Class: Poppler::AnnotText

Inherits:

AnnotMarkup

• Object
• Annot
• AnnotMarkup
• Poppler::AnnotText

Defined in:

(unknown)

Instance Method Summary

• #icon ⇒ String

  Gets name of the icon of poppler_annot.

• #icon=(icon) ⇒ nil

  Sets the icon of poppler_annot.

• #initialize(doc, rect) ⇒ Poppler::Annot constructor

  Creates a new Text annotation that will be located on rect when added to a page.

• #is_open ⇒ Boolean

  Retrieves the state of poppler_annot.

• #is_open=(is_open) ⇒ nil

  Sets whether poppler_annot should initially be displayed open.

• #state ⇒ Poppler::AnnotTextState

  Retrieves the state of poppler_annot.

Methods inherited from AnnotMarkup

#date, #external_data, #get_popup_rectangle, #has_popup, #label, #label=, #opacity, #opacity=, #popup=, #popup_is_open, #popup_is_open=, #popup_rectangle=, #reply_to, #subject

Methods inherited from Annot

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

Constructor Details

#initialize(doc, rect) ⇒ Poppler::Annot

Creates a new Text annotation that will be located on rect when added to a page. See poppler_page_add_annot()

Parameters:

• doc (Poppler::Document) —

  a Poppler::Document

• rect (Poppler::Rectangle) —

  a Poppler::Rectangle

Instance Method Details

#icon ⇒ String

Gets name of the icon of poppler_annot.

Returns:

• (String) —

  a new allocated string containing the icon name

#icon=(icon) ⇒ nil

Sets the icon of poppler_annot. The following predefined icons are currently supported: #POPPLER_ANNOT_TEXT_ICON_NOTE #POPPLER_ANNOT_TEXT_ICON_COMMENT #POPPLER_ANNOT_TEXT_ICON_KEY #POPPLER_ANNOT_TEXT_ICON_HELP #POPPLER_ANNOT_TEXT_ICON_NEW_PARAGRAPH #POPPLER_ANNOT_TEXT_ICON_PARAGRAPH #POPPLER_ANNOT_TEXT_ICON_INSERT #POPPLER_ANNOT_TEXT_ICON_CROSS #POPPLER_ANNOT_TEXT_ICON_CIRCLE

Parameters:

• icon (String) —

  the name of an icon

Returns:

• (nil)

#is_open ⇒ Boolean

Retrieves the state of poppler_annot.

Returns:

• (Boolean) —

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

#is_open=(is_open) ⇒ nil

Sets whether poppler_annot should initially be displayed open

Parameters:

• is_open (Boolean) —

  whether annotation should initially be displayed open

Returns:

• (nil)

#state ⇒ Poppler::AnnotTextState

Retrieves the state of poppler_annot.

Returns:

• (Poppler::AnnotTextState) —

  Poppler::AnnotTextState of poppler_annot.