offapi/com/sun/star/ui/UIElementSettings.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: UIElementSettings.idl,v $
  10  * $Revision: 1.5 $
  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_ui_UIElementSettings_idl__
  32 #define __com_sun_star_ui_UIElementSettings_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_XSingleComponentFactory_idl__
  39 #include <com/sun/star/lang/XSingleComponentFactory.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module ui {
  45
  46 //=============================================================================
  47
  48 /**
  49     describes the internal structure of a configurable user interface element.
  50
  51     <p>
  52     No assumption is made about any graphical representation:
  53     You could have a menu or a toolbar working with the same UIElementSettings
  54     although limitations based on the real user interface element may be visible.
  55     </p>
  56
  57     @since OOo 2.0.0
  58 */
  59 service UIElementSettings
  60 {
  61     /** provides access to the structure of the user interface element.
  62
  63         <p>
  64         The container contains the items of the user interface element. Every
  65         item is stored as a sequence of <type scope="com::sun::star::beans">PropertyValue</type>.
  66         The properties insides the sequence are defined by the service <type scope="com::sun::star::ui">ItemDescriptor</type>.
  67         It depends on the function which provides these service if the container is shareable read-only or exclusive writeable.
  68
  69         @see com::sun::star::ui::ItemDescriptor
  70         @see com::sun::star::ui::ItemType
  71         @see com::sun::star::ui::ItemStyle
  72         </p>
  73     */
  74     interface ::com::sun::star::container::XIndexAccess;
  75
  76
  77     /** provides access to an optional factory interface to create sub container.
  78
  79         <p>
  80         The factory should be used to create sub container within this user interface element settings. This interface is only
  81         available if the container is exclusive writable.
  82         </p>
  83     */
  84     [optional] interface ::com::sun::star::lang::XSingleComponentFactory;
  85
  86     /** determine an optional user interface name of the user interface element.
  87
  88         <p>
  89         A toolbar can show a its user interface name on the window title, when it is in floating mode.
  90         </p>
  91     */
  92     [optional, property] string UIName;
  93 };
  94
  95 }; }; }; };
  96
  97 #endif