1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef SD_ICON_CACHE_HXX 29*cdf0e10cSrcweir #define SD_ICON_CACHE_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include "SdGlobalResourceContainer.hxx" 32*cdf0e10cSrcweir #include <vcl/image.hxx> 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir namespace sd { 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir /** This simple class stores frequently used icons so that the classes that 37*cdf0e10cSrcweir use the icons do not have to store them in every one of their 38*cdf0e10cSrcweir instances. 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir Icons are adressed over their resource id and are loaded on demand. 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir This cache acts like a singleton with a lifetime equal to that of the sd 43*cdf0e10cSrcweir module. 44*cdf0e10cSrcweir */ 45*cdf0e10cSrcweir class IconCache 46*cdf0e10cSrcweir : public SdGlobalResource 47*cdf0e10cSrcweir { 48*cdf0e10cSrcweir public: 49*cdf0e10cSrcweir /** The lifetime of the returned reference is limited to that of the sd 50*cdf0e10cSrcweir module. 51*cdf0e10cSrcweir */ 52*cdf0e10cSrcweir static IconCache& Instance (void); 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir /** Return the icon with the given resource id. 55*cdf0e10cSrcweir @return 56*cdf0e10cSrcweir The returned Image may be empty when there is no icon for the 57*cdf0e10cSrcweir given id or an error occured. Should not happen under normal 58*cdf0e10cSrcweir circumstances. 59*cdf0e10cSrcweir */ 60*cdf0e10cSrcweir Image GetIcon (sal_uInt16 nResourceId); 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir private: 63*cdf0e10cSrcweir class Implementation; 64*cdf0e10cSrcweir ::std::auto_ptr<Implementation> mpImpl; 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir /** The constructor creates the one instance of the cache and registers 67*cdf0e10cSrcweir it at the SdGlobalResourceContainer to limit is lifetime to that of 68*cdf0e10cSrcweir the sd module. 69*cdf0e10cSrcweir */ 70*cdf0e10cSrcweir IconCache (void); 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir /** This destructor is called by SdGlobalResourceContainer. 73*cdf0e10cSrcweir */ 74*cdf0e10cSrcweir virtual ~IconCache (void); 75*cdf0e10cSrcweir }; 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir } // end of namespace sd 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir #endif 80