offapi/com/sun/star/drawing/framework/TabBarButton.idl

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