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 module com { module sun { module star { module ui {
  21
  22 /** specifies a persistence interface which supports to load/store user
  23     interface configuration data to a storage and to retrieve information
  24     about the current state.
  25
  26     @since OOo 2.0
  27 */
  28
  29 published interface XUIConfigurationPersistence : ::com::sun::star::uno::XInterface
  30 {
  31     /** reloads the configuration data from the storage and reinitialize
  32         the user interface configuration manager instance with this data.
  33
  34         <p>
  35         It is up to the implementation if it defers the first loading process
  36         until the first data request using XUIConfigurationManager
  37         interface.
  38         </p>
  39     */
  40     void reload() raises ( ::com::sun::star::uno::Exception );
  41
  42     /** stores the configuration data to the storage provided by
  43         setStorage() from the storage and initialize the
  44         user interface configuration manager instance with the newly
  45         data. This call can throw an
  46         com::sun::star::io::IOException if
  47         store() cannot store its data into the internal
  48         storage.
  49     */
  50     void store() raises ( ::com::sun::star::uno::Exception );
  51
  52     /** stores the configuration data to the provided storage, ignoring
  53         the previously set storage by setStorage(). Can
  54         be used to make copy of the current user interface configuration
  55         data to another storage. This call will throw an
  56         com::sun::star::io::IOException if the provided
  57         storage is in read-only mode.
  58
  59         @param Storage
  60             all configuration data will be stored to this storage.
  61     */
  62     void storeToStorage( [in] ::com::sun::star::embed::XStorage Storage ) raises ( ::com::sun::star::uno::Exception );
  63
  64     /** provides the current modify state of the configuration manager
  65         instance.
  66
  67         @return
  68             `TRUE` if the configuration manager has changed since the
  69             last store() call. `FALSE` if the configuration
  70             manager has not been changed.
  71     */
  72     boolean isModified();
  73
  74     /** provides the current read-only state of the user configuration
  75         manager. Storing a user interface configuration to a read-only storage
  76         is not possible. A read-only configuration manager instance will also
  77         not support any changes to its configuration settings.
  78
  79         @return
  80             `TRUE` if the configuration manager storage is read-only otherwise
  81             `FALSE`.
  82     */
  83     boolean isReadOnly();
  84 };
  85
  86
  87 }; }; }; };
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */