Coverage for deluge/event : 85%
Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
|
# -*- coding: utf-8 -*- # # Copyright (C) 2009 Andrew Resch <andrewresch@gmail.com> # # This file is part of Deluge and is licensed under GNU General Public License 3.0, or later, with # the additional special exception to link portions of this program with the OpenSSL library. # See LICENSE for more details. #
Event module.
This module describes the types of events that can be generated by the daemon and subsequently emitted to the clients.
"""
""" This metaclass simply keeps a list of all events classes created. """
""" The base class for all events.
:prop name: this is the name of the class which is in-turn the event name :type name: string :prop args: a list of the attribute values :type args: list
"""
return []
""" Emitted when a new torrent is successfully added to the session. """ """ :param torrent_id: the torrent_id of the torrent that was added :type torrent_id: string :param from_state: was the torrent loaded from state? Or is it a new torrent. :type from_state: bool """
""" Emitted when a torrent has been removed from the session. """ """ :param torrent_id: the torrent_id :type torrent_id: string """
""" Emitted when a torrent is about to be removed from the session. """ """ :param torrent_id: the torrent_id :type torrent_id: string """
""" Emitted when a torrent changes state. """ """ :param torrent_id: the torrent_id :type torrent_id: string :param state: the new state :type state: string """
""" Emitted when the queue order has changed. """
""" Emitted when a folder within a torrent has been renamed. """ """ :param torrent_id: the torrent_id :type torrent_id: string :param old: the old folder name :type old: string :param new: the new folder name :type new: string """
""" Emitted when a file within a torrent has been renamed. """ """ :param torrent_id: the torrent_id :type torrent_id: string :param index: the index of the file :type index: int :param name: the new filename :type name: string """ self._args = [torrent_id, index, name]
""" Emitted when a torrent finishes downloading. """ """ :param torrent_id: the torrent_id :type torrent_id: string """ self._args = [torrent_id]
""" Emitted when a torrent resumes from a paused state. """ """ :param torrent_id: the torrent_id :type torrent_id: string """
""" Emitted when a file completes. """ """ :param torrent_id: the torrent_id :type torrent_id: string :param index: the file index :type index: int """ self._args = [torrent_id, index]
""" Emitted when the storage location for a torrent has been moved. """ """ :param torrent_id: the torrent_id :type torrent_id: string :param path: the new location :type path: string """ self._args = [torrent_id, path]
""" Emitted when creating a torrent file remotely. """ self._args = [piece_count, num_pieces]
""" Emitted when a more recent version of Deluge is available. """ """ :param new_release: the new version that is available :type new_release: string """ self._args = [new_release]
""" Emitted when a session has started. This typically only happens once when the daemon is initially started. """
""" Emitted when the session has been paused. """
""" Emitted when the session has been resumed. """
""" Emitted when a config value changes in the Core. """ """ :param key: the key that changed :type key: string :param value: the new value of the `:param:key` """ self._args = [key, value]
""" Emitted when a plugin is enabled in the Core. """ self._args = [plugin_name]
""" Emitted when a plugin is disabled in the Core. """ self._args = [plugin_name] |