FXIconCache.h

/********************************************************************************
*                                                                               *
*                              I c o n   C a c h e                              *
*                                                                               *
*********************************************************************************
* Copyright (C) 1998,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify          *
* it under the terms of the GNU Lesser General Public License as published by   *
* the Free Software Foundation; either version 3 of the License, or             *
* (at your option) any later version.                                           *
*                                                                               *
* This library is distributed in the hope that it will be useful,               *
* but WITHOUT ANY WARRANTY; without even the implied warranty of                *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                 *
* GNU Lesser General Public License for more details.                           *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public License      *
* along with this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXICONCACHE_H
#define FXICONCACHE_H

#ifndef FXOBJECT_H
#include "FXObject.h"
#endif

namespace FX {


// Forward declarations
class FXIcon;
class FXIconSource;


// Dictionary of icons
typedef FXDictionaryOf<FXIcon> FXIconDictionary;


class FXAPI FXIconCache : public FXObject {
  FXDECLARE(FXIconCache)
private:
  FXApp            *app;        // Application object
  FXIconSource     *loader;     // Icon source loads the icons
  FXIconDictionary  dict;       // Map filename to icon resource
  FXString          path;       // Paths to search for icons
protected:
  FXIconCache();
private:
  FXIconCache(const FXIconCache&);
  FXIconCache &operator=(const FXIconCache&);
public:

  static const FXchar defaultIconPath[];

public:

  FXIconCache(FXApp* ap,const FXString& sp=defaultIconPath);

  FXApp* getApp() const { return app; }

  void setIconSource(FXIconSource* src){ loader=src; }

  FXIconSource* getIconSource() const { return loader; }

  void setIconPath(const FXString& p){ path=p; }

  const FXString& getIconPath() const { return path; }

  FXIcon* insert(const FXchar* name);

  FXIcon* insert(const FXString& name){ return insert(name.text()); }

  FXIcon* find(const FXchar* name) const { return dict.at(name); }

  FXIcon* find(const FXString& name) const { return dict.at(name); }

  void remove(const FXchar* name);

  void remove(const FXString& name){ remove(name.text()); }

  void clear();

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXIconCache();
  };


}

#endif