lib/Texture.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 // Texture.hh for Blackbox - an X11 Window manager
   3 // Copyright (c) 2001 - 2005 Sean 'Shaleh' Perry <shaleh@debian.org>
   4 // Copyright (c) 1997 - 2000, 2002 - 2005
   5 //         Bradley T Hughes <bhughes at trolltech.com>
   6 //
   7 // Permission is hereby granted, free of charge, to any person obtaining a
   8 // copy of this software and associated documentation files (the "Software"),
   9 // to deal in the Software without restriction, including without limitation
  10 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11 // and/or sell copies of the Software, and to permit persons to whom the
  12 // Software is furnished to do so, subject to the following conditions:
  13 //
  14 // The above copyright notice and this permission notice shall be included in
  15 // all copies or substantial portions of the Software.
  16 //
  17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23 // DEALINGS IN THE SOFTWARE.
  24
  25 #ifndef __Texture_hh
  26 #define __Texture_hh
  27
  28 #include "Color.hh"
  29 #include "Util.hh"
  30
  31 namespace bt {
  32
  33   // forward declarations
  34   class Rect;
  35   class Resource;
  36   class Texture;
  37
  38   void drawTexture(unsigned int screen,
  39                    const Texture &texture,
  40                    Drawable drawable,
  41                    const Rect &trect,
  42                    const Rect &urect,
  43                    Pixmap pixmap = 0ul);
  44
  45   Texture
  46   textureResource(const Display &display, unsigned int screen,
  47                   const Resource &resource,
  48                   const std::string &name,
  49                   const std::string &classname,
  50                   const std::string &default_color = std::string("black"));
  51
  52   class Texture {
  53   public:
  54     enum Type {
  55       // bevel options
  56       Flat                = (1l<<0),
  57       Sunken              = (1l<<1),
  58       Raised              = (1l<<2),
  59       // textures
  60       Solid               = (1l<<3),
  61       Gradient            = (1l<<4),
  62       // gradients
  63       Horizontal          = (1l<<5),
  64       Vertical            = (1l<<6),
  65       Diagonal            = (1l<<7),
  66       CrossDiagonal       = (1l<<8),
  67       Rectangle           = (1l<<9),
  68       Pyramid             = (1l<<10),
  69       PipeCross           = (1l<<11),
  70       Elliptic            = (1l<<12),
  71       // parent relative image
  72       Parent_Relative     = (1l<<13),
  73       // fake interlaced image
  74       Interlaced          = (1l<<14),
  75       // border around image
  76       Border              = (1l<<15)
  77     };
  78
  79     inline Texture(void)
  80       : t(0ul), bw(0u)
  81     { }
  82     inline Texture(const Texture &tt)
  83     { *this = tt; }
  84
  85     inline const std::string &description(void) const
  86     { return descr; }
  87     void setDescription(const std::string &d);
  88
  89     void setColor1(const Color &new_color);
  90     inline void setColor2(const Color &new_color)
  91     { c2 = new_color; }
  92     inline void setBorderColor(const Color &new_borderColor)
  93     { bc = new_borderColor; }
  94
  95     inline const Color &color1(void) const
  96     { return c1; }
  97     inline const Color &color2(void) const
  98     { return c2; }
  99     inline const Color &borderColor(void) const
 100     { return bc; }
 101     inline const Color &lightColor(void) const
 102     { return lc; }
 103     inline const Color &shadowColor(void) const
 104     { return sc; }
 105
 106     inline unsigned long texture(void) const
 107     { return t; }
 108     inline void setTexture(unsigned long _texture)
 109     { t  = _texture; }
 110     inline void addTexture(unsigned long _texture)
 111     { t |= _texture; }
 112
 113     inline unsigned int borderWidth(void) const
 114     { return bw; }
 115     inline void setBorderWidth(unsigned int new_bw)
 116     { bw = new_bw; }
 117
 118     Texture &operator=(const Texture &tt);
 119     inline bool operator==(const Texture &tt) const {
 120       return (c1 == tt.c1 && c2 == tt.c2 && bc == tt.bc &&
 121               lc == tt.lc && sc == tt.sc && t == tt.t && bw == tt.bw);
 122     }
 123     inline bool operator!=(const Texture &tt) const
 124     { return (!operator==(tt)); }
 125
 126   private:
 127     std::string descr;
 128     Color c1, c2, bc, lc, sc;
 129     unsigned long t;
 130     unsigned int bw;
 131   };
 132
 133 } // namespace bt
 134
 135 #endif // __Texture_hh