Top | ![]() |
![]() |
![]() |
![]() |
PopplerAnnotType
poppler_annot_get_annot_type (PopplerAnnot *poppler_annot
);
Gets the type of poppler_annot
PopplerAnnotFlag
poppler_annot_get_flags (PopplerAnnot *poppler_annot
);
Retrieves the flag field specifying various characteristics of the
poppler_annot
.
gchar *
poppler_annot_get_name (PopplerAnnot *poppler_annot
);
Retrieves the name of poppler_annot
.
gint
poppler_annot_get_page_index (PopplerAnnot *poppler_annot
);
Returns the page index to which poppler_annot
is associated, or -1 if unknown
Since 0.14
PopplerColor *
poppler_annot_get_color (PopplerAnnot *poppler_annot
);
Retrieves the color of poppler_annot
.
a new allocated PopplerColor with the color values of
poppler_annot
, or NULL
. It must be freed with g_free()
when done.
void poppler_annot_set_color (PopplerAnnot *poppler_annot
,PopplerColor *poppler_color
);
Sets the color of poppler_annot
.
Since 0.16
gchar *
poppler_annot_get_contents (PopplerAnnot *poppler_annot
);
Retrieves the contents of poppler_annot
.
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.
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()
gchar *
poppler_annot_markup_get_label (PopplerAnnotMarkup *poppler_annot
);
Retrieves 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
Since 0.16
gchar *
poppler_annot_markup_get_subject (PopplerAnnotMarkup *poppler_annot
);
Retrives the subject text of poppler_annot
.
gdouble
poppler_annot_markup_get_opacity (PopplerAnnotMarkup *poppler_annot
);
Retrieves the opacity value of poppler_annot
.
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
Since 0.16
gboolean
poppler_annot_markup_has_popup (PopplerAnnotMarkup *poppler_annot
);
Return TRUE
if the markup annotation has a popup window associated
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.
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
.
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
.
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
.
Since 0.12
GDate *
poppler_annot_markup_get_date (PopplerAnnotMarkup *poppler_annot
);
Returns the date and time when the annotation was created
PopplerAnnotExternalDataType
poppler_annot_markup_get_external_data
(PopplerAnnotMarkup *poppler_annot
);
Gets the external data type of poppler_annot
.
PopplerAnnotMarkupReplyType
poppler_annot_markup_get_reply_to (PopplerAnnotMarkup *poppler_annot
);
Gets the reply type 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()
Since 0.16
gchar *
poppler_annot_text_get_icon (PopplerAnnotText *poppler_annot
);
Gets name of the icon of poppler_annot
.
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:
Since 0.16
gboolean
poppler_annot_text_get_is_open (PopplerAnnotText *poppler_annot
);
Retrieves the state of poppler_annot
.
void poppler_annot_text_set_is_open (PopplerAnnotText *poppler_annot
,gboolean is_open
);
Sets whether poppler_annot
should initially be displayed open
Since 0.16
PopplerAnnotTextState
poppler_annot_text_get_state (PopplerAnnotText *poppler_annot
);
Retrieves the state 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 new allocated PopplerAnnotCalloutLine if the annot has a callout
line, NULL
in other case. It must be freed with g_free()
when
done.
PopplerAnnotFreeTextQuadding
poppler_annot_free_text_get_quadding (PopplerAnnotFreeText *poppler_annot
);
Retrieves the justification of the text 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.
Since 0.14
gchar *
poppler_annot_file_attachment_get_name
(PopplerAnnotFileAttachment *poppler_annot
);
Retrieves the name of poppler_annot
.
a new allocated string with the name of poppler_annot
. It must
be freed with g_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
the action to perform. The returned
object is owned by poppler_annot
and 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
.
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
.
Since 0.14
PopplerAnnotCalloutLine *
poppler_annot_callout_line_new (void
);
Creates a new empty PopplerAnnotCalloutLine.
PopplerAnnotCalloutLine *
poppler_annot_callout_line_copy (PopplerAnnotCalloutLine *callout
);
It does copy callout
to a new PopplerAnnotCalloutLine.
a new allocated PopplerAnnotCalloutLine as exact copy of
callout
, NULL
in other case. It must be freed when done.
void
poppler_annot_callout_line_free (PopplerAnnotCalloutLine *callout
);
Frees the memory used by PopplerAnnotCalloutLine.
typedef struct { gboolean multiline; gdouble x1; gdouble y1; gdouble x2; gdouble y2; gdouble x3; gdouble y3; } PopplerAnnotCalloutLine;