ACTION_MENU Class Reference

Defines the structure of a menu based on ACTIONs. More...

#include <action_menu.h>

Inheritance diagram for ACTION_MENU:

Public Member Functions
	ACTION_MENU (bool isContextMenu, TOOL_INTERACTIVE *aTool=nullptr)
	< Default constructor More...
	~ACTION_MENU () override
	ACTION_MENU (const ACTION_MENU &aMenu)=delete
ACTION_MENU &	operator= (const ACTION_MENU &aMenu)=delete
void	SetTitle (const wxString &aTitle) override
	Set title for the menu. More...
void	DisplayTitle (bool aDisplay=true)
	Decide whether a title for a pop up menu should be displayed. More...
void	SetIcon (BITMAPS aIcon)
	Assign an icon for the entry. More...
wxMenuItem *	Add (const wxString &aLabel, int aId, BITMAPS aIcon)
	Add a wxWidgets-style entry to the menu. More...
wxMenuItem *	Add (const wxString &aLabel, const wxString &aToolTip, int aId, BITMAPS aIcon, bool aIsCheckmarkEntry=false)
wxMenuItem *	Add (const TOOL_ACTION &aAction, bool aIsCheckmarkEntry=false, const wxString &aOverrideLabel=wxEmptyString)
	Add an entry to the menu based on the TOOL_ACTION object. More...
wxMenuItem *	Add (ACTION_MENU *aMenu)
	Add an action menu as a submenu. More...
void	AddClose (wxString aAppname="")
	Add a standard close item to the menu with the accelerator key CTRL-W. More...
void	AddQuitOrClose (KIFACE_I *aKiface, wxString aAppname="")
	Add either a standard Quit or Close item to the menu. More...
void	Clear ()
	Remove all the entries from the menu (as well as its title). More...
bool	HasEnabledItems () const
	Returns true if the menu has any enabled items. More...
int	GetSelected () const
	Return the position of selected item. More...
void	UpdateAll ()
	Run update handlers for the menu and its submenus. More...
void	ClearDirty ()
	Clear the dirty flag on the menu and all descendants. More...
void	SetDirty ()
void	SetTool (TOOL_INTERACTIVE *aTool)
	Set a tool that is the creator of the menu. More...
ACTION_MENU *	Clone () const
	Create a deep, recursive copy of this ACTION_MENU. More...
void	OnMenuEvent (wxMenuEvent &aEvent)
void	OnIdle (wxIdleEvent &event)
virtual bool	PassHelpTextToHandler ()

Static Public Attributes
static constexpr bool	NORMAL = false
static constexpr bool	CHECK = true

Protected Member Functions
virtual ACTION_MENU *	create () const
	< Return an instance of this class. It has to be overridden in inheriting classes. More...
TOOL_MANAGER *	getToolManager () const
virtual void	update ()
	Update menu state stub. More...
virtual OPT_TOOL_EVENT	eventHandler (const wxMenuEvent &)
	Event handler stub. More...
void	copyFrom (const ACTION_MENU &aMenu)
	Copy another menus data to this instance. More...
wxMenuItem *	appendCopy (const wxMenuItem *aSource)
	Append a copy of wxMenuItem. More...
void	setupEvents ()
	Update hot key settings for TOOL_ACTIONs in this menu. More...
void	updateHotKeys ()
	Traverse the submenus tree looking for a submenu capable of handling a particular menu event. More...
void	runEventHandlers (const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
	Run a function on the menu and all its submenus. More...
void	runOnSubmenus (std::function< void(ACTION_MENU *)> aFunction)
	Check if any of submenus contains a TOOL_ACTION with a specific ID. More...
OPT_TOOL_EVENT	findToolAction (int aId)

Protected Attributes
bool	m_isForcedPosition
wxPoint	m_forcedPosition
bool	m_dirty
bool	m_titleDisplayed
bool	m_isContextMenu
	Menu title. More...
wxString	m_title
	Optional icon. More...
BITMAPS	m_icon
	Stores the id number of selected item. More...
int	m_selected
	Creator of the menu. More...
TOOL_INTERACTIVE *	m_tool
	Associates tool actions with menu item IDs. Non-owning. More...
std::map< int, const TOOL_ACTION * >	m_toolActions
	List of submenus. More...
std::list< ACTION_MENU * >	m_submenus

Friends
class	TOOL_INTERACTIVE

Detailed Description

Defines the structure of a menu based on ACTIONs.

Definition at line 48 of file action_menu.h.

Constructor & Destructor Documentation

ACTION_MENU() [1/2]

ACTION_MENU::ACTION_MENU	(	bool	isContextMenu,
		TOOL_INTERACTIVE *	aTool = nullptr
	)

< Default constructor

Definition at line 47 of file action_menu.cpp.

                                                                      :
    m_isForcedPosition( false ),
    m_dirty( true ),
    m_titleDisplayed( false ),
    m_isContextMenu( isContextMenu ),
    m_icon( BITMAPS::INVALID_BITMAP ),
    m_selected( -1 ),
    m_tool( aTool )
{
    setupEvents();
}

References INVALID_BITMAP, and setupEvents().

Referenced by create(), and BUS_UNFOLD_MENU::update().

~ACTION_MENU()

ACTION_MENU::~ACTION_MENU ( )

override

Definition at line 60 of file action_menu.cpp.

{
    // Set parent to NULL to prevent submenus from unregistering from a nonexistent object
    for( auto menu : m_submenus )
        menu->SetParent( nullptr );

    ACTION_MENU* parent = dynamic_cast<ACTION_MENU*>( GetParent() );

    if( parent )
        parent->m_submenus.remove( this );
}

References m_submenus.

ACTION_MENU() [2/2]

ACTION_MENU::ACTION_MENU ( const ACTION_MENU &  aMenu )

delete

Member Function Documentation

Add() [1/4]

wxMenuItem * ACTION_MENU::Add	(	const wxString &	aLabel,
		int	aId,
		BITMAPS	aIcon
	)

Add a wxWidgets-style entry to the menu.

After highlighting/selecting the entry, a wxWidgets event is generated.

Definition at line 135 of file action_menu.cpp.

{
    wxASSERT_MSG( FindItem( aId ) == nullptr, "Duplicate menu IDs!" );

    wxMenuItem* item = new wxMenuItem( this, aId, aLabel, wxEmptyString, wxITEM_NORMAL );

    if( !!aIcon )
        AddBitmapToMenuItem( item, KiBitmap( aIcon ) );

    return Append( item );
}

References AddBitmapToMenuItem(), and KiBitmap().

Referenced by AddClose(), AddMenuLanguageList(), AddQuitOrClose(), EDA_3D_VIEWER_FRAME::CreateMenuBar(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), CONDITIONAL_MENU::Evaluate(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), NET_CONTEXT_MENU::NET_CONTEXT_MENU(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), and CVPCB_MAINFRAME::setupTools().

Add() [2/4]

wxMenuItem * ACTION_MENU::Add	(	const wxString &	aLabel,
		const wxString &	aToolTip,
		int	aId,
		BITMAPS	aIcon,
		bool	aIsCheckmarkEntry = false
	)

Definition at line 148 of file action_menu.cpp.

{
    wxASSERT_MSG( FindItem( aId ) == nullptr, "Duplicate menu IDs!" );

    wxMenuItem* item = new wxMenuItem( this, aId, aLabel, aTooltip,
                                       aIsCheckmarkEntry ? wxITEM_CHECK : wxITEM_NORMAL );

    if( !!aIcon )
        AddBitmapToMenuItem( item, KiBitmap( aIcon ) );

    return Append( item );
}

References AddBitmapToMenuItem(), and KiBitmap().

Add() [3/4]

wxMenuItem * ACTION_MENU::Add	(	const TOOL_ACTION &	aAction,
		bool	aIsCheckmarkEntry = false,
		const wxString &	aOverrideLabel = wxEmptyString
	)

Add an entry to the menu based on the TOOL_ACTION object.

After selecting the entry, a TOOL_EVENT command containing name of the action is sent.

Parameters

aAction	is the action to be added to menu entry.
aIsCheckmarkEntry	is true to indicate a check menu entry, false for normal menu entry
aOverrideLabel	is the label to show in the menu (overriding the action's menu text) when non-empty

ID numbers for tool actions are assigned above ACTION_BASE_UI_ID inside TOOL_EVENT

Definition at line 163 of file action_menu.cpp.

{
    BITMAPS icon = aAction.GetIcon();

    // Allow the label to be overridden at point of use
    wxString menuLabel = aOverrideLabel.IsEmpty() ? aAction.GetMenuItem() :  aOverrideLabel;

    wxMenuItem* item = new wxMenuItem( this, aAction.GetUIId(), menuLabel,
                                       aAction.GetDescription(),
                                       aIsCheckmarkEntry ? wxITEM_CHECK : wxITEM_NORMAL );
    if( !!icon )
        AddBitmapToMenuItem( item, KiBitmap( icon ) );

    m_toolActions[aAction.GetUIId()] = &aAction;

    return Append( item );
}

References AddBitmapToMenuItem(), TOOL_ACTION::GetDescription(), TOOL_ACTION::GetIcon(), TOOL_ACTION::GetMenuItem(), TOOL_ACTION::GetUIId(), KiBitmap(), and m_toolActions.

Add() [4/4]

wxMenuItem * ACTION_MENU::Add

(

ACTION_MENU *

aMenu

)

Add an action menu as a submenu.

The difference between this function and wxMenu::AppendSubMenu() is the capability to handle icons.

Parameters

aMenu

is the submenu to be added.

Definition at line 184 of file action_menu.cpp.

{
    ACTION_MENU* menuCopy = aMenu->Clone();
    m_submenus.push_back( menuCopy );

    wxASSERT_MSG( !menuCopy->m_title.IsEmpty(), "Set a title for ACTION_MENU using SetTitle()" );

    if( !!aMenu->m_icon )
    {
        wxMenuItem* newItem = new wxMenuItem( this, -1, menuCopy->m_title );
        AddBitmapToMenuItem( newItem, KiBitmap( aMenu->m_icon ) );
        newItem->SetSubMenu( menuCopy );
        return Append( newItem );
    }
    else
    {
        return AppendSubMenu( menuCopy, menuCopy->m_title );
    }
}

References AddBitmapToMenuItem(), Clone(), KiBitmap(), m_icon, m_submenus, and m_title.

AddClose()

void ACTION_MENU::AddClose

(

wxString

aAppname = ""

)

Add a standard close item to the menu with the accelerator key CTRL-W.

Emits the wxID_CLOSE event.

Parameters

aAppname

is the application name to append to the tooltip.

Definition at line 205 of file action_menu.cpp.

{
#ifdef __WINDOWS__
    Add( _( "Close" ),
         wxString::Format( _( "Close %s" ), aAppname ),
         wxID_CLOSE,
         BITMAPS::exit );
#else
    Add( _( "Close" ) + "\tCtrl+W",
         wxString::Format( _( "Close %s" ), aAppname ),
         wxID_CLOSE,
         BITMAPS::exit );
#endif
}

References _, Add(), exit, and Format().

Referenced by AddQuitOrClose(), EDA_3D_VIEWER_FRAME::CreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), and CVPCB_MAINFRAME::ReCreateMenuBar().

AddQuitOrClose()

void ACTION_MENU::AddQuitOrClose	(	KIFACE_I *	aKiface,
		wxString	aAppname = ""
	)

Add either a standard Quit or Close item to the menu.

If aKiface is NULL or in single-instance then quit (wxID_QUIT) is used, otherwise close (wxID_CLOSE) is used.

Parameters

aAppname

is the application name to append to the tooltip.

Definition at line 221 of file action_menu.cpp.

{
    if( !aKiface || aKiface->IsSingle() ) // not when under a project mgr
    {
        // Don't use ACTIONS::quit; wxWidgets moves this on OSX and expects to find it via
        // wxID_EXIT
        Add( _( "Quit" ) + "\tCtrl+Q",
             wxString::Format( _( "Quit %s" ), aAppname ),
             wxID_EXIT,
             BITMAPS::exit );
    }
    else
    {
        AddClose( aAppname );
    }
}

References _, Add(), AddClose(), exit, Format(), and KIFACE_I::IsSingle().

Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

appendCopy()

wxMenuItem * ACTION_MENU::appendCopy ( const wxMenuItem *  aSource )

protected

Append a copy of wxMenuItem.

Initialize handlers for events.

Definition at line 637 of file action_menu.cpp.

{
    wxMenuItem* newItem = new wxMenuItem( this, aSource->GetId(), aSource->GetItemLabel(),
                                          aSource->GetHelp(), aSource->GetKind() );

    // Add the source bitmap if it is not the wxNullBitmap
    // On Windows, for Checkable Menu items, adding a bitmap adds also
    // our predefined checked alternate bitmap
    // On other OS, wxITEM_CHECK and wxITEM_RADIO Menu items do not use custom bitmaps.
#if defined( _WIN32 )
    // On Windows, AddBitmapToMenuItem() uses the unchecked bitmap for wxITEM_CHECK and
    // wxITEM_RADIO menuitems and autoamtically adds a checked bitmap.
    // For other menuitrms, use the "checked" bitmap.
    bool use_checked_bm = ( aSource->GetKind() == wxITEM_CHECK ||
                            aSource->GetKind() == wxITEM_RADIO ) ? false : true;
    const wxBitmap& src_bitmap = aSource->GetBitmap( use_checked_bm );
#else
    const wxBitmap& src_bitmap = aSource->GetBitmap();
#endif

    if( src_bitmap.IsOk() && src_bitmap.GetHeight() > 1 )    // a null bitmap has a 0 size
        AddBitmapToMenuItem( newItem, src_bitmap );

    if( aSource->IsSubMenu() )
    {
        ACTION_MENU* menu = dynamic_cast<ACTION_MENU*>( aSource->GetSubMenu() );
        wxASSERT_MSG( menu, "Submenus are expected to be a ACTION_MENU" );

        if( menu )
        {
            ACTION_MENU* menuCopy = menu->Clone();
            newItem->SetSubMenu( menuCopy );
            m_submenus.push_back( menuCopy );
        }
    }

    // wxMenuItem has to be added before enabling/disabling or checking
    Append( newItem );

    if( aSource->IsCheckable() )
        newItem->Check( aSource->IsChecked() );

    newItem->Enable( aSource->IsEnabled() );

    return newItem;
}

References AddBitmapToMenuItem(), Clone(), and m_submenus.

Referenced by copyFrom().

Clear()

void ACTION_MENU::Clear

(

)

Remove all the entries from the menu (as well as its title).

It leaves the menu in the initial state.

Definition at line 239 of file action_menu.cpp.

{
    m_titleDisplayed = false;

    for( int i = GetMenuItemCount() - 1; i >= 0; --i )
        Destroy( FindItemByPosition( i ) );

    m_toolActions.clear();
    m_submenus.clear();

    wxASSERT( GetMenuItemCount() == 0 );
}

References m_submenus, m_titleDisplayed, and m_toolActions.

Referenced by Clone(), CONDITIONAL_MENU::Evaluate(), VIA_SIZE_MENU::update(), SYMBOL_UNIT_MENU::update(), BUS_UNFOLD_MENU::update(), TRACK_WIDTH_MENU::update(), and DIFF_PAIR_MENU::update().

ClearDirty()

void ACTION_MENU::ClearDirty

(

)

Clear the dirty flag on the menu and all descendants.

Definition at line 289 of file action_menu.cpp.

{
    m_dirty = false;
    runOnSubmenus( std::bind( &ACTION_MENU::ClearDirty, _1 ) );
}

References m_dirty, and runOnSubmenus().

Referenced by TOOL_MENU::ShowContextMenu().

Clone()

ACTION_MENU * ACTION_MENU::Clone

(

)

const

Create a deep, recursive copy of this ACTION_MENU.

Definition at line 310 of file action_menu.cpp.

{
    ACTION_MENU* clone = create();
    clone->Clear();
    clone->copyFrom( *this );
    return clone;
}

References Clear(), copyFrom(), and create().

Referenced by Add(), appendCopy(), and TOOL_MANAGER::DispatchContextMenu().

copyFrom()

void ACTION_MENU::copyFrom ( const ACTION_MENU &  aMenu )

protected

Copy another menus data to this instance.

Old entries are preserved and ones form aMenu are copied.

Definition at line 619 of file action_menu.cpp.

{
    m_icon = aMenu.m_icon;
    m_title = aMenu.m_title;
    m_titleDisplayed = aMenu.m_titleDisplayed;
    m_selected = -1; // aMenu.m_selected;
    m_tool = aMenu.m_tool;
    m_toolActions = aMenu.m_toolActions;

    // Copy all menu entries
    for( int i = 0; i < (int) aMenu.GetMenuItemCount(); ++i )
    {
        wxMenuItem* item = aMenu.FindItemByPosition( i );
        appendCopy( item );
    }
}

References appendCopy(), m_icon, m_selected, m_title, m_titleDisplayed, m_tool, and m_toolActions.

Referenced by Clone().

create()

ACTION_MENU * ACTION_MENU::create ( ) const

protectedvirtual

< Return an instance of this class. It has to be overridden in inheriting classes.

Returns an instance of TOOL_MANAGER class.

Reimplemented in DIFF_PAIR_MENU, TRACK_WIDTH_MENU, LOCK_CONTEXT_MENU, HIGHLIGHT_MENU, ZONE_CONTEXT_MENU, BUS_UNFOLD_MENU, SELECT_MENU, SYMBOL_UNIT_MENU, VIA_SIZE_MENU, NET_CONTEXT_MENU, GROUP_CONTEXT_MENU, CONDITIONAL_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 319 of file action_menu.cpp.

{
    ACTION_MENU* menu = new ACTION_MENU( false );

    wxASSERT_MSG( typeid( *this ) == typeid( *menu ),
                  wxString::Format( "You need to override create() method for class %s",
                                    typeid( *this ).name() ) );

    return menu;
}

References ACTION_MENU(), and Format().

Referenced by Clone().

DisplayTitle()

void ACTION_MENU::DisplayTitle

(

bool

aDisplay = true

)

Decide whether a title for a pop up menu should be displayed.

Definition at line 98 of file action_menu.cpp.

{
    if( ( !aDisplay || m_title.IsEmpty() ) && m_titleDisplayed )
    {
        // Destroy the menu entry keeping the title..
        wxMenuItem* item = FindItemByPosition( 0 );
        wxASSERT( item->GetItemLabelText() == GetTitle() );
        Destroy( item );
        // ..and separator
        item = FindItemByPosition( 0 );
        wxASSERT( item->IsSeparator() );
        Destroy( item );
        m_titleDisplayed = false;
    }

    else if( aDisplay && !m_title.IsEmpty() )
    {
        if( m_titleDisplayed )
        {
            // Simply update the title
            FindItemByPosition( 0 )->SetItemLabel( m_title );
        }
        else
        {
            // Add a separator and a menu entry to display the title
            InsertSeparator( 0 );
            Insert( 0, new wxMenuItem( this, wxID_NONE, m_title, wxEmptyString, wxITEM_NORMAL ) );

            if( !!m_icon )
                AddBitmapToMenuItem( FindItemByPosition( 0 ), KiBitmap( m_icon ) );

            m_titleDisplayed = true;
        }
    }
}

References AddBitmapToMenuItem(), KiBitmap(), m_icon, m_title, and m_titleDisplayed.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), and SetTitle().

