offapi/com/sun/star/ui/XUIConfigurationStorage.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_XUIConfigurationStorage_idl__
  21 #define __com_sun_star_ui_XUIConfigurationStorage_idl__
  22
  23 #include <com/sun/star/embed/XStorage.idl>
  24
  25
  26 module com { module sun { module star { module ui {
  27
  28
  29 /** supplies functions to change or get information about the storage
  30     of a user interface configuration manager.
  31
  32     @since OOo 2.0
  33 */
  34
  35 interface XUIConfigurationStorage : ::com::sun::star::uno::XInterface
  36 {
  37     /** connects a storage to the user interface configuration manager
  38         which is used on subsequent calls of <member>load</member> and
  39         <member>store</member>.
  40
  41         @param Storage
  42             all configuration data is loaded/stored from/into this storage.
  43             If the storage is in read/write mode <member>load</member>
  44             and <member>store</member> can be used otherwise only
  45             <member>load</member> is possible.
  46
  47         <p>
  48         This call needs careful usage as data loss can occur. If the
  49         implementation has modified data and a new storage is set the
  50         implementation is not allowed to write back the data to the old
  51         storage. This must be done explicitly with <member>store</member>.
  52         In general a user interface configuration manager instance is
  53         created and initialize by the document model or the module user
  54         interface configuration supplier. Normally there is no need to
  55         set a storage for a user interface configuration manager. If a
  56         copy of the configuration data to another storage should be made,
  57         use <member>storeToStorage</member>.
  58         </p>
  59     */
  60     void setStorage( [in] ::com::sun::star::embed::XStorage Storage );
  61
  62     /** checks if an instance has already a storage to load/store its data.
  63
  64         @return
  65             <TRUE/> if the instance has a storage otherwise <FALSE/>.
  66     */
  67     boolean hasStorage();
  68 };
  69
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */