HAL
hal::GroupingTableModel Class Reference

Table that holds information about all groupings. More...

#include <grouping_table_model.h>

Inheritance diagram for hal::GroupingTableModel:
Inheritance graph
Collaboration diagram for hal::GroupingTableModel:
Collaboration graph

Public Slots

void deleteGroupingEvent (Grouping *grp)
 
QColor recolorGrouping (u32 id, const QColor &groupingColor)
 
void createGroupingEvent (Grouping *grp)
 
void groupingNameChangedEvent (Grouping *grp)
 
void groupingColorChangedEvent (Grouping *grp)
 

Signals

void groupingColorChanged (Grouping *grp)
 
void lastEntryDeleted ()
 
void newEntryAdded (QModelIndex &index)
 

Public Member Functions

 GroupingTableModel (bool history, QObject *parent=nullptr)
 
int columnCount (const QModelIndex &parent=QModelIndex()) const override
 
int rowCount (const QModelIndex &parent=QModelIndex()) const override
 
QVariant data (const QModelIndex &index, int role) const override
 
QVariant headerData (int section, Qt::Orientation orientation, int role) const override
 
bool setData (const QModelIndex &index, const QVariant &value, int role) override
 
bool removeRows (int row, int count=1, const QModelIndex &parent=QModelIndex()) override
 
bool validate (const QString &input)
 
void setAboutToRename (const QString &oldName)
 
GroupingTableEntry groupingAt (int irow) const
 
GroupingaddDefaultEntry ()
 
GroupinggroupingByName (const QString &name) const
 
QColor colorForItem (ItemType itemType, u32 itemId) const
 
QColor colorForGrouping (Grouping *grouping) const
 
QString renameGrouping (u32 id, const QString &groupingName)
 
QStringList groupingNames () const
 
- Public Member Functions inherited from QAbstractTableModel
 QAbstractTableModel (QObject *parent)
 
virtual ~QAbstractTableModel ()
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent) const const override
 
virtual QModelIndex sibling (int row, int column, const QModelIndex &idx) const const override
 
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
 
virtual Qt::ItemFlags flags (const QModelIndex &index) const const override
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent)
 
virtual ~QAbstractItemModel ()
 
bool hasIndex (int row, int column, const QModelIndex &parent) const const
 
virtual QModelIndex parent (const QModelIndex &index) const const=0
 
virtual bool hasChildren (const QModelIndex &parent) const const
 
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)
 
virtual QMap< int, QVariantitemData (const QModelIndex &index) const const
 
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
 
virtual QStringList mimeTypes () const const
 
virtual QMimeDatamimeData (const QModelIndexList &indexes) const const
 
virtual bool canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const
 
virtual Qt::DropActions supportedDropActions () const const
 
virtual Qt::DropActions supportedDragActions () const const
 
void setSupportedDragActions (Qt::DropActions actions)
 
virtual bool insertRows (int row, int count, const QModelIndex &parent)
 
virtual bool insertColumns (int column, int count, const QModelIndex &parent)
 
virtual bool removeColumns (int column, int count, const QModelIndex &parent)
 
virtual bool moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)
 
virtual bool moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)
 
bool insertRow (int row, const QModelIndex &parent)
 
bool insertColumn (int column, const QModelIndex &parent)
 
bool removeRow (int row, const QModelIndex &parent)
 
bool removeColumn (int column, const QModelIndex &parent)
 
bool moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)
 
bool moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)
 
virtual void fetchMore (const QModelIndex &parent)
 
virtual bool canFetchMore (const QModelIndex &parent) const const
 
virtual void sort (int column, Qt::SortOrder order)
 
virtual QModelIndex buddy (const QModelIndex &index) const const
 
virtual QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const
 
virtual QSize span (const QModelIndex &index) const const
 
virtual QHash< int, QByteArrayroleNames () const const
 
bool checkIndex (const QModelIndex &index, QAbstractItemModel::CheckIndexOptions options) const const
 
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< int > &roles)
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 
void layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
 
void layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
 
void rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void rowsInserted (const QModelIndex &parent, int first, int last)
 
void rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)
 
void rowsRemoved (const QModelIndex &parent, int first, int last)
 
void columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)
 
void columnsInserted (const QModelIndex &parent, int first, int last)
 
void columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)
 
void columnsRemoved (const QModelIndex &parent, int first, int last)
 
void modelAboutToBeReset ()
 
void modelReset ()
 
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int row)
 
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int column)
 
virtual bool submit ()
 
