PapersDocument.DocumentAnnotations¶

Implementations:: None

Methods¶

	`add_annotation` (annot)
	`can_add_annotation` ()
	`can_remove_annotation` ()
	`document_is_modified` ()
	`get_annotations` (page)
	`get_annotations_mapping` (page)
	`over_markup` (annot, x, y)
	`remove_annotation` (annot)
	`save_annotation` (annot, mask)

Virtual Methods¶

	`do_add_annotation` (annot)
	`do_document_is_modified` ()
	`do_get_annotations` (page)
	`do_get_annotations_mapping` (page)
	`do_over_markup` (annot, x, y)
	`do_remove_annotation` (annot)
	`do_save_annotation` (annot, mask)

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class PapersDocument.DocumentAnnotations¶

Bases:: GObject.GInterface
Structure:: PapersDocument.DocumentAnnotationsInterface

add_annotation(annot)¶

Parameters:: annot (PapersDocument.Annotation) –

can_add_annotation()¶

Return type:: bool

can_remove_annotation()¶

Return type:: bool

document_is_modified()¶

Return type:: bool

get_annotations(page)¶

Parameters:: page (PapersDocument.Page) – the page from where to get the annotations
Return type:: [PapersDocument.Annotation] or None

get_annotations_mapping(page)¶

Parameters:: page (PapersDocument.Page) –
Return type:: PapersDocument.MappingList

over_markup(annot, x, y)¶

Parameters:

annot (PapersDocument.Annotation) –
x (float) –
y (float) –

Return type:

PapersDocument.AnnotationsOverMarkup

remove_annotation(annot)¶

Parameters:: annot (PapersDocument.Annotation) –

save_annotation(annot, mask)¶

Parameters:

annot (PapersDocument.Annotation) –
mask (PapersDocument.AnnotationsSaveMask) –

do_add_annotation(annot) virtual¶

Parameters:: annot (PapersDocument.Annotation) –

do_document_is_modified() virtual¶

Return type:: bool

do_get_annotations(page) virtual¶

Parameters:: page (PapersDocument.Page) – the page from where to get the annotations
Return type:: [PapersDocument.Annotation] or None

do_get_annotations_mapping(page) virtual¶

Parameters:: page (PapersDocument.Page) –
Return type:: PapersDocument.MappingList

do_over_markup(annot, x, y) virtual¶

Parameters:

annot (PapersDocument.Annotation) –
x (float) –
y (float) –

Return type:

PapersDocument.AnnotationsOverMarkup

do_remove_annotation(annot) virtual¶

Parameters:: annot (PapersDocument.Annotation) –

do_save_annotation(annot, mask) virtual¶

Parameters:

annot (PapersDocument.Annotation) –
mask (PapersDocument.AnnotationsSaveMask) –