mgui/grid.h

Go to the documentation of this file.

#ifndef  INC_MGUI_GRID_H
#define  INC_MGUI_GRID_H

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

#ifndef  INC_MI32_MISTRING_H
   #include <mi32/mistring.h>
#endif

#ifndef  INC_MI32_COLOR_H
   #include <mi32/color.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
struct LPOINT2D;
namespace MGD {
   class CONTEXT;
   }
namespace MGUI {
   class IMAGELIST;
   class TOOLTIP;
   }
#endif


namespace MGUI {

//------------------------------------------------------------------------------------------------
class CTRL_GRID : public MGUI::CTRL {
   public:

      enum CELLTYPE {
         CELLTYPE_Text = 0,               // Simple text cell (default)
         CELLTYPE_Button = 1,             // Simple pushbutton
         CELLTYPE_DropDown = 2,           // Dropdown list
         CELLTYPE_Icon = 3,                  
         CELLTYPE_IconButton = 4,
         CELLTYPE_BigText = 5,            // Text with [...] button to see/edit whole thing.
         CELLTYPE_PopUp = 6,              // Popup list
         CELLTYPE_Color = 7               // Button with color sample and no text. 
         };
         
      enum FORMAT {
         FORMAT_Left =           0, 
         FORMAT_Right =          1, 
         FORMAT_Center =         2  
         };

      enum STYLE {
         STYLE_AlignTop =        0x0000,  
         STYLE_NoGridLines =     0x0001,  
         STYLE_MultiSelect =     0x0002,  
         STYLE_SingleSel =       0x0004,  
         STYLE_ShowSelAlways =   0x0008,  
         STYLE_SortAscending =   0x0010,  
         STYLE_SortDescending =  0x0020,  
         STYLE_NoSelect =        0x0040,  
         STYLE_NoOuterFrame =    0x0080,  
         STYLE_AutoArrange =     0x0100,  
         STYLE_EditLabels =      0x0200,  
         STYLE_SizeInPixels =    0x0400,  
         STYLE_AlignLeft =       0x0800,  
         STYLE_OwnerData =       0x1000,  
         STYLE_NoScroll =        0x2000,  
         STYLE_NoColumnHeader =  0x4000,  
         STYLE_NoSortHeader =    0x8000,  
         };

      enum VIEWMODE {
         VIEWMODE_Icon =         0,    
         VIEWMODE_Report =       1,    
         VIEWMODE_SmallIcon =    2,    
         VIEWMODE_List =         3     
         };

      enum IMAGELISTTYPE {
         IMAGELISTTYPE_Normal =  0,    
         IMAGELISTTYPE_Small  =  1,    
         IMAGELISTTYPE_State  =  2     
         };

      struct DISPINFO {
         DISPINFO () :
            m_indent(0),
            m_IconIndex(-1),
            m_StateImageIndex(-1),
            m_OverlayImageIndex(-1),
            m_bSelected(false),
            m_CellType(CELLTYPE_Text)
            {}
            
         ~DISPINFO() {}

         MISTRING m_text;           
         int m_indent;              
         int m_IconIndex;           
         int m_StateImageIndex;     
         int m_OverlayImageIndex;   
         bool m_bSelected; 
         CELLTYPE m_CellType;       
         MISTRING m_ToolTipStr;     
         };
      
      struct CUSTOMDRAW {
         int row;
         int col;
         LRECT2D rect;
         COLOR BackgroundColor;
         COLOR TextColor;
         bool ChangedBackgroundColor;
         bool ChangedTextColor;
         MGD::CONTEXT *gc;
         };

      // Delegates
      typedef fastdelegate::FastDelegate<bool(int row, int col)> DELEGATE_ONBEGINLABELEDIT;
      typedef fastdelegate::FastDelegate<void(int startcol, int endcol)> DELEGATE_ONCHANGECOLUMNORDER;
      typedef fastdelegate::FastDelegate<void(int row, int col, KEYSTATE keystate)> DELEGATE_ONCLICK;
      typedef fastdelegate::FastDelegate<bool(CUSTOMDRAW& customdraw)> DELEGATE_ONDRAWITEM;
      typedef fastdelegate::FastDelegate<bool(int row, int col, MISTRING&)> DELEGATE_ONENDLABELEDIT;
      typedef fastdelegate::FastDelegate<bool(int row, int col, DISPINFO&)> DELEGATE_ONGETDISPINFO;
      typedef fastdelegate::FastDelegate<int(UINT32 row1, UINT32 row2, int col, bool bAscending)> DELEGATE_ONITEMCOMPARE;
      typedef fastdelegate::FastDelegate<void(int row, int col)> DELEGATE_ONITEMSELECT;
      typedef fastdelegate::FastDelegate<void(int row, int col)> DELEGATE_ONITEMUNSELECT;
      typedef fastdelegate::FastDelegate<void(int row, int col, const LPOINT2D&point, KEYSTATE keystate)> DELEGATE_ONRIGHTCLICK;
      typedef fastdelegate::FastDelegate<void(int col, int width)> DELEGATE_ONRESIZECOLUMN;
      typedef fastdelegate::FastDelegate<bool(MGUI::CTRL_TOOLTIP&, int row, int col)> DELEGATE_ONTOOLTIP;

