core_resource.hxx 3.2 KB
Newer Older
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
Michael Meeks's avatar
Michael Meeks committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
Jens-Heiner Rechtien's avatar
Jens-Heiner Rechtien committed
19

20 21
#ifndef INCLUDED_DBACCESS_SOURCE_CORE_INC_CORE_RESOURCE_HXX
#define INCLUDED_DBACCESS_SOURCE_CORE_INC_CORE_RESOURCE_HXX
Jens-Heiner Rechtien's avatar
Jens-Heiner Rechtien committed
22 23

#include <rtl/ustring.hxx>
24
#include "dbadllapi.hxx"
Jens-Heiner Rechtien's avatar
Jens-Heiner Rechtien committed
25

26 27
#define DBA_RES( id )                       ::dbaccess::ResourceManager::loadString( id )
#define DBA_RES_PARAM( id, ascii, replace ) ::dbaccess::ResourceManager::loadString( id, ascii, replace )
28

29
namespace dbaccess
Jens-Heiner Rechtien's avatar
Jens-Heiner Rechtien committed
30
{
31 32
    // ResourceManager
    // handling resources within the DBA-Core library
33
    class OOO_DLLPUBLIC_DBA ResourceManager
Jens-Heiner Rechtien's avatar
Jens-Heiner Rechtien committed
34 35 36
    {
    private:
        // no instantiation allowed
37
        ResourceManager() = delete;
Jens-Heiner Rechtien's avatar
Jens-Heiner Rechtien committed
38 39 40
        ~ResourceManager() { }

    public:
41 42
        /** loads the string with the specified resource id
        */
43
        static OUString  loadString(const char* pResId);
44 45 46

        /** loads a string from the resource file, substituting a placeholder with a given string

47
            @param  pResId
48
                the resource ID of the string to load
49 50 51
            @param  _pPlaceholderAscii
                the ASCII representation of the placeholder string
            @param  _rReplace
52
                the string which should substitute the placeholder
Jens-Heiner Rechtien's avatar
Jens-Heiner Rechtien committed
53
        */
54
        static OUString  loadString(
55 56
                const char* pResId,
                const sal_Char* _pPlaceholderAscii,
57
                const OUString&  _rReplace
58
        );
59

60 61
        /** loads a string from the resource file, substituting two placeholders with given strings

62
            @param  pResId
63 64 65 66 67 68 69 70 71 72
                the resource ID of the string to load
            @param  _pPlaceholderAscii1
                the ASCII representation of the first placeholder string
            @param  _rReplace1
                the string which should substitute the first placeholder
            @param  _pPlaceholderAscii2
                the ASCII representation of the second placeholder string
            @param  _rReplace2
                the string which should substitute the second placeholder
        */
73
        static OUString  loadString(
74 75 76 77 78
                const char* pResId,
                const sal_Char* _pPlaceholderAscii1,
                const OUString& _rReplace1,
                const sal_Char* _pPlaceholderAscii2,
                const OUString& _rReplace2
79
        );
Jens-Heiner Rechtien's avatar
Jens-Heiner Rechtien committed
80 81 82
    };
}

83
#endif // INCLUDED_DBACCESS_SOURCE_CORE_INC_CORE_RESOURCE_HXX
84 85

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */