Action Class Reference

Explorable function within an application. More...

#include <cc/Action>

Inheritance diagram for Action:

Public Member Functions
	Action ()
	Create a primordial action.
	Action (const String &title)
	Create a new action.
	Action (const Picture &icon)
	Create a new action.
String	title () const
	Get title.
Action &	title (const String &newValue)
	Set title
Action &	title (Definition< String > &&f)
	Define title.
Shortcut	shortcut () const
	Get shortcut.
Action &	shortcut (const Shortcut &newValue)
	Set shortcut
Action &	shortcut (Definition< Shortcut > &&f)
	Define shortcut.
Picture	icon () const
	Get icon.
Action &	icon (const Picture &newValue)
	Set icon
Action &	icon (Definition< Picture > &&f)
	Define icon.
Action &	onTriggered (Function< void()> &&f)
	Set callback
void	operator() () const
	Invoke the action's callback.
Action &	operator() (Function< void()> &&f)
	Set callback
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
template<class T >
bool	is () const
	Check if this object is of type T.
template<class T >
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.
long	useCount () const
	Reference count.

Additional Inherited Members
Protected Types inherited from Entity
using	State = Object::State
	Internal state.
using	Constructor = State *()
	Internal state constructor.
Protected Member Functions inherited from Entity
	Entity (State *newState)
	Initialize entity with newState.
	Entity (Constructor onDemand)
	Initialize a primordial entity.
template<class T >
T &	get ()
	Get access to the entity's internal state of type T.
template<class T >
const T &	get () const
	Get access to the entity's internal state.
Protected Member Functions inherited from Object
template<class T >
T	weak () const
template<class T >
void	initOnce ()
	Create the object state when called the first time.
template<class T >
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)
Static Protected Member Functions inherited from Entity
template<class T >
static State *	onDemand ()
	Convenience template for initializing primordial entities.
Static Protected Member Functions inherited from Object
template<class T >
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T >
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Explorable function within an application.

Constructor & Destructor Documentation

Action() [1/3]

Action

(

)

Create a primordial action.

Action() [2/3]

Action

(

const String &

title

)

Create a new action.

Action() [3/3]

Action

(

const Picture &

icon

)

Create a new action.

Member Function Documentation

title() [1/3]

String title

(

)

const

Get title.

title() [2/3]

Action & title

(

const String &

newValue

)

Set title

title() [3/3]

Action & title

(

Definition< String > &&

f

)

Define title.

shortcut() [1/3]

Shortcut shortcut

(

)

const

Get shortcut.

shortcut() [2/3]

Action & shortcut

(

const Shortcut &

newValue

)

Set shortcut

shortcut() [3/3]

Action & shortcut

(

Definition< Shortcut > &&

f

)

Define shortcut.

icon() [1/3]

Picture icon

(

)

const

Get icon.

icon() [2/3]

Action & icon

(

const Picture &

newValue

)

Set icon

icon() [3/3]

Action & icon

(

Definition< Picture > &&

f

)

Define icon.

onTriggered()

Action & onTriggered

(

Function< void()> &&

f

)

Set callback

operator()() [1/2]

void operator()

(

)

const

Invoke the action's callback.

operator()() [2/2]

Action & operator()

(

Function< void()> &&

f

)

Set callback