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 #pragma once
  21
  22 #include <com/sun/star/uno/XComponentContext.hpp>
  23 #include <rtl/ustring.hxx>
  24 #include <mutex>
  25
  26 namespace framework{
  27
  28 /**
  29     @short  implements a simple configuration access
  30     @descr  Sometimes it's better to have direct config access
  31             instead of using specialized config items of the svtools
  32             project. This class can wrap such configuration access.
  33  */
  34 class ConfigAccess final
  35 {
  36
  37     public:
  38
  39         /** represent the possible modes of the internal wrapped configuration access */
  40         enum EOpenMode
  41         {
  42             /// config isn't used yet
  43             E_CLOSED,
  44             /// config access is open for reading only
  45             E_READONLY,
  46             /// config access is open for reading/writing data
  47             E_READWRITE
  48         };
  49
  50     // member
  51
  52     private:
  53         mutable std::mutex m_mutex;
  54
  55         /**
  56             reference to the uno service manager
  57             It's necessary to instantiate own needed services.
  58          */
  59         css::uno::Reference< css::uno::XComponentContext > m_xContext;
  60
  61         /** hold an opened configuration alive */
  62         css::uno::Reference< css::uno::XInterface > m_xConfig;
  63
  64         /** knows the root of the opened config access point */
  65         OUString m_sRoot;
  66
  67         /** represent the current open mode */
  68         EOpenMode m_eMode;
  69
  70     // native interface methods
  71
  72         void      closeImpl();
  73     public:
  74
  75                  ConfigAccess( css::uno::Reference< css::uno::XComponentContext > xContext,
  76                                OUString                                     sRoot );
  77                  ~ConfigAccess();
  78
  79         void      open   ( EOpenMode eMode );
  80         void      close  (                 );
  81         EOpenMode getMode(                 ) const;
  82
  83         const css::uno::Reference< css::uno::XInterface >& cfg();
  84 };
  85
  86 } // namespace framework
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */