EvAnnotation

EvAnnotation

Synopsis

                    EvAnnotation;
                    EvAnnotationClass;
                    EvAnnotationMarkup;
                    EvAnnotationText;
                    EvAnnotationTextClass;
                    EvAnnotationAttachment;
                    EvAnnotationAttachmentClass;
const gchar *       ev_annotation_markup_get_label      (EvAnnotationMarkup *markup);
gboolean            ev_annotation_markup_set_label      (EvAnnotationMarkup *markup,
                                                         const gchar *label);
gdouble             ev_annotation_markup_get_opacity    (EvAnnotationMarkup *markup);
gboolean            ev_annotation_markup_set_opacity    (EvAnnotationMarkup *markup,
                                                         gdouble opacity);
gboolean            ev_annotation_markup_has_popup      (EvAnnotationMarkup *markup);
void                ev_annotation_markup_get_rectangle  (EvAnnotationMarkup *markup,
                                                         EvRectangle *ev_rect);
EvAnnotation *      ev_annotation_text_new              (EvPage *page);
EvAnnotation *      ev_annotation_attachment_new        (EvPage *page,
                                                         EvAttachment *attachment);

Object Hierarchy

  GObject
   +----EvAnnotation
         +----EvAnnotationAttachment
         +----EvAnnotationText

  GInterface
   +----EvAnnotationMarkup

  GObject
   +----EvAnnotation
         +----EvAnnotationText

  GObject
   +----EvAnnotation
         +----EvAnnotationAttachment

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.

Properties

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

Description

Details

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;

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

Property Details

The "color" property

  "color"                    gpointer              : Read / Write

The annotation color.

The "contents" property

  "contents"                 gchar*                : Read / Write

The annotation contents.

Default value: NULL

The "modified" property

  "modified"                 gchar*                : Read / Write

Last modified date as string.

Default value: NULL

The "name" property

  "name"                     gchar*                : Read / Write

The annotation unique name.

Default value: NULL

The "page" property

  "page"                     EvPage*               : Write / Construct Only

The page wehere the annotation is.

The "has-popup" property

  "has-popup"                gboolean              : Read / Write

Whether the markup annotation has a popup window associated.

Default value: TRUE

The "label" property

  "label"                    gchar*                : Read / Write

Label of the markup annotation.

Default value: NULL

The "opacity" property

  "opacity"                  gdouble               : Read / Write

Opacity of the markup annotation.

Allowed values: >= 0

Default value: 1

The "popup-is-open" property

  "popup-is-open"            gboolean              : Read / Write

Whether the popup associated to the markup annotation is open.

Default value: FALSE

The "rectangle" property

  "rectangle"                EvRectangle*          : Read / Write

The Rectangle of the popup associated to the markup annotation.

The "icon" property

  "icon"                     EvAnnotationTextIcon  : Read / Write

The icon fo the text annotation.

Default value: EV_ANNOTATION_TEXT_ICON_NOTE

The "is-open" property

  "is-open"                  gboolean              : Read / Write

Whether text annot is initially open.

Default value: FALSE

The "attachment" property

  "attachment"               EvAttachment*         : Read / Write / Construct

The attachment of the annotation.

Generated by GTK-Doc V1.15