draglist.c 10.2 KB
Newer Older
Eric Kohl's avatar
Eric Kohl committed
1 2 3 4
/*
 * Drag List control
 *
 * Copyright 1999 Eric Kohl
5
 * Copyright 2004 Robert Shearman
Eric Kohl's avatar
Eric Kohl committed
6
 *
7 8 9 10 11 12 13 14 15 16 17 18 19 20
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
21 22 23 24 25 26 27 28 29
 * NOTES
 *
 * This code was audited for completeness against the documented features
 * of Comctl32.dll version 6.0 on Mar. 10, 2004, by Robert Shearman.
 * 
 * Unless otherwise noted, we believe this code to be complete, as per
 * the specification mentioned above.
 * If you discover missing features or bugs please note them below.
 * 
Eric Kohl's avatar
Eric Kohl committed
30 31
 */

32 33 34 35 36 37 38
#include <stdarg.h>

#include "windef.h"
#include "winbase.h"
#include "wingdi.h"
#include "winuser.h"
#include "winnls.h"
Eric Kohl's avatar
Eric Kohl committed
39
#include "commctrl.h"
40
#include "comctl32.h"
41
#include "wine/debug.h"
Eric Kohl's avatar
Eric Kohl committed
42

43
WINE_DEFAULT_DEBUG_CHANNEL(commctrl);
44

45 46 47
/* for compiler compatibility we only accept literal ASCII strings */
#undef TEXT
#define TEXT(string) string
48 49 50 51 52 53 54 55 56 57 58 59 60

#define DRAGLIST_SUBCLASSID     0
#define DRAGLIST_SCROLLPERIOD 200
#define DRAGLIST_TIMERID      666

/* properties relating to IDI_DRAGICON */
#define DRAGICON_HOTSPOT_X 17
#define DRAGICON_HOTSPOT_Y  7
#define DRAGICON_HEIGHT    32

/* internal Wine specific data for the drag list control */
typedef struct _DRAGLISTDATA
{
61 62
    /* are we currently in dragging mode? */
    BOOL dragging;
63

64
    /* cursor to use as determined by DL_DRAGGING notification.
65 66
     * NOTE: as we use LoadCursor we don't have to use DeleteCursor
     * when we are finished with it */
67
    HCURSOR cursor;
Eric Kohl's avatar
Eric Kohl committed
68

69 70
    /* optimisation so that we don't have to load the cursor
     * all of the time whilst dragging */
71 72
    LRESULT last_dragging_response;

73 74 75 76
    /* prevents flicker with drawing drag arrow */
    RECT last_drag_icon_rect;
} DRAGLISTDATA;

77
UINT uDragListMessage = 0; /* registered window message code */
Eric Kohl's avatar
Eric Kohl committed
78
static DWORD dwLastScrollTime = 0;
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
static HICON hDragArrow = NULL;

/***********************************************************************
 *		DragList_Notify (internal)
 *
 * Sends notification messages to the parent control. Note that it
 * does not use WM_NOTIFY like the rest of the controls, but a registered
 * window message.
 */
static LRESULT DragList_Notify(HWND hwndLB, UINT uNotification)
{
    DRAGLISTINFO dli;
    dli.hWnd = hwndLB;
    dli.uNotification = uNotification;
    GetCursorPos(&dli.ptCursor);
    return SendMessageW(GetParent(hwndLB), uDragListMessage, GetDlgCtrlID(hwndLB), (LPARAM)&dli);
}

/* cleans up after dragging */
static inline void DragList_EndDrag(HWND hwnd, DRAGLISTDATA * data)
{
    KillTimer(hwnd, DRAGLIST_TIMERID);
    ReleaseCapture();
    /* clear any drag insert icon present */
    InvalidateRect(GetParent(hwnd), &data->last_drag_icon_rect, TRUE);
104 105
    /* clear data for next use */
    memset(data, 0, sizeof(*data));
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
}

/***********************************************************************
 *		DragList_SubclassWindowProc (internal)
 *
 * Handles certain messages to enable dragging for the ListBox and forwards
 * the rest to the ListBox.
 */
static LRESULT CALLBACK
DragList_SubclassWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam, UINT_PTR uIdSubclass, DWORD_PTR dwRefData)
{
    DRAGLISTDATA * data = (DRAGLISTDATA*)dwRefData;
    switch (uMsg)
    {
    case WM_LBUTTONDOWN:
        SetFocus(hwnd);
        data->dragging = DragList_Notify(hwnd, DL_BEGINDRAG);
        if (data->dragging)
        {
            SetCapture(hwnd);
            SetTimer(hwnd, DRAGLIST_TIMERID, DRAGLIST_SCROLLPERIOD, NULL);
        }
        /* note that we don't absorb this message to let the list box
         * do its thing (normally selecting an item) */
        break;

    case WM_KEYDOWN:
    case WM_RBUTTONDOWN:
        /* user cancelled drag by either right clicking or
         * by pressing the escape key */
        if ((data->dragging) &&
            ((uMsg == WM_RBUTTONDOWN) || (wParam == VK_ESCAPE)))
        {
            /* clean up and absorb message */
            DragList_EndDrag(hwnd, data);
            DragList_Notify(hwnd, DL_CANCELDRAG);
            return 0;
        }
        break;

    case WM_MOUSEMOVE:
    case WM_TIMER:
        if (data->dragging)
        {
            LRESULT cursor = DragList_Notify(hwnd, DL_DRAGGING);
            /* optimisation so that we don't have to load the cursor
             * all of the time whilst dragging */
            if (data->last_dragging_response != cursor)
            {
                switch (cursor)
                {
                case DL_STOPCURSOR:
                    data->cursor = LoadCursorW(NULL, (LPCWSTR)IDC_NO);
                    SetCursor(data->cursor);
                    break;
                case DL_COPYCURSOR:
                    data->cursor = LoadCursorW(COMCTL32_hModule, (LPCWSTR)IDC_COPY);
                    SetCursor(data->cursor);
                    break;
                case DL_MOVECURSOR:
                    data->cursor = LoadCursorW(NULL, (LPCWSTR)IDC_ARROW);
                    SetCursor(data->cursor);
                    break;
                }
                data->last_dragging_response = cursor;
            }
            /* don't pass this message on to List Box */
            return 0;
        }
        break;

    case WM_LBUTTONUP:
        if (data->dragging)
        {
            DragList_EndDrag(hwnd, data);
            DragList_Notify(hwnd, DL_DROPPED);
        }
        break;

    case WM_GETDLGCODE:
        /* tell dialog boxes that we want to receive WM_KEYDOWN events
         * for keys like VK_ESCAPE */
        if (data->dragging)
            return DLGC_WANTALLKEYS;
        break;
    case WM_NCDESTROY:
        RemoveWindowSubclass(hwnd, DragList_SubclassWindowProc, DRAGLIST_SUBCLASSID);
        Free(data);
        break;
    }
    return DefSubclassProc(hwnd, uMsg, wParam, lParam);
}
Eric Kohl's avatar
Eric Kohl committed
198

199
/***********************************************************************
200
 *		MakeDragList (COMCTL32.13)
201 202 203 204 205 206
 *
 * Makes a normal ListBox into a DragList by subclassing it.
 *
 * RETURNS
 *      Success: Non-zero
 *      Failure: Zero
207
 */
208
BOOL WINAPI MakeDragList (HWND hwndLB)
Eric Kohl's avatar
Eric Kohl committed
209
{
210 211 212
    DRAGLISTDATA * data = Alloc(sizeof(DRAGLISTDATA));

    TRACE("(%p)\n", hwndLB);
Eric Kohl's avatar
Eric Kohl committed
213

214 215
    if (!uDragListMessage)
        uDragListMessage = RegisterWindowMessageA(DRAGLISTMSGSTRING);
Eric Kohl's avatar
Eric Kohl committed
216

217
    return SetWindowSubclass(hwndLB, DragList_SubclassWindowProc, DRAGLIST_SUBCLASSID, (DWORD_PTR)data);
Eric Kohl's avatar
Eric Kohl committed
218 219
}

220
/***********************************************************************
221
 *		DrawInsert (COMCTL32.15)
222 223 224 225 226
 *
 * Draws insert arrow by the side of the ListBox item in the parent window.
 *
 * RETURNS
 *      Nothing.
227
 */
228
VOID WINAPI DrawInsert (HWND hwndParent, HWND hwndLB, INT nItem)
Eric Kohl's avatar
Eric Kohl committed
229
{
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
    RECT rcItem, rcListBox, rcDragIcon;
    HDC hdc;
    DRAGLISTDATA * data;

    TRACE("(%p %p %d)\n", hwndParent, hwndLB, nItem);

    if (!hDragArrow)
        hDragArrow = LoadIconW(COMCTL32_hModule, (LPCWSTR)IDI_DRAGARROW);

    if (LB_ERR == SendMessageW(hwndLB, LB_GETITEMRECT, nItem, (LPARAM)&rcItem))
        return;

    if (!GetWindowRect(hwndLB, &rcListBox))
        return;

    /* convert item rect to parent co-ordinates */
    if (!MapWindowPoints(hwndLB, hwndParent, (LPPOINT)&rcItem, 2))
        return;

    /* convert list box rect to parent co-ordinates */
    if (!MapWindowPoints(HWND_DESKTOP, hwndParent, (LPPOINT)&rcListBox, 2))
        return;

    rcDragIcon.left = rcListBox.left - DRAGICON_HOTSPOT_X;
    rcDragIcon.top = rcItem.top - DRAGICON_HOTSPOT_Y;
    rcDragIcon.right = rcListBox.left;
    rcDragIcon.bottom = rcDragIcon.top + DRAGICON_HEIGHT;
Eric Kohl's avatar
Eric Kohl committed
257

258 259
    if (!GetWindowSubclass(hwndLB, DragList_SubclassWindowProc, DRAGLIST_SUBCLASSID, (DWORD_PTR*)&data))
        return;
Eric Kohl's avatar
Eric Kohl committed
260

261 262 263
    if (nItem < 0)
        SetRectEmpty(&rcDragIcon);

264 265 266 267 268 269 270
    /* prevent flicker by only redrawing when necessary */
    if (!EqualRect(&rcDragIcon, &data->last_drag_icon_rect))
    {
        /* get rid of any previous inserts drawn */
        RedrawWindow(hwndParent, &data->last_drag_icon_rect, NULL,
            RDW_INTERNALPAINT | RDW_ERASE | RDW_INVALIDATE | RDW_UPDATENOW);

271 272
        CopyRect(&data->last_drag_icon_rect, &rcDragIcon);

273 274 275 276 277 278 279 280 281
        if (nItem >= 0)
        {
            hdc = GetDC(hwndParent);

            DrawIcon(hdc, rcDragIcon.left, rcDragIcon.top, hDragArrow);

            ReleaseDC(hwndParent, hdc);
        }
    }
Eric Kohl's avatar
Eric Kohl committed
282 283
}

284
/***********************************************************************
285
 *		LBItemFromPt (COMCTL32.14)
286 287 288 289 290 291
 *
 * Gets the index of the ListBox item under the specified point,
 * scrolling if bAutoScroll is TRUE and pt is outside of the ListBox.
 *
 * RETURNS
 *      The ListBox item ID if pt is over a list item or -1 otherwise.
292
 */
293
INT WINAPI LBItemFromPt (HWND hwndLB, POINT pt, BOOL bAutoScroll)
Eric Kohl's avatar
Eric Kohl committed
294
{
Eric Kohl's avatar
Eric Kohl committed
295 296 297 298
    RECT rcClient;
    INT nIndex;
    DWORD dwScrollTime;

299 300
    TRACE("(%p %ld x %ld %s)\n",
           hwndLB, pt.x, pt.y, bAutoScroll ? "TRUE" : "FALSE");
Eric Kohl's avatar
Eric Kohl committed
301

Eric Kohl's avatar
Eric Kohl committed
302 303 304 305 306 307
    ScreenToClient (hwndLB, &pt);
    GetClientRect (hwndLB, &rcClient);
    nIndex = (INT)SendMessageA (hwndLB, LB_GETTOPINDEX, 0, 0);

    if (PtInRect (&rcClient, pt))
    {
308 309 310 311 312
        /* point is inside -- get the item index */
        while (TRUE)
        {
            if (SendMessageA (hwndLB, LB_GETITEMRECT, nIndex, (LPARAM)&rcClient) == LB_ERR)
                return -1;
Eric Kohl's avatar
Eric Kohl committed
313

314 315
            if (PtInRect (&rcClient, pt))
                return nIndex;
Eric Kohl's avatar
Eric Kohl committed
316

317 318
            nIndex++;
        }
Eric Kohl's avatar
Eric Kohl committed
319 320 321
    }
    else
    {
322 323 324
        /* point is outside */
        if (!bAutoScroll)
            return -1;
Eric Kohl's avatar
Eric Kohl committed
325

326 327
        if ((pt.x > rcClient.right) || (pt.x < rcClient.left))
            return -1;
Eric Kohl's avatar
Eric Kohl committed
328

329 330 331 332
        if (pt.y < 0)
            nIndex--;
        else
            nIndex++;
Eric Kohl's avatar
Eric Kohl committed
333

334
        dwScrollTime = GetTickCount ();
Eric Kohl's avatar
Eric Kohl committed
335

336 337
        if ((dwScrollTime - dwLastScrollTime) < DRAGLIST_SCROLLPERIOD)
            return -1;
Eric Kohl's avatar
Eric Kohl committed
338

339
        dwLastScrollTime = dwScrollTime;
Eric Kohl's avatar
Eric Kohl committed
340

341
        SendMessageA (hwndLB, LB_SETTOPINDEX, (WPARAM)nIndex, 0);
Eric Kohl's avatar
Eric Kohl committed
342
    }
Eric Kohl's avatar
Eric Kohl committed
343 344 345

    return -1;
}