Package Camelot :: Package camelot :: Package admin :: Package list_action :: Class ListAction
[frames] | no frames]

Class ListAction

source code


Abstract base class to implement list actions

Use the class attribute Options, to let the user enter some options for the action. Where options is a class with and admin definition. The admin definition will be used to pop up an interface screen for an object of type Options.

Instance Methods
 
__init__(self, name, icon=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
render(self, parent, collection_getter, selection_getter)
Returns a QWidget the user can use to trigger the action
source code
 
run(self, collection_getter, selection_getter)
Overwrite this method to create an action that does something
source code

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

Class Variables
  Options = None
hash(x)
Properties

Inherited from object: __class__

Method Details

__init__(self, name, icon=None)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides: object.__init__
(inherited documentation)

run(self, collection_getter, selection_getter)

source code 

Overwrite this method to create an action that does something

an object of of type Options

Returns:
None if there was no Options class attribute or if Cancel was pressed, otherwise