2015-04-30 09:08:18 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2015 CERN
|
2019-05-13 20:42:40 +00:00
|
|
|
* Copyright (C) 2015-2019 KiCad Developers, see CHANGELOG.txt for contributors.
|
2015-04-30 09:08:18 +00:00
|
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, you may find one here:
|
|
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
*/
|
|
|
|
|
2017-02-28 03:04:44 +00:00
|
|
|
#include <tool/conditional_menu.h>
|
2019-05-14 11:14:00 +00:00
|
|
|
#include <tool/action_menu.h>
|
2019-05-21 15:50:05 +00:00
|
|
|
#include <menus_helpers.h>
|
2015-04-30 09:08:18 +00:00
|
|
|
|
2019-05-13 20:42:40 +00:00
|
|
|
|
2019-05-17 14:35:50 +00:00
|
|
|
CONDITIONAL_MENU::CONDITIONAL_MENU( bool isContextMenu, TOOL_INTERACTIVE* aTool ) :
|
2019-06-15 00:29:42 +00:00
|
|
|
ACTION_MENU( isContextMenu )
|
2019-05-17 14:35:50 +00:00
|
|
|
{
|
|
|
|
m_tool = aTool;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-05-14 11:14:00 +00:00
|
|
|
ACTION_MENU* CONDITIONAL_MENU::create() const
|
2019-05-13 20:42:40 +00:00
|
|
|
{
|
|
|
|
CONDITIONAL_MENU* clone = new CONDITIONAL_MENU( m_isContextMenu, m_tool );
|
|
|
|
clone->m_entries = m_entries;
|
|
|
|
return clone;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2015-04-30 09:08:18 +00:00
|
|
|
void CONDITIONAL_MENU::AddItem( const TOOL_ACTION& aAction, const SELECTION_CONDITION& aCondition,
|
|
|
|
int aOrder )
|
|
|
|
{
|
2019-05-20 09:36:58 +00:00
|
|
|
wxASSERT( aAction.GetId() > 0 ); // Check if action was previously registered in ACTION_MANAGER
|
2019-05-13 20:42:40 +00:00
|
|
|
addEntry( ENTRY( &aAction, aCondition, aOrder, false ) );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void CONDITIONAL_MENU::AddCheckItem( const TOOL_ACTION& aAction,
|
|
|
|
const SELECTION_CONDITION& aCondition, int aOrder )
|
|
|
|
{
|
2019-05-20 09:36:58 +00:00
|
|
|
wxASSERT( aAction.GetId() > 0 ); // Check if action was previously registered in ACTION_MANAGER
|
2019-05-13 20:42:40 +00:00
|
|
|
addEntry( ENTRY( &aAction, aCondition, aOrder, true ) );
|
2015-04-30 09:08:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-05-14 19:21:10 +00:00
|
|
|
void CONDITIONAL_MENU::AddItem( int aId, const wxString& aText, const wxString& aTooltip,
|
|
|
|
BITMAP_DEF aIcon, const SELECTION_CONDITION& aCondition,
|
|
|
|
int aOrder )
|
|
|
|
{
|
|
|
|
wxMenuItem* item = new wxMenuItem( nullptr, aId, aText, aTooltip, wxITEM_NORMAL );
|
|
|
|
|
|
|
|
if( aIcon )
|
2019-05-21 15:50:05 +00:00
|
|
|
AddBitmapToMenuItem( item, KiBitmap( aIcon ) );
|
2019-05-14 19:21:10 +00:00
|
|
|
|
2019-05-21 15:50:05 +00:00
|
|
|
addEntry( ENTRY( item, aIcon, aCondition, aOrder, false ) );
|
2019-05-14 19:21:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void CONDITIONAL_MENU::AddCheckItem( int aId, const wxString& aText, const wxString& aTooltip,
|
|
|
|
BITMAP_DEF aIcon, const SELECTION_CONDITION& aCondition,
|
|
|
|
int aOrder )
|
|
|
|
{
|
|
|
|
wxMenuItem* item = new wxMenuItem( nullptr, aId, aText, aTooltip, wxITEM_CHECK );
|
|
|
|
|
|
|
|
if( aIcon )
|
2019-05-21 15:50:05 +00:00
|
|
|
AddBitmapToMenuItem( item, KiBitmap( aIcon ) );
|
2019-05-21 00:09:27 +00:00
|
|
|
|
2019-05-21 15:50:05 +00:00
|
|
|
addEntry( ENTRY( item, aIcon, aCondition, aOrder, true ) );
|
2019-05-14 19:21:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-05-14 11:14:00 +00:00
|
|
|
void CONDITIONAL_MENU::AddMenu( ACTION_MENU* aMenu, const SELECTION_CONDITION& aCondition,
|
2019-05-13 20:42:40 +00:00
|
|
|
int aOrder )
|
2015-04-30 09:08:18 +00:00
|
|
|
{
|
2019-05-13 20:42:40 +00:00
|
|
|
addEntry( ENTRY( aMenu, aCondition, aOrder ) );
|
2015-04-30 09:08:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-06-15 16:40:14 +00:00
|
|
|
void CONDITIONAL_MENU::AddSeparator( int aOrder )
|
2015-04-30 09:08:18 +00:00
|
|
|
{
|
2019-06-15 16:40:14 +00:00
|
|
|
addEntry( ENTRY( SELECTION_CONDITIONS::ShowAlways, aOrder ) );
|
2015-04-30 09:08:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-06-02 11:57:29 +00:00
|
|
|
SELECTION g_resolveDummySelection;
|
|
|
|
|
2019-06-15 00:29:42 +00:00
|
|
|
|
2019-06-02 11:57:29 +00:00
|
|
|
void CONDITIONAL_MENU::Resolve()
|
|
|
|
{
|
|
|
|
Evaluate( g_resolveDummySelection );
|
2019-06-15 00:29:42 +00:00
|
|
|
UpdateAll();
|
2019-06-11 09:03:22 +00:00
|
|
|
|
|
|
|
runOnSubmenus( [] ( ACTION_MENU* aMenu ) {
|
|
|
|
CONDITIONAL_MENU* conditionalMenu = dynamic_cast<CONDITIONAL_MENU*>( aMenu );
|
|
|
|
|
|
|
|
if( conditionalMenu )
|
|
|
|
conditionalMenu->Resolve();
|
|
|
|
} );
|
2019-06-02 11:57:29 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-05-13 20:42:40 +00:00
|
|
|
void CONDITIONAL_MENU::Evaluate( SELECTION& aSelection )
|
2015-04-30 09:08:18 +00:00
|
|
|
{
|
2019-05-13 20:42:40 +00:00
|
|
|
Clear();
|
2015-04-30 09:08:18 +00:00
|
|
|
|
2019-05-20 08:53:32 +00:00
|
|
|
// We try to avoid adding useless separators (when no menuitems between separators)
|
|
|
|
int menu_count = 0; // number of menus since the latest separator
|
|
|
|
|
2019-05-13 20:42:40 +00:00
|
|
|
for( const ENTRY& entry : m_entries )
|
2015-04-30 09:08:18 +00:00
|
|
|
{
|
2019-05-13 20:42:40 +00:00
|
|
|
const SELECTION_CONDITION& cond = entry.Condition();
|
|
|
|
bool result;
|
|
|
|
wxMenuItem* menuItem = nullptr;
|
2015-04-30 09:08:18 +00:00
|
|
|
|
2015-09-01 09:32:23 +00:00
|
|
|
try
|
|
|
|
{
|
2019-05-13 20:42:40 +00:00
|
|
|
result = cond( aSelection );
|
2015-09-01 09:32:23 +00:00
|
|
|
}
|
2016-10-10 15:04:48 +00:00
|
|
|
catch( std::exception& )
|
2015-09-01 09:32:23 +00:00
|
|
|
{
|
2015-04-30 09:08:18 +00:00
|
|
|
continue;
|
2015-09-01 09:32:23 +00:00
|
|
|
}
|
2015-04-30 09:08:18 +00:00
|
|
|
|
2019-05-13 20:42:40 +00:00
|
|
|
if( m_isContextMenu && !result )
|
|
|
|
continue;
|
|
|
|
|
|
|
|
switch( entry.Type() )
|
2015-04-30 09:08:18 +00:00
|
|
|
{
|
|
|
|
case ENTRY::ACTION:
|
2019-05-13 20:42:40 +00:00
|
|
|
menuItem = Add( *entry.Action(), entry.IsCheckmarkEntry() );
|
2019-05-20 08:53:32 +00:00
|
|
|
menu_count++;
|
2015-04-30 09:08:18 +00:00
|
|
|
break;
|
2019-05-20 09:36:58 +00:00
|
|
|
|
2015-04-30 09:08:18 +00:00
|
|
|
case ENTRY::MENU:
|
2019-05-13 20:42:40 +00:00
|
|
|
menuItem = Add( entry.Menu() );
|
2019-05-20 08:53:32 +00:00
|
|
|
menu_count++;
|
2015-04-30 09:08:18 +00:00
|
|
|
break;
|
2019-05-20 09:36:58 +00:00
|
|
|
|
2019-05-14 19:21:10 +00:00
|
|
|
case ENTRY::WXITEM:
|
2019-06-01 13:32:12 +00:00
|
|
|
#ifdef __WXMAC__
|
2019-06-02 11:57:29 +00:00
|
|
|
// Instantiate the Preferences item only on the first Resolve(); after that
|
|
|
|
// wxWidgets will have moved it to the Application menu
|
2019-06-01 13:32:12 +00:00
|
|
|
if( entry.wxItem()->GetId() == wxID_PREFERENCES )
|
2019-06-02 11:57:29 +00:00
|
|
|
{
|
|
|
|
if( &aSelection != &g_resolveDummySelection )
|
|
|
|
continue;
|
|
|
|
}
|
2019-06-01 13:32:12 +00:00
|
|
|
#endif
|
|
|
|
menuItem = new wxMenuItem( this,
|
|
|
|
entry.wxItem()->GetId(),
|
|
|
|
entry.wxItem()->GetItemLabel(),
|
|
|
|
entry.wxItem()->GetHelp(),
|
|
|
|
entry.wxItem()->GetKind() );
|
2019-05-21 15:50:05 +00:00
|
|
|
|
|
|
|
if( entry.GetIcon() )
|
|
|
|
AddBitmapToMenuItem( menuItem, KiBitmap( entry.GetIcon() ) );
|
|
|
|
|
|
|
|
// the wxMenuItem must be append only after the bitmap is set:
|
|
|
|
Append( menuItem );
|
|
|
|
|
2019-05-20 08:53:32 +00:00
|
|
|
menu_count++;
|
2019-05-14 19:21:10 +00:00
|
|
|
break;
|
2019-05-20 09:36:58 +00:00
|
|
|
|
2015-04-30 09:08:18 +00:00
|
|
|
case ENTRY::SEPARATOR:
|
2019-05-20 08:53:32 +00:00
|
|
|
if( menu_count )
|
|
|
|
menuItem = AppendSeparator();
|
2019-05-20 09:36:58 +00:00
|
|
|
|
2019-05-20 08:53:32 +00:00
|
|
|
menu_count = 0;
|
2015-04-30 09:08:18 +00:00
|
|
|
break;
|
2019-05-20 09:36:58 +00:00
|
|
|
|
2015-04-30 09:08:18 +00:00
|
|
|
default:
|
2019-05-20 09:36:58 +00:00
|
|
|
wxASSERT( false );
|
2015-04-30 09:08:18 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
2019-05-20 09:36:58 +00:00
|
|
|
if( menuItem )
|
|
|
|
{
|
|
|
|
if( entry.IsCheckmarkEntry() )
|
|
|
|
menuItem->Check( result );
|
|
|
|
else
|
|
|
|
menuItem->Enable( result );
|
|
|
|
}
|
2019-05-13 20:42:40 +00:00
|
|
|
}
|
2015-04-30 09:08:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void CONDITIONAL_MENU::addEntry( ENTRY aEntry )
|
|
|
|
{
|
|
|
|
if( aEntry.Order() < 0 ) // Any order, so give it any order number
|
|
|
|
aEntry.SetOrder( m_entries.size() );
|
|
|
|
|
|
|
|
std::list<ENTRY>::iterator it = m_entries.begin();
|
|
|
|
|
|
|
|
// Find the right spot for the entry
|
|
|
|
while( it != m_entries.end() && it->Order() <= aEntry.Order() )
|
|
|
|
++it;
|
|
|
|
|
|
|
|
m_entries.insert( it, aEntry );
|
|
|
|
}
|