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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XUIConfigurationStorage.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_XUIConfigurationStorage_idl__
  32 #define __com_sun_star_ui_XUIConfigurationStorage_idl__
  33
  34 #ifndef __com_sun_star_embed_XStorage_idl__
  35 #include <com/sun/star/embed/XStorage.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ui {
  41
  42 //=============================================================================
  43
  44 /** supplies functions to change or get information about the storage
  45     of a user interface configuration manager.
  46
  47     @since OOo 2.0.0
  48 */
  49
  50 interface XUIConfigurationStorage : ::com::sun::star::uno::XInterface
  51 {
  52     /** connects a storage to the user interface configuration manager
  53         which is used on subsequent calls of <member>load</member> and
  54         <member>store</member>.
  55
  56         @param Storage
  57             all configuration data is loaded/stored from/into this storage.
  58             If the storage is in read/write mode <member>load</member>
  59             and <member>store</member> can be used otherwise only
  60             <member>load</member> is possible.
  61
  62         <p>
  63         This call needs careful usage as data loss can occur. If the
  64         implementation has modified data and a new storage is set the
  65         implementation is not allowed to write back the data to the old
  66         storage. This must be done explicitly with <member>store</member>.
  67         In general a user interface configuration manager instance is
  68         created and initialize by the document model or the module user
  69         interface configuration supplier. Normally there is no need to
  70         set a storage for a user interface configuration manager. If a
  71         copy of the configuration data to another storage should be made,
  72         use <member>storeToStorage</member>.
  73         </p>
  74     */
  75     void setStorage( [in] ::com::sun::star::embed::XStorage Storage );
  76
  77     /** checks if an instance has already a storage to load/store its data.
  78
  79         @return
  80             <TRUE/> if the instance has a storage otherwise <FALSE/>.
  81     */
  82     boolean hasStorage();
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif