EvAnnotationText

EvAnnotationText

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

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);

ev_annotation_get_page_index ()

guint
ev_annotation_get_page_index (EvAnnotation *annot);

ev_annotation_equal ()

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

ev_annotation_get_contents ()

const gchar *
ev_annotation_get_contents (EvAnnotation *annot);

ev_annotation_set_contents ()

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

ev_annotation_get_name ()

const gchar *
ev_annotation_get_name (EvAnnotation *annot);

ev_annotation_set_name ()

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

ev_annotation_get_modified ()

const gchar *
ev_annotation_get_modified (EvAnnotation *annot);

ev_annotation_set_modified ()

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

ev_annotation_set_modified_from_time ()

gboolean
ev_annotation_set_modified_from_time (EvAnnotation *annot,
                                      GTime utime);

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.


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.


ev_annotation_get_rgba ()

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

Since: 3.6


ev_annotation_set_rgba ()

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

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);

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);

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.

Flags: Read / Write


The “color” property

  “color”                    gpointer

The annotation color.

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 *

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