| Top | |
|
|
|
GBoxed ├── PopplerAnnotCalloutLine ╰── PopplerFontDescription GEnum ├── PopplerAnnotExternalDataType ├── PopplerAnnotFreeTextQuadding ├── PopplerAnnotMarkupReplyType ├── PopplerAnnotStampIcon ├── PopplerAnnotTextState ╰── PopplerAnnotType GFlags ╰── PopplerAnnotFlag GObject ╰── PopplerAnnot ├── PopplerAnnotMarkup │ ├── PopplerAnnotCircle │ ├── PopplerAnnotFileAttachment │ ├── PopplerAnnotFreeText │ ├── PopplerAnnotLine │ ├── PopplerAnnotSquare │ ├── PopplerAnnotText │ ├── PopplerAnnotTextMarkup │ ├── PopplerAnnotCircle │ ├── PopplerAnnotFileAttachment │ ├── PopplerAnnotFreeText │ ╰── PopplerAnnotLine ├── PopplerAnnotMovie ├── PopplerAnnotScreen ╰── PopplerAnnotStamp
PopplerAnnotType
poppler_annot_get_annot_type (PopplerAnnot *poppler_annot);
Gets the type of poppler_annot
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.
PopplerAnnotCalloutLine *
poppler_annot_callout_line_new (void);
Creates a new empty PopplerAnnotCalloutLine.
PopplerColor *
poppler_annot_circle_get_interior_color
(PopplerAnnotCircle *poppler_annot);
Retrieves the interior 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.
Since: 0.26
PopplerAnnot * poppler_annot_circle_new (PopplerDocument *doc,PopplerRectangle *rect);
Creates a new Circle annotation that will be
located on rect
when added to a page. See
poppler_page_add_annot()
Since: 0.26
void poppler_annot_circle_set_interior_color (PopplerAnnotCircle *poppler_annot,PopplerColor *poppler_color);
Sets the interior color of poppler_annot
.
Since: 0.26
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
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.
PopplerColor *
poppler_annot_free_text_get_font_color
(PopplerAnnotFreeText *poppler_annot);
Gets the font color.
Since: 24.12.0
PopplerFontDescription *
poppler_annot_free_text_get_font_desc (PopplerAnnotFreeText *poppler_annot);
Gets the font description (i.e. font family name, style, weight, stretch and size).
Since: 24.12.0
PopplerAnnotFreeTextQuadding
poppler_annot_free_text_get_quadding (PopplerAnnotFreeText *poppler_annot);
Retrieves the justification of the text of poppler_annot
.
PopplerAnnot * poppler_annot_free_text_new (PopplerDocument *doc,PopplerRectangle *rect);
Creates a new Free Text annotation that will be
located on rect
when added to a page. See
poppler_page_add_annot(). It initially has no content. Font family, size and
color are initially undefined and must be set, see
poppler_annot_free_text_set_font_desc() and
poppler_annot_free_text_set_font_color().
void poppler_annot_free_text_set_font_desc (PopplerAnnotFreeText *poppler_annot,PopplerFontDescription *font_desc);
Sets the font description (i.e. font family name, style, weight, stretch and size).
Since: 24.12.0
void poppler_annot_free_text_set_font_color (PopplerAnnotFreeText *poppler_annot,PopplerColor *color);
Sets the font color.
Since: 24.12.0
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.
gchar *
poppler_annot_get_contents (PopplerAnnot *poppler_annot);
Retrieves the contents 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_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_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
void poppler_annot_get_rectangle (PopplerAnnot *poppler_annot,PopplerRectangle *poppler_rect);
Retrieves the rectangle representing the page coordinates where the
annotation poppler_annot
is placed.
poppler_annot |
||
poppler_rect |
a PopplerRectangle to store the annotation's coordinates. |
[out] |
Since: 0.26
gboolean poppler_annot_get_border_width (PopplerAnnot *poppler_annot,double *width);
Returns the border width of the annotation. Some PDF editors set a border width even if the border is not actually drawn.
true and sets border_width
to the actual border width if a border
is defined, otherwise returns false and sets border_width
to 0.
Since: 24.12.0
PopplerAnnot * poppler_annot_line_new (PopplerDocument *doc,PopplerRectangle *rect,PopplerPoint *start,PopplerPoint *end);
Creates a new Line annotation that will be
located on rect
when added to a page. See
poppler_page_add_annot()
doc |
||
rect |
||
start |
a PopplerPoint of the starting vertice |
|
end |
a PopplerPoint of the ending vertice |
Since: 0.26
void poppler_annot_line_set_vertices (PopplerAnnotLine *poppler_annot,PopplerPoint *start,PopplerPoint *end);
Set the coordinate points where the poppler_annot
starts and ends.
poppler_annot |
||
start |
a PopplerPoint of the starting vertice |
|
end |
a PopplerPoint of the ending vertice |
Since: 0.26
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
.
gchar *
poppler_annot_markup_get_label (PopplerAnnotMarkup *poppler_annot);
Retrieves the label text of poppler_annot
.
gdouble
poppler_annot_markup_get_opacity (PopplerAnnotMarkup *poppler_annot);
Retrieves the opacity value of poppler_annot
.
gboolean
poppler_annot_markup_get_popup_is_open
(PopplerAnnotMarkup *poppler_annot);
Retrieves the state of the popup window related to poppler_annot
.
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
PopplerAnnotMarkupReplyType
poppler_annot_markup_get_reply_to (PopplerAnnotMarkup *poppler_annot);
Gets the reply type of poppler_annot
.
gchar *
poppler_annot_markup_get_subject (PopplerAnnotMarkup *poppler_annot);
Retrives the subject text of poppler_annot
.
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_label (PopplerAnnotMarkup *poppler_annot,const gchar *label);
Sets the label text of poppler_annot
, replacing the current one
Since: 0.16
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
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
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
void poppler_annot_markup_set_popup_rectangle (PopplerAnnotMarkup *poppler_annot,PopplerRectangle *poppler_rect);
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 PopplerAnnotMarkup.
Since: 0.33
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
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
void poppler_annot_set_color (PopplerAnnot *poppler_annot,PopplerColor *poppler_color);
Sets the color of poppler_annot
.
Since: 0.16
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
void poppler_annot_set_flags (PopplerAnnot *poppler_annot,PopplerAnnotFlag flags);
Sets the flag field specifying various characteristics of the
poppler_annot
.
Since: 0.22
void poppler_annot_set_rectangle (PopplerAnnot *poppler_annot,PopplerRectangle *poppler_rect);
Move the annotation to the rectangle representing the page coordinates
where the annotation poppler_annot
should be placed.
Since: 0.26
void poppler_annot_set_border_width (PopplerAnnot *poppler_annot,double width);
Sets the border width of the annotation. Since there is currently no mechanism in the GLib binding to control the appearance of the border width, this should generally only be used to disable the border, although the API might be completed in the future.
Since: 24.12.0
PopplerColor *
poppler_annot_square_get_interior_color
(PopplerAnnotSquare *poppler_annot);
Retrieves the interior 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.
Since: 0.26
PopplerAnnot * poppler_annot_square_new (PopplerDocument *doc,PopplerRectangle *rect);
Creates a new Square annotation that will be
located on rect
when added to a page. See
poppler_page_add_annot()
Since: 0.26
void poppler_annot_square_set_interior_color (PopplerAnnotSquare *poppler_annot,PopplerColor *poppler_color);
Sets the interior color of poppler_annot
.
Since: 0.26
PopplerAnnotStampIcon
poppler_annot_stamp_get_icon (PopplerAnnotStamp *poppler_annot);
Since: 22.07.0
PopplerAnnot * poppler_annot_stamp_new (PopplerDocument *doc,PopplerRectangle *rect);
Creates a new Stamp annotation that will be
located on rect
when added to a page. See
poppler_page_add_annot()
Since: 22.07.0
gboolean poppler_annot_stamp_set_custom_image (PopplerAnnotStamp *poppler_annot,cairo_surface_t *image,GError **error);
Sets the custom image of poppler_annot
to be image
poppler_annot |
||
image |
an image cairo surface |
|
error |
return location for error, or |
[nullable] |
Since: 22.07.0
void poppler_annot_stamp_set_icon (PopplerAnnotStamp *poppler_annot,PopplerAnnotStampIcon icon);
Sets the icon of poppler_annot
to be one of the predefined values in PopplerAnnotStampIcon
Since: 22.07.0
gchar *
poppler_annot_text_get_icon (PopplerAnnotText *poppler_annot);
Gets name of the icon of poppler_annot
.
gboolean
poppler_annot_text_get_is_open (PopplerAnnotText *poppler_annot);
Retrieves the state of poppler_annot
.
PopplerAnnotTextState
poppler_annot_text_get_state (PopplerAnnotText *poppler_annot);
Retrieves the state of poppler_annot
.
GArray *
poppler_annot_text_markup_get_quadrilaterals
(PopplerAnnotTextMarkup *poppler_annot);
Returns a GArray of PopplerQuadrilateral items that map from a
location on page
to a PopplerAnnotTextMarkup. This array must be freed
when done.
Since: 0.26
PopplerAnnot * poppler_annot_text_markup_new_highlight (PopplerDocument *doc,PopplerRectangle *rect,GArray *quadrilaterals);
Creates a new Highlight Text annotation that will be
located on rect
when added to a page. See poppler_page_add_annot()
doc |
||
rect |
||
quadrilaterals |
A GArray of PopplerQuadrilaterals. |
[element-type PopplerQuadrilateral] |
Since: 0.26
PopplerAnnot * poppler_annot_text_markup_new_squiggly (PopplerDocument *doc,PopplerRectangle *rect,GArray *quadrilaterals);
Creates a new Squiggly Text annotation that will be
located on rect
when added to a page. See poppler_page_add_annot()
doc |
||
rect |
||
quadrilaterals |
A GArray of PopplerQuadrilaterals. |
[element-type PopplerQuadrilateral] |
Since: 0.26
PopplerAnnot * poppler_annot_text_markup_new_strikeout (PopplerDocument *doc,PopplerRectangle *rect,GArray *quadrilaterals);
Creates a new Strike Out Text annotation that will be
located on rect
when added to a page. See poppler_page_add_annot()
doc |
||
rect |
||
quadrilaterals |
A GArray of PopplerQuadrilaterals. |
[element-type PopplerQuadrilateral] |
Since: 0.26
PopplerAnnot * poppler_annot_text_markup_new_underline (PopplerDocument *doc,PopplerRectangle *rect,GArray *quadrilaterals);
Creates a new Underline Text annotation that will be
located on rect
when added to a page. See poppler_page_add_annot()
doc |
||
rect |
||
quadrilaterals |
A GArray of PopplerQuadrilaterals. |
[element-type PopplerQuadrilateral] |
Since: 0.26
void poppler_annot_text_markup_set_quadrilaterals (PopplerAnnotTextMarkup *poppler_annot,GArray *quadrilaterals);
Set the regions (Quadrilaterals) to apply the text markup in poppler_annot
.
poppler_annot |
||
quadrilaterals |
A GArray of PopplerQuadrilaterals. |
[element-type PopplerQuadrilateral] |
Since: 0.26
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
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
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
PopplerFontDescription *
poppler_font_description_copy (PopplerFontDescription *font_desc);
Creates a copy of font_desc
void
poppler_font_description_free (PopplerFontDescription *font_desc);
Frees the given PopplerFontDescription
PopplerFontDescription *
poppler_font_description_new (const char *font_name);
Creates a new PopplerFontDescriptions
typedef struct {
gboolean multiline;
gdouble x1;
gdouble y1;
gdouble x2;
gdouble y2;
gdouble x3;
gdouble y3;
} PopplerAnnotCalloutLine;
typedef struct {
char *font_name;
double size_pt;
PopplerStretch stretch;
PopplerWeight weight;
PopplerStyle style;
} PopplerFontDescription;
A PopplerFontDescription structure represents the description of a font. When used together with Pango, all the fields are value-compatible with pango equivalent, although Pango font descriptions may contain more information.
This type supports g_autoptr
Since: 24.12.0