LibreOffice
LibreOffice 7.2 SDK API Reference
Exported Interfaces | List of all members
UIElement Service Reference

specifies a user interface element. More...

import"UIElement.idl";

Inheritance diagram for UIElement:
XUIElement XInitialization XUpdatable XComponent XInterface XInterface XInterface XInterface ConfigurableUIElement

Exported Interfaces

interface ::com::sun::star::ui::XUIElement
 provides a function to retrieve a special purpose interface which depends on the specific user interface element type. More...
 
interface ::com::sun::star::lang::XInitialization
 interface to initialize a user interface element instance. More...
 
interface com::sun::star::util::XUpdatable
 used to notify an implementation that it needs to update its visual representation. More...
 
interface ::com::sun::star::lang::XComponent
 controls the life-time of the object. More...
 

Additional Inherited Members

- Public Member Functions inherited from XUIElement
::com::sun::star::uno::XInterface getRealInterface ()
 returns an interface to get access to user interface type specific functions. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Public Attributes inherited from XUIElement
::com::sun::star::frame::XFrame Frame
 determines the document frame to which this element is bound to. More...
 
string ResourceURL
 a resource URL which is a unique identifier of a user interface element. More...
 
short Type
 determines the type of the user interface element. More...
 
- Protected Member Functions inherited from XInitialization
void initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
 initializes the object. More...
 
- Protected Member Functions inherited from XUpdatable
void update ()
 refreshes the data of the object from the connected data source. More...
 
- Protected Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 

Detailed 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
OOo 2.0

Exported Interfaces

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

controls the life-time of the object.

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

interface to initialize a user interface element instance.

A user interface element must be initialized using com::sun::star::lang::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.

See also
com::sun::star::ui::UIElementFactoryManager;
com::sun::star::ui::UIElementFactory

◆ ::com::sun::star::ui::XUIElement

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

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

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.


The documentation for this service was generated from the following file: