colorbtn.h

Go to the documentation of this file.

/**
 * \file mgui/colorbtn.h
 * \brief MGUI CTRL_COLORBUTTON and FORM_COLORBUTTON class definitions
 *
 * \if NODOC
 * $Id: colorbtn.h_v 1.8 2005/03/31 16:57:07 fileserver!dwilliss Exp $
 *
 * $Log: colorbtn.h_v $
 * Revision 1.8  2005/03/31 16:57:07  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.7  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.6  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.5  2003/04/09 20:46:42  dwilliss
 * Don't use _T in templates. Mac ctypes.h defines a global _T
 *
 * Revision 1.4  2002/10/09 16:31:00  mju
 * Moved to 'mgui' folder.
 *
 * Revision 1.2  2001/12/13 20:15:32  mju
 * Add CTRL version without label.
 *
 * Revision 1.1  2001/12/13 16:58:26  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MGUI_COLORBTN_H
#define  INC_MGUI_COLORBTN_H

#ifndef  INC_MGUI_CTRL_H
#include <mgui/ctrl.h>
#endif

namespace MGUI {

//===================================================================================================================
//! PushButton control for showing and selecting a "color".
//! The button will be shown in the selected color and contains no visible text.
class CTRL_COLORBUTTON : public MGUI::CTRL {
   public:

      enum STYLE {
         STYLE_Default =            0x0000,
         STYLE_OutputOnly =         0x0001,     //!< User cannot change value
         STYLE_AllowTransparent =   0x0002      //!< Allow transparent/transparency settings
         };

      //! Constructor.
      CTRL_COLORBUTTON (
         );

      //! Destructor.
      virtual ~CTRL_COLORBUTTON (
         );

      //! Create control.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const COLOR& dftcolor,                 //!< Default color
         STYLE style = STYLE_Default,           //!< Control style
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize
         );

      //! Get current color.
      const COLOR& GetColor (
         ) const { return (m_color); }

      //! Get current color.
      COLORREF GetColorRef (
         ) const { return (m_color.GetColorRef()); }

      //! Set color.
      void SetColor (
         const COLOR& color,                 //!< New color value to set
         bool notify = true                  //!< Call OnChangeColor() if 'true'
         );

      //! Set color.
      void SetColor (
         const COLORREF color,               //!< New color value to set
         bool notify = true                  //!< Call OnChangeColor() if 'true'
         ) { COLOR c; c.SetColorRef(color); SetColor(c, notify); }

   protected:

      //! Called when color is changed.
      //! Derived class must call corresponding superclass method BEFORE performing its own processing.
      virtual void OnChangeColor (
         );

   private:
   #ifndef GENERATING_DOXYGEN_OUTPUT

   #ifdef WIN32_MFC
      class MyButton : public CButton {
         public:
            MyButton (
               CTRL_COLORBUTTON& guiform
               ): m_guiform(guiform)
               { }
         protected:
            afx_msg void OnClicked ();
            DECLARE_MESSAGE_MAP()
         private:
            CTRL_COLORBUTTON& m_guiform;
            virtual void DrawItem (DRAWITEMSTRUCT*);
         };
      MyButton m_ctrl;
   #endif

   #ifdef X_NATIVE
      Pixel m_pixel;
   #endif

      COLOR m_color;
      STYLE m_style;

   #ifdef X_NATIVE
      static void CCB_ChangeColorMap (void*, UINT8*);
      static void CB_PushButton (Widget, CTRL_COLORBUTTON*, void*);
      void UpdateButtonColor ();
   #endif

      CTRL_COLORBUTTON (const CTRL_COLORBUTTON&);
      CTRL_COLORBUTTON& operator= (const CTRL_COLORBUTTON&);
   #endif // GENERATING_DOXYGEN_OUTPUT
   };
DEFINE_ENUM_OPERATORS(CTRL_COLORBUTTON::STYLE);


//-------------------------------------------------------------------------------------------------------------------
//! Template form containing label and button for showing and selecting a "color".
template <class _CT> class CTRL_COLORBUTTON_T : public MGUI::CTRL_COLORBUTTON {
   public:

      //! Constructor.
      CTRL_COLORBUTTON_T (
         ): m_pContainer(0), m_pfOnChangeColor(0) { }

      //! Create control.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         _CT *pContainer,                       //!< Pointer to callback container class
         void (_CT::*pfOnChangeColor)(),        //! Container method to call for color change notification
         const COLOR& dftcolor,                 //!< Default color
         STYLE style = STYLE_Default,           //!< Control style
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize
         ) {
         m_pContainer = pContainer;
         m_pfOnChangeColor = pfOnChangeColor;
         CTRL_COLORBUTTON::Create(ParentPane,dftcolor,style,sizealign);
         }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      _CT *m_pContainer;
      void (_CT::*m_pfOnChangeColor)();

      virtual void OnChangeColor (
         ) { (m_pContainer->*m_pfOnChangeColor)(); }
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//===================================================================================================================
//! Form containing label and color pushbutton for showing and selecting a "color".
//! The button will be shown in the selected color and contains no visible text.
class FORM_COLORBUTTON : public MGUI::FORM_COMPOSITE {
   public:

      //! Constructor.
      FORM_COLORBUTTON (
         );

      //! Destructor.
      virtual ~FORM_COLORBUTTON (
         );

      //! Create form with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const char* label,                     //!< Label string for resource lookup
         const COLOR& dftcolor,                 //!< Default color
         MGUI::CTRL_COLORBUTTON::STYLE buttonstyle = MGUI::CTRL_COLORBUTTON::STYLE_Default,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
         MGUI::CTRL_LABEL::STYLE labelstyle = MGUI::CTRL_LABEL::STYLE_LeftNoWrap
         );

      //! Create form with Unicode label.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const MIUNICODE *label,                //!< Label string
         const COLOR& dftcolor,                 //!< Default color
         MGUI::CTRL_COLORBUTTON::STYLE buttonstyle = MGUI::CTRL_COLORBUTTON::STYLE_Default,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
         MGUI::CTRL_LABEL::STYLE labelstyle = MGUI::CTRL_LABEL::STYLE_LeftNoWrap
         );

      //! Get current color.
      const COLOR& GetColor (
         ) const { return (m_button.GetColor()); }

      //! Get current color.
      COLORREF GetColorRef (
         ) const { return (m_button.GetColorRef()); }

      //! Retrieve label control for form.
      //! Usually the label control is only retrieved for alignment purposes.
      MGUI::CTRL_LABEL& GetLabel (
         ) { return (m_label); }

      //! Set color.
      void SetColor (
         const COLOR& color,                 //!< New color value to set
         bool notify = true                  //!< Call OnChangeColor() if 'true'
         ) { m_button.SetColor(color,notify); }

      //! Set color.
      void SetColor (
         const COLORREF color,               //!< New color value to set
         bool notify = true                  //!< Call OnChangeColor() if 'true'
         ) { m_button.SetColor(color,notify); }

      //! Set label text using string from resource lookup.
      void SetLabel (
         const char* label                   //!< New label text
         ) { m_label.SetLabel(label); }

      //! Set label text from Unicode string.
      void SetLabel (
         const MIUNICODE* label                 //!< New label text
         ) { m_label.SetLabel(label); }

   protected:

      //! Called when value is changed.
      //! Derived class must call corresponding superclass method BEFORE performing its own processing.
      virtual void OnChangeColor (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      CTRL_COLORBUTTON_T<FORM_COLORBUTTON> m_button;
      MGUI::CTRL_LABEL m_label;

      FORM_COLORBUTTON (const FORM_COLORBUTTON&);
      FORM_COLORBUTTON& operator= (const FORM_COLORBUTTON&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//-------------------------------------------------------------------------------------------------------------------
//! Template form containing label and button for showing and selecting a "color".
template <class _CT> class FORM_COLORBUTTON_T : public MGUI::FORM_COLORBUTTON {
   public:

      //! Constructor.
      FORM_COLORBUTTON_T (
         ): m_pContainer(0), m_pfOnChangeColor(0) { }

      //! Create with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const char* label,                     //!< Label string for resource lookup
         _CT *pContainer,                       //!< Pointer to callback container class
         void (_CT::*pfOnChangeColor)(),        //! Container method to call for color change notification
         const COLOR& dftcolor,                 //!< Default color
         MGUI::CTRL_COLORBUTTON::STYLE buttonstyle = MGUI::CTRL_COLORBUTTON::STYLE_Default,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
         MGUI::CTRL_LABEL::STYLE labelstyle = MGUI::CTRL_LABEL::STYLE_LeftNoWrap
         ) {
         m_pContainer = pContainer;
         m_pfOnChangeColor = pfOnChangeColor;
         FORM_COLORBUTTON::Create(ParentPane,label,dftcolor,buttonstyle,sizealign,labelstyle);
         }

      //! Create with Unicode label.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const MIUNICODE *label,                //!< Label string
         _CT *pContainer,                       //!< Pointer to callback container class
         void (_CT::*pfOnChangeColor)(),        //! Container method to call for color change notification
         const COLOR& dftcolor,                 //!< Default color
         MGUI::CTRL_COLORBUTTON::STYLE buttonstyle = MGUI::CTRL_COLORBUTTON::STYLE_Default,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
         MGUI::CTRL_LABEL::STYLE labelstyle = MGUI::CTRL_LABEL::STYLE_LeftNoWrap
         ) {
         m_pContainer = pContainer;
         m_pfOnChangeColor = pfOnChangeColor;
         FORM_COLORBUTTON::Create(ParentPane,label,dftcolor,buttonstyle,sizealign,labelstyle);
         }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      _CT *m_pContainer;
      void (_CT::*m_pfOnChangeColor)();

      virtual void OnChangeColor (
         ) { (m_pContainer->*m_pfOnChangeColor)(); }
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//===================================================================================================================

}  // End of MGUI namespace

#endif   // INC_MGUI_COLORBTN_H

---