ToolFlag Class Reference

List of all members.

Public Slots
void	CheckedEnables (int state)
void	CheckedDisables (int state)
void	UncheckedEnables (int state)
void	UncheckedDisables (int state)
void	IndexChanged (const QString &text)
Public Member Functions
	ToolFlag (const QString &flag)
	ToolFlag (const QString &flag, const QStringList &params)
ToolFlag *	Clone ()
void	Initialize (ProcessSettings *settings, const QHash< QString, QStringList > &possibleFiles)
void	DetachFromGui (ProcessSettings *settings)
void	LoadFromXml (QXmlStreamReader &xml)
void	SaveToXml (QXmlStreamWriter &xml)
bool	AppendFlag (QStringList *args, VolumeIndex *index, const QString &fileNameOverride, Tool *tool, QHash< QString, QStringList > &outputFiles)
void	InitializeDependencies (QHash< QString, ToolFlag * > &flagList)
QString	GetFlag ()
bool	IsEnabled ()
bool	IsRequired ()
bool	IsAdvanced ()
QPoint	GetNextGridPos ()
QString	GetDescription ()
QString	GetFullDescription ()
int	GetMaxControlCount ()
void	ClearElements ()
void	UpdateStatus (int state, bool checkedState, bool enabledState)
Static Public Member Functions
static ToolFlag *	CreateFromXml (QXmlStreamReader &xml, int &basicCount, int &advancedCount)

---

Member Function Documentation

void ToolFlag::LoadFromXml

(

QXmlStreamReader &

xml )

Reads an Argument or Checkbox from xml. Any number of these can be used to append values to the tool's comman line arguments. Arguments and checkboxes differ only in that a checkbox needs to be selected to be appended.

Required Elements

• Checkbox or Argument - Each argument is surrounded by either checkbox or argument tags.
  • flag - A unique string id flag for this flag. This flag will automatically be appended to the command line.
  • default - Is this flag enabled by default? Default value [false].
  • required - Can this checkbox be disabled? Default value [false].
  • advanced - Is this an advanced flag. Advanced flags will appear in a separate location from the beginning flags. Default value [false].

• Description - A short description about what the flag does.

• MoreInfo - A more lengthy explanation of the tool. This information will only be displayed if it is asked for from the user. Therefore it should be much more descriptive.

• Dependency - A requirement that this flag can only be enabled/disabled if the given dependent flag is enabled/disabled.
  • enables - The specified flag enables this flag if true, disables if false. Default [false].
  • checked - The flag is enabled/disabled if the specified flag is checked/unchecked. Default [false].

Other Elements

Any number of elements that are supported by ToolFlagElement. See ToolFlagElement::LoadFromXml() for more details.

---

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

• C:/CRCNS/Development/code/iris/ToolFlag.h
• C:/CRCNS/Development/code/iris/ToolFlag.cpp