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 (const SYSLINK_INFO *infoPtr, const DOC_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 (const 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 (const 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 (const 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 (const 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 (const 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 Free(Current->Blocks);
688 Current->Blocks = NULL;
692 if(Current->Type == slText)
694 SelectObject(hdc, infoPtr->Font);
696 else if(Current->Type == slLink)
698 SelectObject(hdc, infoPtr->LinkFont);
705 /* skip break characters unless they're the first of the doc item */
706 if(tx != Current->Text || x == SL_LEFTMARGIN)
708 while(n > 0 && (*tx) == infoPtr->BreakChar)
716 if((n == 0 && SkipChars != 0) ||
717 GetTextExtentExPointW(hdc, tx, n, rc.right - x, &nFit, NULL, &szDim))
725 Wrap = SYSLINK_WrapLine(hdc, tx, infoPtr->BreakChar, &LineLen, nFit, &szDim, rc.right - x);
729 if(x > SL_LEFTMARGIN)
731 /* move one line down, the word didn't fit into the line */
739 /* the word starts at the beginning of the line and doesn't
740 fit into the line, so break it at the last character that fits */
741 LineLen = max(nFit, 1);
747 if(!GetTextExtentExPointW(hdc, tx, LineLen, rc.right - x, NULL, NULL, &szDim))
760 nbl = ReAlloc(bl, (nBlocks + 1) * sizeof(DOC_TEXTBLOCK));
766 cbl = bl + nBlocks - 1;
768 cbl->nChars = LineLen;
769 cbl->nSkip = SkipChars;
772 cbl->rc.right = x + szDim.cx;
773 cbl->rc.bottom = y + szDim.cy;
775 if (cbl->rc.right > szDoc.cx)
776 szDoc.cx = cbl->rc.right;
777 if (cbl->rc.bottom > szDoc.cy)
778 szDoc.cy = cbl->rc.bottom;
783 LineHeight = max(LineHeight, szDim.cy);
799 ERR("Failed to alloc DOC_TEXTBLOCK structure!\n");
813 Current->Blocks = bl;
817 SelectObject(hdc, hOldFont);
819 pRect->right = pRect->left + szDoc.cx;
820 pRect->bottom = pRect->top + szDoc.cy;
823 /***********************************************************************
825 * Draws the SysLink control.
827 static LRESULT SYSLINK_Draw (const SYSLINK_INFO *infoPtr, HDC hdc)
832 COLORREF OldTextColor, OldBkColor;
834 hOldFont = SelectObject(hdc, infoPtr->Font);
835 OldTextColor = SetTextColor(hdc, infoPtr->TextColor);
836 OldBkColor = SetBkColor(hdc, GetSysColor(COLOR_BTNFACE));
838 GetClientRect(infoPtr->Self, &rc);
839 rc.right -= SL_RIGHTMARGIN + SL_LEFTMARGIN;
840 rc.bottom -= SL_BOTTOMMARGIN + SL_TOPMARGIN;
842 if(rc.right < 0 || rc.bottom < 0) return 0;
844 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
850 bl = Current->Blocks;
856 if(Current->Type == slText)
858 SelectObject(hdc, infoPtr->Font);
859 SetTextColor(hdc, infoPtr->TextColor);
863 SelectObject(hdc, infoPtr->LinkFont);
864 SetTextColor(hdc, (!(Current->u.Link.state & LIS_VISITED) ? infoPtr->LinkColor : infoPtr->VisitedColor));
870 ExtTextOutW(hdc, bl->rc.left, bl->rc.top, ETO_OPAQUE | ETO_CLIPPED, &bl->rc, tx, bl->nChars, NULL);
871 if((Current->Type == slLink) && (Current->u.Link.state & LIS_FOCUSED) && infoPtr->HasFocus)
873 COLORREF PrevTextColor;
874 PrevTextColor = SetTextColor(hdc, infoPtr->TextColor);
875 DrawFocusRect(hdc, &bl->rc);
876 SetTextColor(hdc, PrevTextColor);
879 n -= bl->nChars + bl->nSkip;
885 SetBkColor(hdc, OldBkColor);
886 SetTextColor(hdc, OldTextColor);
887 SelectObject(hdc, hOldFont);
893 /***********************************************************************
895 * Handles the WM_PAINT message.
897 static LRESULT SYSLINK_Paint (const SYSLINK_INFO *infoPtr, HDC hdcParam)
902 hdc = hdcParam ? hdcParam : BeginPaint (infoPtr->Self, &ps);
905 SYSLINK_Draw (infoPtr, hdc);
906 if (!hdcParam) EndPaint (infoPtr->Self, &ps);
912 /***********************************************************************
914 * Set new Font for the SysLink control.
916 static HFONT SYSLINK_SetFont (SYSLINK_INFO *infoPtr, HFONT hFont, BOOL bRedraw)
922 HFONT hOldFont = infoPtr->Font;
923 infoPtr->Font = hFont;
925 /* free the underline font */
926 if(infoPtr->LinkFont != NULL)
928 DeleteObject(infoPtr->LinkFont);
929 infoPtr->LinkFont = NULL;
932 /* Render text position and word wrapping in memory */
933 if (GetClientRect(infoPtr->Self, &rcClient))
935 hdc = GetDC(infoPtr->Self);
938 /* create a new underline font */
939 if(GetTextMetricsW(hdc, &tm) &&
940 GetObjectW(infoPtr->Font, sizeof(LOGFONTW), &lf))
942 lf.lfUnderline = TRUE;
943 infoPtr->LinkFont = CreateFontIndirectW(&lf);
944 infoPtr->BreakChar = tm.tmBreakChar;
948 ERR("Failed to create link font!\n");
951 SYSLINK_Render(infoPtr, hdc, &rcClient);
952 ReleaseDC(infoPtr->Self, hdc);
958 RedrawWindow(infoPtr->Self, NULL, NULL, RDW_INVALIDATE | RDW_UPDATENOW);
964 /***********************************************************************
966 * Set new text for the SysLink control.
968 static LRESULT SYSLINK_SetText (SYSLINK_INFO *infoPtr, LPCWSTR Text)
972 /* clear the document */
973 SYSLINK_ClearDoc(infoPtr);
975 if(Text == NULL || (textlen = lstrlenW(Text)) == 0)
980 /* let's parse the string and create a document */
981 if(SYSLINK_ParseText(infoPtr, Text) > 0)
985 /* Render text position and word wrapping in memory */
986 if (GetClientRect(infoPtr->Self, &rcClient))
988 HDC hdc = GetDC(infoPtr->Self);
991 SYSLINK_Render(infoPtr, hdc, &rcClient);
992 ReleaseDC(infoPtr->Self, hdc);
994 InvalidateRect(infoPtr->Self, NULL, TRUE);
1002 /***********************************************************************
1003 * SYSLINK_SetFocusLink
1004 * Updates the focus status bits and focusses the specified link.
1005 * If no document item is specified, the focus bit will be removed from all links.
1006 * Returns the previous focused item.
1008 static PDOC_ITEM SYSLINK_SetFocusLink (const SYSLINK_INFO *infoPtr, const DOC_ITEM *DocItem)
1010 PDOC_ITEM Current, PrevFocus = NULL;
1012 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
1014 if(Current->Type == slLink)
1016 if((PrevFocus == NULL) && (Current->u.Link.state & LIS_FOCUSED))
1018 PrevFocus = Current;
1021 if(Current == DocItem)
1023 Current->u.Link.state |= LIS_FOCUSED;
1027 Current->u.Link.state &= ~LIS_FOCUSED;
1035 /***********************************************************************
1037 * Sets the states and attributes of a link item.
1039 static LRESULT SYSLINK_SetItem (const SYSLINK_INFO *infoPtr, const LITEM *Item)
1045 BOOL Repaint = FALSE;
1047 if(!(Item->mask & LIF_ITEMINDEX) || !(Item->mask & (LIF_FLAGSMASK)))
1049 ERR("Invalid Flags!\n");
1053 di = SYSLINK_GetLinkItemByIndex(infoPtr, Item->iLink);
1056 ERR("Link %d couldn't be found\n", Item->iLink);
1060 if(Item->mask & LIF_ITEMID)
1062 nc = min(lstrlenW(Item->szID), MAX_LINKID_TEXT - 1);
1063 szId = Alloc((nc + 1) * sizeof(WCHAR));
1066 lstrcpynW(szId, Item->szID, nc + 1);
1070 ERR("Unable to allocate memory for link id\n");
1075 if(Item->mask & LIF_URL)
1077 nc = min(lstrlenW(Item->szUrl), L_MAX_URL_LENGTH - 1);
1078 szUrl = Alloc((nc + 1) * sizeof(WCHAR));
1081 lstrcpynW(szUrl, Item->szUrl, nc + 1);
1087 ERR("Unable to allocate memory for link url\n");
1092 if(Item->mask & LIF_ITEMID)
1094 Free(di->u.Link.szID);
1095 di->u.Link.szID = szId;
1098 if(Item->mask & LIF_URL)
1100 Free(di->u.Link.szUrl);
1101 di->u.Link.szUrl = szUrl;
1104 if(Item->mask & LIF_STATE)
1106 UINT oldstate = di->u.Link.state;
1107 /* clear the masked bits */
1108 di->u.Link.state &= ~(Item->stateMask & LIS_MASK);
1110 di->u.Link.state |= (Item->state & Item->stateMask) & LIS_MASK;
1111 Repaint = (oldstate != di->u.Link.state);
1113 /* update the focus */
1114 SYSLINK_SetFocusLink(infoPtr, ((di->u.Link.state & LIS_FOCUSED) ? di : NULL));
1119 SYSLINK_RepaintLink(infoPtr, di);
1125 /***********************************************************************
1127 * Retrieves the states and attributes of a link item.
1129 static LRESULT SYSLINK_GetItem (const SYSLINK_INFO *infoPtr, PLITEM Item)
1133 if(!(Item->mask & LIF_ITEMINDEX) || !(Item->mask & (LIF_FLAGSMASK)))
1135 ERR("Invalid Flags!\n");
1139 di = SYSLINK_GetLinkItemByIndex(infoPtr, Item->iLink);
1142 ERR("Link %d couldn't be found\n", Item->iLink);
1146 if(Item->mask & LIF_STATE)
1148 Item->state = (di->u.Link.state & Item->stateMask);
1149 if(!infoPtr->HasFocus)
1151 /* remove the LIS_FOCUSED bit if the control doesn't have focus */
1152 Item->state &= ~LIS_FOCUSED;
1156 if(Item->mask & LIF_ITEMID)
1160 lstrcpyW(Item->szID, di->u.Link.szID);
1168 if(Item->mask & LIF_URL)
1170 if(di->u.Link.szUrl)
1172 lstrcpyW(Item->szUrl, di->u.Link.szUrl);
1183 /***********************************************************************
1184 * SYSLINK_PtInDocItem
1185 * Determines if a point is in the region of a document item
1187 static BOOL SYSLINK_PtInDocItem (const DOC_ITEM *DocItem, POINT pt)
1192 bl = DocItem->Blocks;
1199 if (PtInRect(&bl->rc, pt))
1203 n -= bl->nChars + bl->nSkip;
1211 /***********************************************************************
1213 * Determines the link the user clicked on.
1215 static LRESULT SYSLINK_HitTest (const SYSLINK_INFO *infoPtr, PLHITTESTINFO HitTest)
1220 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
1222 if(Current->Type == slLink)
1224 if(SYSLINK_PtInDocItem(Current, HitTest->pt))
1226 HitTest->item.mask = 0;
1227 HitTest->item.iLink = id;
1228 HitTest->item.state = 0;
1229 HitTest->item.stateMask = 0;
1230 if(Current->u.Link.szID)
1232 lstrcpyW(HitTest->item.szID, Current->u.Link.szID);
1236 HitTest->item.szID[0] = 0;
1238 if(Current->u.Link.szUrl)
1240 lstrcpyW(HitTest->item.szUrl, Current->u.Link.szUrl);
1244 HitTest->item.szUrl[0] = 0;
1255 /***********************************************************************
1256 * SYSLINK_GetIdealHeight
1257 * Returns the preferred height of a link at the current control's width.
1259 static LRESULT SYSLINK_GetIdealHeight (const SYSLINK_INFO *infoPtr)
1261 HDC hdc = GetDC(infoPtr->Self);
1266 HGDIOBJ hOldFont = SelectObject(hdc, infoPtr->Font);
1268 if(GetTextMetricsW(hdc, &tm))
1270 height = tm.tmHeight;
1276 SelectObject(hdc, hOldFont);
1277 ReleaseDC(infoPtr->Self, hdc);
1284 /***********************************************************************
1285 * SYSLINK_SendParentNotify
1286 * Sends a WM_NOTIFY message to the parent window.
1288 static LRESULT SYSLINK_SendParentNotify (const SYSLINK_INFO *infoPtr, UINT code, const DOC_ITEM *Link, int iLink)
1292 nml.hdr.hwndFrom = infoPtr->Self;
1293 nml.hdr.idFrom = GetWindowLongPtrW(infoPtr->Self, GWLP_ID);
1294 nml.hdr.code = code;
1297 nml.item.iLink = iLink;
1299 nml.item.stateMask = 0;
1300 if(Link->u.Link.szID)
1302 lstrcpyW(nml.item.szID, Link->u.Link.szID);
1306 nml.item.szID[0] = 0;
1308 if(Link->u.Link.szUrl)
1310 lstrcpyW(nml.item.szUrl, Link->u.Link.szUrl);
1314 nml.item.szUrl[0] = 0;
1317 return SendMessageW(infoPtr->Notify, WM_NOTIFY, (WPARAM)nml.hdr.idFrom, (LPARAM)&nml);
1320 /***********************************************************************
1322 * Handles receiving the input focus.
1324 static LRESULT SYSLINK_SetFocus (SYSLINK_INFO *infoPtr, HWND PrevFocusWindow)
1328 infoPtr->HasFocus = TRUE;
1330 /* We always select the first link, even if we activated the control using
1331 SHIFT+TAB. This is the default behavior */
1332 Focus = SYSLINK_GetNextLink(infoPtr, NULL);
1335 SYSLINK_SetFocusLink(infoPtr, Focus);
1338 SYSLINK_RepaintLink(infoPtr, Focus);
1343 /***********************************************************************
1345 * Handles losing the input focus.
1347 static LRESULT SYSLINK_KillFocus (SYSLINK_INFO *infoPtr, HWND NewFocusWindow)
1351 infoPtr->HasFocus = FALSE;
1352 Focus = SYSLINK_GetFocusLink(infoPtr, NULL);
1356 SYSLINK_RepaintLink(infoPtr, Focus);
1362 /***********************************************************************
1364 * Returns a link at the specified position
1366 static PDOC_ITEM SYSLINK_LinkAtPt (const SYSLINK_INFO *infoPtr, const POINT *pt, int *LinkId, BOOL MustBeEnabled)
1371 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
1373 if((Current->Type == slLink) && SYSLINK_PtInDocItem(Current, *pt) &&
1374 (!MustBeEnabled || (MustBeEnabled && (Current->u.Link.state & LIS_ENABLED))))
1388 /***********************************************************************
1389 * SYSLINK_LButtonDown
1390 * Handles mouse clicks
1392 static LRESULT SYSLINK_LButtonDown (SYSLINK_INFO *infoPtr, DWORD Buttons, const POINT *pt)
1394 PDOC_ITEM Current, Old;
1397 Current = SYSLINK_LinkAtPt(infoPtr, pt, &id, TRUE);
1400 SetFocus(infoPtr->Self);
1402 Old = SYSLINK_SetFocusLink(infoPtr, Current);
1403 if(Old != NULL && Old != Current)
1405 SYSLINK_RepaintLink(infoPtr, Old);
1407 infoPtr->MouseDownID = id;
1408 SYSLINK_RepaintLink(infoPtr, Current);
1414 /***********************************************************************
1416 * Handles mouse clicks
1418 static LRESULT SYSLINK_LButtonUp (SYSLINK_INFO *infoPtr, DWORD Buttons, const POINT *pt)
1420 if(infoPtr->MouseDownID > -1)
1425 Current = SYSLINK_LinkAtPt(infoPtr, pt, &id, TRUE);
1426 if((Current != NULL) && (Current->u.Link.state & LIS_FOCUSED) && (infoPtr->MouseDownID == id))
1428 SYSLINK_SendParentNotify(infoPtr, NM_CLICK, Current, id);
1432 infoPtr->MouseDownID = -1;
1437 /***********************************************************************
1439 * Handles ENTER key events
1441 static BOOL SYSLINK_OnEnter (const SYSLINK_INFO *infoPtr)
1443 if(infoPtr->HasFocus)
1448 Focus = SYSLINK_GetFocusLink(infoPtr, &id);
1451 SYSLINK_SendParentNotify(infoPtr, NM_RETURN, Focus, id);
1458 /***********************************************************************
1459 * SYSKEY_SelectNextPrevLink
1460 * Changes the currently focused link
1462 static BOOL SYSKEY_SelectNextPrevLink (const SYSLINK_INFO *infoPtr, BOOL Prev)
1464 if(infoPtr->HasFocus)
1469 Focus = SYSLINK_GetFocusLink(infoPtr, &id);
1472 PDOC_ITEM NewFocus, OldFocus;
1475 NewFocus = SYSLINK_GetPrevLink(infoPtr, Focus);
1477 NewFocus = SYSLINK_GetNextLink(infoPtr, Focus);
1479 if(NewFocus != NULL)
1481 OldFocus = SYSLINK_SetFocusLink(infoPtr, NewFocus);
1483 if(OldFocus != NewFocus)
1485 SYSLINK_RepaintLink(infoPtr, OldFocus);
1487 SYSLINK_RepaintLink(infoPtr, NewFocus);
1495 /***********************************************************************
1496 * SYSKEY_SelectNextPrevLink
1497 * Determines if there's a next or previous link to decide whether the control
1498 * should capture the tab key message
1500 static BOOL SYSLINK_NoNextLink (const SYSLINK_INFO *infoPtr, BOOL Prev)
1502 PDOC_ITEM Focus, NewFocus;
1504 Focus = SYSLINK_GetFocusLink(infoPtr, NULL);
1506 NewFocus = SYSLINK_GetPrevLink(infoPtr, Focus);
1508 NewFocus = SYSLINK_GetNextLink(infoPtr, Focus);
1510 return NewFocus == NULL;
1513 /***********************************************************************
1514 * SYSLINK_GetIdealSize
1515 * Calculates the ideal size of a link control at a given maximum width.
1517 static VOID SYSLINK_GetIdealSize (const SYSLINK_INFO *infoPtr, int cxMaxWidth, LPSIZE lpSize)
1522 rc.left = rc.top = rc.bottom = 0;
1523 rc.right = cxMaxWidth;
1525 hdc = GetDC(infoPtr->Self);
1528 HGDIOBJ hOldFont = SelectObject(hdc, infoPtr->Font);
1530 SYSLINK_Render(infoPtr, hdc, &rc);
1532 SelectObject(hdc, hOldFont);
1533 ReleaseDC(infoPtr->Self, hdc);
1535 lpSize->cx = rc.right;
1536 lpSize->cy = rc.bottom;
1540 /***********************************************************************
1543 static LRESULT WINAPI SysLinkWindowProc(HWND hwnd, UINT message,
1544 WPARAM wParam, LPARAM lParam)
1546 SYSLINK_INFO *infoPtr;
1548 TRACE("hwnd=%p msg=%04x wparam=%lx lParam=%lx\n", hwnd, message, wParam, lParam);
1550 infoPtr = (SYSLINK_INFO *)GetWindowLongPtrW(hwnd, 0);
1552 if (!infoPtr && message != WM_CREATE)
1553 goto HandleDefaultMessage;
1556 case WM_PRINTCLIENT:
1558 return SYSLINK_Paint (infoPtr, (HDC)wParam);
1563 DWORD mp = GetMessagePos();
1565 ht.pt.x = (short)LOWORD(mp);
1566 ht.pt.y = (short)HIWORD(mp);
1568 ScreenToClient(infoPtr->Self, &ht.pt);
1569 if(SYSLINK_HitTest (infoPtr, &ht))
1571 SetCursor(LoadCursorW(0, (LPCWSTR)IDC_HAND));
1574 /* let the default window proc handle this message */
1575 goto HandleDefaultMessage;
1581 if (GetClientRect(infoPtr->Self, &rcClient))
1583 HDC hdc = GetDC(infoPtr->Self);
1586 SYSLINK_Render(infoPtr, hdc, &rcClient);
1587 ReleaseDC(infoPtr->Self, hdc);
1594 return (LRESULT)infoPtr->Font;
1597 return (LRESULT)SYSLINK_SetFont(infoPtr, (HFONT)wParam, (BOOL)lParam);
1600 SYSLINK_SetText(infoPtr, (LPWSTR)lParam);
1601 goto HandleDefaultMessage;
1603 case WM_LBUTTONDOWN:
1606 pt.x = (short)LOWORD(lParam);
1607 pt.y = (short)HIWORD(lParam);
1608 return SYSLINK_LButtonDown(infoPtr, wParam, &pt);
1613 pt.x = (short)LOWORD(lParam);
1614 pt.y = (short)HIWORD(lParam);
1615 return SYSLINK_LButtonUp(infoPtr, wParam, &pt);
1623 SYSLINK_OnEnter(infoPtr);
1627 BOOL shift = GetKeyState(VK_SHIFT) & 0x8000;
1628 SYSKEY_SelectNextPrevLink(infoPtr, shift);
1632 goto HandleDefaultMessage;
1637 LRESULT Ret = DLGC_HASSETSEL;
1638 int vk = (lParam != 0 ? (int)((LPMSG)lParam)->wParam : 0);
1642 Ret |= DLGC_WANTMESSAGE;
1646 BOOL shift = GetKeyState(VK_SHIFT) & 0x8000;
1647 if(!SYSLINK_NoNextLink(infoPtr, shift))
1649 Ret |= DLGC_WANTTAB;
1653 Ret |= DLGC_WANTCHARS;
1665 pt.x = (short)LOWORD(lParam);
1666 pt.y = (short)HIWORD(lParam);
1668 GetClientRect(infoPtr->Self, &rc);
1669 ScreenToClient(infoPtr->Self, &pt);
1670 if(pt.x < 0 || pt.y < 0 || pt.x > rc.right || pt.y > rc.bottom)
1675 if(SYSLINK_LinkAtPt(infoPtr, &pt, NULL, FALSE))
1680 return HTTRANSPARENT;
1684 return SYSLINK_HitTest(infoPtr, (PLHITTESTINFO)lParam);
1687 return SYSLINK_SetItem(infoPtr, (PLITEM)lParam);
1690 return SYSLINK_GetItem(infoPtr, (PLITEM)lParam);
1692 case LM_GETIDEALHEIGHT:
1695 /* LM_GETIDEALSIZE */
1696 SYSLINK_GetIdealSize(infoPtr, (int)wParam, (LPSIZE)lParam);
1698 return SYSLINK_GetIdealHeight(infoPtr);
1701 return SYSLINK_SetFocus(infoPtr, (HWND)wParam);
1704 return SYSLINK_KillFocus(infoPtr, (HWND)wParam);
1707 infoPtr->Style &= ~WS_DISABLED;
1708 infoPtr->Style |= (wParam ? 0 : WS_DISABLED);
1709 InvalidateRect (infoPtr->Self, NULL, FALSE);
1712 case WM_STYLECHANGED:
1713 if (wParam == GWL_STYLE)
1715 infoPtr->Style = ((LPSTYLESTRUCT)lParam)->styleNew;
1717 InvalidateRect(infoPtr->Self, NULL, TRUE);
1722 /* allocate memory for info struct */
1723 infoPtr = Alloc (sizeof(SYSLINK_INFO));
1724 if (!infoPtr) return -1;
1725 SetWindowLongPtrW (hwnd, 0, (DWORD_PTR)infoPtr);
1727 /* initialize the info struct */
1728 infoPtr->Self = hwnd;
1729 infoPtr->Notify = ((LPCREATESTRUCTW)lParam)->hwndParent;
1730 infoPtr->Style = ((LPCREATESTRUCTW)lParam)->style;
1732 infoPtr->LinkFont = 0;
1733 infoPtr->Items = NULL;
1734 infoPtr->HasFocus = FALSE;
1735 infoPtr->MouseDownID = -1;
1736 infoPtr->TextColor = GetSysColor(COLOR_WINDOWTEXT);
1737 infoPtr->LinkColor = GetSysColor(COLOR_HIGHLIGHT);
1738 infoPtr->VisitedColor = GetSysColor(COLOR_HIGHLIGHT);
1739 infoPtr->BreakChar = ' ';
1740 TRACE("SysLink Ctrl creation, hwnd=%p\n", hwnd);
1741 SYSLINK_SetText(infoPtr, ((LPCREATESTRUCTW)lParam)->lpszName);
1745 TRACE("SysLink Ctrl destruction, hwnd=%p\n", hwnd);
1746 SYSLINK_ClearDoc(infoPtr);
1747 if(infoPtr->Font != 0) DeleteObject(infoPtr->Font);
1748 if(infoPtr->LinkFont != 0) DeleteObject(infoPtr->LinkFont);
1749 SetWindowLongPtrW(hwnd, 0, 0);
1754 HandleDefaultMessage:
1755 if ((message >= WM_USER) && (message < WM_APP))
1757 ERR("unknown msg %04x wp=%04lx lp=%08lx\n", message, wParam, lParam );
1759 return DefWindowProcW(hwnd, message, wParam, lParam);
1764 /***********************************************************************
1765 * SYSLINK_Register [Internal]
1767 * Registers the SysLink window class.
1769 VOID SYSLINK_Register (void)
1773 ZeroMemory (&wndClass, sizeof(wndClass));
1774 wndClass.style = CS_GLOBALCLASS | CS_VREDRAW | CS_HREDRAW;
1775 wndClass.lpfnWndProc = SysLinkWindowProc;
1776 wndClass.cbClsExtra = 0;
1777 wndClass.cbWndExtra = sizeof (SYSLINK_INFO *);
1778 wndClass.hCursor = LoadCursorW (0, (LPWSTR)IDC_ARROW);
1779 wndClass.lpszClassName = WC_LINK;
1781 RegisterClassW (&wndClass);
1785 /***********************************************************************
1786 * SYSLINK_Unregister [Internal]
1788 * Unregisters the SysLink window class.
1790 VOID SYSLINK_Unregister (void)
1792 UnregisterClassW (WC_LINK, NULL);