1 // Permission is hereby granted, free of charge, to any person obtaining
2 // a copy of this software and associated documentation files (the
3 // "Software"), to deal in the Software without restriction, including
4 // without limitation the rights to use, copy, modify, merge, publish,
5 // distribute, sublicense, and/or sell copies of the Software, and to
6 // permit persons to whom the Software is furnished to do so, subject to
7 // the following conditions:
9 // The above copyright notice and this permission notice shall be
10 // included in all copies or substantial portions of the Software.
12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 // Copyright (c) 2004-2005 Novell, Inc.
23 // Jordi Mas i Hernandez, jordi@ximian.com
29 using System.Collections;
30 using System.ComponentModel;
31 using System.ComponentModel.Design;
33 using System.Drawing.Text;
35 namespace System.Windows.Forms
37 [DefaultProperty("Text")]
38 [DefaultEvent("Click")]
39 [DesignTimeVisible(false)]
41 public class MenuItem : Menu
43 internal bool separator;
45 internal bool bar_break;
46 private Shortcut shortcut;
48 private bool checked_;
49 private bool radiocheck;
51 private char mnemonic;
52 private bool showshortcut;
55 private Hashtable mdilist_items;
56 private MdiClient mdicontainer;
57 private bool defaut_item;
59 private bool ownerdraw;
61 private int mergeorder;
63 private int menuheight;
65 private DrawItemState status;
66 private MenuMerge mergetype;
67 internal Rectangle bounds;
69 public MenuItem (): base (null)
71 CommonConstructor (string.Empty);
72 shortcut = Shortcut.None;
75 public MenuItem (string text) : base (null)
77 CommonConstructor (text);
78 shortcut = Shortcut.None;
81 public MenuItem (string text, EventHandler onClick) : base (null)
83 CommonConstructor (text);
84 shortcut = Shortcut.None;
88 public MenuItem (string text, MenuItem[] items) : base (items)
90 CommonConstructor (text);
91 shortcut = Shortcut.None;
94 public MenuItem (string text, EventHandler onClick, Shortcut shortcut) : base (null)
96 CommonConstructor (text);
98 this.shortcut = shortcut;
101 public MenuItem (MenuMerge mergeType, int mergeOrder, Shortcut shortcut, string text,
102 EventHandler onClick, EventHandler onPopup, EventHandler onSelect, MenuItem[] items)
105 CommonConstructor (text);
106 this.shortcut = shortcut;
107 mergeorder = mergeOrder;
108 mergetype = mergeType;
115 private void CommonConstructor (string text)
127 status = DrawItemState.None;
135 mergetype = MenuMerge.Add;
136 Text = text; // Text can change separator status
140 public event EventHandler Click;
141 public event DrawItemEventHandler DrawItem;
142 public event MeasureItemEventHandler MeasureItem;
143 public event EventHandler Popup;
144 public event EventHandler Select;
147 #region Public Properties
150 [DefaultValue(false)]
151 public bool BarBreak {
152 get { return break_; }
153 set { break_ = value; }
157 [DefaultValue(false)]
159 get { return bar_break; }
160 set { bar_break = value; }
163 [DefaultValue(false)]
164 public bool Checked {
165 get { return checked_; }
166 set { checked_ = value; }
169 [DefaultValue(false)]
170 public bool DefaultItem {
171 get { return defaut_item; }
172 set { defaut_item = value; }
177 public bool Enabled {
178 get { return enabled; }
179 set { enabled = value; }
184 get { return index; }
186 if (Parent != null && Parent.MenuItems != null && (value < 0 || value >= Parent.MenuItems.Count))
187 throw new ArgumentException ("'" + value + "' is not a valid value for 'value'");
193 public override bool IsParent {
194 get { return IsPopup; }
197 [DefaultValue(false)]
198 public bool MdiList {
199 get { return mdilist; }
201 if (mdilist == value)
205 if (mdilist || mdilist_items == null)
208 foreach (MenuItem item in mdilist_items.Keys)
209 MenuItems.Remove (item);
210 mdilist_items.Clear ();
211 mdilist_items = null;
216 protected int MenuID {
217 get { return menuid; }
221 public int MergeOrder {
222 get { return mergeorder; }
223 set { mergeorder = value; }
226 [DefaultValue(MenuMerge.Add)]
227 public MenuMerge MergeType {
228 get { return mergetype; }
230 if (!Enum.IsDefined (typeof (MenuMerge), value))
231 throw new InvalidEnumArgumentException (string.Format("Enum argument value '{0}' is not valid for MenuMerge", value));
238 public char Mnemonic {
239 get { return mnemonic; }
242 [DefaultValue(false)]
243 public bool OwnerDraw {
244 get { return ownerdraw; }
245 set { ownerdraw = value; }
250 get { return parent_menu;}
253 [DefaultValue(false)]
254 public bool RadioCheck {
255 get { return radiocheck; }
256 set { radiocheck = value; }
259 [DefaultValue(Shortcut.None)]
261 public Shortcut Shortcut {
262 get { return shortcut;}
264 if (!Enum.IsDefined (typeof (Shortcut), value))
265 throw new InvalidEnumArgumentException (string.Format("Enum argument value '{0}' is not valid for Shortcut", value));
273 public bool ShowShortcut {
274 get { return showshortcut;}
275 set { showshortcut = value; }
295 public bool Visible {
296 get { return visible;}
298 if (value == visible)
303 if (menu_items != null) {
304 foreach (MenuItem mi in menu_items)
308 if (parent_menu != null)
309 parent_menu.MenuChanged ();
313 #endregion Public Properties
315 #region Private Properties
317 internal new int Height {
318 get { return bounds.Height; }
319 set { bounds.Height = value; }
322 internal bool IsPopup {
324 if (menu_items.Count > 0)
331 internal bool MeasureEventDefined {
333 if (ownerdraw == true && MeasureItem != null) {
341 internal bool MenuBar {
342 get { return menubar; }
343 set { menubar = value; }
346 internal int MenuHeight {
347 get { return menuheight; }
348 set { menuheight = value; }
351 internal bool Separator {
352 get { return separator; }
353 set { separator = value; }
356 internal DrawItemState Status {
357 get { return status; }
358 set { status = value; }
361 internal new int Width {
362 get { return bounds.Width; }
363 set { bounds.Width = value; }
367 get { return bounds.X; }
368 set { bounds.X = value; }
373 set { xtab = value; }
377 get { return bounds.Y; }
378 set { bounds.Y = value; }
381 #endregion Private Properties
383 #region Public Methods
385 public virtual MenuItem CloneMenu ()
387 MenuItem item = new MenuItem ();
388 item.CloneMenu (this);
392 protected void CloneMenu (MenuItem menuitem)
394 base.CloneMenu (menuitem); // Copy subitems
397 BarBreak = menuitem.BarBreak;
398 Break = menuitem.Break;
399 Checked = menuitem.Checked;
400 DefaultItem = menuitem.DefaultItem;
401 Enabled = menuitem.Enabled;
402 MergeOrder = menuitem.MergeOrder;
403 MergeType = menuitem.MergeType;
404 OwnerDraw = menuitem.OwnerDraw;
405 //Parent = menuitem.Parent;
406 RadioCheck = menuitem.RadioCheck;
407 Shortcut = menuitem.Shortcut;
408 ShowShortcut = menuitem.ShowShortcut;
409 Text = menuitem.Text;
410 Visible = menuitem.Visible;
413 Click = menuitem.Click;
414 DrawItem = menuitem.DrawItem;
415 MeasureItem = menuitem.MeasureItem;
416 Popup = menuitem.Popup;
417 Select = menuitem.Select;
420 protected override void Dispose (bool disposing)
422 base.Dispose (disposing);
425 // This really clones the item
426 public virtual MenuItem MergeMenu ()
428 MenuItem item = new MenuItem ();
429 item.CloneMenu (this);
433 public void MergeMenu (MenuItem menuitem)
435 base.MergeMenu (menuitem);
438 protected virtual void OnClick (EventArgs e)
444 protected virtual void OnDrawItem (DrawItemEventArgs e)
446 if (DrawItem != null) {
451 ThemeEngine.Current.DrawMenuItem (this, e);
455 protected virtual void OnInitMenuPopup (EventArgs e)
460 protected virtual void OnMeasureItem (MeasureItemEventArgs e)
462 if (MeasureItem != null)
463 MeasureItem (this, e);
466 protected virtual void OnPopup (EventArgs e)
472 protected virtual void OnSelect (EventArgs e)
478 public void PerformClick ()
480 OnClick (EventArgs.Empty);
483 public virtual void PerformSelect ()
485 OnSelect (EventArgs.Empty);
488 public override string ToString ()
490 return base.ToString () + ", Items.Count: " + MenuItems.Count + ", Text: " + text;
493 #endregion Public Methods
495 #region Private Methods
497 internal void PerformDrawItem (DrawItemEventArgs e)
499 if (mdilist && mdilist_items == null) {
501 // Add the mdilist for the first time
502 mdilist_items = new Hashtable ();
504 MainMenu main = GetMainMenu ();
505 if (main == null || main.GetForm () == null)
508 Form form = main.GetForm ();
509 mdicontainer = form.MdiContainer;
510 if (mdicontainer == null)
513 foreach (Form mdichild in mdicontainer.Controls) {
514 MenuItem item = new MenuItem (mdichild.Text);
515 item.Click += new EventHandler (MdiWindowClickHandler);
516 MenuItems.Add (item);
517 mdilist_items.Add (item, form);
526 internal void PerformMeasureItem (MeasureItemEventArgs e)
531 private void ProcessMnemonic ()
533 if (text.Length < 2) {
538 bool bPrevAmp = false;
539 for (int i = 0; i < text.Length -1 ; i++) {
540 if (text[i] == '&') {
541 if (bPrevAmp == false && (text[i+1] != '&')) {
542 mnemonic = Char.ToUpper (text[i+1]);
555 private string GetShortCutTextCtrl () { return "Ctrl"; }
556 private string GetShortCutTextAlt () { return "Alt"; }
557 private string GetShortCutTextShift () { return "Shift"; }
559 internal string GetShortCutText ()
561 /* Ctrl+A - Ctrl+Z */
562 if (Shortcut >= Shortcut.CtrlA && Shortcut <= Shortcut.CtrlZ)
563 return GetShortCutTextCtrl () + "+" + (char)((int) 'A' + (int)(Shortcut - Shortcut.CtrlA));
566 if (Shortcut >= Shortcut.Alt0 && Shortcut <= Shortcut.Alt9)
567 return GetShortCutTextAlt () + "+" + (char)((int) '0' + (int)(Shortcut - Shortcut.Alt0));
569 /* Alt+F1 - Alt+F2 */
570 if (Shortcut >= Shortcut.AltF1 && Shortcut <= Shortcut.AltF9)
571 return GetShortCutTextAlt () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.AltF1));
573 /* Ctrl+0 - Ctrl+9 */
574 if (Shortcut >= Shortcut.Ctrl0 && Shortcut <= Shortcut.Ctrl9)
575 return GetShortCutTextCtrl () + "+" + (char)((int) '0' + (int)(Shortcut - Shortcut.Ctrl0));
577 /* Ctrl+F0 - Ctrl+F9 */
578 if (Shortcut >= Shortcut.CtrlF1 && Shortcut <= Shortcut.CtrlF9)
579 return GetShortCutTextCtrl () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.CtrlF1));
581 /* Ctrl+Shift+0 - Ctrl+Shift+9 */
582 if (Shortcut >= Shortcut.CtrlShift0 && Shortcut <= Shortcut.CtrlShift9)
583 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+" + (char)((int) '0' + (int)(Shortcut - Shortcut.CtrlShift0));
585 /* Ctrl+Shift+A - Ctrl+Shift+Z */
586 if (Shortcut >= Shortcut.CtrlShiftA && Shortcut <= Shortcut.CtrlShiftZ)
587 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+" + (char)((int) 'A' + (int)(Shortcut - Shortcut.CtrlShiftA));
589 /* Ctrl+Shift+F1 - Ctrl+Shift+F9 */
590 if (Shortcut >= Shortcut.CtrlShiftF1 && Shortcut <= Shortcut.CtrlShiftF9)
591 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.CtrlShiftF1));
594 if (Shortcut >= Shortcut.F1 && Shortcut <= Shortcut.F9)
595 return "F" + (char)((int) '1' + (int)(Shortcut - Shortcut.F1));
597 /* Shift+F1 - Shift+F9 */
598 if (Shortcut >= Shortcut.ShiftF1 && Shortcut <= Shortcut.ShiftF9)
599 return GetShortCutTextShift () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.ShiftF1));
603 case Shortcut.AltBksp:
605 case Shortcut.AltF10:
606 return GetShortCutTextAlt () + "+F10";
607 case Shortcut.AltF11:
608 return GetShortCutTextAlt () + "+F11";
609 case Shortcut.AltF12:
610 return GetShortCutTextAlt () + "+F12";
611 case Shortcut.CtrlDel:
612 return GetShortCutTextCtrl () + "+Del";
613 case Shortcut.CtrlF10:
614 return GetShortCutTextCtrl () + "+F10";
615 case Shortcut.CtrlF11:
616 return GetShortCutTextCtrl () + "+F11";
617 case Shortcut.CtrlF12:
618 return GetShortCutTextCtrl () + "+F12";
619 case Shortcut.CtrlIns:
620 return GetShortCutTextCtrl () + "+Ins";
621 case Shortcut.CtrlShiftF10:
622 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+F10";
623 case Shortcut.CtrlShiftF11:
624 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+F11";
625 case Shortcut.CtrlShiftF12:
626 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+F12";
639 case Shortcut.ShiftDel:
640 return GetShortCutTextShift () + "+Del";
641 case Shortcut.ShiftF10:
642 return GetShortCutTextShift () + "+F10";
643 case Shortcut.ShiftF11:
644 return GetShortCutTextShift () + "+F11";
645 case Shortcut.ShiftF12:
646 return GetShortCutTextShift () + "+F12";
647 case Shortcut.ShiftIns:
648 return GetShortCutTextShift () + "+Ins";
656 private void MdiWindowClickHandler (object sender, EventArgs e)
658 Form mdichild = (Form) mdilist_items [SelectedItem];
660 // people could add weird items to the Window menu
661 // so we can't assume its just us
662 if (mdichild == null)
665 mdicontainer.ActivateChild (mdichild);
668 #endregion Private Methods