offapi/com/sun/star/ui/XUIElement.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 /** provides a function to retrieve a special purpose interface dependent
  25     on the user interface element type.
  26
  27     <p>
  28     The type of the interface depends on the real type of the user interface
  29     element. A menubar user interface element provides access to its
  30     com::sun::star::awt::XSystemDependentMenuBarPeer
  31     which supports to retrieve the system dependent menu handle.
  32     A floating window or a toolbar user interface element return a
  33     com::sun::star::awt::XWindow
  34     interface.
  35     </p>
  36 */
  37
  38 interface XUIElement : com::sun::star::uno::XInterface
  39 {
  40     /** returns an interface to get access to user interface type specific functions.
  41
  42         @return
  43             a special purpose interface which depends on the type of the user
  44             interface element.
  45     */
  46     ::com::sun::star::uno::XInterface getRealInterface();
  47
  48     /** determines the document frame to which this element is bound to.
  49
  50         <p>The life time of a user interface element does not explicitly depend on the
  51         frame itself but on the visible component attached to the frame. It is possible
  52         to exchange the visible component of a frame and that will lead to the end of
  53         life of all user interface elements.</p>
  54     */
  55     [readonly, attribute] ::com::sun::star::frame::XFrame Frame;
  56
  57     /** a resource URL which is a unique identifier of a user interface element.
  58     */
  59     [readonly, attribute] string ResourceURL;
  60
  61     /** determines the type of the user interface element.
  62
  63         @see UIElementType
  64     */
  65     [readonly, attribute] short  Type;
  66 };
  67
  68 }; }; }; };
  69
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */