collection_proxy

Proxy representing a collection of entities that live in the model thread.

The proxy represents them in the gui thread and provides access to the data with zero delay. If the data is not yet present in the proxy, dummy data is returned and an update signal is emitted when the correct data is available.

class camelot.view.proxy.collection_proxy.CollectionProxy(admin, collection_getter, columns_getter, max_number_of_rows=10, flush_changes=True, cache_collection_proxy=None)

The CollectionProxy contains a limited copy of the data in the actual collection, usable for fast visualisation in a QTableView

the CollectionProxy has some class attributes that can be overwritten when subclassing it :

• header_icon : the icon to be used in the vertical header

append_object(*args, **kwargs)

Append an object to this collection, set the possible defaults and flush the object if possible/needed

Parameters:

• obj – the object to be added to the collection
• flush – if this object should be flushed or not

Returns:

the new number of rows in the collection

data(index, role=0)

Returns:the data at index for the specified role

This function will return ValueLoading when the data has not yet been fetched from the underlying model. It will then send a request to the model thread to fetch this data. Once the data is readily available, the dataChanged signal will be emitted

Using Qt.UserRole as a role will return all the field attributes of the index.

Using Qt.UserRole+1 will return the object of which an attribute is displayed in that specific cell

flags(index)

Returns the item flags for the given index

getColumns()

Returns:the columns as set by the setColumns method

getData(*args, **kwargs)

Generator for all the data queried by this proxy

getItemDelegate()

Returns:a DelegateManager for this model, or None if no DelegateManager yet available

a DelegateManager will be available once the item_delegate_changed signal has been emitted

get_admin()

Get the admin object associated with this model

handleRowUpdate(row)

Handles the update of a row when this row might be out of date

handle_entity_create(sender, entity)

Handles the entity signal, indicating that the model is out of date

handle_entity_delete(sender, obj)

Handles the entity signal, indicating that the model is out of date

handle_entity_update(sender, entity)

Handles the entity signal, indicating that the model is out of date

hasUnflushedRows()

The model has rows that have not been flushed to the database yet, because the row is invalid

headerData(section, orientation, role)

In case the columns have not been set yet, don’t even try to get information out of them

map_to_source(sorted_row_number)

Converts a sorted row number to a row number of the source collection

max_number_of_rows

The maximum number of rows to be displayed at once

setColumns(columns)

Callback method to set the columns

Parameters:columns – a list with fields to be displayed of the form [(‘field_name’, field_attributes), ...] as

returned by the getColumns method of the ElixirAdmin class

setData(index, value, role=2)

Value should be a function taking no arguments that returns the data to be set

This function will then be called in the model_thread

setRowCount(rows)

Callback method to set the number of rows @param rows the new number of rows

sort(column, order)

reimplementation of the QtGui.QAbstractItemModel its sort function

class camelot.view.proxy.collection_proxy.DelayedProxy(*args, **kwargs)

A proxy object needs to be constructed within the GUI thread. Construct a delayed proxy when the construction of a proxy is needed within the Model thread. On first occasion the delayed proxy will be converted to a real proxy within the GUI thread

class camelot.view.proxy.collection_proxy.ProxyDict

Subclass of dictionary to fool the QVariant object and prevent it from converting dictionary keys to whatever Qt object, but keep everything python

class camelot.view.proxy.collection_proxy.SortingRowMapper

Class mapping rows of a collection 1:1 without sorting and filtering, unless a mapping has been defined explicitly

camelot.view.proxy.collection_proxy.strip_data_from_object(*args, **kwargs)

For every column in columns, get the corresponding value from the object. Getting a value from an object is time consuming, so using this function should be minimized. :param obj: the object of which to get data :param columns: a list of columns for which to get data

camelot.view.proxy.collection_proxy.stripped_data_to_unicode(*args, **kwargs)

Extract for each field in the row data a ‘visible’ form of data