eventHandler()

virtual OPT_TOOL_EVENT ACTION_MENU::eventHandler ( const wxMenuEvent &  )

inlineprotectedvirtual

Event handler stub.

It should be used if you want to generate a TOOL_EVENT from a wxMenuEvent. It will be called when a menu entry is clicked.

Reimplemented in DIFF_PAIR_MENU, TRACK_WIDTH_MENU, VIA_SIZE_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 208 of file action_menu.h.

    {
        return OPT_TOOL_EVENT();
    }

Referenced by OnMenuEvent(), and runEventHandlers().

findToolAction()

OPT_TOOL_EVENT ACTION_MENU::findToolAction ( int  aId )

protected

Definition at line 596 of file action_menu.cpp.

{
    OPT_TOOL_EVENT evt;

    auto findFunc = [&]( ACTION_MENU* m ) {
        if( evt )
            return;

        const auto it = m->m_toolActions.find( aId );

        if( it != m->m_toolActions.end() )
            evt = it->second->MakeEvent();
    };

    findFunc( this );

    if( !evt )
        runOnSubmenus( findFunc );

    return evt;
}

References runOnSubmenus().

Referenced by OnMenuEvent().

GetSelected()

int ACTION_MENU::GetSelected ( ) const

inline

Return the position of selected item.

