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.back_color = Control.DefaultBackColor;
 102                         this.can_overflow = true;
 103                         base.CausesValidation = false;
 104                         this.default_drop_down_direction = ToolStripDropDownDirection.BelowRight;
 105                         this.displayed_items = new ToolStripItemCollection (this, null, true);
 106                         this.Dock = this.DefaultDock;
 107                         base.Font = new Font ("Tahoma", 8.25f);
 108                         this.fore_color = Control.DefaultForeColor;
 109                         this.grip_margin = this.DefaultGripMargin;
 110                         this.grip_style = ToolStripGripStyle.Visible;
 111                         this.image_scaling_size = new Size (16, 16);
 112                         this.layout_style = ToolStripLayoutStyle.HorizontalStackWithOverflow;
 113                         this.orientation = Orientation.Horizontal;
 114                         if (!(this is ToolStripDropDown))
 115                                 this.overflow_button = new ToolStripOverflowButton (this);
 116                         this.renderer = null;
 117                         this.render_mode = ToolStripRenderMode.ManagerRenderMode;
 118                         this.show_item_tool_tips = this.DefaultShowItemToolTips;
 119                         base.TabStop = false;
 120                         this.text_direction = ToolStripTextDirection.Horizontal;
 121                         this.ResumeLayout ();
 122                         DoAutoSize ();
 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 { base.TabStop = value; }
 508                 }
 509
 510                 [DefaultValue (ToolStripTextDirection.Horizontal)]
 511                 public virtual ToolStripTextDirection TextDirection {
 512                         get { return this.text_direction; }
 513                         set {
 514                                 if (!Enum.IsDefined (typeof (ToolStripTextDirection), value))
 515                                         throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ToolStripTextDirection", value));
 516
 517                                 if (this.text_direction != value) {
 518                                         this.text_direction = value;
 519
 520                                         this.PerformLayout (this, "TextDirection");
 521
 522                                         this.Invalidate ();
 523                                 }
 524                         }
 525                 }
 526
 527                 [Browsable (false)]
 528                 [EditorBrowsable (EditorBrowsableState.Never)]
 529                 public new VScrollProperties VerticalScroll {
 530                         get { return base.VerticalScroll; }
 531                 }
 532                 #endregion
 533
 534                 #region Protected Properties
 535                 protected virtual DockStyle DefaultDock { get { return DockStyle.Top; } }
 536                 protected virtual Padding DefaultGripMargin { get { return new Padding (2); } }
 537                 protected override Padding DefaultMargin { get { return Padding.Empty; } }
 538                 protected override Padding DefaultPadding { get { return new Padding (0, 0, 1, 0); } }
 539                 protected virtual bool DefaultShowItemToolTips { get { return true; } }
 540                 protected override Size DefaultSize { get { return new Size (100, 25); } }
 541                 protected internal virtual ToolStripItemCollection DisplayedItems { get { return this.displayed_items; } }
 542                 protected internal virtual Size MaxItemSize {
 543                         get { return new Size (Width - (GripStyle == ToolStripGripStyle.Hidden ? 1 : 8), Height); }
 544                 }
 545                 #endregion
 546
 547                 #region Public Methods
 548                 [EditorBrowsable (EditorBrowsableState.Never)]
 549                 public new Control GetChildAtPoint (Point point)
 550                 {
 551                         return base.GetChildAtPoint (point);
 552                 }
 553
 554                 [EditorBrowsable (EditorBrowsableState.Never)]
 555                 public new Control GetChildAtPoint (Point pt, GetChildAtPointSkip skipValue)
 556                 {
 557                         return base.GetChildAtPoint (pt, skipValue);
 558                 }
 559
 560                 public ToolStripItem GetItemAt (Point point)
 561                 {
 562                         foreach (ToolStripItem tsi in this.displayed_items)
 563                                 if (tsi.Visible && tsi.Bounds.Contains (point))
 564                                         return tsi;
 565
 566                         return null;
 567                 }
 568
 569                 public ToolStripItem GetItemAt (int x, int y)
 570                 {
 571                         return GetItemAt (new Point (x, y));
 572                 }
 573
 574                 public virtual ToolStripItem GetNextItem (ToolStripItem start, ArrowDirection direction)
 575                 {
 576                         if (!Enum.IsDefined (typeof (ArrowDirection), direction))
 577                                 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ArrowDirection", direction));
 578
 579                         ToolStripItem current_best = null;
 580                         int current_best_point;
 581
 582                         switch (direction) {
 583                                 case ArrowDirection.Right:
 584                                         current_best_point = int.MaxValue;
 585
 586                                         if (start != null)
 587                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 588                                                         if (loop_tsi.Left >= start.Right && loop_tsi.Left < current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 589                                                                 current_best = loop_tsi;
 590                                                                 current_best_point = loop_tsi.Left;
 591                                                         }
 592
 593                                         if (current_best == null)
 594                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 595                                                         if (loop_tsi.Left < current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 596                                                                 current_best = loop_tsi;
 597                                                                 current_best_point = loop_tsi.Left;
 598                                                         }
 599
 600                                         break;
 601                                 case ArrowDirection.Up:
 602                                         current_best_point = int.MinValue;
 603
 604                                         if (start != null)
 605                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 606                                                         if (loop_tsi.Bottom <= start.Top && loop_tsi.Top > current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 607                                                                 current_best = loop_tsi;
 608                                                                 current_best_point = loop_tsi.Top;
 609                                                         }
 610
 611                                         if (current_best == null)
 612                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 613                                                         if (loop_tsi.Top > current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 614                                                                 current_best = loop_tsi;
 615                                                                 current_best_point = loop_tsi.Top;
 616                                                         }
 617
 618                                         break;
 619                                 case ArrowDirection.Left:
 620                                         current_best_point = int.MinValue;
 621
 622                                         if (start != null)
 623                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 624                                                         if (loop_tsi.Right <= start.Left && loop_tsi.Left > current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 625                                                                 current_best = loop_tsi;
 626                                                                 current_best_point = loop_tsi.Left;
 627                                                         }
 628
 629                                         if (current_best == null)
 630                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 631                                                         if (loop_tsi.Left > current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 632                                                                 current_best = loop_tsi;
 633                                                                 current_best_point = loop_tsi.Left;
 634                                                         }
 635
 636                                         break;
 637                                 case ArrowDirection.Down:
 638                                         current_best_point = int.MaxValue;
 639
 640                                         if (start != null)
 641                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 642                                                         if (loop_tsi.Top >= start.Bottom && loop_tsi.Bottom < current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 643                                                                 current_best = loop_tsi;
 644                                                                 current_best_point = loop_tsi.Top;
 645                                                         }
 646
 647                                         if (current_best == null)
 648                                                 foreach (ToolStripItem loop_tsi in this.DisplayedItems)
 649                                                         if (loop_tsi.Top < current_best_point && loop_tsi.Visible && loop_tsi.CanSelect) {
 650                                                                 current_best = loop_tsi;
 651                                                                 current_best_point = loop_tsi.Top;
 652                                                         }
 653
 654                                         break;
 655                         }
 656
 657                         return current_best;
 658                 }
 659
 660                 [EditorBrowsable (EditorBrowsableState.Never)]
 661                 public void ResetMinimumSize ()
 662                 {
 663                         this.MinimumSize = new Size (-1, -1);
 664                 }
 665
 666                 [EditorBrowsable (EditorBrowsableState.Never)]
 667                 public new void SetAutoScrollMargin (int x, int y)
 668                 {
 669                         base.SetAutoScrollMargin (x, y);
 670                 }
 671
 672                 public override string ToString ()
 673                 {
 674                         return String.Format ("{0}, Name: {1}, Items: {2}", base.ToString(), this.Name, this.items.Count.ToString ());
 675                 }
 676                 #endregion
 677
 678                 #region Protected Methods
 679                 protected override AccessibleObject CreateAccessibilityInstance ()
 680                 {
 681                         return new ToolStripAccessibleObject (this);
 682                 }
 683
 684                 protected override ControlCollection CreateControlsInstance ()
 685                 {
 686                         return base.CreateControlsInstance ();
 687                 }
 688
 689                 protected internal virtual ToolStripItem CreateDefaultItem (string text, Image image, EventHandler onClick)
 690                 {
 691                         if (text == "-")
 692                                 return new ToolStripSeparator ();
 693
 694                         if (this is ToolStripDropDown)
 695                                 return new ToolStripMenuItem (text, image, onClick);
 696
 697                         return new ToolStripButton (text, image, onClick);
 698                 }
 699
 700                 protected virtual LayoutSettings CreateLayoutSettings (ToolStripLayoutStyle layoutStyle)
 701                 {
 702                         switch (layoutStyle) {
 703                                 case ToolStripLayoutStyle.Flow:
 704                                         return new FlowLayoutSettings ();
 705                                 case ToolStripLayoutStyle.Table:
 706                                         //return new TableLayoutSettings ();
 707                                 case ToolStripLayoutStyle.StackWithOverflow:
 708                                 case ToolStripLayoutStyle.HorizontalStackWithOverflow:
 709                                 case ToolStripLayoutStyle.VerticalStackWithOverflow:
 710                                 default:
 711                                         return null;
 712                         }
 713                 }
 714
 715                 protected override void Dispose (bool disposing)
 716                 {
 717                         if (!IsDisposed) {
 718                                 ToolStripManager.RemoveToolStrip (this);
 719                                 base.Dispose (disposing);
 720                         }
 721                 }
 722
 723                 [MonoTODO ("Not called")]
 724                 protected virtual void OnBeginDrag (EventArgs e)
 725                 {
 726                         EventHandler eh = (EventHandler)(Events[BeginDragEvent]);
 727                         if (eh != null)
 728                                 eh (this, e);
 729                 }
 730
 731                 protected override void OnDockChanged (EventArgs e)
 732                 {
 733                         base.OnDockChanged (e);
 734                 }
 735
 736                 [MonoTODO ("Not called")]
 737                 protected virtual void OnEndDrag (EventArgs e)
 738                 {
 739                         EventHandler eh = (EventHandler)(Events[EndDragEvent]);
 740                         if (eh != null)
 741                                 eh (this, e);
 742                 }
 743
 744                 protected override bool IsInputChar (char charCode)
 745                 {
 746                         return base.IsInputChar (charCode);
 747                 }
 748
 749                 protected override bool IsInputKey (Keys keyData)
 750                 {
 751                         return base.IsInputKey (keyData);
 752                 }
 753
 754                 protected override void OnEnabledChanged (EventArgs e)
 755                 {
 756                         base.OnEnabledChanged (e);
 757
 758                         foreach (ToolStripItem tsi in this.Items)
 759                                 tsi.OnParentEnabledChanged (EventArgs.Empty);
 760                 }
 761
 762                 protected override void OnFontChanged (EventArgs e)
 763                 {
 764                         base.OnFontChanged (e);
 765                 }
 766
 767                 protected override void OnHandleCreated (EventArgs e)
 768                 {
 769                         base.OnHandleCreated (e);
 770                 }
 771
 772                 protected override void OnHandleDestroyed (EventArgs e)
 773                 {
 774                         base.OnHandleDestroyed (e);
 775                 }
 776
 777                 protected override void OnInvalidated (InvalidateEventArgs e)
 778                 {
 779                         base.OnInvalidated (e);
 780                 }
 781
 782                 protected internal virtual void OnItemAdded (ToolStripItemEventArgs e)
 783                 {
 784                         e.Item.Available = true;
 785                         e.Item.SetPlacement (ToolStripItemPlacement.Main);
 786                         this.DoAutoSize ();
 787
 788                         if (this.Created)
 789                                 this.PerformLayout ();
 790
 791                         ToolStripItemEventHandler eh = (ToolStripItemEventHandler)(Events [ItemAddedEvent]);
 792                         if (eh != null)
 793                                 eh (this, e);
 794                 }
 795
 796                 protected virtual void OnItemClicked (ToolStripItemClickedEventArgs e)
 797                 {
 798                         if (this.KeyboardActive)
 799                                 ToolStripManager.SetActiveToolStrip (null, false);
 800
 801                         ToolStripItemClickedEventHandler eh = (ToolStripItemClickedEventHandler)(Events [ItemClickedEvent]);
 802                         if (eh != null)
 803                                 eh (this, e);
 804                 }
 805
 806                 protected internal virtual void OnItemRemoved (ToolStripItemEventArgs e)
 807                 {
 808                         ToolStripItemEventHandler eh = (ToolStripItemEventHandler)(Events [ItemRemovedEvent]);
 809                         if (eh != null)
 810                                 eh (this, e);
 811                 }
 812
 813                 protected override void OnLayout (LayoutEventArgs e)
 814                 {
 815                         DoAutoSize ();
 816                         base.OnLayout (e);
 817
 818                         this.SetDisplayedItems ();
 819                         this.OnLayoutCompleted (EventArgs.Empty);
 820                         this.Invalidate ();
 821                 }
 822
 823                 protected virtual void OnLayoutCompleted (EventArgs e)
 824                 {
 825                         EventHandler eh = (EventHandler)(Events [LayoutCompletedEvent]);
 826                         if (eh != null)
 827                                 eh (this, e);
 828                 }
 829
 830                 protected virtual void OnLayoutStyleChanged (EventArgs e)
 831                 {
 832                         EventHandler eh = (EventHandler)(Events[LayoutStyleChangedEvent]);
 833                         if (eh != null)
 834                                 eh (this, e);
 835                 }
 836
 837                 protected override void OnLeave (EventArgs e)
 838                 {
 839                         base.OnLeave (e);
 840                 }
 841
 842                 protected override void OnLostFocus (EventArgs e)
 843                 {
 844                         base.OnLostFocus (e);
 845                 }
 846
 847                 protected override void OnMouseCaptureChanged (EventArgs e)
 848                 {
 849                         base.OnMouseCaptureChanged (e);
 850                 }
 851
 852                 protected override void OnMouseDown (MouseEventArgs mea)
 853                 {
 854                         if (mouse_currently_over != null)
 855                         {
 856                                 ToolStripItem focused = GetCurrentlyFocusedItem ();
 857
 858                                 if (focused != null && focused != mouse_currently_over)
 859                                         this.FocusInternal (true);
 860
 861                                 if (this is MenuStrip && !(mouse_currently_over as ToolStripMenuItem).HasDropDownItems) {
 862                                         if (!menu_selected)
 863                                                 (this as MenuStrip).FireMenuActivate ();
 864
 865                                         return;
 866                                 }
 867
 868                                 mouse_currently_over.FireEvent (mea, ToolStripItemEventType.MouseDown);
 869
 870                                 if (this is MenuStrip && !menu_selected) {
 871                                         (this as MenuStrip).FireMenuActivate ();
 872                                         menu_selected = true;
 873                                 }
 874                         } else {
 875                                 if (this is MenuStrip)
 876                                         this.HideMenus (true, ToolStripDropDownCloseReason.AppClicked);
 877                         }
 878
 879                         if (this is MenuStrip)
 880                                 this.Capture = false;
 881
 882                         base.OnMouseDown (mea);
 883                 }
 884
 885                 protected override void OnMouseLeave (EventArgs e)
 886                 {
 887                         if (mouse_currently_over != null) {
 888                                 MouseLeftItem (mouse_currently_over);
 889                                 mouse_currently_over.FireEvent (e, ToolStripItemEventType.MouseLeave);
 890                                 mouse_currently_over = null;
 891                         }
 892
 893                         base.OnMouseLeave (e);
 894                 }
 895
 896                 protected override void OnMouseMove (MouseEventArgs mea)
 897                 {
 898                         ToolStripItem tsi;
 899                         // Find the item we are now
 900                         if (this.overflow_button != null && this.overflow_button.Visible && this.overflow_button.Bounds.Contains (mea.Location))
 901                                 tsi = this.overflow_button;
 902                         else
 903                                 tsi = this.GetItemAt (mea.X, mea.Y);
 904
 905                         if (tsi != null) {
 906                                 // If we were already hovering on this item, just send a mouse move
 907                                 if (tsi == mouse_currently_over)
 908                                         tsi.FireEvent (mea, ToolStripItemEventType.MouseMove);
 909                                 else {
 910                                         // If we were over a different item, fire a mouse leave on it
 911                                         if (mouse_currently_over != null) {
 912                                                 MouseLeftItem (tsi);
 913                                                 mouse_currently_over.FireEvent (mea, ToolStripItemEventType.MouseLeave);
 914                                         }
 915
 916                                         // Set the new item we are currently over
 917                                         mouse_currently_over = tsi;
 918
 919                                         // Fire mouse enter and mouse move
 920                                         tsi.FireEvent (mea, ToolStripItemEventType.MouseEnter);
 921                                         MouseEnteredItem (tsi);
 922                                         tsi.FireEvent (mea, ToolStripItemEventType.MouseMove);
 923
 924                                         // If we're over something with a drop down, show it
 925                                         if (menu_selected && mouse_currently_over.Enabled && mouse_currently_over is ToolStripDropDownItem && (mouse_currently_over as ToolStripDropDownItem).HasDropDownItems)
 926                                                 (mouse_currently_over as ToolStripDropDownItem).ShowDropDown ();
 927                                 }
 928                         } else {
 929                                 // We're not over anything now, just fire the mouse leave on what we used to be over
 930                                 if (mouse_currently_over != null) {
 931                                         MouseLeftItem (tsi);
 932                                         mouse_currently_over.FireEvent (mea, ToolStripItemEventType.MouseLeave);
 933                                         mouse_currently_over = null;
 934                                 }
 935                         }
 936
 937                         base.OnMouseMove (mea);
 938                 }
 939
 940                 protected override void OnMouseUp (MouseEventArgs mea)
 941                 {
 942                         // If we're currently over an item (set in MouseMove)
 943                         if (mouse_currently_over != null) {
 944                                 // Fire our ItemClicked event
 945                                 OnItemClicked (new ToolStripItemClickedEventArgs (mouse_currently_over));
 946
 947                                 // Fire the item's MouseUp event
 948                                 mouse_currently_over.FireEvent (mea, ToolStripItemEventType.MouseUp);
 949
 950                                 // The event handler may have blocked until the mouse moved off of the ToolStripItem
 951                                 if (mouse_currently_over == null)
 952                                         return;
 953                         }
 954
 955                         base.OnMouseUp (mea);
 956                 }
 957
 958                 protected override void OnPaint (PaintEventArgs e)
 959                 {
 960                         base.OnPaint (e);
 961
 962                         // Draw the grip
 963                         this.OnPaintGrip (e);
 964
 965                         // Make each item draw itself
 966                         foreach (ToolStripItem tsi in this.displayed_items) {
 967                                 if (tsi.Visible) {
 968                                         e.Graphics.TranslateTransform (tsi.Bounds.Left, tsi.Bounds.Top);
 969                                         tsi.FireEvent (e, ToolStripItemEventType.Paint);
 970                                         e.Graphics.ResetTransform ();
 971                                 }
 972                         }
 973
 974                         // Paint the Overflow button if it's visible
 975                         if (this.overflow_button != null && this.overflow_button.Visible) {
 976                                 e.Graphics.TranslateTransform (this.overflow_button.Bounds.Left, this.overflow_button.Bounds.Top);
 977                                 this.overflow_button.FireEvent (e, ToolStripItemEventType.Paint);
 978                                 e.Graphics.ResetTransform ();
 979                         }
 980
 981                         Rectangle affected_bounds = new Rectangle (Point.Empty, this.Size);
 982
 983                         ToolStripRenderEventArgs pevent = new ToolStripRenderEventArgs (e.Graphics, this, affected_bounds, Color.Empty);
 984                         pevent.InternalConnectedArea = CalculateConnectedArea ();
 985
 986                         this.Renderer.DrawToolStripBorder (pevent);
 987                 }
 988
 989                 [EditorBrowsable (EditorBrowsableState.Advanced)]
 990                 protected override void OnPaintBackground (PaintEventArgs pevent)
 991                 {
 992                         base.OnPaintBackground (pevent);
 993
 994                         Rectangle affected_bounds = new Rectangle (Point.Empty, this.Size);
 995                         ToolStripRenderEventArgs e = new ToolStripRenderEventArgs (pevent.Graphics, this, affected_bounds, SystemColors.Control);
 996
 997                         this.Renderer.DrawToolStripBackground (e);
 998                 }
 999
1000                 protected internal virtual void OnPaintGrip (PaintEventArgs e)
1001                 {
1002                         // Never draw a grip with these two layouts
1003                         if (this.layout_style == ToolStripLayoutStyle.Flow || this.layout_style == ToolStripLayoutStyle.Table)
1004                                 return;
1005
1006                         PaintEventHandler eh = (PaintEventHandler)(Events [PaintGripEvent]);
1007                         if (eh != null)
1008                                 eh (this, e);
1009
1010                         if (!(this is MenuStrip)) {
1011                                 if (this.orientation == Orientation.Horizontal)
1012                                         e.Graphics.TranslateTransform (2, 0);
1013                                 else
1014                                         e.Graphics.TranslateTransform (0, 2);
1015                         }
1016
1017                         this.Renderer.DrawGrip (new ToolStripGripRenderEventArgs (e.Graphics, this, this.GripRectangle, this.GripDisplayStyle, this.grip_style));
1018                         e.Graphics.ResetTransform ();
1019                 }
1020
1021                 protected virtual void OnRendererChanged (EventArgs e)
1022                 {
1023                         EventHandler eh = (EventHandler)(Events [RendererChangedEvent]);
1024                         if (eh != null)
1025                                 eh (this, e);
1026                 }
1027
1028                 [EditorBrowsable (EditorBrowsableState.Advanced)]
1029                 protected override void OnRightToLeftChanged (EventArgs e)
1030                 {
1031                         base.OnRightToLeftChanged (e);
1032
1033                         foreach (ToolStripItem tsi in this.Items)
1034                                 tsi.OnParentRightToLeftChanged (e);
1035                 }
1036
1037                 protected override void OnScroll (ScrollEventArgs se)
1038                 {
1039                         base.OnScroll (se);
1040                 }
1041
1042                 protected override void OnTabStopChanged (EventArgs e)
1043                 {
1044                         base.OnTabStopChanged (e);
1045                 }
1046
1047                 protected override void OnVisibleChanged (EventArgs e)
1048                 {
1049                         base.OnVisibleChanged (e);
1050                 }
1051
1052                 protected override bool ProcessCmdKey (ref Message msg, Keys keyData)
1053                 {
1054                         return base.ProcessCmdKey (ref msg, keyData);
1055                 }
1056
1057                 protected override bool ProcessDialogKey (Keys keyData)
1058                 {
1059                         if (!this.KeyboardActive)
1060                                 return false;
1061
1062                         // Give each item a chance to handle the key
1063                         foreach (ToolStripItem tsi in this.Items)
1064                                 if (tsi.ProcessDialogKey (keyData))
1065                                         return true;
1066
1067                         // See if I want to handle it
1068                         if (this.ProcessArrowKey (keyData))
1069                                 return true;
1070
1071                         ToolStrip ts = null;
1072
1073                         switch (keyData) {
1074                                 case Keys.Escape:
1075                                         this.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1076                                         return true;
1077
1078                                 case Keys.Control | Keys.Tab:
1079                                         ts = ToolStripManager.GetNextToolStrip (this, true);
1080
1081                                         if (ts != null) {
1082                                                 foreach (ToolStripItem tsi in this.Items)
1083                                                         tsi.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1084
1085                                                 ToolStripManager.SetActiveToolStrip (ts, true);
1086                                                 ts.SelectNextToolStripItem (null, true);
1087                                         }
1088
1089                                         return true;
1090                                 case Keys.Control | Keys.Shift | Keys.Tab:
1091                                         ts = ToolStripManager.GetNextToolStrip (this, false);
1092
1093                                         if (ts != null) {
1094                                                 foreach (ToolStripItem tsi in this.Items)
1095                                                         tsi.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1096
1097                                                 ToolStripManager.SetActiveToolStrip (ts, true);
1098                                                 ts.SelectNextToolStripItem (null, true);
1099                                         }
1100
1101                                         return true;
1102                                 case Keys.Down:
1103                                 case Keys.Up:
1104                                 case Keys.Left:
1105                                 case Keys.Right:
1106                                         if (GetCurrentlySelectedItem () is ToolStripControlHost)
1107                                                 return false;
1108                                         break;
1109                         }
1110
1111                         return base.ProcessDialogKey (keyData);
1112                 }
1113
1114                 protected override bool ProcessMnemonic (char charCode)
1115                 {
1116                         // If any item has an explicit mnemonic, it gets the message
1117                         foreach (ToolStripItem tsi in this.Items)
1118                                 if (tsi.Enabled && tsi.Visible && !string.IsNullOrEmpty (tsi.Text) && Control.IsMnemonic (charCode, tsi.Text))
1119                                         return tsi.ProcessMnemonic (charCode);
1120
1121                         string code = Char.ToUpper (charCode).ToString ();
1122
1123                         // If any item's text starts with our letter, it gets the message
1124                         if (this is MenuStrip)
1125                                 foreach (ToolStripItem tsi in this.Items)
1126                                         if (tsi.Enabled && tsi.Visible && !string.IsNullOrEmpty (tsi.Text) && tsi.Text.ToUpper ().StartsWith (code))
1127                                                 return tsi.ProcessMnemonic (charCode);
1128
1129                         return base.ProcessMnemonic (charCode);
1130                 }
1131
1132                 [MonoTODO ()]
1133                 [EditorBrowsable (EditorBrowsableState.Advanced)]
1134                 protected virtual void RestoreFocus ()
1135                 {
1136                 }
1137
1138                 [MonoTODO ()]
1139                 protected override void Select (bool directed, bool forward)
1140                 {
1141                         base.Select (directed, forward);
1142                 }
1143
1144                 protected override void SetBoundsCore (int x, int y, int width, int height, BoundsSpecified specified)
1145                 {
1146                         base.SetBoundsCore (x, y, width, height, specified);
1147                 }
1148
1149                 protected virtual void SetDisplayedItems ()
1150                 {
1151                         this.displayed_items.Clear ();
1152
1153                         foreach (ToolStripItem tsi in this.items)
1154                                 if (tsi.Placement == ToolStripItemPlacement.Main && tsi.Available) {
1155                                         this.displayed_items.AddNoOwnerOrLayout (tsi);
1156                                         tsi.Parent = this;
1157                                 }
1158                                 else if (tsi.Placement == ToolStripItemPlacement.Overflow)
1159                                         tsi.Parent = this.OverflowButton.DropDown;
1160
1161                         if (this.OverflowButton != null)
1162                                 this.OverflowButton.DropDown.SetDisplayedItems ();
1163                 }
1164
1165                 protected internal void SetItemLocation (ToolStripItem item, Point location)
1166                 {
1167                         if (item == null)
1168                                 throw new ArgumentNullException ("item");
1169
1170                         if (item.Owner != this)
1171                                 throw new NotSupportedException ("The item is not owned by this ToolStrip");
1172
1173                         item.SetBounds (new Rectangle (location, item.Size));
1174                 }
1175
1176                 protected internal static void SetItemParent (ToolStripItem item, ToolStrip parent)
1177                 {
1178                         if (item.Owner != null) {
1179                                 item.Owner.Items.RemoveNoOwnerOrLayout (item);
1180
1181                                 if (item.Owner is ToolStripOverflow)
1182                                         (item.Owner as ToolStripOverflow).ParentToolStrip.Items.RemoveNoOwnerOrLayout (item);
1183                         }
1184
1185                         parent.Items.AddNoOwnerOrLayout (item);
1186                         item.Parent = parent;
1187                 }
1188
1189                 protected override void SetVisibleCore (bool value)
1190                 {
1191                         base.SetVisibleCore (value);
1192                 }
1193
1194                 protected override void WndProc (ref Message m)
1195                 {
1196                         base.WndProc (ref m);
1197                 }
1198                 #endregion
1199
1200                 #region Public Events
1201                 static object BeginDragEvent = new object ();
1202                 static object EndDragEvent = new object ();
1203                 static object ItemAddedEvent = new object ();
1204                 static object ItemClickedEvent = new object ();
1205                 static object ItemRemovedEvent = new object ();
1206                 static object LayoutCompletedEvent = new object ();
1207                 static object LayoutStyleChangedEvent = new object ();
1208                 static object PaintGripEvent = new object ();
1209                 static object RendererChangedEvent = new object ();
1210
1211                 [Browsable (true)]
1212                 [EditorBrowsable (EditorBrowsableState.Always)]
1213                 public new event EventHandler AutoSizeChanged {
1214                         add { base.AutoSizeChanged += value; }
1215                         remove { base.AutoSizeChanged -= value; }
1216                 }
1217
1218                 [MonoTODO ()]
1219                 public event EventHandler BeginDrag {
1220                         add { Events.AddHandler (BeginDragEvent, value); }
1221                         remove { Events.RemoveHandler (BeginDragEvent, value); }
1222                 }
1223
1224                 [Browsable (false)]
1225                 public new event EventHandler CausesValidationChanged {
1226                         add { base.CausesValidationChanged += value; }
1227                         remove { base.CausesValidationChanged -= value; }
1228                 }
1229
1230                 [Browsable (false)]
1231                 [EditorBrowsable (EditorBrowsableState.Never)]
1232                 public new event ControlEventHandler ControlAdded {
1233                         add { base.ControlAdded += value; }
1234                         remove { base.ControlAdded -= value; }
1235                 }
1236
1237                 [Browsable (false)]
1238                 [EditorBrowsable (EditorBrowsableState.Never)]
1239                 public new event ControlEventHandler ControlRemoved {
1240                         add { base.ControlRemoved += value; }
1241                         remove { base.ControlRemoved -= value; }
1242                 }
1243
1244                 [Browsable (false)]
1245                 public new event EventHandler CursorChanged {
1246                         add { base.CursorChanged += value; }
1247                         remove { base.CursorChanged -= value; }
1248                 }
1249
1250                 [MonoTODO ()]
1251                 public event EventHandler EndDrag {
1252                         add { Events.AddHandler (EndDragEvent, value); }
1253                         remove { Events.RemoveHandler (EndDragEvent, value); }
1254                 }
1255
1256                 [Browsable (false)]
1257                 public new event EventHandler ForeColorChanged {
1258                         add { base.ForeColorChanged += value; }
1259                         remove { base.ForeColorChanged -= value; }
1260                 }
1261
1262                 public event ToolStripItemEventHandler ItemAdded {
1263                         add { Events.AddHandler (ItemAddedEvent, value); }
1264                         remove { Events.RemoveHandler (ItemAddedEvent, value); }
1265                 }
1266
1267                 public event ToolStripItemClickedEventHandler ItemClicked {
1268                         add { Events.AddHandler (ItemClickedEvent, value); }
1269                         remove { Events.RemoveHandler (ItemClickedEvent, value); }
1270                 }
1271
1272                 public event ToolStripItemEventHandler ItemRemoved {
1273                         add { Events.AddHandler (ItemRemovedEvent, value); }
1274                         remove { Events.RemoveHandler (ItemRemovedEvent, value); }
1275                 }
1276
1277                 public event EventHandler LayoutCompleted {
1278                         add { Events.AddHandler (LayoutCompletedEvent, value); }
1279                         remove { Events.RemoveHandler (LayoutCompletedEvent, value); }
1280                 }
1281
1282                 public event EventHandler LayoutStyleChanged {
1283                         add { Events.AddHandler (LayoutStyleChangedEvent, value); }
1284                         remove { Events.RemoveHandler (LayoutStyleChangedEvent, value); }
1285                 }
1286
1287                 public event PaintEventHandler PaintGrip {
1288                         add { Events.AddHandler (PaintGripEvent, value); }
1289                         remove { Events.RemoveHandler (PaintGripEvent, value); }
1290                 }
1291
1292                 public event EventHandler RendererChanged {
1293                         add { Events.AddHandler (RendererChangedEvent, value); }
1294                         remove { Events.RemoveHandler (RendererChangedEvent, value); }
1295                 }
1296                 #endregion
1297
1298                 #region Internal Properties
1299                 internal virtual bool KeyboardActive
1300                 {
1301                         get { return this.keyboard_active; }
1302                         set {
1303                                 if (this.keyboard_active != value) {
1304                                         this.keyboard_active = value;
1305
1306                                         if (value)
1307                                                 Application.KeyboardCapture = this;
1308                                         else if (Application.KeyboardCapture == this) {
1309                                                 Application.KeyboardCapture = null;
1310                                                 ToolStripManager.ActivatedByKeyboard = false;
1311                                         }
1312
1313                                         // Redraw for mnemonic underlines
1314                                         this.Invalidate ();
1315                                 }
1316                         }
1317                 }
1318                 #endregion
1319
1320                 #region Private Methods
1321                 internal virtual Rectangle CalculateConnectedArea ()
1322                 {
1323                         return Rectangle.Empty;
1324                 }
1325
1326                 internal void ChangeSelection (ToolStripItem nextItem)
1327                 {
1328                         if (Application.KeyboardCapture != this)
1329                                 ToolStripManager.SetActiveToolStrip (this, ToolStripManager.ActivatedByKeyboard);
1330
1331                         foreach (ToolStripItem tsi in this.Items)
1332                                 if (tsi != nextItem)
1333                                         tsi.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1334
1335                         ToolStripItem current = GetCurrentlySelectedItem ();
1336
1337                         if (!(current is ToolStripControlHost))
1338                                 this.FocusInternal (true);
1339
1340                         if (nextItem is ToolStripControlHost)
1341                                 (nextItem as ToolStripControlHost).Focus ();
1342
1343                         nextItem.Select ();
1344
1345                         if (nextItem.Parent is MenuStrip && (nextItem.Parent as MenuStrip).MenuDroppedDown)
1346                                 (nextItem as ToolStripMenuItem).HandleAutoExpansion ();
1347                 }
1348
1349                 internal virtual void Dismiss ()
1350                 {
1351                         this.Dismiss (ToolStripDropDownCloseReason.AppClicked);
1352                 }
1353
1354                 internal virtual void Dismiss (ToolStripDropDownCloseReason reason)
1355                 {
1356                         // Release our stranglehold on the keyboard
1357                         this.KeyboardActive = false;
1358
1359                         // Set our drop down flag to false;
1360                         this.menu_selected = false;
1361
1362                         // Make sure all of our items are deselected and repainted
1363                         foreach (ToolStripItem tsi in this.Items)
1364                                 tsi.Dismiss (reason);
1365
1366                         // We probably need to redraw for mnemonic underlines
1367                         this.Invalidate ();
1368                 }
1369
1370                 private void DoAutoSize ()
1371                 {
1372                         if (this.AutoSize == true && this.Dock == DockStyle.None) {
1373                                 Size new_size = GetToolStripPreferredSize (Size.Empty);
1374                                 SetBounds (Left, Top, new_size.Width, new_size.Height, BoundsSpecified.None);
1375                         }
1376
1377                         if (this.AutoSize == true && this.Orientation == Orientation.Horizontal && (this.Dock == DockStyle.Top || this.Dock == DockStyle.Bottom))
1378                                 SetBounds (Left, Top, Width, GetToolStripPreferredSize (Size.Empty).Height, BoundsSpecified.None);
1379                 }
1380
1381                 internal ToolStripItem GetCurrentlySelectedItem ()
1382                 {
1383                         foreach (ToolStripItem tsi in this.DisplayedItems)
1384                                 if (tsi.Selected)
1385                                         return tsi;
1386
1387                         return null;
1388                 }
1389
1390                 internal ToolStripItem GetCurrentlyFocusedItem ()
1391                 {
1392                         foreach (ToolStripItem tsi in this.DisplayedItems)
1393                                 if ((tsi is ToolStripControlHost) && (tsi as ToolStripControlHost).Control.Focused)
1394                                         return tsi;
1395
1396                         return null;
1397                 }
1398
1399                 internal virtual Size GetToolStripPreferredSize (Size proposedSize)
1400                 {
1401                         Size new_size = new Size (0, this.Height);
1402
1403                         if (this.orientation == Orientation.Vertical) {
1404                                 foreach (ToolStripItem tsi in this.items)
1405                                         if (tsi.GetPreferredSize (Size.Empty).Height + tsi.Margin.Top + tsi.Margin.Bottom > new_size.Height)
1406                                                 new_size.Height = tsi.GetPreferredSize (Size.Empty).Height + tsi.Margin.Top + tsi.Margin.Bottom;
1407
1408                                 new_size.Height += this.Padding.Top + this.Padding.Bottom;
1409                                 new_size.Width = this.Width;
1410                         } else {
1411                                 foreach (ToolStripItem tsi in this.items)
1412                                         if (tsi.Available) {
1413                                                 Size tsi_preferred = tsi.GetPreferredSize (Size.Empty);
1414                                                 new_size.Width += tsi_preferred.Width + tsi.Margin.Left + tsi.Margin.Right;
1415
1416                                                 if (new_size.Height < (this.Padding.Vertical + tsi_preferred.Height))
1417                                                         new_size.Height = (this.Padding.Vertical + tsi_preferred.Height);
1418                                         }
1419                         }
1420
1421                         new_size.Width += (this.GripRectangle.Width + this.GripMargin.Horizontal + this.Padding.Horizontal + 4);
1422                         return new_size;
1423                 }
1424
1425                 internal virtual ToolStrip GetTopLevelToolStrip ()
1426                 {
1427                         return this;
1428                 }
1429
1430                 internal virtual void HandleItemClick (ToolStripItem dismissingItem)
1431                 {
1432                         this.GetTopLevelToolStrip ().Dismiss (ToolStripDropDownCloseReason.ItemClicked);
1433                 }
1434
1435                 internal void HideMenus (bool release, ToolStripDropDownCloseReason reason)
1436                 {
1437                         if (this is MenuStrip && release && menu_selected)
1438                                 (this as MenuStrip).FireMenuDeactivate ();
1439
1440                         if (release)
1441                                 menu_selected = false;
1442
1443                         NotifySelectedChanged (null);
1444                 }
1445
1446                 internal void NotifySelectedChanged (ToolStripItem tsi)
1447                 {
1448                         foreach (ToolStripItem tsi2 in this.DisplayedItems)
1449                                 if (tsi != tsi2)
1450                                         if (tsi2 is ToolStripDropDownItem)
1451                                                 (tsi2 as ToolStripDropDownItem).HideDropDown (ToolStripDropDownCloseReason.Keyboard);
1452
1453                         if (this.OverflowButton != null) {
1454                                 ToolStripItemCollection tsic = this.OverflowButton.DropDown.DisplayedItems;
1455
1456                                 foreach (ToolStripItem tsi2 in tsic)
1457                                         if (tsi != tsi2)
1458                                                 if (tsi2 is ToolStripDropDownItem)
1459                                                         (tsi2 as ToolStripDropDownItem).HideDropDown (ToolStripDropDownCloseReason.Keyboard);
1460
1461                                 this.OverflowButton.HideDropDown ();
1462                         }
1463
1464                         foreach (ToolStripItem tsi2 in this.Items)
1465                                 if (tsi != tsi2)
1466                                         tsi2.Dismiss (ToolStripDropDownCloseReason.Keyboard);
1467                 }
1468
1469                 internal virtual bool OnMenuKey ()
1470                 {
1471                         return false;
1472                 }
1473
1474                 internal virtual bool ProcessArrowKey (Keys keyData)
1475                 {
1476                         ToolStripItem tsi;
1477
1478                         switch (keyData) {
1479                                 case Keys.Right:
1480                                         tsi = this.GetCurrentlySelectedItem ();
1481
1482                                         if (tsi is ToolStripControlHost)
1483                                                 return false;
1484
1485                                         tsi = this.SelectNextToolStripItem (tsi, true);
1486
1487                                         if (tsi is ToolStripControlHost)
1488                                                 (tsi as ToolStripControlHost).Focus ();
1489
1490                                         return true;
1491                                 case Keys.Tab:
1492                                         tsi = this.GetCurrentlySelectedItem ();
1493
1494                                         tsi = this.SelectNextToolStripItem (tsi, true);
1495
1496                                         if (tsi is ToolStripControlHost)
1497                                                 (tsi as ToolStripControlHost).Focus ();
1498
1499                                         return true;
1500                                 case Keys.Left:
1501                                         tsi = this.GetCurrentlySelectedItem ();
1502
1503                                         if (tsi is ToolStripControlHost)
1504                                                 return false;
1505
1506                                         tsi = this.SelectNextToolStripItem (tsi, false);
1507
1508                                         if (tsi is ToolStripControlHost)
1509                                                 (tsi as ToolStripControlHost).Focus ();
1510
1511                                         return true;
1512                                 case Keys.Shift | Keys.Tab:
1513                                         tsi = this.GetCurrentlySelectedItem ();
1514
1515                                         tsi = this.SelectNextToolStripItem (tsi, false);
1516
1517                                         if (tsi is ToolStripControlHost)
1518                                                 (tsi as ToolStripControlHost).Focus ();
1519
1520                                         return true;
1521                         }
1522
1523                         return false;
1524                 }
1525
1526                 internal virtual ToolStripItem SelectNextToolStripItem (ToolStripItem start, bool forward)
1527                 {
1528                         ToolStripItem next_item = this.GetNextItem (start, forward ? ArrowDirection.Right : ArrowDirection.Left);
1529
1530                         this.ChangeSelection (next_item);
1531
1532                         if (next_item is ToolStripControlHost)
1533                                 (next_item as ToolStripControlHost).Focus ();
1534
1535                         return next_item;
1536                 }
1537
1538                 #region Stuff for ToolTips
1539                 private void MouseEnteredItem (ToolStripItem item)
1540                 {
1541                         if (this.show_item_tool_tips) {
1542                                 tooltip_currently_showing = item;
1543                                 ToolTipTimer.Start ();
1544                         }
1545                 }
1546
1547                 private void MouseLeftItem (ToolStripItem item)
1548                 {
1549                         ToolTipTimer.Stop ();
1550                         ToolTipWindow.Hide (this);
1551                         tooltip_currently_showing = null;
1552                 }
1553
1554                 private Timer ToolTipTimer {
1555                         get {
1556                                 if (tooltip_timer == null) {
1557                                         tooltip_timer = new Timer ();
1558                                         tooltip_timer.Enabled = false;
1559                                         tooltip_timer.Interval = 500;
1560                                         tooltip_timer.Tick += new EventHandler (ToolTipTimer_Tick);
1561                                 }
1562
1563                                 return tooltip_timer;
1564                         }
1565                 }
1566
1567                 private ToolTip ToolTipWindow {
1568                         get {
1569                                 if (tooltip_window == null)
1570                                         tooltip_window = new ToolTip ();
1571
1572                                 return tooltip_window;
1573                         }
1574                 }
1575
1576                 private void ToolTipTimer_Tick (object o, EventArgs args)
1577                 {
1578                         string tooltip = tooltip_currently_showing.GetToolTip ();
1579
1580                         if (!string.IsNullOrEmpty (tooltip))
1581                                 ToolTipWindow.Present (this, tooltip);
1582
1583                         tooltip_currently_showing.FireEvent (EventArgs.Empty, ToolStripItemEventType.MouseHover);
1584
1585                         ToolTipTimer.Stop ();
1586                 }
1587                 #endregion
1588
1589                 #region Stuff for Merging
1590                 internal ToolStrip CurrentlyMergedWith {
1591                         get { return this.currently_merged_with; }
1592                         set { this.currently_merged_with = value; }
1593                 }
1594
1595                 internal List<ToolStripItem> HiddenMergedItems {
1596                         get {
1597                                 if (this.hidden_merged_items == null)
1598                                         this.hidden_merged_items = new List<ToolStripItem> ();
1599
1600                                 return this.hidden_merged_items;
1601                         }
1602                 }
1603
1604                 internal bool IsCurrentlyMerged {
1605                         get { return this.is_currently_merged; }
1606                         set {
1607                                 this.is_currently_merged = value;
1608
1609                                 if (!value && this is MenuStrip)
1610                                         foreach (ToolStripMenuItem tsmi in this.Items)
1611                                                 tsmi.DropDown.IsCurrentlyMerged = value;
1612                          }
1613                 }
1614
1615                 internal void BeginMerge ()
1616                 {
1617                         if (!IsCurrentlyMerged) {
1618                                 IsCurrentlyMerged = true;
1619
1620                                 if (this.pre_merge_items == null) {
1621                                         this.pre_merge_items = new List<ToolStripItem> ();
1622
1623                                 foreach (ToolStripItem tsi in this.Items)
1624                                         this.pre_merge_items.Add (tsi);
1625                                 }
1626                         }
1627                 }
1628
1629                 internal void RevertMergeItem (ToolStripItem item)
1630                 {
1631                         int index = 0;
1632
1633                         // Remove it from it's current Parent
1634                         if (item.Parent != null && item.Parent != this) {
1635                                 if (item.Parent is ToolStripOverflow)
1636                                         (item.Parent as ToolStripOverflow).ParentToolStrip.Items.RemoveNoOwnerOrLayout (item);
1637                                 else
1638                                         item.Parent.Items.RemoveNoOwnerOrLayout (item);
1639
1640                                 item.Parent = item.Owner;
1641                         }
1642
1643                         // Find where the item was before the merge
1644                         index = item.Owner.pre_merge_items.IndexOf (item);
1645
1646                         // Find the first pre-merge item that was after this item, that
1647                         // is currently in the Items collection.  Insert our item before
1648                         // that one.
1649                         for (int i = index; i < this.pre_merge_items.Count; i++) {
1650                                 if (this.Items.Contains (this.pre_merge_items[i])) {
1651                                         item.Owner.Items.InsertNoOwnerOrLayout (this.Items.IndexOf (this.pre_merge_items[i]), item);
1652                                         return;
1653                                 }
1654                         }
1655
1656                         // There aren't any items that are supposed to be after this item,
1657                         // so just append it to the end.
1658                         item.Owner.Items.AddNoOwnerOrLayout (item);
1659                 }
1660                 #endregion
1661                 #endregion
1662
1663                 #region ToolStripAccessibleObject
1664                 [ComVisible (true)]
1665                 public class ToolStripAccessibleObject : ControlAccessibleObject
1666                 {
1667                         #region Public Constructor
1668                         public ToolStripAccessibleObject (ToolStrip owner) : base (owner)
1669                         {
1670                         }
1671                         #endregion
1672
1673                         #region Public Properties
1674                         public override AccessibleRole Role {
1675                                 get { return AccessibleRole.ToolBar; }
1676                         }
1677                         #endregion
1678
1679                         #region Public Methods
1680                         public override AccessibleObject GetChild (int index)
1681                         {
1682                                 return base.GetChild (index);
1683                         }
1684
1685                         public override int GetChildCount ()
1686                         {
1687                                 return (owner as ToolStrip).Items.Count;
1688                         }
1689
1690                         public override AccessibleObject HitTest (int x, int y)
1691                         {
1692                                 return base.HitTest (x, y);
1693                         }
1694                         #endregion
1695                 }
1696                 #endregion
1697         }
1698 }
1699 #endif