PapersDocument.AnnotationMarkup¶

Subclasses:: PapersDocument.AnnotationAttachment, PapersDocument.AnnotationFreeText, PapersDocument.AnnotationStamp, PapersDocument.AnnotationText, PapersDocument.AnnotationTextMarkup

Methods¶

Inherited:: PapersDocument.Annotation (20), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`can_have_popup` ()
	`get_label` ()
	`get_opacity` ()
	`get_popup_is_open` ()
	`get_rectangle` (pps_rect)
	`has_popup` ()
	`set_has_popup` (has_popup)
	`set_label` (label)
	`set_opacity` (opacity)
	`set_popup_is_open` (is_open)
	`set_rectangle` (pps_rect)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: PapersDocument.Annotation (8)

Name	Type	Flags	Short Description
`can-have-popup`	`bool`	r	Whether it is allowed to have a popup window for this type of markup annotation
`has-popup`	`bool`	r/w	Whether the markup annotation has a popup window associated
`label`	`str`	r/w	Label of the markup annotation
`opacity`	`float`	r/w	Opacity of the markup annotation
`popup-is-open`	`bool`	r/w	Whether the popup associated to the markup annotation is open
`rectangle`	`PapersDocument.Rectangle`	r/w	The Rectangle of the popup associated to the markup annotation

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`PapersDocument.Annotation`	r

Class Details¶

class PapersDocument.AnnotationMarkup(**kwargs)¶

Bases:: PapersDocument.Annotation
Abstract:: Yes
Structure:: PapersDocument.AnnotationMarkupClass

can_have_popup()¶

Return type:: bool

get_label()¶

Return type:: str

get_opacity()¶

Return type:: float

get_popup_is_open()¶

Return type:: bool

get_rectangle(pps_rect)¶

Parameters:: pps_rect (PapersDocument.Rectangle) –

has_popup()¶

Return type:: bool

set_has_popup(has_popup)¶

Parameters:: has_popup (bool) –
Return type:: bool

set_label(label)¶

Parameters:: label (str) –
Return type:: bool

set_opacity(opacity)¶

Parameters:: opacity (float) –
Return type:: bool

set_popup_is_open(is_open)¶

Parameters:: is_open (bool) –
Return type:: bool

set_rectangle(pps_rect)¶

Parameters:: pps_rect (PapersDocument.Rectangle) –
Return type:: bool

Property Details¶

PapersDocument.AnnotationMarkup.props.can_have_popup¶

Name:: can-have-popup
Type:: bool
Default Value:: False
Flags:: READABLE

Whether it is allowed to have a popup window for this type of markup annotation

PapersDocument.AnnotationMarkup.props.has_popup¶

Name:: has-popup
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

Whether the markup annotation has a popup window associated

PapersDocument.AnnotationMarkup.props.label¶

Name:: label
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Label of the markup annotation

PapersDocument.AnnotationMarkup.props.opacity¶

Name:: opacity
Type:: float
Default Value:: 1.0
Flags:: READABLE, WRITABLE

Opacity of the markup annotation

PapersDocument.AnnotationMarkup.props.popup_is_open¶

Name:: popup-is-open
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the popup associated to the markup annotation is open

PapersDocument.AnnotationMarkup.props.rectangle¶

Name:: rectangle
Type:: PapersDocument.Rectangle
Default Value:: None
Flags:: READABLE, WRITABLE

The Rectangle of the popup associated to the markup annotation