offapi/com/sun/star/ui/XUIConfigurationPersistence.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_ui_XUIConfigurationPersistence_idl__
  21 #define __com_sun_star_ui_XUIConfigurationPersistence_idl__
  22
  23 #include <com/sun/star/embed/XStorage.idl>
  24
  25 module com { module sun { module star { module ui {
  26
  27 /** specifies a persistence interface which supports to load/store user
  28     interface configuration data to a storage and to retrieve information
  29     about the current state.
  30
  31     @since OOo 2.0
  32 */
  33
  34 interface XUIConfigurationPersistence : ::com::sun::star::uno::XInterface
  35 {
  36     /** reloads the configuration data from the storage and reinitialize
  37         the user interface configuration manager instance with this data.
  38
  39         <p>
  40         It is up to the implementation if it defers the first loading process
  41         until the first data request using <type>XUIConfigurationManager</type>
  42         interface.
  43         </p>
  44     */
  45     void reload() raises ( ::com::sun::star::uno::Exception );
  46
  47     /** stores the configuration data to the storage provided by
  48         <member>setStorage</member> from the storage and initialize the
  49         user interface configuration manager instance with the newly
  50         data. This call can throw an
  51         <type scope="com::sun::star::io">IOException</type> if
  52         <member>store</member> cannot store its data into the internal
  53         storage.
  54     */
  55     void store() raises ( ::com::sun::star::uno::Exception );
  56
  57     /** stores the configuration data to the provided storage, ignoring
  58         the previously set storage by <member>setStorage</member>. Can
  59         be used to make copy of the current user interface configuration
  60         data to another storage. This call will throw an
  61         <type scope="com::sun::star::io">IOException</type> if the provided
  62         storage is in read-only mode.
  63
  64         @param Storage
  65             all configuration data will be stored to this storage.
  66     */
  67     void storeToStorage( [in] ::com::sun::star::embed::XStorage Storage ) raises ( ::com::sun::star::uno::Exception );
  68
  69     /** provides the current modify state of the configuration manager
  70         instance.
  71
  72         @return
  73             <TRUE/> if the configuration manager has changed since the
  74             last <member>store</member> call. <FALSE/> if the configuration
  75             manager has not been changed.
  76     */
  77     boolean isModified();
  78
  79     /** provides the current read-only state of the user configuration
  80         manager. Storing a user interface configuration to a read-only storage
  81         is not possible. A read-only configuration manager instance will also
  82         not support any changes to its configuration settings.
  83
  84         @return
  85             <TRUE/> if the configuration manager storage is read-only otherwise
  86             <FALSE/>.
  87     */
  88     boolean isReadOnly();
  89 };
  90
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */