panel_toolbar_customization.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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
 */
 
#include <dialogs/panel_toolbar_customization.h>
 
#include <bitmaps.h>
#include <settings/app_settings.h>
#include <tool/actions.h>
#include <tool/ui/toolbar_configuration.h>
#include <widgets/split_button.h>
#include <widgets/std_bitmap_button.h>
#include <widgets/up_down_tree.h>
 
#include <magic_enum.hpp>
#include <wx/listctrl.h>
#include <wx/menu.h>
#include <widgets/ui_common.h>
 
#include <algorithm>
#include <set>
 
// Simple IDs for the split button menu
enum
{
    ID_SEPARATOR_MENU = ( wxID_HIGHEST + 5 ),
    ID_SPACER_MENU,
    ID_GROUP_MENU
};
 
 
static std::map<TOOLBAR_LOC, wxString> s_toolbarNameMap = {
    { TOOLBAR_LOC::LEFT,     _( "Left" ) },
    { TOOLBAR_LOC::RIGHT,    _( "Right" ) },
    { TOOLBAR_LOC::TOP_MAIN, _( "Top main" ) },
    { TOOLBAR_LOC::TOP_AUX,  _( "Top auxiliary" ) }
};
 
 
class TOOLBAR_TREE_ITEM_DATA : public wxTreeItemData
{
public:
    TOOLBAR_TREE_ITEM_DATA() :
        m_type( TOOLBAR_ITEM_TYPE::SEPARATOR ),     // Init m_type to something
        m_action( nullptr ),
        m_control( nullptr ),
        m_size( 0 )
    { }
 
    TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE aType ) :
        m_type( aType ),
        m_action( nullptr ),
        m_control( nullptr ),
        m_size( 0 )
    { }
 
    TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE aType, int aSize ) :
        m_type( aType ),
        m_action( nullptr ),
        m_control( nullptr ),
        m_size( aSize )
    {
        wxASSERT( aType == TOOLBAR_ITEM_TYPE::SPACER );
    }
 
    TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE aType, wxString aName ) :
        m_type( aType ),
        m_action( nullptr ),
        m_control( nullptr ),
        m_size( 0 ),
        m_name( aName )
    {
        wxASSERT( aType == TOOLBAR_ITEM_TYPE::CONTROL
                  || aType == TOOLBAR_ITEM_TYPE::TB_GROUP );
    }
 
    void SetAction( TOOL_ACTION* aAction ) { m_action = aAction; }
    TOOL_ACTION* GetAction() const
    {
        wxASSERT( m_type == TOOLBAR_ITEM_TYPE::TOOL );
        return m_action;
    }
 
    void SetControl( ACTION_TOOLBAR_CONTROL* aControl ) { m_control = aControl; }
    ACTION_TOOLBAR_CONTROL* GetControl() const
    {
        wxASSERT( m_type == TOOLBAR_ITEM_TYPE::CONTROL );
        return m_control;
    }
 
    void SetName( const wxString& aName ) { m_name = aName; }
    const wxString& GetName() const       { return m_name; }
 
    void SetSize( int aSize )  { m_size = aSize; }
    int GetSize() const        { return m_size; }
 
    TOOLBAR_ITEM_TYPE GetType() const { return m_type; }
 
