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(syslink);
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 COLORREF BackColor; /* Background color, set on creation */
98 WCHAR BreakChar; /* Break Character for the current font */
99 BOOL IgnoreReturn; /* (infoPtr->Style & LWS_IGNORERETURN) on creation */
102 static const WCHAR SL_LINKOPEN[] = { '<','a', 0 };
103 static const WCHAR SL_HREF[] = { 'h','r','e','f','=','\"',0 };
104 static const WCHAR SL_ID[] = { 'i','d','=','\"',0 };
105 static const WCHAR SL_LINKCLOSE[] = { '<','/','a','>',0 };
107 /* Control configuration constants */
109 #define SL_LEFTMARGIN (0)
110 #define SL_TOPMARGIN (0)
111 #define SL_RIGHTMARGIN (0)
112 #define SL_BOTTOMMARGIN (0)
114 /***********************************************************************
115 * SYSLINK_FreeDocItem
116 * Frees all data and gdi objects associated with a document item
118 static VOID SYSLINK_FreeDocItem (PDOC_ITEM DocItem)
120 if(DocItem->Type == slLink)
122 Free(DocItem->u.Link.szID);
123 Free(DocItem->u.Link.szUrl);
126 /* we don't free Text because it's just a pointer to a character in the
127 entire window text string */
132 /***********************************************************************
133 * SYSLINK_AppendDocItem
134 * Create and append a new document item.
136 static PDOC_ITEM SYSLINK_AppendDocItem (SYSLINK_INFO *infoPtr, LPCWSTR Text, UINT textlen,
137 SL_ITEM_TYPE type, PDOC_ITEM LastItem)
141 textlen = min(textlen, strlenW(Text));
142 Item = Alloc(FIELD_OFFSET(DOC_ITEM, Text[textlen + 1]));
145 ERR("Failed to alloc DOC_ITEM structure!\n");
150 Item->nText = textlen;
156 LastItem->Next = Item;
160 infoPtr->Items = Item;
163 lstrcpynW(Item->Text, Text, textlen + 1);
168 /***********************************************************************
170 * Clears the document tree
172 static VOID SYSLINK_ClearDoc (SYSLINK_INFO *infoPtr)
174 PDOC_ITEM Item, Next;
176 Item = infoPtr->Items;
180 SYSLINK_FreeDocItem(Item);
184 infoPtr->Items = NULL;
187 /***********************************************************************
189 * Parses the window text string and creates a document. Returns the
190 * number of document items created.
192 static UINT SYSLINK_ParseText (SYSLINK_INFO *infoPtr, LPCWSTR Text)
194 LPCWSTR current, textstart = NULL, linktext = NULL, firsttag = NULL;
195 int taglen = 0, textlen = 0, linklen = 0, docitems = 0;
196 PDOC_ITEM Last = NULL;
197 SL_ITEM_TYPE CurrentType = slText;
201 TRACE("(%p %s)\n", infoPtr, debugstr_w(Text));
203 for(current = Text; *current != 0;)
207 if(!StrCmpNIW(current, SL_LINKOPEN, 2) && (CurrentType == slText))
209 BOOL ValidParam = FALSE, ValidLink = FALSE;
211 if(*(current + 2) == '>')
213 /* we just have to deal with a <a> tag */
222 else if(*(current + 2) == infoPtr->BreakChar)
224 /* we expect parameters, parse them */
225 LPCWSTR *CurrentParameter = NULL, tmp;
226 UINT *CurrentParameterLen = NULL;
229 tmp = current + taglen;
234 /* compare the current position with all known parameters */
235 if(!StrCmpNIW(tmp, SL_HREF, 6))
239 CurrentParameter = &lpUrl;
240 CurrentParameterLen = &lenUrl;
242 else if(!StrCmpNIW(tmp, SL_ID, 4))
246 CurrentParameter = &lpID;
247 CurrentParameterLen = &lenId;
256 /* we got a known parameter, now search until the next " character.
257 If we can't find a " character, there's a syntax error and we just assume it's text */
259 *CurrentParameter = current + taglen;
260 *CurrentParameterLen = 0;
262 for(tmp = *CurrentParameter; *tmp != 0; tmp++)
271 (*CurrentParameterLen)++;
276 /* we're done with this parameter, now there are only 2 possibilities:
277 * 1. another parameter is coming, so expect a ' ' (space) character
278 * 2. the tag is being closed, so expect a '<' character
280 if(*tmp == infoPtr->BreakChar)
282 /* we expect another parameter, do the whole thing again */
289 /* the tag is being closed, we're done */
296 if(ValidLink && ValidParam)
298 /* the <a ...> tag appears to be valid. save all information
299 so we can add the link if we find a valid </a> tag later */
300 CurrentType = slLink;
301 linktext = current + taglen;
310 if(textstart == NULL)
316 else if(!StrCmpNIW(current, SL_LINKCLOSE, 4) && (CurrentType == slLink) && firsttag)
318 /* there's a <a...> tag opened, first add the previous text, if present */
319 if(textstart != NULL && textlen > 0 && firsttag > textstart)
321 Last = SYSLINK_AppendDocItem(infoPtr, textstart, firsttag - textstart, slText, Last);
324 ERR("Unable to create new document item!\n");
332 /* now it's time to add the link to the document */
334 if(linktext != NULL && linklen > 0)
336 Last = SYSLINK_AppendDocItem(infoPtr, linktext, linklen, slLink, Last);
339 ERR("Unable to create new document item!\n");
343 if(CurrentType == slLink)
347 if(!(infoPtr->Style & WS_DISABLED))
349 Last->u.Link.state |= LIS_ENABLED;
351 /* Copy the tag parameters */
354 nc = min(lenId, strlenW(lpID));
355 nc = min(nc, MAX_LINKID_TEXT - 1);
356 Last->u.Link.szID = Alloc((nc + 1) * sizeof(WCHAR));
357 if(Last->u.Link.szID != NULL)
359 lstrcpynW(Last->u.Link.szID, lpID, nc + 1);
363 Last->u.Link.szID = NULL;
366 nc = min(lenUrl, strlenW(lpUrl));
367 nc = min(nc, L_MAX_URL_LENGTH - 1);
368 Last->u.Link.szUrl = Alloc((nc + 1) * sizeof(WCHAR));
369 if(Last->u.Link.szUrl != NULL)
371 lstrcpynW(Last->u.Link.szUrl, lpUrl, nc + 1);
375 Last->u.Link.szUrl = NULL;
379 CurrentType = slText;
386 /* we don't know what tag it is, so just continue */
389 if(CurrentType == slText && textstart == NULL)
403 /* save the pointer of the current text item if we couldn't find a tag */
404 if(textstart == NULL && CurrentType == slText)
413 if(textstart != NULL && textlen > 0)
415 Last = SYSLINK_AppendDocItem(infoPtr, textstart, textlen, CurrentType, Last);
418 ERR("Unable to create new document item!\n");
421 if(CurrentType == slLink)
425 if(!(infoPtr->Style & WS_DISABLED))
427 Last->u.Link.state |= LIS_ENABLED;
429 /* Copy the tag parameters */
432 nc = min(lenId, strlenW(lpID));
433 nc = min(nc, MAX_LINKID_TEXT - 1);
434 Last->u.Link.szID = Alloc((nc + 1) * sizeof(WCHAR));
435 if(Last->u.Link.szID != NULL)
437 lstrcpynW(Last->u.Link.szID, lpID, nc + 1);
441 Last->u.Link.szID = NULL;
444 nc = min(lenUrl, strlenW(lpUrl));
445 nc = min(nc, L_MAX_URL_LENGTH - 1);
446 Last->u.Link.szUrl = Alloc((nc + 1) * sizeof(WCHAR));
447 if(Last->u.Link.szUrl != NULL)
449 lstrcpynW(Last->u.Link.szUrl, lpUrl, nc + 1);
453 Last->u.Link.szUrl = NULL;
458 if(linktext != NULL && linklen > 0)
460 /* we got an unclosed link, just display the text */
461 Last = SYSLINK_AppendDocItem(infoPtr, linktext, linklen, slText, Last);
464 ERR("Unable to create new document item!\n");
473 /***********************************************************************
474 * SYSLINK_RepaintLink
477 static VOID SYSLINK_RepaintLink (const SYSLINK_INFO *infoPtr, const DOC_ITEM *DocItem)
482 if(DocItem->Type != slLink)
484 ERR("DocItem not a link!\n");
488 bl = DocItem->Blocks;
495 InvalidateRect(infoPtr->Self, &bl->rc, TRUE);
496 n -= bl->nChars + bl->nSkip;
502 /***********************************************************************
503 * SYSLINK_GetLinkItemByIndex
504 * Retrieves a document link by its index
506 static PDOC_ITEM SYSLINK_GetLinkItemByIndex (const SYSLINK_INFO *infoPtr, int iLink)
508 PDOC_ITEM Current = infoPtr->Items;
510 while(Current != NULL)
512 if((Current->Type == slLink) && (iLink-- <= 0))
516 Current = Current->Next;
521 /***********************************************************************
522 * SYSLINK_GetFocusLink
523 * Retrieves the link that has the LIS_FOCUSED bit
525 static PDOC_ITEM SYSLINK_GetFocusLink (const SYSLINK_INFO *infoPtr, int *LinkId)
527 PDOC_ITEM Current = infoPtr->Items;
530 while(Current != NULL)
532 if(Current->Type == slLink)
534 if(Current->u.Link.state & LIS_FOCUSED)
542 Current = Current->Next;
547 /***********************************************************************
548 * SYSLINK_GetNextLink
551 static PDOC_ITEM SYSLINK_GetNextLink (const SYSLINK_INFO *infoPtr, PDOC_ITEM Current)
553 for(Current = (Current != NULL ? Current->Next : infoPtr->Items);
555 Current = Current->Next)
557 if(Current->Type == slLink)
565 /***********************************************************************
566 * SYSLINK_GetPrevLink
567 * Gets the previous link
569 static PDOC_ITEM SYSLINK_GetPrevLink (const SYSLINK_INFO *infoPtr, PDOC_ITEM Current)
573 /* returns the last link */
574 PDOC_ITEM Last = NULL;
576 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
578 if(Current->Type == slLink)
587 /* returns the previous link */
588 PDOC_ITEM Cur, Prev = NULL;
590 for(Cur = infoPtr->Items; Cur != NULL; Cur = Cur->Next)
596 if(Cur->Type == slLink)
605 /***********************************************************************
607 * Tries to wrap a line.
609 static BOOL SYSLINK_WrapLine (LPWSTR Text, WCHAR BreakChar, int *LineLen,
610 int nFit, LPSIZE Extent)
621 Current = Text + nFit;
623 /* check if we're in the middle of a word */
624 if((*Current) != BreakChar)
626 /* search for the beginning of the word */
627 while(Current > Text && (*(Current - 1)) != BreakChar)
644 /***********************************************************************
646 * Renders the document in memory
648 static VOID SYSLINK_Render (const SYSLINK_INFO *infoPtr, HDC hdc, PRECT pRect)
653 int x, y, LineHeight;
656 szDoc.cx = szDoc.cy = 0;
659 rc.right -= SL_RIGHTMARGIN;
660 rc.bottom -= SL_BOTTOMMARGIN;
662 if(rc.right - SL_LEFTMARGIN < 0)
664 if (rc.bottom - SL_TOPMARGIN < 0)
667 hOldFont = SelectObject(hdc, infoPtr->Font);
673 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
677 PDOC_TEXTBLOCK bl, cbl;
681 if(Current->nText == 0)
689 Free(Current->Blocks);
690 Current->Blocks = NULL;
694 if(Current->Type == slText)
696 SelectObject(hdc, infoPtr->Font);
698 else if(Current->Type == slLink)
700 SelectObject(hdc, infoPtr->LinkFont);
707 /* skip break characters unless they're the first of the doc item */
708 if(tx != Current->Text || x == SL_LEFTMARGIN)
710 while(n > 0 && (*tx) == infoPtr->BreakChar)
718 if((n == 0 && SkipChars != 0) ||
719 GetTextExtentExPointW(hdc, tx, n, rc.right - x, &nFit, NULL, &szDim))
727 Wrap = SYSLINK_WrapLine(tx, infoPtr->BreakChar, &LineLen, nFit, &szDim);
731 if(x > SL_LEFTMARGIN)
733 /* move one line down, the word didn't fit into the line */
741 /* the word starts at the beginning of the line and doesn't
742 fit into the line, so break it at the last character that fits */
743 LineLen = max(nFit, 1);
749 if(!GetTextExtentExPointW(hdc, tx, LineLen, rc.right - x, NULL, NULL, &szDim))
762 nbl = ReAlloc(bl, (nBlocks + 1) * sizeof(DOC_TEXTBLOCK));
768 cbl = bl + nBlocks - 1;
770 cbl->nChars = LineLen;
771 cbl->nSkip = SkipChars;
774 cbl->rc.right = x + szDim.cx;
775 cbl->rc.bottom = y + szDim.cy;
777 if (cbl->rc.right > szDoc.cx)
778 szDoc.cx = cbl->rc.right;
779 if (cbl->rc.bottom > szDoc.cy)
780 szDoc.cy = cbl->rc.bottom;
785 LineHeight = max(LineHeight, szDim.cy);
801 ERR("Failed to alloc DOC_TEXTBLOCK structure!\n");
815 Current->Blocks = bl;
819 SelectObject(hdc, hOldFont);
821 pRect->right = pRect->left + szDoc.cx;
822 pRect->bottom = pRect->top + szDoc.cy;
825 /***********************************************************************
827 * Draws the SysLink control.
829 static LRESULT SYSLINK_Draw (const SYSLINK_INFO *infoPtr, HDC hdc)
834 COLORREF OldTextColor, OldBkColor;
837 hOldFont = SelectObject(hdc, infoPtr->Font);
838 OldTextColor = SetTextColor(hdc, infoPtr->TextColor);
839 OldBkColor = SetBkColor(hdc, infoPtr->BackColor);
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 hBrush = (HBRUSH)SendMessageW(infoPtr->Notify, WM_CTLCOLORSTATIC,
848 (WPARAM)hdc, (LPARAM)infoPtr->Self);
850 hBrush = CreateSolidBrush(infoPtr->BackColor);
851 FillRect(hdc, &rc, hBrush);
852 DeleteObject(hBrush);
854 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
860 bl = Current->Blocks;
866 if(Current->Type == slText)
868 SelectObject(hdc, infoPtr->Font);
869 SetTextColor(hdc, infoPtr->TextColor);
873 SelectObject(hdc, infoPtr->LinkFont);
874 SetTextColor(hdc, (!(Current->u.Link.state & LIS_VISITED) ? infoPtr->LinkColor : infoPtr->VisitedColor));
880 ExtTextOutW(hdc, bl->rc.left, bl->rc.top, ETO_OPAQUE | ETO_CLIPPED, &bl->rc, tx, bl->nChars, NULL);
881 if((Current->Type == slLink) && (Current->u.Link.state & LIS_FOCUSED) && infoPtr->HasFocus)
883 COLORREF PrevTextColor;
884 PrevTextColor = SetTextColor(hdc, infoPtr->TextColor);
885 DrawFocusRect(hdc, &bl->rc);
886 SetTextColor(hdc, PrevTextColor);
889 n -= bl->nChars + bl->nSkip;
895 SetBkColor(hdc, OldBkColor);
896 SetTextColor(hdc, OldTextColor);
897 SelectObject(hdc, hOldFont);
903 /***********************************************************************
905 * Handles the WM_PAINT message.
907 static LRESULT SYSLINK_Paint (const SYSLINK_INFO *infoPtr, HDC hdcParam)
912 hdc = hdcParam ? hdcParam : BeginPaint (infoPtr->Self, &ps);
915 SYSLINK_Draw (infoPtr, hdc);
916 if (!hdcParam) EndPaint (infoPtr->Self, &ps);
921 /***********************************************************************
923 * Set new Font for the SysLink control.
925 static HFONT SYSLINK_SetFont (SYSLINK_INFO *infoPtr, HFONT hFont, BOOL bRedraw)
931 HFONT hOldFont = infoPtr->Font;
932 infoPtr->Font = hFont;
934 /* free the underline font */
935 if(infoPtr->LinkFont != NULL)
937 DeleteObject(infoPtr->LinkFont);
938 infoPtr->LinkFont = NULL;
941 /* Render text position and word wrapping in memory */
942 if (GetClientRect(infoPtr->Self, &rcClient))
944 hdc = GetDC(infoPtr->Self);
947 /* create a new underline font */
948 if(GetTextMetricsW(hdc, &tm) &&
949 GetObjectW(infoPtr->Font, sizeof(LOGFONTW), &lf))
951 lf.lfUnderline = TRUE;
952 infoPtr->LinkFont = CreateFontIndirectW(&lf);
953 infoPtr->BreakChar = tm.tmBreakChar;
957 ERR("Failed to create link font!\n");
960 SYSLINK_Render(infoPtr, hdc, &rcClient);
961 ReleaseDC(infoPtr->Self, hdc);
967 RedrawWindow(infoPtr->Self, NULL, NULL, RDW_INVALIDATE | RDW_UPDATENOW);
973 /***********************************************************************
975 * Set new text for the SysLink control.
977 static LRESULT SYSLINK_SetText (SYSLINK_INFO *infoPtr, LPCWSTR Text)
979 /* clear the document */
980 SYSLINK_ClearDoc(infoPtr);
982 if(Text == NULL || *Text == 0)
987 /* let's parse the string and create a document */
988 if(SYSLINK_ParseText(infoPtr, Text) > 0)
992 /* Render text position and word wrapping in memory */
993 if (GetClientRect(infoPtr->Self, &rcClient))
995 HDC hdc = GetDC(infoPtr->Self);
998 SYSLINK_Render(infoPtr, hdc, &rcClient);
999 ReleaseDC(infoPtr->Self, hdc);
1001 InvalidateRect(infoPtr->Self, NULL, TRUE);
1009 /***********************************************************************
1010 * SYSLINK_SetFocusLink
1011 * Updates the focus status bits and focusses the specified link.
1012 * If no document item is specified, the focus bit will be removed from all links.
1013 * Returns the previous focused item.
1015 static PDOC_ITEM SYSLINK_SetFocusLink (const SYSLINK_INFO *infoPtr, const DOC_ITEM *DocItem)
1017 PDOC_ITEM Current, PrevFocus = NULL;
1019 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
1021 if(Current->Type == slLink)
1023 if((PrevFocus == NULL) && (Current->u.Link.state & LIS_FOCUSED))
1025 PrevFocus = Current;
1028 if(Current == DocItem)
1030 Current->u.Link.state |= LIS_FOCUSED;
1034 Current->u.Link.state &= ~LIS_FOCUSED;
1042 /***********************************************************************
1044 * Sets the states and attributes of a link item.
1046 static LRESULT SYSLINK_SetItem (const SYSLINK_INFO *infoPtr, const LITEM *Item)
1052 BOOL Repaint = FALSE;
1054 if(!(Item->mask & LIF_ITEMINDEX) || !(Item->mask & (LIF_FLAGSMASK)))
1056 ERR("Invalid Flags!\n");
1060 di = SYSLINK_GetLinkItemByIndex(infoPtr, Item->iLink);
1063 ERR("Link %d couldn't be found\n", Item->iLink);
1067 if(Item->mask & LIF_ITEMID)
1069 nc = min(lstrlenW(Item->szID), MAX_LINKID_TEXT - 1);
1070 szId = Alloc((nc + 1) * sizeof(WCHAR));
1073 lstrcpynW(szId, Item->szID, nc + 1);
1077 ERR("Unable to allocate memory for link id\n");
1082 if(Item->mask & LIF_URL)
1084 nc = min(lstrlenW(Item->szUrl), L_MAX_URL_LENGTH - 1);
1085 szUrl = Alloc((nc + 1) * sizeof(WCHAR));
1088 lstrcpynW(szUrl, Item->szUrl, nc + 1);
1094 ERR("Unable to allocate memory for link url\n");
1099 if(Item->mask & LIF_ITEMID)
1101 Free(di->u.Link.szID);
1102 di->u.Link.szID = szId;
1105 if(Item->mask & LIF_URL)
1107 Free(di->u.Link.szUrl);
1108 di->u.Link.szUrl = szUrl;
1111 if(Item->mask & LIF_STATE)
1113 UINT oldstate = di->u.Link.state;
1114 /* clear the masked bits */
1115 di->u.Link.state &= ~(Item->stateMask & LIS_MASK);
1117 di->u.Link.state |= (Item->state & Item->stateMask) & LIS_MASK;
1118 Repaint = (oldstate != di->u.Link.state);
1120 /* update the focus */
1121 SYSLINK_SetFocusLink(infoPtr, ((di->u.Link.state & LIS_FOCUSED) ? di : NULL));
1126 SYSLINK_RepaintLink(infoPtr, di);
1132 /***********************************************************************
1134 * Retrieves the states and attributes of a link item.
1136 static LRESULT SYSLINK_GetItem (const SYSLINK_INFO *infoPtr, PLITEM Item)
1140 if(!(Item->mask & LIF_ITEMINDEX) || !(Item->mask & (LIF_FLAGSMASK)))
1142 ERR("Invalid Flags!\n");
1146 di = SYSLINK_GetLinkItemByIndex(infoPtr, Item->iLink);
1149 ERR("Link %d couldn't be found\n", Item->iLink);
1153 if(Item->mask & LIF_STATE)
1155 Item->state = (di->u.Link.state & Item->stateMask);
1156 if(!infoPtr->HasFocus)
1158 /* remove the LIS_FOCUSED bit if the control doesn't have focus */
1159 Item->state &= ~LIS_FOCUSED;
1163 if(Item->mask & LIF_ITEMID)
1167 lstrcpyW(Item->szID, di->u.Link.szID);
1175 if(Item->mask & LIF_URL)
1177 if(di->u.Link.szUrl)
1179 lstrcpyW(Item->szUrl, di->u.Link.szUrl);
1190 /***********************************************************************
1191 * SYSLINK_PtInDocItem
1192 * Determines if a point is in the region of a document item
1194 static BOOL SYSLINK_PtInDocItem (const DOC_ITEM *DocItem, POINT pt)
1199 bl = DocItem->Blocks;
1206 if (PtInRect(&bl->rc, pt))
1210 n -= bl->nChars + bl->nSkip;
1218 /***********************************************************************
1220 * Determines the link the user clicked on.
1222 static LRESULT SYSLINK_HitTest (const SYSLINK_INFO *infoPtr, PLHITTESTINFO HitTest)
1227 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
1229 if(Current->Type == slLink)
1231 if(SYSLINK_PtInDocItem(Current, HitTest->pt))
1233 HitTest->item.mask = 0;
1234 HitTest->item.iLink = id;
1235 HitTest->item.state = 0;
1236 HitTest->item.stateMask = 0;
1237 if(Current->u.Link.szID)
1239 lstrcpyW(HitTest->item.szID, Current->u.Link.szID);
1243 HitTest->item.szID[0] = 0;
1245 if(Current->u.Link.szUrl)
1247 lstrcpyW(HitTest->item.szUrl, Current->u.Link.szUrl);
1251 HitTest->item.szUrl[0] = 0;
1262 /***********************************************************************
1263 * SYSLINK_GetIdealHeight
1264 * Returns the preferred height of a link at the current control's width.
1266 static LRESULT SYSLINK_GetIdealHeight (const SYSLINK_INFO *infoPtr)
1268 HDC hdc = GetDC(infoPtr->Self);
1273 HGDIOBJ hOldFont = SelectObject(hdc, infoPtr->Font);
1275 if(GetTextMetricsW(hdc, &tm))
1277 height = tm.tmHeight;
1283 SelectObject(hdc, hOldFont);
1284 ReleaseDC(infoPtr->Self, hdc);
1291 /***********************************************************************
1292 * SYSLINK_SendParentNotify
1293 * Sends a WM_NOTIFY message to the parent window.
1295 static LRESULT SYSLINK_SendParentNotify (const SYSLINK_INFO *infoPtr, UINT code, const DOC_ITEM *Link, int iLink)
1299 nml.hdr.hwndFrom = infoPtr->Self;
1300 nml.hdr.idFrom = GetWindowLongPtrW(infoPtr->Self, GWLP_ID);
1301 nml.hdr.code = code;
1304 nml.item.iLink = iLink;
1306 nml.item.stateMask = 0;
1307 if(Link->u.Link.szID)
1309 lstrcpyW(nml.item.szID, Link->u.Link.szID);
1313 nml.item.szID[0] = 0;
1315 if(Link->u.Link.szUrl)
1317 lstrcpyW(nml.item.szUrl, Link->u.Link.szUrl);
1321 nml.item.szUrl[0] = 0;
1324 return SendMessageW(infoPtr->Notify, WM_NOTIFY, nml.hdr.idFrom, (LPARAM)&nml);
1327 /***********************************************************************
1329 * Handles receiving the input focus.
1331 static LRESULT SYSLINK_SetFocus (SYSLINK_INFO *infoPtr)
1335 infoPtr->HasFocus = TRUE;
1337 /* We always select the first link, even if we activated the control using
1338 SHIFT+TAB. This is the default behavior */
1339 Focus = SYSLINK_GetNextLink(infoPtr, NULL);
1342 SYSLINK_SetFocusLink(infoPtr, Focus);
1343 SYSLINK_RepaintLink(infoPtr, Focus);
1348 /***********************************************************************
1350 * Handles losing the input focus.
1352 static LRESULT SYSLINK_KillFocus (SYSLINK_INFO *infoPtr)
1356 infoPtr->HasFocus = FALSE;
1357 Focus = SYSLINK_GetFocusLink(infoPtr, NULL);
1361 SYSLINK_RepaintLink(infoPtr, Focus);
1367 /***********************************************************************
1369 * Returns a link at the specified position
1371 static PDOC_ITEM SYSLINK_LinkAtPt (const SYSLINK_INFO *infoPtr, const POINT *pt, int *LinkId, BOOL MustBeEnabled)
1376 for(Current = infoPtr->Items; Current != NULL; Current = Current->Next)
1378 if((Current->Type == slLink) && SYSLINK_PtInDocItem(Current, *pt) &&
1379 (!MustBeEnabled || (MustBeEnabled && (Current->u.Link.state & LIS_ENABLED))))
1393 /***********************************************************************
1394 * SYSLINK_LButtonDown
1395 * Handles mouse clicks
1397 static LRESULT SYSLINK_LButtonDown (SYSLINK_INFO *infoPtr, const POINT *pt)
1399 PDOC_ITEM Current, Old;
1402 Current = SYSLINK_LinkAtPt(infoPtr, pt, &id, TRUE);
1405 SetFocus(infoPtr->Self);
1407 Old = SYSLINK_SetFocusLink(infoPtr, Current);
1408 if(Old != NULL && Old != Current)
1410 SYSLINK_RepaintLink(infoPtr, Old);
1412 infoPtr->MouseDownID = id;
1413 SYSLINK_RepaintLink(infoPtr, Current);
1419 /***********************************************************************
1421 * Handles mouse clicks
1423 static LRESULT SYSLINK_LButtonUp (SYSLINK_INFO *infoPtr, const POINT *pt)
1425 if(infoPtr->MouseDownID > -1)
1430 Current = SYSLINK_LinkAtPt(infoPtr, pt, &id, TRUE);
1431 if((Current != NULL) && (Current->u.Link.state & LIS_FOCUSED) && (infoPtr->MouseDownID == id))
1433 SYSLINK_SendParentNotify(infoPtr, NM_CLICK, Current, id);
1437 infoPtr->MouseDownID = -1;
1442 /***********************************************************************
1444 * Handles ENTER key events
1446 static BOOL SYSLINK_OnEnter (const SYSLINK_INFO *infoPtr)
1448 if(infoPtr->HasFocus && !infoPtr->IgnoreReturn)
1453 Focus = SYSLINK_GetFocusLink(infoPtr, &id);
1456 SYSLINK_SendParentNotify(infoPtr, NM_RETURN, Focus, id);
1463 /***********************************************************************
1464 * SYSKEY_SelectNextPrevLink
1465 * Changes the currently focused link
1467 static BOOL SYSKEY_SelectNextPrevLink (const SYSLINK_INFO *infoPtr, BOOL Prev)
1469 if(infoPtr->HasFocus)
1474 Focus = SYSLINK_GetFocusLink(infoPtr, &id);
1477 PDOC_ITEM NewFocus, OldFocus;
1480 NewFocus = SYSLINK_GetPrevLink(infoPtr, Focus);
1482 NewFocus = SYSLINK_GetNextLink(infoPtr, Focus);
1484 if(NewFocus != NULL)
1486 OldFocus = SYSLINK_SetFocusLink(infoPtr, NewFocus);
1488 if(OldFocus && OldFocus != NewFocus)
1490 SYSLINK_RepaintLink(infoPtr, OldFocus);
1492 SYSLINK_RepaintLink(infoPtr, NewFocus);
1500 /***********************************************************************
1501 * SYSKEY_SelectNextPrevLink
1502 * Determines if there's a next or previous link to decide whether the control
1503 * should capture the tab key message
1505 static BOOL SYSLINK_NoNextLink (const SYSLINK_INFO *infoPtr, BOOL Prev)
1507 PDOC_ITEM Focus, NewFocus;
1509 Focus = SYSLINK_GetFocusLink(infoPtr, NULL);
1511 NewFocus = SYSLINK_GetPrevLink(infoPtr, Focus);
1513 NewFocus = SYSLINK_GetNextLink(infoPtr, Focus);
1515 return NewFocus == NULL;
1518 /***********************************************************************
1519 * SYSLINK_GetIdealSize
1520 * Calculates the ideal size of a link control at a given maximum width.
1522 static VOID SYSLINK_GetIdealSize (const SYSLINK_INFO *infoPtr, int cxMaxWidth, LPSIZE lpSize)
1527 rc.left = rc.top = rc.bottom = 0;
1528 rc.right = cxMaxWidth;
1530 hdc = GetDC(infoPtr->Self);
1533 HGDIOBJ hOldFont = SelectObject(hdc, infoPtr->Font);
1535 SYSLINK_Render(infoPtr, hdc, &rc);
1537 SelectObject(hdc, hOldFont);
1538 ReleaseDC(infoPtr->Self, hdc);
1540 lpSize->cx = rc.right;
1541 lpSize->cy = rc.bottom;
1545 /***********************************************************************
1548 static LRESULT WINAPI SysLinkWindowProc(HWND hwnd, UINT message,
1549 WPARAM wParam, LPARAM lParam)
1551 SYSLINK_INFO *infoPtr;
1553 TRACE("hwnd=%p msg=%04x wparam=%lx lParam=%lx\n", hwnd, message, wParam, lParam);
1555 infoPtr = (SYSLINK_INFO *)GetWindowLongPtrW(hwnd, 0);
1557 if (!infoPtr && message != WM_CREATE)
1558 return DefWindowProcW(hwnd, message, wParam, lParam);
1561 case WM_PRINTCLIENT:
1563 return SYSLINK_Paint (infoPtr, (HDC)wParam);
1571 DWORD mp = GetMessagePos();
1573 ht.pt.x = (short)LOWORD(mp);
1574 ht.pt.y = (short)HIWORD(mp);
1576 ScreenToClient(infoPtr->Self, &ht.pt);
1577 if(SYSLINK_HitTest (infoPtr, &ht))
1579 SetCursor(LoadCursorW(0, (LPCWSTR)IDC_HAND));
1583 return DefWindowProcW(hwnd, message, wParam, lParam);
1589 if (GetClientRect(infoPtr->Self, &rcClient))
1591 HDC hdc = GetDC(infoPtr->Self);
1594 SYSLINK_Render(infoPtr, hdc, &rcClient);
1595 ReleaseDC(infoPtr->Self, hdc);
1602 return (LRESULT)infoPtr->Font;
1605 return (LRESULT)SYSLINK_SetFont(infoPtr, (HFONT)wParam, (BOOL)lParam);
1608 SYSLINK_SetText(infoPtr, (LPWSTR)lParam);
1609 return DefWindowProcW(hwnd, message, wParam, lParam);
1611 case WM_LBUTTONDOWN:
1614 pt.x = (short)LOWORD(lParam);
1615 pt.y = (short)HIWORD(lParam);
1616 return SYSLINK_LButtonDown(infoPtr, &pt);
1621 pt.x = (short)LOWORD(lParam);
1622 pt.y = (short)HIWORD(lParam);
1623 return SYSLINK_LButtonUp(infoPtr, &pt);
1631 SYSLINK_OnEnter(infoPtr);
1635 BOOL shift = GetKeyState(VK_SHIFT) & 0x8000;
1636 SYSKEY_SelectNextPrevLink(infoPtr, shift);
1640 return DefWindowProcW(hwnd, message, wParam, lParam);
1646 LRESULT Ret = DLGC_HASSETSEL;
1647 int vk = (lParam != 0 ? (int)((LPMSG)lParam)->wParam : 0);
1651 Ret |= DLGC_WANTMESSAGE;
1655 BOOL shift = GetKeyState(VK_SHIFT) & 0x8000;
1656 if(!SYSLINK_NoNextLink(infoPtr, shift))
1658 Ret |= DLGC_WANTTAB;
1662 Ret |= DLGC_WANTCHARS;
1674 pt.x = (short)LOWORD(lParam);
1675 pt.y = (short)HIWORD(lParam);
1677 GetClientRect(infoPtr->Self, &rc);
1678 ScreenToClient(infoPtr->Self, &pt);
1679 if(pt.x < 0 || pt.y < 0 || pt.x > rc.right || pt.y > rc.bottom)
1684 if(SYSLINK_LinkAtPt(infoPtr, &pt, NULL, FALSE))
1689 return HTTRANSPARENT;
1693 return SYSLINK_HitTest(infoPtr, (PLHITTESTINFO)lParam);
1696 return SYSLINK_SetItem(infoPtr, (PLITEM)lParam);
1699 return SYSLINK_GetItem(infoPtr, (PLITEM)lParam);
1701 case LM_GETIDEALHEIGHT:
1704 /* LM_GETIDEALSIZE */
1705 SYSLINK_GetIdealSize(infoPtr, (int)wParam, (LPSIZE)lParam);
1707 return SYSLINK_GetIdealHeight(infoPtr);
1710 return SYSLINK_SetFocus(infoPtr);
1713 return SYSLINK_KillFocus(infoPtr);
1716 infoPtr->Style &= ~WS_DISABLED;
1717 infoPtr->Style |= (wParam ? 0 : WS_DISABLED);
1718 InvalidateRect (infoPtr->Self, NULL, FALSE);
1721 case WM_STYLECHANGED:
1722 if (wParam == GWL_STYLE)
1724 infoPtr->Style = ((LPSTYLESTRUCT)lParam)->styleNew;
1726 InvalidateRect(infoPtr->Self, NULL, TRUE);
1731 /* allocate memory for info struct */
1732 infoPtr = Alloc (sizeof(SYSLINK_INFO));
1733 if (!infoPtr) return -1;
1734 SetWindowLongPtrW (hwnd, 0, (DWORD_PTR)infoPtr);
1736 /* initialize the info struct */
1737 infoPtr->Self = hwnd;
1738 infoPtr->Notify = ((LPCREATESTRUCTW)lParam)->hwndParent;
1739 infoPtr->Style = ((LPCREATESTRUCTW)lParam)->style;
1741 infoPtr->LinkFont = 0;
1742 infoPtr->Items = NULL;
1743 infoPtr->HasFocus = FALSE;
1744 infoPtr->MouseDownID = -1;
1745 infoPtr->TextColor = comctl32_color.clrWindowText;
1746 infoPtr->LinkColor = comctl32_color.clrHighlight;
1747 infoPtr->VisitedColor = comctl32_color.clrHighlight;
1748 infoPtr->BackColor = infoPtr->Style & LWS_TRANSPARENT ?
1749 comctl32_color.clrWindow : comctl32_color.clrBtnFace;
1750 infoPtr->BreakChar = ' ';
1751 infoPtr->IgnoreReturn = infoPtr->Style & LWS_IGNORERETURN;
1752 TRACE("SysLink Ctrl creation, hwnd=%p\n", hwnd);
1753 SYSLINK_SetText(infoPtr, ((LPCREATESTRUCTW)lParam)->lpszName);
1757 TRACE("SysLink Ctrl destruction, hwnd=%p\n", hwnd);
1758 SYSLINK_ClearDoc(infoPtr);
1759 if(infoPtr->Font != 0) DeleteObject(infoPtr->Font);
1760 if(infoPtr->LinkFont != 0) DeleteObject(infoPtr->LinkFont);
1761 SetWindowLongPtrW(hwnd, 0, 0);
1765 case WM_SYSCOLORCHANGE:
1766 COMCTL32_RefreshSysColors();
1767 if (infoPtr->Style & LWS_TRANSPARENT)
1768 infoPtr->BackColor = comctl32_color.clrWindow;
1772 if ((message >= WM_USER) && (message < WM_APP) && !COMCTL32_IsReflectedMessage(message))
1774 ERR("unknown msg %04x wp=%04lx lp=%08lx\n", message, wParam, lParam );
1776 return DefWindowProcW(hwnd, message, wParam, lParam);
1781 /***********************************************************************
1782 * SYSLINK_Register [Internal]
1784 * Registers the SysLink window class.
1786 VOID SYSLINK_Register (void)
1790 ZeroMemory (&wndClass, sizeof(wndClass));
1791 wndClass.style = CS_GLOBALCLASS | CS_VREDRAW | CS_HREDRAW;
1792 wndClass.lpfnWndProc = SysLinkWindowProc;
1793 wndClass.cbClsExtra = 0;
1794 wndClass.cbWndExtra = sizeof (SYSLINK_INFO *);
1795 wndClass.hCursor = LoadCursorW (0, (LPWSTR)IDC_ARROW);
1796 wndClass.lpszClassName = WC_LINK;
1798 RegisterClassW (&wndClass);
1802 /***********************************************************************
1803 * SYSLINK_Unregister [Internal]
1805 * Unregisters the SysLink window class.
1807 VOID SYSLINK_Unregister (void)
1809 UnregisterClassW (WC_LINK, NULL);