EvAnnotation: Atril Document Library Reference Manual

## EvAnnotation EvAnnotation |

## Functions

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 ()
void | ev_annotation_markup_get_rectangle ()
EvAnnotation * | ev_annotation_text_new ()
EvAnnotation * | ev_annotation_attachment_new ()

## Properties

gpointer | color | Read / Write
gchar * | contents | Read / Write
gchar * | modified | Read / Write
gchar * | name | Read / Write
EvPage * | page | Write / Construct Only
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
| EvAnnotationText
| EvAnnotationTextClass
| EvAnnotationAttachment
| EvAnnotationAttachmentClass

## Object Hierarchy

        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_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_get_rectangle ()

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

### ev_annotation_text_new ()

    EvAnnotation *
    ev_annotation_text_new (EvPage *page);

### ev_annotation_attachment_new ()

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

## Types and Values

### EvAnnotation

    typedef struct _EvAnnotation EvAnnotation;

### EvAnnotationClass

    typedef struct _EvAnnotationClass EvAnnotationClass;

### EvAnnotationMarkup

    typedef struct _EvAnnotationMarkup EvAnnotationMarkup;

### EvAnnotationText

    typedef struct _EvAnnotationText EvAnnotationText;

### EvAnnotationTextClass

    typedef struct _EvAnnotationTextClass EvAnnotationTextClass;

### EvAnnotationAttachment

    typedef struct _EvAnnotationAttachment EvAnnotationAttachment;

### EvAnnotationAttachmentClass

    typedef struct _EvAnnotationAttachmentClass EvAnnotationAttachmentClass;

## Property Details

### The `“color”` property

      “color”                    gpointer

The annotation color.

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 `“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