colorsel.h

Go to the documentation of this file.

/**
 * \file mgui/colorsel.h
 * \brief MGUI::FORM_COLORSELECTOR class definition
 *
 * \if NODOC
 * $Id: colorsel.h_v 1.10 2003/10/03 19:58:19 linux32build!build Exp $
 *
 * $Log: colorsel.h_v $
 * Revision 1.10  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.9  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.8  2003/04/09 20:47:26  dwilliss
 * Don't use _T in templates. Mac ctypes.h defines a global _T
 *
 * Revision 1.7  2003/01/14 16:40:30  mju
 * Use PANE_BASE for parent.
 *
 * Revision 1.6  2003/01/07 15:03:17  mju
 * Use v_ for canvas virtual methods.
 *
 * Revision 1.5  2002/12/02 17:13:10  mju
 * Allow palette selection.
 *
 * Revision 1.4  2002/10/14 13:46:27  mju
 * Rename ctrl_canvas as 'canvas'.
 *
 * Revision 1.3  2002/10/11 21:39:06  mju
 * Use CANVAS so works for X and MFC.
 *
 * Revision 1.2  2002/10/09 16:52:32  mju
 * Moved to 'mgui' folder.
 *
 * Revision 1.1  2002/08/13 16:39:43  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MGUI_COLORSEL_H
#define  INC_MGUI_COLORSEL_H

#ifndef  INC_MGUI_COLORBTN_H
#include <mgui/colorbtn.h>
#endif

#ifndef  INC_MGUI_CANVAS_H
#include <mgui/canvas.h>
#endif

class COLORPALETTE;

namespace MGUI {

//! Form for color selection.
//! This form includes a "mini-palette", a pushbutton for choosing color, and an
//! optional "edit" control for tranparency.
class FORM_COLORSELECTOR : public MGUI::FORM_COMPOSITE {
   public:

      enum FORMSTYLE {
         FORMSTYLE_Default =           0x00,
         FORMSTYLE_EditTransparency =  0x01
         };

      //! Constructor.
      FORM_COLORSELECTOR (
         );

      //! Destructor.
      virtual ~FORM_COLORSELECTOR (
         );

      //! Create the form.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,
         FORMSTYLE formstyle = FORMSTYLE_Default
         );

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

      //! Determine if form has been created.
      //! @return true if created, false if not.
      virtual bool IsCreated (
         ) const;

      //! Determine if form is enabled for keyboard or mouse input.
      //! @return true if enabled, false if not, or if not yet created.
      virtual bool IsEnabled (
         ) const;

      //! Set color.
      void SetColor (
         const COLOR& color,
         bool notify = true
         );

      //! Set whether mouse or keyboard input to form is allowed.
      virtual void SetEnabled (
         bool enabled = true
         );

      //! Set transparency factor.
      void SetTransparency (
         UINT8 transparency,              //!< 0 = opaque, 255 = invisible.
         bool notify = true
         );

      //! Set whether form is visible or not.
      virtual void SetVisible (
         bool visible = true
         );

   protected:

      //! Called when user changes color.
      virtual void OnChangeColor (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class CANVAS_PALETTE : public MGUI::CANVAS {
         public:
            CANVAS_PALETTE (
               FORM_COLORSELECTOR& form
               ): m_form(form) { }
         private:
            FORM_COLORSELECTOR& m_form;
            virtual void v_OnLeftDown (MGUI::POINT point, KEYSTATE keystate);
         };
      friend class CANVAS_PALETTE;

      class EDIT_TRANSPARENCY : public FORM_EDIT_NUMBER {
         public:
            EDIT_TRANSPARENCY (
               FORM_COLORSELECTOR& form
               ): m_form(form) { }
         private:
            FORM_COLORSELECTOR& m_form;
            virtual void OnChangeValue ();
         };

      COLOR m_color;
      int m_palindex;
      int m_cellsize;
      int m_x0;
      int m_y0;
      CANVAS_PALETTE m_PaletteCanvas;
      CTRL_PUSHBUTTON_T<FORM_COLORSELECTOR> m_PalettePB;
      FORM_COLORBUTTON_T<FORM_COLORSELECTOR> m_ColorBtn;
      EDIT_TRANSPARENCY m_TransparencyEN;
      const COLORPALETTE *m_pColorPalette;

      void DrawHighlight (int palindex, bool set);
      void DrawPalette ();
      void OnCmdColor ();
      void OnCmdPalette ();
      void OnPaletteLeftDown (MGUI::POINT point);

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

DEFINE_ENUM_OPERATORS(FORM_COLORSELECTOR::FORMSTYLE);


//! Color selector form template.
//! This template allows a method in a 'container' class to be called when the color is changed,
//! rather than requiring that a subclass be defined with the OnChangeColor() virtual method overridden.
template <class _CT> class FORM_COLORSELECTOR_T : public MGUI::FORM_COLORSELECTOR {
   public:

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

      //! Create the form.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,
         _CT *pContainer,                       //!< Pointer to callback container class
         void (_CT::*pfOnChangeColor)(),        //! Callback function pointer
         FORMSTYLE formstyle = FORMSTYLE_Default
         ) {
         m_pContainer = pContainer;
         m_pfOnChangeColor = pfOnChangeColor;
         FORM_COLORSELECTOR::Create(ParentPane,formstyle);
         return;
         }

   protected:

      //! Called when user changes color.
      virtual void OnChangeColor (
         ) { (m_pContainer->*m_pfOnChangeColor)(); }

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

};    // End of MGUI namespace


#endif   // INC_MGUI_COLORSEL_H

---