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