1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_drawing_framework_TabBarButton_idl__
29#define __com_sun_star_drawing_framework_TabBarButton_idl__
30
31module com { module sun { module star { module drawing { module framework {
32
33interface XResourceId;
34
35/** Descriptor of a tab bar button.  Tab bar buttons are typically used to
36    offer the user the choice between different views to be disiplayed in
37    one pane.
38    <p>For identification only the <member>ResourceId</member> is used, so for
39    some methods of the <type>XTabBar</type> interface only the
40    <member>ResourceId</member> member is evaluated.</p>
41*/
42struct TabBarButton
43{
44    /** This label is displayed on the UI as button text.
45        <p>The label is expected to be localized.</p>
46    */
47    string ButtonLabel;
48
49    /** The localized help text that may be displayed in a tool tip.
50    */
51    string HelpText;
52
53    /** <type>XResourceId</type> object of the resource that is requested to be
54        displayed when the tab bar button is activated.
55        <p>For some methods of the <type>XTabBar</type> interface only this
56        member is evaluated.  That is because only this member is used to
57        identify a tab bar button.</p>
58    */
59    XResourceId ResourceId;
60};
61
62}; }; }; }; }; // ::com::sun::star::drawing::framework
63
64#endif
65