If the returned value is negative, that means that menu was dismissed.

Returns

The position of selected item in the action menu.

Definition at line 149 of file action_menu.h.

    {
        return m_selected;
    }

References m_selected.

getToolManager()

TOOL_MANAGER * ACTION_MENU::getToolManager ( ) const

protected

Definition at line 331 of file action_menu.cpp.

{
    wxASSERT( m_tool );
    return m_tool ? m_tool->GetManager() : nullptr;
}

References TOOL_BASE::GetManager(), and m_tool.

Referenced by VIA_SIZE_MENU::eventHandler(), OnMenuEvent(), GROUP_CONTEXT_MENU::update(), VIA_SIZE_MENU::update(), SYMBOL_UNIT_MENU::update(), BUS_UNFOLD_MENU::update(), and updateHotKeys().

HasEnabledItems()

bool ACTION_MENU::HasEnabledItems

(

)

const

Returns true if the menu has any enabled items.

Definition at line 253 of file action_menu.cpp.

{
    bool hasEnabled = false;

    auto& items = GetMenuItems();

    for( auto item : items )
    {
        if( item->IsEnabled() && !item->IsSeparator() )
        {
            hasEnabled = true;
            break;
        }
    }

    return hasEnabled;
}

OnIdle()

void ACTION_MENU::OnIdle

