xref: /trunk/main/svtools/source/graphic/grfcache.hxx (revision 914d351e5f5b84e4342a86d6ab8d4aca7308b9bd)
1*01aa44aaSAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*01aa44aaSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*01aa44aaSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*01aa44aaSAndrew Rist  * distributed with this work for additional information
6*01aa44aaSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*01aa44aaSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*01aa44aaSAndrew Rist  * "License"); you may not use this file except in compliance
9*01aa44aaSAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*01aa44aaSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*01aa44aaSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*01aa44aaSAndrew Rist  * software distributed under the License is distributed on an
15*01aa44aaSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*01aa44aaSAndrew Rist  * KIND, either express or implied.  See the License for the
17*01aa44aaSAndrew Rist  * specific language governing permissions and limitations
18*01aa44aaSAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*01aa44aaSAndrew Rist  *************************************************************/
21*01aa44aaSAndrew Rist 
22*01aa44aaSAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef _GRFCACHE_HXX
25cdf0e10cSrcweir #define _GRFCACHE_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include <tools/list.hxx>
28cdf0e10cSrcweir #include <vcl/graph.hxx>
29cdf0e10cSrcweir #include <vcl/timer.hxx>
30cdf0e10cSrcweir #include <svtools/grfmgr.hxx>
31cdf0e10cSrcweir 
32cdf0e10cSrcweir // -----------------------
33cdf0e10cSrcweir // - GraphicManagerCache -
34cdf0e10cSrcweir // -----------------------
35cdf0e10cSrcweir 
36cdf0e10cSrcweir class GraphicCacheEntry;
37cdf0e10cSrcweir 
38cdf0e10cSrcweir class GraphicCache
39cdf0e10cSrcweir {
40cdf0e10cSrcweir private:
41cdf0e10cSrcweir 
42cdf0e10cSrcweir     GraphicManager&             mrMgr;
43cdf0e10cSrcweir     Timer                       maReleaseTimer;
44cdf0e10cSrcweir     List                        maGraphicCache;
45cdf0e10cSrcweir     List                        maDisplayCache;
46cdf0e10cSrcweir     sal_uLong                       mnReleaseTimeoutSeconds;
47cdf0e10cSrcweir     sal_uLong                       mnMaxDisplaySize;
48cdf0e10cSrcweir     sal_uLong                       mnMaxObjDisplaySize;
49cdf0e10cSrcweir     sal_uLong                       mnUsedDisplaySize;
50cdf0e10cSrcweir 
51cdf0e10cSrcweir     sal_Bool                        ImplFreeDisplayCacheSpace( sal_uLong nSizeToFree );
52cdf0e10cSrcweir     GraphicCacheEntry*          ImplGetCacheEntry( const GraphicObject& rObj );
53cdf0e10cSrcweir 
54cdf0e10cSrcweir 
55cdf0e10cSrcweir                                 DECL_LINK( ReleaseTimeoutHdl, Timer* pTimer );
56cdf0e10cSrcweir 
57cdf0e10cSrcweir public:
58cdf0e10cSrcweir 
59cdf0e10cSrcweir                                 GraphicCache( GraphicManager& rMgr,
60cdf0e10cSrcweir                                               sal_uLong nDisplayCacheSize = 10000000UL,
61cdf0e10cSrcweir                                               sal_uLong nMaxObjDisplayCacheSize = 2400000UL );
62cdf0e10cSrcweir                                 ~GraphicCache();
63cdf0e10cSrcweir 
64cdf0e10cSrcweir public:
65cdf0e10cSrcweir 
66cdf0e10cSrcweir     void                        AddGraphicObject( const GraphicObject& rObj, Graphic& rSubstitute,
67cdf0e10cSrcweir                                                   const ByteString* pID, const GraphicObject* pCopyObj );
68cdf0e10cSrcweir     void                        ReleaseGraphicObject( const GraphicObject& rObj );
69cdf0e10cSrcweir 
70cdf0e10cSrcweir     void                        GraphicObjectWasSwappedOut( const GraphicObject& rObj );
71cdf0e10cSrcweir     sal_Bool                        FillSwappedGraphicObject( const GraphicObject& rObj, Graphic& rSubstitute );
72cdf0e10cSrcweir     void                        GraphicObjectWasSwappedIn( const GraphicObject& rObj );
73cdf0e10cSrcweir 
74cdf0e10cSrcweir     ByteString                  GetUniqueID( const GraphicObject& rObj ) const;
75cdf0e10cSrcweir 
76cdf0e10cSrcweir public:
77cdf0e10cSrcweir 
78cdf0e10cSrcweir     void                        SetMaxDisplayCacheSize( sal_uLong nNewCacheSize );
GetMaxDisplayCacheSize() const79cdf0e10cSrcweir     sal_uLong                       GetMaxDisplayCacheSize() const { return mnMaxDisplaySize; };
80cdf0e10cSrcweir 
81cdf0e10cSrcweir     void                        SetMaxObjDisplayCacheSize( sal_uLong nNewMaxObjSize, sal_Bool bDestroyGreaterCached = sal_False );
GetMaxObjDisplayCacheSize() const82cdf0e10cSrcweir     sal_uLong                       GetMaxObjDisplayCacheSize() const { return mnMaxObjDisplaySize; }
83cdf0e10cSrcweir 
GetUsedDisplayCacheSize() const84cdf0e10cSrcweir     sal_uLong                       GetUsedDisplayCacheSize() const { return mnUsedDisplaySize; }
GetFreeDisplayCacheSize() const85cdf0e10cSrcweir     sal_uLong                       GetFreeDisplayCacheSize() const { return( mnMaxDisplaySize - mnUsedDisplaySize ); }
86cdf0e10cSrcweir 
87cdf0e10cSrcweir     void                        SetCacheTimeout( sal_uLong nTimeoutSeconds );
GetCacheTimeout() const88cdf0e10cSrcweir     sal_uLong                       GetCacheTimeout() const { return mnReleaseTimeoutSeconds; }
89cdf0e10cSrcweir 
90cdf0e10cSrcweir     void                        ClearDisplayCache();
91cdf0e10cSrcweir     sal_Bool                        IsDisplayCacheable( OutputDevice* pOut, const Point& rPt, const Size& rSz,
92cdf0e10cSrcweir                                                     const GraphicObject& rObj, const GraphicAttr& rAttr ) const;
93cdf0e10cSrcweir     sal_Bool                        IsInDisplayCache( OutputDevice* pOut, const Point& rPt, const Size& rSz,
94cdf0e10cSrcweir                                                   const GraphicObject& rObj, const GraphicAttr& rAttr ) const;
95cdf0e10cSrcweir     sal_Bool                        CreateDisplayCacheObj( OutputDevice* pOut, const Point& rPt, const Size& rSz,
96cdf0e10cSrcweir                                                        const GraphicObject& rObj, const GraphicAttr& rAttr,
97cdf0e10cSrcweir                                                        const BitmapEx& rBmpEx );
98cdf0e10cSrcweir     sal_Bool                        CreateDisplayCacheObj( OutputDevice* pOut, const Point& rPt, const Size& rSz,
99cdf0e10cSrcweir                                                        const GraphicObject& rObj, const GraphicAttr& rAttr,
100cdf0e10cSrcweir                                                        const GDIMetaFile& rMtf );
101cdf0e10cSrcweir     sal_Bool                        DrawDisplayCacheObj( OutputDevice* pOut, const Point& rPt, const Size& rSz,
102cdf0e10cSrcweir                                                      const GraphicObject& rObj, const GraphicAttr& rAttr );
103cdf0e10cSrcweir };
104cdf0e10cSrcweir 
105cdf0e10cSrcweir #endif // _GRFCACHE_HXX
106