1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_drawing_framework_TabBarButton_idl__
25#define __com_sun_star_drawing_framework_TabBarButton_idl__
26
27module com { module sun { module star { module drawing { module framework {
28
29interface XResourceId;
30
31/** Descriptor of a tab bar button.  Tab bar buttons are typically used to
32    offer the user the choice between different views to be disiplayed in
33    one pane.
34    <p>For identification only the <member>ResourceId</member> is used, so for
35    some methods of the <type>XTabBar</type> interface only the
36    <member>ResourceId</member> member is evaluated.</p>
37*/
38struct TabBarButton
39{
40    /** This label is displayed on the UI as button text.
41        <p>The label is expected to be localized.</p>
42    */
43    string ButtonLabel;
44
45    /** The localized help text that may be displayed in a tool tip.
46    */
47    string HelpText;
48
49    /** <type>XResourceId</type> object of the resource that is requested to be
50        displayed when the tab bar button is activated.
51        <p>For some methods of the <type>XTabBar</type> interface only this
52        member is evaluated.  That is because only this member is used to
53        identify a tab bar button.</p>
54    */
55    XResourceId ResourceId;
56};
57
58}; }; }; }; }; // ::com::sun::star::drawing::framework
59
60#endif
61