offapi/com/sun/star/ui/ConfigurableUIElement.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 /** specifies a configurable user interface element that supports persistence.
  25
  26     <p>
  27     Configurable user interface elements are:
  28     <ul>
  29         <li>menubar</li>
  30         <li>popupmenu<li>
  31         <li>toolbar</li>
  32         <li>statusbar</li>
  33     </ul>
  34     </p>
  35
  36     @since OOo 2.0
  37 */
  38
  39 service ConfigurableUIElement
  40 {
  41     /** provides properties and functions to initialize and identify a user
  42         interface element.
  43
  44         <p>
  45         A configurable user interface element must be initialized using
  46         com::sun::star::lang::XInitialization::initialize() before
  47         it can be used. The following properties must be provided:
  48         <ul>
  49             <li><b>ResourceURL</b><br>specifies the user interface name.</li>
  50             <li><b>Frame</b><br>specifies to which frame instance the user interface belongs to.</li>
  51             <li><b>ConfigurationSource</b><br>specifies to which configuration manager a user interface
  52             element instance is bound to.</li>
  53         </ul>
  54         </p>
  55
  56         A user interface element factory creates and initializes every user interface element
  57         correctly.
  58
  59         @see com::sun::star::ui::UIElementFactory
  60     */
  61     service UIElement;
  62
  63     /** provides functions to retrieve and change the user interface element structure data and to
  64         update its visible representation.
  65     */
  66     interface com::sun::star::ui::XUIElementSettings;
  67
  68     /** specifies if the user interface element stores changes of its structure to its creator
  69         source defined by the property #ConfigurationSource. */
  70     [property] boolean Persistent;
  71
  72     /** specifies the configuration source of this user interface element.
  73
  74         <p>
  75         If the property #Persistent is `TRUE` changes on the structure of
  76         the user interface element are written back to configuration source. When this property is
  77         changed, afterwards XUIElementSettings::updateSettings()  must be called so
  78         the user interface element tries to retrieve its settings from the new user interface
  79         configuration manager.
  80         </p>
  81     */
  82     [property] com::sun::star::ui::XUIConfigurationManager ConfigurationSource;
  83 };
  84
  85 }; }; }; };
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */