mcs/class/Managed.Windows.Forms/System.Windows.Forms/ToolStrip.cs

   1 //
   2 // ToolStrip.cs
   3 //
   4 // Permission is hereby granted, free of charge, to any person obtaining
   5 // a copy of this software and associated documentation files (the
   6 // "Software"), to deal in the Software without restriction, including
   7 // without limitation the rights to use, copy, modify, merge, publish,
   8 // distribute, sublicense, and/or sell copies of the Software, and to
   9 // permit persons to whom the Software is furnished to do so, subject to
  10 // the following conditions:
  11 //
  12 // The above copyright notice and this permission notice shall be
  13 // included in all copies or substantial portions of the Software.
  14 //
  15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  19 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  20 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22 //
  23 // Copyright (c) 2006 Jonathan Pobst
  24 //
  25 // Authors:
  26 //      Jonathan Pobst (monkey@jpobst.com)
  27 //
  28
  29 #if NET_2_0
  30 using System;
  31 using System.Runtime.InteropServices;
  32 using System.ComponentModel;
  33 using System.Drawing;
  34 using System.Windows.Forms.Layout;
  35 using System.Collections.Generic;
  36 using System.ComponentModel.Design.Serialization;
  37
  38 namespace System.Windows.Forms
  39 {
  40         [ComVisible (true)]
  41         [ClassInterface (ClassInterfaceType.AutoDispatch)]
  42         [DefaultEvent ("ItemClicked")]
  43         [DefaultProperty ("Items")]
  44         [Designer ("System.Windows.Forms.Design.ToolStripDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
  45         [DesignerSerializer ("System.Windows.Forms.Design.ToolStripCodeDomSerializer, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.Serialization.CodeDomSerializer, " + Consts.AssemblySystem_Design)]
  46         public class ToolStrip : ScrollableControl, IComponent, IDisposable
  47         {
  48                 #region Private Variables
  49                 private bool allow_item_reorder;
  50                 private bool allow_merge;
  51                 private Color back_color;
  52                 private bool can_overflow;
  53                 private ToolStrip currently_merged_with;
  54                 private ToolStripDropDownDirection default_drop_down_direction;
  55                 internal ToolStripItemCollection displayed_items;
  56                 private Color fore_color;
  57                 private Padding grip_margin;
  58                 private ToolStripGripStyle grip_style;
  59                 private List<ToolStripItem> hidden_merged_items;
  60                 private ImageList image_list;
  61                 private Size image_scaling_size;
  62                 private bool is_currently_merged;
  63                 private ToolStripItemCollection items;
  64                 private bool keyboard_active;
  65                 private LayoutEngine layout_engine;
  66                 private LayoutSettings layout_settings;
  67                 private ToolStripLayoutStyle layout_style;
  68                 private Orientation orientation;
  69                 private ToolStripOverflowButton overflow_button;
  70                 private List<ToolStripItem> pre_merge_items;
  71                 private ToolStripRenderer renderer;
  72                 private ToolStripRenderMode render_mode;
  73                 private ToolStripTextDirection text_direction;
  74                 private Timer tooltip_timer;
  75                 private ToolTip tooltip_window;
  76                 private bool show_item_tool_tips;
  77                 private bool stretch;
  78
  79                 private ToolStripItem mouse_currently_over;
  80                 internal bool menu_selected;
  81                 private ToolStripItem tooltip_currently_showing;
  82                 #endregion
  83
  84                 #region Public Constructors
  85                 public ToolStrip () : this (null)
  86                 {
  87                 }
  88
  89                 public ToolStrip (params ToolStripItem[] items) : base ()
  90                 {
  91                         SetStyle (ControlStyles.AllPaintingInWmPaint, true);
  92                         SetStyle (ControlStyles.OptimizedDoubleBuffer, true);
  93                         SetStyle (ControlStyles.Selectable, false);
  94                         SetStyle (ControlStyles.SupportsTransparentBackColor, true);
  95
  96                         this.SuspendLayout ();
  97
  98                         this.items = new ToolStripItemCollection (this, items, true);
  99                         this.allow_merge = true;
 100                         base.AutoSize = true;
 101                         this.SetAutoSizeMode (AutoSizeMode.GrowAndShrink);
 102                         this.back_color = Control.DefaultBackColor;
 103                         this.can_overflow = true;
 104                         base.CausesValidation = false;
 105                         this.default_drop_down_direction = ToolStripDropDownDirection.BelowRight;
 106                         this.displayed_items = new ToolStripItemCollection (this, null, true);
 107                         this.Dock = this.DefaultDock;
 108                         base.Font = new Font ("Tahoma", 8.25f);
 109                         this.fore_color = Control.DefaultForeColor;
 110                         this.grip_margin = this.DefaultGripMargin;
 111                         this.grip_style = ToolStripGripStyle.Visible;
 112                         this.image_scaling_size = new Size (16, 16);
 113                         this.layout_style = ToolStripLayoutStyle.HorizontalStackWithOverflow;
 114                         this.orientation = Orientation.Horizontal;
 115                         if (!(this is ToolStripDropDown))
 116                                 this.overflow_button = new ToolStripOverflowButton (this);
 117                         this.renderer = null;
 118                         this.render_mode = ToolStripRenderMode.ManagerRenderMode;
 119                         this.show_item_tool_tips = this.DefaultShowItemToolTips;
 120                         base.TabStop = false;
 121                         this.text_direction = ToolStripTextDirection.Horizontal;
 122                         this.ResumeLayout ();
 123
 124                         // Register with the ToolStripManager
 125                         ToolStripManager.AddToolStrip (this);
 126                 }
 127                 #endregion
 128
 129                 #region Public Properties
 130                 [MonoTODO ()]
 131                 public override bool AllowDrop {
 132                         get { return base.AllowDrop; }
 133                         set { base.AllowDrop = value; }
 134                 }
 135
 136                 [MonoTODO ()]
 137                 [DefaultValue (false)]
 138                 public bool AllowItemReorder {
 139                         get { return this.allow_item_reorder; }
 140                         set { this.allow_item_reorder = value; }
 141                 }
 142
 143                 [DefaultValue (true)]
 144                 public bool AllowMerge {
 145                         get { return this.allow_merge; }
 146                         set { this.allow_merge = false; }
 147                 }
 148
 149                 public override AnchorStyles Anchor {
 150                         get { return base.Anchor; }
 151                         set { base.Anchor = value; }
 152                 }
 153
 154                 [Browsable (false)]
 155                 [EditorBrowsable (EditorBrowsableState.Never)]
 156                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 157                 public override bool AutoScroll {
 158                         get { return base.AutoScroll; }
 159                         set { base.AutoScroll = value; }
 160                 }
 161
 162                 [Browsable (false)]
 163                 [EditorBrowsable (EditorBrowsableState.Never)]
 164                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 165                 public new Size AutoScrollMargin {
 166                         get { return base.AutoScrollMargin; }
 167                         set { base.AutoScrollMargin = value; }
 168                 }
 169
 170                 [Browsable (false)]
 171                 [EditorBrowsable (EditorBrowsableState.Never)]
 172                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 173                 public new Size AutoScrollMinSize {
 174                         get { return base.AutoScrollMinSize; }
 175                         set { base.AutoScrollMinSize = value; }
 176                 }
 177
 178                 [Browsable (false)]
 179                 [EditorBrowsable (EditorBrowsableState.Never)]
 180                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 181                 public new Point AutoScrollPosition {
 182                         get { return base.AutoScrollPosition; }
 183                         set { base.AutoScrollPosition = value; }
 184                 }
 185
 186                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Visible)]
 187                 [Browsable (true)]
 188                 [EditorBrowsable (EditorBrowsableState.Always)]
 189                 [DefaultValue (true)]
 190                 public override bool AutoSize {
 191                         get { return base.AutoSize; }
 192                         set { base.AutoSize = value; }
 193                 }
 194
 195                 new public Color BackColor {
 196                         get { return this.back_color; }
 197                         set { this.back_color = value; }
 198                 }
 199
 200                 public override BindingContext BindingContext {
 201                         get { return base.BindingContext; }
 202                         set { base.BindingContext = value; }
 203                 }
 204
 205                 [DefaultValue (true)]
 206                 public bool CanOverflow {
 207                         get { return this.can_overflow; }
 208                         set { this.can_overflow = value; }
 209                 }
 210
 211                 [Browsable (false)]
 212                 [DefaultValue (false)]
 213                 public new bool CausesValidation {
 214                         get { return base.CausesValidation; }
 215                         set { base.CausesValidation = value; }
 216                 }
 217
 218                 [EditorBrowsable (EditorBrowsableState.Never)]
 219                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 220                 public new ControlCollection Controls {
 221                         get { return base.Controls; }
 222                 }
 223
 224                 [Browsable (false)]
 225                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 226                 public override Cursor Cursor {
 227                         get { return base.Cursor; }
 228                         set { base.Cursor = value; }
 229                 }
 230
 231                 [Browsable (false)]
 232                 public virtual ToolStripDropDownDirection DefaultDropDownDirection {
 233                         get { return this.default_drop_down_direction; }
 234                         set {
 235                                 if (!Enum.IsDefined (typeof (ToolStripDropDownDirection), value))
 236                                         throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ToolStripDropDownDirection", value));
 237
 238                                 this.default_drop_down_direction = value;
 239                         }
 240                 }
 241
 242                 public override Rectangle DisplayRectangle {
 243                         get {
 244                                 if (this.orientation == Orientation.Horizontal)
 245                                         if (this.grip_style == ToolStripGripStyle.Hidden || this.layout_style == ToolStripLayoutStyle.Flow || this.layout_style == ToolStripLayoutStyle.Table)
 246                                                 return new Rectangle (this.Padding.Left, this.Padding.Top, this.Width - this.Padding.Horizontal, this.Height - this.Padding.Vertical);
 247                                         else
 248                                                 return new Rectangle (this.GripRectangle.Right + this.GripMargin.Right, this.Padding.Top, this.Width - this.Padding.Horizontal - this.GripRectangle.Right - this.GripMargin.Right, this.Height - this.Padding.Vertical);
 249                                 else
 250                                         if (this.grip_style == ToolStripGripStyle.Hidden || this.layout_style == ToolStripLayoutStyle.Flow || this.layout_style == ToolStripLayoutStyle.Table)
 251                                                 return new Rectangle (this.Padding.Left, this.Padding.Top, this.Width - this.Padding.Horizontal, this.Height - this.Padding.Vertical);
 252                                         else
 253                                                 return new Rectangle (this.Padding.Left, this.GripRectangle.Bottom + this.GripMargin.Bottom + this.Padding.Top, this.Width - this.Padding.Horizontal, this.Height - this.Padding.Vertical - this.GripRectangle.Bottom - this.GripMargin.Bottom);
 254                         }
 255                 }
 256
 257                 [DefaultValue (DockStyle.Top)]
 258                 public override DockStyle Dock {
 259                         get { return base.Dock; }
 260                         set {
 261                                 if (base.Dock != value) {
 262                                         base.Dock = value;
 263
 264                                         switch (value) {
 265                                                 case DockStyle.Top:
 266                                                 case DockStyle.Bottom:
 267                                                 case DockStyle.None:
 268                                                         this.LayoutStyle = ToolStripLayoutStyle.HorizontalStackWithOverflow;
 269                                                         break;
 270                                                 case DockStyle.Left:
 271                                                 case DockStyle.Right:
 272                                                         this.LayoutStyle = ToolStripLayoutStyle.VerticalStackWithOverflow;
 273                                                         break;
 274                                         }
 275                                 }
 276                         }
 277                 }
 278
 279                 public override Font Font {
 280                         get { return base.Font; }
 281                         set {
 282                                 if (base.Font != value) {
 283                                         base.Font = value;
 284
 285                                         foreach (ToolStripItem tsi in this.Items)
 286                                                 tsi.OnOwnerFontChanged (EventArgs.Empty);
 287                                 }
 288                          }
 289                 }
 290
 291                 [Browsable (false)]
 292                 public new Color ForeColor {
 293                         get { return this.fore_color; }
 294                         set {
 295                                 if (this.fore_color != value) {
 296                                         this.fore_color = value;
 297                                         this.OnForeColorChanged (EventArgs.Empty);
 298                                 }
 299                         }
 300                 }
 301
 302                 [Browsable (false)]
 303                 public ToolStripGripDisplayStyle GripDisplayStyle {
 304                         get { return this.orientation == Orientation.Vertical ? ToolStripGripDisplayStyle.Horizontal : ToolStripGripDisplayStyle.Vertical; }
 305                 }
 306
 307                 public Padding GripMargin {
 308                         get { return this.grip_margin; }
 309                         set {
 310                                 if (this.grip_margin != value) {
 311                                         this.grip_margin = value;
 312                                         this.PerformLayout ();
 313                                 }
 314                         }
 315                 }
 316
 317                 [Browsable (false)]
 318                 public Rectangle GripRectangle {
 319                         get {
 320                                 if (this.grip_style == ToolStripGripStyle.Hidden)
 321                                         return Rectangle.Empty;
 322
 323                                 if (this.orientation == Orientation.Horizontal)
 324                                         return new Rectangle (this.grip_margin.Left + this.Padding.Left, this.Padding.Top, 3, this.Height);
 325                                 else
 326                                         return new Rectangle (this.Padding.Left, this.grip_margin.Top + this.Padding.Top, this.Width, 3);
 327                         }
 328                 }
 329
 330                 [DefaultValue (ToolStripGripStyle.Visible)]
 331                 public ToolStripGripStyle GripStyle {
 332                         get { return this.grip_style; }
 333                         set {
 334                                 if (this.grip_style != value) {
 335                                         if (!Enum.IsDefined (typeof (ToolStripGripStyle), value))
 336                                                 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ToolStripGripStyle", value));
 337                                         this.grip_style = value;
 338                                         this.PerformLayout ();
 339                                 }
 340                         }
 341                 }
 342
 343                 [Browsable (false)]
 344                 [EditorBrowsable (EditorBrowsableState.Never)]
 345                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 346                 public new bool HasChildren {
 347                         get { return base.HasChildren; }
 348                 }
 349
 350                 [Browsable (false)]
 351                 [EditorBrowsable (EditorBrowsableState.Never)]
 352                 public new HScrollProperties HorizontalScroll {
 353                         get { return base.HorizontalScroll; }
 354                 }
 355
 356                 [Browsable (false)]
 357                 [DefaultValue (null)]
 358                 public ImageList ImageList {
 359                         get { return this.image_list; }
 360                         set { this.image_list = value; }
 361                 }
 362
 363                 [DefaultValue ("{Width=16, Height=16}")]
 364                 public Size ImageScalingSize {
 365                         get { return this.image_scaling_size; }
 366                         set { this.image_scaling_size = value; }
 367                 }
 368
 369                 [MonoTODO ("Always returns false, dragging not implemented yet.")]
 370                 [Browsable (false)]
 371                 [EditorBrowsable (EditorBrowsableState.Advanced)]
 372                 public bool IsCurrentlyDragging {
 373                         get { return false; }
 374                 }
 375
 376                 [Browsable (false)]
 377                 public bool IsDropDown {
 378                         get {
 379                                 if (this is ToolStripDropDown)
 380                                         return true;
 381
 382                                 return false;
 383                         }
 384                 }
 385
 386                 [MergableProperty (false)]
 387                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Content)]
 388                 public virtual ToolStripItemCollection Items {
 389                         get { return this.items; }
 390                 }
 391
 392                 public override LayoutEngine LayoutEngine {
 393                         get {
 394                                  if (layout_engine == null)
 395                                         this.layout_engine = new ToolStripSplitStackLayout ();
 396
 397                                  return this.layout_engine;
 398                         }
 399                 }
 400
 401                 [Browsable (false)]
 402                 [DefaultValue (null)]
 403                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 404                 public LayoutSettings LayoutSettings {
 405                         get { return this.layout_settings; }
 406                         set { this.layout_settings = value; }
 407                 }
 408
 409                 [AmbientValue (ToolStripLayoutStyle.StackWithOverflow)]
 410                 public ToolStripLayoutStyle LayoutStyle {
 411                         get { return layout_style; }
 412                         set {
 413                                 if (this.layout_style != value) {
 414                                         if (!Enum.IsDefined (typeof (ToolStripLayoutStyle), value))
 415                                                 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ToolStripLayoutStyle", value));
 416
 417                                         this.layout_style = value;
 418
 419                                         if (this.layout_style == ToolStripLayoutStyle.Flow)
 420                                                 this.layout_engine = new FlowLayout ();
 421                                         else
 422                                                 this.layout_engine = new ToolStripSplitStackLayout ();
 423
 424                                         if (this.layout_style == ToolStripLayoutStyle.StackWithOverflow) {
 425                                                 if (this.Dock == DockStyle.Left || this.Dock == DockStyle.Right)
 426                                                         this.layout_style = ToolStripLayoutStyle.VerticalStackWithOverflow;
 427                                                 else
 428                                                         this.layout_style = ToolStripLayoutStyle.HorizontalStackWithOverflow;
 429                                         }
 430
 431                                         if (this.layout_style == ToolStripLayoutStyle.HorizontalStackWithOverflow)
 432                                                 this.orientation = Orientation.Horizontal;
 433                                         else if (this.layout_style == ToolStripLayoutStyle.VerticalStackWithOverflow)
 434                                                 this.orientation = Orientation.Vertical;
 435
 436                                         this.layout_settings = this.CreateLayoutSettings (value);
 437
 438                                         this.PerformLayout ();
 439                                         this.OnLayoutStyleChanged (EventArgs.Empty);
 440                                 }
 441                         }
 442                 }
 443
 444                 [Browsable (false)]
 445                 public Orientation Orientation {
 446                         get { return this.orientation; }
 447                 }
 448
 449                 [Browsable (false)]
 450                 [EditorBrowsable (EditorBrowsableState.Advanced)]
 451                 public ToolStripOverflowButton OverflowButton {
 452                         get { return this.overflow_button; }
 453                 }
 454
 455                 [Browsable (false)]
 456                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 457                 public ToolStripRenderer Renderer {
 458                         get {
 459                                 if (this.render_mode == ToolStripRenderMode.ManagerRenderMode)
 460                                         return ToolStripManager.Renderer;
 461
 462                                 return this.renderer;
 463                         }
 464                         set {
 465                                 if (this.renderer != value) {
 466                                         this.renderer = value;
 467                                         this.render_mode = ToolStripRenderMode.Custom;
 468                                         this.PerformLayout ();
 469                                         this.OnRendererChanged (EventArgs.Empty);
 470                                 }
 471                         }
 472                 }
 473
 474                 public ToolStripRenderMode RenderMode {
 475                         get { return this.render_mode; }
 476                         set {
 477                                 if (!Enum.IsDefined (typeof (ToolStripRenderMode), value))
 478                                         throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ToolStripRenderMode", value));
 479
 480                                 if (value == ToolStripRenderMode.Custom && this.renderer == null)
 481                                         throw new NotSupportedException ("Must set Renderer property before setting RenderMode to Custom");
 482                                 else if (value == ToolStripRenderMode.Professional)
 483                                         this.Renderer = new ToolStripProfessionalRenderer ();
 484                                 else if (value == ToolStripRenderMode.System)
 485                                         this.Renderer = new ToolStripSystemRenderer ();
 486
 487                                 this.render_mode = value;
 488                         }
 489                 }
 490
 491                 [DefaultValue (true)]
 492                 public bool ShowItemToolTips {
 493                         get { return this.show_item_tool_tips; }
 494                         set { this.show_item_tool_tips = value; }
 495                 }
 496
 497                 [DefaultValue (false)]
 498                 public bool Stretch {
 499                         get { return this.stretch; }
 500                         set { this.stretch = value; }
 501                 }
 502
 503                 [DefaultValue (false)]
 504                 [DispId(-516)]
 505                 public new bool TabStop {
 506                         get { return base.TabStop; }
 507                         set {
 508                                 base.TabStop = value;
 509                                 SetStyle (ControlStyles.Selectable, value);
 510                         }
 511                 }
 512
 513                 [DefaultValue (ToolStripTextDirection.Horizontal)]
 514                 public virtual ToolStripTextDirection TextDirection {
 515                         get { return this.text_direction; }
 516                         set {
 517                                 if (!Enum.IsDefined (typeof (ToolStripTextDirection), value))
 518                                         throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ToolStripTextDirection", value));
 519
 520                                 if (this.text_direction != value) {
 521                                         this.text_direction = value;
 522
 523                                         this.PerformLayout (this, "TextDirection");
 524
 525                                         this.Invalidate ();
 526                                 }
 527                         }
 528                 }
 529
 530                 [Browsable (false)]
 531                 [EditorBrowsable (EditorBrowsableState.Never)]
 532                 public new VScrollProperties VerticalScroll {
 533                         get { return base.VerticalScroll; }
 534                 }
 535                 #endregion
 536
 537                 #region Protected Properties
 538                 protected virtual DockStyle DefaultDock { get { return DockStyle.Top; } }
 539                 protected virtual Padding DefaultGripMargin { get { return new Padding (2); } }
 540                 protected override Padding DefaultMargin { get { return Padding.Empty; } }
 541                 protected override Padding DefaultPadding { get { return new Padding (0, 0, 1, 0); } }
 542                 protected virtual bool DefaultShowItemToolTips { get { return true; } }
 543                 protected override Size DefaultSize { get { return new Size (100, 25); } }
 544                 protected internal virtual ToolStripItemCollection DisplayedItems { get { return this.displayed_items; } }
 545                 protected internal virtual Size MaxItemSize {
 546                         get { return new Size (Width - (GripStyle == ToolStripGripStyle.Hidden ? 1 : 8), Height); }
 547                 }
 548                 #endregion
 549
 550                 #region Public Methods
 551                 [EditorBrowsable (EditorBrowsableState.Never)]
 552                 public new Control GetChildAtPoint (Point point)
 553                 {
 554                         return base.GetChildAtPoint (point);
 555                 }
 556
 557                 [EditorBrowsable (EditorBrowsableState.Never)]
 558                 public new Control GetChildAtPoint (Point pt, GetChildAtPointSkip skipValue)
 559                 {
 560                         return base.GetChildAtPoint (pt, skipValue);
 561                 }
 562
 563                 public ToolStripItem GetItemAt (Point point)
 564                 {
 565                         foreach (ToolStripItem tsi in this.displayed_items)
 566                                 if (tsi.Visible && tsi.Bounds.Contains (point))
 567                                         return tsi;
 568
 569                         return null;
 570                 }
 571
 572                 public ToolStripItem GetItemAt (int x, int y)
 573                 {
 574                         return GetItemAt (new Point (x, y));
 575                 }
 576
 577                 public virtual ToolStripItem GetNextItem (ToolStripItem start, ArrowDirection direction)
 578                 {
 579                         if (!Enum.IsDefined (typeof (ArrowDirection), direction))
 580                                 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ArrowDirection", direction));
 581
 582                         ToolStripItem current_best = null;
 583                         int current_best_point;
 584
 585                         switch (direction) {
 586                                 case ArrowDirection.Right:
 587                                         current_best_point = int.MaxValue;
 588
 589                                         if (start != null)
 590                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 591                                                         if (loop_tsi.Left >= start.Right && loop_tsi.Left < current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 592                                                                 current_best = loop_tsi;
 593                                                                 current_best_point = loop_tsi.Left;
 594                                                         }
 595
 596                                         if (current_best == null)
 597                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 598                                                         if (loop_tsi.Left < current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 599                                                                 current_best = loop_tsi;
 600                                                                 current_best_point = loop_tsi.Left;
 601                                                         }
 602
 603                                         break;
 604                                 case ArrowDirection.Up:
 605                                         current_best_point = int.MinValue;
 606
 607                                         if (start != null)
 608                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 609                                                         if (loop_tsi.Bottom <= start.Top && loop_tsi.Top > current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 610                                                                 current_best = loop_tsi;
 611                                                                 current_best_point = loop_tsi.Top;
 612                                                         }
 613
 614                                         if (current_best == null)
 615                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 616                                                         if (loop_tsi.Top > current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 617                                                                 current_best = loop_tsi;
 618                                                                 current_best_point = loop_tsi.Top;
 619                                                         }
 620
 621                                         break;
 622                                 case ArrowDirection.Left:
 623                                         current_best_point = int.MinValue;
 624
 625                                         if (start != null)
 626                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 627                                                         if (loop_tsi.Right <= start.Left && loop_tsi.Left > current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 628                                                                 current_best = loop_tsi;
 629                                                                 current_best_point = loop_tsi.Left;
 630                                                         }
 631
 632                                         if (current_best == null)
 633                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 634                                                         if (loop_tsi.Left > current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 635                                                                 current_best = loop_tsi;
 636                                                                 current_best_point = loop_tsi.Left;
 637                                                         }
 638
 639                                         break;
 640                                 case ArrowDirection.Down:
 641                                         current_best_point = int.MaxValue;
 642
 643                                         if (start != null)
 644                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 645                                                         if (loop_tsi.Top >= start.Bottom && loop_tsi.Bottom < current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 646                                                                 current_best = loop_tsi;
 647                                                                 current_best_point = loop_tsi.Top;
 648                                                         }
 649
 650                                         if (current_best == null)
 651                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 652                                                         if (loop_tsi.Top < current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 653                                                                 current_best = loop_tsi;
 654                                                                 current_best_point = loop_tsi.Top;
 655                                                         }
 656
 657                                         break;
 658                         }
 659
 660                         return current_best;
 661                 }
 662
 663                 [EditorBrowsable (EditorBrowsableState.Never)]
 664                 public void ResetMinimumSize ()
 665                 {
 666                         this.MinimumSize = new Size (-1, -1);
 667                 }
 668
 669                 [EditorBrowsable (EditorBrowsableState.Never)]
 670                 public new void SetAutoScrollMargin (int x, int y)
 671                 {
 672                         base.SetAutoScrollMargin (x, y);
 673                 }
 674
 675                 public override string ToString ()
 676                 {
 677                         return String.Format ("{0}, Name: {1}, Items: {2}", base.ToString(), this.Name, this.items.Count.ToString ());
 678                 }
 679                 #endregion
 680
 681                 #region Protected Methods
 682                 protected override AccessibleObject CreateAccessibilityInstance ()
 683                 {
 684                         return new ToolStripAccessibleObject (this);
 685                 }
 686
 687                 protected override ControlCollection CreateControlsInstance ()
 688                 {
 689                         return base.CreateControlsInstance ();
 690                 }
 691
 692                 protected internal virtual ToolStripItem CreateDefaultItem (string text, Image image, EventHandler onClick)
 693                 {
 694                         if (text == "-")
 695                                 return new ToolStripSeparator ();
 696
 697                         if (this is ToolStripDropDown)
 698                                 return new ToolStripMenuItem (text, image, onClick);
 699
 700                         return new ToolStripButton (text, image, onClick);
 701                 }
 702
 703                 protected virtual LayoutSettings CreateLayoutSettings (ToolStripLayoutStyle layoutStyle)
 704                 {
 705                         switch (layoutStyle) {
 706                                 case ToolStripLayoutStyle.Flow:
 707                                         return new FlowLayoutSettings ();
 708                                 case ToolStripLayoutStyle.Table:
 709                                         //return new TableLayoutSettings ();
 710                                 case ToolStripLayoutStyle.StackWithOverflow:
 711                                 case ToolStripLayoutStyle.HorizontalStackWithOverflow:
 712                                 case ToolStripLayoutStyle.VerticalStackWithOverflow:
 713                                 default:
 714                                         return null;
 715                         }
 716                 }
 717
 718                 protected override void Dispose (bool disposing)
 719                 {
 720                         if (!IsDisposed) {
 721                                 ToolStripManager.RemoveToolStrip (this);
 722                                 base.Dispose (disposing);
 723                         }
 724                 }
 725
 726                 [MonoTODO ("Not called")]
 727                 protected virtual void OnBeginDrag (EventArgs e)
 728                 {
 729                         EventHandler eh = (EventHandler)(Events[BeginDragEvent]);
 730                         if (eh != null)
 731                                 eh (this, e);
 732                 }
 733
 734                 protected override void OnDockChanged (EventArgs e)
 735                 {
 736                         base.OnDockChanged (e);
 737                 }
 738
 739                 [MonoTODO ("Not called")]
 740                 protected virtual void OnEndDrag (EventArgs e)
 741                 {
 742                         EventHandler eh = (EventHandler)(Events[EndDragEvent]);
 743                         if (eh != null)
 744                                 eh (this, e);
 745                 }
 746
 747                 protected override bool IsInputChar (char charCode)
 748                 {
 749                         return base.IsInputChar (charCode);
 750                 }
 751
 752                 protected override bool IsInputKey (Keys keyData)
 753                 {
 754                         return base.IsInputKey (keyData);
 755                 }
 756
 757                 protected override void OnEnabledChanged (EventArgs e)
 758                 {
 759                         base.OnEnabledChanged (e);
 760
 761                         foreach (ToolStripItem tsi in this.Items)
 762                                 tsi.OnParentEnabledChanged (EventArgs.Empty);
 763                 }
 764
 765                 protected override void OnFontChanged (EventArgs e)
 766                 {
 767                         base.OnFontChanged (e);
 768                 }
 769
 770                 protected override void OnHandleCreated (EventArgs e)
 771                 {
 772                         base.OnHandleCreated (e);
 773                 }
 774
 775                 protected override void OnHandleDestroyed (EventArgs e)
 776                 {
 777                         base.OnHandleDestroyed (e);
 778                 }
 779
 780                 protected override void OnInvalidated (InvalidateEventArgs e)
 781                 {
 782                         base.OnInvalidated (e);
 783                 }
 784
 785                 protected internal virtual void OnItemAdded (ToolStripItemEventArgs e)
 786                 {
 787                         if (e.Item.InternalVisible)
 788                                 e.Item.Available = true;
 789
 790                         e.Item.SetPlacement (ToolStripItemPlacement.Main);
 791
 792                         if (this.Created)
 793                                 this.PerformLayout ();
 794
 795                         ToolStripItemEventHandler eh = (ToolStripItemEventHandler)(Events [ItemAddedEvent]);
 796                         if (eh != null)
 797                                 eh (this, e);
 798                 }
 799
 800                 protected virtual void OnItemClicked (ToolStripItemClickedEventArgs e)
 801                 {
 802                         if (this.KeyboardActive)
 803                                 ToolStripManager.SetActiveToolStrip (null, false);
 804
 805                         ToolStripItemClickedEventHandler eh = (ToolStripItemClickedEventHandler)(Events [ItemClickedEvent]);
 806                         if (eh != null)
 807                                 eh (this, e);
 808                 }
 809
 810                 protected internal virtual void OnItemRemoved (ToolStripItemEventArgs e)
 811                 {
 812                         ToolStripItemEventHandler eh = (ToolStripItemEventHandler)(Events [ItemRemovedEvent]);
 813                         if (eh != null)
 814                                 eh (this, e);
 815                 }
 816
 817                 protected override void OnLayout (LayoutEventArgs e)
 818                 {
 819                         base.OnLayout (e);
 820
 821                         this.SetDisplayedItems ();
 822                         this.OnLayoutCompleted (EventArgs.Empty);
 823                         this.Invalidate ();
 824                 }
 825
 826                 protected virtual void OnLayoutCompleted (EventArgs e)
 827                 {
 828                         EventHandler eh = (EventHandler)(Events [LayoutCompletedEvent]);
 829                         if (eh != null)
 830                                 eh (this, e);
 831                 }
 832
 833                 protected virtual void OnLayoutStyleChanged (EventArgs e)
 834                 {
 835                         EventHandler eh = (EventHandler)(Events[LayoutStyleChangedEvent]);
 836                         if (eh != null)
 837                                 eh (this, e);
 838                 }
 839
 840                 protected override void OnLeave (EventArgs e)
 841                 {
 842                         base.OnLeave (e);
 843                 }
 844
 845                 protected override void OnLostFocus (EventArgs e)
 846                 {
 847                         base.OnLostFocus (e);
 848                 }
 849
 850                 protected override void OnMouseCaptureChanged (EventArgs e)
 851                 {
 852                         base.OnMouseCaptureChanged (e);
 853                 }
 854
 855                 protected override void OnMouseDown (MouseEventArgs mea)
 856                 {
 857                         if (mouse_currently_over != null)
 858                         {
 859                                 ToolStripItem focused = GetCurrentlyFocusedItem ();
 860
 861                                 if (focused != null && focused != mouse_currently_over)
 862                                         this.FocusInternal (true);
 863
 864                                 if (this is MenuStrip && !(mouse_currently_over as ToolStripMenuItem).HasDropDownItems) {
 865                                         if (!menu_selected)
 866                                                 (this as MenuStrip).FireMenuActivate ();
 867
 868                                         return;
 869                                 }
 870
 871                                 mouse_currently_over.FireEvent (mea, ToolStripItemEventType.MouseDown);
 872
 873                                 if (this is MenuStrip && !menu_selected) {
 874                                         (this as MenuStrip).FireMenuActivate ();
 875                                         menu_selected = true;
 876                                 }
 877                         } else {
 878                                 if (this is MenuStrip)
 879                                         this.HideMenus (true, ToolStripDropDownCloseReason.AppClicked);
 880                         }
 881
 882                         if (this is MenuStrip)
 883                                 this.Capture = false;
 884
 885                         base.OnMouseDown (mea);
 886                 }
 887
 888                 protected override void OnMouseLeave (EventArgs e)
 889                 {
 890                         if (mouse_currently_over != null) {
 891                                 MouseLeftItem (mouse_currently_over);
 892                                 mouse_currently_over.FireEvent (e, ToolStripItemEventType.MouseLeave);
 893                                 mouse_currently_over = null;
 894                         }
 895
 896                         base.OnMouseLeave (e);
 897                 }
 898
 899                 protected override void OnMouseMove (MouseEventArgs mea)
 900                 {
 901                         ToolStripItem tsi;
 902                         // Find the item we are now
 903                         if (this.overflow_button != null && this.overflow_button.Visible && this.overflow_button.Bounds.Contains (mea.Location))
 904                                 tsi = this.overflow_button;
 905                         else
 906                                 tsi = this.GetItemAt (mea.X, mea.Y);
 907
 908                         if (tsi != null) {
 909                                 // If we were already hovering on this item, just send a mouse move
 910                                 if (tsi == mouse_currently_over)
 911                                         tsi.FireEvent (mea, ToolStripItemEventType.MouseMove);
 912                                 else {
 913                                         // If we were over a different item, fire a mouse leave on it
 914                                         if (mouse_currently_over != null) {
 915                                                 MouseLeftItem (tsi);
 916                                                 mouse_currently_over.FireEvent (mea, ToolStripItemEventType.MouseLeave);
 917                                         }
 918
 919                                         // Set the new item we are currently over
 920                                         mouse_currently_over = tsi;
 921
 922                                         // Fire mouse enter and mouse move
 923                                         tsi.FireEvent (mea, ToolStripItemEventType.MouseEnter);
 924                                         MouseEnteredItem (tsi);
 925                                         tsi.FireEvent (mea, ToolStripItemEventType.MouseMove);
 926
 927                                         // If we're over something with a drop down, show it
 928                                         if (menu_selected && mouse_currently_over.Enabled && mouse_currently_over is ToolStripDropDownItem && (mouse_currently_over as ToolStripDropDownItem).HasDropDownItems)
 929                                                 (mouse_currently_over as ToolStripDropDownItem).ShowDropDown ();
 930                                 }
 931                         } else {
 932                                 // We're not over anything now, just fire the mouse leave on what we used to be over
 933                                 if (mouse_currently_over != null) {
 934                                         MouseLeftItem (tsi);
 935                                         mouse_currently_over.FireEvent (mea, ToolStripItemEventType.MouseLeave);
 936                                         mouse_currently_over = null;
 937                                 }
 938                         }
 939
 940                         base.OnMouseMove (mea);
 941                 }
 942
 943                 protected override void OnMouseUp (MouseEventArgs mea)
 944                 {
 945                         // If we're currently over an item (set in MouseMove)
 946                         if (mouse_currently_over != null && !(mouse_currently_over is ToolStripControlHost)) {
 947                                 // Fire our ItemClicked event
 948                                 OnItemClicked (new ToolStripItemClickedEventArgs (mouse_currently_over));
 949
 950                                 // Fire the item's MouseUp event
 951                                 mouse_currently_over.FireEvent (mea, ToolStripItemEventType.MouseUp);
 952
 953                                 // The event handler may have blocked until the mouse moved off of the ToolStripItem
 954                                 if (mouse_currently_over == null)
 955                                         return;
 956                         }
 957
 958                         base.OnMouseUp (mea);
 959                 }
 960
 961                 protected override void OnPaint (PaintEventArgs e)
 962                 {
 963                         base.OnPaint (e);
 964
 965                         // Draw the grip
 966                         this.OnPaintGrip (e);
 967
 968                         // Make each item draw itself
 969                         foreach (ToolStripItem tsi in this.displayed_items) {
 970                                 if (tsi.Visible) {
 971                                         e.Graphics.TranslateTransform (tsi.Bounds.Left, tsi.Bounds.Top);
 972                                         tsi.FireEvent (e, ToolStripItemEventType.Paint);
 973                                         e.Graphics.ResetTransform ();
 974                                 }
 975                         }
 976
 977                         // Paint the Overflow button if it's visible
 978                         if (this.overflow_button != null && this.overflow_button.Visible) {
 979                                 e.Graphics.TranslateTransform (this.overflow_button.Bounds.Left, this.overflow_button.Bounds.Top);
 980                                 this.overflow_button.FireEvent (e, ToolStripItemEventType.Paint);
 981                                 e.Graphics.ResetTransform ();
 982                         }
 983
 984                         Rectangle affected_bounds = new Rectangle (Point.Empty, this.Size);
 985
 986                         ToolStripRenderEventArgs pevent = new ToolStripRenderEventArgs (e.Graphics, this, affected_bounds, Color.Empty);
 987                         pevent.InternalConnectedArea = CalculateConnectedArea ();
 988
 989                         this.Renderer.DrawToolStripBorder (pevent);
 990                 }
 991
 992                 [EditorBrowsable (EditorBrowsableState.Advanced)]
 993                 protected override void OnPaintBackground (PaintEventArgs pevent)
 994                 {
 995                         base.OnPaintBackground (pevent);
 996
 997                         Rectangle affected_bounds = new Rectangle (Point.Empty, this.Size);
 998                         ToolStripRenderEventArgs e = new ToolStripRenderEventArgs (pevent.Graphics, this, affected_bounds, SystemColors.Control);
 999
1000                         this.Renderer.DrawToolStripBackground (e);
1001                 }
1002
1003                 protected internal virtual void OnPaintGrip (PaintEventArgs e)
1004                 {
1005                         // Never draw a grip with these two layouts
1006                         if (this.layout_style == ToolStripLayoutStyle.Flow || this.layout_style == ToolStripLayoutStyle.Table)
1007                                 return;
1008
1009                         PaintEventHandler eh = (PaintEventHandler)(Events [PaintGripEvent]);
1010                         if (eh != null)
1011                                 eh (this, e);
1012
1013                         if (!(this is MenuStrip)) {
1014                                 if (this.orientation == Orientation.Horizontal)
1015                                         e.Graphics.TranslateTransform (2, 0);
1016                                 else
1017                                         e.Graphics.TranslateTransform (0, 2);
1018                         }
1019
1020                         this.Renderer.DrawGrip (new ToolStripGripRenderEventArgs (e.Graphics, this, this.GripRectangle, this.GripDisplayStyle, this.grip_style));
1021                         e.Graphics.ResetTransform ();
1022                 }
1023
1024                 protected virtual void OnRendererChanged (EventArgs e)
1025                 {
1026                         EventHandler eh = (EventHandler)(Events [RendererChangedEvent]);
1027                         if (eh != null)
1028                                 eh (this, e);
1029                 }
1030
1031                 [EditorBrowsable (EditorBrowsableState.Advanced)]
1032                 protected override void OnRightToLeftChanged (EventArgs e)
1033                 {
1034                         base.OnRightToLeftChanged (e);
1035
1036                         foreach (ToolStripItem tsi in this.Items)
1037                                 tsi.OnParentRightToLeftChanged (e);
1038                 }
1039
1040                 protected override void OnScroll (ScrollEventArgs se)
1041                 {
1042                         base.OnScroll (se);
1043                 }
1044
1045                 protected override void OnTabStopChanged (EventArgs e)
1046                 {
1047                         base.OnTabStopChanged (e);
1048                 }
1049
1050                 protected override void OnVisibleChanged (EventArgs e)
1051                 {
1052                         base.OnVisibleChanged (e);
1053                 }
1054
1055                 protected override bool ProcessCmdKey (ref Message msg, Keys keyData)
1056                 {
1057                         return base.ProcessCmdKey (ref msg, keyData);
1058                 }
1059
1060                 protected override bool ProcessDialogKey (Keys keyData)
1061                 {
1062                         if (!this.KeyboardActive)
1063                                 return false;
1064
1065                         // Give each item a chance to handle the key
1066                         foreach (ToolStripItem tsi in this.Items)
1067                                 if (tsi.ProcessDialogKey (keyData))
1068                                         return true;
1069
1070                         // See if I want to handle it
1071                         if (this.ProcessArrowKey (keyData))
1072                                 return true;
1073
1074                         ToolStrip ts = null;
1075
1076                         switch (keyData) {
1077                                 case Keys.Escape:
1078                                         this.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1079                                         return true;
1080
1081                                 case Keys.Control | Keys.Tab:
1082                                         ts = ToolStripManager.GetNextToolStrip (this, true);
1083
1084                                         if (ts != null) {
1085                                                 foreach (ToolStripItem tsi in this.Items)
1086                                                         tsi.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1087
1088                                                 ToolStripManager.SetActiveToolStrip (ts, true);
1089                                                 ts.SelectNextToolStripItem (null, true);
1090                                         }
1091
1092                                         return true;
1093                                 case Keys.Control | Keys.Shift | Keys.Tab:
1094                                         ts = ToolStripManager.GetNextToolStrip (this, false);
1095
1096                                         if (ts != null) {
1097                                                 foreach (ToolStripItem tsi in this.Items)
1098                                                         tsi.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1099
1100                                                 ToolStripManager.SetActiveToolStrip (ts, true);
1101                                                 ts.SelectNextToolStripItem (null, true);
1102                                         }
1103
1104                                         return true;
1105                                 case Keys.Down:
1106                                 case Keys.Up:
1107                                 case Keys.Left:
1108                                 case Keys.Right:
1109                                         if (GetCurrentlySelectedItem () is ToolStripControlHost)
1110                                                 return false;
1111                                         break;
1112                         }
1113
1114                         return base.ProcessDialogKey (keyData);
1115                 }
1116
1117                 protected override bool ProcessMnemonic (char charCode)
1118                 {
1119                         // If any item has an explicit mnemonic, it gets the message
1120                         foreach (ToolStripItem tsi in this.Items)
1121                                 if (tsi.Enabled && tsi.Visible && !string.IsNullOrEmpty (tsi.Text) && Control.IsMnemonic (charCode, tsi.Text))
1122                                         return tsi.ProcessMnemonic (charCode);
1123
1124                         string code = Char.ToUpper (charCode).ToString ();
1125
1126                         // If any item's text starts with our letter, it gets the message
1127                         if (this is MenuStrip)
1128                                 foreach (ToolStripItem tsi in this.Items)
1129                                         if (tsi.Enabled && tsi.Visible && !string.IsNullOrEmpty (tsi.Text) && tsi.Text.ToUpper ().StartsWith (code))
1130                                                 return tsi.ProcessMnemonic (charCode);
1131
1132                         return base.ProcessMnemonic (charCode);
1133                 }
1134
1135                 [MonoTODO ()]
1136                 [EditorBrowsable (EditorBrowsableState.Advanced)]
1137                 protected virtual void RestoreFocus ()
1138                 {
1139                 }
1140
1141                 [MonoTODO ()]
1142                 protected override void Select (bool directed, bool forward)
1143                 {
1144                         foreach (ToolStripItem tsi in this.DisplayedItems)
1145                                 if (tsi.CanSelect) {
1146                                         tsi.Select ();
1147                                         break;
1148                                 }
1149                 }
1150
1151                 protected override void SetBoundsCore (int x, int y, int width, int height, BoundsSpecified specified)
1152                 {
1153                         base.SetBoundsCore (x, y, width, height, specified);
1154                 }
1155
1156                 protected virtual void SetDisplayedItems ()
1157                 {
1158                         this.displayed_items.Clear ();
1159
1160                         foreach (ToolStripItem tsi in this.items)
1161                                 if (tsi.Placement == ToolStripItemPlacement.Main && tsi.Available) {
1162                                         this.displayed_items.AddNoOwnerOrLayout (tsi);
1163                                         tsi.Parent = this;
1164                                 }
1165                                 else if (tsi.Placement == ToolStripItemPlacement.Overflow)
1166                                         tsi.Parent = this.OverflowButton.DropDown;
1167
1168                         if (this.OverflowButton != null)
1169                                 this.OverflowButton.DropDown.SetDisplayedItems ();
1170                 }
1171
1172                 protected internal void SetItemLocation (ToolStripItem item, Point location)
1173                 {
1174                         if (item == null)
1175                                 throw new ArgumentNullException ("item");
1176
1177                         if (item.Owner != this)
1178                                 throw new NotSupportedException ("The item is not owned by this ToolStrip");
1179
1180                         item.SetBounds (new Rectangle (location, item.Size));
1181                 }
1182
1183                 protected internal static void SetItemParent (ToolStripItem item, ToolStrip parent)
1184                 {
1185                         if (item.Owner != null) {
1186                                 item.Owner.Items.RemoveNoOwnerOrLayout (item);
1187
1188                                 if (item.Owner is ToolStripOverflow)
1189                                         (item.Owner as ToolStripOverflow).ParentToolStrip.Items.RemoveNoOwnerOrLayout (item);
1190                         }
1191
1192                         parent.Items.AddNoOwnerOrLayout (item);
1193                         item.Parent = parent;
1194                 }
1195
1196                 protected override void SetVisibleCore (bool value)
1197                 {
1198                         base.SetVisibleCore (value);
1199                 }
1200
1201                 protected override void WndProc (ref Message m)
1202                 {
1203                         base.WndProc (ref m);
1204                 }
1205                 #endregion
1206
1207                 #region Public Events
1208                 static object BeginDragEvent = new object ();
1209                 static object EndDragEvent = new object ();
1210                 static object ItemAddedEvent = new object ();
1211                 static object ItemClickedEvent = new object ();
1212                 static object ItemRemovedEvent = new object ();
1213                 static object LayoutCompletedEvent = new object ();
1214                 static object LayoutStyleChangedEvent = new object ();
1215                 static object PaintGripEvent = new object ();
1216                 static object RendererChangedEvent = new object ();
1217
1218                 [Browsable (true)]
1219                 [EditorBrowsable (EditorBrowsableState.Always)]
1220                 public new event EventHandler AutoSizeChanged {
1221                         add { base.AutoSizeChanged += value; }
1222                         remove { base.AutoSizeChanged -= value; }
1223                 }
1224
1225                 [MonoTODO ()]
1226                 public event EventHandler BeginDrag {
1227                         add { Events.AddHandler (BeginDragEvent, value); }
1228                         remove { Events.RemoveHandler (BeginDragEvent, value); }
1229                 }
1230
1231                 [Browsable (false)]
1232                 public new event EventHandler CausesValidationChanged {
1233                         add { base.CausesValidationChanged += value; }
1234                         remove { base.CausesValidationChanged -= value; }
1235                 }
1236
1237                 [Browsable (false)]
1238                 [EditorBrowsable (EditorBrowsableState.Never)]
1239                 public new event ControlEventHandler ControlAdded {
1240                         add { base.ControlAdded += value; }
1241                         remove { base.ControlAdded -= value; }
1242                 }
1243
1244                 [Browsable (false)]
1245                 [EditorBrowsable (EditorBrowsableState.Never)]
1246                 public new event ControlEventHandler ControlRemoved {
1247                         add { base.ControlRemoved += value; }
1248                         remove { base.ControlRemoved -= value; }
1249                 }
1250
1251                 [Browsable (false)]
1252                 public new event EventHandler CursorChanged {
1253                         add { base.CursorChanged += value; }
1254                         remove { base.CursorChanged -= value; }
1255                 }
1256
1257                 [MonoTODO ()]
1258                 public event EventHandler EndDrag {
1259                         add { Events.AddHandler (EndDragEvent, value); }
1260                         remove { Events.RemoveHandler (EndDragEvent, value); }
1261                 }
1262
1263                 [Browsable (false)]
1264                 public new event EventHandler ForeColorChanged {
1265                         add { base.ForeColorChanged += value; }
1266                         remove { base.ForeColorChanged -= value; }
1267                 }
1268
1269                 public event ToolStripItemEventHandler ItemAdded {
1270                         add { Events.AddHandler (ItemAddedEvent, value); }
1271                         remove { Events.RemoveHandler (ItemAddedEvent, value); }
1272                 }
1273
1274                 public event ToolStripItemClickedEventHandler ItemClicked {
1275                         add { Events.AddHandler (ItemClickedEvent, value); }
1276                         remove { Events.RemoveHandler (ItemClickedEvent, value); }
1277                 }
1278
1279                 public event ToolStripItemEventHandler ItemRemoved {
1280                         add { Events.AddHandler (ItemRemovedEvent, value); }
1281                         remove { Events.RemoveHandler (ItemRemovedEvent, value); }
1282                 }
1283
1284                 public event EventHandler LayoutCompleted {
1285                         add { Events.AddHandler (LayoutCompletedEvent, value); }
1286                         remove { Events.RemoveHandler (LayoutCompletedEvent, value); }
1287                 }
1288
1289                 public event EventHandler LayoutStyleChanged {
1290                         add { Events.AddHandler (LayoutStyleChangedEvent, value); }
1291                         remove { Events.RemoveHandler (LayoutStyleChangedEvent, value); }
1292                 }
1293
1294                 public event PaintEventHandler PaintGrip {
1295                         add { Events.AddHandler (PaintGripEvent, value); }
1296                         remove { Events.RemoveHandler (PaintGripEvent, value); }
1297                 }
1298
1299                 public event EventHandler RendererChanged {
1300                         add { Events.AddHandler (RendererChangedEvent, value); }
1301                         remove { Events.RemoveHandler (RendererChangedEvent, value); }
1302                 }
1303                 #endregion
1304
1305                 #region Internal Properties
1306                 internal virtual bool KeyboardActive
1307                 {
1308                         get { return this.keyboard_active; }
1309                         set {
1310                                 if (this.keyboard_active != value) {
1311                                         this.keyboard_active = value;
1312
1313                                         if (value)
1314                                                 Application.KeyboardCapture = this;
1315                                         else if (Application.KeyboardCapture == this) {
1316                                                 Application.KeyboardCapture = null;
1317                                                 ToolStripManager.ActivatedByKeyboard = false;
1318                                         }
1319
1320                                         // Redraw for mnemonic underlines
1321                                         this.Invalidate ();
1322                                 }
1323                         }
1324                 }
1325                 #endregion
1326
1327                 #region Private Methods
1328                 internal virtual Rectangle CalculateConnectedArea ()
1329                 {
1330                         return Rectangle.Empty;
1331                 }
1332
1333                 internal void ChangeSelection (ToolStripItem nextItem)
1334                 {
1335                         if (Application.KeyboardCapture != this)
1336                                 ToolStripManager.SetActiveToolStrip (this, ToolStripManager.ActivatedByKeyboard);
1337
1338                         foreach (ToolStripItem tsi in this.Items)
1339                                 if (tsi != nextItem)
1340                                         tsi.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1341
1342                         ToolStripItem current = GetCurrentlySelectedItem ();
1343
1344                         if (current != null && !(current is ToolStripControlHost))
1345                                 this.FocusInternal (true);
1346
1347                         if (nextItem is ToolStripControlHost)
1348                                 (nextItem as ToolStripControlHost).Focus ();
1349
1350                         nextItem.Select ();
1351
1352                         if (nextItem.Parent is MenuStrip && (nextItem.Parent as MenuStrip).MenuDroppedDown)
1353                                 (nextItem as ToolStripMenuItem).HandleAutoExpansion ();
1354                 }
1355
1356                 internal virtual void Dismiss ()
1357                 {
1358                         this.Dismiss (ToolStripDropDownCloseReason.AppClicked);
1359                 }
1360
1361                 internal virtual void Dismiss (ToolStripDropDownCloseReason reason)
1362                 {
1363                         // Release our stranglehold on the keyboard
1364                         this.KeyboardActive = false;
1365
1366                         // Set our drop down flag to false;
1367                         this.menu_selected = false;
1368
1369                         // Make sure all of our items are deselected and repainted
1370                         foreach (ToolStripItem tsi in this.Items)
1371                                 tsi.Dismiss (reason);
1372
1373                         // We probably need to redraw for mnemonic underlines
1374                         this.Invalidate ();
1375                 }
1376
1377                 internal ToolStripItem GetCurrentlySelectedItem ()
1378                 {
1379                         foreach (ToolStripItem tsi in this.DisplayedItems)
1380                                 if (tsi.Selected)
1381                                         return tsi;
1382
1383                         return null;
1384                 }
1385
1386                 internal ToolStripItem GetCurrentlyFocusedItem ()
1387                 {
1388                         foreach (ToolStripItem tsi in this.DisplayedItems)
1389                                 if ((tsi is ToolStripControlHost) && (tsi as ToolStripControlHost).Control.Focused)
1390                                         return tsi;
1391
1392                         return null;
1393                 }
1394
1395                 internal override Size GetPreferredSizeCore (Size proposedSize)
1396                 {
1397                         return GetToolStripPreferredSize (proposedSize);
1398                 }
1399
1400                 internal virtual Size GetToolStripPreferredSize (Size proposedSize)
1401                 {
1402                         Size new_size = Size.Empty;
1403
1404                         if (this.orientation == Orientation.Vertical) {
1405                                 foreach (ToolStripItem tsi in this.items)
1406                                         if (tsi.Available)  {
1407                                                 Size tsi_preferred = tsi.GetPreferredSize (Size.Empty);
1408                                                 new_size.Height += tsi_preferred.Height + tsi.Margin.Top + tsi.Margin.Bottom;
1409
1410                                                 if (new_size.Width < (this.Padding.Horizontal + tsi_preferred.Width + tsi.Margin.Horizontal))
1411                                                         new_size.Width = (this.Padding.Horizontal + tsi_preferred.Width + tsi.Margin.Horizontal);
1412                                         }
1413
1414                                 new_size.Height += (this.GripRectangle.Height + this.GripMargin.Vertical + this.Padding.Vertical + 4);
1415
1416                                 if (new_size.Width == 0)
1417                                         new_size.Width = ExplicitBounds.Width;
1418
1419                                 return new_size;
1420                         } else {
1421                                 foreach (ToolStripItem tsi in this.items)
1422                                         if (tsi.Available) {
1423                                                 Size tsi_preferred = tsi.GetPreferredSize (Size.Empty);
1424                                                 new_size.Width += tsi_preferred.Width + tsi.Margin.Left + tsi.Margin.Right;
1425
1426                                                 if (new_size.Height < (this.Padding.Vertical + tsi_preferred.Height + tsi.Margin.Vertical))
1427                                                         new_size.Height = (this.Padding.Vertical + tsi_preferred.Height + tsi.Margin.Vertical);
1428                                         }
1429
1430                                 new_size.Width += (this.GripRectangle.Width + this.GripMargin.Horizontal + this.Padding.Horizontal + 4);
1431
1432                                 if (new_size.Height == 0)
1433                                         new_size.Height = ExplicitBounds.Height;
1434
1435                                 if (this is StatusStrip)
1436                                         new_size.Height = Math.Max (new_size.Height, 22);
1437
1438                                 return new_size;
1439                         }
1440                 }
1441
1442                 internal virtual ToolStrip GetTopLevelToolStrip ()
1443                 {
1444                         return this;
1445                 }
1446
1447                 internal virtual void HandleItemClick (ToolStripItem dismissingItem)
1448                 {
1449                         this.GetTopLevelToolStrip ().Dismiss (ToolStripDropDownCloseReason.ItemClicked);
1450                 }
1451
1452                 internal void HideMenus (bool release, ToolStripDropDownCloseReason reason)
1453                 {
1454                         if (this is MenuStrip && release && menu_selected)
1455                                 (this as MenuStrip).FireMenuDeactivate ();
1456
1457                         if (release)
1458                                 menu_selected = false;
1459
1460                         NotifySelectedChanged (null);
1461                 }
1462
1463                 internal void NotifySelectedChanged (ToolStripItem tsi)
1464                 {
1465                         foreach (ToolStripItem tsi2 in this.DisplayedItems)
1466                                 if (tsi != tsi2)
1467                                         if (tsi2 is ToolStripDropDownItem)
1468                                                 (tsi2 as ToolStripDropDownItem).HideDropDown (ToolStripDropDownCloseReason.Keyboard);
1469
1470                         if (this.OverflowButton != null) {
1471                                 ToolStripItemCollection tsic = this.OverflowButton.DropDown.DisplayedItems;
1472
1473                                 foreach (ToolStripItem tsi2 in tsic)
1474                                         if (tsi != tsi2)
1475                                                 if (tsi2 is ToolStripDropDownItem)
1476                                                         (tsi2 as ToolStripDropDownItem).HideDropDown (ToolStripDropDownCloseReason.Keyboard);
1477
1478                                 this.OverflowButton.HideDropDown ();
1479                         }
1480
1481                         foreach (ToolStripItem tsi2 in this.Items)
1482                                 if (tsi != tsi2)
1483                                         tsi2.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1484                 }
1485
1486                 internal virtual bool OnMenuKey ()
1487                 {
1488                         return false;
1489                 }
1490
1491                 internal virtual bool ProcessArrowKey (Keys keyData)
1492                 {
1493                         ToolStripItem tsi;
1494
1495                         switch (keyData) {
1496                                 case Keys.Right:
1497                                         tsi = this.GetCurrentlySelectedItem ();
1498
1499                                         if (tsi is ToolStripControlHost)
1500                                                 return false;
1501
1502                                         tsi = this.SelectNextToolStripItem (tsi, true);
1503
1504                                         if (tsi is ToolStripControlHost)
1505                                                 (tsi as ToolStripControlHost).Focus ();
1506
1507                                         return true;
1508                                 case Keys.Tab:
1509                                         tsi = this.GetCurrentlySelectedItem ();
1510
1511                                         tsi = this.SelectNextToolStripItem (tsi, true);
1512
1513                                         if (tsi is ToolStripControlHost)
1514                                                 (tsi as ToolStripControlHost).Focus ();
1515
1516                                         return true;
1517                                 case Keys.Left:
1518                                         tsi = this.GetCurrentlySelectedItem ();
1519
1520                                         if (tsi is ToolStripControlHost)
1521                                                 return false;
1522
1523                                         tsi = this.SelectNextToolStripItem (tsi, false);
1524
1525                                         if (tsi is ToolStripControlHost)
1526                                                 (tsi as ToolStripControlHost).Focus ();
1527
1528                                         return true;
1529                                 case Keys.Shift | Keys.Tab:
1530                                         tsi = this.GetCurrentlySelectedItem ();
1531
1532                                         tsi = this.SelectNextToolStripItem (tsi, false);
1533
1534                                         if (tsi is ToolStripControlHost)
1535                                                 (tsi as ToolStripControlHost).Focus ();
1536
1537                                         return true;
1538                         }
1539
1540                         return false;
1541                 }
1542
1543                 internal virtual ToolStripItem SelectNextToolStripItem (ToolStripItem start, bool forward)
1544                 {
1545                         ToolStripItem next_item = this.GetNextItem (start, forward ? ArrowDirection.Right : ArrowDirection.Left);
1546
1547                         this.ChangeSelection (next_item);
1548
1549                         if (next_item is ToolStripControlHost)
1550                                 (next_item as ToolStripControlHost).Focus ();
1551
1552                         return next_item;
1553                 }
1554
1555                 #region Stuff for ToolTips
1556                 private void MouseEnteredItem (ToolStripItem item)
1557                 {
1558                         if (this.show_item_tool_tips && !(item is ToolStripTextBox)) {
1559                                 tooltip_currently_showing = item;
1560                                 ToolTipTimer.Start ();
1561                         }
1562                 }
1563
1564                 private void MouseLeftItem (ToolStripItem item)
1565                 {
1566                         ToolTipTimer.Stop ();
1567                         ToolTipWindow.Hide (this);
1568                         tooltip_currently_showing = null;
1569                 }
1570
1571                 private Timer ToolTipTimer {
1572                         get {
1573                                 if (tooltip_timer == null) {
1574                                         tooltip_timer = new Timer ();
1575                                         tooltip_timer.Enabled = false;
1576                                         tooltip_timer.Interval = 500;
1577                                         tooltip_timer.Tick += new EventHandler (ToolTipTimer_Tick);
1578                                 }
1579
1580                                 return tooltip_timer;
1581                         }
1582                 }
1583
1584                 private ToolTip ToolTipWindow {
1585                         get {
1586                                 if (tooltip_window == null)
1587                                         tooltip_window = new ToolTip ();
1588
1589                                 return tooltip_window;
1590                         }
1591                 }
1592
1593                 private void ToolTipTimer_Tick (object o, EventArgs args)
1594                 {
1595                         string tooltip = tooltip_currently_showing.GetToolTip ();
1596
1597                         if (!string.IsNullOrEmpty (tooltip))
1598                                 ToolTipWindow.Present (this, tooltip);
1599
1600                         tooltip_currently_showing.FireEvent (EventArgs.Empty, ToolStripItemEventType.MouseHover);
1601
1602                         ToolTipTimer.Stop ();
1603                 }
1604                 #endregion
1605
1606                 #region Stuff for Merging
1607                 internal ToolStrip CurrentlyMergedWith {
1608                         get { return this.currently_merged_with; }
1609                         set { this.currently_merged_with = value; }
1610                 }
1611
1612                 internal List<ToolStripItem> HiddenMergedItems {
1613                         get {
1614                                 if (this.hidden_merged_items == null)
1615                                         this.hidden_merged_items = new List<ToolStripItem> ();
1616
1617                                 return this.hidden_merged_items;
1618                         }
1619                 }
1620
1621                 internal bool IsCurrentlyMerged {
1622                         get { return this.is_currently_merged; }
1623                         set {
1624                                 this.is_currently_merged = value;
1625
1626                                 if (!value && this is MenuStrip)
1627                                         foreach (ToolStripMenuItem tsmi in this.Items)
1628                                                 tsmi.DropDown.IsCurrentlyMerged = value;
1629                          }
1630                 }
1631
1632                 internal void BeginMerge ()
1633                 {
1634                         if (!IsCurrentlyMerged) {
1635                                 IsCurrentlyMerged = true;
1636
1637                                 if (this.pre_merge_items == null) {
1638                                         this.pre_merge_items = new List<ToolStripItem> ();
1639
1640                                 foreach (ToolStripItem tsi in this.Items)
1641                                         this.pre_merge_items.Add (tsi);
1642                                 }
1643                         }
1644                 }
1645
1646                 internal void RevertMergeItem (ToolStripItem item)
1647                 {
1648                         int index = 0;
1649
1650                         // Remove it from it's current Parent
1651                         if (item.Parent != null && item.Parent != this) {
1652                                 if (item.Parent is ToolStripOverflow)
1653                                         (item.Parent as ToolStripOverflow).ParentToolStrip.Items.RemoveNoOwnerOrLayout (item);
1654                                 else
1655                                         item.Parent.Items.RemoveNoOwnerOrLayout (item);
1656
1657                                 item.Parent = item.Owner;
1658                         }
1659
1660                         // Find where the item was before the merge
1661                         index = item.Owner.pre_merge_items.IndexOf (item);
1662
1663                         // Find the first pre-merge item that was after this item, that
1664                         // is currently in the Items collection.  Insert our item before
1665                         // that one.
1666                         for (int i = index; i < this.pre_merge_items.Count; i++) {
1667                                 if (this.Items.Contains (this.pre_merge_items[i])) {
1668                                         item.Owner.Items.InsertNoOwnerOrLayout (this.Items.IndexOf (this.pre_merge_items[i]), item);
1669                                         return;
1670                                 }
1671                         }
1672
1673                         // There aren't any items that are supposed to be after this item,
1674                         // so just append it to the end.
1675                         item.Owner.Items.AddNoOwnerOrLayout (item);
1676                 }
1677                 #endregion
1678                 #endregion
1679
1680                 #region ToolStripAccessibleObject
1681                 [ComVisible (true)]
1682                 public class ToolStripAccessibleObject : ControlAccessibleObject
1683                 {
1684                         #region Public Constructor
1685                         public ToolStripAccessibleObject (ToolStrip owner) : base (owner)
1686                         {
1687                         }
1688                         #endregion
1689
1690                         #region Public Properties
1691                         public override AccessibleRole Role {
1692                                 get { return AccessibleRole.ToolBar; }
1693                         }
1694                         #endregion
1695
1696                         #region Public Methods
1697                         public override AccessibleObject GetChild (int index)
1698                         {
1699                                 return base.GetChild (index);
1700                         }
1701
1702                         public override int GetChildCount ()
1703                         {
1704                                 return (owner as ToolStrip).Items.Count;
1705                         }
1706
1707                         public override AccessibleObject HitTest (int x, int y)
1708                         {
1709                                 return base.HitTest (x, y);
1710                         }
1711                         #endregion
1712                 }
1713                 #endregion
1714         }
1715 }
1716 #endif