(

wxIdleEvent &

event

)

Definition at line 387 of file action_menu.cpp.

{
    g_last_menu_highlighted_id = 0;
    g_menu_open_position.x = 0.0;
    g_menu_open_position.y = 0.0;
}

References g_last_menu_highlighted_id, g_menu_open_position, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setupEvents().

OnMenuEvent()

void ACTION_MENU::OnMenuEvent

(

wxMenuEvent &

aEvent

)

Definition at line 395 of file action_menu.cpp.

{
    OPT_TOOL_EVENT evt;
    wxString       menuText;
    wxEventType    type = aEvent.GetEventType();
    wxWindow*      focus = wxWindow::FindFocus();

    if( type == wxEVT_MENU_OPEN )
    {
        if( m_dirty && m_tool )
            getToolManager()->RunAction( ACTIONS::updateMenu, true, this );

        wxMenu* parent = dynamic_cast<wxMenu*>( GetParent() );

        // Don't update the position if this menu has a parent
        if( !parent && m_tool )
            g_menu_open_position = getToolManager()->GetMousePosition();

        g_last_menu_highlighted_id = 0;
    }
    else if( type == wxEVT_MENU_HIGHLIGHT )
    {
        if( aEvent.GetId() > 0 )
            g_last_menu_highlighted_id = aEvent.GetId();

        evt = TOOL_EVENT( TC_COMMAND, TA_CHOICE_MENU_UPDATE, aEvent.GetId() );
    }
    else if( type == wxEVT_COMMAND_MENU_SELECTED )
    {
        // Despite our attempts to catch the theft of text editor CHAR_HOOK and CHAR events
        // in TOOL_DISPATCHER::DispatchWxEvent, wxWidgets sometimes converts those it knows
        // about into menu commands without ever generating the appropriate CHAR_HOOK and CHAR
        // events first.
        if( dynamic_cast<wxTextEntry*>( focus )
                || dynamic_cast<wxStyledTextCtrl*>( focus )
                || dynamic_cast<wxListView*>( focus ) )
        {
            // Original key event has been lost, so we have to re-create it from the menu's
            // wxAcceleratorEntry.
            wxMenuItem* menuItem = FindItem( aEvent.GetId() );
            wxAcceleratorEntry* acceleratorKey = menuItem ? menuItem->GetAccel() : nullptr;

            if( acceleratorKey )
            {
                wxKeyEvent keyEvent( wxEVT_CHAR_HOOK );
                keyEvent.m_keyCode = acceleratorKey->GetKeyCode();
                keyEvent.m_controlDown = ( acceleratorKey->GetFlags() & wxMOD_CONTROL ) > 0;
                keyEvent.m_shiftDown = ( acceleratorKey->GetFlags() & wxMOD_SHIFT ) > 0;
                keyEvent.m_altDown = ( acceleratorKey->GetFlags() & wxMOD_ALT ) > 0;

                if( auto ctrl = dynamic_cast<wxTextEntry*>( focus ) )
                    TEXTENTRY_TRICKS::OnCharHook( ctrl, keyEvent );
                else
                    focus->HandleWindowEvent( keyEvent );

                if( keyEvent.GetSkipped() )
                {
                    keyEvent.SetEventType( wxEVT_CHAR );
                    focus->HandleWindowEvent( keyEvent );
                }

                // If the event was used as KEY event (not skipped) by the focused window,
                // just finish.
                // Otherwise this is actually a wxEVT_COMMAND_MENU_SELECTED, or the
                // focused window is read only
                if( !keyEvent.GetSkipped() )
                    return;
            }
        }

        // Store the selected position, so it can be checked by the tools
        m_selected = aEvent.GetId();

        ACTION_MENU* parent = dynamic_cast<ACTION_MENU*>( GetParent() );

        while( parent )
        {
            parent->m_selected = m_selected;
            parent = dynamic_cast<ACTION_MENU*>( parent->GetParent() );
        }

        // Check if there is a TOOL_ACTION for the given ID
        if( m_selected >= TOOL_ACTION::GetBaseUIId() )
            evt = findToolAction( m_selected );

        if( !evt )
        {
#ifdef __WINDOWS__
            if( !evt )
            {
                // Try to find the submenu which holds the selected item
                wxMenu* menu = nullptr;
                FindItem( m_selected, &menu );

                // This conditional compilation is probably not needed.
                // It will be removed later, for the Kicad V 6.x version.
                // But in "old" 3.0 version, the "&& menu != this" contition was added to avoid
                // hang.  This hang is no longer encountered in wxWidgets 3.0.4 version, and this
                // condition is no longer needed.  And in 3.1.2, we have to remove it, as
                // "menu != this" never happens ("menu != this" always happens in 3.1.1 and older!).
#if wxCHECK_VERSION( 3, 1, 2 )
                if( menu )
#else
                if( menu && menu != this )
#endif
                {
                    ACTION_MENU* cxmenu = static_cast<ACTION_MENU*>( menu );
                    evt = cxmenu->eventHandler( aEvent );
                }
            }
#else
            if( !evt )
                runEventHandlers( aEvent, evt );
#endif

            // Handling non-ACTION menu entries.  Two ranges of ids are supported:
            //   between 0 and ID_CONTEXT_MENU_ID_MAX
            //   between ID_POPUP_MENU_START and ID_POPUP_MENU_END

            #define ID_CONTEXT_MENU_ID_MAX wxID_LOWEST  /* = 100 should be plenty */

            if( !evt &&
                    ( ( m_selected >= 0 && m_selected < ID_CONTEXT_MENU_ID_MAX ) ||
                      ( m_selected >= ID_POPUP_MENU_START && m_selected <= ID_POPUP_MENU_END ) ) )
            {
                ACTION_MENU* actionMenu = dynamic_cast<ACTION_MENU*>( GetParent() );

                if( actionMenu && actionMenu->PassHelpTextToHandler() )
                    menuText = GetHelpString( aEvent.GetId() );
                else
                    menuText = GetLabelText( aEvent.GetId() );

                evt = TOOL_EVENT( TC_COMMAND, TA_CHOICE_MENU_CHOICE, m_selected, AS_GLOBAL,
                                  &menuText );
            }
        }
    }

    // forward the action/update event to the TOOL_MANAGER
    // clients that don't supply a tool will have to check GetSelected() themselves
    if( evt && m_tool )
    {
        wxLogTrace( kicadTraceToolStack, "ACTION_MENU::OnMenuEvent %s", evt->Format() );

        // WARNING: if you're squeamish, look away.
        // What follows is a series of egregious hacks necessitated by a lack of information from
        // wxWidgets on where context-menu-commands and command-key-events originated.

        // If it's a context menu then fetch the mouse position from our context-menu-position
        // hack.
        if( m_isContextMenu )
        {
            evt->SetMousePosition( g_menu_open_position );
        }
        // Otherwise, if g_last_menu_highlighted_id matches then it's a menubar menu event and has
        // no position.
        else if( g_last_menu_highlighted_id == aEvent.GetId() )
        {
            evt->SetHasPosition( false );
        }
        // Otherwise it's a command-key-event and we need to get the mouse position from the tool
        // manager so that immediate actions work.
        else
        {
            evt->SetMousePosition( getToolManager()->GetMousePosition() );
        }

        if( m_tool->GetManager() )
            m_tool->GetManager()->ProcessEvent( *evt );
    }
    else
    {
        aEvent.Skip();
    }
}