virtual void revert ()
 
- Public Member Functions inherited from QObject
virtual const QMetaObjectmetaObject () const const
 
 QObject (QObject *parent)
 
virtual ~QObject ()
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
QString objectName () const const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
bool signalsBlocked () const const
 
bool blockSignals (bool block)
 
QThreadthread () const const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
const QObjectListchildren () const const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectInfo () const const
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const const
 
QList< QByteArraydynamicPropertyNames () const const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
bool inherits (const char *className) const const
 
void deleteLater ()
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
 Q_CLASSINFO (Name, Value)
 
 Q_INTERFACES (...)
 
 Q_PROPERTY (...)
 
 Q_ENUMS (...)
 
 Q_FLAGS (...)
 
 Q_ENUM (...)
 
 Q_FLAG (...)
 
 Q_ENUM_NS (...)
 
 Q_FLAG_NS (...)
 
 Q_OBJECT Q_OBJECT
 
 Q_GADGET Q_GADGET
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SLOTS Q_SLOTS
 
 Q_SLOT Q_SLOT
 
 Q_EMIT Q_EMIT
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
- Public Member Functions inherited from hal::Validator
void setFailText (const QString &text)
 
QString failText () const
 

Additional Inherited Members

- Public Types inherited from QAbstractItemModel
enum  LayoutChangeHint
 
enum  CheckIndexOption
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
- Public Attributes inherited from QAbstractItemModel
typedef CheckIndexOptions
 
 NoLayoutChangeHint
 
 VerticalSortHint
 
 HorizontalSortHint
 
 NoOption
 
 IndexIsValid
 
 DoNotUseParent
 
 ParentIsInvalid
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QAbstractItemModel
void resetInternalData ()
 
QModelIndex createIndex (int row, int column, void *ptr) const const
 
QModelIndex createIndex (int row, int column, quintptr id) const const
 
void beginInsertRows (const QModelIndex &parent, int first, int last)
 
void endInsertRows ()
 
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 
void endRemoveRows ()
 
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
void endMoveRows ()
 
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 
void endInsertColumns ()
 
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 
void endRemoveColumns ()
 
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
void endMoveColumns ()
 
void reset ()
 
void beginResetModel ()
 
void endResetModel ()
 
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
 
QModelIndexList persistentIndexList () const const
 
void setRoleNames (const QHash< int, QByteArray > &roleNames)
 
- Protected Member Functions inherited from QObject
QObjectsender () const const
 
int senderSignalIndex () const const
 
int receivers (const char *signal) const const
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
- Protected Attributes inherited from hal::Validator
QString mFailText = "Chosen input is not allowed."
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Table that holds information about all groupings.

The table model used for groupings within the GroupingsManagerWidget.
Read the Qt documentation for further descriptions of the table model system.

Definition at line 128 of file grouping_table_model.h.

Constructor & Destructor Documentation

◆ GroupingTableModel()

Member Function Documentation

◆ addDefaultEntry()

Grouping * hal::GroupingTableModel::addDefaultEntry ( )

Adds a grouping to the table. The grouping is created with a unique default name (e.g. 'grouping1').

Returns
the created grouping

Definition at line 212 of file grouping_table_model.cpp.

References hal::GroupingTableEntry::grouping(), QAbstractTableModel::index(), QSet::insert(), QAbstractItemModel::layoutAboutToBeChanged(), QAbstractItemModel::layoutChanged(), test::n, newEntryAdded(), and QObject::Q_EMIT().

Referenced by hal::ActionCreateObject::exec().

◆ colorForGrouping()

QColor hal::GroupingTableModel::colorForGrouping ( Grouping grouping) const

Gets the grouping color of a specified Grouping.

Parameters
grouping- the specified grouping
Returns
the color of the grouping

Definition at line 373 of file grouping_table_model.cpp.

◆ colorForItem()

QColor hal::GroupingTableModel::colorForItem ( ItemType  itemType,
u32  itemId 
) const

Gets the color of an item based on its grouping. If the item has no grouping an invalid color (QColor()) is returned.

Parameters
itemType- The type of the item (i.e. Module, Gate or Net)
itemId- The id of the item
Returns
the color of the grouping of the item. Returns an invalid color if the item has no grouping.

Definition at line 341 of file grouping_table_model.cpp.

References test_plugin::g, hal::Gate, hal::Netlist::get_gate_by_id(), hal::Module::get_grouping(), hal::Netlist::get_module_by_id(), hal::Netlist::get_net_by_id(), hal::gNetlist, hal::Module, test::n, and hal::Net.

