mgui/formlist.h

Go to the documentation of this file.

#ifndef  INC_MGUI_FORMLIST_H
#define  INC_MGUI_FORMLIST_H

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

#ifndef  INC_MGUI_KEYCODE_H
   #include <mgui/keycode.h>
#endif

#ifndef  INC_MGUI_POINTERBUTTON_H
   #include <mgui/pointerbutton.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
namespace MGD {
   class CONTEXT;
   }
struct LPOINT2D;
#endif


namespace MGUI {

//=====================================================================================================================
class FORM_LIST : public MGUI::FORM_COMPOSITE {
   #ifndef GENERATING_DOXYGEN_OUTPUT
   private:
      class PRIV;
   #endif // GENERATING_DOXYGEN_OUTPUT

   public:

      enum LISTSTYLE {
         LISTSTYLE_NoSelect =                0x00000000, 
         LISTSTYLE_SelectSingle =            0x00000001, 
         LISTSTYLE_SelectMulti =             0x00000002, 
         LISTSTYLE_WidthInPixels =           0x00000004, 
         LISTSTYLE_HeightInPixels =          0x00000008, 
         LISTSTYLE_UseCommonBackground =     0x00000010, 
         LISTSTYLE_NoFrame =                 0x00000020, 
         LISTSTYLE_NoHeading =               0x00000040, 
         LISTSTYLE_NoScrollH =               0x00000080, 
         LISTSTYLE_NoScrollV =               0x00000100, 
         LISTSTYLE_NoScrollBars =            LISTSTYLE_NoScrollH | LISTSTYLE_NoScrollV,   
         LISTSTYLE_NoSort =                  0x00000200, 
         LISTSTYLE_NoToolTips =              0x00000400, 
         LISTSTYLE_UseIcons =                0x00000800, 
         LISTSTYLE_ShowItemSeparators =      0x00001000, 
         LISTSTYLE_ShowFieldSeparators =     0x00002000, 
         LISTSTYLE_ShowColumnSeparators =    0x00004000, 
         LISTSTYLE_UseSelectButtons =        0x00008000, 
         LISTSTYLE_AllowReorderFields =      0x00010000, 
         LISTSTYLE_AllowShowHideFields =     0x00020000, 
         LISTSTYLE_NoSaveWidth =             0x00040000, 
         LISTSTYLE_NoSaveHeight =            0x00080000, 
         LISTSTYLE_NoSaveSize =              LISTSTYLE_NoSaveWidth | LISTSTYLE_NoSaveHeight, 
         LISTSTYLE_NoMultiColumn =           0x00100000, 
         LISTSTYLE_ToggleSelect =            0x00200000, 
         LISTSTYLE_AllowMultiColumnDetails = 0x00400000, 
         LISTSTYLE_NoFitToContent =          0x00800000, 
         };

      enum FIELDSTYLE {
         FIELDSTYLE_AlignLeft =           0x0000,  
         FIELDSTYLE_AlignRight =          0x0001,  
         FIELDSTYLE_AlignCenter =         0x0002,  
         FIELDSTYLE_AlignMask =           0x0003,  
         FIELDSTYLE_AllowEdit =           0x0004,  
         FIELDSTYLE_NoSort =              0x0008,  
         FIELDSTYLE_NoResize =            0x0010,  
         FIELDSTYLE_NoShowHide =          0x0020,  
         FIELDSTYLE_InitHidden =          0x0100,  
         FIELDSTYLE_InitSortDescending =  0x0200,  
         FIELDSTYLE_IconTextRight =       0x0400,  
         FIELDSTYLE_IconRight =           0x0800,  
//       FIELDSTYLE_KeepWithPrevious =    0x0400,  //!< Keep field with previous one when reordering via user drag of column heading
//       FIELDSTYLE_NoSeparatorBefore =   0x0800,  //!< Don't show separator between this field and previous, implies FIELDSTYLE_KeepWithPrevious
         };

      enum VIEWMODE {
         VIEWMODE_List =         0,    
         VIEWMODE_Details =      1,    
         VIEWMODE_COUNT
         };

      enum EDITMODE {
         EDITMODE_InsertEnd,           
         EDITMODE_SelectAll,           
         EDITMODE_Clear                
         };

