1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef SD_ICON_CACHE_HXX 25*b1cdbd2cSJim Jagielski #define SD_ICON_CACHE_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "SdGlobalResourceContainer.hxx" 28*b1cdbd2cSJim Jagielski #include <vcl/image.hxx> 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski namespace sd { 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski /** This simple class stores frequently used icons so that the classes that 33*b1cdbd2cSJim Jagielski use the icons do not have to store them in every one of their 34*b1cdbd2cSJim Jagielski instances. 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski Icons are adressed over their resource id and are loaded on demand. 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski This cache acts like a singleton with a lifetime equal to that of the sd 39*b1cdbd2cSJim Jagielski module. 40*b1cdbd2cSJim Jagielski */ 41*b1cdbd2cSJim Jagielski class IconCache 42*b1cdbd2cSJim Jagielski : public SdGlobalResource 43*b1cdbd2cSJim Jagielski { 44*b1cdbd2cSJim Jagielski public: 45*b1cdbd2cSJim Jagielski /** The lifetime of the returned reference is limited to that of the sd 46*b1cdbd2cSJim Jagielski module. 47*b1cdbd2cSJim Jagielski */ 48*b1cdbd2cSJim Jagielski static IconCache& Instance (void); 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski /** Return the icon with the given resource id. 51*b1cdbd2cSJim Jagielski @return 52*b1cdbd2cSJim Jagielski The returned Image may be empty when there is no icon for the 53*b1cdbd2cSJim Jagielski given id or an error occured. Should not happen under normal 54*b1cdbd2cSJim Jagielski circumstances. 55*b1cdbd2cSJim Jagielski */ 56*b1cdbd2cSJim Jagielski Image GetIcon (sal_uInt16 nResourceId); 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski private: 59*b1cdbd2cSJim Jagielski class Implementation; 60*b1cdbd2cSJim Jagielski ::std::auto_ptr<Implementation> mpImpl; 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski /** The constructor creates the one instance of the cache and registers 63*b1cdbd2cSJim Jagielski it at the SdGlobalResourceContainer to limit is lifetime to that of 64*b1cdbd2cSJim Jagielski the sd module. 65*b1cdbd2cSJim Jagielski */ 66*b1cdbd2cSJim Jagielski IconCache (void); 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski /** This destructor is called by SdGlobalResourceContainer. 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielski virtual ~IconCache (void); 71*b1cdbd2cSJim Jagielski }; 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski } // end of namespace sd 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski #endif 76