uprop.hpp

/* ==================================================== ======== ======= *
 *
 *  uprop.hpp: objects' properties
 *  Ubit Project
 *  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
 *  (C) 1999-2006 EricLecolinet / ENST Paris / 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.
 * ***********************************************************************
 * ==================================================== [(c)Elc] ======= *
 * ==================================================== ======== ======= */

#ifndef _uprop_hpp_
#define _uprop_hpp_
//pragma ident  "@(#)uprop.hpp  ubit:05.05.00"
#include <ubit/unumber.hpp>
namespace ubit {

/* ==================================================== ===== ======= */
class UProp: public UBrick {
public:
  UBIT_ATTR_CLASS(UProp,UBrick)  
  
  UProp(UMask b_modes = 0);
  virtual ~UProp();

  virtual class UProp* propCast() {return this;}

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  virtual unsigned short getNodeType() const {return ATTRIBUTE_NODE;}

  virtual const UStr* getNodeName() const {return &getClassName();}

  virtual const UStr* getNodeValue() const {return getValue();}

  virtual const UStr* getName() const {return &getClassName();}
  
  virtual const UStr* getValue() const;
    
  virtual void setValue(const UStr&);

  virtual void initNode(UDoc*, UGroup* parent) {}

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

  virtual UProp& onChange(UCall&);
  virtual void changed(bool update = true);
  virtual void update() {}
  
  virtual void putProp(UContext*, UControl*) {}

protected:
  friend class UBox;
  uptr<UStr> pvalue;
};

/* ==================================================== [(c)Elc] ======= */
/* ==================================================== ======== ======= */
class UProps : public UProp {
public:
  UBIT_ATTR_CLASS(UProps, UProp)

  void addProp(UProp&);
  void addProp(const UStr& name, const UStr& value);
  
  UStr* getProp(const UStr&, bool ignore_case = true);
  
  virtual void update();
  virtual void putProp(UContext*, UControl*);  
};

/* ==================================================== ===== ======= */
/* Tool Tip.
*/
class UTip: public UProp {
public:
  UBIT_ATTR_CLASS(UTip, UProp)

  UTip(const char* label = null);
  UTip(const UArgs& arglist);
  friend UTip& utip(const char* label = null) {return *new UTip(label);}
  friend UTip& utip(const UArgs& arglist) {return *new UTip(arglist);}

  virtual ~UTip();
    
  //UStr& value() {return *pvalue;}
  /* returns the string value.
    * - example: UTip t; t.value() = "Do it"; UStr s = t.value(); 
    * - value() can be shared, but can't be deleted!
    */
  
  virtual UTip& set(const char* label);
  virtual UTip& set(const UArgs& arglist);

  // - impl. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
  virtual void addingTo(UChild* self, UGroup *parent);
  virtual void removingFrom(UChild* self, UGroup *parent);
  //NB: removingFrom() impose un destructeur
  uptr<UBrick> content;
#endif
};

/* ==================================================== [Elc] ======= */
/* ==================================================== ===== ======= */
class UBackground : public UProp {
public:
  UBIT_ATTR_CLASS(UBackground, UProp)

  static UBackground none, inherit,
  metal, velin, white, black, grey, lightgrey, darkgrey, navy, lightblue, blue, 
  red, green, yellow, orange, wheat, teal;
  
  ~UBackground();

  UBackground();

  UBackground(const UBackground&);
 
  UBackground(UColor&);
    
  UBackground(UIma&);  
    
  friend UBackground& ubackground(UBackground& b) {return *new UBackground(b);}
  friend UBackground& ubackground(UColor& c) {return *new UBackground(c);}
  friend UBackground& ubackground(UIma& i) {return *new UBackground(i);}
  
  UBackground& operator=(const UBackground&);
  
  bool operator==(const UBackground&);
    
  virtual UBackground& setColor(UColor&);
    
  virtual UBackground& setIma(UIma&, bool tiling = true);
  virtual UBackground& setTiling(bool);

  operator UColor&();
  
