|  |  |  | Poppler Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
#include <poppler.h>
                    PopplerAnnot;
                    PopplerAnnotMarkup;
                    PopplerAnnotText;
                    PopplerAnnotFreeText;
                    PopplerAnnotFileAttachment;
                    PopplerAnnotMovie;
                    PopplerAnnotScreen;
enum                PopplerAnnotType;
enum                PopplerAnnotFlag;
enum                PopplerAnnotExternalDataType;
enum                PopplerAnnotMarkupReplyType;
enum                PopplerAnnotTextState;
                    PopplerAnnotCalloutLine;
enum                PopplerAnnotFreeTextQuadding;
PopplerAnnotType    poppler_annot_get_annot_type        (PopplerAnnot *poppler_annot);
PopplerAnnotFlag    poppler_annot_get_flags             (PopplerAnnot *poppler_annot);
gchar *             poppler_annot_get_name              (PopplerAnnot *poppler_annot);
gint                poppler_annot_get_page_index        (PopplerAnnot *poppler_annot);
PopplerColor *      poppler_annot_get_color             (PopplerAnnot *poppler_annot);
void                poppler_annot_set_color             (PopplerAnnot *poppler_annot,
                                                         PopplerColor *poppler_color);
gchar *             poppler_annot_get_contents          (PopplerAnnot *poppler_annot);
void                poppler_annot_set_contents          (PopplerAnnot *poppler_annot,
                                                         const gchar *contents);
gchar *             poppler_annot_get_modified          (PopplerAnnot *poppler_annot);
gchar *             poppler_annot_markup_get_label      (PopplerAnnotMarkup *poppler_annot);
void                poppler_annot_markup_set_label      (PopplerAnnotMarkup *poppler_annot,
                                                         const gchar *label);
gchar *             poppler_annot_markup_get_subject    (PopplerAnnotMarkup *poppler_annot);
gdouble             poppler_annot_markup_get_opacity    (PopplerAnnotMarkup *poppler_annot);
void                poppler_annot_markup_set_opacity    (PopplerAnnotMarkup *poppler_annot,
                                                         gdouble opacity);
gboolean            poppler_annot_markup_has_popup      (PopplerAnnotMarkup *poppler_annot);
void                poppler_annot_markup_set_popup      (PopplerAnnotMarkup *poppler_annot,
                                                         PopplerRectangle *popup_rect);
gboolean            poppler_annot_markup_get_popup_is_open
                                                        (PopplerAnnotMarkup *poppler_annot);
void                poppler_annot_markup_set_popup_is_open
                                                        (PopplerAnnotMarkup *poppler_annot,
                                                         gboolean is_open);
gboolean            poppler_annot_markup_get_popup_rectangle
                                                        (PopplerAnnotMarkup *poppler_annot,
                                                         PopplerRectangle *poppler_rect);
GDate *             poppler_annot_markup_get_date       (PopplerAnnotMarkup *poppler_annot);
PopplerAnnotExternalDataType poppler_annot_markup_get_external_data
                                                        (PopplerAnnotMarkup *poppler_annot);
PopplerAnnotMarkupReplyType poppler_annot_markup_get_reply_to
                                                        (PopplerAnnotMarkup *poppler_annot);
PopplerAnnot *      poppler_annot_text_new              (PopplerDocument *doc,
                                                         PopplerRectangle *rect);
gchar *             poppler_annot_text_get_icon         (PopplerAnnotText *poppler_annot);
#define             POPPLER_ANNOT_TEXT_ICON_NOTE
#define             POPPLER_ANNOT_TEXT_ICON_COMMENT
#define             POPPLER_ANNOT_TEXT_ICON_KEY
#define             POPPLER_ANNOT_TEXT_ICON_HELP
#define             POPPLER_ANNOT_TEXT_ICON_NEW_PARAGRAPH
#define             POPPLER_ANNOT_TEXT_ICON_PARAGRAPH
#define             POPPLER_ANNOT_TEXT_ICON_INSERT
#define             POPPLER_ANNOT_TEXT_ICON_CROSS
#define             POPPLER_ANNOT_TEXT_ICON_CIRCLE
void                poppler_annot_text_set_icon         (PopplerAnnotText *poppler_annot,
                                                         const gchar *icon);
gboolean            poppler_annot_text_get_is_open      (PopplerAnnotText *poppler_annot);
void                poppler_annot_text_set_is_open      (PopplerAnnotText *poppler_annot,
                                                         gboolean is_open);
PopplerAnnotTextState poppler_annot_text_get_state      (PopplerAnnotText *poppler_annot);
PopplerAnnotCalloutLine * poppler_annot_free_text_get_callout_line
                                                        (PopplerAnnotFreeText *poppler_annot);
PopplerAnnotFreeTextQuadding poppler_annot_free_text_get_quadding
                                                        (PopplerAnnotFreeText *poppler_annot);
PopplerAttachment * poppler_annot_file_attachment_get_attachment
                                                        (PopplerAnnotFileAttachment *poppler_annot);
gchar *             poppler_annot_file_attachment_get_name
                                                        (PopplerAnnotFileAttachment *poppler_annot);
PopplerAction *     poppler_annot_screen_get_action     (PopplerAnnotScreen *poppler_annot);
PopplerMovie *      poppler_annot_movie_get_movie       (PopplerAnnotMovie *poppler_annot);
gchar *             poppler_annot_movie_get_title       (PopplerAnnotMovie *poppler_annot);
PopplerAnnotCalloutLine * poppler_annot_callout_line_new
                                                        (void);
PopplerAnnotCalloutLine * poppler_annot_callout_line_copy
                                                        (PopplerAnnotCalloutLine *callout);
void                poppler_annot_callout_line_free     (PopplerAnnotCalloutLine *callout);
typedef enum {
  POPPLER_ANNOT_UNKNOWN,
  POPPLER_ANNOT_TEXT,
  POPPLER_ANNOT_LINK,
  POPPLER_ANNOT_FREE_TEXT,
  POPPLER_ANNOT_LINE,
  POPPLER_ANNOT_SQUARE,
  POPPLER_ANNOT_CIRCLE,
  POPPLER_ANNOT_POLYGON,
  POPPLER_ANNOT_POLY_LINE,
  POPPLER_ANNOT_HIGHLIGHT,
  POPPLER_ANNOT_UNDERLINE,
  POPPLER_ANNOT_SQUIGGLY,
  POPPLER_ANNOT_STRIKE_OUT,
  POPPLER_ANNOT_STAMP,
  POPPLER_ANNOT_CARET,
  POPPLER_ANNOT_INK,
  POPPLER_ANNOT_POPUP,
  POPPLER_ANNOT_FILE_ATTACHMENT,
  POPPLER_ANNOT_SOUND,
  POPPLER_ANNOT_MOVIE,
  POPPLER_ANNOT_WIDGET,
  POPPLER_ANNOT_SCREEN,
  POPPLER_ANNOT_PRINTER_MARK,
  POPPLER_ANNOT_TRAP_NET,
  POPPLER_ANNOT_WATERMARK,
  POPPLER_ANNOT_3D
} PopplerAnnotType;
typedef enum {
  POPPLER_ANNOT_FLAG_UNKNOWN = 0,
  POPPLER_ANNOT_FLAG_INVISIBLE = 1 << 0,
  POPPLER_ANNOT_FLAG_HIDDEN = 1 << 1,
  POPPLER_ANNOT_FLAG_PRINT = 1 << 2,
  POPPLER_ANNOT_FLAG_NO_ZOOM = 1 << 3,
  POPPLER_ANNOT_FLAG_NO_ROTATE = 1 << 4,
  POPPLER_ANNOT_FLAG_NO_VIEW = 1 << 5,
  POPPLER_ANNOT_FLAG_READ_ONLY = 1 << 6,
  POPPLER_ANNOT_FLAG_LOCKED = 1 << 7,
  POPPLER_ANNOT_FLAG_TOGGLE_NO_VIEW = 1 << 8,
  POPPLER_ANNOT_FLAG_LOCKED_CONTENTS = 1 << 9
} PopplerAnnotFlag;
typedef enum {
  POPPLER_ANNOT_EXTERNAL_DATA_MARKUP_3D,
  POPPLER_ANNOT_EXTERNAL_DATA_MARKUP_UNKNOWN
} PopplerAnnotExternalDataType;
typedef enum {
  POPPLER_ANNOT_MARKUP_REPLY_TYPE_R,
  POPPLER_ANNOT_MARKUP_REPLY_TYPE_GROUP
} PopplerAnnotMarkupReplyType;
typedef enum {
  POPPLER_ANNOT_TEXT_STATE_MARKED,
  POPPLER_ANNOT_TEXT_STATE_UNMARKED,
  POPPLER_ANNOT_TEXT_STATE_ACCEPTED,
  POPPLER_ANNOT_TEXT_STATE_REJECTED,
  POPPLER_ANNOT_TEXT_STATE_CANCELLED,
  POPPLER_ANNOT_TEXT_STATE_COMPLETED,
  POPPLER_ANNOT_TEXT_STATE_NONE,
  POPPLER_ANNOT_TEXT_STATE_UNKNOWN
} PopplerAnnotTextState;
typedef struct {
  gboolean multiline;
  gdouble  x1;
  gdouble  y1;
  gdouble  x2;
  gdouble  y2;
  gdouble  x3;
  gdouble  y3;
} PopplerAnnotCalloutLine;
typedef enum {
  POPPLER_ANNOT_FREE_TEXT_QUADDING_LEFT_JUSTIFIED,
  POPPLER_ANNOT_FREE_TEXT_QUADDING_CENTERED,
  POPPLER_ANNOT_FREE_TEXT_QUADDING_RIGHT_JUSTIFIED
} PopplerAnnotFreeTextQuadding;
PopplerAnnotType    poppler_annot_get_annot_type        (PopplerAnnot *poppler_annot);
Gets the type of poppler_annot
| 
 | a PopplerAnnot | 
