/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: ItemDescriptor.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 08:21:15 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_ui_ItemDescriptor_idl__
#define __com_sun_star_ui_ItemDescriptor_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module ui {

/**
    describes a user interface item that is part of a user interface
    element.
    <p>Common examples for such elements are:
        <ul>
            <li>menus</li>
            <li>tool bars</li>
            <li>status bars</li>
        </ul>
       No assumption is made about any graphical representation:
       You could have a menu or a toolbox working with the same item descriptor.
    </p>

    @since OOo 2.0.0
*/
service ItemDescriptor
{
    /** specifies which type this item descriptor belongs to.<p>See constant definition
        <type>ItemType</type>.</p>
    */
    [property] short Type;

    /** the text of the user interface item.
    */
    [property] string Label;

    /** contains the command URL which specifies which action should be accomplished.
     */
    [property] string CommandURL;

    /** contains the a URL that points to a help text.
     */
    [property] string HelpURL;

    /** different styles which influence the appearance of the item and its behavior.
        <p>This property is only valid if the item describes a toolbar or statusbar
        item. See <type>ItemStyle</type> for more information about possible styles.</p>
    */
    [optional, property] short Style;

    /** specifies the pixel distance by which the text of the item is shifted on the x-axis.
        <p>This property is only valid if the item describes a statusbar item.</p>
    */
    [optional, property] short Offset;

    /** specifies an optional sub container.
        <p>This property is valid for menus only. It can be used to define sub menus.</p>
    */
    [optional, property] com::sun::star::container::XIndexAccess ItemDescriptorContainer;

    /** specifies if this item is visible or not.
        <p>This property is only valid if the item describes a toolbar or statusbar item.</p>
    */
    [optional, property] boolean IsVisible;

    /** specifies a pixel width for this item inside the user interface element.
        <p>This property is only valid if the item describes a toolbar or statusbar item.</p>
    */
    [optional, property] short Width;
};

}; }; }; };

#endif
