EvAnnotation: Evince Document Library Reference Manual

EvAnnotation

Functions

EvAnnotationType	ev_annotation_get_annotation_type ()
EvPage *	ev_annotation_get_page ()
guint	ev_annotation_get_page_index ()
gboolean	ev_annotation_equal ()
const gchar *	ev_annotation_get_contents ()
gboolean	ev_annotation_set_contents ()
const gchar *	ev_annotation_get_name ()
gboolean	ev_annotation_set_name ()
const gchar *	ev_annotation_get_modified ()
gboolean	ev_annotation_set_modified ()
gboolean	ev_annotation_set_modified_from_time ()
void	ev_annotation_get_color ()
gboolean	ev_annotation_set_color ()
void	ev_annotation_get_rgba ()
gboolean	ev_annotation_set_rgba ()
void	ev_annotation_get_area ()
gboolean	ev_annotation_set_area ()
const gchar *	ev_annotation_markup_get_label ()
gboolean	ev_annotation_markup_set_label ()
gdouble	ev_annotation_markup_get_opacity ()
gboolean	ev_annotation_markup_set_opacity ()
gboolean	ev_annotation_markup_has_popup ()
gboolean	ev_annotation_markup_set_has_popup ()
void	ev_annotation_markup_get_rectangle ()
gboolean	ev_annotation_markup_set_rectangle ()
gboolean	ev_annotation_markup_get_popup_is_open ()
gboolean	ev_annotation_markup_set_popup_is_open ()
EvAnnotation *	ev_annotation_text_new ()
EvAnnotationTextIcon	ev_annotation_text_get_icon ()
gboolean	ev_annotation_text_set_icon ()
gboolean	ev_annotation_text_get_is_open ()
gboolean	ev_annotation_text_set_is_open ()
EvAnnotation *	ev_annotation_attachment_new ()
EvAttachment *	ev_annotation_attachment_get_attachment ()
gboolean	ev_annotation_attachment_set_attachment ()

Properties

EvRectangle *	area	Read / Write
gpointer	color	Read / Write
gchar *	contents	Read / Write
gchar *	modified	Read / Write
gchar *	name	Read / Write
EvPage *	page	Write / Construct Only
GdkRGBA *	rgba	Read / Write
gboolean	can-have-popup	Read / Write
gboolean	has-popup	Read / Write
gchar *	label	Read / Write
gdouble	opacity	Read / Write
gboolean	popup-is-open	Read / Write
EvRectangle *	rectangle	Read / Write
EvAnnotationTextIcon	icon	Read / Write
gboolean	is-open	Read / Write
EvAttachment *	attachment	Read / Write / Construct

Types and Values

	EvAnnotation
	EvAnnotationClass
	EvAnnotationMarkup
	EvAnnotationMarkupInterface
	EvAnnotationText
	EvAnnotationTextClass
	EvAnnotationAttachment
	EvAnnotationAttachmentClass
enum	EvAnnotationTextIcon
enum	EvAnnotationType

Object Hierarchy

    GEnum
    ├── EvAnnotationTextIcon
    ╰── EvAnnotationType
    GInterface
    ╰── EvAnnotationMarkup
    GObject
    ╰── EvAnnotation
        ├── EvAnnotationAttachment
        ╰── EvAnnotationText

Prerequisites

EvAnnotationMarkup requires EvAnnotation.

Known Derived Interfaces

EvAnnotation is required by EvAnnotationMarkup.

Implemented Interfaces

EvAnnotationText implements EvAnnotationMarkup.

EvAnnotationAttachment implements EvAnnotationMarkup.

Known Implementations

EvAnnotationMarkup is implemented by EvAnnotationAttachment and EvAnnotationText.

Description

Functions

ev_annotation_get_annotation_type ()

EvAnnotationType
ev_annotation_get_annotation_type (EvAnnotation *annot);

ev_annotation_get_page ()

EvPage *
ev_annotation_get_page (EvAnnotation *annot);

Get the page where annot appears.

Parameters

annot

an EvAnnotation

Returns

the EvPage where annot appears.

