330 lines
10 KiB
C++
330 lines
10 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2019 KiCad Developers, see CHANGELOG.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
|
|
*/
|
|
|
|
#ifndef ACTION_TOOLBAR_H
|
|
#define ACTION_TOOLBAR_H
|
|
|
|
#include <map>
|
|
#include <vector>
|
|
#include <wx/bitmap.h> // Needed for the auibar include
|
|
#include <wx/aui/auibar.h>
|
|
#include <wx/aui/framemanager.h>
|
|
#include <wx/popupwin.h>
|
|
#include <wx/panel.h>
|
|
#include <tool/action_manager.h>
|
|
#include <tool/tool_action.h>
|
|
#include <tool/tool_event.h>
|
|
|
|
class ACTION_MENU;
|
|
class BITMAP_BUTTON;
|
|
class EDA_BASE_FRAME;
|
|
class TOOL_MANAGER;
|
|
|
|
/**
|
|
* A group of actions that will be displayed together on a toolbar palette.
|
|
*/
|
|
class ACTION_GROUP
|
|
{
|
|
public:
|
|
// Make the toolbar a friend so it can easily access everything inside here
|
|
friend class ACTION_TOOLBAR;
|
|
|
|
ACTION_GROUP( std::string aName, const std::vector<const TOOL_ACTION*>& aActions );
|
|
|
|
/**
|
|
* Set the default action to use when first creating the toolbar palette icon.
|
|
* If no default action is provided, the default will be the first action in the
|
|
* vector.
|
|
*
|
|
* @param aDefault is the default action.
|
|
*/
|
|
void SetDefaultAction( const TOOL_ACTION& aDefault );
|
|
|
|
/**
|
|
* Get the default action to use when first creating this group's toolbar palette icon.
|
|
*/
|
|
const TOOL_ACTION* GetDefaultAction() const { return m_defaultAction; }
|
|
|
|
/**
|
|
* Get the name of the group.
|
|
*/
|
|
std::string GetName() const { return m_name; }
|
|
|
|
/**
|
|
* Get the ID used in the UI to reference this group
|
|
*/
|
|
int GetUIId() const { return m_id + TOOL_ACTION::GetBaseUIId(); }
|
|
|
|
/**
|
|
* Get a vector of all the actions contained inside this group.
|
|
*/
|
|
const std::vector< const TOOL_ACTION*>& GetActions() const { return m_actions; }
|
|
|
|
protected:
|
|
///> The action ID for this action group
|
|
int m_id;
|
|
|
|
///> The name of this action group
|
|
std::string m_name;
|
|
|
|
///> The default action to display on the toolbar item
|
|
const TOOL_ACTION* m_defaultAction;
|
|
|
|
///> The actions that compose the group
|
|
std::vector<const TOOL_ACTION*> m_actions;
|
|
};
|
|
|
|
|
|
/**
|
|
* A popup window that contains a row of toolbar-like buttons for the user to choose from.
|
|
*/
|
|
class ACTION_TOOLBAR_PALETTE : public wxPopupTransientWindow
|
|
{
|
|
public:
|
|
/**
|
|
* Create the palette.
|
|
*
|
|
* @param aParent is the parent window
|
|
* @param aVertical is true if the palette should make the buttons a vertical line,
|
|
* false for a horizonatl line.
|
|
*/
|
|
ACTION_TOOLBAR_PALETTE( wxWindow* aParent, bool aVertical );
|
|
|
|
/**
|
|
* Add an action to the palette.
|
|
*
|
|
* @param aAction is the action to add
|
|
*/
|
|
void AddAction( const TOOL_ACTION& aAction );
|
|
|
|
/**
|
|
* Enable the button for an action on the palette.
|
|
*
|
|
* @param aAction is the action who's button should be enabled
|
|
* @param aEnable is true to enable the button, false to disable
|
|
*/
|
|
void EnableAction( const TOOL_ACTION& aAction, bool aEnable = true );
|
|
|
|
/**
|
|
* Check/Toggle the button for an action on the palette.
|
|
*
|
|
* @param aAction is the action who's button should be checked
|
|
* @param aCheck is true to check the button, false to uncheck
|
|
*/
|
|
void CheckAction( const TOOL_ACTION& aAction, bool aCheck = true );
|
|
|
|
/**
|
|
* Set the size all the buttons on this palette should be.
|
|
* This function will automatically pad all button bitmaps to ensure this
|
|
* size is met.
|
|
*
|
|
* @param aSize is the requested size of the buttons
|
|
*/
|
|
void SetButtonSize( wxRect& aSize ) { m_buttonSize = aSize; }
|
|
|
|
/**
|
|
* Popup this window
|
|
*
|
|
* @param aFocus is the window to keep focus on (if supported)
|
|
*/
|
|
void Popup( wxWindow* aFocus = nullptr ) override;
|
|
|
|
/**
|
|
* Set the action group that this palette contains the actions for
|
|
*/
|
|
void SetGroup( ACTION_GROUP* aGroup ) { m_group = aGroup; }
|
|
ACTION_GROUP* GetGroup() { return m_group; }
|
|
|
|
protected:
|
|
void onCharHook( wxKeyEvent& aEvent );
|
|
|
|
protected:
|
|
// The group that the buttons in the palette are part of
|
|
ACTION_GROUP* m_group;
|
|
|
|
///> The size each button on the toolbar should be
|
|
wxRect m_buttonSize;
|
|
|
|
///> True if the palette uses vertical buttons, false for horizontal buttons
|
|
bool m_isVertical;
|
|
|
|
wxPanel* m_panel;
|
|
wxBoxSizer* m_mainSizer;
|
|
wxBoxSizer* m_buttonSizer;
|
|
|
|
///> The buttons that act as the toolbar on the palette
|
|
std::map<int, BITMAP_BUTTON*> m_buttons;
|
|
};
|
|
|
|
|
|
/**
|
|
* ACTION_TOOLBAR
|
|
*
|
|
* Defines the structure of a toolbar with buttons that invoke ACTIONs.
|
|
*/
|
|
class ACTION_TOOLBAR : public wxAuiToolBar
|
|
{
|
|
public:
|
|
ACTION_TOOLBAR( EDA_BASE_FRAME* parent, wxWindowID id = wxID_ANY,
|
|
const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
|
|
long style = wxAUI_TB_DEFAULT_STYLE );
|
|
|
|
virtual ~ACTION_TOOLBAR();
|
|
|
|
/**
|
|
* Set the AUI manager that this toolbar belongs to.
|
|
*
|
|
* @param aManager is the AUI manager
|
|
*/
|
|
void SetAuiManager( wxAuiManager* aManager ) { m_auiManager = aManager; }
|
|
|
|
/**
|
|
* Adds a TOOL_ACTION-based button to the toolbar. After selecting the entry,
|
|
* a TOOL_EVENT command containing name of the action is sent.
|
|
*
|
|
* @param aAction is the action to add
|
|
* @param aIsToggleEntry makes the toolbar item a toggle entry when true
|
|
* @param aIsCancellable when true, cancels the tool if clicked when tool is active
|
|
*/
|
|
void Add( const TOOL_ACTION& aAction, bool aIsToggleEntry = false,
|
|
bool aIsCancellable = false );
|
|
|
|
/**
|
|
* Adds a large button such as used in the Kicad Manager Frame's launch bar.
|
|
*
|
|
* @param aAction
|
|
*/
|
|
void AddButton( const TOOL_ACTION& aAction );
|
|
|
|
/**
|
|
* Add a separator that introduces space on either side to not squash the tools
|
|
* when scaled.
|
|
*
|
|
* @param aWindow is the window to get the scaling factor of
|
|
*/
|
|
void AddScaledSeparator( wxWindow* aWindow );
|
|
|
|
/**
|
|
* Add a context menu to a specific tool item on the toolbar.
|
|
* This toolbar gets ownership of the menu object, and will delete it when the
|
|
* ClearToolbar() function is called.
|
|
*
|
|
* @param aAction is the action to get the menu
|
|
* @param aMenu is the context menu
|
|
*/
|
|
void AddToolContextMenu( const TOOL_ACTION& aAction, ACTION_MENU* aMenu );
|
|
|
|
/**
|
|
* Add a set of actions to a toolbar as a group. One action from the group will be displayed
|
|
* at a time.
|
|
*
|
|
* @param aGroup is the group to add. The first action in the group will be the first shown on the toolbar.
|
|
* @param aIsToggleEntry makes the toolbar item a toggle entry when true
|
|
*/
|
|
void AddGroup( ACTION_GROUP* aGroup, bool aIsToggleEntry = false );
|
|
|
|
/**
|
|
* Select an action inside a group
|
|
*
|
|
* @param aGroup is the group that contains the action
|
|
* @param aAction is the action inside the group
|
|
*/
|
|
void SelectAction( ACTION_GROUP* aGroup, const TOOL_ACTION& aAction );
|
|
|
|
/**
|
|
* Clear the toolbar and remove all associated menus.
|
|
*/
|
|
void ClearToolbar();
|
|
|
|
/**
|
|
* Updates the bitmap of a particular tool. Not icon-based because we use it
|
|
* for the custom-drawn layer pair bitmap.
|
|
*/
|
|
void SetToolBitmap( const TOOL_ACTION& aAction, const wxBitmap& aBitmap );
|
|
|
|
/**
|
|
* Applies the default toggle action. For checked items this is check/uncheck; for
|
|
* non-checked items it's enable/disable.
|
|
*/
|
|
void Toggle( const TOOL_ACTION& aAction, bool aState );
|
|
|
|
void Toggle( const TOOL_ACTION& aAction, bool aEnabled, bool aChecked );
|
|
|
|
static constexpr bool TOGGLE = true;
|
|
static constexpr bool CANCEL = true;
|
|
|
|
protected:
|
|
/**
|
|
* Update a group toolbar item to look like a specific action.
|
|
*
|
|
* Note: This function does not verify that the action is inside the group.
|
|
*/
|
|
void doSelectAction( ACTION_GROUP* aGroup, const TOOL_ACTION& aAction );
|
|
|
|
/**
|
|
* Popup the ACTION_TOOLBAR_PALETTE associated with the ACTION_GROUP of the
|
|
* given toolbar item.
|
|
*/
|
|
void popupPalette( wxAuiToolBarItem* aItem );
|
|
|
|
///> Handler for a mouse up/down event
|
|
void onMouseClick( wxMouseEvent& aEvent );
|
|
|
|
///> Handler for when a drag event occurs on an item
|
|
void onItemDrag( wxAuiToolBarEvent& aEvent );
|
|
|
|
///> The default tool event handler
|
|
void onToolEvent( wxAuiToolBarEvent& aEvent );
|
|
|
|
///> Handle a right-click on a menu item
|
|
void onToolRightClick( wxAuiToolBarEvent& aEvent );
|
|
|
|
///> Handle the button select inside the palette
|
|
void onPaletteEvent( wxCommandEvent& aEvent );
|
|
|
|
///> Handle the palette timer triggering
|
|
void onTimerDone( wxTimerEvent& aEvent );
|
|
|
|
///> Render the triangle in the lower-right corner that represents that an action pallette
|
|
///> is available for an item
|
|
void OnCustomRender( wxDC& aDc, const wxAuiToolBarItem& aItem,
|
|
const wxRect& aRect ) override;
|
|
|
|
protected:
|
|
// Timer used to determine when the palette should be opened after a group item is pressed
|
|
wxTimer* m_paletteTimer;
|
|
|
|
wxAuiManager* m_auiManager;
|
|
TOOL_MANAGER* m_toolManager;
|
|
ACTION_TOOLBAR_PALETTE* m_palette;
|
|
|
|
std::map<int, bool> m_toolKinds;
|
|
std::map<int, bool> m_toolCancellable;
|
|
std::map<int, const TOOL_ACTION*> m_toolActions;
|
|
std::map<int, ACTION_MENU*> m_toolMenus;
|
|
|
|
std::map<int, ACTION_GROUP*> m_actionGroups;
|
|
};
|
|
|
|
#endif
|