References AS_GLOBAL, eventHandler(), findToolAction(), g_last_menu_highlighted_id, g_menu_open_position, TOOL_ACTION::GetBaseUIId(), TOOL_BASE::GetManager(), TOOL_MANAGER::GetMousePosition(), getToolManager(), ID_CONTEXT_MENU_ID_MAX, ID_POPUP_MENU_END, ID_POPUP_MENU_START, kicadTraceToolStack, m_dirty, m_isContextMenu, m_selected, m_tool, TEXTENTRY_TRICKS::OnCharHook(), PassHelpTextToHandler(), TOOL_MANAGER::ProcessEvent(), TOOL_MANAGER::RunAction(), runEventHandlers(), TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_UPDATE, TC_COMMAND, and ACTIONS::updateMenu.

Referenced by TOOL_DISPATCHER::DispatchWxEvent(), and setupEvents().

operator=()

ACTION_MENU& ACTION_MENU::operator= ( const ACTION_MENU &  aMenu )

delete

PassHelpTextToHandler()

virtual bool ACTION_MENU::PassHelpTextToHandler ( )

inlinevirtual

Reimplemented in BUS_UNFOLD_MENU.

Definition at line 180 of file action_menu.h.

{ return false; }

Referenced by OnMenuEvent().

runEventHandlers()

void ACTION_MENU::runEventHandlers ( const wxMenuEvent &  aMenuEvent, OPT_TOOL_EVENT &  aToolEvent  )

protected

Run a function on the menu and all its submenus.

Definition at line 572 of file action_menu.cpp.

{
    aToolEvent = eventHandler( aMenuEvent );

    if( !aToolEvent )
        runOnSubmenus( std::bind( &ACTION_MENU::runEventHandlers, _1, aMenuEvent, aToolEvent ) );
}

References eventHandler(), and runOnSubmenus().

Referenced by OnMenuEvent().

runOnSubmenus()

void ACTION_MENU::runOnSubmenus ( std::function< void(ACTION_MENU *)>  aFunction )

