Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: ui ::
unpublished | interface XUIConfigurationPersistence |
Usage Restrictions not published Description specifies a persistence interface which supports to load/store user interface configuration data to a storage and to retrieve information about the current state. Since OOo 2.0

Methods' Summary
reload | reloads the configuration data from the storage and reinitialize the user interface configuration manager instance with this data.
store | stores the configuration data to the storage provided by setStorage from the storage and initialize the user interface configuration manager instance with the newly data. This call can throw an ::com::sun::star::io::IOException if store cannot store its data into the internal storage.
storeToStorage | stores the configuration data to the provided storage, ignoring the previously set storage by setStorage. Can be used to make copy of the current user interface configuration data to another storage. This call will throw an ::com::sun::star::io::IOException if the provided storage is in read-only mode.
isModified | provides the current modify state of the configuration manager instance.
isReadOnly | provides the current read-only state of the user configuration manager. Storing a user interface configuration to a read-only storage is not possible. A read-only configuration manager instance will also not support any changes to its configuration settings.

Methods' Details
reload
void
reload()
raises( | ::com::sun::star::uno::Exception );
Description reloads the configuration data from the storage and reinitialize the user interface configuration manager instance with this data. It is up to the implementation if it defers the first loading process until the first data request using XUIConfigurationManager interface.
store
void
store()
raises( | ::com::sun::star::uno::Exception );
Description stores the configuration data to the storage provided by setStorage from the storage and initialize the user interface configuration manager instance with the newly data. This call can throw an ::com::sun::star::io::IOException if store cannot store its data into the internal storage.
storeToStorage
void
storeToStorage( | [in] ::com::sun::star::embed::XStorage | Storage )
raises( | ::com::sun::star::uno::Exception );
Description stores the configuration data to the provided storage, ignoring the previously set storage by setStorage. Can be used to make copy of the current user interface configuration data to another storage. This call will throw an ::com::sun::star::io::IOException if the provided storage is in read-only mode. Parameter Storage all configuration data will be stored to this storage.
isModified
boolean
isModified();
Description provides the current modify state of the configuration manager instance. Returns true if the configuration manager has changed since the last store call. false if the configuration manager has not been changed.
isReadOnly
boolean
isReadOnly();
Description provides the current read-only state of the user configuration manager. Storing a user interface configuration to a read-only storage is not possible. A read-only configuration manager instance will also not support any changes to its configuration settings. Returns true if the configuration manager storage is read-only otherwise false.

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.