tool_action.h File Reference

#include <bitset>
#include <cassert>
#include <optional>
#include <string>
#include <string_view>
#include <ki_any.h>
#include <wx/string.h>

Go to the source code of this file.

Classes
class	TOOL_ACTION_GROUP
	Define a group that can be used to group actions (and their events) of similar operations. More...
class	TOOL_ACTION_ARGS
	Build up the properties of a TOOL_ACTION in an incremental manner that is static-construction safe. More...
class	TOOL_ACTION
	Represent a single user action. More...

Typedefs
typedef std::bitset< gToolbarStateNumber >	TOOLBAR_STATE_FLAGS

Enumerations
enum	TOOL_ACTION_SCOPE { AS_CONTEXT = 1 , AS_ACTIVE , AS_GLOBAL }
	Scope of tool actions. More...
enum	TOOL_ACTION_FLAGS { AF_NONE = 0 , AF_ACTIVATE = 1 , AF_NOTIFY = 2 }
	Flags for tool actions. More...
enum class	TOOLBAR_STATE { HIDDEN = 0 , TOGGLE = 1 , CANCEL = 2 , ENUM_LENGTH = 3 }
	Flags that control how actions appear and interact on the toolbar. More...

Variables
const size_t	gToolbarStateNumber = static_cast<size_t>( TOOLBAR_STATE::ENUM_LENGTH )

Typedef Documentation

TOOLBAR_STATE_FLAGS

typedef std::bitset<gToolbarStateNumber> TOOLBAR_STATE_FLAGS

Definition at line 73 of file tool_action.h.

Enumeration Type Documentation

TOOL_ACTION_FLAGS

enum TOOL_ACTION_FLAGS

Flags for tool actions.

Enumerator
AF_NONE
AF_ACTIVATE	Action activates a tool.
AF_NOTIFY	Action is a notification (it is by default passed to all tools)

Definition at line 53 of file tool_action.h.

TOOL_ACTION_SCOPE

enum TOOL_ACTION_SCOPE

Scope of tool actions.

Enumerator
AS_CONTEXT	Action belongs to a particular tool (i.e. a part of a pop-up menu)
AS_ACTIVE	All active tools.
AS_GLOBAL	Global action (toolbar/main menu event, global shortcut)

Definition at line 45 of file tool_action.h.

TOOLBAR_STATE

enum class TOOLBAR_STATE

strong

Flags that control how actions appear and interact on the toolbar.

Enumerator
HIDDEN	Action is hidden from the toolbar.
TOGGLE	Action is a toggle button on the toolbar.
CANCEL	Action can be cancelled by clicking the toolbar button again.
ENUM_LENGTH

Definition at line 61 of file tool_action.h.

Variable Documentation

gToolbarStateNumber

const size_t gToolbarStateNumber = static_cast<size_t>( TOOLBAR_STATE::ENUM_LENGTH )

Definition at line 71 of file tool_action.h.