framework/inc/jobs/configaccess.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_FRAMEWORK_INC_JOBS_CONFIGACCESS_HXX
  21 #define INCLUDED_FRAMEWORK_INC_JOBS_CONFIGACCESS_HXX
  22
  23 #include <general.h>
  24
  25 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  26 #include <com/sun/star/uno/XComponentContext.hpp>
  27
  28 #include <rtl/ustring.hxx>
  29 #include <fwidllapi.h>
  30
  31 namespace framework{
  32
  33 /**
  34     @short  implements a simple configuration access
  35     @descr  Sometimes it's better to have direct config access
  36             instead of using soecialize config items of the svtools
  37             project. This class can wrapp such configuration access.
  38  */
  39 class FWI_DLLPUBLIC ConfigAccess
  40 {
  41
  42     public:
  43
  44         /** represent the possible modes of the internal wrapped configuration access */
  45         enum EOpenMode
  46         {
  47             /// config isn't used yet
  48             E_CLOSED,
  49             /// config access is open for reading only
  50             E_READONLY,
  51             /// config access is open for reading/writing data
  52             E_READWRITE
  53         };
  54
  55     // member
  56
  57     private:
  58         mutable osl::Mutex m_mutex;
  59
  60         /**
  61             reference to the uno service manager
  62             It's necessary to instanciate own needed services.
  63          */
  64         css::uno::Reference< css::uno::XComponentContext > m_xContext;
  65
  66         /** hold an opened configuration alive */
  67         css::uno::Reference< css::uno::XInterface > m_xConfig;
  68
  69         /** knows the root of the opened config access point */
  70         OUString m_sRoot;
  71
  72         /** represent the current open mode */
  73         EOpenMode m_eMode;
  74
  75     // native interface methods
  76
  77     public:
  78
  79                  ConfigAccess( const css::uno::Reference< css::uno::XComponentContext >& rxContext,
  80                                const OUString&                                    sRoot );
  81         virtual ~ConfigAccess();
  82
  83         void      open   ( EOpenMode eMode );
  84         void      close  (                 );
  85         EOpenMode getMode(                 ) const;
  86
  87         const css::uno::Reference< css::uno::XInterface >& cfg();
  88 };
  89
  90 } // namespace framework
  91
  92 #endif // INCLUDED_FRAMEWORK_INC_JOBS_CONFIGACCESS_HXX
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */