deluge.ui.gtkui.listview

class deluge.ui.gtkui.listview.ListView(treeview_widget=None, state_file=None)

ListView is used to make custom GtkTreeViews. It supports the adding and removing of columns, creating a menu for a column toggle list and support for ‘status_field’s which are used while updating the columns data.

class ListViewColumn(name, column_indices)

Holds information regarding a column in the ListView

ListView.TreeviewColumn

ListView.add_bool_column(header, col_type=<type 'bool'>, hidden=False, position=None, status_field=None, sortid=0, column_type='bool')

Add a bool column to the listview

ListView.add_column(header, render, col_types, hidden, position, status_field, sortid, text=0, value=0, pixbuf=0, function=None, column_type=None, sort_func=None)

Adds a column to the ListView

ListView.add_func_column(header, function, col_types, sortid=0, hidden=False, position=None, status_field=None, column_type='func', sort_func=None)

Add a function column to the listview. Need a header name, the function and the column types.

ListView.add_progress_column(header, col_types=[, <type 'float'>, <type 'str'>], sortid=0, hidden=False, position=None, status_field=None, function=None, column_type='progress')

Add a progress column to the listview.

ListView.add_text_column(header, col_type=<type 'str'>, hidden=False, position=None, status_field=None, sortid=0, column_type='text', sort_func=None)

Add a text column to the listview. Only the header name is required.

ListView.add_texticon_column(header, col_types=[, <type 'str'>, <type 'str'>], sortid=1, hidden=False, position=None, status_field=None, column_type='texticon', function=None)

Adds a texticon column to the listview.

ListView.create_checklist_menu()

Creates a menu used for toggling the display of columns.

ListView.create_column_state(column, position=None)

ListView.create_model_filter()

create new filter-model must be called after listview.create_new_liststore

ListView.create_new_liststore()

Creates a new GtkListStore based on the liststore_columns list

ListView.get_column_index(name)

Get the liststore column indices belonging to this column. Will return a list.

ListView.get_column_name(index)

Get the header name for a liststore column index

ListView.get_state_field_column(field)

Returns the column number for the state field

ListView.load_state(filename)

Load the listview state from filename.

ListView.on_menuitem_toggled(widget)

Callback for the generated column menuitems.

ListView.on_treeview_header_right_clicked(column, event)

ListView.register_checklist_menu(menu)

Register a checklist menu with the listview. It will automatically attach any new checklist menu it makes to this menu.

ListView.remove_column(header)

Removes the column with the name ‘header’ from the listview

ListView.save_state(filename)

Saves the listview state (column positions and visibility) to filename.

ListView.set_sort_functions()

ListView.set_treeview(treeview_widget)

Set the treeview widget that this listview uses.

class deluge.ui.gtkui.listview.ListViewColumnState(name, position, width, visible, sort, sort_order)

Used for saving/loading column state

deluge.ui.gtkui.listview.cell_data_date(column, cell, model, row, data)

Display value as date, eg 05/05/08

deluge.ui.gtkui.listview.cell_data_peer(column, cell, model, row, data)

Display values as ‘value1 (value2)’

deluge.ui.gtkui.listview.cell_data_ratio(column, cell, model, row, data)

Display value as a ratio with a precision of 3.

deluge.ui.gtkui.listview.cell_data_size(column, cell, model, row, data)

Display value in terms of size, eg. 2 MB

deluge.ui.gtkui.listview.cell_data_speed(column, cell, model, row, data)

Display value as a speed, eg. 2 KiB/s

deluge.ui.gtkui.listview.cell_data_time(column, cell, model, row, data)

Display value as time, eg 1m10s