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