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 ::

unpublished service ConfigurableUIElement
Usage Restrictions
not published
Description
specifies a configurable user interface element that supports persistence.

Configurable user interface elements are:

  • menubar
  • popupmenu
  • toolbar
  • statusbar

Since
OOo 2.0

Included Services - Summary
UIElement

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

Exported Interfaces - Summary
XUIElementSettings

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

Properties' Summary
boolean
Persistent
specifies if the user interface element stores changes of its structure to its creator source defined by the property ConfigurationSource.  
XUIConfigurationManager
ConfigurationSource
specifies the configuration source of this user interface element.  
Included Services - Details
UIElement
Description
provides properties and functions to initialize and identify a user interface element.

A configurable user interface element must be initialized using ::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
UIElementFactory
Exported Interfaces - Details
XUIElementSettings
Description
provides functions to retrieve and change the user interface element structure data and to update its visible representation.
Properties' Details
Persistent
boolean Persistent;
Description
specifies if the user interface element stores changes of its structure to its creator source defined by the property ConfigurationSource.
ConfigurationSource
XUIConfigurationManager ConfigurationSource;
Description
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.


 
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.