      CTRL_GRID (
         );

      virtual ~CTRL_GRID (
         );

      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    
         int height = 10,                       
         int width = 40,                        
         VIEWMODE viewmode = VIEWMODE_Report,   
         STYLE style = STYLE_AlignTop,          
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         );

      void DeleteAllColumns (
         );

      void DeleteAllItems (
         );

      void DeleteColumn (
         int col
         );

      void DeleteItem (
         int itemnum
         );

      void DeleteItem (
         int itemnum,
         bool redrawnow
         );

      void DeleteItemByData (
         ID id
         );

      void DeselectAllItems (
         );

      void EditFinish ();

      bool EditItem (
         int itemnum,
         int column = 0,
         bool selectall = true                  
         );

      bool EditItem (
         int itemnum,
         int column,
         const MIUNICODE *initstr,                 
         bool selectall = true                  
         );

      void EnsureVisible (
         int itemnum,
         bool PartialOK = false
         );

      int FindItemByData (
         const void* value
         ) const;

      int FindItemByData (
         ID data
         ) const { return (FindItemByData((void*)data)); }

      int GetBottomRow (
         ) const { return (GetTopRow() + GetCountPerPage()); }

      bool GetCellRect (
         int itemnum,
         int col,
         LRECT2D& rect
         ) const;

      int GetColumnCount (
         ) const;

      bool GetColumnLabel (
         int column,
         MISTRING& label
         ) const;

      ERRVALUE GetColumnOrderArray (
         SIMPLE_ARRAY<INT32>& array
         ) const;

      int GetColumnWidth (
         int column
         ) const;

      int GetCountPerPage (
         ) const;

      int GetHeadingHeight (
         ) const;

      int GetItemCount (
         ) const;

      MGUI::ID GetItemData (
         int itemnum
         ) const;

      MISTRING GetItemText (
         int itemnum,
         int subitem
         ) const;

      int GetNextSelectedItem (
         int startitem = -1                     
         ) const;

      int GetSelectedCount (
         ) const;

      int GetTopRow (
         ) const;

      int InsertColumn (
         int colnum,                            
         const MISTRING& string,                
         FORMAT format = FORMAT_Left,           
         int width = -1                         
         );

      int InsertColumnComboBox (
         int colnum,                            
         const MISTRING& label,                 
         const MISTRING& menu,
         int width = -1                         
         );

      int InsertItem (
         const MISTRING& string                 
         );

      int InsertItem (
         int pos,                               
         const MISTRING& string                 
         );

      bool IsItemSelected (
         int itemnum
         ) const;

      void Redraw (
         bool updatenow = true
         );

      void RedrawDisable (
         );

      void RedrawEnable (
         );

      void RedrawItems (
         int firstitemnum,
         int lastitemnum,
         bool updatenow = true
         );

      bool SetColumnLabel (
         int column,
         const MISTRING& label
         );

      void SetColumnOrderArray (
         SIMPLE_ARRAY<INT32>& array
         );

      void SetColumnWidth (
         int column,
         int width
         );

      void SetDelegateOnBeginLabelEdit (
         DELEGATE_ONBEGINLABELEDIT DelegateOnBeginLabelEdit
         ) { m_DelegateOnBeginLabelEdit = DelegateOnBeginLabelEdit; }

      void SetDelegateOnChangeColumnOrder (
         DELEGATE_ONCHANGECOLUMNORDER DelegateOnChangeColumnOrder
         ) { m_DelegateOnChangeColumnOrder = DelegateOnChangeColumnOrder; }

      void SetDelegateOnClickColumn (
         DELEGATE_ONCLICK DelegateOnClickColumn
         ) { m_DelegateOnClickColumn = DelegateOnClickColumn; }

      void SetDelegateOnClickItem (
         DELEGATE_ONCLICK DelegateOnClickItem
         ) { m_DelegateOnClickItem = DelegateOnClickItem; }

      void SetDelegateOnDoubleClickItem (
         DELEGATE_ONCLICK DelegateOnDoubleClickItem
         ) { m_DelegateOnDoubleClickItem = DelegateOnDoubleClickItem; }

      void SetDelegateOnDrawItem (
         DELEGATE_ONDRAWITEM DelegateOnDrawItem
         ) { m_DelegateOnDrawItem = DelegateOnDrawItem; }

      void SetDelegateOnEndLabelEdit (
         DELEGATE_ONENDLABELEDIT DelegateOnEndLabelEdit
         ) { m_DelegateOnEndLabelEdit = DelegateOnEndLabelEdit; }

      void SetDelegateOnGetDispInfo (
         DELEGATE_ONGETDISPINFO DelegateOnGetDispInfo
         ) { m_DelegateOnGetDispInfo = DelegateOnGetDispInfo; }

      void SetDelegateOnItemCompare (
         DELEGATE_ONITEMCOMPARE DelegateOnItemCompare
         ) { m_DelegateOnItemCompare = DelegateOnItemCompare; }

