summaryrefslogtreecommitdiff
path: root/comphelper/inc/comphelper/officeresourcebundle.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'comphelper/inc/comphelper/officeresourcebundle.hxx')
-rw-r--r--comphelper/inc/comphelper/officeresourcebundle.hxx116
1 files changed, 116 insertions, 0 deletions
diff --git a/comphelper/inc/comphelper/officeresourcebundle.hxx b/comphelper/inc/comphelper/officeresourcebundle.hxx
new file mode 100644
index 000000000000..d45209da9374
--- /dev/null
+++ b/comphelper/inc/comphelper/officeresourcebundle.hxx
@@ -0,0 +1,116 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef COMPHELPER_OFFICE_RESOURCE_BUNDLE_HXX
+#define COMPHELPER_OFFICE_RESOURCE_BUNDLE_HXX
+
+#include <comphelper/comphelperdllapi.h>
+
+/** === begin UNO includes === **/
+#include <com/sun/star/uno/XComponentContext.hpp>
+/** === end UNO includes === **/
+#include <rtl/ustring.hxx>
+
+#include <memory>
+
+//........................................................................
+namespace comphelper
+{
+//........................................................................
+
+ //====================================================================
+ //= OfficeResourceBundle
+ //====================================================================
+ class ResourceBundle_Impl;
+ /** wraps the <type scope="com::sun::star::resource">OfficeResourceAccess</type> service
+ */
+ class COMPHELPER_DLLPUBLIC OfficeResourceBundle
+ {
+ private:
+ ::std::auto_ptr< ResourceBundle_Impl > m_pImpl;
+
+ public:
+ /** constructs a resource bundle
+ @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 ::rtl::OUString& _bundleBaseName
+ );
+
+ /** 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.
+ */
+ ::rtl::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 // COMPHELPER_OFFICE_RESOURCE_BUNDLE_HXX
+