Poppler.AnnotMarkup¶

Subclasses:: Poppler.AnnotCircle, Poppler.AnnotFileAttachment, Poppler.AnnotFreeText, Poppler.AnnotLine, Poppler.AnnotSquare, Poppler.AnnotText, Poppler.AnnotTextMarkup

Methods¶

Inherited:: Poppler.Annot (12), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_date` ()
	`get_external_data` ()
	`get_label` ()
	`get_opacity` ()
	`get_popup_is_open` ()
	`get_popup_rectangle` ()
	`get_reply_to` ()
	`get_subject` ()
	`has_popup` ()
	`set_label` (label)
	`set_opacity` (opacity)
	`set_popup` (popup_rect)
	`set_popup_is_open` (is_open)
	`set_popup_rectangle` (poppler_rect)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Poppler.AnnotMarkup(**kwargs)¶

Bases:: Poppler.Annot
Abstract:: No

get_date()¶

Returns:: a GLib.Date representing the date and time when the annotation was created, or None
Return type:: GLib.Date

Returns the date and time when the annotation was created

get_external_data()¶

Returns:: Poppler.AnnotExternalDataType of self.
Return type:: Poppler.AnnotExternalDataType

Gets the external data type of self.

get_label()¶

Returns:: the label text of self.
Return type:: str

Retrieves the label text of self.

get_opacity()¶

Returns:: the opacity value of self, between 0 (transparent) and 1 (opaque)
Return type:: float

Retrieves the opacity value of self.

get_popup_is_open()¶

Returns:: the state of self. True if it’s open, False in other case.
Return type:: bool

Retrieves the state of the popup window related to self.

get_popup_rectangle()¶

Returns:

True if Poppler.Rectangle was correctly filled, False otherwise

poppler_rect:: a Poppler.Rectangle to store the popup rectangle

Return type:

(bool, poppler_rect: Poppler.Rectangle)

Retrieves the rectangle of the popup window related to self.

New in version 0.12.

get_reply_to()¶

Returns:: Poppler.AnnotMarkupReplyType of self.
Return type:: Poppler.AnnotMarkupReplyType

Gets the reply type of self.

get_subject()¶

Returns:: the subject text of self.
Return type:: str

Retrives the subject text of self.

has_popup()¶

Returns:: True, if self has popup, False otherwise
Return type:: bool

Return True if the markup annotation has a popup window associated

New in version 0.12.

set_label(label)¶

Parameters:: label (str or None) – a text string containing the new label, or None

Sets the label text of self, replacing the current one

New in version 0.16.

set_opacity(opacity)¶

Parameters:: opacity (float) – a constant opacity value, between 0 (transparent) and 1 (opaque)

Sets the opacity of self. This value applies to all visible elements of self in its closed state, but not to the pop-up window that appears when it’s openened

New in version 0.16.

set_popup(popup_rect)¶

Parameters:: popup_rect (Poppler.Rectangle) – a Poppler.Rectangle

Associates a new popup window for editing contents of self. Popup window shall be displayed by viewers at popup_rect on the page.

New in version 0.16.

set_popup_is_open(is_open)¶

Parameters:: is_open (bool) – whether popup window should initially be displayed open

Sets the state of the popup window related to self.

New in version 0.16.

set_popup_rectangle(poppler_rect)¶

Parameters:: poppler_rect (Poppler.Rectangle) – a Poppler.Rectangle to set

Sets the rectangle of the popup window related to self. This doesn’t have any effect if self doesn’t have a popup associated, use Poppler.AnnotMarkup.set_popup() to associate a popup window to a Poppler.AnnotMarkup.

New in version 0.33.