comctl32: Fix comments explaining visibleOrder and firstVisible.

Hopefully this clears up the confusion between a) visible as in "all
ancestors are expanded" and b) visible as in "within the part of the
tree that is displayed on the screen".

Also, the claim that firstVisible has visible order 0 was false.

Signed-off-by: Joachim Priesner <joachim.priesner@web.de>
Signed-off-by: Nikolay Sivov<nsivov@codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard@winehq.org>

diff --git a/dlls/comctl32/treeview.c b/dlls/comctl32/treeview.c
index 695745c7a86a12e0452a12185fe323e69cbf7f9d..e0e9945f3bd19c8039a64e4e38c5f8ef8da7a850 100644 (file)
--- a/dlls/comctl32/treeview.c
+++ b/dlls/comctl32/treeview.c
@@ -96,7 +96,7 @@ typedef struct tagTREEVIEW_INFO
   HTREEITEM    focusedItem;    /* item that was under the cursor when WM_LBUTTONDOWN was received */
   HTREEITEM     editItem;       /* item being edited with builtin edit box */
 
-  HTREEITEM     firstVisible;   /* handle to first visible item */
+  HTREEITEM     firstVisible;   /* handle to item whose top edge is at y = 0 */
   LONG          maxVisibleOrder;
   HTREEITEM     dropItem;       /* handle to item selected by drag cursor */
   HTREEITEM     insertMarkItem; /* item after which insertion mark is placed */
@@ -162,7 +162,10 @@ typedef struct _TREEITEM    /* HTREEITEM is a _TREEINFO *. */
   LONG      imageOffset;
   LONG      textOffset;
   LONG      textWidth;      /* horizontal text extent for pszText */
-  LONG      visibleOrder;   /* visible ordering, 0 is first visible item */
+  LONG      visibleOrder;   /* Depth-first numbering of the items whose ancestors are all expanded,
+                               corresponding to a top-to-bottom ordering in the tree view.
+                               Each item takes up "item.iIntegral" spots in the visible order.
+                               0 is the root's first child. */
   const TREEVIEW_INFO *infoPtr; /* tree data this item belongs to */
 } TREEVIEW_ITEM;