mlistview.h

Go to the documentation of this file.

//
//                          IMPORTANT NOTICE
//
// The following open source license statement does not apply to any
// entity in the Exception List published by FMSoft.
//
// For more information, please visit:
//
// https://www.fmsoft.cn/exception-list
//

#ifdef _MGNCSCTRL_LISTVIEW

#ifndef _MGUI_CTRL_LISTV_H
#define _MGUI_CTRL_LISTV_H


#ifdef __cplusplus
extern "C" {
#endif  /* __cplusplus */

typedef struct _mListView mListView;
typedef struct _mListViewClass mListViewClass;
typedef struct _mListViewRenderer mListViewRenderer;

typedef enum
{
    NCSID_LISTV_IR_PARENT,
    NCSID_LISTV_IR_FIRSTCHILD,
    NCSID_LISTV_IR_LASTCHILD,
    NCSID_LISTV_IR_NEXTSIBLING,
    NCSID_LISTV_IR_PREVSIBLING,
}ncsListVIRType;

#define NCSF_LSTHDR_LEFTALIGN       (0x00<<NCSF_LSTCLM_SHIFT)

#define NCSF_LSTHDR_TOPALIGN        (0x00<<NCSF_LSTCLM_SHIFT)

#define NCSF_LSTHDR_RIGHTALIGN      (0x01<<NCSF_LSTCLM_SHIFT)

#define NCSF_LSTHDR_CENTERALIGN     (0x02<<NCSF_LSTCLM_SHIFT)

#define NCSF_LSTHDR_BOTTOMALIGN     (0x04<<NCSF_LSTCLM_SHIFT)

#define NCSF_LSTHDR_VCENTERALIGN    (0x08<<NCSF_LSTCLM_SHIFT)

#define NCSF_LSTHDR_VALIGNMASK      (0x0C<<NCSF_LSTCLM_SHIFT)

#define NCSF_LSTHDR_SHIFT           (NCSF_LSTCLM_SHIFT+4)

typedef enum
{
    NCSID_LISTV_FT_ADDDATA,
    NCSID_LISTV_FT_TEXT,
}ncsListVFindType;

typedef struct _NCS_LISTV_FINDINFO
{
    ncsListVFindType type;

    HITEM   parent;

    int     startIdx;

    union {
        struct {
            /* The number of searching column. */
            int     size;
            /* The text of searching column */
            char    **text;
        }string;
        DWORD   addData;
    }data;
}NCS_LISTV_FINDINFO;

typedef struct _NCS_LISTV_CLMINFO
{
    int     index;
    int     width;
    char    *text;
    DWORD   image;
    DWORD   flags;
    NCS_CB_LISTV_CMPCLM pfnCmp;

    /*
     * \sa ncsLstClmSortType
     */
    ncsLstClmSortType sort;
} NCS_LISTV_CLMINFO;

typedef struct _NCS_LISTV_ITEMDATA
{
    int     row;
    int     col;
    char*   text;
    int     textColor;

    DWORD   flags;
    DWORD   image;
}NCS_LISTV_ITEMDATA;

typedef struct _NCS_LISTV_ITEMINFO
{
    int     index;
    int     retPos;
    HITEM   parent;
    int     height;
    int     flags;
    HICON   foldIcon;
    HICON   unfoldIcon;
    int     dataSize;
    NCS_LISTV_ITEMDATA *data;
        DWORD   addData;
}NCS_LISTV_ITEMINFO;

typedef void (*NCS_CB_LISTV_DRAWHDRBK)(mListView *self, HITEM hHdr, HDC hdc, RECT *rcDraw);
typedef void (*NCS_CB_LISTV_DRAWHDR)(mListView *self, HITEM hHdr, HDC hdc, RECT *rcDraw);

typedef void (*NCS_CB_DRAWITEMBK)(mListView *self, HITEM hItem, HDC hdc, RECT *rcDraw);
typedef struct _NCS_CB_LISTV_CSTMHDROPS
{
    NCS_CB_LISTV_DRAWHDRBK pfnDrawHdrBk;
    NCS_CB_LISTV_DRAWHDR   pfnDrawHdrItem;
} NCS_CB_LISTV_CSTMHDROPS;


#define NCSSPEC_LISTV_HDR   MAX_USER_SPECIAL_KEY + 2000

typedef struct _NCS_LISTV_CLMRD{
        const char* text;
        const char* image_file;
        DWORD       width;
        DWORD       flags;
}NCS_LISTV_CLMRD;

MGNCS_EXPORT extern const unsigned char gListVColumnRecordTypes[];

#define NCSCTRL_LISTVIEW NCSCLASSNAME("listview")

#define NCSS_LISTV_NOTIFY    NCSS_NOTIFY

#define NCSS_LISTV_LOOP      NCSS_ITEMV_LOOP

#define NCSS_LISTV_MULTIPLE     NCSS_ITEMV_MULTIPLE

#define NCSS_LISTV_SINGLE     NCSS_ITEMV_SINGLE

#define NCSS_LISTV_CHECKBOX  (0x0001<<NCSS_ITEMV_SHIFT)

#define NCSS_LISTV_AUTOCHECK (0x0002<<NCSS_ITEMV_SHIFT)

#define NCSS_LISTV_AUTOCHECKBOX \
    (NCSS_LISTV_CHECKBOX | NCSS_LISTV_AUTOCHECK)

#define NCSS_LISTV_TREE      (0x0004<<NCSS_ITEMV_SHIFT)

#define NCSS_LISTV_WITHICON  (0x0008<<NCSS_ITEMV_SHIFT)

#define NCSS_LISTV_SORT      (0x0010<<NCSS_ITEMV_SHIFT)

#define NCSS_LISTV_NOHDRDRAG (0x0020<<NCSS_ITEMV_SHIFT)

#define NCSS_LISTV_SHIFT     (NCSS_ITEMV_SHIFT + 6)

#define mListViewHeader(className)  \
    mItemViewHeader(className)      \
    NCS_CB_LISTV_DRAWHDRBK  drawHdrBk;  \
    NCS_CB_LISTV_DRAWHDR    drawHdrItem;\
    NCS_CB_DRAWITEMBK   drawItemBk; \
    NCS_CB_DRAWITEM     drawSubItem;\
    mItemManager *hdrList;          \
    mListItem *rootItem;            \
    ncsLstClmSortType sort;         \
    int curCol;                     \
    int gridLineWidth;              \
    int gridLineColor;              \
    NCS_CB_LISTV_CMPCLM pfnSort;    \
    int hdrH;                       \
    int hdrW;                       \
    int dragedHead;                 \
    int dragX;                      \
    mListColumn *clickedHead;       \
    DWORD status;

struct _mListView
{
        mListViewHeader(mListView)
};

#define mListViewClassHeader(clsName, parentClass)  \
    mItemViewClassHeader(clsName, parentClass)      \
    NCS_CB_DRAWITEMBK (*setItemBkDraw)(clsName*, NCS_CB_DRAWITEMBK func);\
    NCS_CB_DRAWITEM (*setSubItemDraw)(clsName*, NCS_CB_DRAWITEM func);  \
    HITEM (*getRelatedItem)(clsName*,HITEM hItem,ncsListVIRType type);  \
    void (*setBackground)(clsName*,int row,int col,int *color);         \
    void (*setForeground)(clsName*,int row,int col,int *color);         \
    int (*getBackground)(clsName*,int row,int col,int *color);          \
    int (*getForeground)(clsName*,int row,int col,int *color);          \
    void (*sort)(clsName*, NCS_CB_LISTV_CMPCLM func, int col, ncsLstClmSortType sort);\
    void (*setCustomDrawHeader)(clsName*, NCS_CB_LISTV_CSTMHDROPS *func);\
    BOOL (*setItemInfo)(clsName*, NCS_LISTV_ITEMDATA *info);            \
    BOOL (*getItemInfo)(clsName*, NCS_LISTV_ITEMDATA *info);            \
    const char* (*getItemText)(clsName*, int row, int col);             \
    int (*getItemTextLen)(clsName*, int row, int col);                  \
        BOOL (*setItemText)(clsName*, int row, int col, const char* str);   \
    void (*setSortDirection)(clsName*, ncsLstClmSortType direction);    \
    ncsLstClmSortType (*getSortDirection)(clsName*);                    \
    HITEM (*findItem)(clsName*, NCS_LISTV_FINDINFO *info);              \
    mListColumn* (*getColumn)(clsName*, int index);                     \
    int (*getColumnIndex)(clsName*, mListColumn *column);               \
    int (*getColumnWidth)(clsName*, int index);                         \
    void (*setColumnWidth)(clsName*, int index, int width);             \
    int (*getColumnCount)(clsName*);                                    \
    mListColumn* (*getSortColumn)(clsName*);                            \
    void (*setSortColumn)(clsName*, mListColumn* column);               \
    void (*showColumn)(clsName*, mListColumn *column);                  \
    BOOL (*delColumn)(clsName*, int index);                             \
    BOOL (*addColumn)(clsName*, NCS_LISTV_CLMINFO *info);               \
    HITEM (*addItem)(clsName*, NCS_LISTV_ITEMINFO *info);               \
    BOOL (*setHeadText)(clsName*, int col, const char* text);           \
    HITEM (*getChildItem)(clsName*, HITEM parent,int index);            \
    int (*getChildCount)(clsName*, HITEM hItem);                        \
    int (*foldItem)(clsName*, HITEM hItem, BOOL fold);


struct _mListViewClass
{
        mListViewClassHeader(mListView, mItemView)
};

#define mListViewRendererHeader(clsName, parentClass)               \
        mItemViewRendererHeader(clsName, parentClass)                   \
    void (*drawHeader) (clsName *self, HDC hdc, const RECT* pRect,  \
            DWORD color, int flag);                                 \
    void (*drawFold) (clsName *self, HDC hdc, const RECT* pRect,    \
            DWORD color, HICON icon, int status, int next);

struct  _mListViewRenderer {
        mListViewRendererHeader(mListView, mItemView)
};

enum mListViewProp
{
    NCSP_LISTV_DEFITEMHEIGHT = NCSP_ITEMV_DEFITEMHEIGHT,
    NCSP_LISTV_ROWCOUNT = NCSP_ITEMV_ITEMCOUNT,
    NCSP_LISTV_HDRHEIGHT = NCSP_ITEMV_MAX + 1,
    NCSP_LISTV_HDRWIDTH,
    NCSP_LISTV_HDRVISIBLE,
    NCSP_LISTV_SORTCOLUMN,
    NCSP_LISTV_GRIDLINEWIDTH,
    NCSP_LISTV_GRIDLINECOLOR,
    NCSP_LISTV_COLCOUNT,
        NCSP_LISTV_MAX,
};

enum mListViewNotify
{
    NCSN_LISTV_CLICKED = NCSN_ITEMV_CLICKED,
    NCSN_LISTV_SELCHANGED = NCSN_ITEMV_SELCHANGED,
    NCSN_LISTV_ITEMRDOWN = NCSN_ITEMV_MAX + 1,
    NCSN_LISTV_ITEMRUP,
    NCSN_LISTV_HDRRDOWN,
    NCSN_LISTV_HDRRUP,
    NCSN_LISTV_ITEMDBCLK,
    NCSN_LISTV_FOLDITEM,
    NCSN_LISTV_UNFOLDITEM,
        NCSN_LISTV_MAX
};

MGNCS_EXPORT extern mListViewClass g_stmListViewCls;
#ifdef __cplusplus
}
#endif  /* __cplusplus */

#endif /* _MGUI_CTRL_LISTV_H */
#endif //_MGNCSCTRL_LISTVIEW