  const UColor* getColor() const;
  UColor* getColor();
  
  const UIma* getIma() const;
  UIma* getIma();

  bool isTiled() const;

  virtual void update();
  virtual void putProp(UContext*, UControl*);

  friend UBackground& ubgcolor(int r, int g, int b);

  void set(UColor& c) {setColor(c);}

  // - impl. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
  UBackground(UColor&, UMask);
  UBackground(UIma&, UMask);
protected:
  uptr<UBrick> pval;
  bool tiling;
#endif
};

/* ==================================================== ===== ======= */
class UAlpha : public UProp {
public:
  UBIT_ATTR_CLASS(UAlpha, UProp)

  UAlpha(float = 1.0);
  friend UAlpha& ualpha(float v = 1.0) {return *new UAlpha(v);}
  
  operator float() const {return val;}
  
  UAlpha& operator=(float v)         {return set(v);}
  UAlpha& operator=(const UFloat& v) {return set(v);}
  UAlpha& operator=(const UAlpha& v) {return set(v.val);}
  virtual UAlpha& set(float);  
  
  bool operator==(float v)         const {return val == v;}  
  bool operator==(const UFloat& v) const {return val == v;}  
  bool operator==(const UAlpha& v) const {return val == v.val;}
  
  virtual void update();
  virtual void putProp(UContext*, UControl*);
  
private:
  float val;
};

/* ==================================================== [Elc] ======= */
/* ==================================================== ===== ======= */
class UFlagdef : public UProp {
public:
  UBIT_ATTR_CLASS(UFlagdef, UProp)

  UFlagdef();
  UFlagdef(const UFlag&);

  friend UFlagdef& uflagdef();
  friend UFlagdef& uflagdef(const UFlag& f);
  
  UFlagdef& operator=(const UFlag& f) {return set(f);} 
  virtual UFlagdef& set(const UFlag&);
  virtual UFlagdef& clear();
  
  const UFlag* getFlag() const {return flag;}
  
  virtual void update();
  virtual void putProp(UContext*, UControl*);

  // - - - impl - - - - -- - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
protected:
  const UFlag* flag;
#endif
};

/* ==================================================== ===== ======= */
class UPropdef : public UFlagdef {
public:
  UBIT_ATTR_CLASS(UPropdef, UProp)

  UPropdef();
  UPropdef(const UFlag&);
  UPropdef(const UFlag&, UProp&);

  friend UPropdef& upropdef();
  friend UPropdef& upropdef(const class UFlag& f, UProp&);

  virtual UPropdef& set(const UFlag&);
  virtual UPropdef& set(UProp&);
  virtual UPropdef& set(const UFlag&, UProp&);
  virtual UPropdef& clear();

  UProp* getProp() const {return prop;}
  virtual void putProp(UContext*, UControl*);

private:
  uptr<UProp> prop;
};

/* ==================================================== ===== ======= */
class UPropval : public UProp {
public:
  UBIT_ATTR_CLASS(UPropval, UProp)

  UPropval();
  UPropval(const UFlag&);
  friend UPropval& upropval(const class UFlag& f);

  const UFlag* getFlag() const {return flag;}

  virtual void update();
  virtual void putProp(UContext*, UControl*);

private:
  const UFlag* flag;
};

/* ==================================================== ===== ======= */
/* Window Title.
*/
class UTitle: public UProp {
public:
  UBIT_ATTR_CLASS(UTitle, UProp)

  UTitle(const char* = "");
  UTitle(const UStr&);
  friend UTitle& utitle(const char*_s) {return *new UTitle(_s);}
  friend UTitle& utitle(const UStr&_s) {return *new UTitle(_s);}
  
  UStr& value() {return *pvalue;}
  /* returns the value.
    * - example: UTitle t; t.value() = "Main Win"; UStr s = t.value();
    * - value() can be shared (but can't be deleted!)
    */
  
  virtual void update();

  // - impl. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
private:
    //uptr<UStr> pvalue;
    bool changed;
#endif
};

}
#endif
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [(c)Elc] ======= */

---