Package p6 :: Module api
[show private | hide private]
[frames | no frames]

Module p6.api

p6.api

Collects frequently used functions in a single module.
Function Summary
Unbound callable deinstify(func)
Decorator to strip an instance method of it's "self" paramter, making it work properly as a non-bound function or adapter.
  findField(field_id, item)
Returns the value of the metadata field specified.
wx.App getApp()
Returns a reference to the current Application object.
string getAppSupportDir()
Returns the Application Support directory where we can store preferences and persisted metadata information.
  nearest(items, target)

Function Details

deinstify(func)

Decorator to strip an instance method of it's "self" paramter, making it work properly as a non-bound function or adapter.
Parameters:
func - The instance method to decorate
           (type=Bound instance method (callable))
Returns:
Unbound callable

findField(field_id, item=None)

Returns the value of the metadata field specified.
Parameters:
field_id - the identifier of the field to retrieve
           (type=string)
item - the item we want the value to apply to, or None for Work
           (type=None or adaptable to p6.metadata.interfaces.IMetadataStorage)
Returns:
the value of the metadata field

getApp()

Returns a reference to the current Application object.
Returns:
the current Application object
           (type=wx.App)

getAppSupportDir()

Returns the Application Support directory where we can store preferences and persisted metadata information.
Returns:
path to the application directory
           (type=string)

Generated by Epydoc 2.1 on Fri Jun 24 12:01:26 2005 http://epydoc.sf.net