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 bool defaut_item;
57 private bool ownerdraw;
59 private int mergeorder;
61 private int menuheight;
63 private DrawItemState status;
64 private MenuMerge mergetype;
66 public MenuItem (): base (null)
68 CommonConstructor (string.Empty);
69 shortcut = Shortcut.None;
72 public MenuItem (string text) : base (null)
74 CommonConstructor (text);
75 shortcut = Shortcut.None;
78 public MenuItem (string text, EventHandler onClick) : base (null)
80 CommonConstructor (text);
81 shortcut = Shortcut.None;
85 public MenuItem (string text, MenuItem[] items) : base (items)
87 CommonConstructor (text);
88 shortcut = Shortcut.None;
91 public MenuItem (string text, EventHandler onClick, Shortcut shortcut) : base (null)
93 CommonConstructor (text);
95 this.shortcut = shortcut;
98 public MenuItem (MenuMerge mergeType, int mergeOrder, Shortcut shortcut, string text,
99 EventHandler onClick, EventHandler onPopup, EventHandler onSelect, MenuItem[] items)
102 CommonConstructor (text);
104 mergeorder = mergeOrder;
105 mergetype = mergeType;
112 private void CommonConstructor (string text)
123 status = DrawItemState.None;
131 mergetype = MenuMerge.Add;
132 Text = text; // Text can change separator status
136 public event EventHandler Click;
137 public event DrawItemEventHandler DrawItem;
138 public event MeasureItemEventHandler MeasureItem;
139 public event EventHandler Popup;
140 public event EventHandler Select;
143 #region Public Properties
146 [DefaultValue(false)]
147 public bool BarBreak {
148 get { return break_; }
149 set { break_ = value; }
153 [DefaultValue(false)]
155 get { return bar_break; }
156 set { bar_break = value; }
159 [DefaultValue(false)]
160 public bool Checked {
161 get { return checked_; }
162 set { checked_ = value; }
165 [DefaultValue(false)]
166 public bool DefaultItem {
167 get { return defaut_item; }
168 set { defaut_item = value; }
173 public bool Enabled {
174 get { return enabled; }
175 set { enabled = value; }
180 get { return index; }
181 set { index = value; }
185 public override bool IsParent {
186 get { return IsPopup; }
189 [DefaultValue(false)]
190 public bool MdiList {
191 get { return mdilist; }
192 set { mdilist = value; }
195 protected int MenuID {
196 get { return menuid; }
200 public int MergeOrder {
201 get { return mergeorder; }
202 set { mergeorder = value; }
205 [DefaultValue(MenuMerge.Add)]
206 public MenuMerge MergeType {
207 get { return mergetype; }
209 if (!Enum.IsDefined (typeof (MenuMerge), value))
210 throw new InvalidEnumArgumentException (string.Format("Enum argument value '{0}' is not valid for MenuMerge", value));
217 public char Mnemonic {
218 get { return mnemonic; }
221 [DefaultValue(false)]
222 public bool OwnerDraw {
223 get { return ownerdraw; }
224 set { ownerdraw = value; }
229 get { return parent_menu;}
232 [DefaultValue(false)]
233 public bool RadioCheck {
234 get { return radiocheck; }
235 set { radiocheck = value; }
238 [DefaultValue(Shortcut.None)]
240 public Shortcut Shortcut {
241 get { return shortcut;}
243 if (!Enum.IsDefined (typeof (Shortcut), value))
244 throw new InvalidEnumArgumentException (string.Format("Enum argument value '{0}' is not valid for Shortcut", value));
252 public bool ShowShortcut {
253 get { return showshortcut;}
254 set { showshortcut = value; }
274 public bool Visible {
275 get { return visible;}
276 set { visible = value; }
279 #endregion Public Properties
281 #region Private Properties
283 internal bool IsPopup {
285 if (menu_items.Count > 0)
292 internal bool MeasureEventDefined {
294 if (ownerdraw == true && MeasureItem != null) {
302 internal bool MenuBar {
303 get { return menubar; }
304 set { menubar = value; }
307 internal int MenuHeight {
308 get { return menuheight; }
309 set { menuheight = value; }
312 internal bool Separator {
313 get { return separator; }
314 set { separator = value; }
317 internal DrawItemState Status {
318 get { return status; }
319 set { status = value; }
324 set { xtab = value; }
327 #endregion Private Properties
329 #region Public Methods
331 public virtual MenuItem CloneMenu ()
333 MenuItem item = new MenuItem ();
334 item.CloneMenu (this);
338 protected void CloneMenu (MenuItem menuitem)
340 base.CloneMenu (menuitem); // Copy subitems
343 BarBreak = menuitem.BarBreak;
344 Break = menuitem.Break;
345 Checked = menuitem.Checked;
346 DefaultItem = menuitem.DefaultItem;
347 Enabled = menuitem.Enabled;
348 MergeOrder = menuitem.MergeOrder;
349 MergeType = menuitem.MergeType;
350 OwnerDraw = menuitem.OwnerDraw;
351 //Parent = menuitem.Parent;
352 RadioCheck = menuitem.RadioCheck;
353 Shortcut = menuitem.Shortcut;
354 ShowShortcut = menuitem.ShowShortcut;
355 Text = menuitem.Text;
356 Visible = menuitem.Visible;
359 Click = menuitem.Click;
360 DrawItem = menuitem.DrawItem;
361 MeasureItem = menuitem.MeasureItem;
362 Popup = menuitem.Popup;
363 Select = menuitem.Select;
366 protected override void Dispose (bool disposing)
368 base.Dispose (disposing);
371 // This really clones the item
372 public virtual MenuItem MergeMenu ()
374 MenuItem item = new MenuItem ();
375 item.CloneMenu (this);
379 public void MergeMenu (MenuItem menuitem)
381 base.MergeMenu (menuitem);
384 protected virtual void OnClick (EventArgs e)
390 protected virtual void OnDrawItem (DrawItemEventArgs e)
392 if (DrawItem != null) {
397 ThemeEngine.Current.DrawMenuItem (this, e);
401 protected virtual void OnInitMenuPopup (EventArgs e)
406 protected virtual void OnMeasureItem (MeasureItemEventArgs e)
408 if (MeasureItem != null)
409 MeasureItem (this, e);
412 protected virtual void OnPopup (EventArgs e)
418 protected virtual void OnSelect (EventArgs e)
424 public void PerformClick ()
426 OnClick (EventArgs.Empty);
429 public virtual void PerformSelect ()
431 OnSelect (EventArgs.Empty);
434 public override string ToString ()
436 return base.ToString () + ", Items.Count: " + MenuItems.Count + ", Text: " + text;
439 #endregion Public Methods
441 #region Private Methods
443 internal void Create ()
445 IntPtr hSubMenu = IntPtr.Zero;
447 menuid = index = MenuAPI.InsertMenuItem (Parent.Handle, -1, true, this, ref hSubMenu);
451 menu_handle = hSubMenu;
456 internal void PerformDrawItem (DrawItemEventArgs e)
461 internal void PerformMeasureItem (MeasureItemEventArgs e)
466 private void ProcessMnemonic ()
468 if (text.Length < 2) {
473 bool bPrevAmp = false;
474 for (int i = 0; i < text.Length -1 ; i++) {
475 if (text[i] == '&') {
476 if (bPrevAmp == false && (text[i+1] != '&')) {
477 mnemonic = Char.ToUpper (text[i+1]);
490 private string GetShortCutTextCtrl () { return "Ctrl"; }
491 private string GetShortCutTextAlt () { return "Alt"; }
492 private string GetShortCutTextShift () { return "Shift"; }
494 internal string GetShortCutText ()
496 /* Ctrl+A - Ctrl+Z */
497 if (Shortcut >= Shortcut.CtrlA && Shortcut <= Shortcut.CtrlZ)
498 return GetShortCutTextCtrl () + "+" + (char)((int) 'A' + (int)(Shortcut - Shortcut.CtrlA));
501 if (Shortcut >= Shortcut.Alt0 && Shortcut <= Shortcut.Alt9)
502 return GetShortCutTextAlt () + "+" + (char)((int) '0' + (int)(Shortcut - Shortcut.Alt0));
504 /* Alt+F1 - Alt+F2 */
505 if (Shortcut >= Shortcut.AltF1 && Shortcut <= Shortcut.AltF9)
506 return GetShortCutTextAlt () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.AltF1));
508 /* Ctrl+0 - Ctrl+9 */
509 if (Shortcut >= Shortcut.Ctrl0 && Shortcut <= Shortcut.Ctrl9)
510 return GetShortCutTextCtrl () + "+" + (char)((int) '0' + (int)(Shortcut - Shortcut.Ctrl0));
512 /* Ctrl+F0 - Ctrl+F9 */
513 if (Shortcut >= Shortcut.CtrlF1 && Shortcut <= Shortcut.CtrlF9)
514 return GetShortCutTextCtrl () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.CtrlF1));
516 /* Ctrl+Shift+0 - Ctrl+Shift+9 */
517 if (Shortcut >= Shortcut.CtrlShift0 && Shortcut <= Shortcut.CtrlShift9)
518 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+" + (char)((int) '0' + (int)(Shortcut - Shortcut.CtrlShift0));
520 /* Ctrl+Shift+A - Ctrl+Shift+Z */
521 if (Shortcut >= Shortcut.CtrlShiftA && Shortcut <= Shortcut.CtrlShiftZ)
522 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+" + (char)((int) 'A' + (int)(Shortcut - Shortcut.CtrlShiftA));
524 /* Ctrl+Shift+F1 - Ctrl+Shift+F9 */
525 if (Shortcut >= Shortcut.CtrlShiftF1 && Shortcut <= Shortcut.CtrlShiftF9)
526 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.CtrlShiftF1));
529 if (Shortcut >= Shortcut.F1 && Shortcut <= Shortcut.F9)
530 return "F" + (char)((int) '1' + (int)(Shortcut - Shortcut.F1));
532 /* Shift+F1 - Shift+F9 */
533 if (Shortcut >= Shortcut.ShiftF1 && Shortcut <= Shortcut.ShiftF9)
534 return GetShortCutTextShift () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.ShiftF1));
538 case Shortcut.AltBksp:
540 case Shortcut.AltF10:
541 return GetShortCutTextAlt () + "+F10";
542 case Shortcut.AltF11:
543 return GetShortCutTextAlt () + "+F11";
544 case Shortcut.AltF12:
545 return GetShortCutTextAlt () + "+F12";
546 case Shortcut.CtrlDel:
547 return GetShortCutTextCtrl () + "+Del";
548 case Shortcut.CtrlF10:
549 return GetShortCutTextCtrl () + "+F10";
550 case Shortcut.CtrlF11:
551 return GetShortCutTextCtrl () + "+F11";
552 case Shortcut.CtrlF12:
553 return GetShortCutTextCtrl () + "+F12";
554 case Shortcut.CtrlIns:
555 return GetShortCutTextCtrl () + "+Ins";
556 case Shortcut.CtrlShiftF10:
557 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+F10";
558 case Shortcut.CtrlShiftF11:
559 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+F11";
560 case Shortcut.CtrlShiftF12:
561 return GetShortCutTextCtrl () + "+" + GetShortCutTextShift () + "+F12";
574 case Shortcut.ShiftDel:
575 return GetShortCutTextShift () + "+Del";
576 case Shortcut.ShiftF10:
577 return GetShortCutTextShift () + "+F10";
578 case Shortcut.ShiftF11:
579 return GetShortCutTextShift () + "+F11";
580 case Shortcut.ShiftF12:
581 return GetShortCutTextShift () + "+F12";
582 case Shortcut.ShiftIns:
583 return GetShortCutTextShift () + "+Ins";
591 #endregion Private Methods