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 context 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=NULL)
	Function Add() Adds an entry to the menu. More...
wxMenuItem *	Add (const TOOL_ACTION &aAction)
	Function Add() Adds an entry to the menu, basing on the TOOL_ACTION object. More...
std::list< wxMenuItem * >	Add (CONTEXT_MENU *aMenu, bool aExpand=false)
	Function Add() Adds a context 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	SetTool (TOOL_INTERACTIVE *aTool)
	Function SetTool() Sets a tool that is the creator of the menu. More...
CONTEXT_MENU *	Clone () const
	Creates a deep, recursive copy of this CONTEXT_MENU. More...

Protected Member Functions
TOOL_MANAGER *	getToolManager ()
	Returns an instance of TOOL_MANAGER class. More...
void	copyFrom (const CONTEXT_MENU &aMenu)
	Copies another menus data to this instance. More...

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

Private Member Functions
CONTEXT_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

(

EDA_DRAW_FRAME *

aParent

)

Definition at line 35 of file zoom_menu.cpp.

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

Referenced by create().

                                              : 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 + i,
            wxString::Format( _( "Zoom: %.2f" ), aParent->GetZoomLevelCoeff() / screen->m_ZoomList[i] ),
            wxEmptyString, wxITEM_CHECK );
    }
}

Member Function Documentation

wxMenuItem * CONTEXT_MENU::Add ( const wxString &  aLabel, int  aId, const BITMAP_OPAQUE *  aIcon = NULL  )

inherited

Function Add() Adds an entry to the menu.

After highlighting/selecting the entry, a TOOL_EVENT command is sent that contains ID of the entry.

Parameters

aLabel	is the text label show in the menu.
aId	is the ID that is sent in the TOOL_EVENT. It should be unique for every entry.
aIcon	is an optional icon.

Definition at line 107 of file context_menu.cpp.

References KiBitmap().

Referenced by SELECTION_TOOL::disambiguationMenu(), CONDITIONAL_MENU::Generate(), ALIGN_DISTRIBUTE_TOOL::Init(), PAD_CONTEXT_MENU::PAD_CONTEXT_MENU(), ROUTER_TOOL_MENU::ROUTER_TOOL_MENU(), and TUNER_TOOL_MENU::TUNER_TOOL_MENU().

{
#ifdef DEBUG
    if( FindItem( aId ) != NULL )
        wxLogWarning( wxT( "Adding more than one menu entry with the same ID may result in"
                "undefined behaviour" ) );
#endif

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

    if( aIcon )
        item->SetBitmap( KiBitmap( aIcon ) );

    return Append( item );
}

wxMenuItem * CONTEXT_MENU::Add ( const TOOL_ACTION &  aAction )

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 124 of file context_menu.cpp.

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

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

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

    if( icon )
        item->SetBitmap( KiBitmap( icon ) );

    m_toolActions[getMenuId( aAction )] = &aAction;

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

std::list< wxMenuItem * > CONTEXT_MENU::Add ( CONTEXT_MENU *  aMenu, bool  aExpand = false  )

inherited

Function Add() Adds a context 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.
aExpand	allows to add all entries from the menu as individual entries rather than add everything as a submenu.

Definition at line 142 of file context_menu.cpp.

References CONTEXT_MENU::appendCopy(), CONTEXT_MENU::Clone(), KiBitmap(), CONTEXT_MENU::m_icon, CONTEXT_MENU::m_submenus, and CONTEXT_MENU::m_title.

{
    std::list<wxMenuItem*> items;
    CONTEXT_MENU* menuCopy = aMenu->Clone();
    m_submenus.push_back( menuCopy );

    if( aExpand )
    {
        for( int i = 0; i < (int) aMenu->GetMenuItemCount(); ++i )
        {
            wxMenuItem* item = aMenu->FindItemByPosition( i );
            items.push_back( appendCopy( item ) );
        }
    }
    else
    {
        wxASSERT_MSG( !menuCopy->m_title.IsEmpty(), "Set a title for CONTEXT_MENU using SetTitle()" );

        if( aMenu->m_icon )
        {
            wxMenuItem* newItem = new wxMenuItem( this, -1, menuCopy->m_title );
            newItem->SetBitmap( KiBitmap( aMenu->m_icon ) );
            newItem->SetSubMenu( menuCopy );
            items.push_back( Append( newItem ) );
        }
        else
        {
            items.push_back( AppendSubMenu( menuCopy, menuCopy->m_title ) );
        }
    }

    return items;
}

void CONTEXT_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 177 of file context_menu.cpp.

References CONTEXT_MENU::m_submenus, CONTEXT_MENU::m_titleDisplayed, and CONTEXT_MENU::m_toolActions.

Referenced by CONTEXT_MENU::Clone(), and TRACK_WIDTH_MENU::SetBoard().

{
    m_titleDisplayed = false;

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

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

    wxASSERT( GetMenuItemCount() == 0 );
}

CONTEXT_MENU * CONTEXT_MENU::Clone ( ) const