[transfer none]

ev_annotation_get_page_index ()

guint
ev_annotation_get_page_index (EvAnnotation *annot);

Get the index of the page where annot appears. Note that the index is 0 based.

Parameters

annot

an EvAnnotation

Returns

the page index.

ev_annotation_equal ()

gboolean
ev_annotation_equal (EvAnnotation *annot,
                     EvAnnotation *other);

Compare annot and other .

Parameters

annot	an EvAnnotation
other	another EvAnnotation

Returns

TRUE if annot is equal to other , FALSE otherwise

ev_annotation_get_contents ()

const gchar *
ev_annotation_get_contents (EvAnnotation *annot);

Get the contents of annot . The contents of annot is the text that is displayed in the annotation, or an alternate description of the annotation's content for non-text annotations

Parameters

annot

an EvAnnotation

Returns

a string with the contents of the annotation or NULL if annot has no contents.

ev_annotation_set_contents ()

gboolean
ev_annotation_set_contents (EvAnnotation *annot,
                            const gchar *contents);

Set the contents of annot . You can monitor changes in the annotation's contents by connecting to notify::contents signal of annot .

Parameters

annot

an EvAnnotation

Returns

TRUE if the contents have been changed, FALSE otherwise.

ev_annotation_get_name ()

const gchar *
ev_annotation_get_name (EvAnnotation *annot);

Get the name of annot . The name of the annotation is a string that uniquely indenftifies annot amongs all the annotations in the same page.

Parameters

annot

an EvAnnotation

Returns

the string with the annotation's name.

ev_annotation_set_name ()

gboolean
ev_annotation_set_name (EvAnnotation *annot,
                        const gchar *name);

Set the name of annot . You can monitor changes of the annotation name by connecting to the notify::name signal on annot .

Parameters

annot

an EvAnnotation

Returns

TRUE when the name has been changed, FALSE otherwise.

ev_annotation_get_modified ()

const gchar *
ev_annotation_get_modified (EvAnnotation *annot);

Get the last modification date of annot .

Parameters

annot

an EvAnnotation

Returns

A string containing the last modification date.

ev_annotation_set_modified ()

gboolean
ev_annotation_set_modified (EvAnnotation *annot,
                            const gchar *modified);

Set the last modification date of annot to modified . To set the last modification date using a GTime, use ev_annotation_set_modified_from_time() instead. You can monitor changes to the last modification date by connecting to the notify::modified signal on annot .

Parameters

annot	an EvAnnotation
modified	string with the last modification date.

Returns

TRUE if the last modification date has been updated, FALSE otherwise.

ev_annotation_set_modified_from_time ()

gboolean
ev_annotation_set_modified_from_time (EvAnnotation *annot,
                                      GTime utime);

Set the last modification date of annot to utime . You can monitor changes to the last modification date by connectin to the notify::modified sinal on annot . For the time-format used, see ev_document_misc_format_date().

Parameters

annot	an EvAnnotation
utime	a GTime

Returns

TRUE if the last modified date has been updated, FALSE otherwise.

ev_annotation_get_color ()

void
ev_annotation_get_color (EvAnnotation *annot,
                         GdkColor *color);

ev_annotation_get_color has been deprecated since version 3.6 and should not be used in newly-written code.

Use ev_annotation_get_rgba() instead.

Get the color of annot .

Parameters

annot	an EvAnnotation
color	a GdkColor to be filled with the Annotation color.	[out]

ev_annotation_set_color ()

gboolean
ev_annotation_set_color (EvAnnotation *annot,
                         const GdkColor *color);

ev_annotation_set_color has been deprecated since version 3.6 and should not be used in newly-written code.

Use ev_annotation_set_rgba() instead.

Set the color of the annotation to color . You can monitor changes to the annotation's color by connecting to notify::color signal on annot .

Parameters

annot	an Evannotation
color	a GdkColor

Returns

TRUE when the color has been changed, FALSE otherwise.

ev_annotation_get_rgba ()

void
ev_annotation_get_rgba (EvAnnotation *annot,
                        GdkRGBA *rgba);

