/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#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 displayed in
    one pane.
    <p>For identification only the #ResourceId is used, so for
    some methods of the XTabBar interface only the
    #ResourceId 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;

    /** XResourceId object of the resource that is requested to be
        displayed when the tab bar button is activated.
        <p>For some methods of the XTabBar 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */