dbaccess/inc/core_resource.hxx

   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 INCLUDED_DBACCESS_SOURCE_CORE_INC_CORE_RESOURCE_HXX
  21 #define INCLUDED_DBACCESS_SOURCE_CORE_INC_CORE_RESOURCE_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include "dbadllapi.hxx"
  25
  26 #define DBA_RES( id )                       ::dbaccess::ResourceManager::loadString( id )
  27 #define DBA_RES_PARAM( id, ascii, replace ) ::dbaccess::ResourceManager::loadString( id, ascii, replace )
  28
  29 namespace dbaccess
  30 {
  31     // ResourceManager
  32     // handling resources within the DBA-Core library
  33     class OOO_DLLPUBLIC_DBA ResourceManager
  34     {
  35     private:
  36         // no instantiation allowed
  37         ResourceManager() = delete;
  38         ~ResourceManager() { }
  39
  40     public:
  41         /** loads the string with the specified resource id
  42         */
  43         static OUString  loadString(const char* pResId);
  44
  45         /** loads a string from the resource file, substituting a placeholder with a given string
  46
  47             @param  pResId
  48                 the resource ID of the string to load
  49             @param  _pPlaceholderAscii
  50                 the ASCII representation of the placeholder string
  51             @param  _rReplace
  52                 the string which should substitute the placeholder
  53         */
  54         static OUString  loadString(
  55                 const char* pResId,
  56                 const sal_Char* _pPlaceholderAscii,
  57                 const OUString&  _rReplace
  58         );
  59
  60         /** loads a string from the resource file, substituting two placeholders with given strings
  61
  62             @param  pResId
  63                 the resource ID of the string to load
  64             @param  _pPlaceholderAscii1
  65                 the ASCII representation of the first placeholder string
  66             @param  _rReplace1
  67                 the string which should substitute the first placeholder
  68             @param  _pPlaceholderAscii2
  69                 the ASCII representation of the second placeholder string
  70             @param  _rReplace2
  71                 the string which should substitute the second placeholder
  72         */
  73         static OUString  loadString(
  74                 const char* pResId,
  75                 const sal_Char* _pPlaceholderAscii1,
  76                 const OUString& _rReplace1,
  77                 const sal_Char* _pPlaceholderAscii2,
  78                 const OUString& _rReplace2
  79         );
  80     };
  81 }
  82
  83 #endif // INCLUDED_DBACCESS_SOURCE_CORE_INC_CORE_RESOURCE_HXX
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */