The CloseAllAction class allows one to close all selected component in the current application. More...

#include <CloseAllAction.h>

Inheritance diagram for CloseAllAction:

Collaboration diagram for CloseAllAction:

Public Slots
virtual camitk::Action::ApplyStatus	apply ()
	this method is automatically called when the action is triggered. More...

Public Slots inherited from camitk::Action
virtual camitk::Action::ApplyStatus	apply ()=0
	This method is called when the action has to be applied on the target list (get the target lists using getTargets()) It calls the algorithm of your action on the target list of components. More...

camitk::Action::ApplyStatus	applyAndRegister ()
	This method is called whenever the action has to be applied on the target list (like the apply()) method AND registered within the application history of actions. More...

camitk::Action::ApplyStatus	trigger (QWidget *parent=nullptr)
	This method triggers the action. More...

Public Member Functions
	CloseAllAction (camitk::ActionExtension *)
	Default Constructor. More...

virtual QWidget *	getWidget ()
	Returns NULL: no permanent widget for this action. The GUI is run shown a one-shot dialog in apply. More...

virtual	~CloseAllAction ()
	Default Destructor. More...

Public Member Functions inherited from camitk::Action
	Action (ActionExtension *)
	Default Constructor: the ActionExtension is needed. More...

	~Action () override
	Destructor. More...

virtual QAction *	getQAction (Component *target=nullptr)
	Get the corresponding QAction. More...

QString	getName () const
	get the name of the action More...

QString	getDescription () const
	the description of the action More...

QString	getComponentClassName () const
	the name of the component class that can be used by this action More...

QString	getFamily () const
	the name of the family in which this action is associated More...

QString	getExtensionName () const
	the name of the extension in the family in which this action is associated More...

QStringList	getTag () const
	the name of the tag called this action More...

bool	getEmbedded () const
	argument use to know if the widget is embedded or not More...

virtual QPixmap	getIcon ()
	the icon to personalize the action (no icon by default) More...

const ComponentList	getTargets () const
	the currently selected and valid (regarding the component property) components, for which this action is called More...

void	updateTargets ()
	update the target list using the currently selected components More...

bool	getAutoUpdateProperties () const

void	setAutoUpdateProperties (bool)
	are the properties to be updated every time the user makes a change in the widget (default is false)? More...

virtual Q_INVOKABLE camitk::Property *	getProperty (QString name)
	Get a Property given its name. More...

virtual bool	addParameter (Property *)
	Add a new parameter to the action, using the CamiTK property class. More...

void	applyTargetPosition (Component input, Component target)
	Change the target frame according to the default frame policy regarding the input's one. More...

void	applyTargetPosition (Component input, Component target, Application::TargetPositionningPolicy policy)
	Change the target frame according to a given frame policy regarding the input's one. More...

virtual QVariant	toVariant () const override

virtual void	fromVariant (const QVariant &) override
	Load data from a QVariant to initialize the current object. More...

ApplyStatus	applyInPipeline ()
	This method encapsulates the apply() method. More...

void	setInputComponents (ComponentList inputs)
	Specify the input Component(s) Only applyInPipeline() should be called with this method (maybe apply), but not trigger() as its first intruction is to clear the target components list !!! More...

void	setInputComponent (Component *input)
	Specify the input Components in case of only one Component. More...

ComponentList	getOutputComponents ()
	Returns the output Component(s) More...

Component *	getOutputComponent ()
	Returns the output Components in case of only one Component. More...

Additional Inherited Members
Public Types inherited from camitk::Action
enum	ApplyStatus { SUCCESS , ERROR , WARNING , ABORTED , TRIGGERED }
	describes what happened during the application of an algorithm (i.e. results of the apply method) More...

Static Public Member Functions inherited from camitk::Action
static QString	getStatusAsString (ApplyStatus)

Protected Member Functions inherited from camitk::Action
void	setName (QString name)

void	setDescription (QString description)
	the description of the action More...

void	setComponentClassName (QString componentClassName)
	set the name of the component class that can be used by this action More...

void	setFamily (QString family)
	the name of the family in which this action is associated More...

void	addTag (QString tag)
	add a tag to the tags list of this action More...

void	setEmbedded (bool isEmbedded)
	set the embedded property (an action is embedded by default, unless specified otherwise by explicitly calling this method with false) More...

void	setIcon (QPixmap)
	set the Pixmap More...

Protected Attributes inherited from camitk::Action
QWidget *	actionWidget
	the action widget More...

Detailed Description

The CloseAllAction class allows one to close all selected component in the current application.

Constructor & Destructor Documentation

◆ CloseAllAction()

CloseAllAction::CloseAllAction ( camitk::ActionExtension * extension )

Default Constructor.

References camitk::Action::addTag(), camitk::Action::setComponentClassName(), camitk::Action::setDescription(), camitk::Action::setEmbedded(), camitk::Action::setFamily(), camitk::Action::setIcon(), and camitk::Action::setName().

Here is the call graph for this function:

◆ ~CloseAllAction()

CloseAllAction::~CloseAllAction ( )

virtual

Default Destructor.

Member Function Documentation

◆ apply

Action::ApplyStatus CloseAllAction::apply ( )

virtualslot

this method is automatically called when the action is triggered.

It gets all the targets' top level component and close them.

References camitk::Action::ABORTED, CAMITK_TRACE, and camitk::Action::SUCCESS.

◆ getWidget()

QWidget * CloseAllAction::getWidget ( )

virtual

Returns NULL: no permanent widget for this action. The GUI is run shown a one-shot dialog in apply.

Reimplemented from camitk::Action.

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

Public Slots

Public Member Functions