Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: ui ::
unpublished | interface XUIConfigurationManager |
Usage Restrictions not published Description specifies a user interface configuration manager interface which controls the structure of all customizable user interface elements. Since OOo 2.0

Methods' Summary
reset | resets the configuration manager to the default user interface configuration data.
getUIElementsInfo | retrieves information about all user interface elements within the user interface configuration manager.
createSettings | creates an empty settings data container.
hasSettings | determines if the settings of a user interface element is part the user interface configuration manager.
getSettings | retrieves the settings of a user interface element.
replaceSettings | replaces the settings of a user interface element with new settings.
removeSettings | removes the settings of an existing user interface element.
insertSettings | inserts the settings of a new user interface element.
getImageManager | retrieves the image manager from the user interface configuration manager.
getShortCutManager | retrieves the keyboard short cut manager from the user interface configuration manager.
getEventsManager | retrieves the events manager from the user interface configuration manager.

Methods' Details
reset
void
reset();
Description resets the configuration manager to the default user interface configuration data. This means that all user interface configuration data of the instance will be removed. A module based user interface configuration manager removes user defined elements, but set all other elements back to default. It is not possible to remove default elements from a module user interface configuration manager.
getUIElementsInfo
sequence< sequence< ::com::sun::star::beans::PropertyValue > >
getUIElementsInfo( | [in] short | ElementType )
raises( | ::com::sun::star::lang::IllegalArgumentException );
Description retrieves information about all user interface elements within the user interface configuration manager. Parameter ElementType makes it possible to narrow the result set to only one type of user interface elements. If all user interface element types should be returned UIElementType::UNKNOWN must be provided. Returns returns all user interface elements within the user interface configuration manager that meet the given ElementType specification. The following ::com::sun::star::beans::PropertyValue entries are defined inside the sequence for every user interface element. ResourceURLspecifies the unique resource URL for the user interface element. UINamespecifies the user interface name for the user interface element. Not all user interface elements have set UIName. At least menubars do not. See also UIElementType
createSettings
::com::sun::star::container::XIndexContainer
createSettings();
Description creates an empty settings data container. Returns an empty user interface element settings data container, which implements UIElementSettings.
hasSettings
boolean
hasSettings( | [in] string | ResourceURL )
raises( | ::com::sun::star::lang::IllegalArgumentException );
Description determines if the settings of a user interface element is part the user interface configuration manager. Parameter ResourceURL a resource URL which identifies the user interface element. A resource 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, otherwise false.
getSettings
::com::sun::star::container::XIndexAccess
getSettings( | [in] string | ResourceURL,
| [in] boolean | bWriteable )
raises( | ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalArgumentException );
Description retrieves the settings of a user interface element. Parameter ResourceURL a resource URL which identifies the user interface element. A resource URL must meet the following syntax: "private:resource/$type/$name. It is only allowed to use ASCII characters for type and name. Parameter bWriteable must be true if the retrieved settings should be a writable. Otherwise false should be provided to get a shareable reference to the settings data. Returns settings data of an existing user interface element, which implements UIElementSettings. If the settings data cannot be found a ::com::sun::star::container::NoSuchElementException is thrown. If the ResourceURL is not valid or describes an unknown type a ::com::sun::star::lang::IllegalArgumentException is thrown.
replaceSettings
void
replaceSettings( | [in] string | ResourceURL,
| [in] ::com::sun::star::container::XIndexAccess | aNewData )
raises( | ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException );
Description replaces the settings of a user interface element with new settings. Parameter ResourceURL a resource URL which identifies the user interface element to be replaced. If no element with the given resource URL exists a ::com::sun::star::container::NoSuchElementException is thrown. Parameter aNewData the new settings data of an existing user interface element, which implements UIElementSettings. If the settings data cannot be found a ::com::sun::star::container::NoSuchElementException is thrown. If the ResourceURL is not valid or describes an unknown type a ::com::sun::star::lang::IllegalArgumentException is thrown. If the configuration manager is read-only a ::com::sun::star::lang::IllegalAccessException is thrown.
removeSettings
void
removeSettings( | [in] string | ResourceURL )
raises( | ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException );
Description removes the settings of an existing user interface element. Parameter ResourceURL a resource URL which identifies the user interface element settings to be removed. If the settings data cannot be found a ::com::sun::star::container::NoSuchElementException is thrown. If the ResourceURL is not valid or describes an unknown type a ::com::sun::star::lang::IllegalArgumentException is thrown. If the configuration manager is read-only a ::com::sun::star::lang::IllegalAccessException is thrown.
insertSettings
void
insertSettings( | [in] string | NewResourceURL,
| [in] ::com::sun::star::container::XIndexAccess | aNewData )
raises( | ::com::sun::star::container::ElementExistException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException );
Description inserts the settings of a new user interface element. Parameter ResourceURL a resource URL which identifies the new user interface element. Parameter aNewData the settings data of the new user interface element, which implements UIElementSettings. If the settings data is already present a ::com::sun::star::container::ElementExistException is thrown. If the ResourceURL is not valid or describes an unknown type a ::com::sun::star::lang::IllegalArgumentException is thrown. If the configuration manager is read-only a ::com::sun::star::lang::IllegalAccessException is thrown.
getImageManager
::com::sun::star::uno::XInterface
getImageManager();
Description retrieves the image manager from the user interface configuration manager. Every user interface configuration manager has one image manager instance which controls all images of a module or document. Returns the image manager of the user interface configuration manager.
getShortCutManager
::com::sun::star::uno::XInterface
getShortCutManager();
Description retrieves the keyboard short cut manager from the user interface configuration manager. Every user interface configuration manager has one keyboard short cut manager instance which controls all short cuts of a module or document. Returns the short cut manager of the user interface configuration manager.
getEventsManager
::com::sun::star::uno::XInterface
getEventsManager();
Description retrieves the events manager from the user interface configuration manager. Every user interface configuration manager has one events manager instance which controls the mapping of events to script URLs of a module or document. Returns the events manager of the user interface configuration manager, if one exists.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.