deluge.ui.gtk3 package
Submodules
deluge.ui.gtk3.aboutdialog module
deluge.ui.gtk3.addtorrentdialog module
- class deluge.ui.gtk3.addtorrentdialog.AddTorrentDialog
Bases:
deluge.component.Component
- add_files(parent_iter, split_files)
- add_from_files(filenames)
- add_from_magnets(uris)
Add a list of magnet URIs to torrent_liststore.
- add_from_url(url)
- add_torrents()
- build_priorities(_iter, priorities)
- get_file_path(row, path='')
- get_file_priorities(torrent_id)
- hide()
- load_path_choosers_data()
- on_button_add_clicked(widget)
- on_button_apply_clicked(widget)
- on_button_cancel_clicked(widget)
- on_button_file_clicked(widget)
- on_button_hash_clicked(widget)
- on_button_remove_clicked(widget)
- on_button_revert_clicked(widget)
- on_button_trackers_clicked(widget)
- on_button_url_clicked(widget)
- on_chk_move_completed_toggled(widget)
- prefetch_waiting_message(torrent_id, files)
Show magnet files fetching or failed message above files list.
- prepare_file(_file, file_name, file_num, download, files_storage)
- prepare_file_store(files)
- save_torrent_options(row=None)
- set_default_options()
- setup_download_location_path_chooser()
- setup_move_completed_path_chooser()
- show(focus=False)
- show_already_added_dialog(count)
Show a message about trying to add duplicate torrents.
- start()
- toggle_iter(_iter, toggle_to=None)
- update_core_config(show=False, focus=False)
- update_dialog_title_count(*args)
Update the AddTorrent dialog title with current torrent count.
- update_torrent_options(torrent_id)
- update_treeview_toggles(_iter)
deluge.ui.gtk3.common module
Common functions for various parts of gtkui to use.
- deluge.ui.gtk3.common.associate_magnet_links(overwrite=False)
Associates magnet links to Deluge.
- Params:
overwrite (bool): if this is True, the current setting will be overwritten
- Returns
bool – True if association was set
Build a menu with radio menu items from a list and connect them to the callback.
Params: value_list [list]: List of values to build into a menu. callback (function): The function to call when menu item is clicked. pref_value (int): A preferred value to insert into value_list suffix (str): Append a suffix the the menu items in value_list. show_notset (bool): Show the unlimited menu item. notset_label (str): The text for the unlimited menu item. notset_lessthan (int): Activates the unlimited menu item if pref_value is less than this. show_other (bool): Show the Other menu item.
The pref_value is what you would like to test for the default active radio item.
- Returns
Menu – The menu radio
- deluge.ui.gtk3.common.cmp(x, y)
Replacement for built-in function cmp that was removed in Python 3.
Compare the two objects x and y and return an integer according to the outcome. The return value is negative if x < y, zero if x == y and strictly positive if x > y.
- deluge.ui.gtk3.common.create_blank_pixbuf(size=16)
- deluge.ui.gtk3.common.get_clipboard_text()
- deluge.ui.gtk3.common.get_deluge_icon()
The deluge icon for use in dialogs.
It will first attempt to get the icon from the theme and will fallback to using an image that is distributed with the package.
- Returns
Pixbuf – the deluge icon
- deluge.ui.gtk3.common.get_logo(size)
A Deluge logo.
- Params:
size (int): Size of logo in pixels
- Returns
Pixbuf – deluge logo
- deluge.ui.gtk3.common.get_pixbuf(filename, size=0)
Creates a new pixbuf by loading an image from file
- Parameters
filename (
str
) – An image file to loadsize (
int
) – Specify a size constraint (equal aspect ratio)
- Return type
Pixbuf
- Returns
A newly created pixbuf
- deluge.ui.gtk3.common.listview_replace_treestore(listview)
Prepare a listview’s treestore to be entirely replaced.
- Params:
listview: a listview backed by a treestore
- deluge.ui.gtk3.common.load_pickled_state_file(filename)
Loads a file from the config directory, attempting backup if original fails to load.
- Params:
filename (str): Filename to be loaded from config
- Returns
state – the unpickled state
- deluge.ui.gtk3.common.parse_ip_port(text)
Return an IP and port from text.
Parses both IPv4 and IPv6.
- Params:
text (str): Text to be parsed for IP and port.
- Returns
tuple – (ip (str), port (int))
- deluge.ui.gtk3.common.reparent_iter(treestore, itr, parent, move_siblings=False)
This effectively moves itr plus it’s children to be a child of parent in treestore
- Params:
treestore (gtkTreeStore): the treestore itr (gtkTreeIter): the iter to move parent (gtkTreeIter): the new parent for itr move_siblings (bool): if True, it will move all itr’s siblings to parent
- deluge.ui.gtk3.common.save_pickled_state_file(filename, state)
Save a file in the config directory and creates a backup
- Params:
filename (str): Filename to be saved to config state (state): The data to be pickled and written to file
- deluge.ui.gtk3.common.windowing(like)
deluge.ui.gtk3.connectionmanager module
- class deluge.ui.gtk3.connectionmanager.ConnectionManager
Bases:
deluge.component.Component
- on_button_addhost_clicked(widget)
- on_button_close_clicked(widget)
- on_button_connect_clicked(widget=None)
Button handler for connect to or disconnect from daemon.
- on_button_edithost_clicked(widget=None)
- on_button_refresh_clicked(widget)
- on_button_removehost_clicked(widget)
- on_button_startdaemon_clicked(widget)
- on_chk_toggled(widget)
- on_entry_host_paste_clipboard(widget)
- on_hostlist_row_activated(tree, path, view_column)
- on_hostlist_selection_changed(treeselection)
- show()
Show the ConnectionManager dialog.
- shutdown()
- start()
- start_daemon(port, config)
Attempts to start local daemon process and will show an ErrorDialog if not.
- Parameters
port (int) – Port for the daemon to listen on.
config (str) – Config path to pass to daemon.
- Returns
bool – True is successfully started the daemon, False otherwise.
- stop()
- deluge.ui.gtk3.connectionmanager.cell_render_host(column, cell, model, row, data)
- deluge.ui.gtk3.connectionmanager.cell_render_status_icon(column, cell, model, row, data)
deluge.ui.gtk3.createtorrentdialog module
- class deluge.ui.gtk3.createtorrentdialog.CreateTorrentDialog
Bases:
object
- adjust_piece_size()
Adjusts the recommended piece based on the file/folder/path selected.
- create_torrent(path, tracker, piece_length, progress, comment, target, webseeds, private, created_by, trackers, add_to_session)
- on_button_add_clicked(widget)
- on_button_cancel_clicked(widget)
- on_button_down_clicked(widget)
- on_button_file_clicked(widget)
- on_button_folder_clicked(widget)
- on_button_remote_path_clicked(widget)
- on_button_remove_clicked(widget)
- on_button_save_clicked(widget)
- on_button_up_clicked(widget)
- parse_piece_size_text(value)
- show()
deluge.ui.gtk3.details_tab module
- class deluge.ui.gtk3.details_tab.DetailsTab
Bases:
deluge.ui.gtk3.torrentdetails.Tab
- clear()
- update()
deluge.ui.gtk3.dialogs module
- class deluge.ui.gtk3.dialogs.Account(username, password, authlevel)
Bases:
tuple
- property authlevel
Alias for field number 2
- property password
Alias for field number 1
- property username
Alias for field number 0
- class deluge.ui.gtk3.dialogs.AccountDialog(*args: Any, **kwargs: Any)
- class deluge.ui.gtk3.dialogs.AuthenticationDialog(*args: Any, **kwargs: Any)
Bases:
deluge.ui.gtk3.dialogs.BaseDialog
Displays a dialog with entry fields asking for username and password.
When run(), it will return either a Gtk.ResponseType.CANCEL or a Gtk.ResponseType.OK.
- __init__(err_msg='', username=None, parent=None)
- Parameters
err_msg (string) – the error message we got back from the server
- get_password()
- get_username()
- on_password_activate(widget)
- class deluge.ui.gtk3.dialogs.BaseDialog(*args: Any, **kwargs: Any)
Bases:
gi.repository.Gtk.Dialog
Base dialog class that should be used with all dialogs.
- __init__(header, text, icon, buttons, parent=None)
- Parameters
header – str, the header portion of the dialog
text – str, the text body of the dialog
icon – icon name from icon theme or icon filename.
buttons – tuple, of icon name and responses
parent – gtkWindow, the parent window, if None it will default to the MainWindow
- run()
Shows the dialog and returns a Deferred object. The deferred, when fired will contain the response ID.
- class deluge.ui.gtk3.dialogs.CopyMagnetDialog(*args: Any, **kwargs: Any)
Bases:
deluge.ui.gtk3.dialogs.BaseDialog
Displays a dialog with a magnet URI
- on_copy_clicked(widget)
- on_copy_emitted(widget)
- class deluge.ui.gtk3.dialogs.ErrorDialog(*args: Any, **kwargs: Any)
Bases:
deluge.ui.gtk3.dialogs.BaseDialog
Displays an error dialog with optional details text for more information.
When run(), it will return a Gtk.ResponseType.CLOSE.
- __init__(header, text, parent=None, details=None, traceback=False)
- Parameters
header – see :class:BaseDialog
text – see :class:BaseDialog
parent – see :class:BaseDialog
details (string) – extra information that will be displayed in a scrollable textview
traceback (bool) – show the traceback information in the details area
- class deluge.ui.gtk3.dialogs.InformationDialog(*args: Any, **kwargs: Any)
Bases:
deluge.ui.gtk3.dialogs.BaseDialog
Displays an information dialog.
When run(), it will return a Gtk.ResponseType.CLOSE.
- __init__(header, text, parent=None)
- Parameters
header – see :class:BaseDialog
text – see :class:BaseDialog
parent – see :class:BaseDialog
- class deluge.ui.gtk3.dialogs.OtherDialog(*args: Any, **kwargs: Any)
Bases:
deluge.ui.gtk3.dialogs.BaseDialog
Displays a dialog with a spinner for setting a value.
- Returns
int or float
- class deluge.ui.gtk3.dialogs.PasswordDialog(*args: Any, **kwargs: Any)
Bases:
deluge.ui.gtk3.dialogs.BaseDialog
Displays a dialog with an entry field asking for a password.
When run(), it will return either a Gtk.ResponseType.CANCEL or a Gtk.ResponseType.OK.
- __init__(password_msg='', parent=None)
- Parameters
password_msg (string) – the error message we got back from the server
- get_password()
- on_password_activate(widget)
- class deluge.ui.gtk3.dialogs.YesNoDialog(*args: Any, **kwargs: Any)
Bases:
deluge.ui.gtk3.dialogs.BaseDialog
Displays a dialog asking the user to select Yes or No to a question.
When run(), it will return either a Gtk.ResponseType.YES or a Gtk.ResponseType.NO.
- __init__(header, text, parent=None)
- Parameters
header – see :class:BaseDialog
text – see :class:BaseDialog
parent – see :class:BaseDialog
deluge.ui.gtk3.edittrackersdialog module
- class deluge.ui.gtk3.edittrackersdialog.EditTrackersDialog(torrent_id, parent=None)
Bases:
object
- add_tracker(tier, url)
Adds a tracker to the list
- get_selected()
Returns the selected tracker
- load_edit_trackers_dialog_state()
- on_button_add_cancel_clicked(widget)
handles the cancel button
- on_button_add_clicked(widget)
- on_button_add_ok_clicked(widget)
- on_button_down_clicked(widget)
- on_button_edit_cancel_clicked(widget)
handles the cancel button
- on_button_edit_clicked(widget)
edits an existing tracker on edit button click
- on_button_edit_ok_clicked(widget)
- on_button_press_event(widget, event)
edits an existing tracker on double click on tracker name
- on_button_remove_clicked(widget)
- on_button_up_clicked(widget)
- on_delete_event_add(widget, event)
handles the Top-Right X button
- on_delete_event_edit(widget, event)
handles the Top-Right X button
- on_edit_trackers_dialog_configure_event(widget, event)
- on_key_add_press_event(widget, event)
handles Escape key press
- on_key_edit_press_event(widget, event)
handles Escape key press
- run()
- deluge.ui.gtk3.edittrackersdialog.last_tier_trackers_from_liststore(trackers_liststore)
Create a list of tracker from existing liststore and find last tier number.
- Parameters
tracker_liststore (Gtk.ListStore) – A Gtk.ListStore with [tier (int), tracker (str)] rows.
- Returns
tuple(int, list) – A tuple containing last tier number and list of trackers.
- deluge.ui.gtk3.edittrackersdialog.trackers_tiers_from_text(text_str='')
Create a list of trackers from text.
Any duplicate trackers are removed.
- Parameters
text_input (str) – A block of text with tracker separated by newlines.
- Returns
list – The list of trackers.
Notes
Trackers should be separated by newlines and empty line denotes start of new tier.
deluge.ui.gtk3.files_tab module
- class deluge.ui.gtk3.files_tab.FilesTab
Bases:
deluge.ui.gtk3.torrentdetails.Tab
- add_files(parent_iter, split_files)
- clear()
- get_file_path(row, path='')
- get_files_from_tree(rows, files_list, indent)
- get_iter_at_path(filepath)
Returns the gtkTreeIter for filepath.
- get_selected_files()
Returns a list of file indexes that are selected.
- keypress_f2(event)
- load_state()
- prepare_file(torrent_file, file_name, file_num, files_storage)
- prepare_file_store(torrent_files)
- remove_childless_folders(itr)
Goes up the tree removing childless itrs starting at itr.
- save_state()
- start()
- update()
- update_files()
- update_folder_percentages()
Go through the tree and update the folder complete percentages.
- deluge.ui.gtk3.files_tab.cell_filename(column, cell, model, row, data)
Only show the tail portion of the file path
- deluge.ui.gtk3.files_tab.cell_priority(column, cell, model, row, data)
- deluge.ui.gtk3.files_tab.cell_priority_icon(column, cell, model, row, data)
- deluge.ui.gtk3.files_tab.cell_progress(column, cell, model, row, data)
deluge.ui.gtk3.filtertreeview module
- class deluge.ui.gtk3.filtertreeview.FilterTreeView
Bases:
deluge.component.Component
- cb_update_filter_tree(filter_items)
- create_model_filter()
- get_pixmap(cat, value)
- on_button_press_event(widget, event)
This is a callback for showing the right-click context menu.
- on_pause_all(event)
- on_resume_all(event)
- on_select_all(event)
- on_selection_changed(selection)
- render_cell_data(column, cell, model, row, data)
- select_all()
For use in popup menu.
- select_default_filter()
- set_row_image(cat, value, filename)
- start()
- stop()
- update()
- update_row(cat, value, count, label=None)
deluge.ui.gtk3.gtkui module
deluge.ui.gtk3.ipcinterface module
- class deluge.ui.gtk3.ipcinterface.IPCClientFactory
Bases:
twisted.internet.protocol.ClientFactory
- clientConnectionFailed(connector, reason)
Called when a connection has failed to connect.
It may be useful to call connector.connect() - this will reconnect.
@type reason: L{twisted.python.failure.Failure}
- protocol
- class deluge.ui.gtk3.ipcinterface.IPCInterface(args)
Bases:
deluge.component.Component
- shutdown()
- class deluge.ui.gtk3.ipcinterface.IPCProtocolClient
Bases:
twisted.internet.protocol.Protocol
- connectionLost(reason=<twisted.python.failure.Failure twisted.internet.error.ConnectionDone: Connection was closed cleanly.>)
Called when the connection is shut down.
Clear any circular references here, and any external references to this Protocol. The connection has been closed.
@type reason: L{twisted.python.failure.Failure}
- connectionMade()
Called when a connection is made.
This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
- class deluge.ui.gtk3.ipcinterface.IPCProtocolServer
Bases:
twisted.internet.protocol.Protocol
- dataReceived(data)
Called whenever data is received.
Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.
- @param data: a string of indeterminate length. Please keep in mind
that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.
- deluge.ui.gtk3.ipcinterface.process_args(args)
Process arguments sent to already running Deluge
deluge.ui.gtk3.listview module
- class deluge.ui.gtk3.listview.ListView(treeview_widget=None, state_file=None)
Bases:
object
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)
Bases:
object
Holds information regarding a column in the ListView
- class TreeviewColumn(*args: Any, **kwargs: Any)
Bases:
gi.repository.Gtk.TreeViewColumn
TreeViewColumn does not signal right-click events, and we need them This subclass is equivalent to TreeViewColumn, but it signals these events
Most of the code of this class comes from Quod Libet (http://www.sacredchao.net/quodlibet)
- __init__(title=None, cell_renderer=None, **args)
Constructor, see Gtk.TreeViewColumn
- on_button_pressed(widget, event)
- on_realize(widget)
- set_cell_data_func_attributes(cell_renderer, func, func_data=None)
Store the values to be set by set_cell_data_func
- set_col_attributes(renderer, add=True, **kw)
- set_visible(visible)
- add_bool_column(header, col_type=<class 'bool'>, hidden=False, position=None, status_field=None, sortid=0, column_type='bool', tooltip=None, default=True)
Add a bool column to the 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, tooltip=None, default=True, unique=False, default_sort=False)
Adds a column to the ListView
- add_func_column(header, function, col_types, sortid=0, hidden=False, position=None, status_field=None, column_type='func', sort_func=None, tooltip=None, default=True)
Add a function column to the listview. Need a header name, the function and the column types.
- add_progress_column(header, col_types=None, sortid=0, hidden=False, position=None, status_field=None, function=None, column_type='progress', tooltip=None, sort_func=None, default=True)
Add a progress column to the listview.
- add_text_column(header, col_type=<class 'str'>, hidden=False, position=None, status_field=None, sortid=0, column_type='text', sort_func=None, tooltip=None, default=True, unique=False, default_sort=False)
Add a text column to the listview. Only the header name is required.
- add_texticon_column(header, col_types=None, sortid=1, hidden=False, position=None, status_field=None, column_type='texticon', function=None, sort_func=None, tooltip=None, default=True, default_sort=False)
Adds a texticon column to the listview.
Creates a menu used for toggling the display of columns.
- create_column_state(column, position=None)
- create_model_filter()
create new filter-model must be called after listview.create_new_liststore
- create_new_liststore()
Creates a new GtkListStore based on the liststore_columns list
- generic_sort_func(model, iter1, iter2, data)
- get_column_index(name)
Get the liststore column indices belonging to this column. Will return a list.
- get_column_name(index)
Get the header name for a liststore column index
- get_sort_column_from_state()
Find the first (should only be one) state with sort enabled
- get_state_field_column(field)
Returns the column number for the state field
- load_state(filename)
Load the listview state from filename.
- on_keypress_search_by_name(model, column, key, _iter)
Callback for the generated column menuitems.
- on_model_row_inserted(model, path, _iter)
- on_model_sort_changed(model)
- on_treeview_header_right_clicked(column, event)
Register a checklist menu with the listview. It will automatically attach any new checklist menu it makes to this menu.
- remove_column(header)
Removes the column with the name ‘header’ from the listview
- restore_columns_order_from_state()
- save_state(filename)
Saves the listview state (column positions and visibility) to filename.
- set_model_sort()
- set_sort_functions()
- set_treeview(treeview_widget)
Set the treeview widget that this listview uses.
- stabilize_sort_func(sort_func)
- update_treeview_column(header, add=True)
Update TreeViewColumn based on ListView column mappings
- class deluge.ui.gtk3.listview.ListViewColumnState(name, position, width, visible, sort, sort_order)
Bases:
object
Class used for saving/loading column state.
deluge.ui.gtk3.mainwindow module
- class deluge.ui.gtk3.mainwindow.MainWindow
Bases:
deluge.component.Component
- active()
Returns True if the window is active, False if not.
- connect_signals(mapping_or_class)
- first_show()
- get_builder()
Returns a reference to the main window GTK builder object.
- get_timestamp()
Returns the timestamp for the windowing server.
- hide()
- is_on_active_workspace()
Determines if MainWindow is on the active workspace.
- Returns
bool – True if on active workspace (or wnck module not available), otherwise False.
- load_window_state()
- on_drag_data_received_event(widget, drag_context, x, y, selection_data, info, timestamp)
- on_expose_event(widget, event)
- on_focus(window, param)
- on_sidebar_pane_position_event(obj, param)
- on_tabsbar_pane_position_event(obj, param)
- on_window_configure_event(widget, event)
- on_window_delete_event(widget, event)
- on_window_state_event(widget, event)
- present()
- quit(shutdown=False, restart=False)
Quits the GtkUI application.
- Parameters
shutdown (bool) – Whether or not to shutdown the daemon as well.
restart (bool) – Whether or not to restart the application after closing.
- save_position()
- show()
- stop()
- update()
- visible()
Returns True if window is visible, False if not.
deluge.ui.gtk3.new_release_dialog module
deluge.ui.gtk3.options_tab module
- class deluge.ui.gtk3.options_tab.OptionsTab
Bases:
deluge.ui.gtk3.torrentdetails.Tab
- clear()
- on_button_apply_clicked(button)
- on_chk_move_completed_toggled(widget)
- on_chk_stop_at_ratio_toggled(widget)
- on_chk_toggled(widget)
- on_get_torrent_status(new_status)
- on_key_press_event(widget, event)
- on_path_chooser_text_changed_event(widget, path)
- on_spin_value_changed(widget)
- parse_torrents_statuses(statuses)
Finds common status values to all torrrents in statuses.
Values which differ are replaced with config values.
- Parameters
statuses (dict) – A status dict of {torrent_id: {key: value}}.
- Returns
dict – A single status dict.
- start()
- stop()
- update()
deluge.ui.gtk3.path_chooser module
- class deluge.ui.gtk3.path_chooser.PathChooser(*args: Any, **kwargs: Any)
Bases:
deluge.ui.gtk3.path_combo_chooser.PathChooserComboBox
- on_accelerator_set(widget, value)
- on_auto_complete_enabled_toggled(widget, value)
- on_completion(args)
- on_list_values_changed_event(widget, values)
- on_max_rows_changed(widget, value)
- on_show_filechooser_toggled(widget, value)
- on_show_folder_on_button_toggled(widget, value)
- on_show_path_entry_toggled(widget, value)
- set_config(config)
- deluge.ui.gtk3.path_chooser.PathChoosersHandler()
- deluge.ui.gtk3.path_chooser.singleton(cls)
deluge.ui.gtk3.path_combo_chooser module
- class deluge.ui.gtk3.path_combo_chooser.CompletionList
Bases:
deluge.ui.gtk3.path_combo_chooser.ValueList
- on_completion_treeview_key_press_event(widget, event)
- on_completion_treeview_motion_notify_event(widget, event)
- reduce_values(prefix)
Reduce the values in the liststore to those starting with the prefix.
- Parameters
prefix – the prefix to be matched
- class deluge.ui.gtk3.path_combo_chooser.PathAutoCompleter(builder, path_entry, max_visible_rows)
Bases:
object
- do_completion(value=None, forward_completion=True)
- is_auto_completion_accelerator(keyval, state)
- on_completion_popup_window_key_press_event(entry, event)
Handles key pressed events on the auto-completion popup window
- on_entry_text_delete_text(entry, start, end)
Do completion when characters are removed
- on_entry_text_insert_text(entry, new_text, new_text_length, position)
- set_use_popup(use)
- class deluge.ui.gtk3.path_combo_chooser.PathChooserComboBox(*args: Any, **kwargs: Any)
Bases:
gi.repository.Gtk.Box
,deluge.ui.gtk3.path_combo_chooser.StoredValuesPopup
,gi.repository.GObject.GObject
- complete(args)
Perform the auto completion with the provided paths
- get_accelerator_string()
- get_auto_complete_enabled()
- get_filechooser_button_enabled()
- get_filechooser_button_visible()
- get_path_entry_visible()
- get_show_folder_name_on_button()
- get_text()
Get the current text in the Entry
- on_entry_text_changed(entry)
- set_accelerator_string(accelerator)
Set the accelerator string to trigger auto-completion
- set_auto_complete_enabled(enable)
- set_auto_completer_func(func)
Set the function to be called when the auto completion accelerator is triggered.
- set_enable_properties(enable)
Enable/disable the config properties
- set_filechooser_button_enabled(enable)
Enable/disable the filechooser button.
By setting filechooser disabled, in will not be possible to change the settings in the properties.
- set_filechooser_button_visible(visible, update=True)
Set file chooser button entry visible
- set_path_entry_visible(visible)
Set the path entry visible
- set_sensitive(sensitive)
Set the path chooser widgets sensitive
- Parameters
sensitive (bool) – if the widget should be sensitive
- set_show_folder_name_on_button(show)
Enable/disable showing hidden files on path completion
- set_text(text, set_file_chooser_folder=True, cursor_end=True, default_text=False, trigger_event=False)
Set the text for the entry.
- class deluge.ui.gtk3.path_combo_chooser.PathChooserPopup(min_visible_rows, max_visible_rows, popup_alignment_widget)
Bases:
object
This creates the popop window for the ComboEntry.
- get_max_popup_rows()
- get_position()
Returns the size of the popup window and the coordinates on the screen.
- is_popped_up()
Check if window is popped up.
- Returns
bool – True if popped up, False otherwise.
- on_popup_window_button_press_event(window, event)
- popdown()
- popup()
Make the popup visible.
- popup_grab_window()
- set_entry_value(path, popdown=False)
Sets the text of the entry to the value in path
- set_max_popup_rows(rows)
- set_window_position_and_size()
- class deluge.ui.gtk3.path_combo_chooser.PathCompletionPopup(builder, path_entry, max_visible_rows)
Bases:
deluge.ui.gtk3.path_combo_chooser.CompletionList
,deluge.ui.gtk3.path_combo_chooser.PathChooserPopup
The auto completion popup
- on_completion_popup_window_focus_out_event(entry, event)
Popup sometimes loses the focus to the text entry, e.g. when right click shows a popup menu on a row. This regains the focus.
- on_scroll_event(widget, event)
Handles scroll events from the treeview
- popup()
Makes the popup visible.
- class deluge.ui.gtk3.path_combo_chooser.StoredValuesList
Bases:
deluge.ui.gtk3.path_combo_chooser.ValueList
- on_cellrenderertext_edited(cellrenderertext, path, new_text)
Callback on the ‘edited’ signal.
Sets the new text in the path and disables editing on the renderer.
- on_edit_path(path, column)
Starts editing on the provided path
- Parameters
path (tuple) – the paths to edit
column (Gtk.TreeViewColumn) – the column to edit
- on_stored_values_treeview_key_press_event(widget, event)
- on_stored_values_treeview_key_release_event(widget, event)
Mimics Combobox behavior
Escape or Alt+Up: Close Enter or Return : Select
- on_treeview_mouse_button_press_event(treeview, event)
Shows popup on selected row when right clicking When left clicking twice, the row value is set for the text entry and the popup is closed.
- remove_selected_path()
- class deluge.ui.gtk3.path_combo_chooser.StoredValuesPopup(builder, path_entry, max_visible_rows, popup_alignment_widget)
Bases:
deluge.ui.gtk3.path_combo_chooser.StoredValuesList
,deluge.ui.gtk3.path_combo_chooser.PathChooserPopup
The stored values popup
- add_current_value_to_saved_list()
- edit_selected_path()
- on_button_add_clicked(widget)
- on_button_default_clicked(widget)
- on_button_down_clicked(widget)
- on_button_edit_clicked(widget)
- on_button_remove_clicked(widget)
- on_button_up_clicked(widget)
- on_buttonbox_key_press_event(widget, event)
Handles when Escape or ALT+arrow up is pressed when focus is on any of the buttons in the popup
- on_scroll_event(widget, event)
Handles scroll events from text entry, toggle button and treeview
- on_stored_values_popup_window_focus_out_event(entry, event)
Popup sometimes loses the focus to the text entry, e.g. when right click shows a popup menu on a row. This regains the focus.
- popup()
Makes the popup visible.
- class deluge.ui.gtk3.path_combo_chooser.ValueList
Bases:
object
- add_values(paths, append=True, scroll_to_row=False, clear=False, emit_signal=False)
Add paths to the liststore
- Parameters
paths (list) – the paths to add
append (boolean) – if the values should be appended or inserted
scroll_to_row (boolean) – if the treeview should scroll to the new row
- get_selected_value()
- get_selection_path()
Returns the (first) selected path from a treeview
- get_values()
Returns the values in the list.
- get_values_count()
- handle_list_scroll(_next=None, path=None, set_entry=False, swap=False, scroll_window=False)
Handles changes to the row selection.
- Parameters
_next (boolean/None) – the direction to change selection. True means down and False means up. None means no change.
path (tuple) – the current path. If None, the currently selected path is used.
set_entry (boolean) – if the new value should be set in the text entry.
swap (boolean) – if the old and new value should be swapped
- on_treeview_mouse_button_press_event(treeview, event, double_click=False)
When left clicking twice, the row value is set for the text entry and the popup is closed.
- on_value_list_treeview_key_press_event(widget, event)
Mimics Combobox behavior
Escape or Alt+Up: Close Enter or Return : Select
- paths_without_trailing_path_sep = False
- remove_selected_path()
- set_path_selected(path)
- set_selected_value(value, select_first=False)
Select the row of the list with value
- Parameters
value (str) – the value to be selected
select_first (boolean) – if the first item should be selected if the value if not found.
- set_values(paths, scroll_to_row=False, preserve_selection=True)
Add paths to the liststore
- Parameters
paths (list) – the paths to add
scroll_to_row (boolean) – if the treeview should scroll to the new row
- deluge.ui.gtk3.path_combo_chooser.is_ascii_value(keyval, ascii_key)
- deluge.ui.gtk3.path_combo_chooser.key_is_down(keyval)
- deluge.ui.gtk3.path_combo_chooser.key_is_enter(keyval)
- deluge.ui.gtk3.path_combo_chooser.key_is_pgup_or_pgdown(keyval)
- deluge.ui.gtk3.path_combo_chooser.key_is_up(keyval)
- deluge.ui.gtk3.path_combo_chooser.key_is_up_or_down(keyval)
- deluge.ui.gtk3.path_combo_chooser.path_without_trailing_path_sep(path)
deluge.ui.gtk3.peers_tab module
deluge.ui.gtk3.piecesbar module
- class deluge.ui.gtk3.piecesbar.PiecesBar(*args: Any, **kwargs: Any)
Bases:
gi.repository.Gtk.DrawingArea
- clear()
- static create_roundcorners_subpath(ctx, x, y, width, height)
- do_draw(event)
- do_size_allocate_event(widget, size)
- draw_pieces()
- draw_progress_overlay()
- get_fraction()
- get_pieces()
- get_text()
- resized()
- roundcorners_border()
- roundcorners_clipping()
- set_fraction(fraction)
- set_pieces(pieces, num_pieces)
- set_text(text)
- update()
- write_text()
deluge.ui.gtk3.pluginmanager module
- class deluge.ui.gtk3.pluginmanager.PluginManager
Bases:
deluge.pluginmanagerbase.PluginManagerBase
,deluge.component.Component
- add_preferences_page(*args)
- add_toolbar_button(*args, **kwargs)
- add_toolbar_separator()
- add_torrentview_text_column(*args, **kwargs)
- deregister_hook(hook, function)
Deregisters a hook function
- get_selected_torrents()
Returns a list of the selected torrent_ids
- register_hook(hook, function)
Register a hook function with the plugin manager
- remove_preferences_page(*args)
- remove_toolbar_button(*args)
- remove_torrentview_column(*args)
- run_on_apply_prefs()
This hook is run after the user clicks Apply or OK in the preferences dialog.
- run_on_show_prefs()
This hook is run before the user is shown the preferences dialog. It is designed so that plugins can update their preference page with the config.
- start()
Start the plugin manager
- stop()
- update()
- update_torrent_view(*args)
deluge.ui.gtk3.preferences module
- class deluge.ui.gtk3.preferences.Preferences
Bases:
deluge.component.Component
- add_page(name, widget)
Add a another page to the notebook
- hide()
- load_languages()
- load_pref_dialog_state()
- on_accounts_add_clicked(widget)
- on_accounts_delete_clicked(widget)
- on_accounts_edit_clicked(widget)
- on_accounts_selection_changed(treeselection)
- on_button_apply_clicked(data)
- on_button_associate_magnet_clicked(widget)
- on_button_cache_refresh_clicked(widget)
- on_button_cancel_clicked(data)
- on_button_find_plugins_clicked(widget)
- on_button_ok_clicked(data)
- on_button_plugin_install_clicked(widget)
- on_button_rescan_plugins_clicked(widget)
- on_checkbutton_language_toggled(widget)
- on_combo_encryption_changed(widget)
- on_combo_proxy_type_changed(widget)
- on_completed_color_set(widget)
- on_downloading_color_set(widget)
- on_entry_proxy_host_paste_clipboard(widget)
- on_get_known_accounts(known_accounts)
- on_missing_color_set(widget)
- on_piecesbar_toggle_toggled(widget)
- on_plugin_selection_changed(treeselection)
- on_plugin_toggled(renderer, path)
- on_pref_dialog_configure_event(widget, event)
- on_pref_dialog_delete_event(widget, event)
- on_revert_color_completed_clicked(widget)
- on_revert_color_downloading_clicked(widget)
- on_revert_color_missing_clicked(widget)
- on_revert_color_waiting_clicked(widget)
- on_selection_changed(treeselection)
- on_test_port_clicked(data)
- on_toggle(widget)
Handles widget sensitivity based on radio/check button values.
- on_urldetect_toggle_toggled(widget)
- on_waiting_color_set(widget)
- remove_page(name)
Removes a page from the notebook
- set_config(hide=False)
Sets all altered config values in the core.
- Parameters
hide – bool, if True, will not re-show the dialog and will hide it instead
- setup_path_choosers()
- show(page=None)
Page should be the string in the left list.. ie, ‘Network’ or ‘Bandwidth’
- start()
- stop()
deluge.ui.gtk3.queuedtorrents module
- class deluge.ui.gtk3.queuedtorrents.QueuedTorrents
Bases:
deluge.component.Component
- add_to_queue(torrents)
Adds the list of torrents to the queue
- on_button_add_clicked(widget)
- on_button_clear_clicked(widget)
- on_button_close_clicked(widget)
- on_button_remove_clicked(widget)
- on_chk_autoadd_toggled(widget)
- on_statusbar_click(widget, event)
- run()
- start()
- stop()
- update_status_bar()
Attempts to update status bar
deluge.ui.gtk3.removetorrentdialog module
- class deluge.ui.gtk3.removetorrentdialog.RemoveTorrentDialog(torrent_ids, delete_files=False)
Bases:
object
This class is used to create and show a Remove Torrent Dialog.
- Parameters
torrent_ids (list of torrent_ids) – the torrent_ids to remove
- Raises
TypeError – if torrent_id is not a sequence type
ValueError – if torrent_id contains no torrent_ids or is None
- on_delete_files_toggled(widget)
- run()
Shows the dialog and awaits for user input. The user can select to remove the torrent(s) from the session with or without their data.
deluge.ui.gtk3.status_tab module
deluge.ui.gtk3.statusbar module
- class deluge.ui.gtk3.statusbar.StatusBar
Bases:
deluge.component.Component
- add_item(image=None, stock=None, icon=None, text=None, markup=False, callback=None, tooltip=None, pack_start=False)
Adds an item to the status bar
- add_timeout_item(seconds=3, image=None, stock=None, icon=None, text=None, callback=None)
Adds an item to the StatusBar for seconds
- clear_statusbar()
- display_warning(text, callback=None)
Displays a warning to the user in the status bar
- on_configvaluechanged_event(key, value)
This is called when we receive a ConfigValueChangedEvent from the core.
- remove_item(item)
Removes an item from the statusbar
- remove_warning(item)
- send_status_request()
- set_limit_value(widget, core_key)
- show_not_connected()
- start()
- stop()
- update()
- update_connections_label()
- update_dht_label()
- update_download_label()
- update_traffic_label()
- update_upload_label()
- visible(visible)
- class deluge.ui.gtk3.statusbar.StatusBarItem(image=None, stock=None, icon=None, text=None, markup=False, callback=None, tooltip=None)
Bases:
object
- get_eventbox()
- get_text()
- get_widgets()
- set_callback(callback)
- set_image_from_file(image)
- set_image_from_icon(icon)
- set_image_from_stock(stock)
- set_markup(text)
- set_text(text)
- set_tooltip(tip)
- show_all()
deluge.ui.gtk3.systemtray module
- class deluge.ui.gtk3.systemtray.SystemTray
Bases:
deluge.component.Component
- blink(value)
- config_value_changed(key, value)
This is called when we received a config_value_changed signal from the core.
- disable(invert_app_ind_conf=False)
Disables the system tray icon or Appindicator.
- enable()
Enables the system tray icon.
- on_enable_appindicator_set(key, value)
Called whenever the ‘enable_appindicator’ config key is modified
- on_enable_system_tray_set(key, value)
Called whenever the ‘enable_system_tray’ config key is modified
- on_tray_clicked(icon)
Called when the tray icon is left clicked.
- on_tray_popup(status_icon, button, activate_time)
Called when the tray icon is right clicked.
- on_tray_setbwdown(widget, data=None)
- on_tray_setbwup(widget, data=None)
- send_status_request()
- setbwlimit(widget, header, text, core_key, ui_key, default, image)
Sets the bandwidth limit based on the user selection.
- shutdown()
- start()
- stop()
- update()
deluge.ui.gtk3.tab_data_funcs module
- deluge.ui.gtk3.tab_data_funcs.fcount(value)
- deluge.ui.gtk3.tab_data_funcs.fdate_or_dash(value)
Display value as date, eg 05/05/08 or dash
- deluge.ui.gtk3.tab_data_funcs.fdate_or_never(value)
Display value as date, eg 05/05/08 or Never
- deluge.ui.gtk3.tab_data_funcs.fpcnt(value, state, message)
- deluge.ui.gtk3.tab_data_funcs.fpieces_num_size(num_pieces, piece_size)
- deluge.ui.gtk3.tab_data_funcs.fratio(value)
- deluge.ui.gtk3.tab_data_funcs.fseed_rank_or_dash(seed_rank, seeding_time)
Display value if seeding otherwise dash
- deluge.ui.gtk3.tab_data_funcs.fspeed_max(value, max_value=- 1)
- deluge.ui.gtk3.tab_data_funcs.ftime_or_dash(value)
Display value as time, eg 2h 30m or dash
- deluge.ui.gtk3.tab_data_funcs.ftotal_sized(first, second)
- deluge.ui.gtk3.tab_data_funcs.ftranslate(text)
- deluge.ui.gtk3.tab_data_funcs.fyes_no(value)
Return Yes or No to bool value
deluge.ui.gtk3.toolbar module
- class deluge.ui.gtk3.toolbar.ToolBar
Bases:
deluge.component.Component
- add_separator(position=None)
Adds a separator toolitem
- add_toolbutton(callback, label=None, image=None, stock=None, tooltip=None)
Adds a toolbutton to the toolbar
- on_toolbutton_add_clicked(data)
- on_toolbutton_connectionmanager_clicked(data)
- on_toolbutton_pause_clicked(data)
- on_toolbutton_preferences_clicked(data)
- on_toolbutton_queue_down_clicked(data)
- on_toolbutton_queue_up_clicked(data)
- on_toolbutton_remove_clicked(data)
- on_toolbutton_resume_clicked(data)
- remove(widget)
Removes a widget from the toolbar
- start()
- stop()
- visible(visible)
deluge.ui.gtk3.torrentdetails module
The torrent details component shows info about the selected torrent.
- class deluge.ui.gtk3.torrentdetails.Tab(name=None, child_widget=None, tab_label=None)
Bases:
object
- add_tab_widget(widget_id, format_func, status_keys)
Create TabWidget item in tab_widgets dictionary.
- Parameters
widget_id (str) – The widget id used to retrieve widget from mainwindow builder.
format_func (str) – A func name related to widget e.g. string label formatter.
status_keys (list) – List of status keys to lookup for the widget.
- get_child_widget()
- get_name()
- get_tab_label()
- class deluge.ui.gtk3.torrentdetails.TabWidget(obj, func, status_keys)
Bases:
tuple
- property func
Alias for field number 1
- property obj
Alias for field number 0
- property status_keys
Alias for field number 2
- class deluge.ui.gtk3.torrentdetails.TorrentDetails
Bases:
deluge.component.Component
- add_tab(tab, generate_menu=True, visible=None)
- clear()
Returns a menu to select which side of the notebook the tabs should be shown
Generates the checklist menu for all the tabs and attaches it
- hide_all_tabs()
Hides all tabs
- hide_tab(tab_name)
Hides tab by name
- load_state()
- regenerate_positions()
Sync the positions in the tab, with the position stored in the tab object
- remove_tab(tab_name)
Removes a tab by name.
- save_state()
We save the state, which is basically the tab_index list
- set_tab_visible(tab_name, visible)
Sets the tab to visible
- show_all_tabs()
Shows all tabs
- show_tab(tab_name, generate_menu=True)
- shutdown()
- start()
- stop()
- tab_insert_position(weight)
Returns the position a tab with a given weight should be inserted in
- update(page_num=None)
- visible(visible)
deluge.ui.gtk3.torrentview module
The torrent view component that lists all torrents in the session.
- class deluge.ui.gtk3.torrentview.SearchBox(torrentview)
Bases:
object
- clear_search()
- hide()
- on_close_search_button_clicked(widget)
- on_search_filter_toggle(widget)
- on_search_torrents_entry_changed(widget)
- on_search_torrents_entry_icon_press(entry, icon, event)
- on_search_torrents_match_toggled(widget)
- prefilter_torrentview()
- set_search_filter()
- show()
- class deluge.ui.gtk3.torrentview.TorrentView
Bases:
deluge.ui.gtk3.listview.ListView
,deluge.component.Component
TorrentView handles the listing of torrents.
- add_rows(torrent_ids)
Accepts a list of torrent_ids to add to self.liststore
- get_selected_torrent()
Returns a torrent_id or None. If multiple torrents are selected, it will return the torrent_id of the first one.
- get_selected_torrents()
Returns a list of selected torrents or None
- get_torrent_status(torrent_id)
Returns data stored in self.status, it may not be complete
- get_visible_torrents()
- keypress_delete(event)
- keypress_down(event)
Handle any Down arrow keypresses
- keypress_up(event)
Handle any Up arrow keypresses
- mark_dirty(torrent_id=None)
- on_button_press_event(widget, event)
This is a callback for showing the right-click context menu.
- on_columns_changed_event(treeview)
- on_drag_data_received(widget, drag_context, x, y, selection_data, info, timestamp)
- on_drag_drop(widget, drag_context, x, y, timestamp)
- on_key_press_event(widget, event)
- on_selection_changed(treeselection)
This callback is know when the selection has changed.
- on_sessionpaused_event()
- on_sessionresumed_event()
- on_torrentadded_event(torrent_id, from_state)
- on_torrentqueuechanged_event()
- on_torrentremoved_event(torrent_id)
- on_torrentstatechanged_event(torrent_id, state)
- remove_column(header)
Removes the column with the name ‘header’ from the torrentview
- remove_row(torrent_id)
Removes a row with torrent_id
- save_state()
Saves the state of the torrent view.
- select_first_row(ignored=None)
Set the first row in the list selected if a selection does not already exist
- send_status_request(columns=None, select_row=False)
- set_columns_to_update(columns=None)
- set_filter(filter_dict)
Sets filters for the torrentview..
see: core.get_torrents_status
- shutdown()
Called when GtkUi is exiting
- start()
Start the torrentview
- stop()
Stops the torrentview
- update(select_row=False)
Sends a status request to core and updates the torrent list with the result.
- Parameters
select_row (boolean) – if the first row in the list should be selected if no rows are already selected.
- update_view(load_new_list=False)
Update the torrent view model with data we’ve received.
- deluge.ui.gtk3.torrentview.eta_column_sort(model, iter1, iter2, data)
- deluge.ui.gtk3.torrentview.progress_sort(model, iter1, iter2, sort_column_id)
- deluge.ui.gtk3.torrentview.queue_column_sort(model, iter1, iter2, data)
- deluge.ui.gtk3.torrentview.queue_peer_seed_sort_function(v1, v2)
- deluge.ui.gtk3.torrentview.seed_peer_column_sort(model, iter1, iter2, data)
- deluge.ui.gtk3.torrentview.str_nocase_sort(model, iter1, iter2, data)
Sort string column data using ISO 14651 in lowercase.
Uses locale.strcoll which (allegedly) uses ISO 14651. Compares first value with second and returns -1, 0, 1 for where it should be placed.
deluge.ui.gtk3.torrentview_data_funcs module
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_date(column, cell, model, row, data, key)
Display value as date, eg 05/05/08
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_date_added(column, cell, model, row, data, *, key='cell_data_date_added')
Display value as date, eg 05/05/08
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_date_completed(column, cell, model, row, data, *, key='cell_data_date_completed')
Display value as date, eg 05/05/08
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_date_or_never(column, cell, model, row, data)
Display value as date, eg 05/05/08 or Never
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_peer(column, cell, model, row, data)
Display values as ‘value1 (value2)’
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_peer_progress(column, cell, model, row, data)
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_progress(column, cell, model, row, data)
Display progress bar with text
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_queue(column, cell, model, row, data)
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_ratio(cell, model, row, data, cache_key)
Display value as a ratio with a precision of 2.
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_ratio_avail(column, cell, model, row, data)
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_ratio_ratio(column, cell, model, row, data)
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_ratio_seeds_peers(column, cell, model, row, data)
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_size(column, cell, model, row, data)
Display value in terms of size, eg. 2 MB
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_speed(cell, model, row, data)
Display value as a speed, eg. 2 KiB/s
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_speed_down(column, cell, model, row, data)
Display value as a speed, eg. 2 KiB/s
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_speed_limit(cell, model, row, data, cache_key)
Display value as a speed, eg. 2 KiB/s
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_speed_limit_down(column, cell, model, row, data)
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_speed_limit_up(column, cell, model, row, data)
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_speed_up(column, cell, model, row, data)
Display value as a speed, eg. 2 KiB/s
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_statusicon(column, cell, model, row, data)
Display text with an icon
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_time(column, cell, model, row, data)
Display value as time, eg 1m10s
- deluge.ui.gtk3.torrentview_data_funcs.cell_data_trackericon(column, cell, model, row, data)
- deluge.ui.gtk3.torrentview_data_funcs.set_tracker_icon(tracker_icon, cell)
deluge.ui.gtk3.trackers_tab module
- class deluge.ui.gtk3.trackers_tab.TrackersTab
Bases:
deluge.ui.gtk3.torrentdetails.Tab
- clear()
- on_button_edit_trackers_clicked(button)
- update()
Module contents
- class deluge.ui.gtk3.Gtk(*args, **kwargs)
Bases:
deluge.ui.ui.UI
- cmd_description = 'GTK-based graphical user interface'
- start()
- deluge.ui.gtk3.start()