diff options
Diffstat (limited to 'framework/source/inc/pattern/configuration.hxx')
| -rw-r--r-- | framework/source/inc/pattern/configuration.hxx | 176 |
1 files changed, 176 insertions, 0 deletions
diff --git a/framework/source/inc/pattern/configuration.hxx b/framework/source/inc/pattern/configuration.hxx new file mode 100644 index 000000000000..7cb9280ef0e2 --- /dev/null +++ b/framework/source/inc/pattern/configuration.hxx @@ -0,0 +1,176 @@ +/************************************************************************* + * + * 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 __FRAMEWORK_PATTERN_CONFIGURATION_HXX_ +#define __FRAMEWORK_PATTERN_CONFIGURATION_HXX_ + +//_______________________________________________ +// own includes + +#include <services.h> +#include <general.h> + +//_______________________________________________ +// interface includes +#include <com/sun/star/uno/Sequence.hxx> +#include <com/sun/star/uno/Any.hxx> + +#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HXX_ +#include <com/sun/star/beans/PropertyValue.hpp> +#endif +#include <com/sun/star/uno/XInterface.hpp> +#include <com/sun/star/lang/XMultiServiceFactory.hpp> + +//_______________________________________________ +// other includes +#include <rtl/ustrbuf.hxx> + +//_______________________________________________ +// namespaces + +#ifndef css +namespace css = ::com::sun::star; +#endif + +namespace framework{ + namespace pattern{ + namespace configuration{ + +//_______________________________________________ +// definitions + +//----------------------------------------------- +class ConfigurationHelper +{ + //------------------------------------------- + // const + public: + + //--------------------------------------- + /** @short allow opening of a configuration access + in different working modes. + + @descr All enum values must be useable as flags + mapped into a int32 value! + */ + enum EOpenMode + { + /// open it readonly (default=readwrite!) + E_READONLY = 1, + /// disable fallback handling for localized cfg nodes + E_ALL_LOCALES = 2 + }; + + //------------------------------------------- + // interface + public: + + //--------------------------------------- + /** + @short opens a configuration access. + + @descr TODO + + @param xSMGR + this method need an uno service manager for internal work. + + @param sPackage + name the configuration file. + e.g. "/.org.openoffice.Setup" + Note: It must start with "/" but end without(!) "/"! + + @param sRelPath + describe the relativ path of the requested key inside + the specified package. + e.g. "Office/Factories" + Note: Its not allowed to start or end with a "/"! + Further you must use encoded path elements if + e.g. set nodes are involved. + + @param nOpenFlags + force opening of the configuration access in special mode. + see enum EOpenMode for further informations. + */ + static css::uno::Reference< css::uno::XInterface > openConfig(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR , + const ::rtl::OUString& sPackage , + const ::rtl::OUString& sRelPath , + sal_Int32 nOpenFlags) + { + static ::rtl::OUString PATH_SEPERATOR = ::rtl::OUString::createFromAscii("/"); + + css::uno::Reference< css::uno::XInterface > xCFG; + + try + { + css::uno::Reference< css::lang::XMultiServiceFactory > xConfigProvider( + xSMGR->createInstance(SERVICENAME_CFGPROVIDER), css::uno::UNO_QUERY_THROW); + + ::rtl::OUStringBuffer sPath(1024); + sPath.append(sPackage ); + sPath.append(PATH_SEPERATOR); + sPath.append(sRelPath ); + + sal_Bool bReadOnly = ((nOpenFlags & ConfigurationHelper::E_READONLY ) == ConfigurationHelper::E_READONLY ); + sal_Bool bAllLocales = ((nOpenFlags & ConfigurationHelper::E_ALL_LOCALES) == ConfigurationHelper::E_ALL_LOCALES); + + sal_Int32 c = 1; + if (bAllLocales) + c = 2; + + css::uno::Sequence< css::uno::Any > lParams(c); + css::beans::PropertyValue aParam; + + aParam.Name = ::rtl::OUString::createFromAscii("nodepath"); + aParam.Value <<= sPath.makeStringAndClear(); + lParams[0] <<= aParam; + + if (bAllLocales) + { + aParam.Name = ::rtl::OUString::createFromAscii("*"); + aParam.Value <<= sal_True; + lParams[1] <<= aParam; + } + + if (bReadOnly) + xCFG = xConfigProvider->createInstanceWithArguments(SERVICENAME_CFGREADACCESS, lParams); + else + xCFG = xConfigProvider->createInstanceWithArguments(SERVICENAME_CFGUPDATEACCESS, lParams); + } + catch(const css::uno::RuntimeException& exRun) + { throw exRun; } + catch(const css::uno::Exception&) + { xCFG.clear(); } + + return xCFG; + } +}; + + } // namespace configuration + } // namespace pattern +} // namespace framework + +#endif // __FRAMEWORK_PATTERN_CONFIGURATION_HXX_ |