inherited

Creates a deep, recursive copy of this CONTEXT_MENU.

Definition at line 235 of file context_menu.cpp.

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

Referenced by CONTEXT_MENU::Add(), CONTEXT_MENU::appendCopy(), and TOOL_MANAGER::dispatchContextMenu().

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

void CONTEXT_MENU::copyFrom ( const CONTEXT_MENU &  aMenu )

protectedinherited

Copies another menus data to this instance.

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

Definition at line 403 of file context_menu.cpp.

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

Referenced by CONTEXT_MENU::Clone().

{
    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 );
    }
}

CONTEXT_MENU* ZOOM_MENU::create ( ) const

inlineoverrideprivatevirtual

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

Reimplemented from CONTEXT_MENU.

Definition at line 38 of file zoom_menu.h.

References m_parent, and ZOOM_MENU().

    {
        return new ZOOM_MENU( m_parent );
    }

void CONTEXT_MENU::DisplayTitle ( bool  aDisplay = true )

inherited

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

Definition at line 74 of file context_menu.cpp.

References CONTEXT_MENU::m_title, and CONTEXT_MENU::m_titleDisplayed.

Referenced by SELECTION_TOOL::disambiguationMenu(), CONTEXT_MENU::SetTitle(), and TUNER_TOOL_MENU::TUNER_TOOL_MENU().

{
    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 ) );
            m_titleDisplayed = true;
        }
    }
}

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 CONTEXT_MENU.

Definition at line 55 of file zoom_menu.cpp.

References ID_POPUP_ZOOM_LEVEL_START, and ACTIONS::zoomPreset.

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

    return event;
}

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

inlinestaticprotectedinherited

Returns the corresponding wxMenuItem identifier for a TOOL_ACTION object.

Definition at line 158 of file context_menu.h.

References CONTEXT_MENU::ACTION_ID, and TOOL_ACTION::GetId().

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

    {
        return aAction.GetId() + ACTION_ID;
    }

int CONTEXT_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 context menu.

Definition at line 127 of file context_menu.h.

References CONTEXT_MENU::m_selected.

    {
        return m_selected;
    }

TOOL_MANAGER * CONTEXT_MENU::getToolManager ( )

protectedinherited

Returns an instance of TOOL_MANAGER class.

Definition at line 255 of file context_menu.cpp.

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

Referenced by PAD_CONTEXT_MENU::update(), and CONTEXT_MENU::updateHotKeys().

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

bool CONTEXT_MENU::HasEnabledItems ( ) const

inherited

Function HasEnabledItems();.

Returns true if the menu has any enabled items

Definition at line 191 of file context_menu.cpp.

{
    bool hasEnabled = false;

    auto& items = GetMenuItems();

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

    return hasEnabled;
}

void CONTEXT_MENU::SetIcon ( const BITMAP_OPAQUE *  aIcon )

inlineinherited

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 74 of file context_menu.h.

References CONTEXT_MENU::m_icon.

Referenced by GRID_MENU::GRID_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), PAD_CONTEXT_MENU::PAD_CONTEXT_MENU(), TRACK_VIA_SIZE_MENU::TRACK_VIA_SIZE_MENU(), and ZOOM_MENU().

    {
        m_icon = aIcon;
    }

void CONTEXT_MENU::SetTitle ( const wxString &  aTitle )

overrideinherited

Function SetTitle() Sets title for the context 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 63 of file context_menu.cpp.

References CONTEXT_MENU::DisplayTitle(), CONTEXT_MENU::m_title, and CONTEXT_MENU::m_titleDisplayed.

Referenced by SELECTION_TOOL::disambiguationMenu(), GRID_MENU::GRID_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), PAD_CONTEXT_MENU::PAD_CONTEXT_MENU(), ROUTER_TOOL_MENU::ROUTER_TOOL_MENU(), TRACK_WIDTH_MENU::TRACK_WIDTH_MENU(), TUNER_TOOL_MENU::TUNER_TOOL_MENU(), and ZOOM_MENU().

{
    // 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 );
}

void CONTEXT_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 228 of file context_menu.cpp.

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

Referenced by CONDITIONAL_MENU::Generate(), and TOOL_INTERACTIVE::SetContextMenu().

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

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 CONTEXT_MENU.

Definition at line 65 of file zoom_menu.cpp.

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

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

    // Check the current zoom
    for( unsigned int i = 0; i < GetMenuItemCount(); ++i )
        Check( ID_POPUP_ZOOM_LEVEL_START + i, std::fabs( zoomList[i] - zoom ) < 1e-6 );
}

void CONTEXT_MENU::UpdateAll ( )

inherited

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

Definition at line 210 of file context_menu.cpp.

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

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

    if( m_tool )
        updateHotKeys();

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

Member Data Documentation

EDA_DRAW_FRAME* ZOOM_MENU::m_parent

private

Definition at line 46 of file zoom_menu.h.

Referenced by create(), and update().

---

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

• zoom_menu.h
• zoom_menu.cpp