Package advene :: Package gui :: Package views :: Module activebookmarks :: Class ActiveBookmarks

Class ActiveBookmarks

object --+    
         |    
 AdhocView --+
             |
            ActiveBookmarks

ActiveBookmarks are another way to create annotations.

First, a time bookmark is set and associated with some text. This represents an incomplete annotation (the end bound is missing). Once the end bound is set, the triplet (t1, t2, content) is used to create an annotation. If no destination type was specified, then a new annotation type is created.

Instance Methods

[hide private]

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

source code

debug(self, widget, *p)

source code

get_type(self)

source code

set_type(self, t)

source code

register_callback(self, controller=None)

source code

unregister_callback(self, controller=None)

source code

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

source code

refresh(self, *p)

source code

remove(self, w)
Remove the given widget from mainbox.

source code

clear(self, *p)

source code

get_current_bookmark(self)

source code

set_current_bookmark(self, cur=None)

source code

move_boomark(self, bookmark, index)
Move the bookmark at the given position

source code

select_bookmark(self, index)
Set the 'index' bookmark as current.

source code

duplicate_bookmark(self, cur=None)
Duplicate a bookmark.

source code

generate_focus_chain(self, *p)

source code

append(self, t, index=None, after_current=False)

source code

check_contents(self, *p)
Check that annotation contents are in sync.

source code

update_model(self, package=None, partial_update=False)

source code

update_annotationtype(self, annotationtype=None, event=None)

source code

update_annotation(self, annotation=None, event=None)

source code

get_matching_bookmark(self, wid)
Return the bookmark whose begin or end image is wid.

source code

scroll_to_end(self)
Scroll to the bottom of the view.

source code

scroll_to_bookmark(self, b=None)
Ensure that the given bookmark (default: current) is visible.

source code

delete_origin_timestamp(self, wid)
Delete the timestamp from the widget wid.

source code

as_html(self, use_tal=True)

source code

set_image_size(self, size)

source code

clipboard_get(self, clipboard, selection, info, data)

source code

clipboard_clear(self, clipboard, data)

source code

copy_current_bookmark(self)
Copy the current bookmark into the clipboard.

source code

build_widget(self)

source code

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

Inherited from AdhocView

attach_view(self, menuitem, window)

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_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

Class Variables

[hide private]

view_name = 'ActiveBookmarks'

view_id = 'activebookmarks'

tooltip = 'ActiveBookmarks'

Properties

[hide private]

type

Inherited from object: __class__

Method Details

[hide private]

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

source code

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

Overrides: object.__init__: (inherited documentation)

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.

Overrides: AdhocView.get_save_arguments: (inherited documentation)

move_boomark(self, bookmark, index)

source code

Move the bookmark at the given position

-1 is for end of the list

duplicate_bookmark(self, cur=None)

source code

Duplicate a bookmark.

If no bookmark is given, then try to duplicate the current one.

get_matching_bookmark(self, wid)

source code

Return the bookmark whose begin or end image is wid.

Usually used in DND callbacks, with wid=context.get_source_widget()

build_widget(self)

source code

Overrides: AdhocView.build_widget

Property Details

[hide private]

type

Get Method:: get_type(self)
Set Method:: set_type(self, t)

Class ActiveBookmarks

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

get_save_arguments(self)

move_boomark(self, bookmark, index)

duplicate_bookmark(self, cur=None)

get_matching_bookmark(self, wid)

build_widget(self)

type

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