tool_action.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2015 CERN
 * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @author Maciej Suminski <[email protected]>
 *
 * 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 __TOOL_ACTION_H
#define __TOOL_ACTION_H

#include <string>
#include <cassert>

#include <wx/string.h>

class TOOL_EVENT;

enum class BITMAPS : unsigned int;

enum TOOL_ACTION_SCOPE
{
 AS_CONTEXT = 1, 
 AS_ACTIVE, 
 AS_GLOBAL 
};

enum TOOL_ACTION_FLAGS
{
 AF_NONE = 0,
 AF_ACTIVATE = 1, 
 AF_NOTIFY = 2 
};

class TOOL_ACTION
{
public:
 TOOL_ACTION( const std::string& aName, TOOL_ACTION_SCOPE aScope = AS_CONTEXT,
 int aDefaultHotKey = 0, const std::string& aLegacyHotKeyName = "",
 const wxString& aMenuText = wxEmptyString,
 const wxString& aTooltip = wxEmptyString,
 BITMAPS aIcon = static_cast<BITMAPS>( 0 ), TOOL_ACTION_FLAGS aFlags = AF_NONE,
 void* aParam = nullptr );

 ~TOOL_ACTION();

 // TOOL_ACTIONS are singletons; don't be copying them around....
 TOOL_ACTION( const TOOL_ACTION& ) = delete;
 TOOL_ACTION& operator= ( const TOOL_ACTION& ) = delete;

 bool operator==( const TOOL_ACTION& aRhs ) const
 {
 return m_id == aRhs.m_id;
 }

 bool operator!=( const TOOL_ACTION& aRhs ) const
 {
 return m_id != aRhs.m_id;
 }

 const std::string& GetName() const { return m_name; }

 int GetDefaultHotKey() const { return m_defaultHotKey; }

 int GetHotKey() const { return m_hotKey; }
 void SetHotKey( int aKeycode );

 int GetId() const { return m_id; }

 /*
 * Get the unique ID for this action in the user interface system.
 *
 * This is simply the action ID offset by @c ACTION_BASE_UI_ID.
 *
 * @return The unique ID number for use in the user interface system.
 */
 int GetUIId() const { return m_id + ACTION_BASE_UI_ID; }

 /*
 * Get the base value used to offset the user interface IDs for the actions.
 */
 static int GetBaseUIId() { return ACTION_BASE_UI_ID; }

 TOOL_EVENT MakeEvent() const;

 wxString GetLabel() const;
 wxString GetMenuItem() const;
 wxString GetDescription( bool aIncludeHotkey = true ) const;

 TOOL_ACTION_SCOPE GetScope() const { return m_scope; }

 void* GetParam() const { return m_param; }

 std::string GetToolName() const;

 bool IsActivation() const
 {
 return m_flags & AF_ACTIVATE;
 }

 bool IsNotification() const
 {
 return m_flags & AF_NOTIFY;
 }

 const BITMAPS GetIcon() const
 {
 return m_icon;
 }

protected:
 TOOL_ACTION();

 friend class ACTION_MANAGER;

 static constexpr int ACTION_BASE_UI_ID = 20000;

 std::string m_name;
 TOOL_ACTION_SCOPE m_scope;

 const int m_defaultHotKey; // Default hot key
 int m_hotKey; // The current hotkey (post-user-settings-application)
 const std::string m_legacyName; // Name for reading legacy hotkey settings

 wxString m_label;
 wxString m_tooltip;
  BITMAPS m_icon; // Icon for the menu entry

 int m_id; // Unique ID for maps. Assigned by ACTION_MANAGER.

 TOOL_ACTION_FLAGS m_flags;
 void* m_param; // Generic parameter
};

#endif