      enum FIELDWIDTH {
         FIELDWIDTH_HeadingOnly =         0,
         FIELDWIDTH_HeadingAndData =      -1,
         FIELDWIDTH_DataOnly =            -2,
         FIELDWIDTH_AsAdded =             -3,
         };

      enum COLORUSE {
         COLORUSE_HeadingBackground = 0,
         COLORUSE_HeadingText,
         COLORUSE_HeadingSeparator,
         COLORUSE_HeadingShadowDark,
         COLORUSE_HeadingShadowLight,
         COLORUSE_ItemBackgroundNormal,
         COLORUSE_ItemBackgroundSelected,
         COLORUSE_ItemTextNormal,
         COLORUSE_ItemTextSelected,
         COLORUSE_ItemSeparator,
         COLORUSE_FieldSeparator,
         COLORUSE_ColumnSeparator,
         COLORUSE_COUNT
         };

      enum ENSUREVISIBLE {
         ENSUREVISIBLE_ScrollMinimum =    0,    // Scroll list minimum amount to show item
         ENSUREVISIBLE_Beginning =        1,    // Scroll so item is at first visible position
         ENSUREVISIBLE_NearBeginning =    2,    // Scroll so item is near beginning of visible portion
         ENSUREVISIBLE_NearEnd =          3,    // Scroll so item is near end of visible portion
         ENSUREVISIBLE_End =              4,    // Scroll so item is at last visible position
         ENSUREVISIBLE_PartialOK =        9     // Don't scroll if item already partially visible
         };

      class DISPINFO {
         public:

            DISPINFO () :
               m_IconID(ICONID__NONE)
               { }
               
            ~DISPINFO() {}

            MISTRING m_text;           
            ICONID m_IconID;           
         };
      
      class CUSTOMDRAW {
         public:
            const COLOR& GetColorBackground (
               ) const { return (m_ColorBackground); }
            const COLOR& GetColorText (
               ) const { return (m_ColorText); }
            int GetFieldNum (
               ) const { return (m_fieldnum); }
            MGD::CONTEXT* GetGC (
               ) const { return (m_gc); }
            int GetItemNum (
               ) const { return (m_itemnum); }
            const LRECT2D& GetRect (
               ) const { return (m_rect); }
            bool HasSetColorBackground (
               ) const { return (m_ChangedColorBackground); }
            bool HasSetColorText (
               ) const { return (m_ChangedColorText); }
            void SetColorBackground (
               const COLOR& color
               ) { m_ColorBackground = color; m_ChangedColorBackground = true; }
            void SetColorText (
               const COLOR& color
               ) { m_ColorText = color; m_ChangedColorText = true; }
            void SetRect (
               const LRECT2D& rect
               ) { m_rect = rect; }
         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            friend class FORM_LIST::PRIV;

            int m_itemnum;                   // Item number
            int m_fieldnum;                  // Field number
            LRECT2D m_rect;                  // Rectangle on canvas for entire field, may not be entirely inside canvas
            COLOR m_ColorBackground;
            COLOR m_ColorText;
            bool m_ChangedColorBackground;   // Delegate can set to true to indicate that background color was changed
            bool m_ChangedColorText;         // Delegate can set to true to indicate that text color was changed
            MGD::CONTEXT *m_gc;              // Drawing context if doing fully customized drawing

            CUSTOMDRAW (int itemnum, int fieldnum, MGD::CONTEXT *gc);
            ~CUSTOMDRAW ();
            #endif
         };

      typedef fastdelegate::FastDelegate<bool(int itemnum, int fieldnum, const MGUI::POINT&, MGUI::POINTERBUTTON, MGUI::KEYSTATE)> DELEGATE_ONPOINTER;

      typedef fastdelegate::FastDelegate<bool(int itemnum, int fieldnum, const MGUI::POINT&, MGUI::KEYSTATE, MGUI::KEYCODE)> DELEGATE_ONKEY;

      typedef fastdelegate::FastDelegate<bool(int itemnum, int fieldnum, MISTRING&)> DELEGATE_ONEDIT;