protected

Check if any of submenus contains a TOOL_ACTION with a specific ID.

Definition at line 581 of file action_menu.cpp.

{
    try
    {
        std::for_each( m_submenus.begin(), m_submenus.end(), [&]( ACTION_MENU* m ) {
            aFunction( m );
            m->runOnSubmenus( aFunction );
        } );
    }
    catch( std::exception& )
    {
    }
}

References m_submenus.

Referenced by ClearDirty(), CONDITIONAL_MENU::Evaluate(), findToolAction(), CONDITIONAL_MENU::Resolve(), runEventHandlers(), SetDirty(), SetTool(), and UpdateAll().

SetDirty()

void ACTION_MENU::SetDirty

(

)

Definition at line 296 of file action_menu.cpp.

{
    m_dirty = true;
    runOnSubmenus( std::bind( &ACTION_MENU::SetDirty, _1 ) );
}

References m_dirty, and runOnSubmenus().

Referenced by TOOL_MENU::ShowContextMenu().

SetIcon()

void ACTION_MENU::SetIcon

(

BITMAPS

aIcon

)

Assign an icon for the entry.

Parameters

aIcon

is the icon to be assigned. NULL is used to remove icon.

Definition at line 73 of file action_menu.cpp.

{
    m_icon = aIcon;
}

References m_icon.

Referenced by AddMenuLanguageList(), BUS_UNFOLD_MENU::BUS_UNFOLD_MENU(), EDA_3D_VIEWER_FRAME::CreateMenuBar(), DIFF_PAIR_MENU::DIFF_PAIR_MENU(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), GRID_MENU::GRID_MENU(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), CONVERT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), NET_CONTEXT_MENU::NET_CONTEXT_MENU(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), SPECIAL_TOOLS_CONTEXT_MENU::SPECIAL_TOOLS_CONTEXT_MENU(), SYMBOL_UNIT_MENU::SYMBOL_UNIT_MENU(), TRACK_WIDTH_MENU::TRACK_WIDTH_MENU(), VIA_SIZE_MENU::VIA_SIZE_MENU(), and ZOOM_MENU::ZOOM_MENU().

SetTitle()

void ACTION_MENU::SetTitle ( const wxString &  aTitle )

override

Set title for the menu.

The title is shown as a text label shown on the top of the menu.

Parameters

aTitle

is the new title.

Definition at line 87 of file action_menu.cpp.

{
    // Unfortunately wxMenu::SetTitle() does not work very well, so this is an alternative version
    m_title = aTitle;

    // Update the menu title
    if( m_titleDisplayed )
        DisplayTitle( true );
}

References DisplayTitle(), m_title, and m_titleDisplayed.

Referenced by AddMenuLanguageList(), BUS_UNFOLD_MENU::BUS_UNFOLD_MENU(), EDA_3D_VIEWER_FRAME::CreateMenuBar(), DIFF_PAIR_MENU::DIFF_PAIR_MENU(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), GRID_MENU::GRID_MENU(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), ROUTER_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), CONVERT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), NET_CONTEXT_MENU::NET_CONTEXT_MENU(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), SPECIAL_TOOLS_CONTEXT_MENU::SPECIAL_TOOLS_CONTEXT_MENU(), SYMBOL_UNIT_MENU::SYMBOL_UNIT_MENU(), TRACK_WIDTH_MENU::TRACK_WIDTH_MENU(), VIA_SIZE_MENU::VIA_SIZE_MENU(), and ZOOM_MENU::ZOOM_MENU().

SetTool()

void ACTION_MENU::SetTool

(

TOOL_INTERACTIVE *

aTool

)

Set a tool that is the creator of the menu.

Parameters

aTool

is the tool that created the menu.

Definition at line 303 of file action_menu.cpp.

{
    m_tool = aTool;
    runOnSubmenus( std::bind( &ACTION_MENU::SetTool, _1, aTool ) );
}

References m_tool, and runOnSubmenus().

Referenced by TOOL_INTERACTIVE::SetContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

setupEvents()

void ACTION_MENU::setupEvents ( )

protected

Update hot key settings for TOOL_ACTIONs in this menu.

Definition at line 79 of file action_menu.cpp.

{
    Connect( wxEVT_COMMAND_MENU_SELECTED, wxMenuEventHandler( ACTION_MENU::OnMenuEvent ), nullptr,
             this );
    Connect( wxEVT_IDLE, wxIdleEventHandler( ACTION_MENU::OnIdle ), nullptr, this );
}

References OnIdle(), and OnMenuEvent().

Referenced by ACTION_MENU().

update()

virtual void ACTION_MENU::update ( )

inlineprotectedvirtual

Update menu state stub.

It is called before a menu is shown, in order to update its state. Here you can tick current settings, enable/disable entries, etc.

Reimplemented in DIFF_PAIR_MENU, TRACK_WIDTH_MENU, BUS_UNFOLD_MENU, SYMBOL_UNIT_MENU, VIA_SIZE_MENU, GROUP_CONTEXT_MENU, HIGHLIGHT_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 198 of file action_menu.h.

    {
    }

Referenced by UpdateAll().

UpdateAll()

void ACTION_MENU::UpdateAll

(

)

Run update handlers for the menu and its submenus.

Definition at line 272 of file action_menu.cpp.

{
    try
    {
        update();
    }
    catch( std::exception& )
    {
    }

    if( m_tool )
        updateHotKeys();

    runOnSubmenus( std::bind( &ACTION_MENU::UpdateAll, _1 ) );
}

References m_tool, runOnSubmenus(), update(), and updateHotKeys().

Referenced by ACTION_TOOLBAR::onToolRightClick(), CONDITIONAL_MENU::Resolve(), TOOL_MENU::ShowContextMenu(), KICAD_MANAGER_CONTROL::UpdateMenu(), PL_SELECTION_TOOL::UpdateMenu(), EDA_3D_CONTROLLER::UpdateMenu(), GERBVIEW_SELECTION_TOOL::UpdateMenu(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::UpdateMenu(), EE_SELECTION_TOOL::UpdateMenu(), CVPCB_CONTROL::UpdateMenu(), and PCB_SELECTION_TOOL::UpdateMenu().

updateHotKeys()

void ACTION_MENU::updateHotKeys ( )

protected

Traverse the submenus tree looking for a submenu capable of handling a particular menu event.

In case it is handled, it is returned the aToolEvent parameter.

Definition at line 338 of file action_menu.cpp.

{
    TOOL_MANAGER* toolMgr = getToolManager();

    for( auto& ii : m_toolActions )
    {
        int                id = ii.first;
        const TOOL_ACTION& action = *ii.second;
        int                key = toolMgr->GetHotKey( action ) & ~MD_MODIFIER_MASK;

        if( key )
        {
            int mod = toolMgr->GetHotKey( action ) & MD_MODIFIER_MASK;
            int flags = 0;
            wxMenuItem* item = FindChildItem( id );

            if( item )
            {
                flags |= ( mod & MD_ALT ) ? wxACCEL_ALT : 0;
                flags |= ( mod & MD_CTRL ) ? wxACCEL_CTRL : 0;
                flags |= ( mod & MD_SHIFT ) ? wxACCEL_SHIFT : 0;

                if( !flags )
                    flags = wxACCEL_NORMAL;

                wxAcceleratorEntry accel( flags, key, id, item );
                item->SetAccel( &accel );
            }
        }
    }
}

References TOOL_MANAGER::GetHotKey(), getToolManager(), m_toolActions, MD_ALT, MD_CTRL, MD_MODIFIER_MASK, and MD_SHIFT.

Referenced by UpdateAll().

Friends And Related Function Documentation

TOOL_INTERACTIVE

friend class TOOL_INTERACTIVE

friend

Definition at line 268 of file action_menu.h.

Member Data Documentation

CHECK

constexpr bool ACTION_MENU::CHECK = true

static

Definition at line 183 of file action_menu.h.

Referenced by EDA_3D_VIEWER_FRAME::CreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateVToolbar().

m_dirty

bool ACTION_MENU::m_dirty

protected

Definition at line 245 of file action_menu.h.

Referenced by ClearDirty(), OnMenuEvent(), and SetDirty().

m_forcedPosition

wxPoint ACTION_MENU::m_forcedPosition

protected

Definition at line 243 of file action_menu.h.

m_icon

BITMAPS ACTION_MENU::m_icon

protected

Stores the id number of selected item.

Definition at line 254 of file action_menu.h.

Referenced by Add(), copyFrom(), DisplayTitle(), and SetIcon().

m_isContextMenu

bool ACTION_MENU::m_isContextMenu

protected

Menu title.

Definition at line 248 of file action_menu.h.

Referenced by OnMenuEvent().

m_isForcedPosition

bool ACTION_MENU::m_isForcedPosition

protected

Definition at line 242 of file action_menu.h.

m_selected

int ACTION_MENU::m_selected

protected

Creator of the menu.

Definition at line 257 of file action_menu.h.

Referenced by copyFrom(), GetSelected(), and OnMenuEvent().

m_submenus

std::list<ACTION_MENU*> ACTION_MENU::m_submenus

protected

Definition at line 266 of file action_menu.h.

Referenced by Add(), appendCopy(), Clear(), runOnSubmenus(), and ~ACTION_MENU().

m_title

wxString ACTION_MENU::m_title

protected

Optional icon.

Definition at line 251 of file action_menu.h.

Referenced by Add(), copyFrom(), DisplayTitle(), and SetTitle().

m_titleDisplayed

bool ACTION_MENU::m_titleDisplayed

protected

Definition at line 247 of file action_menu.h.

Referenced by Clear(), copyFrom(), DisplayTitle(), and SetTitle().

m_tool

TOOL_INTERACTIVE* ACTION_MENU::m_tool

protected

Associates tool actions with menu item IDs. Non-owning.

Definition at line 260 of file action_menu.h.

Referenced by copyFrom(), CONDITIONAL_MENU::create(), getToolManager(), OnMenuEvent(), SetTool(), BUS_UNFOLD_MENU::update(), and UpdateAll().

m_toolActions

std::map<int, const TOOL_ACTION*> ACTION_MENU::m_toolActions

protected

List of submenus.

Definition at line 263 of file action_menu.h.

Referenced by Add(), Clear(), copyFrom(), and updateHotKeys().

NORMAL

constexpr bool ACTION_MENU::NORMAL = false

static

Definition at line 182 of file action_menu.h.

Referenced by SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

---

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

• action_menu.h
• action_menu.cpp