BasicMenu::Handle Class Reference

#include <BasicMenu.h>

Public Member Functions
	Handle (wxMenu *pMenu)
	Handle (const Handle &other)=delete
Handle &	operator= (const Handle &other)=delete
void	Popup (const BasicUI::WindowPlacement &window, const Point &pos={})
	Display the menu at pos, invoke at most one action, then hide it. More...

Private Attributes
wxMenu *	mpMenu

Detailed Description

Definition at line 25 of file BasicMenu.h.

Constructor & Destructor Documentation

Handle() [1/2]

BasicMenu::Handle::Handle ( wxMenu *  pMenu )

inlineexplicit

Definition at line 29 of file BasicMenu.h.

: mpMenu{ pMenu } {}

Handle() [2/2]

BasicMenu::Handle::Handle ( const Handle &  other )

delete

Member Function Documentation

operator=()

Handle & BasicMenu::Handle::operator= ( const Handle &  other )

delete

Popup()

void BasicMenu::Handle::Popup	(	const BasicUI::WindowPlacement &	window,
		const Point &	pos = {}
	)

Display the menu at pos, invoke at most one action, then hide it.

Definition at line 209 of file BasicMenu.cpp.

{
   wxMenu *const pMenu = mpMenu;
   if ( !pMenu )
      return;
 
   if ( auto pWindow = wxWidgetsWindowPlacement::GetParent( window ) ) {
      sHandledEvent = false;
 
      // Put the menu pointers where the event filter can find them
      sMenuStack.push_back( FindDescendants( *pMenu ) );
      auto cleanup = finally( []{ sMenuStack.pop_back(); } );
 
      if ( Journal::IsReplaying() )
         ReplayPopup( pMenu );
      else
         pWindow->PopupMenu( pMenu, { pos.x, pos.y } );
 
      if ( !sHandledEvent )
         // Menu popped but no command was selected.  Record that.
         Journal::Output( JournalCode );
   }
}

References BasicMenu::anonymous_namespace{BasicMenu.cpp}::FindDescendants(), wxWidgetsWindowPlacement::GetParent(), Journal::IsReplaying(), JournalCode, mpMenu, Journal::Output(), BasicMenu::anonymous_namespace{BasicMenu.cpp}::ReplayPopup(), BasicMenu::anonymous_namespace{BasicMenu.cpp}::sHandledEvent, BasicMenu::anonymous_namespace{BasicMenu.cpp}::sMenuStack, BasicUI::Point::x, and BasicUI::Point::y.

Referenced by SelectionBar::AddSelectionSetupButton(), CommonTrackPanelCell::DoContextMenu(), AudioSetupToolBar::OnAudioSetup(), NumericTextCtrl::OnContext(), KeyConfigPrefs::OnDefaults(), EffectUIHost::OnMenu(), anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnPopup(), anonymous_namespace{PopupMenuTable.cpp}::PopupMenuImpl::Popup(), LabelTrackView::ShowContextMenu(), AdornedRulerPanel::ShowMenu(), MeterPanel::ShowMenu(), and AdornedRulerPanel::ShowScrubMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mpMenu

wxMenu* BasicMenu::Handle::mpMenu

private

Definition at line 39 of file BasicMenu.h.

Referenced by Popup().

---

The documentation for this class was generated from the following files:

• BasicMenu.h
• BasicMenu.cpp