Class: Poppler::Annot

Inherits:

Object

• Object
• Poppler::Annot

Defined in:

(unknown)

Direct Known Subclasses

AnnotMarkup, AnnotMovie, AnnotScreen, AnnotStamp

Instance Method Summary

• #annot_type ⇒ Poppler::AnnotType

  Gets the type of poppler_annot.

• #color ⇒ Poppler::Color

  Retrieves the color of poppler_annot.

• #color=(poppler_color) ⇒ nil

  Sets the color of poppler_annot.

• #contents ⇒ String

  Retrieves the contents of poppler_annot.

• #contents=(contents) ⇒ nil

  Sets the contents of poppler_annot to the given value, replacing the current contents.

• #flags ⇒ Poppler::AnnotFlag

  Retrieves the flag field specifying various characteristics of the poppler_annot.

• #flags=(flags) ⇒ nil

  Sets the flag field specifying various characteristics of the poppler_annot.

• #get_rectangle(poppler_rect) ⇒ nil

  Retrieves the rectangle representing the page coordinates where the annotation poppler_annot is placed.

• #modified ⇒ String

  Retrieves the last modification data of poppler_annot.

• #name ⇒ String

  Retrieves the name of poppler_annot.

• #page_index ⇒ Integer

  Returns the page index to which poppler_annot is associated, or -1 if unknown.

• #rectangle=(poppler_rect) ⇒ nil

  Move the annotation to the rectangle representing the page coordinates where the annotation poppler_annot should be placed.

Instance Method Details

#annot_type ⇒ Poppler::AnnotType

Gets the type of poppler_annot

Returns:

• (Poppler::AnnotType) —

  Poppler::AnnotType of poppler_annot.

#color ⇒ Poppler::Color

Retrieves the color of poppler_annot.

Returns:

• (Poppler::Color) —

  a new allocated Poppler::Color with the color values of poppler_annot, or nil. It must be freed with g_free() when done.

#color=(poppler_color) ⇒ nil

Sets the color of poppler_annot.

Parameters:

• poppler_color (Poppler::Color) —

  a Poppler::Color, or nil

Returns:

• (nil)

#contents ⇒ String

Retrieves the contents of poppler_annot.

Returns:

• (String) —

  a new allocated string with the contents of poppler_annot. It must be freed with g_free() when done.

#contents=(contents) ⇒ nil

Sets the contents of poppler_annot to the given value, replacing the current contents.

Parameters:

• contents (String) —

  a text string containing the new contents

Returns:

• (nil)

#flags ⇒ Poppler::AnnotFlag

Retrieves the flag field specifying various characteristics of the poppler_annot.

Returns:

• (Poppler::AnnotFlag) —

  the flag field of poppler_annot.

#flags=(flags) ⇒ nil

Sets the flag field specifying various characteristics of the poppler_annot.

Parameters:

• flags (Poppler::AnnotFlag) —

  a Poppler::AnnotFlag

Returns:

• (nil)

#get_rectangle(poppler_rect) ⇒ nil

Retrieves the rectangle representing the page coordinates where the annotation poppler_annot is placed.

Parameters:

• poppler_rect (Poppler::Rectangle) —

  a Poppler::Rectangle to store the annotation's coordinates

Returns:

• (nil)

#modified ⇒ String

Retrieves the last modification data of poppler_annot. The returned string will be either a PDF format date or a text string. See also #poppler_date_parse()

Returns:

• (String) —

  a new allocated string with the last modification data of poppler_annot. It must be freed with g_free() when done.

#name ⇒ String

Retrieves the name of poppler_annot.

Returns:

• (String) —

  a new allocated string with the name of poppler_annot. It must be freed with g_free() when done.

#page_index ⇒ Integer

Returns the page index to which poppler_annot is associated, or -1 if unknown

Returns:

• (Integer) —

  page index or -1

#rectangle=(poppler_rect) ⇒ nil

Move the annotation to the rectangle representing the page coordinates where the annotation poppler_annot should be placed.

Parameters:

• poppler_rect (Poppler::Rectangle) —

  a Poppler::Rectangle with the new annotation's coordinates

Returns:

• (nil)