mmledit.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
//

#ifndef _MGUI_NCSCTRL_MLEDIT_H
#define _MGUI_NCSCTRL_MLEDIT_H

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

/* ------------------------------- text document/buffer ------------------------ */

/* content type, reserved */
typedef enum {
    CT_TEXT,
    CT_BMP,
    CT_ICON
} ContentType;

/* text format, reserved */
typedef enum {
    TF_PLAINTEXT,
    TF_RICHTEXT,
    TF_MEDIATEXT
} TextFormat;

/* one text line (end with '\n') is a scrollview item */ 
/* structure of text node/line */
typedef struct _textnode
{
    list_t    list;            /* list element */
    StrBuffer content;
    DWORD     addData;         /* for storing scrollview item handle */
} TextNode;

/* structure of a text mark, recording insert position or selection range */
typedef struct _textmark
{
    int       pos_lnOff;       /* mark offset in the text node*/
    TextNode  *curNode;        /* text node containing the mark*/
} TextMark;

/* structure of text document data */
typedef struct _textdoc
{
    list_t    queue;           /* text line/node head */

    /* setup field */
    unsigned char lnsep;       /* line seperator (default is "\n") */
    int       nDefLineSize;    /* default line buffer size*/
    int       nBlockSize;      /* line buffer block size */

    /* node init function executed when creating node */
    void      (*init_fn)     (struct _textdoc *, TextNode *, TextNode *);
    /* node change function executed when changing current insertion/selection node */
    void      (*change_fn)   (struct _textdoc *, BOOL bSel);
    /* node content change function executed when string content of a node is changed */
    void      (*change_cont) (struct _textdoc *, TextNode *node);
    /* node destroy function */
    void      (*del_fn)      (struct _textdoc *, TextNode *);
    void       *fn_data;       /* data passed to init_fn */

    /* status field */
    TextMark  insert;          /* cursor/insertion mark */
    TextMark  selection;       /* selection mark */

} TextDoc;

/* -------------------------------------------------------------------------- */

/* backup data struct */
typedef struct _status_data
{
    DWORD     flags;        /* editor status */

    int       desCaretX;  /* the desired caret x position, changed by mouse and <- , -> */

    int       caretX;      /* caret x position in the virtual content window */
    int       caretY;      /* caret y position in the virtual content window */
    int       selX;        /* selection point x position in the virtual content window */
    int       selY;        /* selection point y position in the virtual content window */

    TextNode  *maxNode;     /* node with the max length */
    int       maxLen;       /* max line length */
    TextNode  *secNode;     /* node with the second max length */
    int       secLen;       /* seconde max line length */

    int       curItemY;     /* y position of the current insertion node */
    int       selItemY;     /* y position of the selection node */
} STATDATA;
typedef STATDATA* PSTATDATA;

/* structure of backup text node/line */
typedef struct _bk_textnode
{
    list_t    list;         /* list element */
    StrBuffer content;      /* text content */
} BkNode;

typedef struct _backup_data
{
    STATDATA  statData;
    TextMark  bkIns;        /* backup insertion point */
    TextMark  bkSel;        /* backup selection point */
    int       opType;       /* operation type */
    list_t    bkQueue;      /* backup text nodes */
} BKDATA;
typedef BKDATA* PBKDATA;

/*
 * \def NCSCTRL_MLEDIT
 * \brief the name of mledit control
*/
#define NCSCTRL_MLEDIT   NCSCLASSNAME("mledit")

typedef struct _mMlEdit         mMlEdit;
typedef struct _mMlEditClass    mMlEditClass;
typedef struct _mMlEditRenderer mMlEditRenderer;


#define mMlEditHeader(Class)        \
        mEditHeader(Class)          \
        TextDoc   txtDoc;           \
        StrBuffer teBuff;           \
        int       nrDiffLine;       \
        int       wNoChanged;       \
        int       wLastLine;        \
        int       hardLimit;        \
        int       curLen;           \
        int       nLineHeight;      \
        int       nLineAboveH;      \
        int       nLineBaseH;       \
        unsigned char lnChar;       \
        unsigned char caretShape;   \
        char      *title;           \
        int       titleIndent;      \
        DWORD     flags;            \
        DWORD     exFlags;          \
        BOOL      contDirty;        \
        int       desCaretX;        \
        int       caretX;           \
        int       caretY;           \
        int       selX;             \
        int       selY;             \
        TextNode  *maxNode;         \
        int       maxLen;           \
        TextNode  *secNode;         \
        int       secLen;           \
        int       curItemY;         \
        int       selItemY;         \
        TextCopyPaste *cp;

struct _mMlEdit
{
    mMlEditHeader(mMlEdit)
};

#define mMlEditClassHeader(clsName, parentClass)                   \
    mEditClassHeader (clsName, parentClass)                        \
    int (*setTitle)(clsName *self, const char *title, int len);    \
    int (*getTitle)(clsName *self, char *buffer, int len); 

struct _mMlEditClass
{
    mMlEditClassHeader(mMlEdit, mEdit)
};

MGNCS_EXPORT extern mMlEditClass g_stmMlEditCls;


#define mMlEditRendererHeader(clsName, parentClass) \
        mEditRendererHeader(clsName, parentClass)       \


struct _mMlEditRenderer
{
        mMlEditRendererHeader(mMlEdit, mEdit)
};

#define NCSS_MLEDIT_AUTOWRAP   (0x0001<<NCSS_EDIT_SHIFT)

#define NCSS_MLEDIT_TITLE      (0x0002<<NCSS_EDIT_SHIFT)

#define NCSS_MLEDIT_SHIFT  (NCSS_EDIT_SHIFT+2)

enum mMlEditProp 
{
    NCSP_MLEDIT_LINECOUNT = NCSP_EDIT_MAX + 1,   
    NCSP_MLEDIT_LINEHEIGHT,                    
    NCSP_MLEDIT_LINEFEEDISPCHAR,               
    NCSP_MLEDIT_LINESEP,                       
    NCSP_MLEDIT_CARETSHAPE,                    
    NCSP_MLEDIT_NUMOFPARAGRAPHS,               
    NCSP_MLEDIT_MAX
};

enum mMlEditNotify
{
    NCSN_MLEDIT_MAX = NCSN_EDIT_MAX + 1,
};

enum ncsCaretShape
{
    NCS_CARETSHAPE_LINE = 0, 
    NCS_CARETSHAPE_BLOCK     
};


/* internal status flags */
#define NCSF_MLEDIT_SELECT         0x0001
#define NCSF_MLEDIT_FOCUSED        0x0002
#define NCSF_MLEDIT_TMP            0x0004
#define NCSF_MLEDIT_REPLACE        0x0008
#define NCSF_MLEDIT_MOVE           0x0010
#define NCSF_MLEDIT_NOCARET        0x0020
#define NCSF_MLEDIT_EX_SETFOCUS    0x0040
#define NCSF_MLEDIT_EX_KILLFOCUS   0x0080

#ifdef __cplusplus
}
#endif  /* __cplusplus */

#endif /* _MGUI_NCSCTRL_MLEDIT_H */