The AboutAction class handles the pop-up "About CamiTK" with information about CamiTK. More...

#include <LoggerParameters.h>

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

virtual void	errorButtonClicked ()

virtual void	infoButtonClicked ()

virtual void	logDebugInfoChanged ()

virtual void	logFileDirectoryButtonClicked ()

virtual void	logFileDirectoryTextEditChanged ()

virtual void	loggerLevelChanged ()

virtual void	logTimeStampInfoChanged ()

virtual void	logToFileChanged ()

virtual void	logToStdOutChanged ()

virtual void	messageBoxlLevelChanged ()

virtual void	traceButtonClicked ()

virtual void	warningButtonClicked ()

Public Slots inherited from camitk::Action
virtual 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...

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...

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

Public Member Functions
virtual QWidget *	getWidget ()
	This method has to be redefined in your Action only if: More...

	LoggerParameters (camitk::ActionExtension *extension)
	Default Constructor. More...

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

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

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

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

void	setInputComponent (Component *input)
	Specify the input Components in case of only one Component. 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...

	~Action () override
	Destructor. More...

QAction *	getQAction ()
	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	getComponent () 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...

bool	getAutoUpdateProperties () const

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

virtual Q_INVOKABLE 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...

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

Private Member Functions
void	enableLogToFileParameters ()

Private Attributes
QWidget *	myWidget

Ui::ui_LoggerParameters	ui

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	setComponent (QString component)
	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 AboutAction class handles the pop-up "About CamiTK" with information about CamiTK.

Constructor & Destructor Documentation

◆ LoggerParameters()

LoggerParameters::LoggerParameters ( camitk::ActionExtension * extension )

Default Constructor.

References camitk::Action::addTag(), myWidget, camitk::Action::setComponent(), camitk::Action::setDescription(), camitk::Action::setFamily(), and camitk::Action::setName().

◆ ~LoggerParameters()

LoggerParameters::~LoggerParameters ( )

virtual

Default Destructor.

Member Function Documentation

◆ apply

Action::ApplyStatus LoggerParameters::apply ( )

virtualslot

this method is automatically called when the action is triggered.

References camitk::Action::SUCCESS.

◆ enableLogToFileParameters()

void LoggerParameters::enableLogToFileParameters ( )

private

References ui.

Referenced by getWidget(), and logToFileChanged().

◆ errorButtonClicked

void LoggerParameters::errorButtonClicked ( )

virtualslot

References CAMITK_ERROR, and ui.

Referenced by getWidget().

◆ getWidget()

QWidget * LoggerParameters::getWidget ( )

virtual

This method has to be redefined in your Action only if:

you do not have any widget to control your action (i.e. getWidget() will have to return NULL),
you do not use the default ActionWidget but another one.

In the second case, it is strongly recommanded to have a code similar to this:

QWidget *MyAction::getWidget() {
   // build or update the widget
   if (!myWidget)
       myWidget = new MyVerySpecialActionWidget(this);
   else
       // MyVerySpecialActionWidget should have an update() method
       myWidget->update();
   return myWidget;
}

The update() method in MyVerySpecialActionWidget is used in case the selection has changed since the last time the widget was shown (a change in the selection often means the targets or the parameter values have changed, the UI should be refreshed as well).

Reimplemented from camitk::Action.

References enableLogToFileParameters(), errorButtonClicked(), infoButtonClicked(), logDebugInfoChanged(), logFileDirectoryButtonClicked(), logFileDirectoryTextEditChanged(), loggerLevelChanged(), logTimeStampInfoChanged(), logToFileChanged(), logToStdOutChanged(), messageBoxlLevelChanged(), myWidget, traceButtonClicked(), ui, and warningButtonClicked().

◆ infoButtonClicked

void LoggerParameters::infoButtonClicked ( )

virtualslot

References CAMITK_INFO, and ui.

Referenced by getWidget().

◆ logDebugInfoChanged

void LoggerParameters::logDebugInfoChanged ( )

virtualslot

References ui.

Referenced by getWidget().

◆ logFileDirectoryButtonClicked

void LoggerParameters::logFileDirectoryButtonClicked ( )

virtualslot

References ui.

Referenced by getWidget().

◆ logFileDirectoryTextEditChanged

void LoggerParameters::logFileDirectoryTextEditChanged ( )

virtualslot

References ui.

Referenced by getWidget().

◆ loggerLevelChanged

void LoggerParameters::loggerLevelChanged ( )

virtualslot

References ui.

Referenced by getWidget().

◆ logTimeStampInfoChanged

void LoggerParameters::logTimeStampInfoChanged ( )

virtualslot

References ui.

Referenced by getWidget().

◆ logToFileChanged

void LoggerParameters::logToFileChanged ( )

virtualslot

References enableLogToFileParameters(), and ui.

Referenced by getWidget().

◆ logToStdOutChanged

void LoggerParameters::logToStdOutChanged ( )

virtualslot

References ui.

Referenced by getWidget().

◆ messageBoxlLevelChanged

void LoggerParameters::messageBoxlLevelChanged ( )

virtualslot

References ui.

Referenced by getWidget().

◆ traceButtonClicked

void LoggerParameters::traceButtonClicked ( )

virtualslot

References CAMITK_TRACE, and ui.

Referenced by getWidget().

◆ warningButtonClicked

void LoggerParameters::warningButtonClicked ( )

virtualslot

References CAMITK_WARNING, and ui.

Referenced by getWidget().

Member Data Documentation

◆ myWidget

QWidget* LoggerParameters::myWidget

private

Referenced by getWidget(), and LoggerParameters().

◆ ui

Ui::ui_LoggerParameters LoggerParameters::ui

private

Referenced by enableLogToFileParameters(), errorButtonClicked(), getWidget(), infoButtonClicked(), logDebugInfoChanged(), logFileDirectoryButtonClicked(), logFileDirectoryTextEditChanged(), loggerLevelChanged(), logTimeStampInfoChanged(), logToFileChanged(), logToStdOutChanged(), messageBoxlLevelChanged(), traceButtonClicked(), and warningButtonClicked().

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

Public Slots

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LoggerParameters()

◆ ~LoggerParameters()

Member Function Documentation

◆ apply

◆ enableLogToFileParameters()

◆ errorButtonClicked

◆ getWidget()

◆ infoButtonClicked

◆ logDebugInfoChanged

◆ logFileDirectoryButtonClicked

◆ logFileDirectoryTextEditChanged

◆ loggerLevelChanged

◆ logTimeStampInfoChanged

◆ logToFileChanged

◆ logToStdOutChanged

◆ messageBoxlLevelChanged

◆ traceButtonClicked

◆ warningButtonClicked

Member Data Documentation

◆ myWidget

◆ ui