ACTION_MENU Class Reference

ACTION_MENU. More...

#include <action_menu.h>

Inheritance diagram for ACTION_MENU:

Public Member Functions
	ACTION_MENU (bool isContextMenu)
	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
	Function SetTitle() Sets title for the menu. More...
void	DisplayTitle (bool aDisplay=true)
	Function DisplayTitle() Decides whether a title for a pop up menu should be displayed. More...
void	SetIcon (const BITMAP_OPAQUE *aIcon)
	Function SetIcon() Assigns an icon for the entry. More...
wxMenuItem *	Add (const wxString &aLabel, int aId, const BITMAP_OPAQUE *aIcon)
	Function Add() Adds a wxWidgets-style entry to the menu. More...
wxMenuItem *	Add (const wxString &aLabel, const wxString &aToolTip, int aId, const BITMAP_OPAQUE *aIcon)
wxMenuItem *	Add (const TOOL_ACTION &aAction, bool aIsCheckmarkEntry=false)
	Function Add() Adds an entry to the menu, basing on the TOOL_ACTION object. More...
wxMenuItem *	Add (ACTION_MENU *aMenu)
	Function Add() Adds an action menu as a submenu. More...
void	Clear ()
	Function Clear() Removes all the entries from the menu (as well as its title). More...
bool	HasEnabledItems () const
	Function HasEnabledItems();. More...
int	GetSelected () const
	Function GetSelected() Returns the position of selected item. More...
void	UpdateAll ()
	Function UpdateAll() Runs update handlers for the menu and its submenus. More...
void	ClearDirty ()
	Function ClearDirty() Clears the dirty flag on the menu and all descendants. More...
void	SetDirty ()
void	SetTool (TOOL_INTERACTIVE *aTool)
	Function SetTool() Sets a tool that is the creator of the menu. More...
ACTION_MENU *	Clone () const
	Creates a deep, recursive copy of this ACTION_MENU. More...
void	OnMenuEvent (wxMenuEvent &aEvent)
void	OnIdle (wxIdleEvent &event)

Protected Member Functions
virtual ACTION_MENU *	create () const
	Returns an instance of this class. It has to be overridden in inheriting classes. More...
TOOL_MANAGER *	getToolManager () const
	Returns an instance of TOOL_MANAGER class. More...
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)
	Copies another menus data to this instance. More...
wxMenuItem *	appendCopy (const wxMenuItem *aSource)
	Function appendCopy Appends a copy of wxMenuItem. More...
void	setupEvents ()
	Initializes handlers for events. More...
void	updateHotKeys ()
	Updates hot key settings for TOOL_ACTIONs in this menu. More...
void	runEventHandlers (const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
	Traverses the submenus tree looking for a submenu capable of handling a particular menu event. More...
void	runOnSubmenus (std::function< void(ACTION_MENU *)> aFunction)
	Runs a function on the menu and all its submenus. More...
OPT_TOOL_EVENT	findToolAction (int aId)
	Checks if any of submenus contains a TOOL_ACTION with a specific ID. More...

Static Protected Member Functions
static int	getMenuId (const TOOL_ACTION &aAction)
	Returns the corresponding wxMenuItem identifier for a TOOL_ACTION object. More...

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

Static Protected Attributes
static const int	ACTION_ID = 20000
	Menu items with ID higher than that are considered TOOL_ACTIONs More...

Friends
class	TOOL_INTERACTIVE

Detailed Description

ACTION_MENU.

Defines the structure of a menu based on ACTIONs.

Definition at line 43 of file action_menu.h.

Constructor & Destructor Documentation

ACTION_MENU() [1/2]

ACTION_MENU::ACTION_MENU

(

bool

isContextMenu

)

Default constructor

Definition at line 43 of file action_menu.cpp.

                                             :
    m_dirty( true ),
    m_titleDisplayed( false ),
    m_isContextMenu( isContextMenu ),
    m_icon( nullptr ),
    m_selected( -1 ),
    m_tool( nullptr )
{
    setupEvents();
}

References setupEvents().

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

~ACTION_MENU()

ACTION_MENU::~ACTION_MENU ( )

override

Definition at line 55 of file action_menu.cpp.

{
    // Set parent to NULL to prevent submenus from unregistering from a notexisting 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,
		const BITMAP_OPAQUE *	aIcon
	)

Function Add() Adds a wxWidgets-style entry to the menu.

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

Definition at line 134 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 GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), CONDITIONAL_MENU::Evaluate(), ALIGN_DISTRIBUTE_TOOL::Init(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), ROUTER_TOOL_MENU::ROUTER_TOOL_MENU(), CVPCB_MAINFRAME::setupTools(), and TUNER_TOOL_MENU::TUNER_TOOL_MENU().

