LibreOffice
LibreOffice 6.4 SDK API Reference
Included Services | Exported Interfaces | Public Attributes | List of all members
ConfigurableUIElement Service Reference

specifies a configurable user interface element that supports persistence. More...

import"ConfigurableUIElement.idl";

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

Included Services

service UIElement
 provides properties and functions to initialize and identify a user interface element. More...
 

Exported Interfaces

interface com::sun::star::ui::XUIElementSettings
 provides functions to retrieve and change the user interface element structure data and to update its visible representation. More...
 
- Exported Interfaces inherited from UIElement
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...
 

Public Attributes

boolean Persistent
 specifies if the user interface element stores changes of its structure to its creator source defined by the property ConfigurationSource. More...
 
com::sun::star::ui::XUIConfigurationManager ConfigurationSource
 specifies the configuration source of this user interface element. 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...
 

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 Member Functions inherited from XUIElementSettings
void updateSettings ()
 forces the user interface element to retrieve new settings from its configuration source. More...
 
com::sun::star::container::XIndexAccess getSettings ([in] boolean bWriteable)
 provides a UIElementSettings instance that provides access to the structure of user interface element if the user interface element type supports it. More...
 
void setSettings ([in] com::sun::star::container::XIndexAccess UISettings)
 set changes to the structure 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 configurable user interface element that supports persistence.

Configurable user interface elements are:

Since
OOo 2.0

Exported Interfaces

◆ UIElement

service UIElement

provides properties and functions to initialize and identify a user interface element.

A configurable user interface element must be initialized using com::sun::star::lang::XInitialization::initialize() before it can be used. The following properties must be provided:

  • ResourceURL
    specifies the user interface name.
  • Frame
    specifies to which frame instance the user interface belongs to.
  • ConfigurationSource
    specifies to which configuration manager a user interface element instance is bound to.

A user interface element factory creates and initializes every user interface element correctly.

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

Exported Interfaces

◆ com::sun::star::ui::XUIElementSettings

provides functions to retrieve and change the user interface element structure data and to update its visible representation.

Member Data Documentation

◆ ConfigurationSource

com::sun::star::ui::XUIConfigurationManager ConfigurationSource
property

specifies the configuration source of this user interface element.

If the property Persistent is TRUE changes on the structure of the user interface element are written back to configuration source. When this property is changed, afterwards XUIElementSettings::updateSettings() must be called so the user interface element tries to retrieve its settings from the new user interface configuration manager.

◆ Persistent

boolean Persistent
property

specifies if the user interface element stores changes of its structure to its creator source defined by the property ConfigurationSource.


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