1 // Permission is hereby granted, free of charge, to any person obtaining
2 // a copy of this software and associated documentation files (the
3 // "Software"), to deal in the Software without restriction, including
4 // without limitation the rights to use, copy, modify, merge, publish,
5 // distribute, sublicense, and/or sell copies of the Software, and to
6 // permit persons to whom the Software is furnished to do so, subject to
7 // the following conditions:
9 // The above copyright notice and this permission notice shall be
10 // included in all copies or substantial portions of the Software.
12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 // Copyright (c) 2004-2005 Novell, Inc.
23 // Jackson Harper (jackson@ximian.com)
24 // Kazuki Oikawa (kazuki@panicode.com)
27 using System.Collections;
28 using System.ComponentModel;
29 using System.ComponentModel.Design;
31 using System.Drawing.Drawing2D;
32 using System.Runtime.InteropServices;
34 namespace System.Windows.Forms {
37 [Docking (DockingBehavior.Ask)]
38 [ClassInterface (ClassInterfaceType.AutoDispatch)]
40 [DefaultProperty("Nodes")]
41 [DefaultEvent("AfterSelect")]
42 [Designer("System.Windows.Forms.Design.TreeViewDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
43 public class TreeView : Control {
45 private string path_separator = "\\";
46 private int item_height = -1;
48 internal TreeNode root_node;
49 internal bool nodes_added;
50 private TreeNodeCollection nodes;
52 private TreeViewAction selection_action;
53 private TreeNode selected_node;
54 private TreeNode pre_selected_node;
55 private TreeNode focused_node;
56 private TreeNode highlighted_node;
57 private Rectangle mouse_rect;
58 private bool select_mmove;
60 private ImageList image_list;
61 private int image_index = -1;
62 private int selected_image_index = -1;
65 private string image_key;
66 private bool is_hovering;
67 private TreeNode mouse_click_node;
68 private bool right_to_left_layout;
69 private string selected_image_key;
70 private bool show_node_tool_tips;
71 private ImageList state_image_list;
72 private TreeNode tooltip_currently_showing;
73 private ToolTip tooltip_window;
75 private bool full_row_select;
76 private bool hot_tracking;
77 private int indent = 19;
79 private NodeLabelEditEventArgs edit_args;
80 private LabelEditTextBox edit_text_box;
81 internal TreeNode edit_node;
83 private bool checkboxes;
84 private bool label_edit;
85 private bool scrollable = true;
86 private bool show_lines = true;
87 private bool show_root_lines = true;
88 private bool show_plus_minus = true;
89 private bool hide_selection = true;
91 private int max_visible_order = -1;
92 private VScrollBar vbar;
93 private HScrollBar hbar;
94 private bool vbar_bounds_set;
95 private bool hbar_bounds_set;
96 internal int skipped_nodes;
97 internal int hbar_offset;
99 private int update_stack;
100 private bool update_needed;
103 private Color line_color;
104 private StringFormat string_format;
106 private int drag_begin_x = 0;
107 private int drag_begin_y = 0;
108 private long handle_count = 1;
110 private TreeViewDrawMode draw_mode;
113 IComparer tree_view_node_sorter;
117 #region Public Constructors
120 InternalBorderStyle = BorderStyle.Fixed3D;
121 base.background_color = ThemeEngine.Current.ColorWindow;
122 base.foreground_color = ThemeEngine.Current.ColorWindowText;
124 root_node = new TreeNode (this);
125 root_node.Text = "ROOT NODE";
126 nodes = new TreeNodeCollection (root_node);
127 root_node.SetNodes (nodes);
129 MouseDown += new MouseEventHandler (MouseDownHandler);
130 MouseUp += new MouseEventHandler(MouseUpHandler);
131 MouseMove += new MouseEventHandler(MouseMoveHandler);
132 SizeChanged += new EventHandler (SizeChangedHandler);
133 FontChanged += new EventHandler (FontChangedHandler);
134 LostFocus += new EventHandler (LostFocusHandler);
135 GotFocus += new EventHandler (GotFocusHandler);
136 MouseWheel += new MouseEventHandler(MouseWheelHandler);
137 VisibleChanged += new EventHandler (VisibleChangedHandler);
139 SetStyle (ControlStyles.UserPaint | ControlStyles.StandardClick
141 | ControlStyles.UseTextForAccessibility
145 string_format = new StringFormat ();
146 string_format.LineAlignment = StringAlignment.Center;
147 string_format.Alignment = StringAlignment.Center;
149 vbar = new ImplicitVScrollBar ();
150 hbar = new ImplicitHScrollBar ();
152 vbar.Visible = false;
153 hbar.Visible = false;
154 vbar.ValueChanged += new EventHandler (VScrollBarValueChanged);
155 hbar.ValueChanged += new EventHandler (HScrollBarValueChanged);
158 Controls.AddImplicit (vbar);
159 Controls.AddImplicit (hbar);
163 #endregion // Public Constructors
165 #region Public Instance Properties
166 public override Color BackColor {
167 get { return base.BackColor;}
169 base.BackColor = value;
178 [EditorBrowsable(EditorBrowsableState.Never)]
179 public override Image BackgroundImage {
180 get { return base.BackgroundImage; }
181 set { base.BackgroundImage = value; }
184 [DefaultValue(BorderStyle.Fixed3D)]
186 public BorderStyle BorderStyle {
187 get { return InternalBorderStyle; }
188 set { InternalBorderStyle = value; }
191 [DefaultValue(false)]
192 public bool CheckBoxes {
193 get { return checkboxes; }
195 if (value == checkboxes)
199 // Match a "bug" in the MS implementation where disabling checkboxes
200 // collapses the entire tree, but enabling them does not affect the
201 // state of the tree.
203 root_node.CollapseAllUncheck ();
209 public override Color ForeColor {
210 get { return base.ForeColor; }
211 set { base.ForeColor = value; }
213 [DefaultValue(false)]
214 public bool FullRowSelect {
215 get { return full_row_select; }
217 if (value == full_row_select)
219 full_row_select = value;
224 public bool HideSelection {
225 get { return hide_selection; }
227 if (hide_selection == value)
229 hide_selection = value;
234 [DefaultValue(false)]
235 public bool HotTracking {
236 get { return hot_tracking; }
237 set { hot_tracking = value; }
242 [RelatedImageList ("ImageList")]
243 [RefreshProperties (RefreshProperties.Repaint)]
244 [TypeConverter (typeof (NoneExcludedImageIndexConverter))]
247 [TypeConverter (typeof (TreeViewImageIndexConverter))]
249 [Editor("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
251 public int ImageIndex {
252 get { return image_index; }
255 throw new ArgumentException ("'" + value + "' is not a valid value for 'value'. " +
256 "'value' must be greater than or equal to 0.");
258 if (image_index == value)
266 [RefreshProperties (RefreshProperties.Repaint)]
269 public ImageList ImageList {
270 get { return image_list; }
279 get { return indent; }
284 throw new ArgumentException ("'" + value + "' is not a valid value for 'Indent'. " +
285 "'Indent' must be less than or equal to 32000");
288 throw new ArgumentException ("'" + value + "' is not a valid value for 'Indent'. " +
289 "'Indent' must be greater than or equal to 0.");
299 public int ItemHeight {
301 if (item_height == -1)
302 return FontHeight + 3;
306 if (value == item_height)
313 internal int ActualItemHeight {
315 int res = ItemHeight;
316 if (ImageList != null && ImageList.ImageSize.Height > res)
317 res = ImageList.ImageSize.Height;
322 [DefaultValue(false)]
323 public bool LabelEdit {
324 get { return label_edit; }
325 set { label_edit = value; }
328 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
329 [MergableProperty(false)]
331 public TreeNodeCollection Nodes {
332 get { return nodes; }
337 [EditorBrowsable (EditorBrowsableState.Never)]
338 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
339 public new Padding Padding {
340 get { return base.Padding; }
341 set { base.Padding = value; }
346 public string PathSeparator {
347 get { return path_separator; }
348 set { path_separator = value; }
353 [DefaultValue (false)]
354 public virtual bool RightToLeftLayout {
355 get { return right_to_left_layout; }
357 if (right_to_left_layout != value) {
358 right_to_left_layout = value;
359 OnRightToLeftLayoutChanged (EventArgs.Empty);
366 public bool Scrollable {
367 get { return scrollable; }
369 if (scrollable == value)
372 UpdateScrollBars (false);
378 [RelatedImageList ("ImageList")]
379 [TypeConverter (typeof (NoneExcludedImageIndexConverter))]
382 [TypeConverter (typeof (TreeViewImageIndexConverter))]
384 [Editor("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
386 public int SelectedImageIndex {
387 get { return selected_image_index; }
390 throw new ArgumentException ("'" + value + "' is not a valid value for 'value'. " +
391 "'value' must be greater than or equal to 0.");
393 UpdateNode (SelectedNode);
398 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
399 public TreeNode SelectedNode {
401 if (!IsHandleCreated)
402 return pre_selected_node;
403 return selected_node;
406 if (!IsHandleCreated) {
407 pre_selected_node = value;
411 if (selected_node == value) {
412 selection_action = TreeViewAction.Unknown;
417 TreeViewCancelEventArgs e = new TreeViewCancelEventArgs (value, false, selection_action);
424 Rectangle invalid = Rectangle.Empty;
426 if (selected_node != null) {
427 invalid = Bloat (selected_node.Bounds);
429 if (focused_node != null) {
430 invalid = Rectangle.Union (invalid,
431 Bloat (focused_node.Bounds));
435 invalid = Rectangle.Union (invalid, Bloat (value.Bounds));
437 highlighted_node = value;
438 selected_node = value;
439 focused_node = value;
441 if (full_row_select || draw_mode != TreeViewDrawMode.Normal) {
443 invalid.Width = ViewportRectangle.Width;
446 if (invalid != Rectangle.Empty)
447 Invalidate (invalid);
449 // We ensure its visible after we update because
450 // scrolling is used for insure visible
451 if (selected_node != null)
452 selected_node.EnsureVisible ();
455 OnAfterSelect (new TreeViewEventArgs (value, TreeViewAction.Unknown));
457 selection_action = TreeViewAction.Unknown;
461 private Rectangle Bloat (Rectangle rect)
471 public bool ShowLines {
472 get { return show_lines; }
474 if (show_lines == value)
482 [DefaultValue (false)]
483 public bool ShowNodeToolTips {
484 get { return show_node_tool_tips; }
485 set { show_node_tool_tips = value; }
490 public bool ShowPlusMinus {
491 get { return show_plus_minus; }
493 if (show_plus_minus == value)
495 show_plus_minus = value;
501 public bool ShowRootLines {
502 get { return show_root_lines; }
504 if (show_root_lines == value)
506 show_root_lines = value;
513 [EditorBrowsable (EditorBrowsableState.Never)]
515 [DefaultValue(false)]
517 get { return sorted; }
523 //LAMESPEC: The documentation says that setting this to true should sort alphabetically if TreeViewNodeSorter is set.
524 // There seems to be a bug in the Microsoft implementation.
525 if (sorted && tree_view_node_sorter == null) {
539 [DefaultValue (null)]
540 public ImageList StateImageList {
541 get { return state_image_list; }
543 state_image_list = value;
550 [EditorBrowsable(EditorBrowsableState.Never)]
552 public override string Text {
553 get { return base.Text; }
554 set { base.Text = value; }
558 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
559 public TreeNode TopNode {
561 if (root_node.FirstNode == null)
563 OpenTreeNodeEnumerator one = new OpenTreeNodeEnumerator (root_node.FirstNode);
565 for (int i = 0; i < skipped_nodes; i++)
567 return one.CurrentNode;
578 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
579 public IComparer TreeViewNodeSorter {
581 return tree_view_node_sorter;
584 tree_view_node_sorter = value;
585 if (tree_view_node_sorter != null) {
587 //LAMESPEC: The documentation says that setting this should set Sorted to false.
588 // There seems to be a bug in the Microsoft implementation.
596 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
597 public int VisibleCount {
599 return ViewportRectangle.Height / ActualItemHeight;
604 /// According to MSDN this property has no effect on the treeview
605 [EditorBrowsable (EditorBrowsableState.Never)]
606 protected override bool DoubleBuffered {
607 get { return base.DoubleBuffered; }
608 set { base.DoubleBuffered = value; }
613 [DefaultValue ("Color [Black]")]
620 if (line_color == Color.Empty) {
621 Color res = ControlPaint.Dark (BackColor);
622 if (res == BackColor)
623 res = ControlPaint.Light (BackColor);
639 [RelatedImageList ("ImageList")]
640 [RefreshProperties (RefreshProperties.Repaint)]
641 [TypeConverter (typeof (ImageKeyConverter))]
642 [Editor ("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof (System.Drawing.Design.UITypeEditor))]
643 public string ImageKey {
644 get { return image_key; }
646 if (image_key == value)
656 [RelatedImageList ("ImageList")]
657 [RefreshProperties (RefreshProperties.Repaint)]
658 [TypeConverter (typeof (ImageKeyConverter))]
659 [Editor ("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof (System.Drawing.Design.UITypeEditor))]
660 public string SelectedImageKey {
661 get { return selected_image_key; }
663 if (selected_image_key == value)
665 selected_image_index = -1;
666 selected_image_key = value;
667 UpdateNode (SelectedNode);
674 [EditorBrowsable (EditorBrowsableState.Never)]
675 public override ImageLayout BackgroundImageLayout {
676 get { return base.BackgroundImageLayout; }
677 set { base.BackgroundImageLayout = value; }
682 [DefaultValue (TreeViewDrawMode.Normal)]
683 public TreeViewDrawMode DrawMode {
684 get { return draw_mode; }
685 set { draw_mode = value; }
688 #endregion // Public Instance Properties
690 #region Protected Instance Properties
691 protected override CreateParams CreateParams {
693 CreateParams cp = base.CreateParams;
698 protected override Size DefaultSize {
699 get { return new Size (121, 97); }
702 #endregion // Protected Instance Properties
704 #region Public Instance Methods
705 public void BeginUpdate ()
710 public void EndUpdate ()
712 if (update_stack > 1) {
717 RecalculateVisibleOrder (root_node);
718 UpdateScrollBars (false);
719 // if (SelectedNode != null)
720 // SelectedNode.EnsureVisible ();
721 Invalidate (ViewportRectangle);
722 update_needed = false;
730 Sort (Nodes.Count >= 2 ? tree_view_node_sorter : null);
734 void Sort (IComparer sorter)
737 RecalculateVisibleOrder (root_node);
738 UpdateScrollBars (false);
742 public void ExpandAll ()
745 root_node.ExpandAll ();
750 /// Everything below this is basically an emulation of a strange bug on MS
751 /// where they don't always scroll to the last node on ExpandAll
754 if (!IsHandleCreated)
759 foreach (TreeNode child in Nodes) {
760 if (child.Nodes.Count > 0)
767 if (IsHandleCreated) {
768 vbar.Value = vbar.Maximum - VisibleCount + 1;
770 RecalculateVisibleOrder (root_node);
771 UpdateScrollBars (true);
772 SetTop (Nodes [Nodes.Count - 1]);
777 public void CollapseAll ()
779 TreeNode walk = TopNode;
781 while (walk.parent != root_node)
785 root_node.CollapseAll ();
791 public TreeNode GetNodeAt (Point pt) {
792 return GetNodeAt (pt.Y);
795 public TreeNode GetNodeAt (int x, int y)
797 return GetNodeAt (y);
800 private TreeNode GetNodeAtUseX (int x, int y) {
801 TreeNode node = GetNodeAt (y);
802 if (node == null || !(IsTextArea (node, x) || full_row_select))
808 public int GetNodeCount (bool include_subtrees) {
809 return root_node.GetNodeCount (include_subtrees);
813 public TreeViewHitTestInfo HitTest (Point pt)
815 return HitTest (pt.X, pt.Y);
818 public TreeViewHitTestInfo HitTest (int x, int y)
820 TreeNode n = GetNodeAt (y);
823 return new TreeViewHitTestInfo (null, TreeViewHitTestLocations.None);
825 if (IsTextArea (n, x))
826 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.Label);
827 else if (IsPlusMinusArea (n, x))
828 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.PlusMinus);
829 else if (checkboxes && IsCheckboxArea (n, x))
830 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.StateImage);
831 else if (x > n.Bounds.Right)
832 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.RightOfLabel);
833 else if (IsImage (n, x))
834 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.Image);
836 return new TreeViewHitTestInfo (null, TreeViewHitTestLocations.Indent);
840 public override string ToString () {
841 int count = Nodes.Count;
843 return String.Concat (base.ToString (), "Node Count: 0");
844 return String.Concat (base.ToString (), "Node Count: ", count, " Nodes[0]: ", Nodes [0]);
848 #endregion // Public Instance Methods
850 #region Protected Instance Methods
851 protected override void CreateHandle () {
852 base.CreateHandle ();
853 RecalculateVisibleOrder (root_node);
854 UpdateScrollBars (false);
856 if (pre_selected_node != null)
857 SelectedNode = pre_selected_node;
860 protected override void Dispose (bool disposing) {
864 base.Dispose (disposing);
867 protected OwnerDrawPropertyBag GetItemRenderStyles (TreeNode node, int state) {
868 return node.prop_bag;
871 protected override bool IsInputKey (Keys key_data)
873 if (IsHandleCreated && (key_data & Keys.Alt) == 0) {
874 switch (key_data & Keys.KeyCode) {
886 if (edit_node != null)
892 return base.IsInputKey (key_data);
895 protected override void OnKeyDown (KeyEventArgs e)
897 OpenTreeNodeEnumerator ne;
899 switch (e.KeyData & Keys.KeyCode) {
901 if (selected_node != null && selected_node.IsExpanded)
902 selected_node.Expand ();
905 if (selected_node != null && selected_node.IsExpanded)
906 selected_node.Collapse ();
909 if (selected_node != null) {
910 if (selected_node.IsExpanded)
911 selected_node.Collapse ();
913 TreeNode parent = selected_node.Parent;
914 if (parent != null) {
915 selection_action = TreeViewAction.ByKeyboard;
916 SelectedNode = parent;
922 if (selected_node != null) {
923 if (!selected_node.IsExpanded)
924 selected_node.Expand ();
926 TreeNode child = selected_node.FirstNode;
928 SelectedNode = child;
933 if (selected_node != null) {
934 ne = new OpenTreeNodeEnumerator (selected_node);
935 if (ne.MovePrevious () && ne.MovePrevious ()) {
936 selection_action = TreeViewAction.ByKeyboard;
937 SelectedNode = ne.CurrentNode;
942 if (selected_node != null) {
943 ne = new OpenTreeNodeEnumerator (selected_node);
944 if (ne.MoveNext () && ne.MoveNext ()) {
945 selection_action = TreeViewAction.ByKeyboard;
946 SelectedNode = ne.CurrentNode;
951 if (root_node.Nodes.Count > 0) {
952 ne = new OpenTreeNodeEnumerator (root_node.Nodes [0]);
953 if (ne.MoveNext ()) {
954 selection_action = TreeViewAction.ByKeyboard;
955 SelectedNode = ne.CurrentNode;
960 if (root_node.Nodes.Count > 0) {
961 ne = new OpenTreeNodeEnumerator (root_node.Nodes [0]);
962 while (ne.MoveNext ())
964 selection_action = TreeViewAction.ByKeyboard;
965 SelectedNode = ne.CurrentNode;
969 if (selected_node != null) {
970 ne = new OpenTreeNodeEnumerator (selected_node);
971 int move = VisibleCount;
972 for (int i = 0; i < move && ne.MoveNext (); i++) {
975 selection_action = TreeViewAction.ByKeyboard;
976 SelectedNode = ne.CurrentNode;
980 if (selected_node != null) {
981 ne = new OpenTreeNodeEnumerator (selected_node);
982 int move = VisibleCount;
983 for (int i = 0; i < move && ne.MovePrevious (); i++)
985 selection_action = TreeViewAction.ByKeyboard;
986 SelectedNode = ne.CurrentNode;
990 if (selected_node != null)
991 selected_node.ExpandAll ();
996 if (!e.Handled && checkboxes &&
997 selected_node != null &&
998 (e.KeyData & Keys.KeyCode) == Keys.Space) {
999 selected_node.check_reason = TreeViewAction.ByKeyboard;
1000 selected_node.Checked = !selected_node.Checked;
1005 protected override void OnKeyPress (KeyPressEventArgs e)
1007 base.OnKeyPress (e);
1008 if (e.KeyChar == ' ')
1012 protected override void OnKeyUp (KeyEventArgs e)
1015 if ((e.KeyData & Keys.KeyCode) == Keys.Space)
1020 protected override void OnMouseHover (EventArgs e)
1022 base.OnMouseHover (e);
1026 TreeNode tn = GetNodeAt (PointToClient (MousePosition));
1029 MouseEnteredItem (tn);
1032 protected override void OnMouseLeave (EventArgs e)
1034 base.OnMouseLeave (e);
1036 is_hovering = false;
1038 if (tooltip_currently_showing != null)
1039 MouseLeftItem (tooltip_currently_showing);
1042 protected virtual void OnNodeMouseClick (TreeNodeMouseClickEventArgs e)
1044 TreeNodeMouseClickEventHandler eh = (TreeNodeMouseClickEventHandler)(Events[NodeMouseClickEvent]);
1049 protected virtual void OnNodeMouseDoubleClick (TreeNodeMouseClickEventArgs e)
1051 TreeNodeMouseClickEventHandler eh = (TreeNodeMouseClickEventHandler)(Events[NodeMouseDoubleClickEvent]);
1056 protected virtual void OnNodeMouseHover (TreeNodeMouseHoverEventArgs e)
1058 TreeNodeMouseHoverEventHandler eh = (TreeNodeMouseHoverEventHandler)(Events[NodeMouseHoverEvent]);
1064 protected virtual void OnItemDrag (ItemDragEventArgs e)
1066 ItemDragEventHandler eh = (ItemDragEventHandler)(Events [ItemDragEvent]);
1072 protected virtual void OnDrawNode(DrawTreeNodeEventArgs e) {
1073 DrawTreeNodeEventHandler eh = (DrawTreeNodeEventHandler)(Events[DrawNodeEvent]);
1078 [EditorBrowsable (EditorBrowsableState.Advanced)]
1079 protected virtual void OnRightToLeftLayoutChanged (EventArgs e) {
1080 EventHandler eh = (EventHandler)(Events[RightToLeftLayoutChangedEvent]);
1086 protected internal virtual void OnAfterCheck (TreeViewEventArgs e) {
1087 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterCheckEvent]);
1092 protected internal virtual void OnAfterCollapse (TreeViewEventArgs e) {
1093 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterCollapseEvent]);
1098 protected internal virtual void OnAfterExpand (TreeViewEventArgs e) {
1099 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterExpandEvent]);
1104 protected virtual void OnAfterLabelEdit (NodeLabelEditEventArgs e) {
1105 NodeLabelEditEventHandler eh = (NodeLabelEditEventHandler)(Events [AfterLabelEditEvent]);
1110 protected virtual void OnAfterSelect (TreeViewEventArgs e) {
1111 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterSelectEvent]);
1116 protected internal virtual void OnBeforeCheck (TreeViewCancelEventArgs e) {
1117 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeCheckEvent]);
1122 protected internal virtual void OnBeforeCollapse (TreeViewCancelEventArgs e) {
1123 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeCollapseEvent]);
1128 protected internal virtual void OnBeforeExpand (TreeViewCancelEventArgs e) {
1129 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeExpandEvent]);
1134 protected virtual void OnBeforeLabelEdit (NodeLabelEditEventArgs e) {
1135 NodeLabelEditEventHandler eh = (NodeLabelEditEventHandler)(Events [BeforeLabelEditEvent]);
1140 protected virtual void OnBeforeSelect (TreeViewCancelEventArgs e) {
1141 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeSelectEvent]);
1146 protected override void OnHandleCreated (EventArgs e) {
1147 base.OnHandleCreated (e);
1150 protected override void OnHandleDestroyed (EventArgs e) {
1151 base.OnHandleDestroyed (e);
1154 protected override void WndProc(ref Message m) {
1155 switch ((Msg) m.Msg) {
1157 case Msg.WM_LBUTTONDBLCLK:
1158 int val = m.LParam.ToInt32();
1159 DoubleClickHandler (null, new
1160 MouseEventArgs (MouseButtons.Left,
1162 (val>>16) & 0xffff, 0));
1165 case Msg.WM_CONTEXTMENU:
1166 if (WmContextMenu (ref m))
1172 base.WndProc (ref m);
1175 #endregion // Protected Instance Methods
1177 #region Internal & Private Methods and Properties
1178 internal IntPtr CreateNodeHandle ()
1180 return (IntPtr) handle_count++;
1183 // According to MSDN docs, for these to be raised,
1184 // the click must occur over a TreeNode
1185 internal override void HandleClick (int clicks, MouseEventArgs me)
1187 if (GetNodeAt (me.Location) != null) {
1188 if ((clicks > 1) && GetStyle (ControlStyles.StandardDoubleClick)) {
1190 OnDoubleClick(EventArgs.Empty);
1192 OnClick(EventArgs.Empty);
1195 OnMouseDoubleClick (me);
1204 internal override bool IsInputCharInternal (char charCode)
1209 internal TreeNode NodeFromHandle (IntPtr handle)
1211 // This method is called rarely, so instead of maintaining a table
1212 // we just walk the tree nodes to find the matching handle
1213 return NodeFromHandleRecursive (root_node, handle);
1216 private TreeNode NodeFromHandleRecursive (TreeNode node, IntPtr handle)
1218 if (node.handle == handle)
1220 foreach (TreeNode child in node.Nodes) {
1221 TreeNode match = NodeFromHandleRecursive (child, handle);
1228 internal Rectangle ViewportRectangle {
1230 Rectangle res = ClientRectangle;
1232 if (vbar != null && vbar.Visible)
1233 res.Width -= vbar.Width;
1234 if (hbar != null && hbar.Visible)
1235 res.Height -= hbar.Height;
1240 private TreeNode GetNodeAt (int y)
1242 if (nodes.Count <= 0)
1245 OpenTreeNodeEnumerator o = new OpenTreeNodeEnumerator (TopNode);
1246 int move = y / ActualItemHeight;
1247 for (int i = -1; i < move; i++) {
1252 return o.CurrentNode;
1255 private bool IsTextArea (TreeNode node, int x)
1257 return node != null && node.Bounds.Left <= x && node.Bounds.Right >= x;
1260 private bool IsSelectableArea (TreeNode node, int x)
1264 int l = node.Bounds.Left;
1265 if (ImageList != null)
1266 l -= ImageList.ImageSize.Width;
1267 return l <= x && node.Bounds.Right >= x;
1271 private bool IsPlusMinusArea (TreeNode node, int x)
1273 if (node.Nodes.Count == 0 || (node.parent == root_node && !show_root_lines))
1276 int l = node.Bounds.Left + 5;
1278 if (show_root_lines || node.Parent != null)
1280 if (ImageList != null)
1281 l -= ImageList.ImageSize.Width + 3;
1284 return (x > l && x < l + 8);
1287 private bool IsCheckboxArea (TreeNode node, int x)
1289 int l = CheckBoxLeft (node);
1290 return (x > l && x < l + 10);
1293 private bool IsImage (TreeNode node, int x)
1295 if (ImageList == null)
1298 int l = node.Bounds.Left;
1300 l -= ImageList.ImageSize.Width + 5;
1302 if (x >= l && x <= (l + ImageList.ImageSize.Width + 5))
1308 private int CheckBoxLeft (TreeNode node)
1310 int l = node.Bounds.Left + 5;
1312 if (show_root_lines || node.Parent != null)
1314 if (ImageList != null)
1315 l -= ImageList.ImageSize.Width + 3;
1320 internal void RecalculateVisibleOrder (TreeNode start)
1322 if (update_stack > 0)
1326 if (start == null) {
1330 order = start.visible_order;
1334 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (start);
1335 while (walk.MoveNext ()) {
1336 walk.CurrentNode.visible_order = order;
1340 max_visible_order = order;
1343 internal void SetTop (TreeNode node)
1347 order = Math.Max (0, node.visible_order - 1);
1349 if (!vbar.is_visible) {
1350 skipped_nodes = order;
1354 vbar.Value = Math.Min (order, vbar.Maximum - VisibleCount + 1);
1357 internal void SetBottom (TreeNode node)
1359 if (!vbar.is_visible)
1362 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (node);
1364 int bottom = ViewportRectangle.Bottom;
1366 while (walk.MovePrevious ()) {
1367 if (walk.CurrentNode.Bounds.Bottom <= bottom)
1372 int nv = vbar.Value + offset;
1373 if (vbar.Value + offset < vbar.Maximum) {
1377 Console.Error.WriteLine ("setting bottom to value greater then maximum ({0}, {1})",
1384 internal void UpdateBelow (TreeNode node)
1386 if (update_stack > 0) {
1387 update_needed = true;
1391 if (node == root_node) {
1392 Invalidate (ViewportRectangle);
1396 // We need to update the current node so the plus/minus block gets update too
1397 int top = Math.Max (node.Bounds.Top - 1, 0);
1398 Rectangle invalid = new Rectangle (0, top,
1399 Width, Height - top);
1400 Invalidate (invalid);
1403 internal void UpdateNode (TreeNode node)
1408 if (update_stack > 0) {
1409 update_needed = true;
1413 if (node == root_node) {
1418 Rectangle invalid = new Rectangle (0, node.Bounds.Top - 1, Width,
1419 node.Bounds.Height + 1);
1420 Invalidate (invalid);
1423 internal void UpdateNodePlusMinus (TreeNode node)
1425 if (update_stack > 0) {
1426 update_needed = true;
1430 int l = node.Bounds.Left + 5;
1432 if (show_root_lines || node.Parent != null)
1434 if (ImageList != null)
1435 l -= ImageList.ImageSize.Width + 3;
1439 Invalidate (new Rectangle (l, node.Bounds.Top, 8, node.Bounds.Height));
1442 internal override void OnPaintInternal (PaintEventArgs pe)
1444 Draw (pe.ClipRectangle, pe.Graphics);
1447 internal void CreateDashPen ()
1449 dash = new Pen (LineColor, 1);
1450 dash.DashStyle = DashStyle.Dot;
1453 private void Draw (Rectangle clip, Graphics dc)
1455 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (BackColor), clip);
1460 Rectangle viewport = ViewportRectangle;
1461 Rectangle original_clip = clip;
1462 if (clip.Bottom > viewport.Bottom)
1463 clip.Height = viewport.Bottom - clip.Top;
1465 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (TopNode);
1466 while (walk.MoveNext ()) {
1467 TreeNode current = walk.CurrentNode;
1469 // Haven't gotten to visible nodes yet
1470 if (current.GetY () + ActualItemHeight < clip.Top)
1473 // Past the visible nodes
1474 if (current.GetY () > clip.Bottom)
1477 DrawTreeNode (current, dc, clip);
1480 if (hbar.Visible && vbar.Visible) {
1481 Rectangle corner = new Rectangle (hbar.Right, vbar.Bottom, vbar.Width, hbar.Height);
1482 if (original_clip.IntersectsWith (corner))
1483 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (ThemeEngine.Current.ColorControl),
1488 private void DrawNodePlusMinus (TreeNode node, Graphics dc, int x, int middle)
1490 int height = ActualItemHeight - 2;
1491 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (BackColor), (x + 4) - (height / 2), node.GetY() + 1, height, height);
1493 dc.DrawRectangle (SystemPens.ControlDarkDark, x, middle - 4, 8, 8);
1495 if (node.IsExpanded) {
1496 dc.DrawLine (SystemPens.ControlDarkDark, x + 2, middle, x + 6, middle);
1498 dc.DrawLine (SystemPens.ControlDarkDark, x + 2, middle, x + 6, middle);
1499 dc.DrawLine (SystemPens.ControlDarkDark, x + 4, middle - 2, x + 4, middle + 2);
1504 private void DrawNodeState (TreeNode node, Graphics dc, int x, int y)
1507 if (StateImageList.Images[1] != null)
1508 dc.DrawImage (StateImageList.Images[1], new Rectangle (x, y, 16, 16));
1510 if (StateImageList.Images[0] != null)
1511 dc.DrawImage (StateImageList.Images[0], new Rectangle (x, y, 16, 16));
1516 private void DrawNodeCheckBox (TreeNode node, Graphics dc, int x, int middle)
1518 Pen pen = ThemeEngine.Current.ResPool.GetSizedPen(Color.Black, 2);
1519 dc.DrawRectangle (pen, x + 3, middle - 4, 11, 11);
1522 Pen check_pen = ThemeEngine.Current.ResPool.GetPen(Color.Black);
1527 Rectangle rect = new Rectangle (x + 5, middle - 2, check_size, check_size);
1529 for (int i = 0; i < lineWidth; i++) {
1530 dc.DrawLine (check_pen, rect.Left + 1, rect.Top + lineWidth + i, rect.Left + 3, rect.Top + 5 + i);
1531 dc.DrawLine (check_pen, rect.Left + 3, rect.Top + 5 + i, rect.Left + 7, rect.Top + 1 + i);
1536 private void DrawNodeLines (TreeNode node, Graphics dc, Rectangle clip, Pen dash, int x, int y, int middle)
1541 if (node.nodes.Count > 0 && show_plus_minus)
1546 dc.DrawLine (dash, x - indent + ladjust, middle, x + radjust, middle);
1548 if (node.PrevNode != null || node.Parent != null) {
1550 dc.DrawLine (dash, x - indent + ladjust, node.Bounds.Top,
1551 x - indent + ladjust, middle - (show_plus_minus && node.Nodes.Count > 0 ? 4 : 0));
1554 if (node.NextNode != null) {
1556 dc.DrawLine (dash, x - indent + ladjust, middle + (show_plus_minus && node.Nodes.Count > 0 ? 4 : 0),
1557 x - indent + ladjust, node.Bounds.Bottom);
1562 if (show_plus_minus)
1564 TreeNode parent = node.Parent;
1565 while (parent != null) {
1566 if (parent.NextNode != null) {
1567 int px = parent.GetLinesX () - indent + ladjust;
1568 dc.DrawLine (dash, px, node.Bounds.Top, px, node.Bounds.Bottom);
1570 parent = parent.Parent;
1574 private void DrawNodeImage (TreeNode node, Graphics dc, Rectangle clip, int x, int y)
1576 // Rectangle r = new Rectangle (x, y + 2, ImageList.ImageSize.Width, ImageList.ImageSize.Height);
1578 if (!RectsIntersect (clip, x, y, ImageList.ImageSize.Width, ImageList.ImageSize.Height))
1581 if (ImageList == null)
1586 if (!node.IsSelected) {
1587 if (node.ImageIndex > -1 && node.ImageIndex < ImageList.Images.Count) {
1588 use_index = node.ImageIndex;
1589 } else if (ImageIndex > -1 && ImageIndex < ImageList.Images.Count) {
1590 use_index = ImageIndex;
1593 if (node.SelectedImageIndex > -1 && node.SelectedImageIndex < ImageList.Images.Count) {
1594 use_index = node.SelectedImageIndex;
1595 } else if (SelectedImageIndex > -1 && SelectedImageIndex < ImageList.Images.Count) {
1596 use_index = SelectedImageIndex;
1602 if (!node.IsSelected) {
1603 if (use_index == -1 && !String.IsNullOrEmpty (node.ImageKey)) {
1604 use_index = image_list.Images.IndexOfKey (node.ImageKey);
1607 if (use_index == -1 && !String.IsNullOrEmpty (ImageKey)) {
1608 use_index = image_list.Images.IndexOfKey (ImageKey);
1611 if (use_index == -1 && !String.IsNullOrEmpty (node.SelectedImageKey)) {
1612 use_index = image_list.Images.IndexOfKey (node.SelectedImageKey);
1615 if (use_index == -1 && !String.IsNullOrEmpty (SelectedImageKey)) {
1616 use_index = image_list.Images.IndexOfKey (SelectedImageKey);
1621 if (use_index == -1 && ImageList.Images.Count > 0) {
1625 if (use_index != -1) {
1626 ImageList.Draw (dc, x, y, ImageList.ImageSize.Width,
1627 ImageList.ImageSize.Height, use_index);
1631 private void LabelEditFinished (object sender, EventArgs e)
1633 EndEdit (edit_node);
1636 internal void BeginEdit (TreeNode node)
1638 if (edit_node != null)
1639 EndEdit (edit_node);
1641 if (edit_text_box == null) {
1642 edit_text_box = new LabelEditTextBox ();
1643 edit_text_box.BorderStyle = BorderStyle.FixedSingle;
1644 edit_text_box.Visible = false;
1645 edit_text_box.EditingCancelled += new EventHandler (LabelEditCancelled);
1646 edit_text_box.EditingFinished += new EventHandler (LabelEditFinished);
1647 edit_text_box.TextChanged += new EventHandler (LabelTextChanged);
1648 Controls.Add (edit_text_box);
1651 node.EnsureVisible ();
1653 edit_text_box.Bounds = node.Bounds;
1654 edit_text_box.Text = node.Text;
1655 edit_text_box.Visible = true;
1656 edit_text_box.Focus ();
1657 edit_text_box.SelectAll ();
1659 edit_args = new NodeLabelEditEventArgs (node);
1660 OnBeforeLabelEdit (edit_args);
1664 if (edit_args.CancelEdit) {
1670 private void LabelEditCancelled (object sender, EventArgs e)
1672 edit_args.SetLabel (null);
1673 EndEdit (edit_node);
1676 private void LabelTextChanged (object sender, EventArgs e)
1678 int width = TextRenderer.MeasureTextInternal (edit_text_box.Text, edit_text_box.Font, false).Width + 4;
1679 edit_text_box.Width = width;
1681 if (edit_args != null)
1682 edit_args.SetLabel (edit_text_box.Text);
1685 internal void EndEdit (TreeNode node)
1687 if (edit_text_box != null && edit_text_box.Visible) {
1688 edit_text_box.Visible = false;
1692 if (edit_node != null && edit_node == node) {
1693 NodeLabelEditEventArgs e = new NodeLabelEditEventArgs (edit_args.Node, edit_args.Label);
1695 OnAfterLabelEdit (e);
1700 if (e.Label != null)
1701 edit_node.Text = e.Label;
1708 internal void CancelEdit (TreeNode node)
1710 edit_args.SetLabel (null);
1712 if (edit_text_box != null && edit_text_box.Visible) {
1713 edit_text_box.Visible = false;
1721 internal int GetNodeWidth (TreeNode node)
1723 Font font = node.NodeFont;
1724 if (node.NodeFont == null)
1726 return (int)TextRenderer.MeasureString (node.Text, font, 0, string_format).Width + 3;
1729 private void DrawSelectionAndFocus(TreeNode node, Graphics dc, Rectangle r)
1731 if (Focused && focused_node == node && !full_row_select) {
1732 ControlPaint.DrawFocusRectangle (dc, r, ForeColor, BackColor);
1734 if (draw_mode != TreeViewDrawMode.Normal)
1738 if (Focused && node == highlighted_node) {
1739 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (ThemeEngine.Current.ColorHighlight), r);
1740 } else if (!hide_selection && node == highlighted_node) {
1741 dc.FillRectangle (SystemBrushes.Control, r);
1743 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (node.BackColor), r);
1747 private void DrawStaticNode (TreeNode node, Graphics dc)
1749 if (!full_row_select || show_lines)
1750 DrawSelectionAndFocus(node, dc, node.Bounds);
1753 Font font = node.NodeFont;
1754 if (node.NodeFont == null)
1756 Color text_color = (Focused && node == highlighted_node ?
1757 ThemeEngine.Current.ColorHighlightText : node.ForeColor);
1758 if (text_color.IsEmpty)
1759 text_color = ForeColor;
1760 dc.DrawString (node.Text, font,
1761 ThemeEngine.Current.ResPool.GetSolidBrush (text_color),
1762 node.Bounds, string_format);
1765 private void DrawTreeNode (TreeNode node, Graphics dc, Rectangle clip)
1767 int child_count = node.nodes.Count;
1768 int y = node.GetY ();
1769 int middle = y + (ActualItemHeight / 2);
1771 if (full_row_select && !show_lines) {
1772 Rectangle r = new Rectangle (1, y, ViewportRectangle.Width - 2, ActualItemHeight);
1773 DrawSelectionAndFocus (node, dc, r);
1776 if (draw_mode == TreeViewDrawMode.Normal || draw_mode == TreeViewDrawMode.OwnerDrawText) {
1777 if ((show_root_lines || node.Parent != null) && show_plus_minus && child_count > 0)
1778 DrawNodePlusMinus (node, dc, node.GetLinesX () - Indent + 5, middle);
1781 if (checkboxes && state_image_list == null)
1782 DrawNodeCheckBox (node, dc, CheckBoxLeft (node) - 3, middle);
1784 if (checkboxes && state_image_list != null)
1785 DrawNodeState (node, dc, CheckBoxLeft (node) - 3, y);
1787 if (!checkboxes && node.StateImage != null)
1788 dc.DrawImage (node.StateImage, new Rectangle (CheckBoxLeft (node) - 3, y, 16, 16));
1791 DrawNodeCheckBox (node, dc, CheckBoxLeft (node) - 3, middle);
1795 DrawNodeLines (node, dc, clip, dash, node.GetLinesX (), y, middle);
1797 if (ImageList != null)
1798 DrawNodeImage (node, dc, clip, node.GetImageX (), y);
1803 if (draw_mode != TreeViewDrawMode.Normal) {
1804 dc.FillRectangle (Brushes.White, node.Bounds);
1805 TreeNodeStates tree_node_state = TreeNodeStates.Default;;
1806 if (node.IsSelected)
1807 tree_node_state = TreeNodeStates.Selected;
1809 tree_node_state |= TreeNodeStates.Checked;
1810 if (node == focused_node)
1811 tree_node_state |= TreeNodeStates.Focused;
1812 Rectangle node_bounds = node.Bounds;
1813 if (draw_mode == TreeViewDrawMode.OwnerDrawText) {
1818 node_bounds.Width = Width;
1821 DrawTreeNodeEventArgs e = new DrawTreeNodeEventArgs (dc, node, node_bounds, tree_node_state);
1829 if (!node.IsEditing)
1830 DrawStaticNode (node, dc);
1833 internal void UpdateScrollBars (bool force)
1835 if (!force && (IsDisposed || update_stack > 0 || !IsHandleCreated || !Visible))
1844 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (root_node);
1846 while (walk.MoveNext ()) {
1847 int r = walk.CurrentNode.Bounds.Right;
1848 int b = walk.CurrentNode.Bounds.Bottom;
1856 // Remove scroll adjustments
1857 if (nodes.Count > 0)
1858 height -= nodes [0].Bounds.Top;
1859 width += hbar_offset;
1861 if (height > ClientRectangle.Height) {
1864 if (width > ClientRectangle.Width - SystemInformation.VerticalScrollBarWidth)
1866 } else if (width > ClientRectangle.Width) {
1870 if (!vert && horz && height > ClientRectangle.Height - SystemInformation.HorizontalScrollBarHeight)
1875 int visible_height = horz ? ClientRectangle.Height - hbar.Height : ClientRectangle.Height;
1876 vbar.SetValues (Math.Max (0, max_visible_order - 2), visible_height / ActualItemHeight);
1878 vbar.Maximum = max_visible_order;
1879 vbar.LargeChange = ClientRectangle.Height / ItemHeight;
1882 if (!vbar_bounds_set) {
1883 vbar.Bounds = new Rectangle (ClientRectangle.Width - vbar.Width, 0, vbar.Width,
1884 ClientRectangle.Height -
1885 (horz ? SystemInformation.VerticalScrollBarWidth : 0));
1886 vbar_bounds_set = true;
1888 // We need to recalc the hbar if the vbar is now visible
1889 hbar_bounds_set = false;
1893 vbar.Visible = true;
1894 if (skipped_nodes > 0) {
1895 int skip = Math.Min (skipped_nodes, vbar.Maximum - VisibleCount + 1);
1898 skipped_nodes = skip;
1902 RecalculateVisibleOrder (root_node);
1903 vbar.Visible = false;
1904 vbar_bounds_set = false;
1908 hbar.SetValues (width + 1, ClientRectangle.Width - (vert ? SystemInformation.VerticalScrollBarWidth : 0));
1910 hbar.LargeChange = ClientRectangle.Width;
1911 hbar.Maximum = width + 1;
1914 if (!hbar_bounds_set) {
1915 hbar.Bounds = new Rectangle (0, ClientRectangle.Height - hbar.Height,
1916 ClientRectangle.Width - (vert ? SystemInformation.VerticalScrollBarWidth : 0),
1918 hbar_bounds_set = true;
1920 hbar.Visible = true;
1923 hbar.Visible = false;
1924 hbar_bounds_set = false;
1928 private void SizeChangedHandler (object sender, EventArgs e)
1930 if (IsHandleCreated) {
1931 if (max_visible_order == -1)
1932 RecalculateVisibleOrder (root_node);
1933 UpdateScrollBars (false);
1937 vbar.Bounds = new Rectangle (ClientRectangle.Width - vbar.Width, 0, vbar.Width,
1938 ClientRectangle.Height - (hbar.Visible ? SystemInformation.HorizontalScrollBarHeight : 0));
1942 hbar.Bounds = new Rectangle (0, ClientRectangle.Height - hbar.Height,
1943 ClientRectangle.Width - (vbar.Visible ? SystemInformation.VerticalScrollBarWidth : 0), hbar.Height);
1947 private void VScrollBarValueChanged (object sender, EventArgs e)
1949 EndEdit (edit_node);
1951 SetVScrollPos (vbar.Value, null);
1954 private void SetVScrollPos (int pos, TreeNode new_top)
1959 if (skipped_nodes == pos)
1962 int diff = skipped_nodes - pos;
1963 skipped_nodes = pos;
1965 if (!IsHandleCreated)
1968 int y_move = diff * ActualItemHeight;
1969 XplatUI.ScrollWindow (Handle, ViewportRectangle, 0, y_move, false);
1972 /*private void SetVScrollTop (TreeNode new_top)
1974 vbar.Value = new_top.visible_order - VisibleCount;
1977 private void HScrollBarValueChanged(object sender, EventArgs e)
1979 EndEdit (edit_node);
1981 int old_offset = hbar_offset;
1982 hbar_offset = hbar.Value;
1984 if (hbar_offset < 0) {
1988 XplatUI.ScrollWindow (Handle, ViewportRectangle, old_offset - hbar_offset, 0, false);
1991 internal void ExpandBelow (TreeNode node, int count_to_next)
1993 if (update_stack > 0) {
1994 update_needed = true;
1998 Rectangle below = new Rectangle (0, node.Bounds.Bottom, ViewportRectangle.Width,
1999 ViewportRectangle.Height - node.Bounds.Bottom);
2001 int amount = count_to_next * ActualItemHeight;
2004 XplatUI.ScrollWindow (Handle, below, 0, amount, false);
2006 if (show_plus_minus) {
2007 Invalidate (new Rectangle (0, node.GetY (), Width, ActualItemHeight));
2011 internal void CollapseBelow (TreeNode node, int count_to_next)
2013 if (update_stack > 0) {
2014 update_needed = true;
2018 Rectangle below = new Rectangle (0, node.Bounds.Bottom, ViewportRectangle.Width,
2019 ViewportRectangle.Height - node.Bounds.Bottom);
2021 int amount = count_to_next * ActualItemHeight;
2024 XplatUI.ScrollWindow (Handle, below, 0, -amount, false);
2026 if (show_plus_minus) {
2027 Invalidate (new Rectangle (0, node.GetY (), Width, ActualItemHeight));
2031 private void MouseWheelHandler(object sender, MouseEventArgs e) {
2033 if (vbar == null || !vbar.is_visible) {
2038 vbar.Value = Math.Min(vbar.Value + SystemInformation.MouseWheelScrollLines, vbar.Maximum - VisibleCount + 1);
2040 vbar.Value = Math.Max(0, vbar.Value - SystemInformation.MouseWheelScrollLines);
2044 private void VisibleChangedHandler (object sender, EventArgs e)
2047 UpdateScrollBars (false);
2051 private void FontChangedHandler (object sender, EventArgs e)
2053 if (IsHandleCreated) {
2054 TreeNode top = TopNode;
2055 InvalidateNodeWidthRecursive (root_node);
2061 private void InvalidateNodeWidthRecursive (TreeNode node)
2063 node.InvalidateWidth ();
2064 foreach (TreeNode child in node.Nodes) {
2065 InvalidateNodeWidthRecursive (child);
2069 private void GotFocusHandler (object sender, EventArgs e)
2071 if (selected_node == null) {
2072 if (pre_selected_node != null) {
2073 SelectedNode = pre_selected_node;
2077 SelectedNode = TopNode;
2079 } else if (selected_node != null)
2080 UpdateNode (selected_node);
2083 private void LostFocusHandler (object sender, EventArgs e)
2085 UpdateNode (SelectedNode);
2088 private void MouseDownHandler (object sender, MouseEventArgs e)
2090 if (e.Button == MouseButtons.Right)
2093 TreeNode node = GetNodeAt (e.Y);
2098 mouse_click_node = node;
2101 if (show_plus_minus && IsPlusMinusArea (node, e.X)) {
2104 } else if (checkboxes && IsCheckboxArea (node, e.X)) {
2105 node.check_reason = TreeViewAction.ByMouse;
2106 node.Checked = !node.Checked;
2109 } else if (IsSelectableArea (node, e.X) || full_row_select) {
2110 TreeNode old_highlighted = highlighted_node;
2111 highlighted_node = node;
2112 if (label_edit && e.Clicks == 1 && highlighted_node == old_highlighted) {
2114 } else if (highlighted_node != focused_node) {
2115 Size ds = SystemInformation.DragSize;
2116 mouse_rect.X = e.X - ds.Width;
2117 mouse_rect.Y = e.Y - ds.Height;
2118 mouse_rect.Width = ds.Width * 2;
2119 mouse_rect.Height = ds.Height * 2;
2121 select_mmove = true;
2124 Invalidate (highlighted_node.Bounds);
2125 if (old_highlighted != null)
2126 Invalidate (Bloat (old_highlighted.Bounds));
2130 private void MouseUpHandler (object sender, MouseEventArgs e) {
2132 TreeNode node = GetNodeAt (e.Y);
2134 if (node != null && node == mouse_click_node) {
2136 OnNodeMouseDoubleClick (new TreeNodeMouseClickEventArgs (node, e.Button, e.Clicks, e.X, e.Y));
2138 OnNodeMouseClick (new TreeNodeMouseClickEventArgs (node, e.Button, e.Clicks, e.X, e.Y));
2141 mouse_click_node = null;
2150 select_mmove = false;
2152 if (e.Button == MouseButtons.Right && selected_node != null) {
2153 Invalidate (highlighted_node.Bounds);
2154 highlighted_node = selected_node;
2155 Invalidate (selected_node.Bounds);
2159 TreeViewCancelEventArgs ce = new TreeViewCancelEventArgs (highlighted_node, false, TreeViewAction.ByMouse);
2160 OnBeforeSelect (ce);
2164 TreeNode prev_focused_node = focused_node;
2165 TreeNode prev_highlighted_node = highlighted_node;
2167 selected_node = highlighted_node;
2168 focused_node = highlighted_node;
2169 OnAfterSelect (new TreeViewEventArgs (selected_node, TreeViewAction.ByMouse));
2171 if (prev_focused_node != null) {
2172 invalid = Rectangle.Union (Bloat (prev_focused_node.Bounds),
2173 Bloat (prev_highlighted_node.Bounds));
2175 invalid = Bloat (prev_highlighted_node.Bounds);
2178 if (full_row_select || draw_mode != TreeViewDrawMode.Normal) {
2180 invalid.Width = ViewportRectangle.Width;
2183 Invalidate (invalid);
2185 highlighted_node = focused_node;
2186 selected_node = focused_node;
2190 private void MouseMoveHandler (object sender, MouseEventArgs e) {
2192 // XXX - This should use HitTest and only fire when we are over
2193 // the important parts of a node, not things like gridlines or
2195 TreeNode tn = GetNodeAt (e.Location);
2197 if (tn != tooltip_currently_showing)
2198 MouseLeftItem (tooltip_currently_showing);
2200 if (tn != null && tn != tooltip_currently_showing)
2201 MouseEnteredItem (tn);
2204 if (e.Button == MouseButtons.Left || e.Button == MouseButtons.Right) {
2205 if (drag_begin_x == -1 && drag_begin_y == -1) {
2209 double rise = Math.Pow (drag_begin_x - e.X, 2);
2210 double run = Math.Pow (drag_begin_y - e.Y, 2);
2211 double move = Math.Sqrt (rise + run);
2213 TreeNode drag = GetNodeAtUseX (e.X, e.Y);
2216 OnItemDrag (new ItemDragEventArgs (e.Button, drag));
2225 // If there is enough movement before the mouse comes up,
2226 // selection is reverted back to the originally selected node
2227 if (!select_mmove || mouse_rect.Contains (e.X, e.Y))
2230 Invalidate (highlighted_node.Bounds);
2231 Invalidate (selected_node.Bounds);
2232 Invalidate (focused_node.Bounds);
2234 highlighted_node = selected_node;
2235 focused_node = selected_node;
2237 select_mmove = false;
2240 private void DoubleClickHandler (object sender, MouseEventArgs e) {
2241 TreeNode node = GetNodeAtUseX (e.X,e.Y);
2248 private bool RectsIntersect (Rectangle r, int left, int top, int width, int height)
2250 return !((r.Left > left + width) || (r.Right < left) ||
2251 (r.Top > top + height) || (r.Bottom < top));
2255 // Return true if message was handled, false to send it to base
2256 private bool WmContextMenu (ref Message m)
2261 pt = new Point (LowOrder ((int)m.LParam.ToInt32 ()), HighOrder ((int)m.LParam.ToInt32 ()));
2263 // This means it's a keyboard menu request
2264 if (pt.X == -1 || pt.Y == -1) {
2270 pt = new Point (tn.Bounds.Left, tn.Bounds.Top + (tn.Bounds.Height / 2));
2272 pt = PointToClient (pt);
2274 tn = GetNodeAt (pt);
2280 // At this point, we have a valid TreeNode
2281 if (tn.ContextMenu != null) {
2282 tn.ContextMenu.Show (this, pt);
2284 } else if (tn.ContextMenuStrip != null) {
2285 tn.ContextMenuStrip.Show (this, pt);
2289 // The node we found did not have its own menu, let the parent try to display its menu
2294 #region Stuff for ToolTips
2296 private void MouseEnteredItem (TreeNode item)
2298 tooltip_currently_showing = item;
2303 if (ShowNodeToolTips && !string.IsNullOrEmpty (tooltip_currently_showing.ToolTipText))
2304 ToolTipWindow.Present (this, tooltip_currently_showing.ToolTipText);
2306 OnNodeMouseHover (new TreeNodeMouseHoverEventArgs (tooltip_currently_showing));
2309 private void MouseLeftItem (TreeNode item)
2311 ToolTipWindow.Hide (this);
2312 tooltip_currently_showing = null;
2315 private ToolTip ToolTipWindow {
2317 if (tooltip_window == null)
2318 tooltip_window = new ToolTip ();
2320 return tooltip_window;
2326 #endregion // Internal & Private Methods and Properties
2329 static object ItemDragEvent = new object ();
2330 static object AfterCheckEvent = new object ();
2331 static object AfterCollapseEvent = new object ();
2332 static object AfterExpandEvent = new object ();
2333 static object AfterLabelEditEvent = new object ();
2334 static object AfterSelectEvent = new object ();
2335 static object BeforeCheckEvent = new object ();
2336 static object BeforeCollapseEvent = new object ();
2337 static object BeforeExpandEvent = new object ();
2338 static object BeforeLabelEditEvent = new object ();
2339 static object BeforeSelectEvent = new object ();
2341 static object DrawNodeEvent = new object ();
2342 static object NodeMouseClickEvent = new object ();
2343 static object NodeMouseDoubleClickEvent = new object();
2344 static object NodeMouseHoverEvent = new object ();
2345 static object RightToLeftLayoutChangedEvent = new object ();
2348 public event ItemDragEventHandler ItemDrag {
2349 add { Events.AddHandler (ItemDragEvent, value); }
2350 remove { Events.RemoveHandler (ItemDragEvent, value); }
2353 public event TreeViewEventHandler AfterCheck {
2354 add { Events.AddHandler (AfterCheckEvent, value); }
2355 remove { Events.RemoveHandler (AfterCheckEvent, value); }
2358 public event TreeViewEventHandler AfterCollapse {
2359 add { Events.AddHandler (AfterCollapseEvent, value); }
2360 remove { Events.RemoveHandler (AfterCollapseEvent, value); }
2363 public event TreeViewEventHandler AfterExpand {
2364 add { Events.AddHandler (AfterExpandEvent, value); }
2365 remove { Events.RemoveHandler (AfterExpandEvent, value); }
2368 public event NodeLabelEditEventHandler AfterLabelEdit {
2369 add { Events.AddHandler (AfterLabelEditEvent, value); }
2370 remove { Events.RemoveHandler (AfterLabelEditEvent, value); }
2373 public event TreeViewEventHandler AfterSelect {
2374 add { Events.AddHandler (AfterSelectEvent, value); }
2375 remove { Events.RemoveHandler (AfterSelectEvent, value); }
2378 public event TreeViewCancelEventHandler BeforeCheck {
2379 add { Events.AddHandler (BeforeCheckEvent, value); }
2380 remove { Events.RemoveHandler (BeforeCheckEvent, value); }
2383 public event TreeViewCancelEventHandler BeforeCollapse {
2384 add { Events.AddHandler (BeforeCollapseEvent, value); }
2385 remove { Events.RemoveHandler (BeforeCollapseEvent, value); }
2388 public event TreeViewCancelEventHandler BeforeExpand {
2389 add { Events.AddHandler (BeforeExpandEvent, value); }
2390 remove { Events.RemoveHandler (BeforeExpandEvent, value); }
2393 public event NodeLabelEditEventHandler BeforeLabelEdit {
2394 add { Events.AddHandler (BeforeLabelEditEvent, value); }
2395 remove { Events.RemoveHandler (BeforeLabelEditEvent, value); }
2398 public event TreeViewCancelEventHandler BeforeSelect {
2399 add { Events.AddHandler (BeforeSelectEvent, value); }
2400 remove { Events.RemoveHandler (BeforeSelectEvent, value); }
2404 public event DrawTreeNodeEventHandler DrawNode {
2405 add { Events.AddHandler (DrawNodeEvent, value); }
2406 remove { Events.RemoveHandler (DrawNodeEvent, value); }
2409 public event TreeNodeMouseClickEventHandler NodeMouseClick {
2410 add { Events.AddHandler (NodeMouseClickEvent, value); }
2411 remove { Events.RemoveHandler (NodeMouseClickEvent, value); }
2415 public event TreeNodeMouseClickEventHandler NodeMouseDoubleClick {
2416 add { Events.AddHandler (NodeMouseDoubleClickEvent, value); }
2417 remove { Events.RemoveHandler (NodeMouseDoubleClickEvent, value); }
2420 public event TreeNodeMouseHoverEventHandler NodeMouseHover {
2421 add { Events.AddHandler (NodeMouseHoverEvent, value); }
2422 remove { Events.RemoveHandler (NodeMouseHoverEvent, value); }
2425 public event EventHandler RightToLeftLayoutChanged {
2426 add { Events.AddHandler (RightToLeftLayoutChangedEvent, value); }
2427 remove { Events.RemoveHandler (RightToLeftLayoutChangedEvent, value); }
2432 [EditorBrowsable (EditorBrowsableState.Never)]
2433 public new event EventHandler BackgroundImageChanged {
2434 add { base.BackgroundImageChanged += value; }
2435 remove { base.BackgroundImageChanged -= value; }
2440 [EditorBrowsable (EditorBrowsableState.Never)]
2441 public new event EventHandler BackgroundImageLayoutChanged {
2442 add { base.BackgroundImageLayoutChanged += value; }
2443 remove { base.BackgroundImageLayoutChanged -= value; }
2447 [EditorBrowsable (EditorBrowsableState.Never)]
2448 public new event EventHandler PaddingChanged {
2449 add { base.PaddingChanged += value; }
2450 remove { base.PaddingChanged -= value; }
2454 [EditorBrowsable (EditorBrowsableState.Never)]
2456 public new event PaintEventHandler Paint {
2457 add { base.Paint += value; }
2458 remove { base.Paint -= value; }
2461 [EditorBrowsable (EditorBrowsableState.Never)]
2463 public new event EventHandler TextChanged {
2464 add { base.TextChanged += value; }
2465 remove { base.TextChanged -= value; }
2467 #endregion // Events