SftTree/DLL 7.5 - Tree Control

OwnerDrawCallback

Defines an application-supplied owner-draw function, which is called whenever an object needs to be rendered.

C

BOOL WINAPI SftTree_SetOwnerDrawCallback(HWND hwndCtl, LPCSFTTREE_OWNERDRAWPARM lpDrawInfo);
BOOL WINAPI SftTreeSplit_SetOwnerDrawCallback(HWND hwndCtl, LPCSFTTREE_OWNERDRAWPARM lpDrawInfo);

C++

BOOL CSftTree::SetOwnerDrawCallback(LPCSFTTREE_OWNERDRAWPARM lpDrawInfo);
BOOL CSftTreeSplit::SetOwnerDrawCallback(LPCSFTTREE_OWNERDRAWPARM lpDrawInfo);

Parameters

hwndCtl

The window handle of the tree control.

lpDrawInfo

A pointer to a SFTTREE_OWNERDRAWPARM structure containing the parameters for this function to register a callback function and user supplied data. This parameter may be NULL to stop using the callback function. The SFTTREE_OWNERDRAWPARM structure contains the following members:

Returns

The return value is TRUE if the function was successful, otherwise FALSE if an error occurred.

Comments

The SetOwnerDrawCallback function defines an application-supplied owner-draw function, which is called whenever an object needs to be rendered.

The callback receives control when an object needs to be rendered. The callback can then perform application specific rendering of the object. An application can render cells, cell ToolTips, row headers, column headers and row/column headers using the owner-draw function.

Examples

C

        SftTree_SetRowColHeaderStyle(g_hwndTree, ES_LEFT | SFTTREE_HEADER_UP);/* Row/column header style */
        SftTree_SetRowColHeaderPictureStyle(g_hwndTree, SFTTREE_BMP_RIGHT);/* Row/column picture alignment */
        SftTree_SetCharSearchMode(g_hwndTree, SFTTREE_CHARSEARCH_ALLCHARS, -1);/* Consider all characters typed */
        /* Use an ownerdraw callback routine */
        {
            SFTTREE_OWNERDRAWPARM Parm;      /* Parameter list */
            Parm.lpfnOwnerDrawProc = (LPFNSFTTREE_OWNERDRAWPROC) Tree_OwnerDrawCallback;/* User supplied drawing routine */
            Parm.OwnerDrawUserData = (SFTTREE_DWORD_PTR)0;/* User supplied data */
            SftTree_SetOwnerDrawCallback(g_hwndTree, &Parm);
        }
        /* Change the default colors */
        {
            SFTTREE_COLORS Colors;
            SftTree_GetCtlColors(g_hwndTree, &Colors);/* Get current color settings */
            Colors.colorTreeLines = COLOR_3DDKSHADOW | 0x80000000L;/* Tree line color */
            Colors.colorSelBgNoFocus = COLOR_BTNFACE | 0x80000000L;/* Selection background color (no input focus) */

View Entire Sample Code

C++

    m_Tree.SetShowRowHeader(SFTTREE_ROWSTYLE_BUTTONCOUNT1);/* Row style */
    m_Tree.SetRowColHeaderText(_T("?"));       /* Row/column header text */
    m_Tree.SetRowColHeaderStyle(ES_LEFT | SFTTREE_HEADER_UP);/* Row/column header style */
    m_Tree.SetCharSearchMode(SFTTREE_CHARSEARCH_ALLCHARS, -1);/* Consider all characters typed */
    /* Use an ownerdraw callback routine */
    {
        SFTTREE_OWNERDRAWPARM Parm;      /* Parameter list */
        Parm.lpfnOwnerDrawProc = (LPFNSFTTREE_OWNERDRAWPROC) CSampleView::OwnerDrawCallback;/* User supplied drawing routine */
        Parm.OwnerDrawUserData = (SFTTREE_DWORD_PTR)this;/* User supplied data */
        m_Tree.SetOwnerDrawCallback(&Parm);
    }
    /* Change the default colors */
    {
        SFTTREE_COLORS Colors;
        m_Tree.GetCtlColors(&Colors);    /* Get current color settings */
        Colors.colorTreeLines = COLOR_3DDKSHADOW | 0x80000000L;/* Tree line color */

View Entire Sample Code

See Also C/C++ API | Categories | Notifications