private:
    // Item type
    TOOLBAR_ITEM_TYPE m_type;
 
    // Tool properties (can be one or the other, but never both)
    TOOL_ACTION*            m_action;
    ACTION_TOOLBAR_CONTROL* m_control;
 
    // Spacer properties
    int m_size;
 
    // Group/control properties
    wxString m_name;
};
 
 
PANEL_TOOLBAR_CUSTOMIZATION::PANEL_TOOLBAR_CUSTOMIZATION( wxWindow* aParent, APP_SETTINGS_BASE* aCfg,
                                                          TOOLBAR_SETTINGS* aTbSettings, FRAME_T aActionContext,
                                                          const std::vector<TOOL_ACTION*>&            aTools,
                                                          const std::vector<ACTION_TOOLBAR_CONTROL*>& aControls ) :
        PANEL_TOOLBAR_CUSTOMIZATION_BASE( aParent ),
        m_appSettings( aCfg ),
        m_appTbSettings( aTbSettings ),
        m_currentToolbar( TOOLBAR_LOC::TOP_MAIN ),
        m_actionContext( aActionContext )
{
    // Copy the tools and controls into the internal maps
    for( auto& tool : aTools )
        m_availableTools.emplace( tool->GetName(), tool );
 
    for( auto& control : aControls )
        m_availableControls.emplace( control->GetName(), control );
 
    // Configure the Ui elements
    m_btnToolDelete->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
    m_btnToolMoveUp->SetBitmap( KiBitmapBundle( BITMAPS::small_up ) );
    m_btnToolMoveDown->SetBitmap( KiBitmapBundle( BITMAPS::small_down ) );
    m_btnAddTool->SetBitmap( KiBitmapBundle( BITMAPS::left ) );
 
    m_insertButton->SetLabel( _( "Insert Separator" ) );
    //m_insertButton->SetWidthPadding( 4 );
 
    // Populate the browse library options
    wxMenu* insertMenu = m_insertButton->GetSplitButtonMenu();
 
    insertMenu->Append( ID_SPACER_MENU, _( "Insert Spacer" ) );
    insertMenu->Append( ID_GROUP_MENU, _( "Insert Group" ) );
 
    insertMenu->Bind( wxEVT_COMMAND_MENU_SELECTED, &PANEL_TOOLBAR_CUSTOMIZATION::onSpacerPress,
                      this, ID_SPACER_MENU );
    insertMenu->Bind( wxEVT_COMMAND_MENU_SELECTED, &PANEL_TOOLBAR_CUSTOMIZATION::onGroupPress,
                      this, ID_GROUP_MENU );
 
    // This is the button only press for the browse button instead of the menu
    m_insertButton->Bind( wxEVT_BUTTON, &PANEL_TOOLBAR_CUSTOMIZATION::onSeparatorPress, this );
 
    m_actionFilter->ShowSearchButton( false );
    m_actionFilter->ShowCancelButton( true );
    m_actionFilter->SetDescriptiveText( _( "Filter actions" ) );
 
#ifdef __WXGTK__
    m_actionFilter->SetMinSize( wxSize( -1, GetTextExtent( wxT( "qb" ) ).y + 10 ) );
#endif
 
    m_actionFilter->Bind( wxEVT_TEXT, &PANEL_TOOLBAR_CUSTOMIZATION::onActionFilterText, this );
    m_actionFilter->Bind( wxEVT_SEARCHCTRL_CANCEL_BTN,
                          &PANEL_TOOLBAR_CUSTOMIZATION::onActionFilterText, this );
    m_actionsList->Bind( wxEVT_MOTION, &PANEL_TOOLBAR_CUSTOMIZATION::onActionListMouseMove, this );
    m_actionsList->Bind( wxEVT_LEAVE_WINDOW, &PANEL_TOOLBAR_CUSTOMIZATION::onActionListMouseMove, this );
 
    // TODO (ISM): Enable draging
    m_btnToolMoveDown->Enable( false );
    m_btnToolMoveUp->Enable( false );
}
 
 
PANEL_TOOLBAR_CUSTOMIZATION::~PANEL_TOOLBAR_CUSTOMIZATION()
{
    m_actionFilter->Unbind( wxEVT_TEXT, &PANEL_TOOLBAR_CUSTOMIZATION::onActionFilterText, this );
    m_actionFilter->Unbind( wxEVT_SEARCHCTRL_CANCEL_BTN,
                            &PANEL_TOOLBAR_CUSTOMIZATION::onActionFilterText, this );
    m_actionsList->Unbind( wxEVT_MOTION, &PANEL_TOOLBAR_CUSTOMIZATION::onActionListMouseMove, this );
    m_actionsList->Unbind( wxEVT_LEAVE_WINDOW, &PANEL_TOOLBAR_CUSTOMIZATION::onActionListMouseMove, this );
}
 
 
bool PANEL_TOOLBAR_CUSTOMIZATION::isActionSupported( const TOOL_ACTION& aAction ) const
{
    const std::string& name = aAction.GetName();
 
    auto hasPrefix = [&]( const char* aPrefix ) -> bool
    {
        return name.rfind( aPrefix, 0 ) == 0;
    };
 
    if( m_actionContext == FRAME_PCB_DISPLAY3D )
    {
        if( hasPrefix( "3DViewer." ) )
            return true;
 
        return name == ACTIONS::zoomRedraw.GetName() || name == ACTIONS::zoomInCenter.GetName()
               || name == ACTIONS::zoomOutCenter.GetName() || name == ACTIONS::zoomFitScreen.GetName();
    }
 
    if( hasPrefix( "common." ) )
        return true;
 
    switch( m_actionContext )
    {
    case FRAME_PCB_EDITOR:
    case FRAME_FOOTPRINT_EDITOR:
    case FRAME_FOOTPRINT_VIEWER: return hasPrefix( "pcbnew." );
 
    case FRAME_SCH:
    case FRAME_SCH_SYMBOL_EDITOR:
    case FRAME_SCH_VIEWER:
    case FRAME_SIMULATOR: return hasPrefix( "eeschema." );
 
    case FRAME_GERBER: return hasPrefix( "gerbview." );
 
    case FRAME_PL_EDITOR: return hasPrefix( "plEditor." );
 
    default: return false;
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::ResetPanel()
{
    m_toolbars.clear();
    m_toolbarChoices.clear();
 
    // Go over every toolbar and initialize things
    for( auto& tb : magic_enum::enum_values<TOOLBAR_LOC>() )
    {
        // Create a shadow toolbar
        auto tbConfig = m_appTbSettings->DefaultToolbarConfig( tb );
 
        if( !tbConfig.has_value() )
            continue;
 
        m_toolbars[tb] = tbConfig.value();
        m_toolbarChoices.push_back( tb );
    }
 
    if( !m_toolbarChoices.empty() )
    {
        m_tbChoice->SetSelection( 0 );
        m_currentToolbar = m_toolbarChoices[0];
    }
 
    populateToolbarTree();
}
 
 
bool PANEL_TOOLBAR_CUSTOMIZATION::TransferDataToWindow()
{
    wxArrayString tbChoices;
 
    m_toolbars.clear();
    m_toolbarChoices.clear();
 
    // Go over every toolbar and initialize things
    for( auto& tb : magic_enum::enum_values<TOOLBAR_LOC>() )
    {
        // Create a shadow toolbar
        auto tbConfig = m_appTbSettings->GetToolbarConfig( tb );
 
        if( !tbConfig.has_value() )
            continue;
 
        m_toolbars.emplace( tb, tbConfig.value() );
        m_toolbarChoices.push_back( tb );
 
        // Setup the UI name
        const auto& tbName = s_toolbarNameMap.find( tb );
 
        wxASSERT_MSG( tbName != s_toolbarNameMap.end(),
                      wxString::Format( "Unknown toolbar: %s", magic_enum::enum_name( tb ) ) );
 
        tbChoices.Add( tbName->second );
    }
 
    m_tbChoice->Set( tbChoices );
 
    // Always populate the actions before the toolbars, that way the icons are available
    populateActions();
 
    if( !m_toolbarChoices.empty() )
    {
        m_tbChoice->SetSelection( 0 );
        m_currentToolbar = m_toolbarChoices[0];
    }
 
    populateToolbarTree();
 
    // Sync the enable/disable control
    enableCustomControls( m_appSettings->m_CustomToolbars );
    m_customToolbars->SetValue( m_appSettings->m_CustomToolbars );
 
    return true;
}
 
 
bool PANEL_TOOLBAR_CUSTOMIZATION::TransferDataFromWindow()
{
    m_appSettings->m_CustomToolbars = m_customToolbars->GetValue();
 
    // Store the current toolbar
    std::optional<TOOLBAR_CONFIGURATION> currentTb = parseToolbarTree();
 
    if( currentTb.has_value() )
        m_toolbars[m_currentToolbar] = currentTb.value();
 
    std::set<std::string> seenControls;
 
    for( auto& [loc, config] : m_toolbars )
    {
        auto& items = config.m_toolbarItems;
 
        items.erase( std::remove_if( items.begin(), items.end(),
                    [&]( const TOOLBAR_ITEM& item )
                    {
                        if( item.m_Type != TOOLBAR_ITEM_TYPE::CONTROL )
                            return false;
 
                        return !seenControls.insert( item.m_ControlName ).second;
                    } ),
                    items.end() );
    }
 
    // Write the shadow toolbars with changes back to the app toolbar settings
    for( const auto& [loc, config] : m_toolbars )
        m_appTbSettings->SetStoredToolbarConfig( loc, config );
 
    return true;
}
 
std::optional<TOOLBAR_CONFIGURATION> PANEL_TOOLBAR_CUSTOMIZATION::parseToolbarTree()
{
    TOOLBAR_CONFIGURATION config;
 
    wxTreeItemId      mainId;
    wxTreeItemId      rootId = m_toolbarTree->GetRootItem();
    wxTreeItemIdValue mainCookie;
 
    if( !rootId.IsOk() )
        return std::nullopt;
 
    mainId = m_toolbarTree->GetFirstChild( rootId, mainCookie );
 
    while( mainId.IsOk() )
    {
        wxTreeItemData* treeData = m_toolbarTree->GetItemData( mainId );
 
        TOOLBAR_TREE_ITEM_DATA* tbData = dynamic_cast<TOOLBAR_TREE_ITEM_DATA*>( treeData );
 
        wxCHECK2( tbData, continue );
 
        switch( tbData->GetType() )
        {
        case TOOLBAR_ITEM_TYPE::SPACER:
            config.AppendSpacer( tbData->GetSize() );
            break;
 
        case TOOLBAR_ITEM_TYPE::SEPARATOR:
            config.AppendSeparator();
            break;
 
        case TOOLBAR_ITEM_TYPE::CONTROL:
            config.AppendControl( tbData->GetControl()->GetName() );
            break;
 
        case TOOLBAR_ITEM_TYPE::TOOL:
            config.AppendAction( *( tbData->GetAction() ) );
            break;
 
        case TOOLBAR_ITEM_TYPE::TB_GROUP:
            TOOLBAR_GROUP_CONFIG grpConfig( tbData->GetName() );
 
            if( m_toolbarTree->ItemHasChildren( mainId ) )
            {
                wxTreeItemIdValue childCookie;
                wxTreeItemId      childId = m_toolbarTree->GetFirstChild( mainId, childCookie );
 
                while( childId.IsOk() )
                {
                    wxTreeItemData* childTreeData = m_toolbarTree->GetItemData( childId );
 
                    TOOLBAR_TREE_ITEM_DATA* childTbData = dynamic_cast<TOOLBAR_TREE_ITEM_DATA*>( childTreeData );
 
                    wxCHECK2( childTbData, break );
 
                    switch( childTbData->GetType() )
                    {
                    case TOOLBAR_ITEM_TYPE::TB_GROUP:
                    case TOOLBAR_ITEM_TYPE::SPACER:
                    case TOOLBAR_ITEM_TYPE::SEPARATOR:
                    case TOOLBAR_ITEM_TYPE::CONTROL:
                        wxASSERT_MSG( false, "Invalid entry in a group" );
                        break;
 
                    case TOOLBAR_ITEM_TYPE::TOOL:
                        grpConfig.AddAction( *( childTbData->GetAction() ) );
                        break;
                    }
 
                    childId = m_toolbarTree->GetNextChild( mainId, childCookie );
                }
            }
 
            config.AppendGroup( grpConfig );
        }
 
        mainId = m_toolbarTree->GetNextChild( rootId, mainCookie );
    }
 
    return config;
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::populateToolbarTree()
{
    m_toolbarTree->DeleteAllItems();
    m_toolbarTree->SetImages( m_actionImageBundleVector );
 
    const auto& it = m_toolbars.find( m_currentToolbar );
 
    if( it == m_toolbars.end() )
    {
        // Disable the controls and bail out - no toolbar here
        enableToolbarControls( false );
        return;
    }
 
    // Ensure the controls are enabled
    enableToolbarControls( true );
 
    TOOLBAR_CONFIGURATION toolbar = it->second;
 
    wxTreeItemId root = m_toolbarTree->AddRoot( "Toolbar" );
 
    for( const TOOLBAR_ITEM& item : toolbar.GetToolbarItems() )
    {
        switch( item.m_Type )
        {
        case TOOLBAR_ITEM_TYPE::SEPARATOR:
        {
            // Add a separator
            TOOLBAR_TREE_ITEM_DATA* sepTreeItem = new TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE::SEPARATOR );
            m_toolbarTree->AppendItem( root, _( "Separator" ), -1, -1, sepTreeItem );
            break;
        }
 
        case TOOLBAR_ITEM_TYPE::SPACER:
        {
            // Add a spacer
            TOOLBAR_TREE_ITEM_DATA* spacerTreeItem = new TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE::SPACER );
            spacerTreeItem->SetSize( item.m_Size );
            m_toolbarTree->AppendItem( root, wxString::Format( _( "Spacer: %i" ), item.m_Size ), -1, -1,
                                       spacerTreeItem );
            break;
        }
 
        case TOOLBAR_ITEM_TYPE::CONTROL:
        {
            auto controlIter = m_availableControls.find( item.m_ControlName );
 
            if( controlIter == m_availableControls.end() )
            {
                wxASSERT_MSG( false, wxString::Format( "Unable to find control %s", item.m_ControlName ) );
                continue;
            }
 
            // Add a control
            TOOLBAR_TREE_ITEM_DATA* controlTreeItem = new TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE::CONTROL );
            controlTreeItem->SetControl( controlIter->second );
            m_toolbarTree->AppendItem( root, controlIter->second->GetUiName(), -1, -1, controlTreeItem );
            break;
        }
 
        case TOOLBAR_ITEM_TYPE::TOOL:
        {
            // Add a tool
            auto toolIter = m_availableTools.find( item.m_ActionName );
 
            if( toolIter == m_availableTools.end() )
            {
                wxASSERT_MSG( false, wxString::Format( "Unable to find tool %s", item.m_ActionName ) );
                continue;
            }
 
            if( !isActionSupported( *toolIter->second ) )
                continue;
 
            TOOLBAR_TREE_ITEM_DATA* toolTreeItem = new TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE::TOOL );
            toolTreeItem->SetAction( toolIter->second );
 
            int  imgIdx = -1;
            auto imgMap = m_actionImageListMap.find( item.m_ActionName );
 
            if( imgMap != m_actionImageListMap.end() )
                imgIdx = imgMap->second;
 
            m_toolbarTree->AppendItem( root, toolIter->second->GetFriendlyName(), imgIdx, -1, toolTreeItem );
            break;
        }
 
        case TOOLBAR_ITEM_TYPE::TB_GROUP:
        {
            // Add a group of items to the toolbar
            TOOLBAR_TREE_ITEM_DATA* groupTreeItem = new TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE::TB_GROUP );
            groupTreeItem->SetName( item.m_GroupName );
 
            wxTreeItemId groupId = m_toolbarTree->AppendItem( root, item.m_GroupName, -1, -1, groupTreeItem );
            bool         haveVisibleGroupItems = false;
 
            // Add the elements below the group
            for( const TOOLBAR_ITEM& groupItem : item.m_GroupItems )
            {
                auto toolMap = m_availableTools.find( groupItem.m_ActionName );
 
                if( toolMap == m_availableTools.end() )
                {
                    wxASSERT_MSG( false, wxString::Format( "Unable to find group tool %s", groupItem.m_ActionName ) );
                    continue;
                }
 
                if( !isActionSupported( *toolMap->second ) )
                    continue;
 
                TOOLBAR_TREE_ITEM_DATA* toolTreeItem = new TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE::TOOL );
                toolTreeItem->SetAction( toolMap->second );
 
                int  imgIdx = -1;
                auto imgMap = m_actionImageListMap.find( groupItem.m_ActionName );
 
                if( imgMap != m_actionImageListMap.end() )
                    imgIdx = imgMap->second;
 
                m_toolbarTree->AppendItem( groupId, toolMap->second->GetFriendlyName(), imgIdx, -1, toolTreeItem );
 
                haveVisibleGroupItems = true;
            }
 
            if( !haveVisibleGroupItems )
                m_toolbarTree->Delete( groupId );
 
            break;
        }
        }
    }
 
    m_toolbarTree->ExpandAll();
 
    wxTreeItemIdValue temp;
    wxTreeItemId firstItem = m_toolbarTree->GetFirstChild( root, temp );
 
    if( firstItem.IsOk()  )
    {
        m_toolbarTree->SelectItem( firstItem );
        m_toolbarTree->EnsureVisible( firstItem );
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::populateActions()
{
    const int c_defSize = 24; // Default icon size for toolbar actions
 
    // Clear all existing information for the actions
    m_actionImageListMap.clear();
    m_actionImageBundleVector.clear();
    m_actionEntries.clear();
 
    // Prep the control
    m_actionsList->DeleteAllItems();
    m_actionsList->DeleteAllColumns();
    m_actionsList->InsertColumn( 0, "", wxLIST_FORMAT_LEFT, wxLIST_AUTOSIZE );
 
    for( const auto& [k, tool] : m_availableTools )
    {
        if( !isActionSupported( *tool ) )
            continue;
 
        if( tool->CheckToolbarState( TOOLBAR_STATE::HIDDEN ) )
            continue;
 
        ACTION_LIST_ENTRY entry;
        entry.label = tool->GetFriendlyName();
        entry.tooltip = tool->GetDescription(); // falls back to tooltip if no description provided
        entry.action = tool;
        entry.search_text = entry.label.Upper() + wxS( " " ) + entry.tooltip.Upper();
 
        if( tool->GetIcon() != BITMAPS::INVALID_BITMAP )
        {
            int imgIdx = m_actionImageBundleVector.size();
            m_actionImageBundleVector.push_back( KiBitmapBundleDef( tool->GetIcon(), c_defSize ) );
            m_actionImageListMap.emplace( tool->GetName(), imgIdx );
            entry.image_index = imgIdx;
        }
 
        m_actionEntries.push_back( std::move( entry ) );
    }
 
    for( const auto& [k, control] : m_availableControls )
    {
        ACTION_LIST_ENTRY entry;
        entry.label = control->GetUiName();
        entry.tooltip = control->GetDescription();
        entry.control = control;
        entry.search_text = entry.label.Upper() + wxS( " " ) + control->GetDescription().Upper();
        m_actionEntries.push_back( std::move( entry ) );
    }
 
    std::sort( m_actionEntries.begin(), m_actionEntries.end(),
               []( const ACTION_LIST_ENTRY& a, const ACTION_LIST_ENTRY& b )
               {
                   return a.label.CmpNoCase( b.label ) < 0;
               } );
 
    m_actionsList->SetSmallImages( m_actionImageBundleVector );
    applyActionFilter();
}
 
 
bool PANEL_TOOLBAR_CUSTOMIZATION::actionMatchesFilter( const ACTION_LIST_ENTRY& aEntry,
                                                       const wxString& aFilter ) const
{
    if( aFilter.IsEmpty() )
        return true;
 
    return aEntry.search_text.Contains( aFilter.Upper() );
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::applyActionFilter()
{
    wxFont   listFont = KIUI::GetInfoFont( this );
    wxString filter = m_actionFilter->GetValue();
 
    m_hoveredActionEntry = -1;
    m_actionsList->UnsetToolTip();
 
    m_actionsList->DeleteAllItems();
 
    for( size_t idx = 0; idx < m_actionEntries.size(); ++idx )
    {
        const ACTION_LIST_ENTRY& entry = m_actionEntries[idx];
 
        if( !actionMatchesFilter( entry, filter ) )
            continue;
 
        wxListItem item;
        item.SetId( m_actionsList->GetItemCount() );
        item.SetText( entry.label );
        item.SetFont( listFont );
        item.SetData( static_cast<long>( idx ) );
        item.SetImage( entry.image_index );
 
        m_actionsList->InsertItem( item );
    }
 
    if( m_actionsList->GetItemCount() > 0 )
        m_actionsList->SetItemState( 0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED );
 
    m_actionsList->SetColumnWidth( 0, wxLIST_AUTOSIZE );
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onGroupPress( wxCommandEvent& aEvent )
{
    TOOLBAR_TREE_ITEM_DATA* treeItem = new TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE::TB_GROUP, _( "Group" ) );
 
    wxTreeItemId newItem;
    wxTreeItemId selItem = m_toolbarTree->GetSelection();
 
    if( selItem.IsOk() )
    {
        // Can't add a group onto a group
        wxTreeItemId parent = m_toolbarTree->GetItemParent( selItem );
 
        if( parent.IsOk() )
        {
            wxTreeItemId secondParent = m_toolbarTree->GetItemParent( parent );
 
            if( secondParent.IsOk() )
            {
                delete treeItem;
                return;
            }
        }
 
        newItem = m_toolbarTree->InsertItem( m_toolbarTree->GetRootItem(), selItem, treeItem->GetName(),
                                             -1, -1, treeItem );
    }
    else
    {
        newItem = m_toolbarTree->AppendItem( m_toolbarTree->GetRootItem(), treeItem->GetName(), -1, -1,
                                             treeItem );
    }
 
    if( newItem.IsOk() )
    {
        m_toolbarTree->SelectItem( newItem );
        m_toolbarTree->EnsureVisible( newItem );
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onSpacerPress( wxCommandEvent& aEvent )
{
    TOOLBAR_TREE_ITEM_DATA* treeItem = new TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE::SPACER, 5 );
 
    wxString label = wxString::Format( "Spacer: %i", treeItem->GetSize() );
 
    wxTreeItemId newItem;
    wxTreeItemId selItem = m_toolbarTree->GetSelection();
 
    if( selItem.IsOk() )
    {
        // Insert after the current selection at the same level
        wxTreeItemId parent = m_toolbarTree->GetItemParent( selItem );
 
        // Can't insert a spacer in a group yet
        if( parent.IsOk() )
        {
            wxTreeItemId secondParent = m_toolbarTree->GetItemParent( parent );
 
            if( secondParent.IsOk() )
            {
                delete treeItem;
                return;
            }
        }
 
        newItem = m_toolbarTree->InsertItem( parent, selItem, label, -1, -1, treeItem );
    }
    else
    {
        newItem = m_toolbarTree->AppendItem( m_toolbarTree->GetRootItem(), label, -1, -1, treeItem );
    }
 
    if( newItem.IsOk() )
    {
        m_toolbarTree->SelectItem( newItem );
        m_toolbarTree->EnsureVisible( newItem );
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onSeparatorPress( wxCommandEvent& aEvent )
{
    TOOLBAR_TREE_ITEM_DATA* treeItem = new TOOLBAR_TREE_ITEM_DATA( TOOLBAR_ITEM_TYPE::SEPARATOR );
 
    wxTreeItemId newItem;
    wxTreeItemId selItem = m_toolbarTree->GetSelection();
 
    if( selItem.IsOk() )
    {
        // Insert after the current selection at the same level
        wxTreeItemId parent = m_toolbarTree->GetItemParent( selItem );
 
        // Can't insert a separator in a group yet
        if( parent.IsOk() )
        {
            wxTreeItemId secondParent = m_toolbarTree->GetItemParent( parent );
 
            if( secondParent.IsOk() )
            {
                delete treeItem;
                return;
            }
        }
 
        newItem = m_toolbarTree->InsertItem( parent, selItem, _( "Separator" ), -1, -1, treeItem );
    }
    else
    {
        newItem = m_toolbarTree->AppendItem( m_toolbarTree->GetRootItem(), _( "Separator" ), -1, -1, treeItem );
    }
 
    if( newItem.IsOk() )
    {
        m_toolbarTree->SelectItem( newItem );
        m_toolbarTree->EnsureVisible( newItem );
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onCustomizeTbCb( wxCommandEvent& event )
{
    enableCustomControls( event.IsChecked() );
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::enableCustomControls( bool enable )
{
    m_tbChoice->Enable( enable );
    enableToolbarControls( enable );
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::enableToolbarControls( bool enable )
{
    m_toolbarTree->Enable( enable );
    m_btnAddTool->Enable( enable );
    m_btnToolDelete->Enable( enable );
 
    m_btnToolMoveDown->Enable( enable );
    m_btnToolMoveUp->Enable( enable );
    m_actionsList->Enable( enable );
    m_actionFilter->Enable( enable );
    m_insertButton->Enable( enable );
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onToolDelete( wxCommandEvent& event )
{
    wxTreeItemId item = m_toolbarTree->GetSelection();
 
    if( !item.IsOk() )
        return;
 
    // The tree control defaults to nothing selected if you delete the item
    // at the last place, so we have to manually get the itme immediately before
    // the one we will delete, and then select it if nothing is selected.
    wxTreeItemId prev = m_toolbarTree->GetPrevSibling( item );
 
    m_toolbarTree->Delete( item );
 
    item = m_toolbarTree->GetSelection();
 
    if( !item.IsOk() && prev.IsOk() )
    {
        m_toolbarTree->SelectItem( prev );
        m_toolbarTree->EnsureVisible( prev );
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onToolMoveUp( wxCommandEvent& event )
{
    m_toolbarTree->MoveItemUp( m_toolbarTree->GetSelection() );
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onToolMoveDown( wxCommandEvent& event )
{
    m_toolbarTree->MoveItemDown( m_toolbarTree->GetSelection() );
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onBtnAddAction( wxCommandEvent& event )
{
    // Get the selected item
    long actionIdx = m_actionsList->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
 
    // Nothing is selected, bail out
    if( actionIdx < 0 )
        return;
 
    size_t entryIdx = m_actionsList->GetItemData( actionIdx );
 
    if( entryIdx >= m_actionEntries.size() )
        return;
 
    const ACTION_LIST_ENTRY& entry = m_actionEntries[entryIdx];
    TOOL_ACTION*             action = entry.action;
    ACTION_TOOLBAR_CONTROL*  control = entry.control;
 
    if( control )
    {
        removeControlFromOtherToolbars( control->GetName() );
        removeControlFromCurrentTree( control->GetName() );
    }
 
    // Build the item to add
    TOOLBAR_TREE_ITEM_DATA* toolTreeItem = new TOOLBAR_TREE_ITEM_DATA( action ? TOOLBAR_ITEM_TYPE::TOOL
                                                                              : TOOLBAR_ITEM_TYPE::CONTROL );
    toolTreeItem->SetAction( action );
    toolTreeItem->SetControl( control );
 
    int imgIdx = -1;
 
    if( action )
    {
        auto imgMap = m_actionImageListMap.find( action->GetName() );
 
        if( imgMap != m_actionImageListMap.end() )
            imgIdx = imgMap->second;
    }
 
    // Actually add the item
    wxTreeItemId selItem = m_toolbarTree->GetSelection();
    wxTreeItemId newItem;
 
    if( selItem.IsOk() )
    {
        TOOLBAR_TREE_ITEM_DATA* data =
                dynamic_cast<TOOLBAR_TREE_ITEM_DATA*>( m_toolbarTree->GetItemData( selItem ) );
 
        if( data && data->GetType() == TOOLBAR_ITEM_TYPE::TB_GROUP )
        {
            // Insert into the end of the group
            newItem = m_toolbarTree->AppendItem( selItem, entry.label, imgIdx, -1, toolTreeItem );
        }
        else
        {
            // Insert after the current selection at the same level
            wxTreeItemId parent = m_toolbarTree->GetItemParent( selItem );
            newItem = m_toolbarTree->InsertItem( parent, selItem, entry.label, imgIdx, -1, toolTreeItem );
        }
    }
    else
    {
        // Insert at the root level if there is no selection
        newItem = m_toolbarTree->AppendItem( m_toolbarTree->GetRootItem(), entry.label, imgIdx, -1, toolTreeItem );
    }
 
    if( newItem.IsOk() )
    {
        m_toolbarTree->SelectItem( newItem );
        m_toolbarTree->EnsureVisible( newItem );
 
        // Move the action to the next available one, to be nice
        if( ++actionIdx < m_actionsList->GetItemCount() )
            m_actionsList->SetItemState( actionIdx, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED );
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onActionFilterText( wxCommandEvent& aEvent )
{
    applyActionFilter();
    aEvent.Skip();
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onActionListMouseMove( wxMouseEvent& aEvent )
{
    aEvent.Skip();
 
    if( aEvent.Leaving() )
    {
        m_hoveredActionEntry = -1;
        m_actionsList->UnsetToolTip();
        return;
    }
 
    int  flags = 0;
    long item = m_actionsList->HitTest( aEvent.GetPosition(), flags );
 
    if( item >= 0 )
    {
        long entryIdx = static_cast<long>( m_actionsList->GetItemData( item ) );
 
        if( entryIdx >= 0 && entryIdx < static_cast<long>( m_actionEntries.size() ) )
        {
            if( m_hoveredActionEntry != entryIdx )
            {
                m_hoveredActionEntry = entryIdx;
 
                if( const wxString& tooltip = m_actionEntries[entryIdx].tooltip; tooltip.IsEmpty() )
                    m_actionsList->UnsetToolTip();
                else
                    m_actionsList->SetToolTip( tooltip );
            }
 
            return;
        }
    }
 
    if( m_hoveredActionEntry != -1 )
    {
        m_hoveredActionEntry = -1;
        m_actionsList->UnsetToolTip();
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onTreeBeginLabelEdit( wxTreeEvent& event )
{
    wxTreeItemId id = event.GetItem();
 
    if( id.IsOk() )
    {
        wxTreeItemData* treeData = m_toolbarTree->GetItemData( id );
 
        if( TOOLBAR_TREE_ITEM_DATA* tbData = dynamic_cast<TOOLBAR_TREE_ITEM_DATA*>( treeData ) )
        {
            switch( tbData->GetType() )
            {
            case TOOLBAR_ITEM_TYPE::TOOL:
            case TOOLBAR_ITEM_TYPE::CONTROL:
            case TOOLBAR_ITEM_TYPE::SEPARATOR:
                // Don't let these be edited
                event.Veto();
                break;
 
            case TOOLBAR_ITEM_TYPE::TB_GROUP:
            case TOOLBAR_ITEM_TYPE::SPACER:
                // Do nothing here
                break;
            }
        }
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onTreeEndLabelEdit( wxTreeEvent& event )
{
 
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onTbChoiceSelect( wxCommandEvent& event )
{
    // Store the current toolbar
    std::optional<TOOLBAR_CONFIGURATION> currentTb = parseToolbarTree();
 
    if( currentTb.has_value() )
        m_toolbars[m_currentToolbar] = currentTb.value();
 
    int idx = event.GetInt();
 
    if( idx >= 0 && idx < static_cast<int>( m_toolbarChoices.size() ) )
    {
        m_currentToolbar = m_toolbarChoices[idx];
        populateToolbarTree();
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::onListItemActivated( wxListEvent& event )
{
    wxCommandEvent dummy;
    onBtnAddAction( dummy );
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::removeControlFromOtherToolbars( const std::string& aControlName )
{
    for( auto& [loc, config] : m_toolbars )
    {
        if( loc == m_currentToolbar )
            continue;
 
        auto& items = config.m_toolbarItems;
 
        items.erase( std::remove_if( items.begin(), items.end(),
                    [&]( const TOOLBAR_ITEM& item )
                    {
                        return item.m_Type == TOOLBAR_ITEM_TYPE::CONTROL
                                && item.m_ControlName == aControlName;
                    } ),
                    items.end() );
    }
}
 
 
void PANEL_TOOLBAR_CUSTOMIZATION::removeControlFromCurrentTree( const std::string& aControlName )
{
    wxTreeItemId rootId = m_toolbarTree->GetRootItem();
 
    if( !rootId.IsOk() )
        return;
 
    std::vector<wxTreeItemId> toDelete;
    wxTreeItemIdValue         cookie;
 
    for( wxTreeItemId id = m_toolbarTree->GetFirstChild( rootId, cookie );
        id.IsOk();
        id = m_toolbarTree->GetNextChild( rootId, cookie ) )
    {
        TOOLBAR_TREE_ITEM_DATA* data =
                dynamic_cast<TOOLBAR_TREE_ITEM_DATA*>( m_toolbarTree->GetItemData( id ) );
 
        if( data
            && data->GetType() == TOOLBAR_ITEM_TYPE::CONTROL
            && data->GetControl()
            && data->GetControl()->GetName() == aControlName )
        {
            toDelete.push_back( id );
        }
    }
 
    for( const wxTreeItemId& id : toDelete )
        m_toolbarTree->Delete( id );
}