neogfx::action Class Reference

#include <action.hpp>

Inheritance diagram for neogfx::action:

Public Types
typedef i_action	abstract_type

Public Member Functions
	define_declared_event (Triggered, triggered) define_declared_event(Hovered
hovered	define_declared_event (Enabled, enabled) define_declared_event(Disabled
hovered disabled	define_declared_event (Checked, checked) define_declared_event(Unchecked
hovered disabled unchecked define_declared_event(Changed, changed) public	action (string const &aText)
	action (string const &aText, string const &aImageUri, dimension aDpiScaleFactor=1.0, texture_sampling aSampling=texture_sampling::Scaled)
	action (string const &aText, const i_texture &aImage)
	action (string const &aText, const i_image &aImage)
	action (i_action_container &aContainer)
	action (i_action_container &aContainer, string const &aText)
	action (i_action_container &aContainer, string const &aText, string const &aImageUri, dimension aDpiScaleFactor=1.0, texture_sampling aSampling=texture_sampling::Scaled)
	action (i_action_container &aContainer, string const &aText, const i_texture &aImage)
	action (i_action_container &aContainer, string const &aText, const i_image &aImage)
bool	is_enabled () const override
bool	is_disabled () const override
bool	is_checkable () const override
bool	is_checked () const override
bool	is_unchecked () const override
uuid const &	group () const override
bool	is_separator () const override
i_string const &	text () const override
i_string const &	menu_text () const override
i_string const &	button_text () const override
i_string const &	tool_tip_text () const override
i_string const &	help_text () const override
const i_texture &	image () const override
const i_texture &	checked_image () const override
const optional_key_sequence &	shortcut () const override
action &	set_enabled (bool aEnabled) override
action &	set_checkable (bool aCheckable=true) override
action &	set_checked (bool aChecked) override
action &	set_group (uuid const &aGroup) override
action &	set_separator (bool aIsSeparator) override
action &	set_text (i_optional< i_string > const &aText=optional_text()) override
action &	set_menu_text (i_optional< i_string > const &aMenuText=optional_text()) override
action &	set_button_text (i_optional< i_string > const &aButtonText=optional_text()) override
action &	set_tool_tip_text (i_optional< i_string > const &aToolTipText=optional_text()) override
action &	set_help_text (i_optional< i_string > const &aHelpText=optional_text()) override
action &	set_image (const i_texture &aTexture) override
action &	set_checked_image (const i_texture &aTexture) override
action &	set_shortcut (const optional_key_sequence &aShortcut) override
action &	set_shortcut (i_string const &aShortcut) override
virtual i_action &	set_text (i_optional< i_string > const &aText)=0
i_action &	set_text (optional_text const &aText=optional_text{})
virtual i_action &	set_menu_text (i_optional< i_string > const &aMenuText)=0
i_action &	set_menu_text (optional_text const &aMenuText=optional_text{})
virtual i_action &	set_button_text (i_optional< i_string > const &aButtonText)=0
i_action &	set_button_text (optional_text const &aButtonText=optional_text{})
virtual i_action &	set_tool_tip_text (i_optional< i_string > const &aToolTipText)=0
i_action &	set_tool_tip_text (optional_text const &aToolTipText=optional_text{})
virtual i_action &	set_help_text (i_optional< i_string > const &aHelpText)=0
i_action &	set_help_text (optional_text const &aHelpText=optional_text{})
virtual i_action &	set_image (i_texture const &aTexture)=0
i_action &	set_image (std::string const &aUri, dimension aDpiScaleFactor=1.0, texture_sampling aSampling=texture_sampling::Scaled)
i_action &	set_image (i_image const &aImage)
virtual i_action &	set_checked_image (i_texture const &aTexture)=0
i_action &	set_checked_image (std::string const &aUri, dimension aDpiScaleFactor=1.0, texture_sampling aSampling=texture_sampling::Scaled)
i_action &	set_checked_image (i_image const &aImage)
virtual i_action &	set_shortcut (optional_key_sequence const &aShortcut)=0
virtual i_action &	set_shortcut (i_string const &aShortcut)=0
i_action &	set_shortcut (std::string const &aShortcut)
Public Member Functions inherited from neolib::reference_counted< Base, DeallocateOnRelease >
	reference_counted () noexcept
	reference_counted (const reference_counted &aOther) noexcept
	~reference_counted ()
reference_counted &	operator= (const reference_counted &)
void	add_ref () const noexcept override
void	release () const override
int32_t	use_count () const noexcept override
const base_type *	release_and_take_ownership () const override
base_type *	release_and_take_ownership () override
void	pin () const noexcept override
void	unpin () const override
i_ref_control_block &	control_block () override

Detailed Description

Definition at line 29 of file action.hpp.

Member Typedef Documentation

abstract_type

typedef i_action neogfx::action::abstract_type

Definition at line 32 of file action.hpp.

Constructor & Destructor Documentation

action() [1/9]

hovered disabled unchecked define_declared_event(Changed, changed) public neogfx::action::action

(

string const &

aText

)

action() [2/9]

neogfx::action::action	(	string const &	aText,
		string const &	aImageUri,
		dimension	aDpiScaleFactor = 1.0,
		texture_sampling	aSampling = texture_sampling::Scaled
	)

action() [3/9]

neogfx::action::action	(	string const &	aText,
		const i_texture &	aImage
	)

action() [4/9]

neogfx::action::action	(	string const &	aText,
		const i_image &	aImage
	)

action() [5/9]

neogfx::action::action

(

i_action_container &

aContainer

)

action() [6/9]

neogfx::action::action	(	i_action_container &	aContainer,
		string const &	aText
	)

action() [7/9]

neogfx::action::action	(	i_action_container &	aContainer,
		string const &	aText,
		string const &	aImageUri,
		dimension	aDpiScaleFactor = 1.0,
		texture_sampling	aSampling = texture_sampling::Scaled
	)

action() [8/9]

neogfx::action::action	(	i_action_container &	aContainer,
		string const &	aText,
		const i_texture &	aImage
	)

action() [9/9]

neogfx::action::action	(	i_action_container &	aContainer,
		string const &	aText,
		const i_image &	aImage
	)

Member Function Documentation

button_text()

i_string const & neogfx::action::button_text ( ) const

override

checked_image()

const i_texture & neogfx::action::checked_image ( ) const

override

define_declared_event() [1/3]

hovered disabled neogfx::action::define_declared_event	(	Checked	,
		checked
	)

define_declared_event() [2/3]

hovered neogfx::action::define_declared_event	(	Enabled	,
		enabled
	)

define_declared_event() [3/3]

neogfx::action::define_declared_event	(	Triggered	,
		triggered
	)

group()

uuid const & neogfx::action::group ( ) const

override

help_text()

i_string const & neogfx::action::help_text ( ) const

override

image()

const i_texture & neogfx::action::image ( ) const

override

is_checkable()

bool neogfx::action::is_checkable ( ) const

override

is_checked()

bool neogfx::action::is_checked ( ) const

override

is_disabled()

bool neogfx::action::is_disabled ( ) const

override

is_enabled()

bool neogfx::action::is_enabled ( ) const

override

is_separator()

bool neogfx::action::is_separator ( ) const

override

is_unchecked()

bool neogfx::action::is_unchecked ( ) const

override

menu_text()

i_string const & neogfx::action::menu_text ( ) const

override

set_button_text() [1/3]

virtual i_action & neogfx::i_action::set_button_text

(

i_optional< i_string > const &

aButtonText

)

set_button_text() [2/3]

action & neogfx::action::set_button_text ( i_optional< i_string > const &  aButtonText = optional_text() )

override

set_button_text() [3/3]

i_action & neogfx::i_action::set_button_text ( optional_text const &  aButtonText = optional_text{} )

inline

Definition at line 107 of file i_action.hpp.

set_checkable()

action & neogfx::action::set_checkable ( bool  aCheckable = true )

override

set_checked()

action & neogfx::action::set_checked ( bool  aChecked )

override

set_checked_image() [1/4]

action & neogfx::action::set_checked_image ( const i_texture &  aTexture )

override

set_checked_image() [2/4]

i_action & neogfx::i_action::set_checked_image ( i_image const &  aImage )

inline

Definition at line 131 of file i_action.hpp.

set_checked_image() [3/4]

virtual i_action & neogfx::i_action::set_checked_image

(

i_texture const &

aTexture

)

set_checked_image() [4/4]

i_action & neogfx::i_action::set_checked_image ( std::string const &  aUri, dimension  aDpiScaleFactor = 1.0, texture_sampling  aSampling = texture_sampling::Scaled  )

inline

Definition at line 127 of file i_action.hpp.

set_enabled()

action & neogfx::action::set_enabled ( bool  aEnabled )

override

set_group()

action & neogfx::action::set_group ( uuid const &  aGroup )

override

set_help_text() [1/3]

virtual i_action & neogfx::i_action::set_help_text

(

i_optional< i_string > const &

aHelpText

)

set_help_text() [2/3]

action & neogfx::action::set_help_text ( i_optional< i_string > const &  aHelpText = optional_text() )

override

set_help_text() [3/3]

i_action & neogfx::i_action::set_help_text ( optional_text const &  aHelpText = optional_text{} )

inline

Definition at line 115 of file i_action.hpp.

set_image() [1/4]

action & neogfx::action::set_image ( const i_texture &  aTexture )

override

set_image() [2/4]

i_action & neogfx::i_action::set_image ( i_image const &  aImage )

inline

Definition at line 123 of file i_action.hpp.

set_image() [3/4]

virtual i_action & neogfx::i_action::set_image

(

i_texture const &

aTexture

)

set_image() [4/4]

i_action & neogfx::i_action::set_image ( std::string const &  aUri, dimension  aDpiScaleFactor = 1.0, texture_sampling  aSampling = texture_sampling::Scaled  )

inline

Definition at line 119 of file i_action.hpp.

set_menu_text() [1/3]

virtual i_action & neogfx::i_action::set_menu_text

(

i_optional< i_string > const &

aMenuText

)

set_menu_text() [2/3]

action & neogfx::action::set_menu_text ( i_optional< i_string > const &  aMenuText = optional_text() )

override

set_menu_text() [3/3]

i_action & neogfx::i_action::set_menu_text ( optional_text const &  aMenuText = optional_text{} )

inline

Definition at line 103 of file i_action.hpp.

set_separator()

action & neogfx::action::set_separator ( bool  aIsSeparator )

override

set_shortcut() [1/5]

action & neogfx::action::set_shortcut ( const optional_key_sequence &  aShortcut )

override

set_shortcut() [2/5]

action & neogfx::action::set_shortcut ( i_string const &  aShortcut )

override

set_shortcut() [3/5]

virtual i_action & neogfx::i_action::set_shortcut

(

i_string const &

aShortcut

)

set_shortcut() [4/5]

virtual i_action & neogfx::i_action::set_shortcut

(

optional_key_sequence const &

aShortcut

)

set_shortcut() [5/5]

i_action & neogfx::i_action::set_shortcut ( std::string const &  aShortcut )

inline

Definition at line 135 of file i_action.hpp.

set_text() [1/3]

virtual i_action & neogfx::i_action::set_text

(

i_optional< i_string > const &

aText

)

set_text() [2/3]

action & neogfx::action::set_text ( i_optional< i_string > const &  aText = optional_text() )

override

set_text() [3/3]

i_action & neogfx::i_action::set_text ( optional_text const &  aText = optional_text{} )

inline

Definition at line 99 of file i_action.hpp.

set_tool_tip_text() [1/3]

virtual i_action & neogfx::i_action::set_tool_tip_text

(

i_optional< i_string > const &

aToolTipText

)

set_tool_tip_text() [2/3]

action & neogfx::action::set_tool_tip_text ( i_optional< i_string > const &  aToolTipText = optional_text() )

override

set_tool_tip_text() [3/3]

i_action & neogfx::i_action::set_tool_tip_text ( optional_text const &  aToolTipText = optional_text{} )

inline

Definition at line 111 of file i_action.hpp.

shortcut()

const optional_key_sequence & neogfx::action::shortcut ( ) const

override

text()

i_string const & neogfx::action::text ( ) const

override

tool_tip_text()

i_string const & neogfx::action::tool_tip_text ( ) const

override

---

The documentation for this class was generated from the following file:

• include/neogfx/app/action.hpp