Cantor::DefaultVariableModel Class Reference

#include <defaultvariablemodel.h>

Inheritance diagram for Cantor::DefaultVariableModel:

Classes
struct	Variable

Public Slots
void	addVariable (const QString &name, const QString &value)
void	addVariable (const Variable &variable)
void	clearVariables ()
void	removeVariable (const QString &name)
void	removeVariable (const Variable &variable)

Public Member Functions
	DefaultVariableModel (Session *session)
virtual	~DefaultVariableModel ()
Session *	session () const

Protected Types
enum	Column { NameColumn = 0, ValueColumn = 1, ColumnCount = 2 }

Protected Member Functions
virtual int	columnCount (const QModelIndex &parent=QModelIndex()) const
virtual QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const
virtual Qt::ItemFlags	flags (const QModelIndex &index) const
virtual QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
virtual int	rowCount (const QModelIndex &parent=QModelIndex()) const
virtual bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)

Properties
Session	session

Detailed Description

This DefaultVariableModel class is an implementation of QAbstractItemModel that can be used with the Variable Manager plugin.

For most uses the addVariable(), removeVariable() and clearVariables() methods are sufficient. They can be used from session (directly or by connecting signals to them), or called from a subclass.

DefaultVariableModel uses the session to run expressions for changing variables, and it gets the commands from the backend's VariableManagementExtension. If you do not want this behavior, you can subclass it and reimplement data() and/or setData().

See also

Session::variableModel()

Definition at line 47 of file defaultvariablemodel.h.

Member Enumeration Documentation

enum Cantor::DefaultVariableModel::Column

protected

Enumerator
NameColumn
ValueColumn
ColumnCount

Definition at line 126 of file defaultvariablemodel.h.

Constructor & Destructor Documentation

Cantor::DefaultVariableModel::DefaultVariableModel ( Session *  session )

explicit

Default constructor If you are constructing a DefaultVariableModel without subclassing, the session must be valid and its backends must support a VariableManagementExtension.

This requirement can be avoided by reimplementing setData() in a subclass.

Parameters

session

the session this Model belongs to, also becomes the Model's parent.

Definition at line 39 of file defaultvariablemodel.cpp.

Cantor::DefaultVariableModel::~DefaultVariableModel ( )

virtual

Definition at line 51 of file defaultvariablemodel.cpp.

Member Function Documentation

void Cantor::DefaultVariableModel::addVariable ( const QString &  name, const QString &  value  )

slot

Adds a variable to the model.

If a variable with the same name already exists, it will be overwritten.

Parameters

name	the name of the variable
value	the value of the variable

Definition at line 142 of file defaultvariablemodel.cpp.

void Cantor::DefaultVariableModel::addVariable ( const Variable &  variable )

slot

Convenience method, equivalent to addVariable(variable.name, variable.value)

Parameters

variable

the variable to add

Definition at line 150 of file defaultvariablemodel.cpp.

void Cantor::DefaultVariableModel::clearVariables ( )

slot

Clears all variables from the model.

Definition at line 180 of file defaultvariablemodel.cpp.

int Cantor::DefaultVariableModel::columnCount ( const QModelIndex &  parent = QModelIndex() ) const

protectedvirtual

Definition at line 56 of file defaultvariablemodel.cpp.

QVariant Cantor::DefaultVariableModel::data ( const QModelIndex &  index, int  role = Qt::DisplayRole  ) const

protectedvirtual

Definition at line 95 of file defaultvariablemodel.cpp.

Qt::ItemFlags Cantor::DefaultVariableModel::flags ( const QModelIndex &  index ) const

protectedvirtual

Definition at line 89 of file defaultvariablemodel.cpp.

QVariant Cantor::DefaultVariableModel::headerData ( int  section, Qt::Orientation  orientation, int  role = Qt::DisplayRole  ) const

protectedvirtual

Definition at line 74 of file defaultvariablemodel.cpp.

void Cantor::DefaultVariableModel::removeVariable ( const QString &  name )

slot

Remove the variable name from the model.

If a variable with the specified name doesn't exists, this method does nothing.

Parameters

name	the name of the variable to remove

Definition at line 162 of file defaultvariablemodel.cpp.

void Cantor::DefaultVariableModel::removeVariable ( const Variable &  variable )

slot

Convenience method, equivalent to removeVariable(variable.name)

Parameters

variable

the variable to remove

Definition at line 169 of file defaultvariablemodel.cpp.

int Cantor::DefaultVariableModel::rowCount ( const QModelIndex &  parent = QModelIndex() ) const

protectedvirtual

Definition at line 62 of file defaultvariablemodel.cpp.

Session* Cantor::DefaultVariableModel::session

(

)

const

Get the session which created this Model and whose variables it contains.

Returns

the session

bool Cantor::DefaultVariableModel::setData ( const QModelIndex &  index, const QVariant &  value, int  role = Qt::EditRole  )

protectedvirtual

Definition at line 114 of file defaultvariablemodel.cpp.

Property Documentation

Session * Cantor::DefaultVariableModel::session

read

Definition at line 50 of file defaultvariablemodel.h.

---

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

• defaultvariablemodel.h
• defaultvariablemodel.cpp