Package conduit :: Package modules :: Module TestModule :: Class _TestBase

Class _TestBase

source code

Instance Methods

[hide private]

__init__(self)
All sync functionality should be provided by derived classes

source code

_change_detected(self, *args)

source code

bool

initialize(self)
Called when the module is loaded by the module loader.

source code

configure(self, window)
Show a configuration box for configuring the dataprovider instance.

source code

string

get_UID(self)
Returns a UID that represents this dataproviders (locally) unique state and configuration.

source code

dict(string)

get_configuration(self)
Returns a dictionary of strings to be saved, representing the dataproviders current configuration.

source code

Inherited from dataproviders.DataProvider.DataProviderBase: emit, emit_change_detected, finish, get_configuration_xml, get_input_conversion_args, get_input_type, get_name, get_output_conversion_args, get_output_type, get_status, is_busy, is_configured, refresh, set_configuration, set_configuration_xml, set_status, uninitialize

Class Variables

[hide private]

_configurable_ = True

Inherited from dataproviders.DataProvider.DataProviderBase: __gsignals__, _category_, _description_, _icon_, _in_type_, _module_type_, _name_, _out_type_

Method Details

[hide private]

init(self)
(Constructor)

source code

All sync functionality should be provided by derived classes

Overrides: dataproviders.DataProvider.DataProviderBase.__init__: (inherited documentation)

initialize(self)

source code

Called when the module is loaded by the module loader.

It is called in the main thread so should NOT block. It should perform simple tests to determine whether the dataprovider is applicable to the user and whether is should be presented to them. For example it may check if a specific piece of hardware is loaded, or check if a user has the specific piece of software installed with which it synchronizes.

Returns: bool: True if the module initialized correctly (is appropriate for the user), False otherwise
Overrides: dataproviders.DataProvider.DataProviderBase.initialize: (inherited documentation)

configure(self, window)

source code

Show a configuration box for configuring the dataprovider instance.

Overrides: dataproviders.DataProvider.DataProviderBase.configure: (inherited documentation)

get_UID(self)

source code

Returns a UID that represents this dataproviders (locally) unique state and configuration. For example the LUID for a gmail dp may be your username and password.

Derived types MUST overwride this function

Returns: string
Overrides: dataproviders.DataProvider.DataProviderBase.get_UID: (inherited documentation)

get_configuration(self)

source code

Returns a dictionary of strings to be saved, representing the dataproviders current configuration. Should be overridden by all dataproviders wishing to be able to save their state between application runs

Returns: dict(string): Dictionary of strings containing application settings
Overrides: dataproviders.DataProvider.DataProviderBase.get_configuration: (inherited documentation)

Class _TestBase

__init__(self) (Constructor)

initialize(self)

configure(self, window)

get_UID(self)

get_configuration(self)

init(self)
(Constructor)