4 * Copyright 2004 - 2006 Thomas Weidenmueller <w3seek@reactos.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 * This code was audited for completeness against the documented features
23 * of Comctl32.dll version 6.0 on Apr. 4, 2005, by Dimitrie O. Paun.
25 * Unless otherwise noted, we believe this code to be complete, as per
26 * the specification mentioned above.
27 * If you discover missing features, or bugs, please note them below.
39 #include "wine/unicode.h"
40 #include "wine/debug.h"
42 WINE_DEFAULT_DEBUG_CHANNEL(progress);
44 INT WINAPI StrCmpNIW(LPCWSTR,LPCWSTR,INT);
51 } DOC_TEXTBLOCK, *PDOC_TEXTBLOCK;
53 #define LIF_FLAGSMASK (LIF_STATE | LIF_ITEMID | LIF_URL)
54 #define LIS_MASK (LIS_FOCUSED | LIS_ENABLED | LIS_VISITED)
62 typedef struct _DOC_ITEM
64 struct _DOC_ITEM *Next; /* Address to the next item */
65 UINT nText; /* Number of characters of the text */
66 SL_ITEM_TYPE Type; /* type of the item */
67 PDOC_TEXTBLOCK Blocks; /* Array of text blocks */
72 UINT state; /* Link state */
73 WCHAR *szID; /* Link ID string */
74 WCHAR *szUrl; /* Link URL string */
81 WCHAR Text[1]; /* Text of the document item */
82 } DOC_ITEM, *PDOC_ITEM;
86 HWND Self; /* The window handle for this control */
87 HWND Notify; /* The parent handle to receive notifications */
88 DWORD Style; /* Styles for this control */
89 PDOC_ITEM Items; /* Address to the first document item */
90 BOOL HasFocus; /* Whether the control has the input focus */
91 int MouseDownID; /* ID of the link that the mouse button first selected */
92 HFONT Font; /* Handle to the font for text */
93 HFONT LinkFont; /* Handle to the font for links */
94 COLORREF TextColor; /* Color of the text */
95 COLORREF LinkColor; /* Color of links */
96 COLORREF VisitedColor; /* Color of visited links */
97 WCHAR BreakChar; /* Break Character for the current font */
100 static const WCHAR SL_LINKOPEN[] = { '<','a', 0 };
101 static const WCHAR SL_HREF[] = { 'h','r','e','f','=','\"',0 };
102 static const WCHAR SL_ID[] = { 'i','d','=','\"',0 };
103 static const WCHAR SL_LINKCLOSE[] = { '<','/','a','>',0 };
105 /* Control configuration constants */
107 #define SL_LEFTMARGIN (0)
108 #define SL_TOPMARGIN (0)
109 #define SL_RIGHTMARGIN (0)
110 #define SL_BOTTOMMARGIN (0)
112 /***********************************************************************
113 * SYSLINK_FreeDocItem
114 * Frees all data and gdi objects associated with a document item
116 static VOID SYSLINK_FreeDocItem (PDOC_ITEM DocItem)
118 if(DocItem->Type == slLink)
120 Free(DocItem->u.Link.szID);
121 Free(DocItem->u.Link.szUrl);
124 /* we don't free Text because it's just a pointer to a character in the
125 entire window text string */
130 /***********************************************************************
131 * SYSLINK_AppendDocItem
132 * Create and append a new document item.
134 static PDOC_ITEM SYSLINK_AppendDocItem (SYSLINK_INFO *infoPtr, LPCWSTR Text, UINT textlen,
135 SL_ITEM_TYPE type, PDOC_ITEM LastItem)
139 textlen = min(textlen, lstrlenW(Text));
140 Item = Alloc(FIELD_OFFSET(DOC_ITEM, Text[textlen + 1]));
143 ERR("Failed to alloc DOC_ITEM structure!\n");
148 Item->nText = textlen;
154 LastItem->Next = Item;
158 infoPtr->Items = Item;
161 lstrcpynW(Item->Text, Text, textlen + 1);
166 /***********************************************************************
168 * Clears the document tree
170 static VOID SYSLINK_ClearDoc (SYSLINK_INFO *infoPtr)
172 PDOC_ITEM Item, Next;
174 Item = infoPtr->Items;
178 SYSLINK_FreeDocItem(Item);
182 infoPtr->Items = NULL;
185 /***********************************************************************
187 * Parses the window text string and creates a document. Returns the
188 * number of document items created.
190 static UINT SYSLINK_ParseText (SYSLINK_INFO *infoPtr, LPCWSTR Text)
192 LPCWSTR current, textstart = NULL, linktext = NULL, firsttag = NULL;
193 int taglen = 0, textlen = 0, linklen = 0, docitems = 0;
194 PDOC_ITEM Last = NULL;
195 SL_ITEM_TYPE CurrentType = slText;
199 for(current = Text; *current != 0;)
203 if(!StrCmpNIW(current, SL_LINKOPEN, 2) && (CurrentType == slText))
205 BOOL ValidParam = FALSE, ValidLink = FALSE;
207 if(*(current + 2) == '>')
209 /* we just have to deal with a <a> tag */
218 else if(*(current + 2) == infoPtr->BreakChar)
220 /* we expect parameters, parse them */
221 LPCWSTR *CurrentParameter = NULL, tmp;
222 UINT *CurrentParameterLen = NULL;
225 tmp = current + taglen;
230 /* compare the current position with all known parameters */
231 if(!StrCmpNIW(tmp, SL_HREF, 6))
235 CurrentParameter = &lpUrl;
236 CurrentParameterLen = &lenUrl;
238 else if(!StrCmpNIW(tmp, SL_ID, 4))
242 CurrentParameter = &lpID;
243 CurrentParameterLen = &lenId;
252 /* we got a known parameter, now search until the next " character.
253 If we can't find a " character, there's a syntax error and we just assume it's text */
255 *CurrentParameter = current + taglen;
256 *CurrentParameterLen = 0;
258 for(tmp = *CurrentParameter; *tmp != 0; tmp++)
267 (*CurrentParameterLen)++;
272 /* we're done with this parameter, now there are only 2 possibilities:
273 * 1. another parameter is coming, so expect a ' ' (space) character
274 * 2. the tag is being closed, so expect a '<' character
276 if(*tmp == infoPtr->BreakChar)
278 /* we expect another parameter, do the whole thing again */
285 /* the tag is being closed, we're done */
294 if(ValidLink && ValidParam)
296 /* the <a ...> tag appears to be valid. save all information
297 so we can add the link if we find a valid </a> tag later */
298 CurrentType = slLink;
299 linktext = current + taglen;
308 if(textstart == NULL)
314 else if(!StrCmpNIW(current, SL_LINKCLOSE, 4) && (CurrentType == slLink) && firsttag)
316 /* there's a <a...> tag opened, first add the previous text, if present */
317 if(textstart != NULL && textlen > 0 && firsttag > textstart)
319 Last = SYSLINK_AppendDocItem(infoPtr, textstart, firsttag - textstart, slText, Last);
322 ERR("Unable to create new document item!\n");
330 /* now it's time to add the link to the document */
332 if(linktext != NULL && linklen > 0)
334 Last = SYSLINK_AppendDocItem(infoPtr, linktext, linklen, slLink, Last);
337 ERR("Unable to create new document item!\n");
341 if(CurrentType == slLink)
345 if(!(infoPtr->Style & WS_DISABLED))
347 Last->u.Link.state |= LIS_ENABLED;
349 /* Copy the tag parameters */
352 nc = min(lenId, strlenW(lpID));
353 nc = min(nc, MAX_LINKID_TEXT - 1);
354 Last->u.Link.szID = Alloc((nc + 1) * sizeof(WCHAR));
355 if(Last->u.Link.szID != NULL)
357 lstrcpynW(Last->u.Link.szID, lpID, nc + 1);
361 Last->u.Link.szID = NULL;
364 nc = min(lenUrl, strlenW(lpUrl));
365 nc = min(nc, L_MAX_URL_LENGTH - 1);
366 Last->u.Link.szUrl = Alloc((nc + 1) * sizeof(WCHAR));
367 if(Last->u.Link.szUrl != NULL)
369 lstrcpynW(Last->u.Link.szUrl, lpUrl, nc + 1);
373 Last->u.Link.szUrl = NULL;
377 CurrentType = slText;
384 /* we don't know what tag it is, so just continue */
387 if(CurrentType == slText && textstart == NULL)
401 /* save the pointer of the current text item if we couldn't find a tag */
402 if(textstart == NULL && CurrentType == slText)
411 if(textstart != NULL && textlen > 0)
413 Last = SYSLINK_AppendDocItem(infoPtr, textstart, textlen, CurrentType, Last);
416 ERR("Unable to create new document item!\n");
419 if(CurrentType == slLink)
423 if(!(infoPtr->Style & WS_DISABLED))
425 Last->u.Link.state |= LIS_ENABLED;
427 /* Copy the tag parameters */
430 nc = min(lenId, strlenW(lpID));
431 nc = min(nc, MAX_LINKID_TEXT - 1);
432 Last->u.Link.szID = Alloc((nc + 1) * sizeof(WCHAR));
433 if(Last->u.Link.szID != NULL)
435 lstrcpynW(Last->u.Link.szID, lpID, nc + 1);
439 Last->u.Link.szID = NULL;
442 nc = min(lenUrl, strlenW(lpUrl));
443 nc = min(nc, L_MAX_URL_LENGTH - 1);
444 Last->u.Link.szUrl = Alloc((nc + 1) * sizeof(WCHAR));
445 if(Last->u.Link.szUrl != NULL)
447 lstrcpynW(Last->u.Link.szUrl, lpUrl, nc + 1);
451 Last->u.Link.szUrl = NULL;
456 if(linktext != NULL && linklen > 0)
458 /* we got an unclosed link, just display the text */
459 Last = SYSLINK_AppendDocItem(infoPtr, linktext, linklen, slText, Last);
462 ERR("Unable to create new document item!\n");
471 /***********************************************************************
472 * SYSLINK_RepaintLink
475 static VOID SYSLINK_RepaintLink (SYSLINK_INFO *infoPtr, PDOC_ITEM DocItem)
480 if(DocItem->Type != slLink)
482 ERR("DocItem not a link!\n");
486 bl = DocItem->Blocks;
493 InvalidateRect(infoPtr->Self, &bl->rc, TRUE);
494 n -= bl->nChars + bl->nSkip;
500 /***********************************************************************
501 * SYSLINK_GetLinkItemByIndex
502 * Retrieves a document link by its index
504 static PDOC_ITEM SYSLINK_GetLinkItemByIndex (SYSLINK_INFO *infoPtr, int iLink)
506 PDOC_ITEM Current = infoPtr->Items;
508 while(Current != NULL)
510 if((Current->Type == slLink) && (iLink-- <= 0))
514 Current = Current->Next;
519 /***********************************************************************
520 * SYSLINK_GetFocusLink
521 * Retrieves the link that has the LIS_FOCUSED bit
523 static PDOC_ITEM SYSLINK_GetFocusLink (SYSLINK_INFO *infoPtr, int *LinkId)
525 PDOC_ITEM Current = infoPtr->Items;
528 while(Current != NULL)
530 if((Current->Type == slLink))
532 if(Current->u.Link.state & LIS_FOCUSED)
540 Current = Current->Next;
545 /***********************************************************************
546 * SYSLINK_GetNextLink
549 static PDOC_ITEM SYSLINK_GetNextLink (SYSLINK_INFO *infoPtr, PDOC_ITEM Current)
551 for(Current = (Current != NULL ? Current->Next : infoPtr->Items);
553 Current = Current->Next)
555 if(Current->Type == slLink)
563 /***********************************************************************
564 * SYSLINK_GetPrevLink
565 * Gets the previous link
567 static PDOC_ITEM SYSLINK_GetPrevLink (SYSLINK_INFO *infoPtr, PDOC_ITEM Current)
571 /* returns the last link */
572 PDOC_ITEM Last = NULL;
574 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
576 if(Current->Type == slLink)
585 /* returns the previous link */
586 PDOC_ITEM Cur, Prev = NULL;
588 for(Cur = infoPtr->Items; Cur != NULL; Cur = Cur->Next)
594 if(Cur->Type == slLink)
603 /***********************************************************************
605 * Tries to wrap a line.
607 static BOOL SYSLINK_WrapLine (HDC hdc, LPWSTR Text, WCHAR BreakChar, int *LineLen,
608 int nFit, LPSIZE Extent, int Width)
619 Current = Text + nFit;
621 /* check if we're in the middle of a word */
622 if((*Current) != BreakChar)
624 /* search for the beginning of the word */
625 while(Current > Text && (*(Current - 1)) != BreakChar)
642 /***********************************************************************
644 * Renders the document in memory
646 static VOID SYSLINK_Render (SYSLINK_INFO *infoPtr, HDC hdc, PRECT pRect)
651 int x, y, LineHeight;
654 szDoc.cx = szDoc.cy = 0;
657 rc.right -= SL_RIGHTMARGIN;
658 rc.bottom -= SL_BOTTOMMARGIN;
660 if(rc.right - SL_LEFTMARGIN < 0)
662 if (rc.bottom - SL_TOPMARGIN < 0)
665 hOldFont = SelectObject(hdc, infoPtr->Font);
671 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
675 PDOC_TEXTBLOCK bl, cbl;
679 if(Current->nText == 0)
687 if (Current->Blocks != NULL)
689 Free(Current->Blocks);
690 Current->Blocks = NULL;
695 if(Current->Type == slText)
697 SelectObject(hdc, infoPtr->Font);
699 else if(Current->Type == slLink)
701 SelectObject(hdc, infoPtr->LinkFont);
708 /* skip break characters unless they're the first of the doc item */
709 if(tx != Current->Text || x == SL_LEFTMARGIN)
711 while(n > 0 && (*tx) == infoPtr->BreakChar)
719 if((n == 0 && SkipChars != 0) ||
720 GetTextExtentExPointW(hdc, tx, n, rc.right - x, &nFit, NULL, &szDim))
728 Wrap = SYSLINK_WrapLine(hdc, tx, infoPtr->BreakChar, &LineLen, nFit, &szDim, rc.right - x);
732 if(x > SL_LEFTMARGIN)
734 /* move one line down, the word didn't fit into the line */
742 /* the word starts at the beginning of the line and doesn't
743 fit into the line, so break it at the last character that fits */
744 LineLen = max(nFit, 1);
750 if(!GetTextExtentExPointW(hdc, tx, LineLen, rc.right - x, NULL, NULL, &szDim))
763 nbl = ReAlloc(bl, (nBlocks + 1) * sizeof(DOC_TEXTBLOCK));
769 cbl = bl + nBlocks - 1;
771 cbl->nChars = LineLen;
772 cbl->nSkip = SkipChars;
775 cbl->rc.right = x + szDim.cx;
776 cbl->rc.bottom = y + szDim.cy;
778 if (cbl->rc.right > szDoc.cx)
779 szDoc.cx = cbl->rc.right;
780 if (cbl->rc.bottom > szDoc.cy)
781 szDoc.cy = cbl->rc.bottom;
786 LineHeight = max(LineHeight, szDim.cy);
802 ERR("Failed to alloc DOC_TEXTBLOCK structure!\n");
816 Current->Blocks = bl;
820 SelectObject(hdc, hOldFont);
822 pRect->right = pRect->left + szDoc.cx;
823 pRect->bottom = pRect->top + szDoc.cy;
826 /***********************************************************************
828 * Draws the SysLink control.
830 static LRESULT SYSLINK_Draw (SYSLINK_INFO *infoPtr, HDC hdc)
835 COLORREF OldTextColor, OldBkColor;
837 hOldFont = SelectObject(hdc, infoPtr->Font);
838 OldTextColor = SetTextColor(hdc, infoPtr->TextColor);
839 OldBkColor = SetBkColor(hdc, GetSysColor(COLOR_BTNFACE));
841 GetClientRect(infoPtr->Self, &rc);
842 rc.right -= SL_RIGHTMARGIN + SL_LEFTMARGIN;
843 rc.bottom -= SL_BOTTOMMARGIN + SL_TOPMARGIN;
845 if(rc.right < 0 || rc.bottom < 0) return 0;
847 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
853 bl = Current->Blocks;
859 if(Current->Type == slText)
861 SelectObject(hdc, infoPtr->Font);
862 SetTextColor(hdc, infoPtr->TextColor);
866 SelectObject(hdc, infoPtr->LinkFont);
867 SetTextColor(hdc, (!(Current->u.Link.state & LIS_VISITED) ? infoPtr->LinkColor : infoPtr->VisitedColor));
873 ExtTextOutW(hdc, bl->rc.left, bl->rc.top, ETO_OPAQUE | ETO_CLIPPED, &bl->rc, tx, bl->nChars, NULL);
874 if((Current->Type == slLink) && (Current->u.Link.state & LIS_FOCUSED) && infoPtr->HasFocus)
876 COLORREF PrevTextColor;
877 PrevTextColor = SetTextColor(hdc, infoPtr->TextColor);
878 DrawFocusRect(hdc, &bl->rc);
879 SetTextColor(hdc, PrevTextColor);
882 n -= bl->nChars + bl->nSkip;
888 SetBkColor(hdc, OldBkColor);
889 SetTextColor(hdc, OldTextColor);
890 SelectObject(hdc, hOldFont);
896 /***********************************************************************
898 * Handles the WM_PAINT message.
900 static LRESULT SYSLINK_Paint (SYSLINK_INFO *infoPtr, HDC hdcParam)
905 hdc = hdcParam ? hdcParam : BeginPaint (infoPtr->Self, &ps);
908 SYSLINK_Draw (infoPtr, hdc);
909 if (!hdcParam) EndPaint (infoPtr->Self, &ps);
915 /***********************************************************************
917 * Set new Font for the SysLink control.
919 static HFONT SYSLINK_SetFont (SYSLINK_INFO *infoPtr, HFONT hFont, BOOL bRedraw)
925 HFONT hOldFont = infoPtr->Font;
926 infoPtr->Font = hFont;
928 /* free the underline font */
929 if(infoPtr->LinkFont != NULL)
931 DeleteObject(infoPtr->LinkFont);
932 infoPtr->LinkFont = NULL;
935 /* Render text position and word wrapping in memory */
936 if (GetClientRect(infoPtr->Self, &rcClient))
938 hdc = GetDC(infoPtr->Self);
941 /* create a new underline font */
942 if(GetTextMetricsW(hdc, &tm) &&
943 GetObjectW(infoPtr->Font, sizeof(LOGFONTW), &lf))
945 lf.lfUnderline = TRUE;
946 infoPtr->LinkFont = CreateFontIndirectW(&lf);
947 infoPtr->BreakChar = tm.tmBreakChar;
951 ERR("Failed to create link font!\n");
954 SYSLINK_Render(infoPtr, hdc, &rcClient);
955 ReleaseDC(infoPtr->Self, hdc);
961 RedrawWindow(infoPtr->Self, NULL, NULL, RDW_INVALIDATE | RDW_UPDATENOW);
967 /***********************************************************************
969 * Set new text for the SysLink control.
971 static LRESULT SYSLINK_SetText (SYSLINK_INFO *infoPtr, LPCWSTR Text)
975 /* clear the document */
976 SYSLINK_ClearDoc(infoPtr);
978 if(Text == NULL || (textlen = lstrlenW(Text)) == 0)
983 /* let's parse the string and create a document */
984 if(SYSLINK_ParseText(infoPtr, Text) > 0)
988 /* Render text position and word wrapping in memory */
989 if (GetClientRect(infoPtr->Self, &rcClient))
991 HDC hdc = GetDC(infoPtr->Self);
994 SYSLINK_Render(infoPtr, hdc, &rcClient);
995 ReleaseDC(infoPtr->Self, hdc);
997 InvalidateRect(infoPtr->Self, NULL, TRUE);
1005 /***********************************************************************
1006 * SYSLINK_SetFocusLink
1007 * Updates the focus status bits and focusses the specified link.
1008 * If no document item is specified, the focus bit will be removed from all links.
1009 * Returns the previous focused item.
1011 static PDOC_ITEM SYSLINK_SetFocusLink (SYSLINK_INFO *infoPtr, PDOC_ITEM DocItem)
1013 PDOC_ITEM Current, PrevFocus = NULL;
1015 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
1017 if(Current->Type == slLink)
1019 if((PrevFocus == NULL) && (Current->u.Link.state & LIS_FOCUSED))
1021 PrevFocus = Current;
1024 if(Current == DocItem)
1026 Current->u.Link.state |= LIS_FOCUSED;
1030 Current->u.Link.state &= ~LIS_FOCUSED;
1038 /***********************************************************************
1040 * Sets the states and attributes of a link item.
1042 static LRESULT SYSLINK_SetItem (SYSLINK_INFO *infoPtr, PLITEM Item)
1048 BOOL Repaint = FALSE;
1050 if(!(Item->mask & LIF_ITEMINDEX) || !(Item->mask & (LIF_FLAGSMASK)))
1052 ERR("Invalid Flags!\n");
1056 di = SYSLINK_GetLinkItemByIndex(infoPtr, Item->iLink);
1059 ERR("Link %d couldn't be found\n", Item->iLink);
1063 if(Item->mask & LIF_ITEMID)
1065 nc = min(lstrlenW(Item->szID), MAX_LINKID_TEXT - 1);
1066 szId = Alloc((nc + 1) * sizeof(WCHAR));
1069 lstrcpynW(szId, Item->szID, nc + 1);
1073 ERR("Unable to allocate memory for link id\n");
1078 if(Item->mask & LIF_URL)
1080 nc = min(lstrlenW(Item->szUrl), L_MAX_URL_LENGTH - 1);
1081 szUrl = Alloc((nc + 1) * sizeof(WCHAR));
1084 lstrcpynW(szUrl, Item->szUrl, nc + 1);
1090 ERR("Unable to allocate memory for link url\n");
1095 if(Item->mask & LIF_ITEMID)
1097 Free(di->u.Link.szID);
1098 di->u.Link.szID = szId;
1101 if(Item->mask & LIF_URL)
1103 Free(di->u.Link.szUrl);
1104 di->u.Link.szUrl = szUrl;
1107 if(Item->mask & LIF_STATE)
1109 UINT oldstate = di->u.Link.state;
1110 /* clear the masked bits */
1111 di->u.Link.state &= ~(Item->stateMask & LIS_MASK);
1113 di->u.Link.state |= (Item->state & Item->stateMask) & LIS_MASK;
1114 Repaint = (oldstate != di->u.Link.state);
1116 /* update the focus */
1117 SYSLINK_SetFocusLink(infoPtr, ((di->u.Link.state & LIS_FOCUSED) ? di : NULL));
1122 SYSLINK_RepaintLink(infoPtr, di);
1128 /***********************************************************************
1130 * Retrieves the states and attributes of a link item.
1132 static LRESULT SYSLINK_GetItem (SYSLINK_INFO *infoPtr, PLITEM Item)
1136 if(!(Item->mask & LIF_ITEMINDEX) || !(Item->mask & (LIF_FLAGSMASK)))
1138 ERR("Invalid Flags!\n");
1142 di = SYSLINK_GetLinkItemByIndex(infoPtr, Item->iLink);
1145 ERR("Link %d couldn't be found\n", Item->iLink);
1149 if(Item->mask & LIF_STATE)
1151 Item->state = (di->u.Link.state & Item->stateMask);
1152 if(!infoPtr->HasFocus)
1154 /* remove the LIS_FOCUSED bit if the control doesn't have focus */
1155 Item->state &= ~LIS_FOCUSED;
1159 if(Item->mask & LIF_ITEMID)
1163 lstrcpyW(Item->szID, di->u.Link.szID);
1171 if(Item->mask & LIF_URL)
1173 if(di->u.Link.szUrl)
1175 lstrcpyW(Item->szUrl, di->u.Link.szUrl);
1186 /***********************************************************************
1187 * SYSLINK_PtInDocItem
1188 * Determines if a point is in the region of a document item
1190 static BOOL SYSLINK_PtInDocItem (PDOC_ITEM DocItem, POINT pt)
1195 bl = DocItem->Blocks;
1202 if (PtInRect(&bl->rc, pt))
1206 n -= bl->nChars + bl->nSkip;
1214 /***********************************************************************
1216 * Determines the link the user clicked on.
1218 static LRESULT SYSLINK_HitTest (SYSLINK_INFO *infoPtr, PLHITTESTINFO HitTest)
1223 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
1225 if(Current->Type == slLink)
1227 if(SYSLINK_PtInDocItem(Current, HitTest->pt))
1229 HitTest->item.mask = 0;
1230 HitTest->item.iLink = id;
1231 HitTest->item.state = 0;
1232 HitTest->item.stateMask = 0;
1233 if(Current->u.Link.szID)
1235 lstrcpyW(HitTest->item.szID, Current->u.Link.szID);
1239 HitTest->item.szID[0] = 0;
1241 if(Current->u.Link.szUrl)
1243 lstrcpyW(HitTest->item.szUrl, Current->u.Link.szUrl);
1247 HitTest->item.szUrl[0] = 0;
1258 /***********************************************************************
1259 * SYSLINK_GetIdealHeight
1260 * Returns the preferred height of a link at the current control's width.
1262 static LRESULT SYSLINK_GetIdealHeight (SYSLINK_INFO *infoPtr)
1264 HDC hdc = GetDC(infoPtr->Self);
1269 HGDIOBJ hOldFont = SelectObject(hdc, infoPtr->Font);
1271 if(GetTextMetricsW(hdc, &tm))
1273 height = tm.tmHeight;
1279 SelectObject(hdc, hOldFont);
1280 ReleaseDC(infoPtr->Self, hdc);
1287 /***********************************************************************
1288 * SYSLINK_SendParentNotify
1289 * Sends a WM_NOTIFY message to the parent window.
1291 static LRESULT SYSLINK_SendParentNotify (SYSLINK_INFO *infoPtr, UINT code, PDOC_ITEM Link, int iLink)
1295 nml.hdr.hwndFrom = infoPtr->Self;
1296 nml.hdr.idFrom = GetWindowLongPtrW(infoPtr->Self, GWLP_ID);
1297 nml.hdr.code = code;
1300 nml.item.iLink = iLink;
1302 nml.item.stateMask = 0;
1303 if(Link->u.Link.szID)
1305 lstrcpyW(nml.item.szID, Link->u.Link.szID);
1309 nml.item.szID[0] = 0;
1311 if(Link->u.Link.szUrl)
1313 lstrcpyW(nml.item.szUrl, Link->u.Link.szUrl);
1317 nml.item.szUrl[0] = 0;
1320 return SendMessageW(infoPtr->Notify, WM_NOTIFY, (WPARAM)nml.hdr.idFrom, (LPARAM)&nml);
1323 /***********************************************************************
1325 * Handles receiving the input focus.
1327 static LRESULT SYSLINK_SetFocus (SYSLINK_INFO *infoPtr, HWND PrevFocusWindow)
1331 infoPtr->HasFocus = TRUE;
1333 /* We always select the first link, even if we activated the control using
1334 SHIFT+TAB. This is the default behavior */
1335 Focus = SYSLINK_GetNextLink(infoPtr, NULL);
1338 SYSLINK_SetFocusLink(infoPtr, Focus);
1341 SYSLINK_RepaintLink(infoPtr, Focus);
1346 /***********************************************************************
1348 * Handles losing the input focus.
1350 static LRESULT SYSLINK_KillFocus (SYSLINK_INFO *infoPtr, HWND NewFocusWindow)
1354 infoPtr->HasFocus = FALSE;
1355 Focus = SYSLINK_GetFocusLink(infoPtr, NULL);
1359 SYSLINK_RepaintLink(infoPtr, Focus);
1365 /***********************************************************************
1367 * Returns a link at the specified position
1369 static PDOC_ITEM SYSLINK_LinkAtPt (SYSLINK_INFO *infoPtr, POINT *pt, int *LinkId, BOOL MustBeEnabled)
1374 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
1376 if((Current->Type == slLink) && SYSLINK_PtInDocItem(Current, *pt) &&
1377 (!MustBeEnabled || (MustBeEnabled && (Current->u.Link.state & LIS_ENABLED))))
1391 /***********************************************************************
1392 * SYSLINK_LButtonDown
1393 * Handles mouse clicks
1395 static LRESULT SYSLINK_LButtonDown (SYSLINK_INFO *infoPtr, DWORD Buttons, POINT *pt)
1397 PDOC_ITEM Current, Old;
1400 Current = SYSLINK_LinkAtPt(infoPtr, pt, &id, TRUE);
1403 SetFocus(infoPtr->Self);
1405 Old = SYSLINK_SetFocusLink(infoPtr, Current);
1406 if(Old != NULL && Old != Current)
1408 SYSLINK_RepaintLink(infoPtr, Old);
1410 infoPtr->MouseDownID = id;
1411 SYSLINK_RepaintLink(infoPtr, Current);
1417 /***********************************************************************
1419 * Handles mouse clicks
1421 static LRESULT SYSLINK_LButtonUp (SYSLINK_INFO *infoPtr, DWORD Buttons, POINT *pt)
1423 if(infoPtr->MouseDownID > -1)
1428 Current = SYSLINK_LinkAtPt(infoPtr, pt, &id, TRUE);
1429 if((Current != NULL) && (Current->u.Link.state & LIS_FOCUSED) && (infoPtr->MouseDownID == id))
1431 SYSLINK_SendParentNotify(infoPtr, NM_CLICK, Current, id);
1435 infoPtr->MouseDownID = -1;
1440 /***********************************************************************
1442 * Handles ENTER key events
1444 static BOOL SYSLINK_OnEnter (SYSLINK_INFO *infoPtr)
1446 if(infoPtr->HasFocus)
1451 Focus = SYSLINK_GetFocusLink(infoPtr, &id);
1454 SYSLINK_SendParentNotify(infoPtr, NM_RETURN, Focus, id);
1461 /***********************************************************************
1462 * SYSKEY_SelectNextPrevLink
1463 * Changes the currently focused link
1465 static BOOL SYSKEY_SelectNextPrevLink (SYSLINK_INFO *infoPtr, BOOL Prev)
1467 if(infoPtr->HasFocus)
1472 Focus = SYSLINK_GetFocusLink(infoPtr, &id);
1475 PDOC_ITEM NewFocus, OldFocus;
1478 NewFocus = SYSLINK_GetPrevLink(infoPtr, Focus);
1480 NewFocus = SYSLINK_GetNextLink(infoPtr, Focus);
1482 if(NewFocus != NULL)
1484 OldFocus = SYSLINK_SetFocusLink(infoPtr, NewFocus);
1486 if(OldFocus != NewFocus)
1488 SYSLINK_RepaintLink(infoPtr, OldFocus);
1490 SYSLINK_RepaintLink(infoPtr, NewFocus);
1498 /***********************************************************************
1499 * SYSKEY_SelectNextPrevLink
1500 * Determines if there's a next or previous link to decide whether the control
1501 * should capture the tab key message
1503 static BOOL SYSLINK_NoNextLink (SYSLINK_INFO *infoPtr, BOOL Prev)
1505 PDOC_ITEM Focus, NewFocus;
1507 Focus = SYSLINK_GetFocusLink(infoPtr, NULL);
1509 NewFocus = SYSLINK_GetPrevLink(infoPtr, Focus);
1511 NewFocus = SYSLINK_GetNextLink(infoPtr, Focus);
1513 return NewFocus == NULL;
1516 /***********************************************************************
1517 * SYSLINK_GetIdealSize
1518 * Calculates the ideal size of a link control at a given maximum width.
1520 static VOID SYSLINK_GetIdealSize (SYSLINK_INFO *infoPtr, int cxMaxWidth, LPSIZE lpSize)
1525 rc.left = rc.top = rc.bottom = 0;
1526 rc.right = cxMaxWidth;
1528 hdc = GetDC(infoPtr->Self);
1531 HGDIOBJ hOldFont = SelectObject(hdc, infoPtr->Font);
1533 SYSLINK_Render(infoPtr, hdc, &rc);
1535 SelectObject(hdc, hOldFont);
1536 ReleaseDC(infoPtr->Self, hdc);
1538 lpSize->cx = rc.right;
1539 lpSize->cy = rc.bottom;
1543 /***********************************************************************
1546 static LRESULT WINAPI SysLinkWindowProc(HWND hwnd, UINT message,
1547 WPARAM wParam, LPARAM lParam)
1549 SYSLINK_INFO *infoPtr;
1551 TRACE("hwnd=%p msg=%04x wparam=%x lParam=%lx\n", hwnd, message, wParam, lParam);
1553 infoPtr = (SYSLINK_INFO *)GetWindowLongPtrW(hwnd, 0);
1555 if (!infoPtr && message != WM_CREATE)
1556 goto HandleDefaultMessage;
1559 case WM_PRINTCLIENT:
1561 return SYSLINK_Paint (infoPtr, (HDC)wParam);
1566 DWORD mp = GetMessagePos();
1568 ht.pt.x = (short)LOWORD(mp);
1569 ht.pt.y = (short)HIWORD(mp);
1571 ScreenToClient(infoPtr->Self, &ht.pt);
1572 if(SYSLINK_HitTest (infoPtr, &ht))
1574 SetCursor(LoadCursorW(0, (LPCWSTR)IDC_HAND));
1577 /* let the default window proc handle this message */
1578 goto HandleDefaultMessage;
1584 if (GetClientRect(infoPtr->Self, &rcClient))
1586 HDC hdc = GetDC(infoPtr->Self);
1589 SYSLINK_Render(infoPtr, hdc, &rcClient);
1590 ReleaseDC(infoPtr->Self, hdc);
1597 return (LRESULT)infoPtr->Font;
1600 return (LRESULT)SYSLINK_SetFont(infoPtr, (HFONT)wParam, (BOOL)lParam);
1603 SYSLINK_SetText(infoPtr, (LPWSTR)lParam);
1604 goto HandleDefaultMessage;
1606 case WM_LBUTTONDOWN:
1609 pt.x = (short)LOWORD(lParam);
1610 pt.y = (short)HIWORD(lParam);
1611 return SYSLINK_LButtonDown(infoPtr, wParam, &pt);
1616 pt.x = (short)LOWORD(lParam);
1617 pt.y = (short)HIWORD(lParam);
1618 return SYSLINK_LButtonUp(infoPtr, wParam, &pt);
1626 SYSLINK_OnEnter(infoPtr);
1630 BOOL shift = GetKeyState(VK_SHIFT) & 0x8000;
1631 SYSKEY_SelectNextPrevLink(infoPtr, shift);
1635 goto HandleDefaultMessage;
1640 LRESULT Ret = DLGC_HASSETSEL;
1641 int vk = (lParam != 0 ? (int)((LPMSG)lParam)->wParam : 0);
1645 Ret |= DLGC_WANTMESSAGE;
1649 BOOL shift = GetKeyState(VK_SHIFT) & 0x8000;
1650 if(!SYSLINK_NoNextLink(infoPtr, shift))
1652 Ret |= DLGC_WANTTAB;
1656 Ret |= DLGC_WANTCHARS;
1668 pt.x = (short)LOWORD(lParam);
1669 pt.y = (short)HIWORD(lParam);
1671 GetClientRect(infoPtr->Self, &rc);
1672 ScreenToClient(infoPtr->Self, &pt);
1673 if(pt.x < 0 || pt.y < 0 || pt.x > rc.right || pt.y > rc.bottom)
1678 if(SYSLINK_LinkAtPt(infoPtr, &pt, NULL, FALSE))
1683 return HTTRANSPARENT;
1687 return SYSLINK_HitTest(infoPtr, (PLHITTESTINFO)lParam);
1690 return SYSLINK_SetItem(infoPtr, (PLITEM)lParam);
1693 return SYSLINK_GetItem(infoPtr, (PLITEM)lParam);
1695 case LM_GETIDEALHEIGHT:
1698 /* LM_GETIDEALSIZE */
1699 SYSLINK_GetIdealSize(infoPtr, (int)wParam, (LPSIZE)lParam);
1701 return SYSLINK_GetIdealHeight(infoPtr);
1704 return SYSLINK_SetFocus(infoPtr, (HWND)wParam);
1707 return SYSLINK_KillFocus(infoPtr, (HWND)wParam);
1710 infoPtr->Style &= ~WS_DISABLED;
1711 infoPtr->Style |= (wParam ? 0 : WS_DISABLED);
1712 InvalidateRect (infoPtr->Self, NULL, FALSE);
1715 case WM_STYLECHANGED:
1716 if (wParam == GWL_STYLE)
1718 infoPtr->Style = ((LPSTYLESTRUCT)lParam)->styleNew;
1720 InvalidateRect(infoPtr->Self, NULL, TRUE);
1725 /* allocate memory for info struct */
1726 infoPtr = Alloc (sizeof(SYSLINK_INFO));
1727 if (!infoPtr) return -1;
1728 SetWindowLongPtrW (hwnd, 0, (DWORD_PTR)infoPtr);
1730 /* initialize the info struct */
1731 infoPtr->Self = hwnd;
1732 infoPtr->Notify = ((LPCREATESTRUCTW)lParam)->hwndParent;
1733 infoPtr->Style = ((LPCREATESTRUCTW)lParam)->style;
1735 infoPtr->LinkFont = 0;
1736 infoPtr->Items = NULL;
1737 infoPtr->HasFocus = FALSE;
1738 infoPtr->MouseDownID = -1;
1739 infoPtr->TextColor = GetSysColor(COLOR_WINDOWTEXT);
1740 infoPtr->LinkColor = GetSysColor(COLOR_HIGHLIGHT);
1741 infoPtr->VisitedColor = GetSysColor(COLOR_HIGHLIGHT);
1742 infoPtr->BreakChar = ' ';
1743 TRACE("SysLink Ctrl creation, hwnd=%p\n", hwnd);
1744 SYSLINK_SetText(infoPtr, ((LPCREATESTRUCTW)lParam)->lpszName);
1748 TRACE("SysLink Ctrl destruction, hwnd=%p\n", hwnd);
1749 SYSLINK_ClearDoc(infoPtr);
1750 if(infoPtr->Font != 0) DeleteObject(infoPtr->Font);
1751 if(infoPtr->LinkFont != 0) DeleteObject(infoPtr->LinkFont);
1752 SetWindowLongPtrW(hwnd, 0, 0);
1757 HandleDefaultMessage:
1758 if ((message >= WM_USER) && (message < WM_APP))
1760 ERR("unknown msg %04x wp=%04x lp=%08lx\n", message, wParam, lParam );
1762 return DefWindowProcW(hwnd, message, wParam, lParam);
1767 /***********************************************************************
1768 * SYSLINK_Register [Internal]
1770 * Registers the SysLink window class.
1772 VOID SYSLINK_Register (void)
1776 ZeroMemory (&wndClass, sizeof(wndClass));
1777 wndClass.style = CS_GLOBALCLASS | CS_VREDRAW | CS_HREDRAW;
1778 wndClass.lpfnWndProc = SysLinkWindowProc;
1779 wndClass.cbClsExtra = 0;
1780 wndClass.cbWndExtra = sizeof (SYSLINK_INFO *);
1781 wndClass.hCursor = LoadCursorW (0, (LPWSTR)IDC_ARROW);
1782 wndClass.lpszClassName = WC_LINK;
1784 RegisterClassW (&wndClass);
1788 /***********************************************************************
1789 * SYSLINK_Unregister [Internal]
1791 * Unregisters the SysLink window class.
1793 VOID SYSLINK_Unregister (void)
1795 UnregisterClassW (WC_LINK, NULL);