coloredl.h

Go to the documentation of this file.

/**
 * \file mgui/coloredl.h
 * \brief MGUI::FORM_COLOR_EDIT_LIST class definitions
 *
 * \if NODOC
 * $Id: coloredl.h_v 1.5 2005/03/31 16:57:07 fileserver!dwilliss Exp $
 *
 * $Log: coloredl.h_v $
 * Revision 1.5  2005/03/31 16:57:07  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.4  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.3  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.2  2002/10/09 16:57:45  mju
 * Moved to 'mgui' folder.
 *
 * Revision 1.1  2002/08/13 16:39:27  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MGUI_COLOREDL_H
#define  INC_MGUI_COLOREDL_H

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

#ifndef  INC_MGUI_GRID_H
#include <mgui/grid.h>
#endif

#ifndef  INC_MGUI_COLORSEL_H
#include <mgui/colorsel.h>
#endif

#ifndef  INC_MI32_MILIST_H
#include <mi32/milist.h>
#endif


namespace MGUI {

//! Form for color edit list.
//! This form includes a list showing color name and sample,
//! and a set of controls to "edit" the selected color.
class FORM_COLOR_EDIT_LIST : public MGUI::FORM {
   public:

      //! Color editing capabilities.
      enum CAP {
         CAP_NoTransparent,         //!< No transparency
         CAP_AllowTransparent,      //!< Allow transparency on/off control
         CAP_AllowTransparency,     //!< Allow transparency percentage control
         CAP_FromForm               //!< Used in item construction to obtain capability from form
         };

      //! Form layout.
      enum LAYOUT {
         LAYOUT_Vertical,           //!< Item edit controls below list
         LAYOUT_Horizontal          //!< Item edit controls to right of list
         };

      class ITEM {
         public:

            //! Construct item with name from resource lookup.
            ITEM (
               const char *name,
               const COLOR& color,
               CAP capability = CAP_FromForm
               );

            //! Construct item with MIUNICODE name.
            ITEM (
               const MIUNICODE *name,
               const COLOR& color,
               CAP capability = CAP_FromForm
               );

            //! Construct item with name from resource lookup.
            ITEM (
               const char *name,
               UINT32 colorref,
               CAP capability = CAP_FromForm
               );

            //! Construct item with MIUNICODE name.
            ITEM (
               const MIUNICODE *name,
               UINT32 colorref,
               CAP capability = CAP_FromForm
               );

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            MISTRING m_name;
            COLOR m_color;
            CAP m_cap;

            friend class FORM_COLOR_EDIT_LIST;
            #endif // GENERATING_DOXYGEN_OUTPUT
         };

      //! Constructor.
      FORM_COLOR_EDIT_LIST (
         );

      //! Destructor.
      virtual ~FORM_COLOR_EDIT_LIST (
         );

      //! Add item to list.
      //! @return Item ID for use when retrieve color.
      int AddItem (
         const ITEM& item
         );

      //! Create the form.
      //! Note that if transparency on/off or percentage controls are required for any
      //! item in the list the desired capability must be specified when creating the form.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane for form
         int listrows,                          //!< Number of visible rows in color list
         CAP capability = CAP_NoTransparent,    //!< Edit capabilities
         LAYOUT layout = LAYOUT_Vertical
         );

      //! Get color for specified item.
      //! @return Reference to color
      const COLOR& GetItemColor (
         int itemid                       //!< Item ID (from AddItem())
         );

      //! Get color reference for specified item.
      //! @return Color reference
      UINT32 GetItemColorRef (
         int itemid                       //!< Item ID (from AddItem())
         );

      //! 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 whether mouse or keyboard input to form is allowed.
      virtual void SetEnabled (
         bool enabled = true
         );

      //! Set color for specified item
      void SetItemColor (
         int itemid,                      //!< Item ID from AddItem()
         const COLOR& color,              //!< New color to set
         bool notify = true               //!< Call OnChangeItemColor() if 'true' and color changed
         );

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

   protected:

      //! Called when item color changed.
      virtual void OnChangeItemColor (
         int itemid,
         const COLOR& color
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      MILIST<ITEM> m_ItemList;
      CTRL_GRID_T<FORM_COLOR_EDIT_LIST> m_ColorList;
      FORM_COLORSELECTOR_T<FORM_COLOR_EDIT_LIST> m_ColorSel;

      CAP m_cap;

      ITEM* GetColorListItemPtr (int itemnum) {
         return (static_cast<ITEM*>(reinterpret_cast<void*>(m_ColorList.GetItemData(itemnum))));
         }
      int InsertItem (ITEM&);
      bool OnColorListItemDraw (MGUI::CTRL_GRID::CUSTOMDRAW&);
      void OnColorListItemSelect (int itemnum, int subitem);
      void OnColorSelChangeColor ();
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//! Template version of color editor list.
template <class _T> class FORM_COLOR_EDIT_LIST_T : public MGUI::FORM_COLOR_EDIT_LIST {
   public:

      //! Constructor.
      FORM_COLOR_EDIT_LIST_T (
         ): m_pContainer(0), m_pfOnChangeItemColor(0) { }

      //! Create the form.
      void Create (
         MGUI::LAYOUT_PANE& ParentPane,
         _T *pContainer,                        //!< Pointer to callback container class
         int listrows,                          //!< Number of visible rows in color list
         CAP capability = CAP_NoTransparent,    //!< Edit capabilities
         LAYOUT layout = LAYOUT_Vertical
         ) {
         m_pContainer = pContainer;
         FORM_COLOR_EDIT_LIST::Create(ParentPane,listrows,capability,layout);
         }

      //! Set container function to call when item color changed.
      void SetChangeItemColorFunc (
         void (_T::*pfChangeItemColor)(int itemnum, const COLOR& color)
         ) { m_pfChangeItemColor = pfChangeItemColor; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      _T *m_pContainer;
      void (_T::*m_pfOnChangeItemColor)(int, const COLOR&);

      virtual void OnChangeItemColor (
         int itemnum,
         const COLOR& color
         ) { if (pfOnChangeItem != 0) m_pContainer->*m_pfOnChangeItemColor)(itemnum,color); }
      #endif // GENERATING_DOXYGEN_OUTPUT

   };

}  // End namespace MGUI

#endif   // INC_MGUI_COLOREDL_H

---