xref: /aoo41x/main/offapi/com/sun/star/drawing/framework/TabBarButton.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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