Trees       Indices       Help   
conduit
Package conduit :: Package modules :: Module TomboyModule :: Class TomboyNoteTwoWay
[hide private]

Class TomboyNoteTwoWay

source code

LUID is the tomboy uid string

Instance Methods [hide private]
 
__init__(self, *args)
All sync functionality should be provided by derived classes		 source code
 
_connect_to_tomboy(self) source code
 
_update_note(self, uid, note) source code
 
_get_note_mtime(self, uid) source code
 
_get_note(self, uid) source code
 
_create_note(self, note) source code
bool
initialize(self)
Loads the tomboy source if the user has used tomboy before		 source code
 
refresh(self)
Performs any (conduit.logging in, etc) which must be undertaken on the dataprovider prior to calling get_all().		 source code
conduit.DataType.DataType
get(self, uri)
Returns data with the specified LUID.		 source code
 
get_all(self)
Returns an array of all the LUIDs this dataprovider holds.		 source code
 
put(self, note, overwrite, LUID=None)
Stores a Note in Tomboy.		 source code
 
delete(self, LUID)
Deletes data with LUID.		 source code
 
finish(self, aborted, error, conflict)
Perform any post-sync cleanup.		 source code
string
get_UID(self)
Returns a UID that represents this dataproviders (locally) unique state and configuration.		 source code

Inherited from dataproviders.DataProvider.DataSource: add, get_changes, get_num_items

Inherited from dataproviders.DataProvider.DataProviderBase: configure, emit, emit_change_detected, get_configuration, 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, set_configuration, set_configuration_xml, set_status, uninitialize

Inherited from dataproviders.AutoSync.AutoSync: handle_added, handle_deleted, handle_modified

Inherited from dataproviders.AutoSync.AutoSync (private): _handle_change, _handle_sync

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]
  _name_ = "Tomboy Notes"
  _description_ = "Sync your Tomboy notes"
  _category_ = DataProviderCategory.DataProviderCategory("Notes"...
  _module_type_ = "twoway"
  _in_type_ = "note/tomboy"
  _out_type_ = "note/tomboy"
  _icon_ = "tomboy"
  _configurable_ = False
  TOMBOY_DBUS_PATH = "/org/gnome/Tomboy/RemoteControl"
  TOMBOY_DBUS_IFACE = "org.gnome.Tomboy"
  TOMBOY_MIN_VERSION = 0, 5, 10
  TOMBOY_COMPLETE_XML_VERSION = 0, 9, 0

Inherited from dataproviders.DataProvider.DataProviderBase: __gsignals__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args)
(Constructor)

source code 
All sync functionality should be provided by derived classes
Overrides: dataproviders.DataProvider.TwoWay.__init__

initialize(self)

source code 
Loads the tomboy source if the user has used tomboy before
Returns: bool
True if the module initialized correctly (is appropriate for the user), False otherwise
Overrides: dataproviders.DataProvider.DataProviderBase.initialize

refresh(self)

source code 

Performs any (conduit.logging in, etc) which must be undertaken on the dataprovider prior to calling get_all(). Should gather all information so a subsequent call to get_all() can return the uids of all the data this dataprovider holds

This function may be called multiple times so derived classes should be aware of this.

Derived classes should call this function to ensure the dataprovider status is updated.
Overrides: dataproviders.DataProvider.DataProviderBase.refresh
(inherited documentation)

get(self, uri)

source code 

Returns data with the specified LUID. This function must be overridden by the appropriate dataprovider.

Derived classes should call this function to ensure the dataprovider status is updated.
Returns: conduit.DataType.DataType
An item of data
Overrides: dataproviders.DataProvider.DataSource.get
(inherited documentation)

get_all(self)

source code 
Returns an array of all the LUIDs this dataprovider holds.
Overrides: dataproviders.DataProvider.DataSource.get_all
(inherited documentation)

put(self, note, overwrite, LUID=None)

source code 
Stores a Note in Tomboy.
Overrides: dataproviders.DataProvider.DataSink.put

delete(self, LUID)

source code 
Deletes data with LUID.
Overrides: dataproviders.DataProvider.DataSink.delete
(inherited documentation)

finish(self, aborted, error, conflict)

source code 
Perform any post-sync cleanup. For example, free any structures created in refresh that were used in the synchronization.
Overrides: dataproviders.DataProvider.DataProviderBase.finish
(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)

Class Variable Details [hide private]

_category_

Value:
DataProviderCategory.DataProviderCategory("Notes", "tomboy")

   Trees       Indices       Help   
conduit
Generated by Epydoc 3.0beta1 on Sat Aug 2 22:18:37 2008 http://epydoc.sourceforge.net