Gets the color of annot .

Parameters

annot	an EvAnnotation
rgba	a GdkRGBA to be filled with the annotation color.	[out]

Since: 3.6

ev_annotation_set_rgba ()

gboolean
ev_annotation_set_rgba (EvAnnotation *annot,
                        const GdkRGBA *rgba);

Set the color of the annotation to rgba .

Parameters

annot	an Evannotation
rgba	a GdkRGBA

Returns

TRUE if the color has been changed, FALSE otherwise

Since: 3.6

ev_annotation_get_area ()

void
ev_annotation_get_area (EvAnnotation *annot,
                        EvRectangle *area);

ev_annotation_set_area ()

gboolean
ev_annotation_set_area (EvAnnotation *annot,
                        const EvRectangle *area);

Set the area of the annotation to area .

Parameters

annot	an Evannotation
area	a EvRectangle

Returns

TRUE if the area has been changed, FALSE otherwise

Since: 3.18

ev_annotation_markup_get_label ()

const gchar *
ev_annotation_markup_get_label (EvAnnotationMarkup *markup);

ev_annotation_markup_set_label ()

gboolean
ev_annotation_markup_set_label (EvAnnotationMarkup *markup,
                                const gchar *label);

ev_annotation_markup_get_opacity ()

gdouble
ev_annotation_markup_get_opacity (EvAnnotationMarkup *markup);

ev_annotation_markup_set_opacity ()

gboolean
ev_annotation_markup_set_opacity (EvAnnotationMarkup *markup,
                                  gdouble opacity);

ev_annotation_markup_has_popup ()

gboolean
ev_annotation_markup_has_popup (EvAnnotationMarkup *markup);

ev_annotation_markup_set_has_popup ()

gboolean
ev_annotation_markup_set_has_popup (EvAnnotationMarkup *markup,
                                    gboolean has_popup);

ev_annotation_markup_get_rectangle ()

void
ev_annotation_markup_get_rectangle (EvAnnotationMarkup *markup,
                                    EvRectangle *ev_rect);

ev_annotation_markup_set_rectangle ()

gboolean
ev_annotation_markup_set_rectangle (EvAnnotationMarkup *markup,
                                    const EvRectangle *ev_rect);

ev_annotation_markup_get_popup_is_open ()

gboolean
ev_annotation_markup_get_popup_is_open
                               (EvAnnotationMarkup *markup);

ev_annotation_markup_set_popup_is_open ()

gboolean
ev_annotation_markup_set_popup_is_open
                               (EvAnnotationMarkup *markup,
                                gboolean is_open);

ev_annotation_text_new ()

EvAnnotation *
ev_annotation_text_new (EvPage *page);

ev_annotation_text_get_icon ()

EvAnnotationTextIcon
ev_annotation_text_get_icon (EvAnnotationText *text);

ev_annotation_text_set_icon ()

gboolean
ev_annotation_text_set_icon (EvAnnotationText *text,
                             EvAnnotationTextIcon icon);

ev_annotation_text_get_is_open ()

gboolean
ev_annotation_text_get_is_open (EvAnnotationText *text);

ev_annotation_text_set_is_open ()

gboolean
ev_annotation_text_set_is_open (EvAnnotationText *text,
                                gboolean is_open);

ev_annotation_attachment_new ()

EvAnnotation *
ev_annotation_attachment_new (EvPage *page,
                              EvAttachment *attachment);

ev_annotation_attachment_get_attachment ()

EvAttachment *
ev_annotation_attachment_get_attachment
                               (EvAnnotationAttachment *annot);

Parameters

annot

an EvAnnotationAttachment

Returns

an EvAttachment.

[transfer none]

ev_annotation_attachment_set_attachment ()

gboolean
ev_annotation_attachment_set_attachment
                               (EvAnnotationAttachment *annot,
                                EvAttachment *attachment);

Types and Values

EvAnnotation

typedef struct _EvAnnotation EvAnnotation;

EvAnnotationClass

typedef struct _EvAnnotationClass EvAnnotationClass;

EvAnnotationMarkup

typedef struct _EvAnnotationMarkup EvAnnotationMarkup;

EvAnnotationMarkupInterface

typedef struct _EvAnnotationMarkupInterface EvAnnotationMarkupInterface;

EvAnnotationText

typedef struct _EvAnnotationText EvAnnotationText;

EvAnnotationTextClass

typedef struct _EvAnnotationTextClass EvAnnotationTextClass;

EvAnnotationAttachment

typedef struct _EvAnnotationAttachment EvAnnotationAttachment;

EvAnnotationAttachmentClass

typedef struct _EvAnnotationAttachmentClass EvAnnotationAttachmentClass;

enum EvAnnotationTextIcon

Members

EV_ANNOTATION_TEXT_ICON_NOTE
EV_ANNOTATION_TEXT_ICON_COMMENT
EV_ANNOTATION_TEXT_ICON_KEY
EV_ANNOTATION_TEXT_ICON_HELP
EV_ANNOTATION_TEXT_ICON_NEW_PARAGRAPH
EV_ANNOTATION_TEXT_ICON_PARAGRAPH
EV_ANNOTATION_TEXT_ICON_INSERT
EV_ANNOTATION_TEXT_ICON_CROSS
EV_ANNOTATION_TEXT_ICON_CIRCLE
EV_ANNOTATION_TEXT_ICON_UNKNOWN

enum EvAnnotationType

Members

EV_ANNOTATION_TYPE_UNKNOWN
EV_ANNOTATION_TYPE_TEXT
EV_ANNOTATION_TYPE_ATTACHMENT
EV_ANNOTATION_TYPE_TEXT_MARKUP

Property Details

The `“area”` property

  “area”                     EvRectangle *

The area of the page where the annotation is placed.

Since 3.18

Flags: Read / Write

The `“color”` property

  “color”                    gpointer

The colour of the annotation as a GdkColor.

EvAnnotation:color has been deprecated since version 3.6 and should not be used in newly-written code.

Use “rgba” instead.

Flags: Read / Write

The `“contents”` property

  “contents”                 gchar *

The annotation contents.

Flags: Read / Write

Default value: NULL

The `“modified”` property

  “modified”                 gchar *

Last modified date as string.

Flags: Read / Write

Default value: NULL

The `“name”` property

  “name”                     gchar *

The annotation unique name.

Flags: Read / Write

Default value: NULL

The `“page”` property

  “page”                     EvPage *

The page wehere the annotation is.

Flags: Write / Construct Only

The `“rgba”` property

  “rgba”                     GdkRGBA *

The colour of the annotation as a GdkRGBA.

Flags: Read / Write

Since: 3.6

The `“can-have-popup”` property

  “can-have-popup”           gboolean

Whether it is allowed to have a popup window for this type of markup annotation.

Flags: Read / Write

Default value: FALSE

The `“has-popup”` property

  “has-popup”                gboolean

Whether the markup annotation has a popup window associated.

Flags: Read / Write

Default value: TRUE

The `“label”` property

  “label”                    gchar *

Label of the markup annotation.

Flags: Read / Write

Default value: NULL

The `“opacity”` property

  “opacity”                  gdouble

Opacity of the markup annotation.

Flags: Read / Write

Allowed values: >= 0

Default value: 1

The `“popup-is-open”` property

  “popup-is-open”            gboolean

Whether the popup associated to the markup annotation is open.

Flags: Read / Write

Default value: FALSE

The `“rectangle”` property

  “rectangle”                EvRectangle *

The Rectangle of the popup associated to the markup annotation.

Flags: Read / Write

The `“icon”` property

  “icon”                     EvAnnotationTextIcon

The icon fo the text annotation.

Flags: Read / Write

Default value: EV_ANNOTATION_TEXT_ICON_NOTE

The `“is-open”` property

  “is-open”                  gboolean

Whether text annot is initially open.

Flags: Read / Write

Default value: FALSE

The `“attachment”` property

  “attachment”               EvAttachment *

The attachment of the annotation.

Flags: Read / Write / Construct