TableGridModel class reference
[Model/View module]

This class is a member of the QtLua namespace.

This class can be used to expose 2 dimensionnal arrays stored as nested lua tables to QTableView widgets. Each row in the grid matches an entry in the provided lua table, and each column describe keys used to access nested tables.

Column and row keys can be independently handled as numerical indexes or as plain lua value. When in numerical key mode, all keys are assumed to be numbers, first key is 1 and keys order is preserved when inserting or deleting entries.

Exposed keys can be defined in several ways:

• all lua values can be automatically fetched from table keys, or

• keys can be user specified, or

• incremental numerical keys can be used.

Lua tables and UserData objects with valid table operations are handled.

Lua tables can be edited from Qt views using this model. The TableGridModel::Attribute flags can be used to control which editing actions are allowed. User input may be evaluated as a lua expression when editing a table entry.

Lua tables change may not update the model on the fly. This is partially due to lack of lua mechanism to implement efficient table change event.

Usage example:

See also ItemViewDialog class.

• enum Attribute
• typedef [...] Attributes

• TableGridModel(const Value &table, TableGridModel::Attributes attr, bool find_keys, QObject *parent = [...])
• TableGridModel(const Value &table, int row_count, int col_count, TableGridModel::Attributes attr, QObject *parent = [...])
• ~TableGridModel()
• void add_column_key(const Value &k)
• void add_column_key(const String &k)
• void add_row_key(const Value &k)
• void add_row_key(const String &k)
• const QList<Value> & column_keys() const
• void fetch_all_column_keys()
• void fetch_all_row_keys()
• ValueRef get_value_ref(const QModelIndex &index) const
• const QList<Value> & row_keys() const
• void set_col_count(int c)
• void set_row_count(int c)

• int columnCount(const QModelIndex &parent) const
• QVariant data(const QModelIndex &index, int role) const
• Qt::ItemFlags flags(const QModelIndex &index) const
• bool hasChildren(const QModelIndex &parent) const
• QVariant headerData(int section, Qt::Orientation orientation, int role) const
• bool insertColumns(int column, int count, const QModelIndex &parent)
• bool insertRows(int row, int count, const QModelIndex &parent)
• virtual Value new_cell_value(State *st, int row, int col) const
• virtual Value new_column_key(State *st, int col) const
• virtual Value new_row_key(State *st, int row) const
• virtual Value new_row_table(State *st, int row) const
• QModelIndex parent(const QModelIndex &index) const
• bool removeColumns(int column, int count, const QModelIndex &parent)
• bool removeRows(int row, int count, const QModelIndex &parent)
• int rowCount(const QModelIndex &parent) const
• bool setData(const QModelIndex &index, const QVariant &value, int role)
• bool setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role)

• static void table_dialog(QWidget *parent, const QString &title, const Value &table, TableGridModel::Attributes attr = [...], const ValueBase::List *colkeys = [...], const ValueBase::List *rowkeys = [...])

• void edit_error(const QString &message)

Create a new lua grid table model.

This constructor will determine rows and columns keys by calling TableGridModel::fetch_all_row_keys and TableGridModel::fetch_all_column_keys if find_keys is true.

Create a new lua grid table model and use numerical keys with given bounds

No documentation available

Specifies TableGridModel behavior for a given lua table

See also TableGridModel::Attributes typedef.

No documentation available

Switch to non-numeric column keys and Add a column key that must appear in the table

Switch to non-numeric column keys and Add a column key that must appear in the table

Switch to non-numeric row keys and Add a row key that must appear in the table

Switch to non-numeric row keys and Add a row key that must appear in the table

This member access is protected.

Return current non-numeric column keys

This member access is protected.

This member is a Qt signal.

Find all column keys or find maximum row numeric key. Must be called with at least one available row

Find all row keys or find maximum row numeric key

This member access is protected.

Get ValueRef reference object to lua value at given QModelIndex

This member access is protected.

This member access is protected.

This member access is protected.

This member access is protected.

This member access is protected.

Return the initial value used when inserting new columns for cell at given position. The default implementation returns a nil value.

This member access is protected.

Return a column key suitable for given column. This function is called when inserting a new column in non-numeric column key mode. The new key must no appear in the current list of column keys.

This member access is protected.

Return a row key suitable for given row. This function is called when inserting a new row in non-numeric row key mode. The new key must no appear in the current list of row keys.

This member access is protected.

Return the a new table for new row insertion. The default implementation returns a lua Value::TTable value filled with values provided by the TableGridModel::new_cell_value function.

This member access is protected.

This member access is protected.

This member access is protected.

This member access is protected.

Return current non-numeric row keys

This member access is protected.

This member access is protected.

Switch to numeric column keys and set column count

Switch to numeric row keys and set row count

Convenience function to display a modal lua table dialog.

Parameters list:

• parent: parent widget
• title: dialog window title
• table: lua table to expose
• attr: model attributes, control display and edit options
• colkeys: list of lua value to use as column keys, use TableGridModel::fetch_all_column_keys if NULL.
• rowkeys: list of lua value to use as row keys, use TableGridModel::fetch_all_row_keys if NULL.