Referenced by hal::GraphicsItem::groupingColor(), and hal::StandardGraphicsGate::paint().

◆ columnCount()

int hal::GroupingTableModel::columnCount ( const QModelIndex parent = QModelIndex()) const
overridevirtual

Returns the amount of columns. Is always 3 (Grouping, ID, Color)

Parameters
parent- Then parent model index
Returns
3

Implements QAbstractItemModel.

Definition at line 103 of file grouping_table_model.cpp.

References QObject::parent().

◆ createGroupingEvent

void hal::GroupingTableModel::createGroupingEvent ( Grouping grp)
slot

Q_SLOT to handle that a grouping has been created.

Parameters
grp- The created grouping

Definition at line 249 of file grouping_table_model.cpp.

References QAbstractTableModel::index(), QAbstractItemModel::layoutAboutToBeChanged(), QAbstractItemModel::layoutChanged(), test::n, newEntryAdded(), and QObject::Q_EMIT().

Referenced by GroupingTableModel().

◆ data()

QVariant hal::GroupingTableModel::data ( const QModelIndex index,
int  role 
) const
overridevirtual

Returns the data stored under the given role for a given index in the table model.

Parameters
index- The index in the table
role- The access role
Returns
the data

Implements QAbstractItemModel.

Definition at line 135 of file grouping_table_model.cpp.

References Qt::BackgroundRole, hal::GroupingTableEntry::color(), QModelIndex::column(), Qt::DisplayRole, hal::GroupingTableEntry::id(), QAbstractTableModel::index(), QModelIndex::isValid(), hal::GroupingTableEntry::name(), QColor::name(), and QModelIndex::row().

Referenced by hal::GroupingColorDelegate::paint().

◆ deleteGroupingEvent

void hal::GroupingTableModel::deleteGroupingEvent ( Grouping grp)
slot

Q_SLOT to handle that a grouping was removed.

Parameters
grp- The removed grouping.

Definition at line 235 of file grouping_table_model.cpp.

References lastEntryDeleted(), QAbstractItemModel::layoutAboutToBeChanged(), QAbstractItemModel::layoutChanged(), and QObject::Q_EMIT().

Referenced by GroupingTableModel().

◆ groupingAt()

GroupingTableEntry hal::GroupingTableModel::groupingAt ( int  irow) const
inline

Gets the table entry that contains the grouping at a given row index.

Parameters
irow- The row index
Returns
the grouping table entry

Definition at line 226 of file grouping_table_model.h.

References QList::at().

Referenced by hal::ActionDeleteObject::exec(), and hal::GroupingColorSerializer::serialize().

◆ groupingByName()

Grouping * hal::GroupingTableModel::groupingByName ( const QString name) const

Searches for a grouping with the given name in the grouping table.

Parameters
name- The name to search for
Returns
the grouping if found. Returns nullptr otherwise.

Definition at line 385 of file grouping_table_model.cpp.

References name.

◆ groupingColorChanged

void hal::GroupingTableModel::groupingColorChanged ( Grouping grp)
signal

Q_SIGNAL to notify that the color of a grouping has been changed. Emitted by GroupingTableModel::setData if the color field was modified.

Parameters
grp- The grouping which color has been changed.

Referenced by hal::GraphicsScene::connectAll(), hal::GraphicsScene::disconnectAll(), hal::GroupingsOfItemModel::GroupingsOfItemModel(), recolorGrouping(), and setData().

◆ groupingColorChangedEvent

void hal::GroupingTableModel::groupingColorChangedEvent ( Grouping grp)
slot

Q_SLOT to handle that a grouping has been recolored.

Parameters
grp

Definition at line 276 of file grouping_table_model.cpp.

References QAbstractItemModel::dataChanged(), hal::Grouping::get_color(), QAbstractTableModel::index(), QObject::Q_EMIT(), and hal::toQColor().

Referenced by GroupingTableModel().

◆ groupingNameChangedEvent

void hal::GroupingTableModel::groupingNameChangedEvent ( Grouping grp)
slot

Q_SLOT to handle that a grouping has been renamed.

Parameters
grp

Definition at line 260 of file grouping_table_model.cpp.

References QAbstractItemModel::dataChanged(), QString::fromStdString(), hal::Grouping::get_name(), QAbstractTableModel::index(), and QObject::Q_EMIT().

Referenced by GroupingTableModel().

◆ groupingNames()

QStringList hal::GroupingTableModel::groupingNames ( ) const

Gets a list of all currently used grouping names.

