igor::iAction Class Reference

#include <iAction.h>

Inherited by igor::iActionApplicationStop, igor::iActionCopyEntity, igor::iActionCreateEntity, igor::iActionCreateMaterial, igor::iActionCreateScene, igor::iActionCreateShader, igor::iActionCreateSprite, igor::iActionCutEntity, igor::iActionDeleteEntity, igor::iActionDuplicateEntity, igor::iActionLoadProject, igor::iActionPasteEntity, igor::iActionSetEntityActive, and igor::iActionSetEntityInactive.

Public Member Functions
	iAction (const iaString &name)
virtual	~iAction ()=default
virtual void	execute (const iActionContext &context)=0
virtual bool	isCompatible (const iActionContext &context)=0
iaString	getName () const
void	setDescription (const iaString &brief, const iaString &description="")
const iaString &	getBrief () const
const iaString &	getDescription () const
void	setIcon (const iaString &alias)
const iaString &	getIcon () const

Detailed Description

action base class

Constructor & Destructor Documentation

iAction()

igor::iAction::iAction

(

const iaString &

name

)

init members

Parameters

name	the identifier of this action

must be a unique name so it can be registered with the action manager

~iAction()

virtual igor::iAction::~iAction ( )

virtualdefault

does nothing

Member Function Documentation

execute()

virtual void igor::iAction::execute ( const iActionContext &  context )

pure virtual

executed when action gets triggered

Parameters

context

the context the action was called with

Implemented in igor::iActionApplicationStop, igor::iActionCreateScene, igor::iActionCreateMaterial, igor::iActionCreateShader, igor::iActionLoadProject, igor::iActionCreateSprite, igor::iActionSetEntityActive, igor::iActionSetEntityInactive, igor::iActionDeleteEntity, igor::iActionCopyEntity, igor::iActionCutEntity, igor::iActionPasteEntity, igor::iActionCreateEntity, and igor::iActionDuplicateEntity.

getBrief()

const iaString & igor::iAction::getBrief

(

)

const

Returns

the brief description

getDescription()

const iaString & igor::iAction::getDescription

(

)

const

Returns

the full description

getIcon()

const iaString & igor::iAction::getIcon

(

)

const

Returns

the icon texture of this action

getName()

iaString igor::iAction::getName

(

)

const

Returns

the action identifier

isCompatible()

virtual bool igor::iAction::isCompatible ( const iActionContext &  context )

pure virtual

Returns

true if this action will execute with given context

Parameters

context

the context the action was called with

Implemented in igor::iActionApplicationStop, igor::iActionCreateScene, igor::iActionCreateMaterial, igor::iActionCreateShader, igor::iActionLoadProject, igor::iActionCreateSprite, igor::iActionSetEntityActive, igor::iActionSetEntityInactive, igor::iActionDeleteEntity, igor::iActionCopyEntity, igor::iActionCutEntity, igor::iActionPasteEntity, igor::iActionCreateEntity, and igor::iActionDuplicateEntity.

setDescription()

void igor::iAction::setDescription	(	const iaString &	brief,
		const iaString &	description = ""
	)

sets text of action

Parameters

brief	the brief description
description	the full description

setIcon()

void igor::iAction::setIcon

(

const iaString &

alias

)

sets icon of the action

Parameters

alias

alias or id of icon

---

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

• /home/martin/dev/Igor/src/igor/igor/ui/actions/iAction.h
• /home/martin/dev/Igor/src/igor/igor/ui/actions/iAction.cpp