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

unpublished service UIElement
Description
specifies a user interface element.

A user interface element consists of a unique identifier and a type specifier. It provides an interface to retrieve a special purpose interface which depends on the specific user interface element type. Every user interface must be initialized before it can be used.

Since
OpenOffice 2.0

Exported Interfaces - Summary
XUIElement

provides a function to retrieve a special purpose interface which depends on the specific user interface element type.

::com::sun::star::lang::XInitialization

interface to initialize a user interface element instance. A user interface element must be initialized using ::XInitialization::initialize before it can be used. The following property must be provided: (details)

::com::sun::star::util::XUpdatable

used to notify an implementation that it needs to update its visual representation. (details)

::com::sun::star::lang::XComponent

controls the life-time of the object.

Properties' Summary
[ readonly ] ::com::sun::star::frame::XFrame
Frame
determines the frame to which this element is bound to.  
[ readonly ] string
ResourceURL
a resource URL which is a unique identifier of a user interface element.  
[ readonly ] short
Type
determines the real type of the user interface element.  
Exported Interfaces - Details
XUIElement
Description
provides a function to retrieve a special purpose interface which depends on the specific user interface element type.
::com::sun::star::lang::XInitialization
Description
interface to initialize a user interface element instance. A user interface element must be initialized using ::XInitialization::initialize before it can be used. The following property must be provided:
  • ResourceURLspecifies a string property which is the unique identifier of the user interface element.
A user interface element factory creates and initializes every user interface element correctly.
::com::sun::star::util::XUpdatable
Description
used to notify an implementation that it needs to update its visual representation.

A user interface element implementation should check if it has to update its visual representation. It is up to the implementation if it ignores notifications.

::com::sun::star::lang::XComponent
Description
controls the life-time of the object.
Properties' Details
Frame
[ readonly ] ::com::sun::star::frame::XFrame Frame;
Description
determines the 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 real type of the user interface element.

 
Top of Page