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
24 // Mike Kestner <mkestner@novell.com>
25 // Everaldo Canuto <ecanuto@novell.com>
28 using System.Collections;
30 using System.Threading;
32 namespace System.Windows.Forms {
35 When writing this code the Wine project was of great help to
36 understand the logic behind some Win32 issues. Thanks to them. Jordi,
38 // UIA Framework Note: This class used by UIA for its mouse action methods.
39 internal class MenuTracker {
42 internal bool popup_active;
43 internal bool popdown_menu;
44 internal bool hotkey_active;
45 private bool mouse_down = false;
46 public Menu CurrentMenu;
48 public Control GrabControl;
49 Point last_motion = Point.Empty;
51 public MenuTracker (Menu top_menu)
53 TopMenu = CurrentMenu = top_menu;
54 foreach (MenuItem item in TopMenu.MenuItems)
65 KeyNavState keynav_state = KeyNavState.Idle;
67 public bool Navigating {
68 get { return keynav_state != KeyNavState.Idle || active; }
71 internal static Point ScreenToMenu (Menu menu, Point pnt)
75 XplatUI.ScreenToMenu (menu.Wnd.window.Handle, ref x, ref y);
76 return new Point (x, y);
79 private void UpdateCursor ()
81 Control child_control = GrabControl.GetRealChildAtPoint (Cursor.Position);
82 if (child_control != null) {
84 XplatUI.SetCursor (child_control.Handle, Cursors.Default.handle);
86 XplatUI.SetCursor (child_control.Handle, child_control.Cursor.handle);
92 bool redrawbar = (keynav_state != KeyNavState.Idle) && (TopMenu is MainMenu);
96 hotkey_active = false;
97 if (GrabControl != null)
98 GrabControl.ActiveTracker = null;
99 keynav_state = KeyNavState.Idle;
100 if (TopMenu is ContextMenu) {
101 PopUpWindow puw = TopMenu.Wnd as PopUpWindow;
102 DeselectItem (TopMenu.SelectedItem);
106 DeselectItem (TopMenu.SelectedItem);
108 CurrentMenu = TopMenu;
111 (TopMenu as MainMenu).Draw ();
114 MenuItem FindItemByCoords (Menu menu, Point pt)
116 if (menu is MainMenu)
117 pt = ScreenToMenu (menu, pt);
119 pt = menu.Wnd.PointToClient (pt);
120 foreach (MenuItem item in menu.MenuItems) {
121 Rectangle rect = item.bounds;
122 if (rect.Contains (pt))
129 MenuItem GetItemAtXY (int x, int y)
131 Point pnt = new Point (x, y);
132 MenuItem item = null;
133 if (TopMenu.SelectedItem != null)
134 item = FindSubItemByCoord (TopMenu.SelectedItem, Control.MousePosition);
136 item = FindItemByCoords (TopMenu, pnt);
140 // UIA Framework Note: Used to expand/collapse MenuItems
141 public bool OnMouseDown (MouseEventArgs args)
143 MenuItem item = GetItemAtXY (args.X, args.Y);
152 if ((args.Button & MouseButtons.Left) == 0)
158 popdown_menu = active && item.VisibleItems;
160 if (item.IsPopup || (item.Parent is MainMenu)) {
162 item.Parent.InvalidateItem (item);
165 if ((CurrentMenu == TopMenu) && !popdown_menu)
166 SelectItem (item.Parent, item, item.IsPopup);
168 GrabControl.ActiveTracker = this;
172 // UIA Framework Note: Used to select MenuItems
173 public void OnMotion (MouseEventArgs args)
175 // Windows helpfully sends us MOUSEMOVE messages when any key is pressed.
176 // So if the mouse hasn't actually moved since the last MOUSEMOVE, ignore it.
177 if (args.Location == last_motion)
180 last_motion = args.Location;
182 MenuItem item = GetItemAtXY (args.X, args.Y);
186 if (CurrentMenu.SelectedItem == item)
189 GrabControl.ActiveTracker = (active || item != null) ? this : null;
192 MenuItem old_item = CurrentMenu.SelectedItem;
194 // Return when is a popup with visible subitems for MainMenu
195 if ((active && old_item.VisibleItems && old_item.IsPopup && (CurrentMenu is MainMenu)))
198 // Also returns when keyboard navigating
199 if (keynav_state == KeyNavState.Navigating)
202 // Select parent menu when move outside of menu item
203 if (old_item.Parent is MenuItem) {
204 MenuItem new_item = (old_item.Parent as MenuItem);
205 if (new_item.IsPopup) {
206 SelectItem (new_item.Parent, new_item, false);
210 if (CurrentMenu != TopMenu)
211 CurrentMenu = CurrentMenu.parent_menu;
213 DeselectItem (old_item);
215 keynav_state = KeyNavState.Idle;
216 SelectItem (item.Parent, item, active && item.IsPopup && popup_active && (CurrentMenu.SelectedItem != item));
220 // UIA Framework Note: Used to expand/collapse MenuItems
221 public void OnMouseUp (MouseEventArgs args)
223 /* mouse down dont comes from menu */
229 /* is not left button */
230 if ((args.Button & MouseButtons.Left) == 0)
233 MenuItem item = GetItemAtXY (args.X, args.Y);
235 /* the user released the mouse button outside the menu */
244 /* Deactivate the menu when is topmenu and popdown and */
245 if (((CurrentMenu == TopMenu) && !(CurrentMenu is ContextMenu) && popdown_menu) || !item.IsPopup) {
250 /* Perform click when is not a popup */
254 // Raise the form's MenuComplete event
255 if (TopMenu != null && TopMenu.Wnd != null) {
256 Form f = TopMenu.Wnd.FindForm ();
259 f.OnMenuComplete (EventArgs.Empty);
262 item.PerformClick ();
266 static public bool TrackPopupMenu (Menu menu, Point pnt)
268 if (menu.MenuItems.Count <= 0) // No submenus to track
271 MenuTracker tracker = menu.tracker;
272 tracker.active = true;
273 tracker.popup_active = true;
276 Control src_ctrl = (tracker.TopMenu as ContextMenu).SourceControl;
277 tracker.GrabControl = src_ctrl.FindForm ();
278 if (tracker.GrabControl == null)
279 tracker.GrabControl = src_ctrl.FindRootParent ();
280 tracker.GrabControl.ActiveTracker = tracker;
282 menu.Wnd = new PopUpWindow (tracker.GrabControl, menu);
283 menu.Wnd.Location = menu.Wnd.PointToClient (pnt);
284 ((PopUpWindow)menu.Wnd).ShowWindow ();
288 Object queue_id = XplatUI.StartLoop(Thread.CurrentThread);
290 while ((menu.Wnd != null) && menu.Wnd.Visible && no_quit) {
291 MSG msg = new MSG ();
292 no_quit = XplatUI.GetMessage(queue_id, ref msg, IntPtr.Zero, 0, 0);
294 switch((Msg)msg.message) {
296 case Msg.WM_SYSKEYDOWN:
300 case Msg.WM_SYSKEYUP:
301 Control c = Control.FromHandle(msg.hwnd);
303 Message m = Message.Create(msg.hwnd, (int)msg.message, msg.wParam, msg.lParam);
304 c.PreProcessControlMessageInternal (ref m);
308 XplatUI.TranslateMessage (ref msg);
309 XplatUI.DispatchMessage (ref msg);
314 if (tracker.GrabControl.IsDisposed)
318 XplatUI.PostQuitMessage(0);
320 if (menu.Wnd != null) {
328 void DeselectItem (MenuItem item)
333 item.Selected = false;
335 /* When popup item then close all sub popups and unselect all sub items */
337 HideSubPopups (item, TopMenu);
339 /* Unselect all selected sub itens */
340 foreach (MenuItem subitem in item.MenuItems)
341 if (subitem.Selected)
342 DeselectItem (subitem);
345 Menu menu = item.Parent;
346 menu.InvalidateItem (item);
349 void SelectItem (Menu menu, MenuItem item, bool execute)
351 MenuItem prev_item = CurrentMenu.SelectedItem;
353 if (prev_item != item.Parent) {
354 DeselectItem (prev_item);
355 if ((CurrentMenu != menu) && (prev_item.Parent != item) && (prev_item.Parent is MenuItem)) {
356 DeselectItem (prev_item.Parent as MenuItem);
360 if (CurrentMenu != menu)
363 item.Selected = true;
364 menu.InvalidateItem (item);
366 if (((CurrentMenu == TopMenu) && execute) || ((CurrentMenu != TopMenu) && popup_active))
367 item.PerformSelect ();
369 if ((execute) && ((prev_item == null) || (item != prev_item.Parent)))
370 ExecFocusedItem (menu, item);
373 // Used when the user executes the action of an item (press enter, shortcut)
374 // or a sub-popup menu has to be shown
375 void ExecFocusedItem (Menu menu, MenuItem item)
384 ShowSubPopup (menu, item);
387 item.PerformClick ();
391 // Create a popup window and show it or only show it if it is already created
392 void ShowSubPopup (Menu menu, MenuItem item)
394 if (item.Enabled == false)
397 if (!popdown_menu || !item.VisibleItems)
398 item.PerformPopup ();
400 if (item.VisibleItems == false)
403 if (item.Wnd != null) {
408 PopUpWindow puw = new PopUpWindow (GrabControl, item);
411 if (menu is MainMenu)
412 pnt = new Point (item.X, item.Y + item.Height - 2 - menu.Height);
414 pnt = new Point (item.X + item.Width - 3, item.Y - 3);
415 pnt = menu.Wnd.PointToScreen (pnt);
422 static public void HideSubPopups (Menu menu, Menu topmenu)
424 foreach (MenuItem item in menu.MenuItems)
426 HideSubPopups (item, null);
428 if (menu.Wnd == null)
431 PopUpWindow puw = menu.Wnd as PopUpWindow;
439 if ((topmenu != null) && (topmenu is MainMenu))
440 ((MainMenu) topmenu).OnCollapse (EventArgs.Empty);
444 MenuItem FindSubItemByCoord (Menu menu, Point pnt)
446 foreach (MenuItem item in menu.MenuItems) {
448 if (item.IsPopup && item.Wnd != null && item.Wnd.Visible && item == menu.SelectedItem) {
449 MenuItem result = FindSubItemByCoord (item, pnt);
454 if (menu.Wnd == null || !menu.Wnd.Visible)
457 Rectangle rect = item.bounds;
458 Point pnt_client = menu.Wnd.PointToScreen (new Point (item.X, item.Y));
459 rect.X = pnt_client.X;
460 rect.Y = pnt_client.Y;
462 if (rect.Contains (pnt) == true)
469 static MenuItem FindItemByKey (Menu menu, IntPtr key)
471 char key_char = Char.ToUpper ((char) (key.ToInt32() & 0xff));
472 foreach (MenuItem item in menu.MenuItems) {
473 if (item.Mnemonic == key_char)
477 string key_str = key_char.ToString ();
478 foreach (MenuItem item in menu.MenuItems) {
479 //if (item.Mnemonic == key_char)
480 if (item.Text.StartsWith (key_str))
487 enum ItemNavigation {
494 static MenuItem GetNextItem (Menu menu, ItemNavigation navigation)
497 bool selectable_items = false;
500 // Check if there is at least a selectable item
501 for (int i = 0; i < menu.MenuItems.Count; i++) {
502 item = menu.MenuItems [i];
503 if (item.Separator == false && item.Visible == true) {
504 selectable_items = true;
509 if (selectable_items == false)
512 switch (navigation) {
513 case ItemNavigation.First:
515 /* First item that is not separator and it is visible*/
516 for (pos = 0; pos < menu.MenuItems.Count; pos++) {
517 item = menu.MenuItems [pos];
518 if (item.Separator == false && item.Visible == true)
524 case ItemNavigation.Last: // Not used
527 case ItemNavigation.Next:
529 pos = menu.SelectedItem == null ? - 1 : menu.SelectedItem.Index;
531 /* Next item that is not separator and it is visible*/
532 for (pos++; pos < menu.MenuItems.Count; pos++) {
533 item = menu.MenuItems [pos];
534 if (item.Separator == false && item.Visible == true)
538 if (pos >= menu.MenuItems.Count) { /* Jump at the start of the menu */
540 /* Next item that is not separator and it is visible*/
541 for (; pos < menu.MenuItems.Count; pos++) {
542 item = menu.MenuItems [pos];
543 if (item.Separator == false && item.Visible == true)
549 case ItemNavigation.Previous:
551 if (menu.SelectedItem != null)
552 pos = menu.SelectedItem.Index;
554 /* Previous item that is not separator and it is visible*/
555 for (pos--; pos >= 0; pos--) {
556 item = menu.MenuItems [pos];
557 if (item.Separator == false && item.Visible == true)
561 if (pos < 0 ) { /* Jump at the end of the menu*/
562 pos = menu.MenuItems.Count - 1;
563 /* Previous item that is not separator and it is visible*/
564 for (; pos >= 0; pos--) {
565 item = menu.MenuItems [pos];
566 if (item.Separator == false && item.Visible == true)
577 return menu.MenuItems [pos];
580 void ProcessMenuKey (Msg msg_type)
582 if (TopMenu.MenuItems.Count == 0)
585 MainMenu main_menu = TopMenu as MainMenu;
588 case Msg.WM_SYSKEYDOWN:
589 switch (keynav_state) {
590 case KeyNavState.Idle:
591 keynav_state = KeyNavState.Startup;
592 hotkey_active = true;
593 GrabControl.ActiveTracker = this;
594 CurrentMenu = TopMenu;
597 case KeyNavState.Startup:
606 case Msg.WM_SYSKEYUP:
607 switch (keynav_state) {
608 case KeyNavState.Idle:
609 case KeyNavState.Navigating:
611 case KeyNavState.Startup:
612 keynav_state = KeyNavState.NoPopups;
613 SelectItem (TopMenu, TopMenu.MenuItems [0], false);
624 bool ProcessMnemonic (Message msg, Keys key_data)
626 keynav_state = KeyNavState.Navigating;
627 MenuItem item = FindItemByKey (CurrentMenu, msg.WParam);
628 if ((item == null) || (GrabControl == null))
632 GrabControl.ActiveTracker = this;
634 SelectItem (CurrentMenu, item, true);
637 SelectItem (item, item.MenuItems [0], false);
642 Hashtable shortcuts = new Hashtable ();
644 public void AddShortcuts (MenuItem item)
646 foreach (MenuItem child in item.MenuItems) {
647 AddShortcuts (child);
648 if (child.Shortcut != Shortcut.None)
649 shortcuts [(int)child.Shortcut] = child;
652 if (item.Shortcut != Shortcut.None)
653 shortcuts [(int)item.Shortcut] = item;
656 public void RemoveShortcuts (MenuItem item)
658 foreach (MenuItem child in item.MenuItems) {
659 RemoveShortcuts (child);
660 if (child.Shortcut != Shortcut.None)
661 shortcuts.Remove ((int)child.Shortcut);
664 if (item.Shortcut != Shortcut.None)
665 shortcuts.Remove ((int)item.Shortcut);
668 bool ProcessShortcut (Keys keyData)
670 MenuItem item = shortcuts [(int)keyData] as MenuItem;
671 if (item == null || !item.Enabled)
676 item.PerformClick ();
680 public bool ProcessKeys (ref Message msg, Keys keyData)
682 // If we get Alt-F4, Windows will ignore it because we have a capture,
683 // release the capture and the program will exit. (X11 doesn't care.)
684 if ((keyData & Keys.Alt) == Keys.Alt && (keyData & Keys.F4) == Keys.F4) {
685 if (GrabControl != null)
686 GrabControl.ActiveTracker = null;
691 if ((Msg)msg.Msg != Msg.WM_SYSKEYUP && ProcessShortcut (keyData))
693 else if ((keyData & Keys.KeyCode) == Keys.Menu && TopMenu is MainMenu) {
694 ProcessMenuKey ((Msg) msg.Msg);
696 } else if ((keyData & Keys.Alt) == Keys.Alt)
697 return ProcessMnemonic (msg, keyData);
698 else if ((Msg)msg.Msg == Msg.WM_SYSKEYUP)
700 else if (!Navigating)
707 if (CurrentMenu is MainMenu)
709 else if (CurrentMenu.MenuItems.Count == 1 && CurrentMenu.parent_menu == TopMenu) {
710 DeselectItem (CurrentMenu.SelectedItem);
711 CurrentMenu = TopMenu;
714 item = GetNextItem (CurrentMenu, ItemNavigation.Previous);
716 SelectItem (CurrentMenu, item, false);
720 if (CurrentMenu is MainMenu) {
721 if (CurrentMenu.SelectedItem != null && CurrentMenu.SelectedItem.IsPopup) {
722 keynav_state = KeyNavState.Navigating;
723 item = CurrentMenu.SelectedItem;
724 ShowSubPopup (CurrentMenu, item);
725 SelectItem (item, item.MenuItems [0], false);
728 GrabControl.ActiveTracker = this;
732 item = GetNextItem (CurrentMenu, ItemNavigation.Next);
734 SelectItem (CurrentMenu, item, false);
738 if (CurrentMenu is MainMenu) {
739 item = GetNextItem (CurrentMenu, ItemNavigation.Next);
740 bool popup = item.IsPopup && keynav_state != KeyNavState.NoPopups;
741 SelectItem (CurrentMenu, item, popup);
743 SelectItem (item, item.MenuItems [0], false);
746 } else if (CurrentMenu.SelectedItem != null && CurrentMenu.SelectedItem.IsPopup) {
747 item = CurrentMenu.SelectedItem;
748 ShowSubPopup (CurrentMenu, item);
749 SelectItem (item, item.MenuItems [0], false);
752 //Search up for a main menu
753 Menu Prnt = CurrentMenu.parent_menu;
754 while (Prnt != null && !(Prnt is MainMenu)) {
755 Prnt = Prnt.parent_menu;
757 if (Prnt is MainMenu)
759 item = GetNextItem(Prnt, ItemNavigation.Next);
760 SelectItem(Prnt, item, item.IsPopup);
763 SelectItem(item, item.MenuItems[0], false);
771 if (CurrentMenu is MainMenu) {
772 item = GetNextItem (CurrentMenu, ItemNavigation.Previous);
773 bool popup = item.IsPopup && keynav_state != KeyNavState.NoPopups;
774 SelectItem (CurrentMenu, item, popup);
776 SelectItem (item, item.MenuItems [0], false);
779 } else if (CurrentMenu.parent_menu is MainMenu) {
780 item = GetNextItem (CurrentMenu.parent_menu, ItemNavigation.Previous);
781 SelectItem (CurrentMenu.parent_menu, item, item.IsPopup);
783 SelectItem (item, item.MenuItems [0], false);
787 HideSubPopups (CurrentMenu, TopMenu);
788 if (CurrentMenu.parent_menu != null)
789 CurrentMenu = CurrentMenu.parent_menu;
794 if (CurrentMenu.SelectedItem != null && CurrentMenu.SelectedItem.IsPopup) {
795 keynav_state = KeyNavState.Navigating;
796 item = CurrentMenu.SelectedItem;
797 ShowSubPopup (CurrentMenu, item);
798 SelectItem (item, item.MenuItems [0], false);
801 GrabControl.ActiveTracker = this;
803 ExecFocusedItem (CurrentMenu, CurrentMenu.SelectedItem);
812 ProcessMnemonic (msg, keyData);
820 internal class PopUpWindow : Control
823 private Control form;
825 public PopUpWindow (Control form, Menu menu): base ()
829 SetStyle (ControlStyles.UserPaint | ControlStyles.AllPaintingInWmPaint, true);
830 SetStyle (ControlStyles.ResizeRedraw | ControlStyles.Opaque, true);
834 protected override CreateParams CreateParams
837 CreateParams cp = base.CreateParams;
838 cp.Caption = "Menu PopUp";
839 cp.Style = unchecked ((int)(WindowStyles.WS_POPUP));
840 cp.ExStyle |= (int)(WindowExStyles.WS_EX_TOOLWINDOW | WindowExStyles.WS_EX_TOPMOST);
845 public void ShowWindow ()
847 XplatUI.SetCursor(form.Handle, Cursors.Default.handle);
852 internal override void OnPaintInternal (PaintEventArgs args)
854 ThemeEngine.Current.DrawPopupMenu (args.Graphics, menu, args.ClipRectangle, ClientRectangle);
857 public void HideWindow ()
859 XplatUI.SetCursor (form.Handle, form.Cursor.handle);
860 MenuTracker.HideSubPopups (menu, null);
864 protected override void CreateHandle ()
866 base.CreateHandle ();
870 // Called when the number of items has changed
871 internal void RefreshItems ()
873 Point pt = new Point (Location.X, Location.Y);
875 ThemeEngine.Current.CalcPopupMenuSize (DeviceContext, menu);
877 if ((pt.X + menu.Rect.Width) > SystemInformation.VirtualScreen.Width) {
878 if (((pt.X - menu.Rect.Width) > 0) && !(menu.parent_menu is MainMenu))
879 pt.X = pt.X - menu.Rect.Width;
881 pt.X = SystemInformation.VirtualScreen.Width - menu.Rect.Width;
886 if ((pt.Y + menu.Rect.Height) > SystemInformation.VirtualScreen.Height) {
887 if ((pt.Y - menu.Rect.Height) > 0)
888 pt.Y = pt.Y - menu.Rect.Height;
890 pt.Y = SystemInformation.VirtualScreen.Height - menu.Rect.Height;
897 Width = menu.Rect.Width;
898 Height = menu.Rect.Height;
901 internal override bool ActivateOnShow { get { return false; } }