blob: 29279ab5b5c60240b598d238b9868e77a656daf1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* 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 .
*/
#ifndef INCLUDED_COMPHELPER_OFFICERESOURCEBUNDLE_HXX
#define INCLUDED_COMPHELPER_OFFICERESOURCEBUNDLE_HXX
#include <comphelper/comphelperdllapi.h>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <rtl/ustring.hxx>
#include <memory>
//........................................................................
namespace comphelper
{
//........................................................................
//====================================================================
//= OfficeResourceBundle
//====================================================================
class ResourceBundle_Impl;
/** wraps the com::sun::star::resource::OfficeResourceAccess service
*/
class COMPHELPER_DLLPUBLIC OfficeResourceBundle
{
private:
::std::auto_ptr< ResourceBundle_Impl > m_pImpl;
public:
/** constructs a resource bundle with the resource bundle given as 8-bit ASCII name
This is a convenience constructor only, it does nothing different than the constructor
taking an unicode string.
@param _context
the component context to operate in
@param _bundleBaseName
the base name of the resource file which should be accessed (*without* the SUPD!)
@raises ::com::sun::star::lang::NullPointerException
if the given component context is <NULL/>
*/
OfficeResourceBundle(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _context,
const sal_Char* _bundleBaseAsciiName
);
/** destroys the instance
*/
~OfficeResourceBundle();
/** loads the string with the given resource id from the resource bundle
@param _resourceId
the id of the string to load
@return
the requested resource string. If no string with the given id exists in the resource bundle,
an empty string is returned. In a non-product version, an OSL_ENSURE will notify you of this
then.
*/
OUString loadString( sal_Int32 _resourceId ) const;
/** determines whether the resource bundle has a string with the given id
@param _resourceId
the id of the string whose existence is to be checked
@return
<TRUE/> if and only if a string with the given ID exists in the resource
bundle.
*/
bool hasString( sal_Int32 _resourceId ) const;
};
//........................................................................
} // namespace comphelper
//........................................................................
#endif // INCLUDED_COMPHELPER_OFFICERESOURCEBUNDLE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
