sd/source/ui/inc/tools/IconCache.hxx

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