Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished service ModuleUIConfigurationManager
Usage Restrictions
not published
Description
specifies a user interface configuration manager which gives access to user interface configuration data of a module.

A module user interface configuratio manager supports two layers of configuration settings data:
1. Layer: A module default user interface configuration which describe all user interface elements settings that are used by OpenOffice. It is not possible to insert, remove or change elements settings in this layer through the interfaces.
2. Layer: A module user interface configuration which only contains customized user interface elements and user-defined ones. All changes on user interface element settings are done on this layer.

Since
OOo 2.0

Exported Interfaces - Summary
::com::sun::star::lang::XInitialization

provides a function to initialize a module user interface configuration manager instance. (details)

XUIConfigurationPersistence

provides access to persistence functions to load/store user interface element settings from/to a module storage.

XUIConfigurationManager

provides functions to change, insert and remove user interface element settings from a module user interface configuration manager.

XModuleUIConfigurationManager

provides access to the default layer of a module based ui configuration manager.

XUIConfiguration

provides functions to add and remove listeners for changes within a module user interface configuration manager.

Exported Interfaces - Details
::com::sun::star::lang::XInitialization
Description
provides a function to initialize a module user interface configuration manager instance.

A module user interface configuration manager instance needs the following arguments as ::com::sun::star::beans::PropertyValue to be in a working state:

  • DefaultConfigStoragea reference to a ::com::sun::star::embed::Storage that contains the default module user interface configuration settings.
  • UserConfigStoragea reference to a ::com::sun::star::embed::Storage that contains the user-defined module user interface configuration settings.
  • ModuleIdentifierstring that provides the module identifier.
  • UserRootCommita reference to a ::com::sun::star::embed::XTransactedObject which represents the customizable root storage. Every implementation must use this reference to commit its changes also at the root storage.
A non-initialized module user interface configuration manager cannot be used, it is treated as a read-only container.

XUIConfigurationPersistence
Description
provides access to persistence functions to load/store user interface element settings from/to a module storage.
XUIConfigurationManager
Description
provides functions to change, insert and remove user interface element settings from a module user interface configuration manager.
XModuleUIConfigurationManager
Description
provides access to the default layer of a module based ui configuration manager.
XUIConfiguration
Description
provides functions to add and remove listeners for changes within a module user interface configuration manager.

 
Top of Page

Apache Software Foundation

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

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