Add() [2/4]

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

Definition at line 147 of file action_menu.cpp.

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

    wxMenuItem* item = new wxMenuItem( this, aId, aLabel, aTooltip, 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
	)

Function Add() Adds an entry to the menu, basing 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.

ID numbers for tool actions need to have a value higher than ACTION_ID

Definition at line 161 of file action_menu.cpp.

{
    const BITMAP_OPAQUE* icon = aAction.GetIcon();

    wxMenuItem* item = new wxMenuItem( this, getMenuId( aAction ), aAction.GetMenuItem(),
                                       aAction.GetDescription(),
                                       aIsCheckmarkEntry ? wxITEM_CHECK : wxITEM_NORMAL );

    if( icon )
        AddBitmapToMenuItem( item, KiBitmap( icon ) );

    m_toolActions[getMenuId( aAction )] = &aAction;

    return Append( item );
}

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

Add() [4/4]

wxMenuItem * ACTION_MENU::Add

(

ACTION_MENU *

aMenu

)

Function Add() Adds 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 179 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.

appendCopy()

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

protected

Function appendCopy Appends a copy of wxMenuItem.

Definition at line 538 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 null bitmap adds also
    // our predefined checked alternate bitmap
    const wxBitmap& src_bitmap = aSource->GetBitmap();

    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

(

)

Function Clear() Removes all the entries from the menu (as well as its title).

It leaves the menu in the initial state.

Definition at line 200 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(), SYMBOL_UNIT_MENU::update(), BUS_UNFOLD_MENU::update(), TRACK_WIDTH_MENU::update(), and DIFF_PAIR_MENU::update().

ClearDirty()

void ACTION_MENU::ClearDirty

(

)

Function ClearDirty() Clears the dirty flag on the menu and all descendants.

Definition at line 251 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

Creates a deep, recursive copy of this ACTION_MENU.

Definition at line 272 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

Copies another menus data to this instance.

Old entries are preserved, and ones form aMenu are copied.

Definition at line 520 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

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

Reimplemented in ROUTER_TOOL_MENU, DIFF_PAIR_MENU, TRACK_WIDTH_MENU, LOCK_CONTEXT_MENU, TUNER_TOOL_MENU, BUS_UNFOLD_MENU, HIGHLIGHT_MENU, SELECT_MENU, ZONE_CONTEXT_MENU, SYMBOL_UNIT_MENU, CONDITIONAL_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 281 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

)

Function DisplayTitle() Decides whether a title for a pop up menu should be displayed.

Definition at line 97 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(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), SetTitle(), and TUNER_TOOL_MENU::TUNER_TOOL_MENU().

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, GRID_MENU, and ZOOM_MENU.

Definition at line 178 of file action_menu.h.

    {
        return OPT_TOOL_EVENT();
    }

Referenced by OnMenuEvent(), and runEventHandlers().

findToolAction()

OPT_TOOL_EVENT ACTION_MENU::findToolAction ( int  aId )

protected

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

Definition at line 497 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().

getMenuId()

static int ACTION_MENU::getMenuId ( const TOOL_ACTION &  aAction )

inlinestaticprotected

Returns the corresponding wxMenuItem identifier for a TOOL_ACTION object.

Definition at line 161 of file action_menu.h.

    {
        return aAction.GetId() + ACTION_ID;
    }

References ACTION_ID, and TOOL_ACTION::GetId().

Referenced by Add().

GetSelected()

int ACTION_MENU::GetSelected ( ) const

inline

Function GetSelected() Returns 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 120 of file action_menu.h.

    {
        return m_selected;
    }

References m_selected.

getToolManager()