      typedef fastdelegate::FastDelegate<bool(int itemnum, int fieldnum)> DELEGATE_ONFIELD;

      typedef fastdelegate::FastDelegate<bool(CUSTOMDRAW& customdraw)> DELEGATE_ONCUSTOMDRAW;

      typedef fastdelegate::FastDelegate<void(int itemnum, int fieldnum, DISPINFO&)> DELEGATE_ONGETDISPINFO;

      typedef fastdelegate::FastDelegate<int(int itemnum1, int itemnum2, int fieldnum)> DELEGATE_ONCOMPARE;

      typedef fastdelegate::FastDelegate<void(int width, int height)> DELEGATE_ONSIZE;

      typedef fastdelegate::FastDelegate<bool(int itemnum, int fieldnum, MGUI::CTRL_TOOLTIP&)> DELEGATE_ONTOOLTIP;

      typedef fastdelegate::FastDelegate<bool(int itemnum, int fieldnum, MGUI::CTRL_TOOLTIP&, const MGUI::POINT&)> DELEGATE_ONTOOLTIPPOINT;

      FORM_LIST ();

      virtual ~FORM_LIST ();

      int AddField (
         const MISTRING& label,                       
         FIELDSTYLE style = FIELDSTYLE_AlignLeft,     
         int DisplayWidth = FIELDWIDTH_HeadingOnly,   
         const char *IniKey = 0                       
         );

      int AppendItem (
         const MISTRING& string                 
         );

      void ComputeFieldDisplayWidth (
         int fieldnum,                          
         FIELDWIDTH mode                        
         );

      bool ComputeRelativePoint (
         int itemnum,                           
         int fieldnum,                          
         const MGUI::POINT& ptCanvas,           
         MGUI::POINT& ptRelative                
         ) const;

      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    
         int height,                            
         int width,                             
         LISTSTYLE style = LISTSTYLE_NoSelect,  
         VIEWMODE ViewMode = VIEWMODE_Details,  
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         );

      void DeleteAllFields (
         );

      void DeleteAllItems (
         ) { SetItemCount(0); }

      void DeleteField (
         int fieldnum
         );

      void DeleteItem (
         int itemnum
         );

      void DeleteItemByID (
         ID id
         ) { DeleteItem(FindItemByID(id)); }

      void DeselectAllItems (
         bool notify = true
         );

      bool DlgShowHideFields (
         MDLGPARENT dlgparent
         );

      bool EditItem (
         int itemnum,
         int fieldnum,
         EDITMODE editmode = EDITMODE_InsertEnd          
         );

      void EnsureVisible (
         int itemnum,
         int fieldnum = -1,
         ENSUREVISIBLE mode = ENSUREVISIBLE_ScrollMinimum
         );

      int FindItemByID (
         ID id
         ) const;

      int FindItemByID (
         const void *id
         ) const { return (FindItemByID(reinterpret_cast<ID>(id))); }

      void FlashItem (
         int itemnum,
         int numtimes = 1
         ) const;

      const COLOR& GetColor (
         COLORUSE use
         ) const;

      int GetFieldCount (
         ) const;

      void GetFieldDisplayOrderDetails (
         SIMPLE_ARRAY<int>& DisplayOrder
         ) const;

      int GetFieldDisplayWidth (
         int fieldnum
         ) const;

      MISTRING GetFieldLabel (
         int fieldnum
         ) const;

      int GetFirstVisibleItem (
         ) const;

      int GetItemCount (
         ) const;

      MGUI::ID GetItemID (
         int itemnum
         ) const;

      MISTRING GetItemText (
         int itemnum,
         int fieldnum
         ) const;

      MGUI::CTRL& GetMenuParent (
         ) const;

      int GetNextSelectedItem (
         int startitem = -1                     
         ) const;

      int GetNumVisibleRows (
         ) const;

      int GetSelectedCount (
         ) const;

      const LPOINT2D& GetSize (
         ) const;

      int GetRowHeight (
         ) const;

      bool HasSorted (
         ) const;

      bool HasSortFields (
         ) const;

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

      bool IsFieldSortAscending (
         int fieldnum
         ) const;

