offapi/com/sun/star/ui/UIElement.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 user interface element.
  25
  26     <p>
  27     A user interface element consists of a unique identifier and a type specifier. It
  28     provides an interface to retrieve a special purpose interface which depends on
  29     the specific user interface element type. Every user interface must be initialized
  30     before it can be used.
  31     </p>
  32
  33     @since OOo 2.0
  34 */
  35
  36 service UIElement
  37 {
  38     /** provides a function to retrieve a special purpose interface which depends on
  39         the specific user interface element type.
  40     */
  41     interface ::com::sun::star::ui::XUIElement;
  42
  43     /** interface to initialize a user interface element instance.
  44
  45         A user interface element must be initialized using
  46         com::sun::star::lang::XInitialization::initialize() before
  47         it can be used. The following property must be provided:
  48         <ul>
  49             <li><b>ResourceURL</b>specifies a string property which is the unique identifier of
  50             the user interface element.</li>
  51         </ul>
  52
  53         A user interface element factory creates and initializes every user interface element
  54         correctly.
  55
  56         @see com::sun::star::ui::UIElementFactoryManager;
  57         @see com::sun::star::ui::UIElementFactory
  58     */
  59     [optional] interface ::com::sun::star::lang::XInitialization;
  60
  61     /** used to notify an implementation that it needs to update its visual representation.
  62
  63         <p>
  64         A user interface element implementation should check if it has to update its visual
  65         representation. It is up to the implementation if it ignores notifications.
  66         </p>
  67     */
  68     [optional] interface com::sun::star::util::XUpdatable;
  69
  70     /** controls the life-time of the object.
  71     */
  72     interface ::com::sun::star::lang::XComponent;
  73 };
  74
  75 }; }; }; };
  76
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */