1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ui_XUIConfigurationPersistence_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_ui_XUIConfigurationPersistence_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_embed_XStorage_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/embed/XStorage.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ui { 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski/** specifies a persistence interface which supports to load/store user 34*b1cdbd2cSJim Jagielski interface configuration data to a storage and to retrieve information 35*b1cdbd2cSJim Jagielski about the current state. 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 38*b1cdbd2cSJim Jagielski*/ 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielskipublished interface XUIConfigurationPersistence : ::com::sun::star::uno::XInterface 41*b1cdbd2cSJim Jagielski{ 42*b1cdbd2cSJim Jagielski /** reloads the configuration data from the storage and reinitialize 43*b1cdbd2cSJim Jagielski the user interface configuration manager instance with this data. 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski <p> 46*b1cdbd2cSJim Jagielski It is up to the implementation if it defers the first loading process 47*b1cdbd2cSJim Jagielski until the first data request using <type>XUIConfigurationManager</type> 48*b1cdbd2cSJim Jagielski interface. 49*b1cdbd2cSJim Jagielski </p> 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski void reload() raises ( ::com::sun::star::uno::Exception ); 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski /** stores the configuration data to the storage provided by 54*b1cdbd2cSJim Jagielski <member>setStorage</member> from the storage and initialize the 55*b1cdbd2cSJim Jagielski user interface configuration manager instance with the newly 56*b1cdbd2cSJim Jagielski data. This call can throw an 57*b1cdbd2cSJim Jagielski <type scope="com::sun::star::io">IOException</type> if 58*b1cdbd2cSJim Jagielski <member>store</member> cannot store its data into the internal 59*b1cdbd2cSJim Jagielski storage. 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski void store() raises ( ::com::sun::star::uno::Exception ); 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski /** stores the configuration data to the provided storage, ignoring 64*b1cdbd2cSJim Jagielski the previously set storage by <member>setStorage</member>. Can 65*b1cdbd2cSJim Jagielski be used to make copy of the current user interface configuration 66*b1cdbd2cSJim Jagielski data to another storage. This call will throw an 67*b1cdbd2cSJim Jagielski <type scope="com::sun::star::io">IOException</type> if the provided 68*b1cdbd2cSJim Jagielski storage is in read-only mode. 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @param Storage 71*b1cdbd2cSJim Jagielski all configuration data will be stored to this storage. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski void storeToStorage( [in] ::com::sun::star::embed::XStorage Storage ) raises ( ::com::sun::star::uno::Exception ); 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** provides the current modify state of the configuration manager 76*b1cdbd2cSJim Jagielski instance. 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski @return 79*b1cdbd2cSJim Jagielski <TRUE/> if the configuration manager has changed since the 80*b1cdbd2cSJim Jagielski last <member>store</member> call. <FALSE/> if the configuration 81*b1cdbd2cSJim Jagielski manager has not been changed. 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski boolean isModified(); 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski /** provides the current read-only state of the user configuration 86*b1cdbd2cSJim Jagielski manager. Storing a user interface configuration to a read-only storage 87*b1cdbd2cSJim Jagielski is not possible. A read-only configuration manager instance will also 88*b1cdbd2cSJim Jagielski not support any changes to its configuration settings. 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski @return 91*b1cdbd2cSJim Jagielski <TRUE/> if the configuration manager storage is read-only otherwise 92*b1cdbd2cSJim Jagielski <FALSE/>. 93*b1cdbd2cSJim Jagielski */ 94*b1cdbd2cSJim Jagielski boolean isReadOnly(); 95*b1cdbd2cSJim Jagielski}; 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski//============================================================================= 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski}; }; }; }; 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski#endif 102