| Returns : | PopplerAnnotType of poppler_annot. | 
PopplerAnnotFlag    poppler_annot_get_flags             (PopplerAnnot *poppler_annot);
Retrieves the flag field specifying various characteristics of the
poppler_annot.
| 
 | a PopplerAnnot | 
| Returns : | the flag field of poppler_annot. | 
gchar *             poppler_annot_get_name              (PopplerAnnot *poppler_annot);
Retrieves the name of poppler_annot.
| 
 | a PopplerAnnot | 
| Returns : | a new allocated string with the name of poppler_annot. It must
be freed withg_free()when done. | 
gint                poppler_annot_get_page_index        (PopplerAnnot *poppler_annot);
Returns the page index to which poppler_annot is associated, or -1 if unknown
| 
 | a PopplerAnnot | 
| Returns : | page index or -1 | 
Since 0.14
PopplerColor *      poppler_annot_get_color             (PopplerAnnot *poppler_annot);
Retrieves the color of poppler_annot.
| 
 | a PopplerAnnot | 
| Returns : | a new allocated PopplerColor with the color values of poppler_annot, orNULL. It must be freed withg_free()when done. | 
void poppler_annot_set_color (PopplerAnnot *poppler_annot,PopplerColor *poppler_color);
Sets the color of poppler_annot.
| 
 | a PopplerAnnot | 
| 
 | a PopplerColor, or NULL. [allow-none] | 
Since 0.16
gchar *             poppler_annot_get_contents          (PopplerAnnot *poppler_annot);
Retrieves the contents of poppler_annot.
| 
 | a PopplerAnnot | 
| Returns : | a new allocated string with the contents of poppler_annot. It
must be freed withg_free()when done. | 
void poppler_annot_set_contents (PopplerAnnot *poppler_annot,const gchar *contents);
Sets the contents of poppler_annot to the given value,
replacing the current contents.
| 
 | a PopplerAnnot | 
| 
 | a text string containing the new contents | 
Since 0.12
gchar *             poppler_annot_get_modified          (PopplerAnnot *poppler_annot);
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()
| 
 | a PopplerAnnot | 
| Returns : | a new allocated string with the last modification data of poppler_annot. It must be freed withg_free()when done. | 
gchar *             poppler_annot_markup_get_label      (PopplerAnnotMarkup *poppler_annot);
Retrieves the label text of poppler_annot.
| 
 | a PopplerAnnotMarkup | 
| Returns : | the label text of poppler_annot. | 
void poppler_annot_markup_set_label (PopplerAnnotMarkup *poppler_annot,const gchar *label);
Sets the label text of poppler_annot, replacing the current one
| 
 | a PopplerAnnotMarkup | 
| 
 | a text string containing the new label, or NULL. [allow-none] | 
