summaryrefslogtreecommitdiffstats
path: root/framework/inc/jobs/configaccess.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'framework/inc/jobs/configaccess.hxx')
-rw-r--r--framework/inc/jobs/configaccess.hxx92
1 files changed, 92 insertions, 0 deletions
diff --git a/framework/inc/jobs/configaccess.hxx b/framework/inc/jobs/configaccess.hxx
new file mode 100644
index 000000000..1bb8e0110
--- /dev/null
+++ b/framework/inc/jobs/configaccess.hxx
@@ -0,0 +1,92 @@
+/* -*- 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_FRAMEWORK_INC_JOBS_CONFIGACCESS_HXX
+#define INCLUDED_FRAMEWORK_INC_JOBS_CONFIGACCESS_HXX
+
+#include <config_options.h>
+#include <com/sun/star/uno/XComponentContext.hpp>
+
+#include <rtl/ustring.hxx>
+#include <fwidllapi.h>
+
+namespace framework{
+
+/**
+ @short implements a simple configuration access
+ @descr Sometimes it's better to have direct config access
+ instead of using specialized config items of the svtools
+ project. This class can wrap such configuration access.
+ */
+class UNLESS_MERGELIBS(FWI_DLLPUBLIC) ConfigAccess final
+{
+
+ public:
+
+ /** represent the possible modes of the internal wrapped configuration access */
+ enum EOpenMode
+ {
+ /// config isn't used yet
+ E_CLOSED,
+ /// config access is open for reading only
+ E_READONLY,
+ /// config access is open for reading/writing data
+ E_READWRITE
+ };
+
+ // member
+
+ private:
+ mutable osl::Mutex m_mutex;
+
+ /**
+ reference to the uno service manager
+ It's necessary to instantiate own needed services.
+ */
+ css::uno::Reference< css::uno::XComponentContext > m_xContext;
+
+ /** hold an opened configuration alive */
+ css::uno::Reference< css::uno::XInterface > m_xConfig;
+
+ /** knows the root of the opened config access point */
+ OUString m_sRoot;
+
+ /** represent the current open mode */
+ EOpenMode m_eMode;
+
+ // native interface methods
+
+ public:
+
+ ConfigAccess( const css::uno::Reference< css::uno::XComponentContext >& rxContext,
+ const OUString& sRoot );
+ ~ConfigAccess();
+
+ void open ( EOpenMode eMode );
+ void close ( );
+ EOpenMode getMode( ) const;
+
+ const css::uno::Reference< css::uno::XInterface >& cfg();
+};
+
+} // namespace framework
+
+#endif // INCLUDED_FRAMEWORK_INC_JOBS_CONFIGACCESS_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */