VolVis::Commands::Command Class Reference

#include <Command.h>

Inheritance diagram for VolVis::Commands::Command:

---

Detailed Description

Abstract base class for all commands which for example can be applied to the menu of the main window. Uses the command pattern for encapsulating invocation. Additionally, contains two strings for the title and the status tip of the action. This is convenient for using a command for the gui. Otherwise these strings are not needed. The CommandFactory provides a simple way of creating command objects.

See also:

CommandFactory

Public Slots
virtual void	execute ()=0
Public Member Functions
	Command (QString &title=tr(""), QString &statusTip=tr(""))
const QString &	getStatusTip () const
const QString &	getTitle () const
void	setStatusTip (QString &statusTip)
void	setTitle (QString &title)

---

Constructor & Destructor Documentation

VolVis::Commands::Command::Command	(	QString &	title = tr(""),
		QString &	statusTip = tr("")
	)			[inline]

Constructor. Defines the title and statusTip of the command. Default values for both are empty strings.

Parameters:

	title	The title is e.g. displayed in the menu. Default value is an empty string.
	statusTip	This string is displayed in the status bar e.g. when the mouse rolls over the menu item.

---

Member Function Documentation

virtual void VolVis::Commands::Command::execute

(

)

[pure virtual, slot]

This slot is called by the object which wants the command to be executed. It has to be implemented by each subclass.

Implemented in VolVis::Commands::ChangeQualityCommand, VolVis::Commands::DoNothingCommand, VolVis::Commands::ExitCommand, VolVis::Commands::HiResCommand, VolVis::Commands::OpenTFCommand, VolVis::Commands::OpenVolumeDataCommand, VolVis::Commands::RenderCommand, VolVis::Commands::RenderHiResCommand, VolVis::Commands::ResetTransformationsCommand, VolVis::Commands::ResizeWindowCommand, VolVis::Commands::SaveTFCommand, VolVis::Commands::ScreenshotCommand, VolVis::Commands::SetRenderModeCommand, VolVis::Commands::SetSlicingAxisCommand, VolVis::Commands::UpdateAveragingParametersCommand, VolVis::Commands::UpdateClippingCommand, VolVis::Commands::UpdateCompositingParametersCommand, VolVis::Commands::UpdateFirstHitParametersCommand, VolVis::Commands::UpdateLightingCommand, VolVis::Commands::UpdateMipParametersCommand, VolVis::Commands::UpdateRaycastingParametersCommand, and VolVis::Commands::UpdateSlicingParametersCommand.

const QString& VolVis::Commands::Command::getStatusTip

(

)

const [inline]

Returns the status tip of the command.

Returns:

status tip of the command.

const QString& VolVis::Commands::Command::getTitle

(

)

const [inline]

Returns the title of the command.

Returns:

title of the command.

void VolVis::Commands::Command::setStatusTip

(

QString &

statusTip

)

[inline]

Defines a new status tip for the command which may be displayed in the status bar at several events.

Parameters:

statusTip

new status tip.

void VolVis::Commands::Command::setTitle

(

QString &

title

)

[inline]

Defines a new title for the command which e.g. is displayed in the menu.

Parameters:

title

new title.

---

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

• Command.h

---