Class: Poppler::AnnotMarkup

Inherits:

Annot

• Object
• Annot
• Poppler::AnnotMarkup

Defined in:

(unknown)

Direct Known Subclasses

AnnotCircle, AnnotFileAttachment, AnnotFreeText, AnnotLine, AnnotSquare, AnnotText, AnnotTextMarkup

Instance Method Summary

• #date ⇒ GLib::Date

  Returns the date and time when the annotation was created.

• #external_data ⇒ Poppler::AnnotExternalDataType

  Gets the external data type of poppler_annot.

• #get_popup_rectangle(poppler_rect) ⇒ Boolean

  Retrieves the rectangle of the popup window related to poppler_annot.

• #has_popup ⇒ Boolean

  Return true if the markup annotation has a popup window associated.

• #label ⇒ String

  Retrieves the label text of poppler_annot.

• #label=(label) ⇒ nil

  Sets the label text of poppler_annot, replacing the current one.

• #opacity ⇒ Float

  Retrieves the opacity value of poppler_annot.

• #opacity=(opacity) ⇒ nil

  Sets the opacity of poppler_annot.

• #popup=(popup_rect) ⇒ nil

  Associates a new popup window for editing contents of poppler_annot.

• #popup_is_open ⇒ Boolean

  Retrieves the state of the popup window related to poppler_annot.

• #popup_is_open=(is_open) ⇒ nil

  Sets the state of the popup window related to poppler_annot.

• #popup_rectangle=(poppler_rect) ⇒ nil

  Sets the rectangle of the popup window related to poppler_annot.

• #reply_to ⇒ Poppler::AnnotMarkupReplyType

  Gets the reply type of poppler_annot.

• #subject ⇒ String

  Retrives the subject text of poppler_annot.

Methods inherited from Annot

#annot_type, #color, #color=, #contents, #contents=, #flags, #flags=, #get_rectangle, #modified, #name, #page_index, #rectangle=

Instance Method Details

#date ⇒ GLib::Date

Returns the date and time when the annotation was created

Returns:

• (GLib::Date) —

  a #GDate representing the date and time when the annotation was created, or nil

#external_data ⇒ Poppler::AnnotExternalDataType

Gets the external data type of poppler_annot.

Returns:

• (Poppler::AnnotExternalDataType) —

  Poppler::AnnotExternalDataType of poppler_annot.

#get_popup_rectangle(poppler_rect) ⇒ Boolean

Retrieves the rectangle of the popup window related to poppler_annot.

Parameters:

• poppler_rect (Poppler::Rectangle) —

  a Poppler::Rectangle to store the popup rectangle

Returns:

• (Boolean) —

  true if Poppler::Rectangle was correctly filled, false otherwise

#has_popup ⇒ Boolean

Return true if the markup annotation has a popup window associated

Returns:

• (Boolean) —

  true, if poppler_annot has popup, false otherwise

#label ⇒ String

Retrieves the label text of poppler_annot.

Returns:

• (String) —

  the label text of poppler_annot.

#label=(label) ⇒ nil

Sets the label text of poppler_annot, replacing the current one

Parameters:

• label (String) —

  a text string containing the new label, or nil

Returns:

• (nil)

#opacity ⇒ Float

Retrieves the opacity value of poppler_annot.

Returns:

• (Float) —

  the opacity value of poppler_annot, between 0 (transparent) and 1 (opaque)

#opacity=(opacity) ⇒ nil

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

Parameters:

• opacity (Float) —

  a constant opacity value, between 0 (transparent) and 1 (opaque)

Returns:

• (nil)

#popup=(popup_rect) ⇒ nil

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

Parameters:

• popup_rect (Poppler::Rectangle) —

  a Poppler::Rectangle

Returns:

• (nil)

#popup_is_open ⇒ Boolean

Retrieves the state of the popup window related to poppler_annot.

Returns:

• (Boolean) —

  the state of poppler_annot. true if it's open, false in other case.

#popup_is_open=(is_open) ⇒ nil

Sets the state of the popup window related to poppler_annot.

Parameters:

• is_open (Boolean) —

  whether popup window should initially be displayed open

Returns:

• (nil)

#popup_rectangle=(poppler_rect) ⇒ nil

Sets the rectangle of the popup window related to poppler_annot. This doesn't have any effect if poppler_annot doesn't have a popup associated, use poppler_annot_markup_set_popup() to associate a popup window to a Poppler::AnnotMarkup.

Parameters:

• poppler_rect (Poppler::Rectangle) —

  a Poppler::Rectangle to set

Returns:

• (nil)

#reply_to ⇒ Poppler::AnnotMarkupReplyType

Gets the reply type of poppler_annot.

Returns:

• (Poppler::AnnotMarkupReplyType) —

  Poppler::AnnotMarkupReplyType of poppler_annot.

#subject ⇒ String

Retrives the subject text of poppler_annot.

Returns:

• (String) —

  the subject text of poppler_annot.