TOOL_MANAGER * ACTION_MENU::getToolManager ( ) const

protected

Returns an instance of TOOL_MANAGER class.

Definition at line 292 of file action_menu.cpp.

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

References TOOL_BASE::GetManager(), and m_tool.

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

HasEnabledItems()

bool ACTION_MENU::HasEnabledItems

(

)

const

Function HasEnabledItems();.

Returns true if the menu has any enabled items

Definition at line 214 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 347 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 355 of file action_menu.cpp.

{
    OPT_TOOL_EVENT evt;
    wxString       menuText;
    wxEventType    type = aEvent.GetEventType();

    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 )
    {
        // 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 >= ACTION_ID )
            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 (e.g. items in clarification list)
            // in some context menus, that have IDs explicitly chosen between
            // ID_POPUP_MENU_START and ID_POPUP_MENU_END
            // Note also items in clarification list have an id >= 0 and < wxID_LOWEST
            // in fact 0 to n-1 for n items in clarification list)
            // id < 0 are automatically created for menuitems created with wxID_ANY
            #define ID_CONTEXT_MENU_ID_MAX wxID_LOWEST  /* = 100 should be enough and better */

            if( !evt &&
                    ( ( m_selected >= 0 && m_selected < ID_CONTEXT_MENU_ID_MAX ) ||
                      ( m_selected >= ID_POPUP_MENU_START && m_selected <= ID_POPUP_MENU_END ) ) )
            {
                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() );

        // Pass the position the menu was opened from into the generated event if it is a select event
        if( type == wxEVT_COMMAND_MENU_SELECTED )
            evt->SetMousePosition( g_menu_open_position );
        else
            evt->SetMousePosition( getToolManager()->GetMousePosition() );

        if( g_last_menu_highlighted_id == aEvent.GetId() && !m_isContextMenu )
            evt->SetHasPosition( false );

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

References ACTION_ID, AS_GLOBAL, eventHandler(), findToolAction(), g_last_menu_highlighted_id, g_menu_open_position, 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, TOOL_MANAGER::ProcessEvent(), TOOL_MANAGER::RunAction(), runEventHandlers(), TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_UPDATE, TC_COMMAND, and ACTIONS::updateMenu.

Referenced by EDA_BASE_FRAME::OnMenuOpen(), and setupEvents().

operator=()

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

delete

runEventHandlers()

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

protected

Traverses 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 472 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

Runs a function on the menu and all its submenus.

Definition at line 481 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& e )
    {
        wxLogDebug( wxString::Format( "ACTION_MENU runOnSubmenus exception: %s", e.what() ) );
    }
}

References Format(), and 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 258 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

(

const BITMAP_OPAQUE *

aIcon

)

Function SetIcon() Assigns an icon for the entry.

Parameters

aIcon

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

Definition at line 68 of file action_menu.cpp.

{
    m_icon = aIcon;
}

References m_icon.

Referenced by AddMenuLanguageList(), BUS_UNFOLD_MENU::BUS_UNFOLD_MENU(), EDA_3D_VIEWER::CreateMenuBar(), DIFF_PAIR_MENU::DIFF_PAIR_MENU(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), GRID_MENU::GRID_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), SYMBOL_UNIT_MENU::SYMBOL_UNIT_MENU(), TRACK_WIDTH_MENU::TRACK_WIDTH_MENU(), TUNER_TOOL_MENU::TUNER_TOOL_MENU(), and ZOOM_MENU::ZOOM_MENU().

SetTitle()

void ACTION_MENU::SetTitle ( const wxString &  aTitle )

override

Function SetTitle() Sets 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 86 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::CreateMenuBar(), DIFF_PAIR_MENU::DIFF_PAIR_MENU(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), GRID_MENU::GRID_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), ROUTER_TOOL_MENU::ROUTER_TOOL_MENU(), SYMBOL_UNIT_MENU::SYMBOL_UNIT_MENU(), TRACK_WIDTH_MENU::TRACK_WIDTH_MENU(), TUNER_TOOL_MENU::TUNER_TOOL_MENU(), and ZOOM_MENU::ZOOM_MENU().

SetTool()

void ACTION_MENU::SetTool

(

TOOL_INTERACTIVE *

aTool

)

