LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
ModuleUIConfigurationManager Service Reference

specifies a user interface configuration manager which gives access to user interface configuration data of a module. More...

import "ModuleUIConfigurationManager.idl";

Inheritance diagram for ModuleUIConfigurationManager:
XModuleUIConfigurationManager2 XUIConfigurationPersistence XUIConfigurationManager XModuleUIConfigurationManager XUIConfiguration XInterface XInterface XInterface XInterface

Public Member Functions

 createDefault ([in] string ModuleShortName,[in] string ModuleIdentifier) raises ( com::sun::star::configuration::CorruptedUIConfigurationException, com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 provides a function to initialize a module user interface configuration manager instance. More...
 

Additional Inherited Members

- Exported Interfaces inherited from XModuleUIConfigurationManager2
interface com::sun::star::ui::XUIConfigurationPersistence
 provides access to persistence functions to load/store user interface element settings from/to a module storage. More...
 
interface com::sun::star::ui::XUIConfigurationManager
 provides functions to change, insert and remove user interface element settings from a module user interface configuration manager. More...
 
interface com::sun::star::ui::XModuleUIConfigurationManager
 provides access to the default layer of a module based ui configuration manager. More...
 
interface com::sun::star::ui::XUIConfiguration
 provides functions to add and remove listeners for changes within a module user interface configuration manager. More...
 

Detailed Description

specifies a user interface configuration manager which gives access to user interface configuration data of a module.

A module user interface configuration 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

Member Function Documentation

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.


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