1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/univ/menu.cpp
3 // Purpose: wxMenuItem, wxMenu and wxMenuBar implementation
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #include "wx/wxprec.h"
29 #include "wx/stockitem.h"
32 #include "wx/dynarray.h"
33 #include "wx/control.h" // for FindAccelIndex()
34 #include "wx/settings.h"
38 #include "wx/dcclient.h"
41 #include "wx/popupwin.h"
42 #include "wx/evtloop.h"
44 #include "wx/univ/renderer.h"
47 #include "wx/msw/private.h"
50 typedef wxMenuItemList::compatibility_iterator wxMenuItemIter
;
52 // ----------------------------------------------------------------------------
53 // wxMenuInfo contains all extra information about top level menus we need
54 // ----------------------------------------------------------------------------
56 class WXDLLEXPORT wxMenuInfo
60 wxMenuInfo(const wxString
& text
)
68 void SetLabel(const wxString
& text
)
70 m_originalLabel
= text
;
72 // remember the accel char (may be -1 if none)
73 m_indexAccel
= wxControl::FindAccelIndex(text
, &m_label
);
75 // calculate the width later, after the menu bar is created
79 void SetEnabled(bool enabled
= true) { m_isEnabled
= enabled
; }
83 const wxString
& GetLabel() const { return m_label
; }
84 const wxString
& GetOriginalLabel() const { return m_originalLabel
; }
85 bool IsEnabled() const { return m_isEnabled
; }
86 wxCoord
GetWidth(wxMenuBar
*menubar
) const
90 wxConstCast(this, wxMenuInfo
)->CalcWidth(menubar
);
96 int GetAccelIndex() const { return m_indexAccel
; }
99 void CalcWidth(wxMenuBar
*menubar
)
102 wxClientDC
dc(menubar
);
103 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
104 dc
.GetTextExtent(m_label
, &size
.x
, &size
.y
);
106 // adjust for the renderer we use and store the width
107 m_width
= menubar
->GetRenderer()->GetMenuBarItemSize(size
).x
;
111 wxString m_originalLabel
;
117 #include "wx/arrimpl.cpp"
119 WX_DEFINE_OBJARRAY(wxMenuInfoArray
);
121 // ----------------------------------------------------------------------------
122 // wxPopupMenuWindow: a popup window showing a menu
123 // ----------------------------------------------------------------------------
125 class wxPopupMenuWindow
: public wxPopupTransientWindow
128 wxPopupMenuWindow(wxWindow
*parent
, wxMenu
*menu
);
130 virtual ~wxPopupMenuWindow();
132 // override the base class version to select the first item initially
133 virtual void Popup(wxWindow
*focus
= NULL
);
135 // override the base class version to dismiss any open submenus
136 virtual void Dismiss();
138 // called when a submenu is dismissed
139 void OnSubmenuDismiss(bool dismissParent
);
141 // the default wxMSW wxPopupTransientWindow::OnIdle disables the capture
142 // when the cursor is inside the popup, which dsables the menu tracking
143 // so override it to do nothing
145 void OnIdle(wxIdleEvent
& WXUNUSED(event
)) { }
148 // get the currently selected item (may be NULL)
149 wxMenuItem
*GetCurrentItem() const
151 return m_nodeCurrent
? m_nodeCurrent
->GetData() : NULL
;
154 // find the menu item at given position
155 wxMenuItemIter
GetMenuItemFromPoint(const wxPoint
& pt
) const;
157 // refresh the given item
158 void RefreshItem(wxMenuItem
*item
);
160 // preselect the first item
161 void SelectFirst() { SetCurrentItem(m_menu
->GetMenuItems().GetFirst()); }
163 // process the key event, return true if done
164 bool ProcessKeyDown(int key
);
166 // process mouse move event
167 void ProcessMouseMove(const wxPoint
& pt
);
169 // don't dismiss the popup window if the parent menu was clicked
170 virtual bool ProcessLeftDown(wxMouseEvent
& event
);
173 // how did we perform this operation?
180 // notify the menu when the window disappears from screen
181 virtual void OnDismiss();
183 // draw the menu inside this window
184 virtual void DoDraw(wxControlRenderer
*renderer
);
187 void OnLeftUp(wxMouseEvent
& event
);
188 void OnMouseMove(wxMouseEvent
& event
);
189 void OnMouseLeave(wxMouseEvent
& event
);
190 void OnKeyDown(wxKeyEvent
& event
);
192 // reset the current item and node
195 // set the current node and item without refreshing anything
196 void SetCurrentItem(wxMenuItemIter node
);
198 // change the current item refreshing the old and new items
199 void ChangeCurrent(wxMenuItemIter node
);
201 // activate item, i.e. call either ClickItem() or OpenSubmenu() depending
202 // on what it is, return true if something was done (i.e. it's not a
204 bool ActivateItem(wxMenuItem
*item
, InputMethod how
= WithKeyboard
);
206 // send the event about the item click
207 void ClickItem(wxMenuItem
*item
);
209 // show the submenu for this item
210 void OpenSubmenu(wxMenuItem
*item
, InputMethod how
= WithKeyboard
);
212 // can this tiem be opened?
213 bool CanOpen(wxMenuItem
*item
)
215 return item
&& item
->IsEnabled() && item
->IsSubMenu();
218 // dismiss the menu and all parent menus too
219 void DismissAndNotify();
221 // react to dimissing this menu and also dismiss the parent if
223 void HandleDismiss(bool dismissParent
);
225 // do we have an open submenu?
226 bool HasOpenSubmenu() const { return m_hasOpenSubMenu
; }
228 // get previous node after the current one
229 wxMenuItemIter
GetPrevNode() const;
231 // get previous node before the given one, wrapping if it's the first one
232 wxMenuItemIter
GetPrevNode(wxMenuItemIter node
) const;
234 // get next node after the current one
235 wxMenuItemIter
GetNextNode() const;
237 // get next node after the given one, wrapping if it's the last one
238 wxMenuItemIter
GetNextNode(wxMenuItemIter node
) const;
244 // the menu node corresponding to the current item
245 wxMenuItemIter m_nodeCurrent
;
247 // do we currently have an opened submenu?
248 bool m_hasOpenSubMenu
;
250 DECLARE_EVENT_TABLE()
253 // ----------------------------------------------------------------------------
254 // wxMenuKbdRedirector: an event handler which redirects kbd input to wxMenu
255 // ----------------------------------------------------------------------------
257 class wxMenuKbdRedirector
: public wxEvtHandler
260 wxMenuKbdRedirector(wxMenu
*menu
) { m_menu
= menu
; }
262 virtual bool ProcessEvent(wxEvent
& event
)
264 if ( event
.GetEventType() == wxEVT_KEY_DOWN
)
266 return m_menu
->ProcessKeyDown(((wxKeyEvent
&)event
).GetKeyCode());
272 return wxEvtHandler::ProcessEvent(event
);
280 // ----------------------------------------------------------------------------
282 // ----------------------------------------------------------------------------
284 BEGIN_EVENT_TABLE(wxPopupMenuWindow
, wxPopupTransientWindow
)
285 EVT_KEY_DOWN(wxPopupMenuWindow::OnKeyDown
)
287 EVT_LEFT_UP(wxPopupMenuWindow::OnLeftUp
)
288 EVT_MOTION(wxPopupMenuWindow::OnMouseMove
)
289 EVT_LEAVE_WINDOW(wxPopupMenuWindow::OnMouseLeave
)
291 EVT_IDLE(wxPopupMenuWindow::OnIdle
)
295 BEGIN_EVENT_TABLE(wxMenuBar
, wxMenuBarBase
)
296 EVT_KILL_FOCUS(wxMenuBar::OnKillFocus
)
298 EVT_KEY_DOWN(wxMenuBar::OnKeyDown
)
300 EVT_LEFT_DOWN(wxMenuBar::OnLeftDown
)
301 EVT_MOTION(wxMenuBar::OnMouseMove
)
304 // ============================================================================
306 // ============================================================================
308 // ----------------------------------------------------------------------------
310 // ----------------------------------------------------------------------------
312 wxPopupMenuWindow::wxPopupMenuWindow(wxWindow
*parent
, wxMenu
*menu
)
315 m_hasOpenSubMenu
= false;
319 (void)Create(parent
, wxBORDER_RAISED
);
321 SetCursor(wxCURSOR_ARROW
);
324 wxPopupMenuWindow::~wxPopupMenuWindow()
326 // When m_popupMenu in wxMenu is deleted because it
327 // is a child of an old menu bar being deleted (note: it does
328 // not get destroyed by the wxMenu destructor, but
329 // by DestroyChildren()), m_popupMenu should be reset to NULL.
331 m_menu
->m_popupMenu
= NULL
;
334 // ----------------------------------------------------------------------------
335 // wxPopupMenuWindow current item/node handling
336 // ----------------------------------------------------------------------------
338 void wxPopupMenuWindow::ResetCurrent()
340 SetCurrentItem(wxMenuItemIter());
343 void wxPopupMenuWindow::SetCurrentItem(wxMenuItemIter node
)
345 m_nodeCurrent
= node
;
348 void wxPopupMenuWindow::ChangeCurrent(wxMenuItemIter node
)
350 if ( !m_nodeCurrent
|| !node
|| (node
!= m_nodeCurrent
) )
352 wxMenuItemIter nodeOldCurrent
= m_nodeCurrent
;
354 m_nodeCurrent
= node
;
356 if ( nodeOldCurrent
)
358 wxMenuItem
*item
= nodeOldCurrent
->GetData();
359 wxCHECK_RET( item
, wxT("no current item?") );
361 // if it was the currently opened menu, close it
362 if ( item
->IsSubMenu() && item
->GetSubMenu()->IsShown() )
364 item
->GetSubMenu()->Dismiss();
365 OnSubmenuDismiss( false );
372 RefreshItem(m_nodeCurrent
->GetData());
376 wxMenuItemIter
wxPopupMenuWindow::GetPrevNode() const
378 // return the last node if there had been no previously selected one
379 return m_nodeCurrent
? GetPrevNode(m_nodeCurrent
)
380 : wxMenuItemIter(m_menu
->GetMenuItems().GetLast());
384 wxPopupMenuWindow::GetPrevNode(wxMenuItemIter node
) const
388 node
= node
->GetPrevious();
391 node
= m_menu
->GetMenuItems().GetLast();
394 //else: the menu is empty
399 wxMenuItemIter
wxPopupMenuWindow::GetNextNode() const
401 // return the first node if there had been no previously selected one
402 return m_nodeCurrent
? GetNextNode(m_nodeCurrent
)
403 : wxMenuItemIter(m_menu
->GetMenuItems().GetFirst());
407 wxPopupMenuWindow::GetNextNode(wxMenuItemIter node
) const
411 node
= node
->GetNext();
414 node
= m_menu
->GetMenuItems().GetFirst();
417 //else: the menu is empty
422 // ----------------------------------------------------------------------------
423 // wxPopupMenuWindow popup/dismiss
424 // ----------------------------------------------------------------------------
426 void wxPopupMenuWindow::Popup(wxWindow
*focus
)
428 // check that the current item had been properly reset before
429 wxASSERT_MSG( !m_nodeCurrent
||
430 m_nodeCurrent
== m_menu
->GetMenuItems().GetFirst(),
431 wxT("menu current item preselected incorrectly") );
433 wxPopupTransientWindow::Popup(focus
);
435 // the base class no-longer captures the mouse automatically when Popup
436 // is called, so do it here to allow the menu tracking to work
441 // ensure that this window is really on top of everything: without using
442 // SetWindowPos() it can be covered by its parent menu which is not
443 // really what we want
444 wxMenu
*menuParent
= m_menu
->GetParent();
447 wxPopupMenuWindow
*win
= menuParent
->m_popupMenu
;
449 // if we're shown, the parent menu must be also shown
450 wxCHECK_RET( win
, wxT("parent menu is not shown?") );
452 if ( !::SetWindowPos(GetHwndOf(win
), GetHwnd(),
454 SWP_NOMOVE
| SWP_NOSIZE
| SWP_NOREDRAW
) )
456 wxLogLastError(wxT("SetWindowPos(HWND_TOP)"));
464 void wxPopupMenuWindow::Dismiss()
466 if ( HasOpenSubmenu() )
468 wxMenuItem
*item
= GetCurrentItem();
469 wxCHECK_RET( item
&& item
->IsSubMenu(), wxT("where is our open submenu?") );
471 wxPopupMenuWindow
*win
= item
->GetSubMenu()->m_popupMenu
;
472 wxCHECK_RET( win
, wxT("opened submenu is not opened?") );
475 OnSubmenuDismiss( false );
478 wxPopupTransientWindow::Dismiss();
483 void wxPopupMenuWindow::OnDismiss()
485 // when we are dismissed because the user clicked elsewhere or we lost
486 // focus in any other way, hide the parent menu as well
490 void wxPopupMenuWindow::OnSubmenuDismiss(bool WXUNUSED(dismissParent
))
492 m_hasOpenSubMenu
= false;
495 void wxPopupMenuWindow::HandleDismiss(bool dismissParent
)
497 m_menu
->OnDismiss(dismissParent
);
500 void wxPopupMenuWindow::DismissAndNotify()
506 // ----------------------------------------------------------------------------
507 // wxPopupMenuWindow geometry
508 // ----------------------------------------------------------------------------
511 wxPopupMenuWindow::GetMenuItemFromPoint(const wxPoint
& pt
) const
513 // we only use the y coord normally, but still check x in case the point is
514 // outside the window completely
515 if ( wxWindow::HitTest(pt
) == wxHT_WINDOW_INSIDE
)
518 for ( wxMenuItemIter node
= m_menu
->GetMenuItems().GetFirst();
520 node
= node
->GetNext() )
522 wxMenuItem
*item
= node
->GetData();
523 y
+= item
->GetHeight();
532 return wxMenuItemIter();
535 // ----------------------------------------------------------------------------
536 // wxPopupMenuWindow drawing
537 // ----------------------------------------------------------------------------
539 void wxPopupMenuWindow::RefreshItem(wxMenuItem
*item
)
541 wxCHECK_RET( item
, wxT("can't refresh NULL item") );
543 wxASSERT_MSG( IsShown(), wxT("can't refresh menu which is not shown") );
545 // FIXME: -1 here because of SetLogicalOrigin(1, 1) in DoDraw()
546 RefreshRect(wxRect(0, item
->GetPosition() - 1,
547 m_menu
->GetGeometryInfo().GetSize().x
, item
->GetHeight()));
550 void wxPopupMenuWindow::DoDraw(wxControlRenderer
*renderer
)
552 // no clipping so far - do we need it? I don't think so as the menu is
553 // never partially covered as it is always on top of everything
555 wxDC
& dc
= renderer
->GetDC();
556 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
558 // FIXME: this should be done in the renderer, however when it is fixed
559 // wxPopupMenuWindow::RefreshItem() should be changed too!
560 dc
.SetLogicalOrigin(1, 1);
562 wxRenderer
*rend
= renderer
->GetRenderer();
565 const wxMenuGeometryInfo
& gi
= m_menu
->GetGeometryInfo();
566 for ( wxMenuItemIter node
= m_menu
->GetMenuItems().GetFirst();
568 node
= node
->GetNext() )
570 wxMenuItem
*item
= node
->GetData();
572 if ( item
->IsSeparator() )
574 rend
->DrawMenuSeparator(dc
, y
, gi
);
576 else // not a separator
579 if ( item
->IsCheckable() )
581 flags
|= wxCONTROL_CHECKABLE
;
583 if ( item
->IsChecked() )
585 flags
|= wxCONTROL_CHECKED
;
589 if ( !item
->IsEnabled() )
590 flags
|= wxCONTROL_DISABLED
;
592 if ( item
->IsSubMenu() )
593 flags
|= wxCONTROL_ISSUBMENU
;
595 if ( item
== GetCurrentItem() )
596 flags
|= wxCONTROL_SELECTED
;
600 if ( !item
->IsEnabled() )
602 bmp
= item
->GetDisabledBitmap();
607 // strangely enough, for unchecked item we use the
608 // "checked" bitmap because this is the default one - this
609 // explains this strange boolean expression
610 bmp
= item
->GetBitmap(!item
->IsCheckable() || item
->IsChecked());
618 item
->GetItemLabelText(),
619 item
->GetAccelString(),
622 item
->GetAccelIndex()
626 y
+= item
->GetHeight();
630 // ----------------------------------------------------------------------------
631 // wxPopupMenuWindow actions
632 // ----------------------------------------------------------------------------
634 void wxPopupMenuWindow::ClickItem(wxMenuItem
*item
)
636 wxCHECK_RET( item
, wxT("can't click NULL item") );
638 wxASSERT_MSG( !item
->IsSeparator() && !item
->IsSubMenu(),
639 wxT("can't click this item") );
641 wxMenu
* menu
= m_menu
;
646 menu
->ClickItem(item
);
649 void wxPopupMenuWindow::OpenSubmenu(wxMenuItem
*item
, InputMethod how
)
651 wxCHECK_RET( item
, wxT("can't open NULL submenu") );
653 wxMenu
*submenu
= item
->GetSubMenu();
654 wxCHECK_RET( submenu
, wxT("can only open submenus!") );
656 // FIXME: should take into account the border width
657 submenu
->Popup(ClientToScreen(wxPoint(0, item
->GetPosition())),
658 wxSize(m_menu
->GetGeometryInfo().GetSize().x
, 0),
659 how
== WithKeyboard
/* preselect first item then */);
661 m_hasOpenSubMenu
= true;
664 bool wxPopupMenuWindow::ActivateItem(wxMenuItem
*item
, InputMethod how
)
666 // don't activate disabled items
667 if ( !item
|| !item
->IsEnabled() )
672 // normal menu items generate commands, submenus can be opened and
673 // the separators don't do anything
674 if ( item
->IsSubMenu() )
676 OpenSubmenu(item
, how
);
678 else if ( !item
->IsSeparator() )
682 else // separator, can't activate
690 // ----------------------------------------------------------------------------
691 // wxPopupMenuWindow input handling
692 // ----------------------------------------------------------------------------
694 bool wxPopupMenuWindow::ProcessLeftDown(wxMouseEvent
& event
)
696 // wxPopupWindowHandler dismisses the window when the mouse is clicked
697 // outside it which is usually just fine, but there is one case when we
698 // don't want to do it: if the mouse was clicked on the parent submenu item
699 // which opens this menu, so check for it
701 wxPoint pos
= event
.GetPosition();
702 if ( HitTest(pos
.x
, pos
.y
) == wxHT_WINDOW_OUTSIDE
)
704 wxMenu
*menu
= m_menu
->GetParent();
707 wxPopupMenuWindow
*win
= menu
->m_popupMenu
;
709 wxCHECK_MSG( win
, false, wxT("parent menu not shown?") );
711 pos
= ClientToScreen(pos
);
712 if ( win
->GetMenuItemFromPoint(win
->ScreenToClient(pos
)) )
717 //else: it is outside the parent menu as well, do dismiss this one
724 void wxPopupMenuWindow::OnLeftUp(wxMouseEvent
& event
)
726 wxMenuItemIter node
= GetMenuItemFromPoint(event
.GetPosition());
729 ActivateItem(node
->GetData(), WithMouse
);
733 void wxPopupMenuWindow::OnMouseMove(wxMouseEvent
& event
)
735 const wxPoint pt
= event
.GetPosition();
737 // we need to ignore extra mouse events: example when this happens is when
738 // the mouse is on the menu and we open a submenu from keyboard - Windows
739 // then sends us a dummy mouse move event, we (correctly) determine that it
740 // happens in the parent menu and so immediately close the just opened
743 static wxPoint s_ptLast
;
744 wxPoint ptCur
= ClientToScreen(pt
);
745 if ( ptCur
== s_ptLast
)
753 ProcessMouseMove(pt
);
758 void wxPopupMenuWindow::ProcessMouseMove(const wxPoint
& pt
)
760 wxMenuItemIter node
= GetMenuItemFromPoint(pt
);
762 // don't reset current to NULL here, we only do it when the mouse leaves
763 // the window (see below)
766 if ( !m_nodeCurrent
|| (node
!= m_nodeCurrent
) )
770 wxMenuItem
*item
= GetCurrentItem();
773 OpenSubmenu(item
, WithMouse
);
776 //else: same item, nothing to do
778 else // not on an item
780 // the last open submenu forwards the mouse move messages to its
781 // parent, so if the mouse moves to another item of the parent menu,
782 // this menu is closed and this other item is selected - in the similar
783 // manner, the top menu forwards the mouse moves to the menubar which
784 // allows to select another top level menu by just moving the mouse
786 // we need to translate our client coords to the client coords of the
787 // window we forward this event to
788 wxPoint ptScreen
= ClientToScreen(pt
);
790 // if the mouse is outside this menu, let the parent one to
792 wxMenu
*menuParent
= m_menu
->GetParent();
795 wxPopupMenuWindow
*win
= menuParent
->m_popupMenu
;
797 // if we're shown, the parent menu must be also shown
798 wxCHECK_RET( win
, wxT("parent menu is not shown?") );
800 win
->ProcessMouseMove(win
->ScreenToClient(ptScreen
));
802 else // no parent menu
804 wxMenuBar
*menubar
= m_menu
->GetMenuBar();
807 if ( menubar
->ProcessMouseEvent(
808 menubar
->ScreenToClient(ptScreen
)) )
810 // menubar has closed this menu and opened another one, probably
815 //else: top level popup menu, no other processing to do
819 void wxPopupMenuWindow::OnMouseLeave(wxMouseEvent
& event
)
821 // due to the artefact of mouse events generation under MSW, we actually
822 // may get the mouse leave event after the menu had been already dismissed
823 // and calling ChangeCurrent() would then assert, so don't do it
826 // we shouldn't change the current them if our submenu is opened and
827 // mouse moved there, in this case the submenu is responsable for
830 if ( HasOpenSubmenu() )
832 wxMenuItem
*item
= GetCurrentItem();
833 wxCHECK_RET( CanOpen(item
), wxT("where is our open submenu?") );
835 wxPopupMenuWindow
*win
= item
->GetSubMenu()->m_popupMenu
;
836 wxCHECK_RET( win
, wxT("submenu is opened but not shown?") );
838 // only handle this event if the mouse is not inside the submenu
839 wxPoint pt
= ClientToScreen(event
.GetPosition());
841 win
->HitTest(win
->ScreenToClient(pt
)) == wxHT_WINDOW_OUTSIDE
;
845 // this menu is the last opened
851 ChangeCurrent(wxMenuItemIter());
858 void wxPopupMenuWindow::OnKeyDown(wxKeyEvent
& event
)
860 wxMenuBar
*menubar
= m_menu
->GetMenuBar();
864 menubar
->ProcessEvent(event
);
866 else if ( !ProcessKeyDown(event
.GetKeyCode()) )
872 bool wxPopupMenuWindow::ProcessKeyDown(int key
)
874 wxMenuItem
*item
= GetCurrentItem();
876 // first let the opened submenu to have it (no test for IsEnabled() here,
877 // the keys navigate even in a disabled submenu if we had somehow managed
878 // to open it inspit of this)
879 if ( HasOpenSubmenu() )
881 wxCHECK_MSG( CanOpen(item
), false,
882 wxT("has open submenu but another item selected?") );
884 if ( item
->GetSubMenu()->ProcessKeyDown(key
) )
888 bool processed
= true;
890 // handle the up/down arrows, home, end, esc and return here, pass the
891 // left/right arrows to the menu bar except when the right arrow can be
892 // used to open a submenu
896 // if we're not a top level menu, close us, else leave this to the
898 if ( !m_menu
->GetParent() )
907 // close just this menu
909 HandleDismiss(false);
913 processed
= ActivateItem(item
);
917 ChangeCurrent(m_menu
->GetMenuItems().GetFirst());
921 ChangeCurrent(m_menu
->GetMenuItems().GetLast());
927 bool up
= key
== WXK_UP
;
929 wxMenuItemIter nodeStart
= up
? GetPrevNode() : GetNextNode(),
931 while ( node
&& node
->GetData()->IsSeparator() )
933 node
= up
? GetPrevNode(node
) : GetNextNode(node
);
935 if ( node
== nodeStart
)
937 // nothing but separators and disabled items in this
939 node
= wxMenuItemIter();
955 // don't try to reopen an already opened menu
956 if ( !HasOpenSubmenu() && CanOpen(item
) )
967 // look for the menu item starting with this letter
968 if ( wxIsalnum((wxChar
)key
) )
970 // we want to start from the item after this one because
971 // if we're already on the item with the given accel we want to
972 // go to the next one, not to stay in place
973 wxMenuItemIter nodeStart
= GetNextNode();
975 // do we have more than one item with this accel?
976 bool notUnique
= false;
978 // translate everything to lower case before comparing
979 wxChar chAccel
= (wxChar
)wxTolower(key
);
981 // loop through all items searching for the item with this
983 wxMenuItemIter nodeFound
,
987 item
= node
->GetData();
989 int idxAccel
= item
->GetAccelIndex();
990 if ( idxAccel
!= -1 &&
991 (wxChar
)wxTolower(item
->GetItemLabelText()[(size_t)idxAccel
])
994 // ok, found an item with this accel
997 // store it but continue searching as we need to
998 // know if it's the only item with this accel or if
1002 else // we already had found such item
1006 // no need to continue further, we won't find
1007 // anything we don't already know
1012 // we want to iterate over all items wrapping around if
1014 node
= GetNextNode(node
);
1015 if ( node
== nodeStart
)
1017 // we've seen all nodes
1024 item
= nodeFound
->GetData();
1026 // go to this item anyhow
1027 ChangeCurrent(nodeFound
);
1029 if ( !notUnique
&& item
->IsEnabled() )
1031 // unique item with this accel - activate it
1032 processed
= ActivateItem(item
);
1034 //else: just select it but don't activate as the user might
1035 // have wanted to activate another item
1037 // skip "processed = false" below
1048 // ----------------------------------------------------------------------------
1050 // ----------------------------------------------------------------------------
1058 m_startRadioGroup
= -1;
1067 // ----------------------------------------------------------------------------
1068 // wxMenu and wxMenuGeometryInfo
1069 // ----------------------------------------------------------------------------
1071 wxMenuGeometryInfo::~wxMenuGeometryInfo()
1075 const wxMenuGeometryInfo
& wxMenu::GetGeometryInfo() const
1081 wxConstCast(this, wxMenu
)->m_geometry
=
1082 m_popupMenu
->GetRenderer()->GetMenuGeometry(m_popupMenu
, *this);
1086 wxFAIL_MSG( wxT("can't get geometry without window") );
1093 void wxMenu::InvalidateGeometryInfo()
1095 wxDELETE(m_geometry
);
1098 // ----------------------------------------------------------------------------
1099 // wxMenu adding/removing items
1100 // ----------------------------------------------------------------------------
1102 void wxMenu::OnItemAdded(wxMenuItem
*item
)
1104 InvalidateGeometryInfo();
1108 #endif // wxUSE_ACCEL
1111 void wxMenu::EndRadioGroup()
1113 // we're not inside a radio group any longer
1114 m_startRadioGroup
= -1;
1117 wxMenuItem
* wxMenu::DoAppend(wxMenuItem
*item
)
1119 if ( item
->GetKind() == wxITEM_RADIO
)
1121 int count
= GetMenuItemCount();
1123 if ( m_startRadioGroup
== -1 )
1125 // start a new radio group
1126 m_startRadioGroup
= count
;
1128 // for now it has just one element
1129 item
->SetAsRadioGroupStart();
1130 item
->SetRadioGroupEnd(m_startRadioGroup
);
1132 else // extend the current radio group
1134 // we need to update its end item
1135 item
->SetRadioGroupStart(m_startRadioGroup
);
1136 wxMenuItemIter node
= GetMenuItems().Item(m_startRadioGroup
);
1140 node
->GetData()->SetRadioGroupEnd(count
);
1144 wxFAIL_MSG( wxT("where is the radio group start item?") );
1148 else // not a radio item
1153 if ( !wxMenuBase::DoAppend(item
) )
1161 wxMenuItem
* wxMenu::DoInsert(size_t pos
, wxMenuItem
*item
)
1163 if ( !wxMenuBase::DoInsert(pos
, item
) )
1171 wxMenuItem
*wxMenu::DoRemove(wxMenuItem
*item
)
1173 wxMenuItem
*itemOld
= wxMenuBase::DoRemove(item
);
1177 InvalidateGeometryInfo();
1180 RemoveAccelFor(item
);
1181 #endif // wxUSE_ACCEL
1187 // ----------------------------------------------------------------------------
1188 // wxMenu attaching/detaching
1189 // ----------------------------------------------------------------------------
1191 void wxMenu::Attach(wxMenuBarBase
*menubar
)
1193 wxMenuBase::Attach(menubar
);
1195 wxCHECK_RET( m_menuBar
, wxT("menubar can't be NULL after attaching") );
1197 // unfortunately, we can't use m_menuBar->GetEventHandler() here because,
1198 // if the menubar is currently showing a menu, its event handler is a
1199 // temporary one installed by wxPopupWindow and so will disappear soon any
1200 // any attempts to use it from the newly attached menu would result in a
1203 // so we use the menubar itself, even if it's a pity as it means we can't
1204 // redirect all menu events by changing the menubar handler (FIXME)
1205 SetNextHandler(m_menuBar
);
1208 void wxMenu::Detach()
1210 // After the menu is detached from the menu bar, it shouldn't send its
1212 SetNextHandler(NULL
);
1214 wxMenuBase::Detach();
1217 // ----------------------------------------------------------------------------
1218 // wxMenu misc functions
1219 // ----------------------------------------------------------------------------
1221 wxWindow
*wxMenu::GetRootWindow() const
1223 return GetMenuBar() ? GetMenuBar() : GetInvokingWindow();
1226 wxRenderer
*wxMenu::GetRenderer() const
1228 // we're going to crash without renderer!
1229 wxCHECK_MSG( m_popupMenu
, NULL
, wxT("neither popup nor menubar menu?") );
1231 return m_popupMenu
->GetRenderer();
1234 void wxMenu::RefreshItem(wxMenuItem
*item
)
1236 // the item geometry changed, so our might have changed as well
1237 InvalidateGeometryInfo();
1241 // this would be a bug in IsShown()
1242 wxCHECK_RET( m_popupMenu
, wxT("must have popup window if shown!") );
1244 // recalc geometry to update the item height and such
1245 (void)GetGeometryInfo();
1247 m_popupMenu
->RefreshItem(item
);
1251 // ----------------------------------------------------------------------------
1252 // wxMenu showing and hiding
1253 // ----------------------------------------------------------------------------
1255 bool wxMenu::IsShown() const
1257 return m_popupMenu
&& m_popupMenu
->IsShown();
1260 void wxMenu::OnDismiss(bool dismissParent
)
1264 // always notify the parent about submenu disappearance
1265 wxPopupMenuWindow
*win
= m_menuParent
->m_popupMenu
;
1268 win
->OnSubmenuDismiss( true );
1272 wxFAIL_MSG( wxT("parent menu not shown?") );
1275 // and if we dismiss everything, propagate to parent
1276 if ( dismissParent
)
1278 // dismissParent is recursive
1279 m_menuParent
->Dismiss();
1280 m_menuParent
->OnDismiss(true);
1283 else // no parent menu
1285 // notify the menu bar if we're a top level menu
1288 m_menuBar
->OnDismissMenu(dismissParent
);
1292 wxWindow
* const win
= GetInvokingWindow();
1293 wxCHECK_RET( win
, wxT("what kind of menu is this?") );
1295 win
->DismissPopupMenu();
1300 void wxMenu::Popup(const wxPoint
& pos
, const wxSize
& size
, bool selectFirst
)
1302 // create the popup window if not done yet
1305 m_popupMenu
= new wxPopupMenuWindow(GetRootWindow(), this);
1308 // select the first item unless disabled
1311 m_popupMenu
->SelectFirst();
1314 // the geometry might have changed since the last time we were shown, so
1316 m_popupMenu
->SetClientSize(GetGeometryInfo().GetSize());
1318 // position it as specified
1319 m_popupMenu
->Position(pos
, size
);
1321 // the menu can't have the focus itself (it is a Windows limitation), so
1322 // always keep the focus at the originating window
1323 wxWindow
*focus
= GetRootWindow();
1325 wxASSERT_MSG( focus
, wxT("no window to keep focus on?") );
1328 m_popupMenu
->Popup(focus
);
1331 void wxMenu::Dismiss()
1333 wxCHECK_RET( IsShown(), wxT("can't dismiss hidden menu") );
1335 m_popupMenu
->Dismiss();
1338 // ----------------------------------------------------------------------------
1339 // wxMenu event processing
1340 // ----------------------------------------------------------------------------
1342 bool wxMenu::ProcessKeyDown(int key
)
1344 wxCHECK_MSG( m_popupMenu
, false,
1345 wxT("can't process key events if not shown") );
1347 return m_popupMenu
->ProcessKeyDown(key
);
1350 bool wxMenu::ClickItem(wxMenuItem
*item
)
1353 if ( item
->IsCheckable() )
1355 // update the item state
1356 isChecked
= !item
->IsChecked();
1358 item
->Check(isChecked
!= 0);
1366 return SendEvent(item
->GetId(), isChecked
);
1369 // ----------------------------------------------------------------------------
1370 // wxMenu accel support
1371 // ----------------------------------------------------------------------------
1375 bool wxMenu::ProcessAccelEvent(const wxKeyEvent
& event
)
1377 // do we have an item for this accel?
1378 wxMenuItem
*item
= m_accelTable
.GetMenuItem(event
);
1379 if ( item
&& item
->IsEnabled() )
1381 return ClickItem(item
);
1385 for ( wxMenuItemIter node
= GetMenuItems().GetFirst();
1387 node
= node
->GetNext() )
1389 const wxMenuItem
*item
= node
->GetData();
1390 if ( item
->IsSubMenu() && item
->IsEnabled() )
1393 if ( item
->GetSubMenu()->ProcessAccelEvent(event
) )
1403 void wxMenu::AddAccelFor(wxMenuItem
*item
)
1405 wxAcceleratorEntry
*accel
= item
->GetAccel();
1408 accel
->SetMenuItem(item
);
1410 m_accelTable
.Add(*accel
);
1416 void wxMenu::RemoveAccelFor(wxMenuItem
*item
)
1418 wxAcceleratorEntry
*accel
= item
->GetAccel();
1421 m_accelTable
.Remove(*accel
);
1427 #endif // wxUSE_ACCEL
1429 // ----------------------------------------------------------------------------
1430 // wxMenuItem construction
1431 // ----------------------------------------------------------------------------
1433 wxMenuItem::wxMenuItem(wxMenu
*parentMenu
,
1435 const wxString
& text
,
1436 const wxString
& help
,
1439 : wxMenuItemBase(parentMenu
, id
, text
, help
, kind
, subMenu
)
1442 m_height
= wxDefaultCoord
;
1444 m_radioGroup
.start
= -1;
1445 m_isRadioGroupStart
= false;
1447 m_bmpDisabled
= wxNullBitmap
;
1452 wxMenuItem::~wxMenuItem()
1456 // ----------------------------------------------------------------------------
1457 // wxMenuItemBase methods implemented here
1458 // ----------------------------------------------------------------------------
1461 wxMenuItem
*wxMenuItemBase::New(wxMenu
*parentMenu
,
1463 const wxString
& name
,
1464 const wxString
& help
,
1468 return new wxMenuItem(parentMenu
, id
, name
, help
, kind
, subMenu
);
1471 // ----------------------------------------------------------------------------
1472 // wxMenuItem operations
1473 // ----------------------------------------------------------------------------
1475 void wxMenuItem::NotifyMenu()
1477 m_parentMenu
->RefreshItem(this);
1480 void wxMenuItem::UpdateAccelInfo()
1482 m_indexAccel
= wxControl::FindAccelIndex(m_text
);
1484 // will be empty if the text contains no TABs - ok
1485 m_strAccel
= m_text
.AfterFirst(wxT('\t'));
1488 void wxMenuItem::SetItemLabel(const wxString
& text
)
1490 if ( text
!= m_text
)
1492 // first call the base class version to change m_text
1493 // (and also check if we don't have a stock menu item)
1494 wxMenuItemBase::SetItemLabel(text
);
1502 void wxMenuItem::SetCheckable(bool checkable
)
1504 if ( checkable
!= IsCheckable() )
1506 wxMenuItemBase::SetCheckable(checkable
);
1512 void wxMenuItem::SetBitmaps(const wxBitmap
& bmpChecked
,
1513 const wxBitmap
& bmpUnchecked
)
1515 m_bmpChecked
= bmpChecked
;
1516 m_bmpUnchecked
= bmpUnchecked
;
1521 void wxMenuItem::Enable(bool enable
)
1523 if ( enable
!= m_isEnabled
)
1525 wxMenuItemBase::Enable(enable
);
1531 void wxMenuItem::Check(bool check
)
1533 wxCHECK_RET( IsCheckable(), wxT("only checkable items may be checked") );
1535 if ( m_isChecked
== check
)
1538 if ( GetKind() == wxITEM_RADIO
)
1540 // it doesn't make sense to uncheck a radio item - what would this do?
1544 // get the index of this item in the menu
1545 const wxMenuItemList
& items
= m_parentMenu
->GetMenuItems();
1546 int pos
= items
.IndexOf(this);
1547 wxCHECK_RET( pos
!= wxNOT_FOUND
,
1548 wxT("menuitem not found in the menu items list?") );
1550 // get the radio group range
1554 if ( m_isRadioGroupStart
)
1556 // we already have all information we need
1558 end
= m_radioGroup
.end
;
1560 else // next radio group item
1562 // get the radio group end from the start item
1563 start
= m_radioGroup
.start
;
1564 end
= items
.Item(start
)->GetData()->m_radioGroup
.end
;
1567 // also uncheck all the other items in this radio group
1568 wxMenuItemIter node
= items
.Item(start
);
1569 for ( int n
= start
; n
<= end
&& node
; n
++ )
1573 node
->GetData()->m_isChecked
= false;
1575 node
= node
->GetNext();
1579 wxMenuItemBase::Check(check
);
1584 // radio group stuff
1585 // -----------------
1587 void wxMenuItem::SetAsRadioGroupStart()
1589 m_isRadioGroupStart
= true;
1592 void wxMenuItem::SetRadioGroupStart(int start
)
1594 wxASSERT_MSG( !m_isRadioGroupStart
,
1595 wxT("should only be called for the next radio items") );
1597 m_radioGroup
.start
= start
;
1600 void wxMenuItem::SetRadioGroupEnd(int end
)
1602 wxASSERT_MSG( m_isRadioGroupStart
,
1603 wxT("should only be called for the first radio item") );
1605 m_radioGroup
.end
= end
;
1608 // ----------------------------------------------------------------------------
1609 // wxMenuBar creation
1610 // ----------------------------------------------------------------------------
1612 void wxMenuBar::Init()
1620 m_shouldShowMenu
= false;
1623 wxMenuBar::wxMenuBar(size_t n
, wxMenu
*menus
[], const wxString titles
[], long WXUNUSED(style
))
1627 for (size_t i
= 0; i
< n
; ++i
)
1628 Append(menus
[i
], titles
[i
]);
1631 void wxMenuBar::Attach(wxFrame
*frame
)
1633 // maybe you really wanted to call Detach()?
1634 wxCHECK_RET( frame
, wxT("wxMenuBar::Attach(NULL) called") );
1636 wxMenuBarBase::Attach(frame
);
1640 // reparent if necessary
1641 if ( m_frameLast
!= frame
)
1646 // show it back - was hidden by Detach()
1649 else // not created yet, do it now
1651 // we have no way to return the error from here anyhow :-(
1652 (void)Create(frame
, wxID_ANY
);
1654 SetCursor(wxCURSOR_ARROW
);
1656 SetFont(wxSystemSettings::GetFont(wxSYS_SYSTEM_FONT
));
1658 // calculate and set our height (it won't be changed any more)
1659 SetSize(wxDefaultCoord
, GetBestSize().y
);
1662 // remember the last frame which had us to avoid unnecessarily reparenting
1664 m_frameLast
= frame
;
1667 void wxMenuBar::Detach()
1669 // don't delete the window because we may be reattached later, just hide it
1675 wxMenuBarBase::Detach();
1678 wxMenuBar::~wxMenuBar()
1682 // ----------------------------------------------------------------------------
1683 // wxMenuBar adding/removing items
1684 // ----------------------------------------------------------------------------
1686 bool wxMenuBar::Append(wxMenu
*menu
, const wxString
& title
)
1688 return Insert(GetCount(), menu
, title
);
1691 bool wxMenuBar::Insert(size_t pos
, wxMenu
*menu
, const wxString
& title
)
1693 if ( !wxMenuBarBase::Insert(pos
, menu
, title
) )
1696 wxMenuInfo
*info
= new wxMenuInfo(title
);
1697 m_menuInfos
.Insert(info
, pos
);
1699 RefreshAllItemsAfter(pos
);
1704 wxMenu
*wxMenuBar::Replace(size_t pos
, wxMenu
*menu
, const wxString
& title
)
1706 wxMenu
*menuOld
= wxMenuBarBase::Replace(pos
, menu
, title
);
1710 wxMenuInfo
& info
= m_menuInfos
[pos
];
1712 info
.SetLabel(title
);
1714 // even if the old menu was disabled, the new one is not any more
1717 // even if we change only this one, the new label has different width,
1718 // so we need to refresh everything beyond this item as well
1719 RefreshAllItemsAfter(pos
);
1725 wxMenu
*wxMenuBar::Remove(size_t pos
)
1727 wxMenu
*menuOld
= wxMenuBarBase::Remove(pos
);
1731 m_menuInfos
.RemoveAt(pos
);
1733 // this doesn't happen too often, so don't try to be too smart - just
1734 // refresh everything
1741 // ----------------------------------------------------------------------------
1742 // wxMenuBar top level menus access
1743 // ----------------------------------------------------------------------------
1745 wxCoord
wxMenuBar::GetItemWidth(size_t pos
) const
1747 return m_menuInfos
[pos
].GetWidth(wxConstCast(this, wxMenuBar
));
1750 void wxMenuBar::EnableTop(size_t pos
, bool enable
)
1752 wxCHECK_RET( pos
< GetCount(), wxT("invalid index in EnableTop") );
1754 if ( enable
!= m_menuInfos
[pos
].IsEnabled() )
1756 m_menuInfos
[pos
].SetEnabled(enable
);
1760 //else: nothing to do
1763 bool wxMenuBar::IsEnabledTop(size_t pos
) const
1765 wxCHECK_MSG( pos
< GetCount(), false, wxT("invalid index in IsEnabledTop") );
1767 return m_menuInfos
[pos
].IsEnabled();
1770 void wxMenuBar::SetMenuLabel(size_t pos
, const wxString
& label
)
1772 wxCHECK_RET( pos
< GetCount(), wxT("invalid index in SetMenuLabel") );
1774 if ( label
!= m_menuInfos
[pos
].GetOriginalLabel() )
1776 m_menuInfos
[pos
].SetLabel(label
);
1780 //else: nothing to do
1783 wxString
wxMenuBar::GetMenuLabel(size_t pos
) const
1785 wxCHECK_MSG( pos
< GetCount(), wxEmptyString
, wxT("invalid index in GetMenuLabel") );
1787 return m_menuInfos
[pos
].GetOriginalLabel();
1790 // ----------------------------------------------------------------------------
1791 // wxMenuBar drawing
1792 // ----------------------------------------------------------------------------
1794 void wxMenuBar::RefreshAllItemsAfter(size_t pos
)
1798 // no need to refresh if nothing is shown yet
1802 wxRect rect
= GetItemRect(pos
);
1803 rect
.width
= GetClientSize().x
- rect
.x
;
1807 void wxMenuBar::RefreshItem(size_t pos
)
1809 wxCHECK_RET( pos
!= (size_t)-1,
1810 wxT("invalid item in wxMenuBar::RefreshItem") );
1814 // no need to refresh if nothing is shown yet
1818 RefreshRect(GetItemRect(pos
));
1821 void wxMenuBar::DoDraw(wxControlRenderer
*renderer
)
1823 wxDC
& dc
= renderer
->GetDC();
1824 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
1826 // redraw only the items which must be redrawn
1828 // we don't have to use GetUpdateClientRect() here because our client rect
1829 // is the same as total one
1830 wxRect rectUpdate
= GetUpdateRegion().GetBox();
1832 int flagsMenubar
= GetStateFlags();
1836 rect
.height
= GetClientSize().y
;
1839 size_t count
= GetCount();
1840 for ( size_t n
= 0; n
< count
; n
++ )
1842 if ( x
> rectUpdate
.GetRight() )
1844 // all remaining items are to the right of rectUpdate
1849 rect
.width
= GetItemWidth(n
);
1851 if ( x
< rectUpdate
.x
)
1853 // this item is still to the left of rectUpdate
1857 int flags
= flagsMenubar
;
1858 if ( m_current
!= -1 && n
== (size_t)m_current
)
1860 flags
|= wxCONTROL_SELECTED
;
1863 if ( !IsEnabledTop(n
) )
1865 flags
|= wxCONTROL_DISABLED
;
1868 GetRenderer()->DrawMenuBarItem
1872 m_menuInfos
[n
].GetLabel(),
1874 m_menuInfos
[n
].GetAccelIndex()
1879 // ----------------------------------------------------------------------------
1880 // wxMenuBar geometry
1881 // ----------------------------------------------------------------------------
1883 wxRect
wxMenuBar::GetItemRect(size_t pos
) const
1885 wxASSERT_MSG( pos
< GetCount(), wxT("invalid menu bar item index") );
1886 wxASSERT_MSG( IsCreated(), wxT("can't call this method yet") );
1891 rect
.height
= GetClientSize().y
;
1893 for ( size_t n
= 0; n
< pos
; n
++ )
1895 rect
.x
+= GetItemWidth(n
);
1898 rect
.width
= GetItemWidth(pos
);
1903 wxSize
wxMenuBar::DoGetBestClientSize() const
1906 if ( GetMenuCount() > 0 )
1908 wxClientDC
dc(wxConstCast(this, wxMenuBar
));
1909 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
1910 dc
.GetTextExtent(GetMenuLabel(0), &size
.x
, &size
.y
);
1912 // adjust for the renderer we use
1913 size
= GetRenderer()->GetMenuBarItemSize(size
);
1915 else // empty menubar
1921 // the width is arbitrary, of course, for horizontal menubar
1927 int wxMenuBar::GetMenuFromPoint(const wxPoint
& pos
) const
1929 if ( pos
.x
< 0 || pos
.y
< 0 || pos
.y
> GetClientSize().y
)
1934 size_t count
= GetCount();
1935 for ( size_t item
= 0; item
< count
; item
++ )
1937 x
+= GetItemWidth(item
);
1945 // to the right of the last menu item
1949 // ----------------------------------------------------------------------------
1950 // wxMenuBar menu operations
1951 // ----------------------------------------------------------------------------
1953 void wxMenuBar::SelectMenu(size_t pos
)
1956 wxLogTrace(wxT("mousecapture"), wxT("Capturing mouse from wxMenuBar::SelectMenu"));
1962 void wxMenuBar::DoSelectMenu(size_t pos
)
1964 wxCHECK_RET( pos
< GetCount(), wxT("invalid menu index in DoSelectMenu") );
1966 int posOld
= m_current
;
1972 // close the previous menu
1973 if ( IsShowingMenu() )
1975 // restore m_shouldShowMenu flag after DismissMenu() which resets
1977 bool old
= m_shouldShowMenu
;
1981 m_shouldShowMenu
= old
;
1984 RefreshItem((size_t)posOld
);
1990 void wxMenuBar::PopupMenu(size_t pos
)
1992 wxCHECK_RET( pos
< GetCount(), wxT("invalid menu index in PopupCurrentMenu") );
1999 // ----------------------------------------------------------------------------
2000 // wxMenuBar input handing
2001 // ----------------------------------------------------------------------------
2004 Note that wxMenuBar doesn't use wxInputHandler but handles keyboard and
2005 mouse in the same way under all platforms. This is because it doesn't derive
2006 from wxControl (which works with input handlers) but directly from wxWindow.
2008 Also, menu bar input handling is rather simple, so maybe it's not really
2009 worth making it themeable - at least I've decided against doing it now as it
2010 would merging the changes back into trunk more difficult. But it still could
2011 be done later if really needed.
2014 void wxMenuBar::OnKillFocus(wxFocusEvent
& event
)
2016 if ( m_current
!= -1 )
2018 RefreshItem((size_t)m_current
);
2026 void wxMenuBar::OnLeftDown(wxMouseEvent
& event
)
2034 else // we didn't have mouse capture, capture it now
2036 m_current
= GetMenuFromPoint(event
.GetPosition());
2037 if ( m_current
== -1 )
2039 // unfortunately, we can't prevent wxMSW from giving us the focus,
2040 // so we can only give it back
2045 wxLogTrace(wxT("mousecapture"), wxT("Capturing mouse from wxMenuBar::OnLeftDown"));
2048 // show it as selected
2049 RefreshItem((size_t)m_current
);
2052 PopupCurrentMenu(false /* don't select first item - as Windows does */);
2057 void wxMenuBar::OnMouseMove(wxMouseEvent
& event
)
2061 (void)ProcessMouseEvent(event
.GetPosition());
2069 bool wxMenuBar::ProcessMouseEvent(const wxPoint
& pt
)
2071 // a hack to ignore the extra mouse events MSW sends us: this is similar to
2072 // wxUSE_MOUSEEVENT_HACK in wxWin itself but it isn't enough for us here as
2073 // we get the messages from different windows (old and new popup menus for
2076 static wxPoint s_ptLast
;
2077 if ( pt
== s_ptLast
)
2085 int currentNew
= GetMenuFromPoint(pt
);
2086 if ( (currentNew
== -1) || (currentNew
== m_current
) )
2091 // select the new active item
2092 DoSelectMenu(currentNew
);
2094 // show the menu if we know that we should, even if we hadn't been showing
2095 // it before (this may happen if the previous menu was disabled)
2096 if ( m_shouldShowMenu
&& !m_menuShown
)
2098 // open the new menu if the old one we closed had been opened
2099 PopupCurrentMenu(false /* don't select first item - as Windows does */);
2105 void wxMenuBar::OnKeyDown(wxKeyEvent
& event
)
2107 // ensure that we have a current item - we might not have it if we're
2108 // given the focus with Alt or F10 press (and under GTK+ the menubar
2109 // somehow gets the keyboard events even when it doesn't have focus...)
2110 if ( m_current
== -1 )
2112 if ( !HasCapture() )
2116 else // we do have capture
2118 // we always maintain a valid current item while we're in modal
2119 // state (i.e. have the capture)
2120 wxFAIL_MSG( wxT("how did we manage to lose current item?") );
2126 int key
= event
.GetKeyCode();
2128 // first let the menu have it
2129 if ( IsShowingMenu() && m_menuShown
->ProcessKeyDown(key
) )
2134 // cycle through the menu items when left/right arrows are pressed and open
2135 // the menu when up/down one is
2139 // Alt must be processed at wxWindow level too
2144 // remove the selection and give the focus away
2145 if ( m_current
!= -1 )
2147 if ( IsShowingMenu() )
2159 size_t count
= GetCount();
2162 // the item won't change anyhow
2165 //else: otherwise, it will
2167 // remember if we were showing a menu - if we did, we should
2168 // show the new menu after changing the item
2169 bool wasMenuOpened
= IsShowingMenu();
2170 if ( wasMenuOpened
)
2175 // cast is safe as we tested for -1 above
2176 size_t currentNew
= (size_t)m_current
;
2178 if ( key
== WXK_LEFT
)
2180 if ( currentNew
-- == 0 )
2181 currentNew
= count
- 1;
2185 if ( ++currentNew
== count
)
2189 DoSelectMenu(currentNew
);
2191 if ( wasMenuOpened
)
2206 // letters open the corresponding menu
2209 int idxFound
= FindNextItemForAccel(m_current
, key
, &unique
);
2211 if ( idxFound
!= -1 )
2213 if ( IsShowingMenu() )
2218 DoSelectMenu((size_t)idxFound
);
2220 // if the item is not unique, just select it but don't
2221 // activate as the user might have wanted to activate
2224 // also, don't try to open a disabled menu
2225 if ( unique
&& IsEnabledTop((size_t)idxFound
) )
2231 // skip the "event.Skip()" below
2240 // ----------------------------------------------------------------------------
2241 // wxMenuBar accel handling
2242 // ----------------------------------------------------------------------------
2244 int wxMenuBar::FindNextItemForAccel(int idxStart
, int key
, bool *unique
) const
2246 if ( !wxIsalnum((wxChar
)key
) )
2248 // we only support letters/digits as accels
2252 // do we have more than one item with this accel?
2256 // translate everything to lower case before comparing
2257 wxChar chAccel
= (wxChar
)wxTolower(key
);
2259 // the index of the item with this accel
2262 // loop through all items searching for the item with this
2263 // accel starting at the item after the current one
2264 int count
= GetCount();
2265 int n
= idxStart
== -1 ? 0 : idxStart
+ 1;
2276 const wxMenuInfo
& info
= m_menuInfos
[n
];
2278 int idxAccel
= info
.GetAccelIndex();
2279 if ( idxAccel
!= -1 &&
2280 (wxChar
)wxTolower(info
.GetLabel()[(size_t)idxAccel
]) == chAccel
)
2282 // ok, found an item with this accel
2283 if ( idxFound
== -1 )
2285 // store it but continue searching as we need to
2286 // know if it's the only item with this accel or if
2290 else // we already had found such item
2295 // no need to continue further, we won't find
2296 // anything we don't already know
2301 // we want to iterate over all items wrapping around if
2309 if ( n
== idxStart
)
2311 // we've seen all items
2321 bool wxMenuBar::ProcessAccelEvent(const wxKeyEvent
& event
)
2324 for ( wxMenuList::compatibility_iterator node
= m_menus
.GetFirst();
2326 node
= node
->GetNext(), n
++ )
2328 // accels of the items in the disabled menus shouldn't work
2329 if ( m_menuInfos
[n
].IsEnabled() )
2331 if ( node
->GetData()->ProcessAccelEvent(event
) )
2333 // menu processed it
2343 #endif // wxUSE_ACCEL
2345 // ----------------------------------------------------------------------------
2346 // wxMenuBar menus showing
2347 // ----------------------------------------------------------------------------
2349 void wxMenuBar::PopupCurrentMenu(bool selectFirst
)
2351 wxCHECK_RET( m_current
!= -1, wxT("no menu to popup") );
2353 // forgot to call DismissMenu()?
2354 wxASSERT_MSG( !m_menuShown
, wxT("shouldn't show two menus at once!") );
2356 // in any case, we should show it - even if we won't
2357 m_shouldShowMenu
= true;
2359 if ( IsEnabledTop(m_current
) )
2361 // remember the menu we show
2362 m_menuShown
= GetMenu(m_current
);
2364 // we don't show the menu at all if it has no items
2365 if ( !m_menuShown
->IsEmpty() )
2367 // position it correctly: note that we must use screen coords and
2368 // that we pass 0 as width to position the menu exactly below the
2369 // item, not to the right of it
2370 wxRect rectItem
= GetItemRect(m_current
);
2372 m_menuShown
->Popup(ClientToScreen(rectItem
.GetPosition()),
2373 wxSize(0, rectItem
.GetHeight()),
2378 // reset it back as no menu is shown
2382 //else: don't show disabled menu
2385 void wxMenuBar::DismissMenu()
2387 wxCHECK_RET( m_menuShown
, wxT("can't dismiss menu if none is shown") );
2389 m_menuShown
->Dismiss();
2393 void wxMenuBar::OnDismissMenu(bool dismissMenuBar
)
2395 m_shouldShowMenu
= false;
2397 if ( dismissMenuBar
)
2403 void wxMenuBar::OnDismiss()
2405 if ( ReleaseMouseCapture() )
2407 wxLogTrace(wxT("mousecapture"), wxT("Releasing mouse from wxMenuBar::OnDismiss"));
2410 if ( m_current
!= -1 )
2412 size_t current
= m_current
;
2415 RefreshItem(current
);
2421 bool wxMenuBar::ReleaseMouseCapture()
2424 // With wxX11, when a menu is closed by clicking away from it, a control
2425 // under the click will still get an event, even though the menu has the
2426 // capture (bug?). So that control may already have taken the capture by
2427 // this point, preventing us from releasing the menu's capture. So to work
2428 // around this, we release both captures, then put back the control's
2430 wxWindow
*capture
= GetCapture();
2433 capture
->ReleaseMouse();
2435 if ( capture
== this )
2438 bool had
= HasCapture();
2443 capture
->CaptureMouse();
2457 void wxMenuBar::GiveAwayFocus()
2459 GetFrame()->SetFocus();
2462 // ----------------------------------------------------------------------------
2463 // popup menu support
2464 // ----------------------------------------------------------------------------
2466 wxEventLoop
*wxWindow::ms_evtLoopPopup
= NULL
;
2468 bool wxWindow::DoPopupMenu(wxMenu
*menu
, int x
, int y
)
2470 wxCHECK_MSG( !ms_evtLoopPopup
, false,
2471 wxT("can't show more than one popup menu at a time") );
2474 // we need to change the cursor before showing the menu as, apparently, no
2475 // cursor changes took place while the mouse is captured
2476 wxCursor cursorOld
= GetCursor();
2477 SetCursor(wxCURSOR_ARROW
);
2481 // flash any delayed log messages before showing the menu, otherwise it
2482 // could be dismissed (because it would lose focus) immediately after being
2484 wxLog::FlushActive();
2486 // some controls update themselves from OnIdle() call - let them do it
2487 wxTheApp
->ProcessIdle();
2489 // if the window hadn't been refreshed yet, the menu can adversely affect
2490 // its next OnPaint() handler execution - i.e. scrolled window refresh
2491 // logic breaks then as it scrolls part of the menu which hadn't been there
2492 // when the update event was generated into view
2496 menu
->Popup(ClientToScreen(wxPoint(x
, y
)), wxSize(0,0));
2498 // this is not very useful if the menu was popped up because of the mouse
2499 // click but I think it is nice to do when it appears because of a key
2500 // press (i.e. Windows menu key)
2502 // Windows itself doesn't do it, but IMHO this is nice
2505 // we have to redirect all keyboard input to the menu temporarily
2506 PushEventHandler(new wxMenuKbdRedirector(menu
));
2508 // enter the local modal loop
2509 ms_evtLoopPopup
= new wxEventLoop
;
2510 ms_evtLoopPopup
->Run();
2512 wxDELETE(ms_evtLoopPopup
);
2514 // remove the handler
2515 PopEventHandler(true /* delete it */);
2518 SetCursor(cursorOld
);
2524 void wxWindow::DismissPopupMenu()
2526 wxCHECK_RET( ms_evtLoopPopup
, wxT("no popup menu shown") );
2528 ms_evtLoopPopup
->Exit();
2531 #endif // wxUSE_MENUS