Function SetTool() Sets a tool that is the creator of the menu.

Parameters

aTool

is the tool that created the menu.

Definition at line 265 of file action_menu.cpp.

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

References m_tool, and runOnSubmenus().

Referenced by ALIGN_DISTRIBUTE_TOOL::Init(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), TOOL_INTERACTIVE::SetContextMenu(), CVPCB_MAINFRAME::setupTools(), SCH_LINE_WIRE_BUS_TOOL::UnfoldBus(), and BUS_UNFOLD_MENU::update().

setupEvents()

void ACTION_MENU::setupEvents ( )

protected

Initializes handlers for events.

Definition at line 74 of file action_menu.cpp.

{
// See wxWidgets hack in EDA_BASE_FRAME::OnMenuOpen().
//    Connect( wxEVT_MENU_OPEN, wxMenuEventHandler( ACTION_MENU::OnMenuEvent ), NULL, this );
//    Connect( wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler( ACTION_MENU::OnMenuEvent ), NULL, this );
//    Connect( wxEVT_MENU_CLOSE, wxMenuEventHandler( ACTION_MENU::OnMenuEvent ), NULL, this );

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

References NULL, 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, ZONE_CONTEXT_MENU, SELECT_MENU, SYMBOL_UNIT_MENU, HIGHLIGHT_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 170 of file action_menu.h.

    {
    }

Referenced by UpdateAll().

UpdateAll()

void ACTION_MENU::UpdateAll

(

)

Function UpdateAll() Runs update handlers for the menu and its submenus.

Definition at line 233 of file action_menu.cpp.

{
    try
    {
        update();
    }
    catch( std::exception& e )
    {
        wxLogDebug( wxString::Format( "ACTION_MENU update handler exception: %s", e.what() ) );
    }

    if( m_tool )
        updateHotKeys();

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

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

Referenced by CONDITIONAL_MENU::Resolve(), TOOL_MENU::ShowContextMenu(), EDA_3D_VIEWER_CONTROL::UpdateMenu(), KICAD_MANAGER_CONTROL::UpdateMenu(), GERBVIEW_SELECTION_TOOL::UpdateMenu(), EE_SELECTION_TOOL::UpdateMenu(), CVPCB_CONTROL::UpdateMenu(), and SELECTION_TOOL::UpdateMenu().

updateHotKeys()

void ACTION_MENU::updateHotKeys ( )

protected

Updates hot key settings for TOOL_ACTIONs in this menu.

Definition at line 299 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 238 of file action_menu.h.

Member Data Documentation

ACTION_ID

const int ACTION_MENU::ACTION_ID = 20000

staticprotected

Menu items with ID higher than that are considered TOOL_ACTIONs

Definition at line 230 of file action_menu.h.

Referenced by getMenuId(), and OnMenuEvent().

m_dirty

bool ACTION_MENU::m_dirty

protected

Definition at line 212 of file action_menu.h.

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

m_icon

const BITMAP_OPAQUE* ACTION_MENU::m_icon

protected

Optional icon

Definition at line 221 of file action_menu.h.

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

m_isContextMenu

bool ACTION_MENU::m_isContextMenu

protected

Definition at line 215 of file action_menu.h.

Referenced by CONDITIONAL_MENU::create(), CONDITIONAL_MENU::Evaluate(), and OnMenuEvent().

m_selected

int ACTION_MENU::m_selected

protected

Stores the id number of selected item.

Definition at line 224 of file action_menu.h.

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

m_submenus

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

protected

List of submenus.

Definition at line 236 of file action_menu.h.

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

m_title

wxString ACTION_MENU::m_title

protected

Menu title

Definition at line 218 of file action_menu.h.

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

m_titleDisplayed

bool ACTION_MENU::m_titleDisplayed

protected

Definition at line 214 of file action_menu.h.

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

m_tool

TOOL_INTERACTIVE* ACTION_MENU::m_tool

protected

Creator of the menu

Definition at line 227 of file action_menu.h.

Referenced by CONDITIONAL_MENU::CONDITIONAL_MENU(), 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

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

Definition at line 233 of file action_menu.h.

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

---

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

• action_menu.h
• action_menu.cpp