Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished interface XModuleUIConfigurationManager
Usage Restrictions
not published
Description
specifies specific functions of a module based user interface configuration manager interface.

A module user interface configuration manager supports, unlike a document based ui configration manager, 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 changeelements 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. This layer is the same as the document ui configuration manager uses.

Since
OOo 2.0

Methods' Summary
isDefaultSettings determine if the settings of a user interface element is part of the default layer of the user interface configuration manager.  
getDefaultSettings retrieves the settings from the default layer of the user interface configuration manager if it has a default layer.  
Methods' Details
isDefaultSettings
boolean
isDefaultSettings( [in] string  ResourceURL )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
determine if the settings of a user interface element is part of the default layer of the user interface configuration manager.
Parameter ResourceURL
a resource URL which identifies the user interface element. A resourcce URL must meet the following syntax: "private:resource/$type/$name. It is only allowed to use ascii characters for type and name.
Returns
true if settings have been found in the default layer, otherwise false.
getDefaultSettings
::com::sun::star::container::XIndexAccess
getDefaultSettings( [in] string  ResourceURL )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::IllegalArgumentException );

Description
retrieves the settings from the default layer of the user interface configuration manager if it has a default layer.
Parameter ResourceURL
a resource URL which identifies the user interface element. A resourcce URL must meet the following syntax: "private:resource/$type/$name. It is only allowed to use ascii characters for type and name.
Returns
true if default settings have been found in the default layer, otherwise false.
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.