offapi/com/sun/star/ui/UIElementSettings.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_ui_UIElementSettings_idl__
  30 #define __com_sun_star_ui_UIElementSettings_idl__
  31
  32 #include <com/sun/star/container/XIndexAccess.idl>
  33 #include <com/sun/star/lang/XSingleComponentFactory.idl>
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module ui {
  38
  39 //=============================================================================
  40
  41 /**
  42     describes the internal structure of a configurable user interface element.
  43
  44     <p>
  45     No assumption is made about any graphical representation:
  46     You could have a menu or a toolbar working with the same UIElementSettings
  47     although limitations based on the real user interface element may be visible.
  48     </p>
  49
  50     @since OOo 2.0
  51 */
  52 service UIElementSettings
  53 {
  54     /** provides access to the structure of the user interface element.
  55
  56         <p>
  57         The container contains the items of the user interface element. Every
  58         item is stored as a sequence of <type scope="com::sun::star::beans">PropertyValue</type>.
  59         The properties insides the sequence are defined by the service <type scope="com::sun::star::ui">ItemDescriptor</type>.
  60         It depends on the function which provides these service if the container is shareable read-only or exclusive writable.
  61
  62         @see com::sun::star::ui::ItemDescriptor
  63         @see com::sun::star::ui::ItemType
  64         @see com::sun::star::ui::ItemStyle
  65         </p>
  66     */
  67     interface ::com::sun::star::container::XIndexAccess;
  68
  69
  70     /** provides access to an optional factory interface to create sub container.
  71
  72         <p>
  73         The factory should be used to create sub container within this user interface element settings. This interface is only
  74         available if the container is exclusive writable.
  75         </p>
  76     */
  77     [optional] interface ::com::sun::star::lang::XSingleComponentFactory;
  78
  79     /** determine an optional user interface name of the user interface element.
  80
  81         <p>
  82         A toolbar can show a its user interface name on the window title, when it is in floating mode.
  83         </p>
  84     */
  85     [optional, property] string UIName;
  86 };
  87
  88 }; }; }; };
  89
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */