ZOOM_MENU Class Reference

#include <zoom_menu.h>

Inheritance diagram for ZOOM_MENU:

Public Member Functions
	ZOOM_MENU (EDA_DRAW_FRAME *aParent)
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
TOOL_MANAGER *	getToolManager () const
	Returns an instance of TOOL_MANAGER class. 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...

Private Member Functions
ACTION_MENU *	create () const override
	Returns an instance of this class. It has to be overridden in inheriting classes. More...
OPT_TOOL_EVENT	eventHandler (const wxMenuEvent &aEvent) override
	Event handler stub. More...
void	update () override
	Update menu state stub. More...

Private Attributes
EDA_DRAW_FRAME *	m_parent

Detailed Description

Definition at line 32 of file zoom_menu.h.

Constructor & Destructor Documentation

ZOOM_MENU()

ZOOM_MENU::ZOOM_MENU

(

EDA_DRAW_FRAME *

aParent

)

Definition at line 35 of file zoom_menu.cpp.

                                              :
        ACTION_MENU( true ),
        m_parent( aParent )
{
    BASE_SCREEN* screen = aParent->GetScreen();

    SetTitle( _( "Zoom" ) );
    SetIcon( zoom_selection_xpm );

    //int zoom = screen->GetZoom();
    int maxZoomIds = std::min( ID_POPUP_ZOOM_LEVEL_END - ID_POPUP_ZOOM_LEVEL_START,
                               (int) screen->m_ZoomList.size() );

    for( int i = 0; i < maxZoomIds; ++i )
    {
        Append( ID_POPUP_ZOOM_LEVEL_START+1 + i,   // ID_POPUP_ZOOM_LEVEL_START == Auto
            wxString::Format( _( "Zoom: %.2f" ), aParent->GetZoomLevelCoeff() / screen->m_ZoomList[i] ),
            wxEmptyString, wxITEM_CHECK );
    }
}

References _, Format(), EDA_DRAW_FRAME::GetScreen(), EDA_DRAW_FRAME::GetZoomLevelCoeff(), i, ID_POPUP_ZOOM_LEVEL_END, ID_POPUP_ZOOM_LEVEL_START, BASE_SCREEN::m_ZoomList, min, ACTION_MENU::SetIcon(), and ACTION_MENU::SetTitle().

Referenced by create().

Member Function Documentation

Add() [1/4]

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

inherited

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(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), CONDITIONAL_MENU::Evaluate(), ALIGN_DISTRIBUTE_TOOL::Init(), PAD_CONTEXT_MENU::PAD_CONTEXT_MENU(), 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  )

inherited

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  )

inherited

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;

    wxMenuItem* i = Append( item );
    return i;
}

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

Add() [4/4]

wxMenuItem * ACTION_MENU::Add ( ACTION_MENU *  aMenu )

inherited

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 180 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(), ACTION_MENU::Clone(), KiBitmap(), ACTION_MENU::m_icon, ACTION_MENU::m_submenus, and ACTION_MENU::m_title.

appendCopy()

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

protectedinherited

Function appendCopy Appends a copy of wxMenuItem.

Definition at line 534 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(), ACTION_MENU::Clone(), and ACTION_MENU::m_submenus.

Referenced by ACTION_MENU::copyFrom().

Clear()

void ACTION_MENU::Clear ( )

inherited

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 201 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 i, ACTION_MENU::m_submenus, ACTION_MENU::m_titleDisplayed, and ACTION_MENU::m_toolActions.

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

ClearDirty()

void ACTION_MENU::ClearDirty ( )

inherited

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

Definition at line 252 of file action_menu.cpp.

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

References ACTION_MENU::m_dirty, and ACTION_MENU::runOnSubmenus().

Referenced by TOOL_MENU::ShowContextMenu().

Clone()

ACTION_MENU * ACTION_MENU::Clone ( ) const

inherited

Creates a deep, recursive copy of this ACTION_MENU.

Definition at line 273 of file action_menu.cpp.

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

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

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

copyFrom()

void ACTION_MENU::copyFrom ( const ACTION_MENU &  aMenu )

protectedinherited

Copies another menus data to this instance.

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

Definition at line 516 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 ACTION_MENU::appendCopy(), i, ACTION_MENU::m_icon, ACTION_MENU::m_selected, ACTION_MENU::m_title, ACTION_MENU::m_titleDisplayed, ACTION_MENU::m_tool, and ACTION_MENU::m_toolActions.

Referenced by ACTION_MENU::Clone().

create()

ACTION_MENU* ZOOM_MENU::create ( ) const

inlineoverrideprivatevirtual

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

Reimplemented from ACTION_MENU.

Definition at line 38 of file zoom_menu.h.

    {
        return new ZOOM_MENU( m_parent );
    }

References m_parent, and ZOOM_MENU().

DisplayTitle()

void ACTION_MENU::DisplayTitle ( bool  aDisplay = true )

inherited

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(), ACTION_MENU::m_icon, ACTION_MENU::m_title, and ACTION_MENU::m_titleDisplayed.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), ACTION_MENU::SetTitle(), and TUNER_TOOL_MENU::TUNER_TOOL_MENU().

eventHandler()

OPT_TOOL_EVENT ZOOM_MENU::eventHandler ( const wxMenuEvent &  )

overrideprivatevirtual

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 from ACTION_MENU.

Definition at line 57 of file zoom_menu.cpp.

{
    OPT_TOOL_EVENT event( ACTIONS::zoomPreset.MakeEvent() );
    intptr_t idx = aEvent.GetId() - ID_POPUP_ZOOM_LEVEL_START;
    event->SetParameter( idx );

    return event;
}

References ID_POPUP_ZOOM_LEVEL_START, and ACTIONS::zoomPreset.

findToolAction()

OPT_TOOL_EVENT ACTION_MENU::findToolAction ( int  aId )

protectedinherited

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

Definition at line 493 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 ACTION_MENU::runOnSubmenus().

Referenced by ACTION_MENU::OnMenuEvent().

getMenuId()

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

inlinestaticprotectedinherited

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_MENU::ACTION_ID, and TOOL_ACTION::GetId().

Referenced by ACTION_MENU::Add(), and PAD_CONTEXT_MENU::update().

GetSelected()

int ACTION_MENU::GetSelected ( ) const

inlineinherited

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 ACTION_MENU::m_selected.

Referenced by EE_INSPECTION_TOOL::ShowDatasheet().

getToolManager()

TOOL_MANAGER * ACTION_MENU::getToolManager ( ) const

protectedinherited

Returns an instance of TOOL_MANAGER class.

Definition at line 293 of file action_menu.cpp.

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

References TOOL_BASE::GetManager(), and ACTION_MENU::m_tool.

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

HasEnabledItems()

bool ACTION_MENU::HasEnabledItems ( ) const

inherited

Function HasEnabledItems();.

Returns true if the menu has any enabled items

Definition at line 215 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 )

inherited

Definition at line 344 of file action_menu.cpp.

{
    g_last_menu_highlighted_id = 0;
}

References g_last_menu_highlighted_id.

Referenced by ACTION_MENU::setupEvents().

OnMenuEvent()

void ACTION_MENU::OnMenuEvent ( wxMenuEvent &  aEvent )

inherited

Definition at line 350 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 );

        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() );

        TOOL_MANAGER* toolMgr = m_tool->GetManager();

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

        if( toolMgr->GetEditFrame() && !toolMgr->GetEditFrame()->GetDoImmediateActions() )
        {
            // An tool-selection-event has no position
            if( evt->GetCommandStr().is_initialized()
                    && evt->GetCommandStr().get() != toolMgr->GetEditFrame()->CurrentToolName() )
            {
                evt->SetHasPosition( false );
            }
        }

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

References ACTION_MENU::ACTION_ID, AS_GLOBAL, ACTION_MENU::eventHandler(), ACTION_MENU::findToolAction(), g_last_menu_highlighted_id, TOOL_BASE::GetManager(), ACTION_MENU::getToolManager(), ID_CONTEXT_MENU_ID_MAX, ID_POPUP_MENU_END, ID_POPUP_MENU_START, kicadTraceToolStack, ACTION_MENU::m_dirty, ACTION_MENU::m_isContextMenu, ACTION_MENU::m_selected, ACTION_MENU::m_tool, TOOL_MANAGER::ProcessEvent(), TOOL_MANAGER::RunAction(), ACTION_MENU::runEventHandlers(), TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_UPDATE, TC_COMMAND, and ACTIONS::updateMenu.

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

runEventHandlers()

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

protectedinherited

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 468 of file action_menu.cpp.

