xref: /AOO41X/main/sd/source/ui/slidesorter/cache/SlsCacheConfiguration.hxx (revision 67e470dafe1997e73f56ff7ff4878983707e3e07)
1*c45d927aSAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*c45d927aSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*c45d927aSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*c45d927aSAndrew Rist  * distributed with this work for additional information
6*c45d927aSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*c45d927aSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*c45d927aSAndrew Rist  * "License"); you may not use this file except in compliance
9*c45d927aSAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*c45d927aSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*c45d927aSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*c45d927aSAndrew Rist  * software distributed under the License is distributed on an
15*c45d927aSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*c45d927aSAndrew Rist  * KIND, either express or implied.  See the License for the
17*c45d927aSAndrew Rist  * specific language governing permissions and limitations
18*c45d927aSAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*c45d927aSAndrew Rist  *************************************************************/
21*c45d927aSAndrew Rist 
22*c45d927aSAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef SD_SLIDESORTER_CACHE_CONFIGURATION_HXX
25cdf0e10cSrcweir #define SD_SLIDESORTER_CACHE_CONFIGURATION_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include <com/sun/star/uno/Any.hxx>
28cdf0e10cSrcweir #include <vcl/timer.hxx>
29cdf0e10cSrcweir #include <com/sun/star/container/XNameAccess.hpp>
30cdf0e10cSrcweir #include <boost/shared_ptr.hpp>
31cdf0e10cSrcweir #include <boost/weak_ptr.hpp>
32cdf0e10cSrcweir 
33cdf0e10cSrcweir namespace sd { namespace slidesorter { namespace cache {
34cdf0e10cSrcweir 
35cdf0e10cSrcweir /** A very simple and easy-to-use access to configuration entries regarding
36cdf0e10cSrcweir     the slide sorter cache.
37cdf0e10cSrcweir */
38cdf0e10cSrcweir class CacheConfiguration
39cdf0e10cSrcweir {
40cdf0e10cSrcweir public:
41cdf0e10cSrcweir     /** Return an instance to this class.  The reference is released after 5
42cdf0e10cSrcweir         seconds.  Subsequent calls to this function will create a new
43cdf0e10cSrcweir         instance.
44cdf0e10cSrcweir     */
45cdf0e10cSrcweir     static ::boost::shared_ptr<CacheConfiguration> Instance (void);
46cdf0e10cSrcweir 
47cdf0e10cSrcweir     /** Look up the specified value in
48cdf0e10cSrcweir         MultiPaneGUI/SlideSorter/PreviewCache.   When the specified value
49cdf0e10cSrcweir         does not exist then an empty Any is returned.
50cdf0e10cSrcweir     */
51cdf0e10cSrcweir     ::com::sun::star::uno::Any GetValue (const ::rtl::OUString& rName);
52cdf0e10cSrcweir 
53cdf0e10cSrcweir private:
54cdf0e10cSrcweir     static ::boost::shared_ptr<CacheConfiguration> mpInstance;
55cdf0e10cSrcweir     /** When a caller holds a reference after we have released ours we use
56cdf0e10cSrcweir         this weak pointer to avoid creating a new instance.
57cdf0e10cSrcweir     */
58cdf0e10cSrcweir     static ::boost::weak_ptr<CacheConfiguration> mpWeakInstance;
59cdf0e10cSrcweir     static Timer maReleaseTimer;
60cdf0e10cSrcweir     ::com::sun::star::uno::Reference<
61cdf0e10cSrcweir         ::com::sun::star::container::XNameAccess> mxCacheNode;
62cdf0e10cSrcweir 
63cdf0e10cSrcweir     CacheConfiguration (void);
64cdf0e10cSrcweir 
65cdf0e10cSrcweir     DECL_LINK(TimerCallback, Timer*);
66cdf0e10cSrcweir };
67cdf0e10cSrcweir 
68cdf0e10cSrcweir } } } // end of namespace ::sd::slidesorter::cache
69cdf0e10cSrcweir 
70cdf0e10cSrcweir #endif
71