xref: /AOO41X/main/sd/source/ui/slidesorter/cache/SlsCacheConfiguration.hxx (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef SD_SLIDESORTER_CACHE_CONFIGURATION_HXX
29 #define SD_SLIDESORTER_CACHE_CONFIGURATION_HXX
30 
31 #include <com/sun/star/uno/Any.hxx>
32 #include <vcl/timer.hxx>
33 #include <com/sun/star/container/XNameAccess.hpp>
34 #include <boost/shared_ptr.hpp>
35 #include <boost/weak_ptr.hpp>
36 
37 namespace sd { namespace slidesorter { namespace cache {
38 
39 /** A very simple and easy-to-use access to configuration entries regarding
40     the slide sorter cache.
41 */
42 class CacheConfiguration
43 {
44 public:
45     /** Return an instance to this class.  The reference is released after 5
46         seconds.  Subsequent calls to this function will create a new
47         instance.
48     */
49     static ::boost::shared_ptr<CacheConfiguration> Instance (void);
50 
51     /** Look up the specified value in
52         MultiPaneGUI/SlideSorter/PreviewCache.   When the specified value
53         does not exist then an empty Any is returned.
54     */
55     ::com::sun::star::uno::Any GetValue (const ::rtl::OUString& rName);
56 
57 private:
58     static ::boost::shared_ptr<CacheConfiguration> mpInstance;
59     /** When a caller holds a reference after we have released ours we use
60         this weak pointer to avoid creating a new instance.
61     */
62     static ::boost::weak_ptr<CacheConfiguration> mpWeakInstance;
63     static Timer maReleaseTimer;
64     ::com::sun::star::uno::Reference<
65         ::com::sun::star::container::XNameAccess> mxCacheNode;
66 
67     CacheConfiguration (void);
68 
69     DECL_LINK(TimerCallback, Timer*);
70 };
71 
72 } } } // end of namespace ::sd::slidesorter::cache
73 
74 #endif
75