offapi/com/sun/star/resource/XStringResourceWithStorage.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 #ifndef __com_sun_star_resource_XStringResourceWithStorage_idl__
  20 #define __com_sun_star_resource_XStringResourceWithStorage_idl__
  21
  22 #include <com/sun/star/resource/XStringResourcePersistence.idl>
  23
  24
  25
  26 module com { module sun { module star { module resource {
  27
  28 /**
  29     Extends XStringResourcePersistence by methods to handle an
  30     associated com::sun::star::embed::XStorage instance.
  31
  32     @see XStringResourcePersistence.
  33 */
  34 interface XStringResourceWithStorage: com::sun::star::resource::XStringResourcePersistence
  35 {
  36     /**
  37         Stores all string table data to a storage and associates this storage
  38         to this instance as if setStorage() was called with
  39         this storage. The modified state will be unmodified after the call.
  40
  41         This method can throw all exceptions thrown by the methods of
  42         com::sun::star::embed::XStorage
  43     */
  44     void storeAsStorage( [in] ::com::sun::star::embed::XStorage Storage )
  45         raises( com::sun::star::uno::Exception );
  46
  47
  48     /**
  49         Associates a storage to the StringResourceWithStorage instance
  50         which is used on subsequent calls of store().
  51
  52         @param Storage
  53             the storage to be associated to the StringResourceManager
  54
  55         <p>
  56         This call has to be used carefully as it removes the storage
  57         previously connected to the StringResourceWithStorage. It may
  58         force the implementation to reload data from the previous storage
  59         before releasing it. The StringResourceManager will be modified
  60         after calling this method as the data isn't stored to the new
  61         storage yet. storeAsStorage() should be preferred
  62         as it directly stores the data to the new storage and afterwards
  63         this storage is in sync with the resource data.
  64         </p>
  65
  66         @throws com::sun::star::lang::IllegalArgumentException
  67             if a null interface is passed as Storage
  68     */
  69     void setStorage( [in] ::com::sun::star::embed::XStorage Storage )
  70         raises( ::com::sun::star::lang::IllegalArgumentException );
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */