Qudi
Public Member Functions | Public Attributes | List of all members
core.util.models.DictTableModel Class Reference

Qt model storing a tabel in dictionaries. More...

Inheritance diagram for core.util.models.DictTableModel:
Inheritance graph
[legend]
Collaboration diagram for core.util.models.DictTableModel:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self)
 
def getKeyByNumber (self, n)
 Get a dict key by index number. More...
 
def getNumberByKey (self, key)
 Get index number for dict key. More...
 
def rowCount (self, parent=QtCore.QModelIndex())
 Gives the number of stored items. More...
 
def columnCount (self, parent=QtCore.QModelIndex())
 Gives the number of data fields. More...
 
def flags (self, index)
 Determines what can be done with entry cells in the table view. More...
 
def data (self, index, role)
 Get data from model for a given cell. More...
 
def headerData (self, section, orientation, role=QtCore.Qt.DisplayRole)
 Data for the table view headers. More...
 
def add (self, key, data)
 Append key and data to dictionary, update model. More...
 
def pop (self, key)
 Remove key from dictionary. More...
 

Public Attributes

 lock
 
 headers
 
 storage
 

Detailed Description

Qt model storing a tabel in dictionaries.

Member Function Documentation

◆ add()

def core.util.models.DictTableModel.add (   self,
  key,
  data 
)

Append key and data to dictionary, update model.

Parameters
keydict key
datadict data
Returns
key: dict key

◆ columnCount()

def core.util.models.DictTableModel.columnCount (   self,
  parent = QtCore.QModelIndex() 
)

Gives the number of data fields.

Returns
int: number of data fields

◆ data()

def core.util.models.DictTableModel.data (   self,
  index,
  role 
)

Get data from model for a given cell.

Data can have a role that affects display.

     @param QModelIndex index: cell for which data is requested
     @param ItemDataRole role: role for which data is requested

     @return QVariant: data for given cell and role

◆ flags()

def core.util.models.DictTableModel.flags (   self,
  index 
)

Determines what can be done with entry cells in the table view.

Parameters
QModelIndexindex: cell fo which the flags are requested
Returns
Qt.ItemFlags: actins allowed fotr this cell

◆ getKeyByNumber()

def core.util.models.DictTableModel.getKeyByNumber (   self,
  n 
)

Get a dict key by index number.

Parameters
nint: index number for element
Returns
key: key at index

◆ getNumberByKey()

def core.util.models.DictTableModel.getNumberByKey (   self,
  key 
)

Get index number for dict key.

Parameters
keydict key
Returns
int: index numer for key
Warning
index number for a key changes when keys with lower numbers are removed.

◆ headerData()

def core.util.models.DictTableModel.headerData (   self,
  section,
  orientation,
  role = QtCore.Qt.DisplayRole 
)

Data for the table view headers.

Parameters
intsection: number of the column to get header data for
Qt.Orientationorientation of header (horizontal or vertical)
ItemDataRolerole for which to get data
Returns
QVariant: header data for given column and role

◆ pop()

def core.util.models.DictTableModel.pop (   self,
  key 
)

Remove key from dictionary.

Parameters
keydict key to remove
Returns
value: value removed from dict

◆ rowCount()

def core.util.models.DictTableModel.rowCount (   self,
  parent = QtCore.QModelIndex() 
)

Gives the number of stored items.

Returns
int: number of items

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