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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_ui_XUIConfigurationPersistence_idl__
  30 #define __com_sun_star_ui_XUIConfigurationPersistence_idl__
  31
  32 #include <com/sun/star/embed/XStorage.idl>
  33
  34 module com { module sun { module star { module ui {
  35
  36 /** specifies a persistence interface which supports to load/store user
  37     interface configuration data to a storage and to retrieve information
  38     about the current state.
  39
  40     @since OOo 2.0
  41 */
  42
  43 interface XUIConfigurationPersistence : ::com::sun::star::uno::XInterface
  44 {
  45     /** reloads the configuration data from the storage and reinitialize
  46         the user interface configuration manager instance with this data.
  47
  48         <p>
  49         It is up to the implementation if it defers the first loading process
  50         until the first data request using <type>XUIConfigurationManager</type>
  51         interface.
  52         </p>
  53     */
  54     void reload() raises ( ::com::sun::star::uno::Exception );
  55
  56     /** stores the configuration data to the storage provided by
  57         <member>setStorage</member> from the storage and initialize the
  58         user interface configuration manager instance with the newly
  59         data. This call can throw an
  60         <type scope="com::sun::star::io">IOException</type> if
  61         <member>store</member> cannot store its data into the internal
  62         storage.
  63     */
  64     void store() raises ( ::com::sun::star::uno::Exception );
  65
  66     /** stores the configuration data to the provided storage, ignoring
  67         the previously set storage by <member>setStorage</member>. Can
  68         be used to make copy of the current user interface configuration
  69         data to another storage. This call will throw an
  70         <type scope="com::sun::star::io">IOException</type> if the provided
  71         storage is in read-only mode.
  72
  73         @param Storage
  74             all configuration data will be stored to this storage.
  75     */
  76     void storeToStorage( [in] ::com::sun::star::embed::XStorage Storage ) raises ( ::com::sun::star::uno::Exception );
  77
  78     /** provides the current modify state of the configuration manager
  79         instance.
  80
  81         @return
  82             <TRUE/> if the configuration manager has changed since the
  83             last <member>store</member> call. <FALSE/> if the configuration
  84             manager has not been changed.
  85     */
  86     boolean isModified();
  87
  88     /** provides the current read-only state of the user configuration
  89         manager. Storing a user interface configuration to a read-only storage
  90         is not possible. A read-only configuration manager instance will also
  91         not support any changes to its configuration settings.
  92
  93         @return
  94             <TRUE/> if the configuration manager storage is read-only otherwise
  95             <FALSE/>.
  96     */
  97     boolean isReadOnly();
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */