/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_drawing_framework_TabBarButton_idl__
#define __com_sun_star_drawing_framework_TabBarButton_idl__

module com { module sun { module star { module drawing { module framework {

interface XResourceId;

/** Descriptor of a tab bar button.  Tab bar buttons are typically used to
    offer the user the choice between different views to be disiplayed in
    one pane.
    <p>For identification only the <member>ResourceId</member> is used, so for
    some methods of the <type>XTabBar</type> interface only the
    <member>ResourceId</member> member is evaluated.</p>
*/
struct TabBarButton
{
    /** This label is displayed on the UI as button text.
        <p>The label is expected to be localized.</p>
    */
    string ButtonLabel;

    /** The localized help text that may be displayed in a tool tip.
    */
    string HelpText;

    /** <type>XResourceId</type> object of the resource that is requested to be
        displayed when the tab bar button is activated.
        <p>For some methods of the <type>XTabBar</type> interface only this
        member is evaluated.  That is because only this member is used to
        identify a tab bar button.</p>
    */
    XResourceId ResourceId;
};

}; }; }; }; }; // ::com::sun::star::drawing::framework

#endif