Since 0.16
gchar *             poppler_annot_markup_get_subject    (PopplerAnnotMarkup *poppler_annot);
Retrives the subject text of poppler_annot.
| 
 | a PopplerAnnotMarkup | 
| Returns : | the subject text of poppler_annot. | 
gdouble             poppler_annot_markup_get_opacity    (PopplerAnnotMarkup *poppler_annot);
Retrieves the opacity value of poppler_annot.
| 
 | a PopplerAnnotMarkup | 
| Returns : | the opacity value of poppler_annot,
between 0 (transparent) and 1 (opaque) | 
void poppler_annot_markup_set_opacity (PopplerAnnotMarkup *poppler_annot,gdouble opacity);
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
| 
 | a PopplerAnnotMarkup | 
| 
 | a constant opacity value, between 0 (transparent) and 1 (opaque) | 
Since 0.16
gboolean            poppler_annot_markup_has_popup      (PopplerAnnotMarkup *poppler_annot);
Return TRUE if the markup annotation has a popup window associated
| 
 | a PopplerAnnotMarkup | 
| Returns : | TRUE, ifpoppler_annothas popup,FALSEotherwise | 
Since 0.12
void poppler_annot_markup_set_popup (PopplerAnnotMarkup *poppler_annot,PopplerRectangle *popup_rect);
Associates a new popup window for editing contents of poppler_annot.
Popup window shall be displayed by viewers at popup_rect on the page.
| 
 | a PopplerAnnotMarkup | 
| 
 | a PopplerRectangle | 
Since 0.16
gboolean            poppler_annot_markup_get_popup_is_open
                                                        (PopplerAnnotMarkup *poppler_annot);
Retrieves the state of the popup window related to poppler_annot.
| 
 | a PopplerAnnotMarkup | 
| Returns : | the state of poppler_annot.TRUEif it's open,FALSEin
other case. | 
void poppler_annot_markup_set_popup_is_open (PopplerAnnotMarkup *poppler_annot,gboolean is_open);
Sets the state of the popup window related to poppler_annot.
| 
 | a PopplerAnnotMarkup | 
| 
 | whether popup window should initially be displayed open | 
Since 0.16
gboolean poppler_annot_markup_get_popup_rectangle (PopplerAnnotMarkup *poppler_annot,PopplerRectangle *poppler_rect);
Retrieves the rectangle of the popup window related to poppler_annot.
| 
 | a PopplerAnnotMarkup | 
| 
 | a PopplerRectangle to store the popup rectangle. [out] | 
| Returns : | TRUEif PopplerRectangle was correctly filled,FALSEotherwise | 
Since 0.12
GDate *             poppler_annot_markup_get_date       (PopplerAnnotMarkup *poppler_annot);
Returns the date and time when the annotation was created
| 
 | a PopplerAnnotMarkup | 
| Returns : | a GDate representing the date and time
when the annotation was created, or NULL. [transfer full] | 
PopplerAnnotExternalDataType poppler_annot_markup_get_external_data
                                                        (PopplerAnnotMarkup *poppler_annot);
Gets the external data type of poppler_annot.
| 
 | a PopplerAnnotMarkup | 
| Returns : | PopplerAnnotExternalDataType of poppler_annot. | 
PopplerAnnotMarkupReplyType poppler_annot_markup_get_reply_to
                                                        (PopplerAnnotMarkup *poppler_annot);
Gets the reply type of poppler_annot.
| 
 | a PopplerAnnotMarkup | 
| Returns : | PopplerAnnotMarkupReplyType of poppler_annot. | 
PopplerAnnot * poppler_annot_text_new (PopplerDocument *doc,PopplerRectangle *rect);
Creates a new Text annotation that will be
located on rect when added to a page. See
poppler_page_add_annot()
| 
 | a PopplerDocument | 
| 
 | a PopplerRectangle | 
| Returns : | A newly created PopplerAnnotText annotation | 
Since 0.16
gchar *             poppler_annot_text_get_icon         (PopplerAnnotText *poppler_annot);
Gets name of the icon of poppler_annot.
| 
 | a PopplerAnnotText | 
| Returns : | a new allocated string containing the icon name | 
void poppler_annot_text_set_icon (PopplerAnnotText *poppler_annot,const gchar *icon);
Sets the icon of poppler_annot. The following predefined
icons are currently supported:
| 
 | a PopplerAnnotText | 
| 
 | the name of an icon | 
Since 0.16
gboolean            poppler_annot_text_get_is_open      (PopplerAnnotText *poppler_annot);
Retrieves the state of poppler_annot.
| 
 | a PopplerAnnotText | 
| Returns : | the state of poppler_annot.TRUEif it's open,FALSEin
other case. | 
void poppler_annot_text_set_is_open (PopplerAnnotText *poppler_annot,gboolean is_open);
Sets whether poppler_annot should initially be displayed open
| 
 | a PopplerAnnotText | 
| 
 | whether annotation should initially be displayed open | 
Since 0.16
PopplerAnnotTextState poppler_annot_text_get_state      (PopplerAnnotText *poppler_annot);
Retrieves the state of poppler_annot.
| 
 | a PopplerAnnotText | 
| Returns : | PopplerAnnotTextState of poppler_annot. | 
PopplerAnnotCalloutLine * poppler_annot_free_text_get_callout_line
                                                        (PopplerAnnotFreeText *poppler_annot);
Retrieves a PopplerAnnotCalloutLine of four or six numbers specifying a callout
line attached to the poppler_annot.
| 
 | a PopplerAnnotFreeText | 
| Returns : | a new allocated PopplerAnnotCalloutLine if the annot has a callout
line, NULLin other case. It must be freed withg_free()when
done. | 
PopplerAnnotFreeTextQuadding poppler_annot_free_text_get_quadding
                                                        (PopplerAnnotFreeText *poppler_annot);
Retrieves the justification of the text of poppler_annot.
| 
 | a PopplerAnnotFreeText | 
| Returns : | PopplerAnnotFreeTextQuadding of poppler_annot. | 
PopplerAttachment * poppler_annot_file_attachment_get_attachment
                                                        (PopplerAnnotFileAttachment *poppler_annot);
Creates a PopplerAttachment for the file of the file attachment annotation annot.
The PopplerAttachment must be unrefed with g_object_unref by the caller.
| 
 | a PopplerAnnotFileAttachment | 
| Returns : | PopplerAttachment. [transfer full] | 
Since 0.14
gchar *             poppler_annot_file_attachment_get_name
                                                        (PopplerAnnotFileAttachment *poppler_annot);
Retrieves the name of poppler_annot.
| 
 | a PopplerAnnotFileAttachment | 
| Returns : | a new allocated string with the name of poppler_annot. It must
be freed withg_free()when done. | 
Since 0.14
PopplerAction *     poppler_annot_screen_get_action     (PopplerAnnotScreen *poppler_annot);
Retrieves the action (PopplerAction) that shall be performed when poppler_annot is activated
| 
 | a PopplerAnnotScreen | 
| Returns : | the action to perform. The returned
object is owned by poppler_annotand should not be freed. [transfer none] | 
Since 0.14
PopplerMovie *      poppler_annot_movie_get_movie       (PopplerAnnotMovie *poppler_annot);
Retrieves the movie object (PopplerMovie) stored in the poppler_annot.
| 
 | a PopplerAnnotMovie | 
| Returns : | the movie object stored in the poppler_annot. The returned
object is owned by PopplerAnnotMovie and should not be freed. [transfer none] | 
Since 0.14
gchar *             poppler_annot_movie_get_title       (PopplerAnnotMovie *poppler_annot);
Retrieves the movie title of poppler_annot.
| 
 | a PopplerAnnotMovie | 
| Returns : | the title text of poppler_annot. | 
Since 0.14
PopplerAnnotCalloutLine * poppler_annot_callout_line_new
                                                        (void);
Creates a new empty PopplerAnnotCalloutLine.
| Returns : | a new allocated PopplerAnnotCalloutLine, NULLin other case.
It must be freed when done. | 
PopplerAnnotCalloutLine * poppler_annot_callout_line_copy
                                                        (PopplerAnnotCalloutLine *callout);
It does copy callout to a new PopplerAnnotCalloutLine.
| 
 | the PopplerAnnotCalloutLine to be copied. | 
| Returns : | a new allocated PopplerAnnotCalloutLine as exact copy of callout,NULLin other case. It must be freed when done. | 
void                poppler_annot_callout_line_free     (PopplerAnnotCalloutLine *callout);
Frees the memory used by PopplerAnnotCalloutLine.
| 
 | a PopplerAnnotCalloutLine |