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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XUIElement.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_XUIElement_idl__
  32 #define __com_sun_star_ui_XUIElement_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_XPropertySet_idl__
  39 #include <com/sun/star/beans/XPropertySet.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module ui {
  45
  46 //=============================================================================
  47
  48 /** provides a function to retrieve a special purpose interface dependent
  49     on the user interface element type.
  50
  51     <p>
  52     The type of the interface depends on the real type of the user interface
  53     element. A menubar user interface element provides access to its
  54     <type scope="com::sun::star::awt">XSystemDependentMenuBarPeer</type>
  55     which supports to retrieve the system dependent menu handle.
  56     A floating window or a toolbar user interface element return a
  57     <type scope=com::sun::star::awt>XWindow</type>
  58     interface.
  59     </p>
  60 */
  61
  62 interface XUIElement : com::sun::star::uno::XInterface
  63 {
  64     /** returns an interface to get access to user interface type specific functions.
  65
  66         @return
  67             a special purpose interface which depends on the type of the user
  68             interface element.
  69     */
  70     com::sun::star::uno::XInterface getRealInterface();
  71 };
  72
  73 }; }; }; };
  74
  75 //=============================================================================
  76
  77 #endif