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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module ui {
  22
  23
  24 /**
  25     describes the internal structure of a configurable user interface element.
  26
  27     <p>
  28     No assumption is made about any graphical representation:
  29     You could have a menu or a toolbar working with the same UIElementSettings
  30     although limitations based on the real user interface element may be visible.
  31     </p>
  32
  33     @since OOo 2.0
  34 */
  35 service UIElementSettings
  36 {
  37     /** provides access to the structure of the user interface element.
  38
  39         <p>
  40         The container contains the items of the user interface element. Every
  41         item is stored as a sequence of com::sun::star::beans::PropertyValue.
  42         The properties insides the sequence are defined by the service com::sun::star::ui::ItemDescriptor.
  43         It depends on the function which provides these service if the container is shareable read-only or exclusive writable.
  44
  45         @see com::sun::star::ui::ItemDescriptor
  46         @see com::sun::star::ui::ItemType
  47         @see com::sun::star::ui::ItemStyle
  48         </p>
  49     */
  50     interface ::com::sun::star::container::XIndexAccess;
  51
  52
  53     /** provides access to an optional factory interface to create sub container.
  54
  55         <p>
  56         The factory should be used to create sub container within this user interface element settings. This interface is only
  57         available if the container is exclusive writable.
  58         </p>
  59     */
  60     [optional] interface ::com::sun::star::lang::XSingleComponentFactory;
  61
  62     /** determine an optional user interface name of the user interface element.
  63
  64         <p>
  65         A toolbar can show its user interface name on the window title, when it is in floating mode.
  66         </p>
  67     */
  68     [optional, property] string UIName;
  69 };
  70
  71 }; }; }; };
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */