offapi/com/sun/star/resource/StringResourceWithStorage.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 #ifndef __com_sun_star_resource_StringResourceWithStorage_idl__
  21 #define __com_sun_star_resource_StringResourceWithStorage_idl__
  22
  23 #include <com/sun/star/resource/XStringResourceWithStorage.idl>
  24
  25
  26
  27 module com { module sun { module star { module resource {
  28
  29
  30 /** specifies a service providing access to a resource string table implementing the
  31     com::sun::star::resource::XStringResourceWithStorage interface.
  32  */
  33 service StringResourceWithStorage : com::sun::star::resource::XStringResourceWithStorage
  34 {
  35     /** is used to initialize the object on its creation.
  36
  37         @param Storage
  38             Specifies the storage used to load and store - if
  39             the ReadOnly state allows it - the string table data.
  40
  41         @param ReadOnly
  42             Specifies if the resource should be read only,
  43             see <code>XStringResourceManager::isReadOnly</code>
  44
  45         @param locale
  46             Specifies if the locale first to be used as current locale. Internally
  47             the <code>XStringResourceManager::setCurrentLocale</code> method is
  48             called with FindClosestMatch=true.
  49             see <code>XStringResourceManager::setCurrentLocale</code>
  50
  51         @param BaseName
  52             Base string for the file names used to store the locale data.
  53             The locale data is stored in Java properties files also following
  54             the corresponding naming scheme. The files will be named like this:
  55             "[BaseName]_[Language]_[Country].properties",
  56             e.g. "MyBaseName_en_US.properties"
  57             If an empty string is passed for BaseName, "strings" will be used
  58             as BaseName.
  59
  60         @param Comment
  61             Comment stored first in each properties file followed by a line
  62             feed character. The line feed character is added automatically
  63             and hasn't to be part of the comment string. The caller is
  64             responsible that the passed string is a valid comment in a Java
  65             properties file, e.g. "# My strings". The string may be empty.
  66
  67         @throws com::sun::star::lang::IllegalArgumentException
  68             if a null interface is passed as Storage
  69      */
  70     create( [in] ::com::sun::star::embed::XStorage Storage,
  71             [in] boolean ReadOnly, [in] com::sun::star::lang::Locale locale,
  72             [in] string BaseName, [in] string Comment )
  73         raises( ::com::sun::star::lang::IllegalArgumentException );
  74 };
  75
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */