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