Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: ui ::

interface XUIElement
Description
provides a function to retrieve a special purpose interface dependent on the user interface element type.

The type of the interface depends on the real type of the user interface element. A menubar user interface element provides access to its com::sun::star::awt::XSystemDependentMenuBarPeer which supports to retrieve the system dependent menu handle. A floating window or a toolbar user interface element return a ::XWindow interface.


Methods' Summary
getRealInterface returns an interface to get access to user interface type specific functions.  
Attributes' Summary
Frame determines the document frame to which this element is bound to.  
ResourceURL a resource URL which is a unique identifier of a user interface element.  
Type determines the type of the user interface element.  
Methods' Details
getRealInterface
::com::sun::star::uno::XInterface
getRealInterface();

Description
returns an interface to get access to user interface type specific functions.
Returns
a special purpose interface which depends on the type of the user interface element.
Attributes' Details
Frame
[ readonly ] ::com::sun::star::frame::XFrame Frame;
Description
determines the document frame to which this element is bound to.

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.

ResourceURL
[ readonly ] string ResourceURL;
Description
a resource URL which is a unique identifier of a user interface element.
Type
[ readonly ] short Type;
Description
determines the type of the user interface element.
See also
UIElementType
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.