{
    aToolEvent = eventHandler( aMenuEvent );

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

References ACTION_MENU::eventHandler(), and ACTION_MENU::runOnSubmenus().

Referenced by ACTION_MENU::OnMenuEvent().

runOnSubmenus()

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

protectedinherited

Runs a function on the menu and all its submenus.

Definition at line 477 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 ACTION_MENU::m_submenus.

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

SetDirty()

void ACTION_MENU::SetDirty ( )

inherited

Definition at line 259 of file action_menu.cpp.

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

References ACTION_MENU::m_dirty, and ACTION_MENU::runOnSubmenus().

Referenced by TOOL_MENU::ShowContextMenu().

SetIcon()

void ACTION_MENU::SetIcon ( const BITMAP_OPAQUE *  aIcon )

inherited

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 ACTION_MENU::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(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), GRID_MENU::GRID_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), PAD_CONTEXT_MENU::PAD_CONTEXT_MENU(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_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().

SetTitle()

void ACTION_MENU::SetTitle ( const wxString &  aTitle )

overrideinherited

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 ACTION_MENU::DisplayTitle(), ACTION_MENU::m_title, and ACTION_MENU::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(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), GRID_MENU::GRID_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), PAD_CONTEXT_MENU::PAD_CONTEXT_MENU(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_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().

SetTool()

void ACTION_MENU::SetTool ( TOOL_INTERACTIVE *  aTool )

inherited

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

Parameters

aTool

is the tool that created the menu.

Definition at line 266 of file action_menu.cpp.

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

References ACTION_MENU::m_tool, and ACTION_MENU::runOnSubmenus().

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

setupEvents()

void ACTION_MENU::setupEvents ( )

protectedinherited

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 ACTION_MENU::OnIdle(), and ACTION_MENU::OnMenuEvent().

Referenced by ACTION_MENU::ACTION_MENU().

update()

void ZOOM_MENU::update ( )

overrideprivatevirtual

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 from ACTION_MENU.

Definition at line 67 of file zoom_menu.cpp.

{
    BASE_SCREEN* screen = m_parent->GetScreen();
    double zoom = screen->GetZoom();
    const std::vector<double>& zoomList = m_parent->GetScreen()->m_ZoomList;

    // Check the current zoom
    int maxZoomIds = std::min( ID_POPUP_ZOOM_LEVEL_END - ID_POPUP_ZOOM_LEVEL_START,
                               (int) screen->m_ZoomList.size() );

    for( int i = 0; i < maxZoomIds; ++i )
    {
        // Search for a value near the current zoom setting:
        double rel_error = std::fabs( zoomList[i] - zoom )/zoom;
        Check( ID_POPUP_ZOOM_LEVEL_START+1 + i, rel_error < 0.1 );
    }
}

References EDA_DRAW_FRAME::GetScreen(), BASE_SCREEN::GetZoom(), i, ID_POPUP_ZOOM_LEVEL_END, ID_POPUP_ZOOM_LEVEL_START, m_parent, BASE_SCREEN::m_ZoomList, and min.

UpdateAll()

void ACTION_MENU::UpdateAll ( )

inherited

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

Definition at line 234 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(), ACTION_MENU::m_tool, ACTION_MENU::runOnSubmenus(), ACTION_MENU::update(), and ACTION_MENU::updateHotKeys().

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

updateHotKeys()

void ACTION_MENU::updateHotKeys ( )

protectedinherited

Updates hot key settings for TOOL_ACTIONs in this menu.

Definition at line 300 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(), ACTION_MENU::getToolManager(), ACTION_MENU::m_toolActions, MD_ALT, MD_CTRL, MD_MODIFIER_MASK, MD_SHIFT, and mod.

Referenced by ACTION_MENU::UpdateAll().

Member Data Documentation

ACTION_ID

const int ACTION_MENU::ACTION_ID = 20000

staticprotectedinherited

Menu items with ID higher than that are considered TOOL_ACTIONs

Definition at line 230 of file action_menu.h.

Referenced by ACTION_MENU::getMenuId(), and ACTION_MENU::OnMenuEvent().

m_dirty

bool ACTION_MENU::m_dirty

protectedinherited

Definition at line 212 of file action_menu.h.

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

m_icon

const BITMAP_OPAQUE* ACTION_MENU::m_icon

protectedinherited

Optional icon

Definition at line 221 of file action_menu.h.

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

m_isContextMenu

bool ACTION_MENU::m_isContextMenu

protectedinherited

Definition at line 215 of file action_menu.h.

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

m_parent

EDA_DRAW_FRAME* ZOOM_MENU::m_parent

private

Definition at line 46 of file zoom_menu.h.

Referenced by create(), and update().

m_selected

int ACTION_MENU::m_selected

protectedinherited

Stores the id number of selected item.

Definition at line 224 of file action_menu.h.

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

m_submenus

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

protectedinherited

List of submenus.

Definition at line 236 of file action_menu.h.

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

m_title

wxString ACTION_MENU::m_title

protectedinherited

Menu title

Definition at line 218 of file action_menu.h.

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

m_titleDisplayed

bool ACTION_MENU::m_titleDisplayed

protectedinherited

Definition at line 214 of file action_menu.h.

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

m_tool

TOOL_INTERACTIVE* ACTION_MENU::m_tool

protectedinherited

Creator of the menu

Definition at line 227 of file action_menu.h.

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

m_toolActions

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

protectedinherited

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

Definition at line 233 of file action_menu.h.

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

---

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

• zoom_menu.h
• zoom_menu.cpp