Package advene :: Module gui :: Module views :: Class AdhocView

Class AdhocView

object --+
         |
        AdhocView

Known Subclasses:

Implementation of the generic parts of AdhocViews.

For details about the API of adhoc views, see gui.views.viewplugin.

Instance Methods

[hide private]

__init__(self, controller=None, parameters=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

attach_view(self, menuitem, window)

source code

build_widget(self)

source code

close(self, *p)

source code

export_as_static_view(self, ident=None)
Propose to export the view as a static view.

source code

get_save_arguments(self)
Method called when saving a parametered view.

source code

get_widget(self)
Return the widget.

source code

load_parameters(self, param)
Parse the parameters from a Content object, a tuple or an ElementTree.Element

source code

log(self, msg, level=None)

source code

message(self, m)
Display a message in the statusbar, if present.

source code

parameters_to_element(self, options=None, arguments=None)
Generate an ET.Element representing the view and its parameters.

source code

popup(self, label=None)

source code

register_slave_view(self, v)

source code

safe_connect(self, obj, *p)
Connect a signal handler to a gobject.

source code

save_default_options(self, *p)
Save the default options.

source code

save_parameters(self, content, options=None, arguments=None)
Save the view parameters to a Content object.

source code

save_view(self, *p)

source code

set_label(self, label)

source code

unregister_slave_view(self, v)

source code

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

Class Variables

[hide private]

tooltip = 'This view is a generic abstract view that should be...

view_id = 'generic'

view_name = 'Generic adhoc view'

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, controller=None, parameters=None)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__

export_as_static_view(self, ident=None)

source code

Propose to export the view as a static view.

The as_html() method must be implemented.

get_save_arguments(self)

source code

Method called when saving a parametered view.

It should return a tuple (options, arguments) where options is the options dictionary, and arguments is a list of (name, value) tuples).

If it returns None, None, it means that the view saving is cancelled.

load_parameters(self, param)

source code

Parse the parameters from a Content object, a tuple or an ElementTree.Element

It will return a tuple (options, arguments) where options is a dictionary and arguments a list of tuples (name, value).

If param is None, then try to load default options, if they exist. They should be stored in config.data.advenefile( ('defaults', self.view_id + '.xml'), 'settings')

In case of problem, it will simply return None, None.

safe_connect(self, obj, *p)

source code

Connect a signal handler to a gobject.

It memorizes the handler id so that it is properly disconnected upon view closing.

Class Variable Details

[hide private]

tooltip

Value:

'This view is a generic abstract view that should be derived by real v
iews.'

Class AdhocView

__init__(self, controller=None, parameters=None) (Constructor)

export_as_static_view(self, ident=None)

get_save_arguments(self)

load_parameters(self, param)

safe_connect(self, obj, *p)

tooltip

init(self, controller=None, parameters=None)
(Constructor)