uima.hpp

/* ***********************************************************************
 *
 *  uima.hpp: images
 *  Ubit GUI Toolkit - Version 6
 *  (C) 2009 | Eric Lecolinet | TELECOM ParisTech | http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE : 
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE 
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 
 * YOU CAN REDISTRIBUTE IT AND/OR MODIFY IT UNDER THE TERMS OF THE GNU 
 * GENERAL PUBLIC LICENSE AS PUBLISHED BY THE FREE SOFTWARE FOUNDATION; 
 * EITHER VERSION 2 OF THE LICENSE, OR (AT YOUR OPTION) ANY LATER VERSION.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************/

#ifndef _uima_hpp_
#define _uima_hpp_ 1
#include <ubit/udata.hpp>
namespace ubit {

class UIma: public UData {
public:
  UCLASS(UIma)

  UIma(int width, int height);
  UIma(const char* filename = null, bool load_now = false);
  UIma(const UStr& filename, bool load_now = false);
  UIma(const char** xpm_data, bool load_now = false);
  UIma(const char** xpm_data, UConst);

  virtual ~UIma();

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  UIma& operator=(const UIma& ima2);
  void resize(int width, int height) { resize(width, height, false, false);}
  void resize(int max_width, int max_height, bool preserve_ratio, bool dont_magnify);
  bool rescale(float scale) {return rescale(scale, scale);}
    
  bool rescale(float xscale, float yscale);
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual int read(const UStr& filename, int max_width = 0, int max_height =0);
  virtual int read(const char* filename, int max_width = 0, int max_height =0);
  virtual int loadFromData(const char** xpm_data);
  virtual int loadNow();
  bool isLoaded() const {return stat > 0;}
  virtual void set(const UStr& filename);
  virtual void set(const char* filename);
  virtual void set(const char** xpm_data);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  int getWidth()  const;
  
  int getHeight() const;

  int getBpp() const;
  
  int getTransparency() const;
  
  int getStatus() const {return stat;}

  virtual bool isPix() const {return false;}
  
  virtual void update(); 

  // - - - impl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  int realize(int max_w = 0, int max_h = 0,
              UDisp* disp = null, bool force_reload = true) const;
  bool isRealized() const;

  std::list<UHardIma*>& getNatImas() const {return natimas;}

  static void getFullPath(UStr& fullpath, const char* filename);
#ifndef NO_DOC
  friend class UBox;
  friend class UHardIma;
  friend class UPix;

  virtual void setImpl(const char* fname);
  virtual void setImpl(const char** xpm_data);
  virtual void setImpl(int width, int height);
  virtual void cleanCache();
  virtual void getSize(UUpdateContext&, UDimension&) const;
  virtual void paint(UGraph&, UUpdateContext&, const URect&) const;

  UHardIma* getOrCreateIma(UDisp*, float xyscale) const;  // not virtual!
  UHardIma* findImaInCache(UDisp*, float xyscale) const;  // not virtual!
  UHardIma* addImaInCache(UDisp*, float xyscale) const;   // not virtual!
  
protected:
  mutable std::list<UHardIma*> natimas;
  char *name;
  const char **data;
  mutable signed char stat;  // can have negative values
  enum Mode {EMPTY, CREATE, READ_FROM_FILE, READ_FROM_DATA};
  mutable char mode;
  bool show_unknown_ima;
#endif
};

inline UIma& uima(const UStr& filename)  {return *new UIma(filename);}

inline UIma& uima(const char* filename)  {return *new UIma(filename);}

inline UIma& uima(const char** xpm_data) {return *new UIma(xpm_data);}

}
#endif