      void SetDelegateOnItemSelect (
         DELEGATE_ONITEMSELECT DelegateOnItemSelect
         ) { m_DelegateOnItemSelect = DelegateOnItemSelect; }

      void SetDelegateOnItemUnselect (
         DELEGATE_ONITEMUNSELECT DelegateOnItemUnselect
         ) { m_DelegateOnItemUnselect = DelegateOnItemUnselect; }

      void SetDelegateOnResizeColumn (
         DELEGATE_ONRESIZECOLUMN DelegateOnResizeColumn
         ) { m_DelegateOnResizeColumn = DelegateOnResizeColumn; }

      void SetDelegateOnRightClick (
         DELEGATE_ONRIGHTCLICK DelegateOnRightClick
         ) { m_DelegateOnRightClick = DelegateOnRightClick; }

      void SetDelegateOnSize (
         DELEGATE_ONSIZE DelegateOnSize
         ) { m_DelegateOnSize = DelegateOnSize; }

      void SetDelegateOnToolTip (
         DELEGATE_ONTOOLTIP DelegateOnToolTip
         ) { m_DelegateOnToolTip = DelegateOnToolTip; }

      void SetImageList (
         IMAGELIST& imagelist,                  
         IMAGELISTTYPE listtype = IMAGELISTTYPE_Small,            
         bool shared = false                    
         );

      int SetItemCount (
         int NumItems
         );

      void SetItemData (
         int itemnum,                           
         ID value                         
         );

      void SetItemImage (
         int itemnum,
         int imageindex
         );

      void SetItemSelected (
         int itemnum,                           
         bool selected = true
         );

      void SetItemText (
         int itemnum,                           
         int subitem,                           
         const MISTRING& string                 
         );

      void SetRowHeight (
         int pixels
         );

      void SortItems (
         int column = 0,         
         bool bAscending = true
         );

      void Update (
         int itemnum
         );

   protected:

      STYLE GetStyle (
         ) const { return m_style; }

      virtual bool OnBeginLabelEdit (
         int itemnum,
         int subitemnum
         );

      virtual void OnChangeColumnOrder (
         int fromCol,
         int toCol
         );

      virtual void OnClickColumn (
         int itemnum,
         int column,
         KEYSTATE state
         );

      virtual void OnClickItem (
         int itemnum,                                             
         int column,
         KEYSTATE state
         );

      virtual void OnDoubleClickItem (
         int itemnum,
         int column,
         KEYSTATE state
         );
      
      virtual bool OnDrawItem (
         CUSTOMDRAW& drawinfo
         );

      virtual bool OnEndLabelEdit (
         int row,
         int col,
         MISTRING& string
         );

      virtual bool OnGetDispInfo (
         int row,
         int col,
         CTRL_GRID::DISPINFO& dispinfo 
         );

      virtual void OnItemActivate (
         );

      virtual int OnItemCompare (
         UINT32 rowitem1,
         UINT32 rowitem2,
         int colnum,
         bool bAscending
         );

      virtual void OnItemSelect (
         int itemnum,
         int subitemnum
         );

      virtual void OnItemUnselect (
         int itemnum,
         int subitemnum
         );

      virtual void OnOwnerDataCacheHint (
         int from,
         int to
         );

      virtual void OnRightClickItem (
         int itemnum,
         int column,
         const LPOINT2D&,
         KEYSTATE state
         );

      virtual void OnUserResizeColumn (
         int column,
         int width
         );

      virtual bool v_OnToolTip (
         MGUI::CTRL_TOOLTIP& tooltip,
         int row,
         int col
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      class MyListCtrl;
      friend class MyListCtrl;

      MyListCtrl *m_pCtrl;
      STYLE m_style;
      int m_PrevSelRow;
      int m_PrevSelCol;

      DELEGATE_ONBEGINLABELEDIT m_DelegateOnBeginLabelEdit;
      DELEGATE_ONCHANGECOLUMNORDER m_DelegateOnChangeColumnOrder;
      DELEGATE_ONCLICK m_DelegateOnClickColumn;
      DELEGATE_ONCLICK m_DelegateOnClickItem;
      DELEGATE_ONCLICK m_DelegateOnDoubleClickItem;
      DELEGATE_ONDRAWITEM m_DelegateOnDrawItem;
      DELEGATE_ONENDLABELEDIT m_DelegateOnEndLabelEdit;
      DELEGATE_ONGETDISPINFO m_DelegateOnGetDispInfo;
      DELEGATE_ONITEMCOMPARE m_DelegateOnItemCompare;
      DELEGATE_ONITEMSELECT m_DelegateOnItemSelect;
      DELEGATE_ONITEMUNSELECT m_DelegateOnItemUnselect;
      DELEGATE_ONRIGHTCLICK m_DelegateOnRightClick;
      DELEGATE_ONRESIZECOLUMN m_DelegateOnResizeColumn;
      DELEGATE_ONSIZE m_DelegateOnSize;
      DELEGATE_ONTOOLTIP m_DelegateOnToolTip;

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

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(MGUI::CTRL_GRID::STYLE)
#endif

//------------------------------------------------------------------------------------------------

}  // End of MGUI namespace

#endif   // INC_MGUI_GRID_H

---