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

   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:
   8 //
   9 // The above copyright notice and this permission notice shall be
  10 // included in all copies or substantial portions of the Software.
  11 //
  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.
  19 //
  20 // Copyright (c) 2004-2005 Novell, Inc.
  21 //
  22 // Authors:
  23 //      Jordi Mas i Hernandez, jordi@ximian.com
  24 //
  25 //
  26
  27 // NOT COMPLETE
  28
  29 using System.Collections;
  30 using System.ComponentModel;
  31 using System.ComponentModel.Design;
  32 using System.Drawing;
  33 using System.Drawing.Text;
  34
  35 namespace System.Windows.Forms
  36 {
  37         [DefaultProperty("Text")]
  38         [DefaultEvent("Click")]
  39         [DesignTimeVisible(false)]
  40         [ToolboxItem(false)]
  41         public class MenuItem : Menu
  42         {
  43                 internal bool separator;
  44                 internal bool break_;
  45                 internal bool bar_break;
  46                 private Shortcut shortcut;
  47                 private string text;
  48                 private bool checked_;
  49                 private bool radiocheck;
  50                 private bool enabled;
  51                 private char mnemonic;
  52                 private bool showshortcut;
  53                 private int index;
  54                 private bool mdilist;
  55                 private Hashtable mdilist_items;
  56                 private MdiClient mdicontainer;
  57                 private bool defaut_item;
  58                 private bool visible;
  59                 private bool ownerdraw;
  60                 private int menuid;
  61                 private int mergeorder;
  62                 private int xtab;
  63                 private int menuheight;
  64                 private bool menubar;
  65                 private DrawItemState status;
  66                 private MenuMerge mergetype;
  67                 internal Rectangle bounds;
  68
  69                 public MenuItem (): base (null)
  70                 {
  71                         CommonConstructor (string.Empty);
  72                         shortcut = Shortcut.None;
  73                 }
  74
  75                 public MenuItem (string text) : base (null)
  76                 {
  77                         CommonConstructor (text);
  78                         shortcut = Shortcut.None;
  79                 }
  80
  81                 public MenuItem (string text, EventHandler onClick) : base (null)
  82                 {
  83                         CommonConstructor (text);
  84                         shortcut = Shortcut.None;
  85                         Click += onClick;
  86                 }
  87
  88                 public MenuItem (string text, MenuItem[] items) : base (items)
  89                 {
  90                         CommonConstructor (text);
  91                         shortcut = Shortcut.None;
  92                 }
  93
  94                 public MenuItem (string text, EventHandler onClick, Shortcut shortcut) : base (null)
  95                 {
  96                         CommonConstructor (text);
  97                         Click += onClick;
  98                         this.shortcut = shortcut;
  99                 }
 100
 101                 public MenuItem (MenuMerge mergeType, int mergeOrder, Shortcut shortcut, string text,
 102                         EventHandler onClick, EventHandler onPopup,  EventHandler onSelect,  MenuItem[] items)
 103                         : base (items)
 104                 {
 105                         CommonConstructor (text);
 106                         this.shortcut = shortcut;
 107                         mergeorder = mergeOrder;
 108                         mergetype = mergeType;
 109
 110                         Click += onClick;
 111                         Popup += onPopup;
 112                         Select += onSelect;
 113                 }
 114
 115                 private void CommonConstructor (string text)
 116                 {
 117                         defaut_item = false;
 118                         separator = false;
 119                         break_ = false;
 120                         bar_break = false;
 121                         checked_ = false;
 122                         radiocheck = false;
 123                         enabled = true;
 124                         showshortcut = true;
 125                         visible = true;
 126                         ownerdraw = false;
 127                         status = DrawItemState.None;
 128                         menubar = false;
 129                         menuheight = 0;
 130                         xtab = 0;
 131                         index = -1;
 132                         mnemonic = '\0';
 133                         menuid = -1;
 134                         mergeorder = 0;
 135                         mergetype = MenuMerge.Add;
 136                         Text = text;    // Text can change separator status
 137                 }
 138
 139                 #region Events
 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;
 145                 #endregion // Events
 146
 147                 #region Public Properties
 148
 149                 [Browsable(false)]
 150                 [DefaultValue(false)]
 151                 public bool BarBreak {
 152                         get { return break_; }
 153                         set { break_ = value; }
 154                 }
 155
 156                 [Browsable(false)]
 157                 [DefaultValue(false)]
 158                 public bool Break {
 159                         get { return bar_break; }
 160                         set { bar_break = value; }
 161                 }
 162
 163                 [DefaultValue(false)]
 164                 public bool Checked {
 165                         get { return checked_; }
 166                         set { checked_ = value; }
 167                 }
 168
 169                 [DefaultValue(false)]
 170                 public bool DefaultItem {
 171                         get { return defaut_item; }
 172                         set { defaut_item = value; }
 173                 }
 174
 175                 [DefaultValue(true)]
 176                 [Localizable(true)]
 177                 public bool Enabled {
 178                         get { return enabled; }
 179                         set { enabled = value; }
 180                 }
 181
 182                 [Browsable(false)]
 183                 public int Index {
 184                         get { return index; }
 185                         set {
 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'");
 188                                 index = value;
 189                         }
 190                 }
 191
 192                 [Browsable(false)]
 193                 public override bool IsParent {
 194                         get { return IsPopup; }
 195                 }
 196
 197                 [DefaultValue(false)]
 198                 public bool MdiList {
 199                         get { return mdilist; }
 200                         set {
 201                                 if (mdilist == value)
 202                                         return;
 203                                 mdilist = value;
 204
 205                                 if (mdilist || mdilist_items == null)
 206                                         return;
 207
 208                                 foreach (MenuItem item in mdilist_items.Keys)
 209                                         MenuItems.Remove (item);
 210                                 mdilist_items.Clear ();
 211                                 mdilist_items = null;
 212
 213                         }
 214                 }
 215
 216                 protected int MenuID {
 217                         get { return menuid; }
 218                 }
 219
 220                 [DefaultValue(0)]
 221                 public int MergeOrder {
 222                         get { return mergeorder; }
 223                         set { mergeorder = value; }
 224                 }
 225
 226                 [DefaultValue(MenuMerge.Add)]
 227                 public MenuMerge MergeType {
 228                         get { return mergetype; }
 229                         set {
 230                                 if (!Enum.IsDefined (typeof (MenuMerge), value))
 231                                         throw new InvalidEnumArgumentException (string.Format("Enum argument value '{0}' is not valid for MenuMerge", value));
 232
 233                                 mergetype = value;
 234                         }
 235                 }
 236
 237                 [Browsable(false)]
 238                 public char Mnemonic {
 239                         get { return mnemonic; }
 240                 }
 241
 242                 [DefaultValue(false)]
 243                 public bool OwnerDraw {
 244                         get { return ownerdraw; }
 245                         set { ownerdraw = value; }
 246                 }
 247
 248                 [Browsable(false)]
 249                 public Menu Parent {
 250                         get { return parent_menu;}
 251                 }
 252
 253                 [DefaultValue(false)]
 254                 public bool RadioCheck {
 255                         get { return radiocheck; }
 256                         set { radiocheck = value; }
 257                 }
 258
 259                 [DefaultValue(Shortcut.None)]
 260                 [Localizable(true)]
 261                 public Shortcut Shortcut {
 262                         get { return shortcut;}
 263                         set {
 264                                 if (!Enum.IsDefined (typeof (Shortcut), value))
 265                                         throw new InvalidEnumArgumentException (string.Format("Enum argument value '{0}' is not valid for Shortcut", value));
 266
 267                                 shortcut = value;
 268                         }
 269                 }
 270
 271                 [DefaultValue(true)]
 272                 [Localizable(true)]
 273                 public bool ShowShortcut {
 274                         get { return showshortcut;}
 275                         set { showshortcut = value; }
 276                 }
 277
 278                 [Localizable(true)]
 279                 public string Text {
 280                         get { return text; }
 281                         set {
 282                                 text = value;
 283
 284                                 if (text == "-")
 285                                         separator = true;
 286                                 else
 287                                         separator = false;
 288
 289                                 ProcessMnemonic ();
 290                         }
 291                 }
 292
 293                 [DefaultValue(true)]
 294                 [Localizable(true)]
 295                 public bool Visible {
 296                         get { return visible;}
 297                         set {
 298                                 if (value == visible)
 299                                         return;
 300
 301                                 visible = value;
 302
 303                                 if (menu_items != null) {
 304                                         foreach (MenuItem mi in menu_items)
 305                                                 mi.Visible = value;
 306                                 }
 307
 308                                 if (parent_menu != null)
 309                                         parent_menu.OnMenuChanged (EventArgs.Empty);
 310                         }
 311                 }
 312
 313                 #endregion Public Properties
 314
 315                 #region Private Properties
 316
 317                 internal new int Height {
 318                         get { return bounds.Height; }
 319                         set { bounds.Height = value; }
 320                 }
 321
 322                 internal bool IsPopup {
 323                         get {
 324                                 if (menu_items.Count > 0)
 325                                         return true;
 326                                 else
 327                                         return false;
 328                         }
 329                 }
 330
 331                 internal bool MeasureEventDefined {
 332                         get {
 333                                 if (ownerdraw == true && MeasureItem != null) {
 334                                         return true;
 335                                 } else {
 336                                         return false;
 337                                 }
 338                         }
 339                 }
 340
 341                 internal bool MenuBar {
 342                         get { return menubar; }
 343                         set { menubar = value; }
 344                 }
 345
 346                 internal int MenuHeight {
 347                         get { return menuheight; }
 348                         set { menuheight = value; }
 349                 }
 350
 351                 internal bool Separator {
 352                         get { return separator; }
 353                         set { separator = value; }
 354                 }
 355
 356                 internal DrawItemState Status {
 357                         get { return status; }
 358                         set { status = value; }
 359                 }
 360
 361                 internal new int Width {
 362                         get { return bounds.Width; }
 363                         set { bounds.Width = value; }
 364                 }
 365
 366                 internal new int X {
 367                         get { return bounds.X; }
 368                         set { bounds.X = value; }
 369                 }
 370
 371                 internal int XTab {
 372                         get { return xtab; }
 373                         set { xtab = value; }
 374                 }
 375
 376                 internal new int Y {
 377                         get { return bounds.Y; }
 378                         set { bounds.Y = value; }
 379                 }
 380
 381                 #endregion Private Properties
 382
 383                 #region Public Methods
 384
 385                 public virtual MenuItem CloneMenu ()
 386                 {
 387                         MenuItem item = new MenuItem ();
 388                         item.CloneMenu (this);
 389                         return item;
 390                 }
 391
 392                 protected void CloneMenu (MenuItem menuitem)
 393                 {
 394                         base.CloneMenu (menuitem); // Copy subitems
 395
 396                         // Properties
 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;
 411
 412                         // Events
 413                         Click = menuitem.Click;
 414                         DrawItem = menuitem.DrawItem;
 415                         MeasureItem = menuitem.MeasureItem;
 416                         Popup = menuitem.Popup;
 417                         Select = menuitem.Select;
 418                 }
 419
 420                 protected override void Dispose (bool disposing)
 421                 {
 422                         base.Dispose (disposing);
 423                 }
 424
 425                 // This really clones the item
 426                 public virtual MenuItem MergeMenu ()
 427                 {
 428                         MenuItem item = new MenuItem ();
 429                         item.CloneMenu (this);
 430                         return item;
 431                 }
 432
 433                 public void MergeMenu (MenuItem menuitem)
 434                 {
 435                         base.MergeMenu (menuitem);
 436                 }
 437
 438                 protected virtual void OnClick (EventArgs e)
 439                 {
 440                         if (Click != null)
 441                                 Click (this, e);
 442                 }
 443
 444                 protected virtual void OnDrawItem (DrawItemEventArgs e)
 445                 {
 446                         if (DrawItem != null) {
 447                                 DrawItem (this, e);
 448                                 return;
 449                         }
 450
 451                         ThemeEngine.Current.DrawMenuItem (this, e);
 452                 }
 453
 454
 455                 protected virtual void OnInitMenuPopup (EventArgs e)
 456                 {
 457                         OnPopup (e);
 458                 }
 459
 460                 protected virtual void OnMeasureItem (MeasureItemEventArgs e)
 461                 {
 462                         if (MeasureItem != null)
 463                                 MeasureItem (this, e);
 464                 }
 465
 466                 protected virtual void OnPopup (EventArgs e)
 467                 {
 468                         if (Popup != null)
 469                                 Popup (this, e);
 470                 }
 471
 472                 protected virtual void OnSelect (EventArgs e)
 473                 {
 474                         if (Select != null)
 475                                 Select (this, e);
 476                 }
 477
 478                 public void PerformClick ()
 479                 {
 480                         OnClick (EventArgs.Empty);
 481                 }
 482
 483                 public virtual void PerformSelect ()
 484                 {
 485                         OnSelect (EventArgs.Empty);
 486                 }
 487
 488                 public override string ToString ()
 489                 {
 490                         return base.ToString () + ", Items.Count: " + MenuItems.Count + ", Text: " + text;
 491                 }
 492
 493                 #endregion Public Methods
 494
 495                 #region Private Methods
 496
 497                 internal void PerformDrawItem (DrawItemEventArgs e)
 498                 {
 499                         if (mdilist && mdilist_items == null) {
 500                                 do {
 501                                         // Add the mdilist for the first time
 502                                         mdilist_items = new Hashtable ();
 503
 504                                         MainMenu main = GetMainMenu ();
 505                                         if (main == null || main.GetForm () == null)
 506                                                 break;
 507
 508                                         Form form = main.GetForm ();
 509                                         mdicontainer = form.MdiContainer;
 510                                         if (mdicontainer == null)
 511                                                 break;
 512
 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);
 518                                         }
 519
 520                                 } while (false);
 521                         }
 522
 523                         OnDrawItem (e);
 524                 }
 525
 526                 internal void PerformMeasureItem (MeasureItemEventArgs e)
 527                 {
 528                         OnMeasureItem (e);
 529                 }
 530
 531                 private void ProcessMnemonic ()
 532                 {
 533                         if (text.Length < 2) {
 534                                 mnemonic = '\0';
 535                                 return;
 536                         }
 537
 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]);
 543                                                 return;
 544                                         }
 545
 546                                         bPrevAmp = true;
 547                                 }
 548                                 else
 549                                         bPrevAmp = false;
 550                         }
 551
 552                         mnemonic = '\0';
 553                 }
 554
 555                 private string GetShortCutTextCtrl () { return "Ctrl"; }
 556                 private string GetShortCutTextAlt () { return "Alt"; }
 557                 private string GetShortCutTextShift () { return "Shift"; }
 558
 559                 internal string GetShortCutText ()
 560                 {
 561                         /* Ctrl+A - Ctrl+Z */
 562                         if (Shortcut >= Shortcut.CtrlA && Shortcut <= Shortcut.CtrlZ)
 563                                 return GetShortCutTextCtrl () + "+" + (char)((int) 'A' + (int)(Shortcut - Shortcut.CtrlA));
 564
 565                         /* Alt+0 - Alt+9 */
 566                         if (Shortcut >= Shortcut.Alt0 && Shortcut <= Shortcut.Alt9)
 567                                 return GetShortCutTextAlt () + "+" + (char)((int) '0' + (int)(Shortcut - Shortcut.Alt0));
 568
 569                         /* Alt+F1 - Alt+F2 */
 570                         if (Shortcut >= Shortcut.AltF1 && Shortcut <= Shortcut.AltF9)
 571                                 return GetShortCutTextAlt () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.AltF1));
 572
 573                         /* Ctrl+0 - Ctrl+9 */
 574                         if (Shortcut >= Shortcut.Ctrl0 && Shortcut <= Shortcut.Ctrl9)
 575                                 return GetShortCutTextCtrl () + "+" + (char)((int) '0' + (int)(Shortcut - Shortcut.Ctrl0));
 576
 577                         /* Ctrl+F0 - Ctrl+F9 */
 578                         if (Shortcut >= Shortcut.CtrlF1 && Shortcut <= Shortcut.CtrlF9)
 579                                 return GetShortCutTextCtrl () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.CtrlF1));
 580
 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));
 584
 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));
 588
 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));
 592
 593                         /* F1 - F9 */
 594                         if (Shortcut >= Shortcut.F1 && Shortcut <= Shortcut.F9)
 595                                 return "F" + (char)((int) '1' + (int)(Shortcut - Shortcut.F1));
 596
 597                         /* Shift+F1 - Shift+F9 */
 598                         if (Shortcut >= Shortcut.ShiftF1 && Shortcut <= Shortcut.ShiftF9)
 599                                 return GetShortCutTextShift () + "+F" + (char)((int) '1' + (int)(Shortcut - Shortcut.ShiftF1));
 600
 601                         /* Special cases */
 602                         switch (Shortcut) {
 603                                 case Shortcut.AltBksp:
 604                                         return "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";
 627                                 case Shortcut.Del:
 628                                         return "Del";
 629                                 case Shortcut.F10:
 630                                         return "F10";
 631                                 case Shortcut.F11:
 632                                         return "F11";
 633                                 case Shortcut.F12:
 634                                         return "F12";
 635                                 case Shortcut.Ins:
 636                                         return "Ins";
 637                                 case Shortcut.None:
 638                                         return "None";
 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";
 649                                 default:
 650                                         break;
 651                                 }
 652
 653                         return "";
 654                 }
 655
 656                 private void MdiWindowClickHandler (object sender, EventArgs e)
 657                 {
 658                         Form mdichild = (Form) mdilist_items [SelectedItem];
 659
 660                         // people could add weird items to the Window menu
 661                         // so we can't assume its just us
 662                         if (mdichild == null)
 663                                 return;
 664
 665                         mdicontainer.ActivateChild (mdichild);
 666                 }
 667
 668                 #endregion Private Methods
 669
 670         }
 671 }
 672
 673