ubackground.hpp

/************************************************************************
 *
 *  ubackground.hpp: Widget background and transparency.
 *  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 ubackground_hpp
#define ubackground_hpp 1
#include <ubit/uattr.hpp>
namespace ubit {
  

  class UBackground : public UAttr {
  public:
    UCLASS(UBackground)
    
    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(const UColor&);
    
    UBackground(UIma&);  
    
    UBackground& operator=(const UBackground&);

    bool operator==(const UBackground&);

    virtual UBackground& setColor(const UColor& color);
    virtual UBackground& setRgba(const URgba&);
     
    virtual UBackground& setRbgaF(float r, float g, float b, float a = 1.);
    
    virtual UBackground& setRbgaI(unsigned int r, unsigned int g, unsigned int b,
                                      unsigned int a = 255);

    virtual UBackground& setNamedColor(const UStr& color_name, float a = 1.);
    
    virtual UBackground& setIma(UIma& image, bool tiling = true);
    UBackground& setTiling(bool);
    
    const UColor* getColor() const;
    
    const UIma* getIma() const;
    
    bool isTiled() const;
    
    virtual void update();
    virtual void putProp(UUpdateContext*, UElem&);
        
    // - impl. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
    UBackground(UColor&, UConst);
    UBackground(UIma&, UConst);
  protected:
    uptr<UColor> pcolor;
    uptr<UIma> pima;
    float alpha;
    bool tiling;
#endif
  };
  
  inline UBackground& ubackground() {return *new UBackground();}
  
  inline UBackground& ubackground(const UColor& col) {return *new UBackground(col);}

  inline UBackground& ubackground(UIma& ima) {return *new UBackground(ima);}

  // ==================================================== Ubit Toolkit =========
  class UAlpha : public UAttr {
  public:
    UCLASS(UAlpha)
    
    UAlpha(float = 1.0);
    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(UUpdateContext*, UElem&);
    
  private:
    float val;
  };
  
  inline UAlpha& ualpha(float value = 1.0) {return *new UAlpha(value);}
  
}
#endif