sd/source/ui/slidesorter/cache/SlsCacheConfiguration.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/Any.hxx>
  23 #include <vcl/timer.hxx>
  24 #include <memory>
  25
  26 namespace com::sun::star::container
  27 {
  28 class XNameAccess;
  29 }
  30
  31 namespace sd::slidesorter::cache
  32 {
  33 /** A very simple and easy-to-use access to configuration entries regarding
  34     the slide sorter cache.
  35 */
  36 class CacheConfiguration
  37 {
  38 public:
  39     /** Return an instance to this class.  The reference is released after 5
  40         seconds.  Subsequent calls to this function will create a new
  41         instance.
  42     */
  43     static std::shared_ptr<CacheConfiguration> Instance();
  44
  45     static void Shutdown();
  46
  47     /** Look up the specified value in
  48         MultiPaneGUI/SlideSorter/PreviewCache.   When the specified value
  49         does not exist then an empty Any is returned.
  50     */
  51     css::uno::Any GetValue(const OUString& rName);
  52
  53 private:
  54     /** When a caller holds a reference after we have released ours we use
  55         this weak pointer to avoid creating a new instance.
  56     */
  57     static std::weak_ptr<CacheConfiguration> mpWeakInstance;
  58     Timer m_ReleaseTimer;
  59     css::uno::Reference<css::container::XNameAccess> mxCacheNode;
  60
  61     CacheConfiguration();
  62
  63     DECL_STATIC_LINK(CacheConfiguration, TimerCallback, Timer*, void);
  64 };
  65
  66 } // end of namespace ::sd::slidesorter::cache
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */