ev-document-annotations.h File Reference

#include <glib-object.h>
#include "ev-document.h"
#include "ev-annotation.h"
#include "ev-mapping-list.h"

Include dependency graph for ev-document-annotations.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_EvDocumentAnnotationsInterface

Macros
#define	EV_TYPE_DOCUMENT_ANNOTATIONS   (ev_document_annotations_get_type ())
#define	EV_DOCUMENT_ANNOTATIONS(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotations))
#define	EV_DOCUMENT_ANNOTATIONS_IFACE(k)   (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotationsInterface))
#define	EV_IS_DOCUMENT_ANNOTATIONS(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_ANNOTATIONS))
#define	EV_IS_DOCUMENT_ANNOTATIONS_IFACE(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_ANNOTATIONS))
#define	EV_DOCUMENT_ANNOTATIONS_GET_IFACE(inst)   (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotationsInterface))

Typedefs
typedef struct _EvDocumentAnnotations	EvDocumentAnnotations
typedef struct _EvDocumentAnnotationsInterface	EvDocumentAnnotationsInterface

Enumerations
enum	EvAnnotationsSaveMask {   EV_ANNOTATIONS_SAVE_NONE = 0, EV_ANNOTATIONS_SAVE_CONTENTS = 1 << 0, EV_ANNOTATIONS_SAVE_COLOR = 1 << 1, EV_ANNOTATIONS_SAVE_AREA = 1 << 2,   EV_ANNOTATIONS_SAVE_LABEL = 1 << 3, EV_ANNOTATIONS_SAVE_OPACITY = 1 << 4, EV_ANNOTATIONS_SAVE_POPUP_RECT = 1 << 5, EV_ANNOTATIONS_SAVE_POPUP_IS_OPEN = 1 << 6,   EV_ANNOTATIONS_SAVE_TEXT_IS_OPEN = 1 << 7, EV_ANNOTATIONS_SAVE_TEXT_ICON = 1 << 8, EV_ANNOTATIONS_SAVE_ATTACHMENT = 1 << 9, EV_ANNOTATIONS_SAVE_TEXT_MARKUP_TYPE = 1 << 10,   EV_ANNOTATIONS_SAVE_ALL = (1 << 11) - 1 }

Functions
GType	ev_document_annotations_get_type (void) G_GNUC_CONST
EvMappingList *	ev_document_annotations_get_annotations (EvDocumentAnnotations *document_annots, EvPage *page)
gboolean	ev_document_annotations_document_is_modified (EvDocumentAnnotations *document_annots)
void	ev_document_annotations_add_annotation (EvDocumentAnnotations *document_annots, EvAnnotation *annot, EvRectangle *rect)
void	ev_document_annotations_remove_annotation (EvDocumentAnnotations *document_annots, EvAnnotation *annot)
void	ev_document_annotations_save_annotation (EvDocumentAnnotations *document_annots, EvAnnotation *annot, EvAnnotationsSaveMask mask)
gboolean	ev_document_annotations_can_add_annotation (EvDocumentAnnotations *document_annots)
gboolean	ev_document_annotations_can_remove_annotation (EvDocumentAnnotations *document_annots)

Macro Definition Documentation

#define EV_DOCUMENT_ANNOTATIONS

(

o)

(G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotations))

Definition at line 37 of file ev-document-annotations.h.

#define EV_DOCUMENT_ANNOTATIONS_GET_IFACE

(

inst)

(G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotationsInterface))

Definition at line 41 of file ev-document-annotations.h.

#define EV_DOCUMENT_ANNOTATIONS_IFACE

(

k)

(G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotationsInterface))

Definition at line 38 of file ev-document-annotations.h.

#define EV_IS_DOCUMENT_ANNOTATIONS

(

o)

(G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_ANNOTATIONS))

Definition at line 39 of file ev-document-annotations.h.

#define EV_IS_DOCUMENT_ANNOTATIONS_IFACE

(

k)

(G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_ANNOTATIONS))

Definition at line 40 of file ev-document-annotations.h.

#define EV_TYPE_DOCUMENT_ANNOTATIONS   (ev_document_annotations_get_type ())

Definition at line 36 of file ev-document-annotations.h.

Typedef Documentation

typedef struct _EvDocumentAnnotations EvDocumentAnnotations

Definition at line 69 of file ev-document-annotations.h.

typedef struct _EvDocumentAnnotationsInterface EvDocumentAnnotationsInterface

Definition at line 70 of file ev-document-annotations.h.

Enumeration Type Documentation

enum EvAnnotationsSaveMask

Enumerator
EV_ANNOTATIONS_SAVE_NONE
EV_ANNOTATIONS_SAVE_CONTENTS
EV_ANNOTATIONS_SAVE_COLOR
EV_ANNOTATIONS_SAVE_AREA
EV_ANNOTATIONS_SAVE_LABEL
EV_ANNOTATIONS_SAVE_OPACITY
EV_ANNOTATIONS_SAVE_POPUP_RECT
EV_ANNOTATIONS_SAVE_POPUP_IS_OPEN
EV_ANNOTATIONS_SAVE_TEXT_IS_OPEN
EV_ANNOTATIONS_SAVE_TEXT_ICON
EV_ANNOTATIONS_SAVE_ATTACHMENT
EV_ANNOTATIONS_SAVE_TEXT_MARKUP_TYPE
EV_ANNOTATIONS_SAVE_ALL

Definition at line 43 of file ev-document-annotations.h.

             {
    EV_ANNOTATIONS_SAVE_NONE             = 0,
    EV_ANNOTATIONS_SAVE_CONTENTS         = 1 << 0,
    EV_ANNOTATIONS_SAVE_COLOR            = 1 << 1,
        EV_ANNOTATIONS_SAVE_AREA             = 1 << 2,

    /* Markup Annotations */
    EV_ANNOTATIONS_SAVE_LABEL            = 1 << 3,
    EV_ANNOTATIONS_SAVE_OPACITY          = 1 << 4,
    EV_ANNOTATIONS_SAVE_POPUP_RECT       = 1 << 5,
    EV_ANNOTATIONS_SAVE_POPUP_IS_OPEN    = 1 << 6,

    /* Text Annotations */
    EV_ANNOTATIONS_SAVE_TEXT_IS_OPEN     = 1 << 7,
    EV_ANNOTATIONS_SAVE_TEXT_ICON        = 1 << 8,

    /* Attachment Annotations */
    EV_ANNOTATIONS_SAVE_ATTACHMENT       = 1 << 9,

        /* Text Markup Annotations */
        EV_ANNOTATIONS_SAVE_TEXT_MARKUP_TYPE = 1 << 10,

    /* Save all */
    EV_ANNOTATIONS_SAVE_ALL              = (1 << 11) - 1
} EvAnnotationsSaveMask;

Function Documentation

void ev_document_annotations_add_annotation	(	EvDocumentAnnotations *	document_annots,
		EvAnnotation *	annot,
		EvRectangle *	rect
	)

Definition at line 59 of file ev-document-annotations.c.

{
    EvDocumentAnnotationsInterface *iface = EV_DOCUMENT_ANNOTATIONS_GET_IFACE (document_annots);

    if (iface->add_annotation)
        iface->add_annotation (document_annots, annot, rect);
}

Here is the caller graph for this function:

gboolean ev_document_annotations_can_add_annotation

(

EvDocumentAnnotations *

document_annots)

Definition at line 70 of file ev-document-annotations.c.

{
    EvDocumentAnnotationsInterface *iface = EV_DOCUMENT_ANNOTATIONS_GET_IFACE (document_annots);

    return iface->add_annotation != NULL;
}

Here is the caller graph for this function:

gboolean ev_document_annotations_can_remove_annotation

(

EvDocumentAnnotations *

document_annots)

Definition at line 88 of file ev-document-annotations.c.

{
        EvDocumentAnnotationsInterface *iface = EV_DOCUMENT_ANNOTATIONS_GET_IFACE (document_annots);

    return iface->remove_annotation != NULL;
}

Here is the caller graph for this function:

gboolean ev_document_annotations_document_is_modified

(

EvDocumentAnnotations *

document_annots)

Definition at line 41 of file ev-document-annotations.c.

{
    EvDocumentAnnotationsInterface *iface = EV_DOCUMENT_ANNOTATIONS_GET_IFACE (document_annots);

    return (iface->document_is_modified) ? iface->document_is_modified (document_annots) : FALSE;
}

Here is the caller graph for this function:

EvMappingList* ev_document_annotations_get_annotations	(	EvDocumentAnnotations *	document_annots,
		EvPage *	page
	)

Definition at line 32 of file ev-document-annotations.c.

{
    EvDocumentAnnotationsInterface *iface = EV_DOCUMENT_ANNOTATIONS_GET_IFACE (document_annots);

    return iface->get_annotations (document_annots, page);
}

Here is the caller graph for this function:

GType ev_document_annotations_get_type

(

void

)

void ev_document_annotations_remove_annotation	(	EvDocumentAnnotations *	document_annots,
		EvAnnotation *	annot
	)

Definition at line 78 of file ev-document-annotations.c.

{
    EvDocumentAnnotationsInterface *iface = EV_DOCUMENT_ANNOTATIONS_GET_IFACE (document_annots);

    if (iface->remove_annotation)
        iface->remove_annotation (document_annots, annot);
}

Here is the caller graph for this function:

void ev_document_annotations_save_annotation	(	EvDocumentAnnotations *	document_annots,
		EvAnnotation *	annot,
		EvAnnotationsSaveMask	mask
	)

Definition at line 49 of file ev-document-annotations.c.

{
    EvDocumentAnnotationsInterface *iface = EV_DOCUMENT_ANNOTATIONS_GET_IFACE (document_annots);

    iface->save_annotation (document_annots, annot, mask);
}

Here is the caller graph for this function: