MacroCommandParameter Class Reference

#include <macroeditor.h>

Inheritance diagram for MacroCommandParameter:

Collaboration diagram for MacroCommandParameter:

Classes
struct	MetaData

Public Types
enum	InputType { DIRECT, REFERENCE, SEQUENCE_SINGLE, SEQUENCE_LIST }
enum	SequenceMode {   UP, DOWN, ALTERNATE_IN_UP, ALTERNATE_IN_DOWN,   ALTERNATE_OUT_UP, ALTERNATE_OUT_DOWN, RANDOM, PSEUDO_RANDOM }

Public Slots
void	setMinimum (int min)
void	setMaximum (int max)
void	setStep (int step)
void	setResolution (int resolution)

Public Member Functions
void	setName (const std::string &name)
void	setType (InputType type)
void	setValue (const std::string &value)
void	setUnit (const std::string &unit)
void	setAvailableReferences (const std::vector< std::string > &refs)
void	setReference (const std::string &ref)
void	setList (const std::string &list)
void	setMode (SequenceMode mode)
void	createGUI (MacroCommandReproMacro *)
QTreeWidgetItem *	listItem () const
void	updatedReferences (const std::string &name, bool added)
const std::string &	name () const
InputType	type () const
const std::string &	value () const
const std::string &	unit () const
const std::string &	reference () const
int	min () const
int	max () const
int	step () const
int	resolution () const
const std::string &	list () const
SequenceMode	mode () const
Public Member Functions inherited from DetailElement< MacroCommandReproMacro >
QWidget *	detailView () const
Public Member Functions inherited from GUIElement< MacroCommandReproMacro >
virtual	~GUIElement ()
MacroCommandReproMacro *	owner () const

Additional Inherited Members
Protected Attributes inherited from DetailElement< MacroCommandReproMacro >
QWidget *	DetailView
Protected Attributes inherited from GUIElement< MacroCommandReproMacro >
bool	GuiCreated
MacroCommandReproMacro *	Owner

Detailed Description

Represents a parameter for the Macro or Repro command

May be one of the following types:

• Direct: Tuple of name and value (plus unit)
• Reference: One of the parameters from the surrounding macro
• Sequence (single): One single sequence construct
• Sequence (list): Allows free editing of the sequence parameter (for multiple sequences or a plain list)

Member Enumeration Documentation

enum InputType

strong

Enumerator
DIRECT
REFERENCE
SEQUENCE_SINGLE
SEQUENCE_LIST

enum SequenceMode

strong

Enumerator
UP
DOWN
ALTERNATE_IN_UP
ALTERNATE_IN_DOWN
ALTERNATE_OUT_UP
ALTERNATE_OUT_DOWN
RANDOM
PSEUDO_RANDOM

Member Function Documentation

void setName

(

const std::string &

name

)

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::name().

void setType

(

InputType

type

)

References MacroCommandParameter::DIRECT, GUIElement< MacroCommandReproMacro >::GuiCreated, MacroCommandParameter::REFERENCE, MacroCommandParameter::SEQUENCE_LIST, MacroCommandParameter::SEQUENCE_SINGLE, and MacroCommandParameter::type().

void setValue

(

const std::string &

value

)

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::name().

void setUnit

(

const std::string &

unit

)

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::name().

void setAvailableReferences

(

const std::vector< std::string > &

refs

)

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::Reference.

void setReference

(

const std::string &

ref

)

References GUIElement< MacroCommandReproMacro >::GuiCreated, MacroCommandParameter::name(), and MacroCommandParameter::Reference.

void setMinimum ( int  min )

slot

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::value().

Referenced by MacroCommandParameter::createGUI().

void setMaximum ( int  max )

slot

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::value().

Referenced by MacroCommandParameter::createGUI().

void setStep ( int  step )

slot

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::value().

Referenced by MacroCommandParameter::createGUI().

void setResolution ( int  resolution )

slot

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::value().

Referenced by MacroCommandParameter::createGUI().

void setList

(

const std::string &

list

)

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::list().

void setMode

(

SequenceMode

mode

)

References GUIElement< MacroCommandReproMacro >::GuiCreated, and MacroCommandParameter::mode().

void createGUI ( MacroCommandReproMacro *  )

virtual

Implements GUIElement< MacroCommandReproMacro >.

References DetailElement< MacroCommandReproMacro >::DetailView, MacroCommandParameter::DIRECT, GUIElement< MacroCommandReproMacro >::GuiCreated, MacroCommandParameter::REFERENCE, MacroCommandParameter::Reference, MacroCommandParameter::SEQUENCE_LIST, MacroCommandParameter::SEQUENCE_SINGLE, MacroCommandParameter::setMaximum(), MacroCommandParameter::setMinimum(), MacroCommandParameter::setResolution(), and MacroCommandParameter::setStep().

Referenced by MacroCommandReproMacro::addParameter(), and MacroCommandReproMacro::createGUI().

QTreeWidgetItem* listItem ( ) const

inline

Referenced by MacroCommandReproMacro::addParameter(), MacroCommandReproMacro::createGUI(), and MacroCommandReproMacro::removeParameter().

void updatedReferences	(	const std::string &	name,
		bool	added
	)

References GUIElement< MacroCommandReproMacro >::GuiCreated, MacroCommandParameter::name(), and MacroCommandParameter::Reference.

Referenced by MacroCommandReproMacro::updateParameterReferences().

const std::string& name ( void  ) const

inline

Referenced by MacroCommandParameter::setName(), MacroCommandParameter::setReference(), MacroCommandParameter::setUnit(), MacroCommandParameter::setValue(), and MacroCommandParameter::updatedReferences().

InputType type ( void  ) const

inline

Referenced by MacroFileWriter::formatValue(), and MacroCommandParameter::setType().

const std::string& value ( void  ) const

inline

Referenced by MacroFileWriter::formatValue(), MacroCommandParameter::setMaximum(), MacroCommandParameter::setMinimum(), MacroCommandParameter::setResolution(), and MacroCommandParameter::setStep().

const std::string& unit ( void  ) const

inline

Referenced by MacroFileWriter::formatValue().

const std::string& reference ( void  ) const

inline

References MacroCommandParameter::Reference.

Referenced by MacroFileWriter::formatValue().

int min ( void  ) const

inline

Referenced by MacroFileWriter::formatValue().

int max ( void  ) const

inline

Referenced by MacroFileWriter::formatValue().

int step ( ) const

inline

Referenced by MacroFileWriter::formatValue().

int resolution ( ) const

inline

Referenced by MacroFileWriter::formatValue().

const std::string& list ( ) const

inline

Referenced by MacroFileWriter::formatValue(), and MacroCommandParameter::setList().

SequenceMode mode ( void  ) const

inline

Referenced by MacroFileWriter::formatValue(), and MacroCommandParameter::setMode().

Member Data Documentation

std::string Value

std::vector<std::string> AvailableReferences

std::string Reference

Referenced by MacroCommandParameter::createGUI(), MacroCommandParameter::reference(), MacroCommandParameter::setAvailableReferences(), MacroCommandParameter::setReference(), and MacroCommandParameter::updatedReferences().

int Min = 0

int Max = 100

int Step = 1

int Resolution = 1

SequenceMode Mode = SequenceMode::UP

std::string List

QLineEdit* Value

QLineEdit* Unit

QComboBox* References

QSpinBox* Min

QSpinBox* Max

QSpinBox* Step

QSpinBox* Resolution

QComboBox* Mode

QLineEdit* List

---

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

• macroeditor.h
• macroeditor.cc