| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef __com_sun_star_ui_XUIElement_idl__ |
| #define __com_sun_star_ui_XUIElement_idl__ |
| |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.idl> |
| #endif |
| |
| #ifndef __com_sun_star_beans_XPropertySet_idl__ |
| #include <com/sun/star/beans/XPropertySet.idl> |
| #endif |
| |
| #ifndef __com_sun_star_frame_XFrame_idl__ |
| #include <com/sun/star/frame/XFrame.idl> |
| #endif |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module ui { |
| |
| //============================================================================= |
| |
| /** provides a function to retrieve a special purpose interface dependent |
| on the user interface element type. |
| |
| <p> |
| The type of the interface depends on the real type of the user interface |
| element. A menubar user interface element provides access to its |
| <type scope="com::sun::star::awt">XSystemDependentMenuBarPeer</type> |
| which supports to retrieve the system dependent menu handle. |
| A floating window or a toolbar user interface element return a |
| <type scope=com::sun::star::awt>XWindow</type> |
| interface. |
| </p> |
| */ |
| |
| published interface XUIElement : com::sun::star::uno::XInterface |
| { |
| /** returns an interface to get access to user interface type specific functions. |
| |
| @return |
| a special purpose interface which depends on the type of the user |
| interface element. |
| */ |
| ::com::sun::star::uno::XInterface getRealInterface(); |
| |
| /** determines the document frame to which this element is bound to. |
| |
| <p>The life time of a user interface element does not explicitly depend on the |
| frame itself but on the visible component attached to the frame. It is possible |
| to exchange the visible component of a frame and that will lead to the end of |
| life of all user interface elements.</p> |
| */ |
| [readonly, attribute] ::com::sun::star::frame::XFrame Frame; |
| |
| /** a resource URL which is a unique identifier of a user interface element. |
| */ |
| [readonly, attribute] string ResourceURL; |
| |
| /** determines the type of the user interface element. |
| |
| @see UIElementType |
| */ |
| [readonly, attribute] short Type; |
| }; |
| |
| }; }; }; }; |
| |
| //============================================================================= |
| |
| #endif |