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