Returns
a string list of used grouping names

Definition at line 393 of file grouping_table_model.cpp.

◆ headerData()

QVariant hal::GroupingTableModel::headerData ( int  section,
Qt::Orientation  orientation,
int  role 
) const
overridevirtual

Returns the header data fields, i.e. 'Groupings', 'ID' or 'Color'

Parameters
section- The section (column) index
orientation- The orientation of the table
role- The access role
Returns
the header data field at the given position

Reimplemented from QAbstractItemModel.

Definition at line 115 of file grouping_table_model.cpp.

References Qt::DisplayRole, and Qt::Horizontal.

◆ lastEntryDeleted

void hal::GroupingTableModel::lastEntryDeleted ( )
signal

Q_SIGNAL to notify that the grouping table entry at the rearmost position (i.e. the entry with the highest row index) has been deleted.

Referenced by deleteGroupingEvent(), hal::GroupingManagerWidget::GroupingManagerWidget(), and removeRows().

◆ newEntryAdded

void hal::GroupingTableModel::newEntryAdded ( QModelIndex index)
signal

Q_SIGNAL to notify that a new grouping table entry has been added to the table.

Parameters
index- The index of the new entry

Referenced by addDefaultEntry(), createGroupingEvent(), hal::GroupingManagerWidget::GroupingManagerWidget(), and GroupingTableModel().

◆ recolorGrouping

QColor hal::GroupingTableModel::recolorGrouping ( u32  id,
const QColor groupingColor 
)
slot

Changes the color of the grouping with the specified id to the specified color.

Parameters
id- The grouping id
groupingColor- The new color
Returns
the color BEFORE the recoloring. If the grouping id is unknown an empty color (QColor()) is returned

Definition at line 310 of file grouping_table_model.cpp.

References QAbstractItemModel::dataChanged(), groupingColorChanged(), QAbstractTableModel::index(), and QObject::Q_EMIT().

◆ removeRows()

bool hal::GroupingTableModel::removeRows ( int  row,
int  count = 1,
const QModelIndex parent = QModelIndex() 
)
overridevirtual

◆ renameGrouping()

QString hal::GroupingTableModel::renameGrouping ( u32  id,
const QString groupingName 
)

Renames the grouping at the given table row of the groupings table.

Parameters
id- The id of the grouping to rename
groupingName- The new name
Returns
The old name.

Definition at line 294 of file grouping_table_model.cpp.

References QAbstractItemModel::dataChanged(), QAbstractTableModel::index(), and QObject::Q_EMIT().

Referenced by hal::ActionCreateObject::exec(), and hal::ActionRenameObject::exec().

◆ rowCount()

int hal::GroupingTableModel::rowCount ( const QModelIndex parent = QModelIndex()) const
overridevirtual

Returns the amount of rows in the table. Is equal to the amount of stored groupings.

Parameters
parent- The parent model index
Returns
the amount of rows in the table.

Implements QAbstractItemModel.

Definition at line 109 of file grouping_table_model.cpp.

References QObject::parent().

Referenced by hal::ActionDeleteObject::exec(), and hal::GroupingColorSerializer::serialize().

◆ setAboutToRename()

void hal::GroupingTableModel::setAboutToRename ( const QString oldName)
inline

This function is used to prevent the 'validate'-function to return false while renaming a grouping to its old name. Therefore the old name of the grouping will always considered as valid.
To achieve this one has to call this function to store the old name.

Parameters
oldName- The old name of the grouping

Definition at line 218 of file grouping_table_model.h.

References QString::trimmed().

◆ setData()

bool hal::GroupingTableModel::setData ( const QModelIndex index,
const QVariant value,
int  role 
)
overridevirtual

Sets the role data for the item at index to value.

Parameters
index- The model index
value- The value to set
role- The access role
Returns
true on success

Reimplemented from QAbstractItemModel.

Definition at line 159 of file grouping_table_model.cpp.

References QModelIndex::column(), Qt::EditRole, groupingColorChanged(), QAbstractTableModel::index(), QModelIndex::isValid(), QObject::Q_EMIT(), QModelIndex::row(), QVariant::toString(), QString::trimmed(), and QVariant::value().

◆ validate()

bool hal::GroupingTableModel::validate ( const QString input)
virtual

Returns true if input is a unique and valid grouping name. Returns false otherwise.

Parameters
input- A grouping name
Returns
true if input is a unique and valid grouping name. Returns false otherwise

Implements hal::Validator.

Definition at line 200 of file grouping_table_model.cpp.

References hal::input.


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