ryzom/client/src/interfaces_manager/button_base.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19 #ifndef NL_BUTTON_BASE_H
  20 #define NL_BUTTON_BASE_H
  21
  22
  23 /////////////
  24 // Include //
  25 /////////////
  26 // Misc.
  27 #include "nel/misc/types_nl.h"
  28 #include "nel/misc/rgba.h"
  29
  30
  31 ///////////
  32 // Using //
  33 ///////////
  34 using NLMISC::CRGBA;
  35
  36
  37 /**
  38  * Class to be the basis of a button.
  39  * \author Guillaume PUZIN
  40  * \author Nevrax France
  41  * \date 2001
  42  */
  43 class CButtonBase
  44 {
  45 public:
  46         enum TBG        // BG = Background.
  47         {
  48                 BG_none = 0,    // NO BG.
  49                 BG_plain,               // BG is only made with 1 color (RGBA).
  50                 BG_stretch              // BG is a stretched Bitmap and 1 color (RGBA).
  51         };
  52
  53 private:
  54         inline void init(uint tOn, uint tOff, uint tDisable, const CRGBA &on, const CRGBA &off, const CRGBA &disable);
  55
  56 protected:
  57         bool    _On;
  58         bool    _Enable;
  59         CRGBA   _ColorOn;
  60         CRGBA   _ColorOff;
  61         CRGBA   _ColorDisable;
  62         uint    _TextureOn;
  63         uint    _TextureOff;
  64         uint    _TextureDisable;
  65         TBG             _BGModeOn;
  66         TBG             _BGModeOff;
  67         TBG             _BGModeDisable;
  68
  69 public:
  70         /// Constructor
  71         CButtonBase();
  72         CButtonBase(uint tOn, uint tOff, uint tDisable);
  73         CButtonBase(const CRGBA &on, const CRGBA &off, const CRGBA &disable);
  74         CButtonBase(uint tOn, uint tOff, uint tDisable, const CRGBA &on, const CRGBA &off, const CRGBA &disable);
  75
  76         /// \name accessors for writing
  77         // @{
  78         /// Change color when On.
  79         void colorOn(const CRGBA &color);
  80         /// Change color when Off.
  81         void colorOff(const CRGBA &color);
  82         /// Change color when Disable.
  83         void colorDisable(const CRGBA &color);
  84
  85         /// Change texture when On.
  86         void textureOn(uint texture);
  87         /// Change texture when Off.
  88         void textureOff(uint texture);
  89         /// Change texture when Disable.
  90         void textureDisable(uint texture);
  91
  92         /// Change the mode to display the background of the button when On.
  93         void bgModeOn(const TBG &mode) {_BGModeOn = mode;}
  94         /// Change the mode to display the background of the button when Off.
  95         void bgModeOff(const TBG &mode) {_BGModeOff = mode;}
  96         /// Change the mode to display the background of the button when Disable.
  97         void bgModeDisable(const TBG &mode) {_BGModeDisable = mode;}
  98         // @}
  99
 100         /// \name accessors for reading
 101         // @{
 102         /// get color when On.
 103         inline const CRGBA &colorOn() const { return _ColorOn; }
 104         /// get color when Off.
 105         inline const CRGBA &colorOff() const { return _ColorOff; }
 106         /// get color when Disable.
 107         inline const CRGBA &colorDisable() const { return _ColorDisable; }
 108
 109         /// get texture when On.
 110         inline uint textureOn() const { return _TextureOn; }
 111         /// get texture when Off.
 112         inline uint textureOff() const { return _TextureOff; }
 113         /// get texture when Disable.
 114         inline uint textureDisable() const { return _TextureDisable; }
 115
 116         /// get the background display mode when On.
 117         inline const TBG & bgModeOn() const { return _BGModeOn; }
 118         /// get the background display mode when Off.
 119         inline const TBG & bgModeOff() const { return _BGModeOff; }
 120         /// get the background display mode when Disable.
 121         inline const TBG & bgModeDisable() const { return _BGModeDisable; }
 122         // @}
 123
 124
 125         /// Get the state of the button(Enable/Disable).
 126         bool enable();
 127         /// Enable or Disable the Button.
 128         void enable(bool e);
 129
 130         /// return true if the button is selected
 131         bool isSelected() const { return _On; }
 132
 133         /// Select the button.
 134         virtual void select();
 135
 136         /// Un-Select the button.
 137         virtual void unSelect();
 138 };
 139
 140
 141 #endif // NL_BUTTON_BASE_H
 142
 143 /* End of button_base.h */