      bool IsFieldVisible (
         int fieldnum,
         VIEWMODE ViewMode = VIEWMODE_COUNT     
         ) const;

      bool IsItemSelected (
         int itemnum
         ) const;

      void LockLayout (
         FORM_LIST& ListLockTo
         );

      void Redraw (
         );

      void RedrawDisable (
         );

      void RedrawEnable (
         );

      void RedrawItem (
         int itemnum
         );

      void RedrawItems (
         int firstitemnum,
         int lastitemnum
         );

      void SaveLayout (
         ) const;

      void SetColor (
         COLORUSE use,                          
         const COLOR& color                     
         );

      void SetIconSize (
         int IconSize                           
         );

      void SetFieldDisplayOrderDetails (
         const SIMPLE_ARRAY<int>& FieldOrder
         );

      void SetFieldDisplayWidth (
         int fieldnum,
         int width                              
         );

      void SetFieldLabel (
         int fieldnum,
         const MISTRING& label
         );

      void SetFieldVisible (
         int fieldnum,
         bool visible
         );

      void SetDelegateOnChangeLayout (
         DELEGATE_VOID_NOPARMS delegate
         );

      void SetDelegateOnChangeOrder (
         DELEGATE_VOID_NOPARMS delegate
         );

      void SetDelegateOnChangeSelection (
         DELEGATE_VOID_INT32 delegate
         );

      void SetDelegateOnCompare (
         DELEGATE_ONCOMPARE delegate
         );

      void SetDelegateOnDrawItem (
         DELEGATE_ONCUSTOMDRAW delegate
         );

      void SetDelegateOnEditBegin (
         DELEGATE_ONEDIT delegate
         );

      void SetDelegateOnEditCancel (
         DELEGATE_ONFIELD delegate
         );

      void SetDelegateOnEditEnd (
         DELEGATE_ONEDIT delegate
         );

      void SetDelegateOnFieldCompare (
         int fieldnum,                       
         DELEGATE_ONCOMPARE delegate
         );

      void SetDelegateOnGetDispInfo (
         DELEGATE_ONGETDISPINFO delegate
         );

      void SetDelegateOnKeyPress (
         DELEGATE_ONKEY delegate
         );

      void SetDelegateOnLeftButtonDoubleClick (
         DELEGATE_ONPOINTER delegate
         );

      void SetDelegateOnPointerButtonDown (
         DELEGATE_ONPOINTER delegate
         );

      void SetDelegateOnPointerButtonUp (
         DELEGATE_ONPOINTER delegate
         );

      void SetDelegateOnSize (
         DELEGATE_ONSIZE delegate
         );

      void SetDelegateOnToolTip (
         DELEGATE_ONTOOLTIP delegate
         );

      void SetDelegateOnToolTipPoint (
         DELEGATE_ONTOOLTIPPOINT delegate
         );

      void SetIniKey (
         const char *IniKey,
         const char *IniGroup = 0
         );

      ERRVALUE SetItemCount (
         int NumItems                           
         );

      ERRVALUE SetItemID (
         int itemnum,                           
         ID id                                  
         );

      ERRVALUE SetItemIcon (
         int itemnum,                           
         ICONID iconid                          
         );

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

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

      void SetRowHeight (
         int RowHeight,                         
         VIEWMODE ViewMode = VIEWMODE_List
         );

      void SetViewMode (
         VIEWMODE ViewMode
         );

      void Sort (
         );

      void Sort (
         int fieldnum,                          
         bool bAscending = true
         );

      void Sort (
         const SIMPLE_ARRAY<int>& FieldNums,          
         const SIMPLE_ARRAY<bool>& FieldsAscending    
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      friend class PRIV;
      PRIV *m_pPriv;

      // UNIMPLEMENTED / UNSUPPORTED
      FORM_LIST (const FORM_LIST&);
      FORM_LIST& operator= (const FORM_LIST&);

      #endif // GENERATING_DOXYGEN_OUTPUT

   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(MGUI::FORM_LIST::LISTSTYLE)
DEFINE_ENUM_OP_BITWISE(MGUI::FORM_LIST::FIELDSTYLE)
#endif

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

}  // End of MGUI namespace

#endif   // INC_MGUI_FORMLIST_H

---