ev-annotation.h File Reference

#include <glib-object.h>
#include "ev-document.h"
#include "ev-attachment.h"
#include "ev-macros.h"

Include dependency graph for ev-annotation.h:

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

Go to the source code of this file.

Macros
#define	EV_TYPE_ANNOTATION   (ev_annotation_get_type())
#define	EV_ANNOTATION(object)   (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION, EvAnnotation))
#define	EV_ANNOTATION_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION, EvAnnotationClass))
#define	EV_IS_ANNOTATION(object)   (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION))
#define	EV_IS_ANNOTATION_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION))
#define	EV_ANNOTATION_GET_CLASS(object)   (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION, EvAnnotationClass))
#define	EV_TYPE_ANNOTATION_MARKUP   (ev_annotation_markup_get_type ())
#define	EV_ANNOTATION_MARKUP(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkup))
#define	EV_ANNOTATION_MARKUP_IFACE(k)   (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkupInterface))
#define	EV_IS_ANNOTATION_MARKUP(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_ANNOTATION_MARKUP))
#define	EV_IS_ANNOTATION_MARKUP_IFACE(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_ANNOTATION_MARKUP))
#define	EV_ANNOTATION_MARKUP_GET_IFACE(inst)   (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkupInterface))
#define	EV_TYPE_ANNOTATION_TEXT   (ev_annotation_text_get_type())
#define	EV_ANNOTATION_TEXT(object)   (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION_TEXT, EvAnnotationText))
#define	EV_ANNOTATION_TEXT_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION_TEXT, EvAnnotationTextClass))
#define	EV_IS_ANNOTATION_TEXT(object)   (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION_TEXT))
#define	EV_IS_ANNOTATION_TEXT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION_TEXT))
#define	EV_ANNOTATION_TEXT_GET_CLASS(object)   (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION_TEXT, EvAnnotationTextClass))
#define	EV_TYPE_ANNOTATION_ATTACHMENT   (ev_annotation_attachment_get_type())
#define	EV_ANNOTATION_ATTACHMENT(object)   (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachment))
#define	EV_ANNOTATION_ATTACHMENT_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachmentClass))
#define	EV_IS_ANNOTATION_ATTACHMENT(object)   (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION_ATTACHMENT))
#define	EV_IS_ANNOTATION_ATTACHMENT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION_ATTACHMENT))
#define	EV_ANNOTATION_ATTACHMENT_GET_CLASS(object)   (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachmentClass))
#define	EV_TYPE_ANNOTATION_TEXT_MARKUP   (ev_annotation_text_markup_get_type ())
#define	EV_ANNOTATION_TEXT_MARKUP(object)   (G_TYPE_CHECK_INSTANCE_CAST ((object), EV_TYPE_ANNOTATION_TEXT_MARKUP, EvAnnotationTextMarkup))
#define	EV_ANNOTATION_TEXT_MARKUP_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), EV_TYPE_ANNOTATION_TEXT_MARKUP, EvAnnotationTextMarkupClass))
#define	EV_IS_ANNOTATION_TEXT_MARKUP(object)   (G_TYPE_CHECK_INSTANCE_TYPE ((object), EV_TYPE_ANNOTATION_TEXT_MARKUP))
#define	EV_IS_ANNOTATION_TEXT_MARKUP_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), EV_TYPE_ANNOTATION_TEXT_MARKUP))
#define	EV_ANNOTATION_TEXT_MARKUP_GET_CLASS(object)   (G_TYPE_INSTANCE_GET_CLASS ((object), EV_TYPE_ANNOTATION_TEXT_MARKUP, EvAnnotationTextMarkupClass))

Typedefs
typedef struct _EvAnnotation	EvAnnotation
typedef struct _EvAnnotationClass	EvAnnotationClass
typedef struct _EvAnnotationMarkup	EvAnnotationMarkup
typedef struct _EvAnnotationMarkupInterface	EvAnnotationMarkupInterface
typedef struct _EvAnnotationText	EvAnnotationText
typedef struct _EvAnnotationTextClass	EvAnnotationTextClass
typedef struct _EvAnnotationAttachment	EvAnnotationAttachment
typedef struct _EvAnnotationAttachmentClass	EvAnnotationAttachmentClass
typedef struct _EvAnnotationTextMarkup	EvAnnotationTextMarkup
typedef struct _EvAnnotationTextMarkupClass	EvAnnotationTextMarkupClass

Enumerations
enum	EvAnnotationType { EV_ANNOTATION_TYPE_UNKNOWN, EV_ANNOTATION_TYPE_TEXT, EV_ANNOTATION_TYPE_ATTACHMENT, EV_ANNOTATION_TYPE_TEXT_MARKUP }
enum	EvAnnotationTextIcon {   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	EvAnnotationTextMarkupType { EV_ANNOTATION_TEXT_MARKUP_HIGHLIGHT, EV_ANNOTATION_TEXT_MARKUP_STRIKE_OUT, EV_ANNOTATION_TEXT_MARKUP_UNDERLINE, EV_ANNOTATION_TEXT_MARKUP_SQUIGGLY }

Functions
GType	ev_annotation_get_type (void) G_GNUC_CONST
EvAnnotationType	ev_annotation_get_annotation_type (EvAnnotation *annot)
EvPage *	ev_annotation_get_page (EvAnnotation *annot)
guint	ev_annotation_get_page_index (EvAnnotation *annot)
gboolean	ev_annotation_equal (EvAnnotation *annot, EvAnnotation *other)
const gchar *	ev_annotation_get_contents (EvAnnotation *annot)
gboolean	ev_annotation_set_contents (EvAnnotation *annot, const gchar *contents)
const gchar *	ev_annotation_get_name (EvAnnotation *annot)
gboolean	ev_annotation_set_name (EvAnnotation *annot, const gchar *name)
const gchar *	ev_annotation_get_modified (EvAnnotation *annot)
gboolean	ev_annotation_set_modified (EvAnnotation *annot, const gchar *modified)
gboolean	ev_annotation_set_modified_from_time (EvAnnotation *annot, GTime utime)
void	ev_annotation_get_color (EvAnnotation *annot, GdkColor *color)
gboolean	ev_annotation_set_color (EvAnnotation *annot, const GdkColor *color)
void	ev_annotation_get_rgba (EvAnnotation *annot, GdkRGBA *rgba)
gboolean	ev_annotation_set_rgba (EvAnnotation *annot, const GdkRGBA *rgba)
void	ev_annotation_get_area (EvAnnotation *annot, EvRectangle *area)
gboolean	ev_annotation_set_area (EvAnnotation *annot, const EvRectangle *area)
GType	ev_annotation_markup_get_type (void) G_GNUC_CONST
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_can_have_popup (EvAnnotationMarkup *markup)
gboolean	ev_annotation_markup_has_popup (EvAnnotationMarkup *markup)
gboolean	ev_annotation_markup_set_has_popup (EvAnnotationMarkup *markup, gboolean has_popup)
void	ev_annotation_markup_get_rectangle (EvAnnotationMarkup *markup, EvRectangle *ev_rect)
gboolean	ev_annotation_markup_set_rectangle (EvAnnotationMarkup *markup, const EvRectangle *ev_rect)
gboolean	ev_annotation_markup_get_popup_is_open (EvAnnotationMarkup *markup)
gboolean	ev_annotation_markup_set_popup_is_open (EvAnnotationMarkup *markup, gboolean is_open)
GType	ev_annotation_text_get_type (void) G_GNUC_CONST
EvAnnotation *	ev_annotation_text_new (EvPage *page)
EvAnnotationTextIcon	ev_annotation_text_get_icon (EvAnnotationText *text)
gboolean	ev_annotation_text_set_icon (EvAnnotationText *text, EvAnnotationTextIcon icon)
gboolean	ev_annotation_text_get_is_open (EvAnnotationText *text)
gboolean	ev_annotation_text_set_is_open (EvAnnotationText *text, gboolean is_open)
GType	ev_annotation_attachment_get_type (void) G_GNUC_CONST
EvAnnotation *	ev_annotation_attachment_new (EvPage *page, EvAttachment *attachment)
EvAttachment *	ev_annotation_attachment_get_attachment (EvAnnotationAttachment *annot)
gboolean	ev_annotation_attachment_set_attachment (EvAnnotationAttachment *annot, EvAttachment *attachment)
GType	ev_annotation_text_markup_get_type (void) G_GNUC_CONST
EvAnnotation *	ev_annotation_text_markup_highlight_new (EvPage *page)
EvAnnotation *	ev_annotation_text_markup_strike_out_new (EvPage *page)
EvAnnotation *	ev_annotation_text_markup_underline_new (EvPage *page)
EvAnnotation *	ev_annotation_text_markup_squiggly_new (EvPage *page)
EvAnnotationTextMarkupType	ev_annotation_text_markup_get_markup_type (EvAnnotationTextMarkup *annot)
gboolean	ev_annotation_text_markup_set_markup_type (EvAnnotationTextMarkup *annot, EvAnnotationTextMarkupType markup_type)

Macro Definition Documentation

#define EV_ANNOTATION

(

object)

(G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION, EvAnnotation))

Definition at line 39 of file ev-annotation.h.

#define EV_ANNOTATION_ATTACHMENT

(

object)

(G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachment))

Definition at line 63 of file ev-annotation.h.

#define EV_ANNOTATION_ATTACHMENT_CLASS

(

klass)

(G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachmentClass))

Definition at line 64 of file ev-annotation.h.

#define EV_ANNOTATION_ATTACHMENT_GET_CLASS

(

object)

(G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachmentClass))

Definition at line 67 of file ev-annotation.h.

#define EV_ANNOTATION_CLASS

(

klass)

(G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION, EvAnnotationClass))

Definition at line 40 of file ev-annotation.h.

#define EV_ANNOTATION_GET_CLASS

(

object)

(G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION, EvAnnotationClass))

Definition at line 43 of file ev-annotation.h.

#define EV_ANNOTATION_MARKUP

(

o)

(G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkup))

Definition at line 47 of file ev-annotation.h.

#define EV_ANNOTATION_MARKUP_GET_IFACE

(

inst)

(G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkupInterface))

Definition at line 51 of file ev-annotation.h.

#define EV_ANNOTATION_MARKUP_IFACE

(

k)

(G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkupInterface))

Definition at line 48 of file ev-annotation.h.

#define EV_ANNOTATION_TEXT

(

object)

(G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION_TEXT, EvAnnotationText))

Definition at line 55 of file ev-annotation.h.

#define EV_ANNOTATION_TEXT_CLASS

(

klass)

(G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION_TEXT, EvAnnotationTextClass))

Definition at line 56 of file ev-annotation.h.

#define EV_ANNOTATION_TEXT_GET_CLASS

(

object)

(G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION_TEXT, EvAnnotationTextClass))

Definition at line 59 of file ev-annotation.h.

#define EV_ANNOTATION_TEXT_MARKUP

(

object)

(G_TYPE_CHECK_INSTANCE_CAST ((object), EV_TYPE_ANNOTATION_TEXT_MARKUP, EvAnnotationTextMarkup))

Definition at line 71 of file ev-annotation.h.

#define EV_ANNOTATION_TEXT_MARKUP_CLASS

(

klass)

(G_TYPE_CHECK_CLASS_CAST ((klass), EV_TYPE_ANNOTATION_TEXT_MARKUP, EvAnnotationTextMarkupClass))

Definition at line 72 of file ev-annotation.h.

#define EV_ANNOTATION_TEXT_MARKUP_GET_CLASS

(

object)

(G_TYPE_INSTANCE_GET_CLASS ((object), EV_TYPE_ANNOTATION_TEXT_MARKUP, EvAnnotationTextMarkupClass))

Definition at line 75 of file ev-annotation.h.

#define EV_IS_ANNOTATION

(

object)

(G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION))

Definition at line 41 of file ev-annotation.h.

#define EV_IS_ANNOTATION_ATTACHMENT

(

object)

(G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION_ATTACHMENT))

Definition at line 65 of file ev-annotation.h.

#define EV_IS_ANNOTATION_ATTACHMENT_CLASS

(

klass)

(G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION_ATTACHMENT))

Definition at line 66 of file ev-annotation.h.

#define EV_IS_ANNOTATION_CLASS

(

klass)

(G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION))

Definition at line 42 of file ev-annotation.h.

#define EV_IS_ANNOTATION_MARKUP

(

o)

(G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_ANNOTATION_MARKUP))

Definition at line 49 of file ev-annotation.h.

#define EV_IS_ANNOTATION_MARKUP_IFACE

(

k)

(G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_ANNOTATION_MARKUP))

Definition at line 50 of file ev-annotation.h.

#define EV_IS_ANNOTATION_TEXT

(

object)

(G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION_TEXT))

Definition at line 57 of file ev-annotation.h.

#define EV_IS_ANNOTATION_TEXT_CLASS

(

klass)

(G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION_TEXT))

Definition at line 58 of file ev-annotation.h.

#define EV_IS_ANNOTATION_TEXT_MARKUP

(

object)

(G_TYPE_CHECK_INSTANCE_TYPE ((object), EV_TYPE_ANNOTATION_TEXT_MARKUP))

Definition at line 73 of file ev-annotation.h.

#define EV_IS_ANNOTATION_TEXT_MARKUP_CLASS

(

klass)

(G_TYPE_CHECK_CLASS_TYPE ((klass), EV_TYPE_ANNOTATION_TEXT_MARKUP))

Definition at line 74 of file ev-annotation.h.

#define EV_TYPE_ANNOTATION   (ev_annotation_get_type())

Definition at line 38 of file ev-annotation.h.

#define EV_TYPE_ANNOTATION_ATTACHMENT   (ev_annotation_attachment_get_type())

Definition at line 62 of file ev-annotation.h.

#define EV_TYPE_ANNOTATION_MARKUP   (ev_annotation_markup_get_type ())

Definition at line 46 of file ev-annotation.h.

#define EV_TYPE_ANNOTATION_TEXT   (ev_annotation_text_get_type())

Definition at line 54 of file ev-annotation.h.

#define EV_TYPE_ANNOTATION_TEXT_MARKUP   (ev_annotation_text_markup_get_type ())

Definition at line 70 of file ev-annotation.h.

Typedef Documentation

typedef struct _EvAnnotation EvAnnotation

Definition at line 77 of file ev-annotation.h.

typedef struct _EvAnnotationAttachment EvAnnotationAttachment

Definition at line 86 of file ev-annotation.h.

typedef struct _EvAnnotationAttachmentClass EvAnnotationAttachmentClass

Definition at line 87 of file ev-annotation.h.

typedef struct _EvAnnotationClass EvAnnotationClass

Definition at line 78 of file ev-annotation.h.

typedef struct _EvAnnotationMarkup EvAnnotationMarkup

Definition at line 80 of file ev-annotation.h.

typedef struct _EvAnnotationMarkupInterface EvAnnotationMarkupInterface

Definition at line 81 of file ev-annotation.h.

typedef struct _EvAnnotationText EvAnnotationText

Definition at line 83 of file ev-annotation.h.

typedef struct _EvAnnotationTextClass EvAnnotationTextClass

Definition at line 84 of file ev-annotation.h.

typedef struct _EvAnnotationTextMarkup EvAnnotationTextMarkup

Definition at line 89 of file ev-annotation.h.

typedef struct _EvAnnotationTextMarkupClass EvAnnotationTextMarkupClass

Definition at line 90 of file ev-annotation.h.

Enumeration Type Documentation

enum EvAnnotationTextIcon

Enumerator
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

Definition at line 99 of file ev-annotation.h.

             {
    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
} EvAnnotationTextIcon;

enum EvAnnotationTextMarkupType

Enumerator
EV_ANNOTATION_TEXT_MARKUP_HIGHLIGHT
EV_ANNOTATION_TEXT_MARKUP_STRIKE_OUT
EV_ANNOTATION_TEXT_MARKUP_UNDERLINE
EV_ANNOTATION_TEXT_MARKUP_SQUIGGLY

Definition at line 112 of file ev-annotation.h.

             {
        EV_ANNOTATION_TEXT_MARKUP_HIGHLIGHT,
        EV_ANNOTATION_TEXT_MARKUP_STRIKE_OUT,
        EV_ANNOTATION_TEXT_MARKUP_UNDERLINE,
        EV_ANNOTATION_TEXT_MARKUP_SQUIGGLY
} EvAnnotationTextMarkupType;

enum EvAnnotationType

Enumerator
EV_ANNOTATION_TYPE_UNKNOWN
EV_ANNOTATION_TYPE_TEXT
EV_ANNOTATION_TYPE_ATTACHMENT
EV_ANNOTATION_TYPE_TEXT_MARKUP

Definition at line 92 of file ev-annotation.h.

             {
    EV_ANNOTATION_TYPE_UNKNOWN,
    EV_ANNOTATION_TYPE_TEXT,
    EV_ANNOTATION_TYPE_ATTACHMENT,
    EV_ANNOTATION_TYPE_TEXT_MARKUP
} EvAnnotationType;

Function Documentation

EvAttachment* ev_annotation_attachment_get_attachment

(

EvAnnotationAttachment *

annot)

ev_annotation_attachment_get_attachment: : an EvAnnotationAttachment

Returns: (transfer none): an EvAttachment

Definition at line 1341 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION_ATTACHMENT (annot), NULL);

    return annot->attachment;
}

Here is the caller graph for this function:

GType ev_annotation_attachment_get_type

(

void

)

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

Definition at line 1323 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ATTACHMENT (attachment), NULL);

    return EV_ANNOTATION (g_object_new (EV_TYPE_ANNOTATION_ATTACHMENT,
                        "page", page,
                        "attachment", attachment,
                        NULL));
}

Here is the caller graph for this function:

gboolean ev_annotation_attachment_set_attachment	(	EvAnnotationAttachment *	annot,
		EvAttachment *	attachment
	)

Definition at line 1349 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION_ATTACHMENT (annot), FALSE);

    if (annot->attachment == attachment)
        return FALSE;

    if (annot->attachment)
        g_object_unref (annot->attachment);
    annot->attachment = attachment ? g_object_ref (attachment) : NULL;

    g_object_notify (G_OBJECT (annot), "attachment");

    return TRUE;
}

Here is the caller graph for this function:

gboolean ev_annotation_equal	(	EvAnnotation *	annot,
		EvAnnotation *	other
	)

ev_annotation_equal: : an EvAnnotation : another EvAnnotation

Compare and .

Returns: TRUE if is equal to , FALSE otherwise

Definition at line 390 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);
    g_return_val_if_fail (EV_IS_ANNOTATION (other), FALSE);

    return (annot == other || g_strcmp0 (annot->name, other->name) == 0);
}

Here is the caller graph for this function:

EvAnnotationType ev_annotation_get_annotation_type

(

EvAnnotation *

annot)

Definition at line 340 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), 0);

    return annot->type;
}

Here is the caller graph for this function:

void ev_annotation_get_area	(	EvAnnotation *	annot,
		EvRectangle *	area
	)

ev_annotation_set_area: : an EvAnnotation : (out): a EvRectangle to be filled with the annotation area

Gets the area of .

Since: 3.18

Definition at line 694 of file ev-annotation.c.

{
        g_return_if_fail (EV_IS_ANNOTATION (annot));
        g_return_if_fail (area != NULL);

        *area = annot->area;
}

Here is the caller graph for this function:

void ev_annotation_get_color	(	EvAnnotation *	annot,
		GdkColor *	color
	)

ev_annotation_get_color: : an EvAnnotation : (out): a #GdkColor to be filled with the Annotation color.

Get the color of .

Deprecated: 3.6: Use ev_annotation_get_rgba() instead.

Definition at line 585 of file ev-annotation.c.

{
        GdkRGBA rgba;

    g_return_if_fail (EV_IS_ANNOTATION (annot));
        g_return_if_fail (color != NULL);

        ev_annotation_get_rgba (annot, &rgba);

        color->pixel = 0;
        color->red = CLAMP (rgba.red * 65535. + 0.5, 0, 65535);
        color->green = CLAMP (rgba.green * 65535. + 0.5, 0, 65535);
        color->blue = CLAMP (rgba.blue * 65535. + 0.5, 0, 65535);
}

Here is the caller graph for this function:

const gchar* ev_annotation_get_contents

(

EvAnnotation *

annot)

ev_annotation_get_contents: : an EvAnnotation

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

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

Definition at line 411 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), NULL);

    return annot->contents;
}

Here is the caller graph for this function:

const gchar* ev_annotation_get_modified

(

EvAnnotation *

annot)

ev_annotation_get_modified: : an EvAnnotation

Get the last modification date of .

Returns: A string containing the last modification date.

Definition at line 501 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), NULL);

    return annot->modified;
}

Here is the caller graph for this function:

const gchar* ev_annotation_get_name

(

EvAnnotation *

annot)

ev_annotation_get_name: : an EvAnnotation

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

Returns: the string with the annotation's name.

Definition at line 457 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), NULL);

    return annot->name;
}

Here is the caller graph for this function:

EvPage* ev_annotation_get_page

(

EvAnnotation *

annot)

ev_annotation_get_page: : an EvAnnotation

Get the page where appears.

Returns: (transfer none): the EvPage where appears

Definition at line 356 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), NULL);

    return annot->page;
}

Here is the caller graph for this function:

guint ev_annotation_get_page_index

(

EvAnnotation *

annot)

ev_annotation_get_page_index: : an EvAnnotation

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

Returns: the page index.

Definition at line 373 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), 0);

    return annot->page->index;
}

Here is the caller graph for this function:

void ev_annotation_get_rgba	(	EvAnnotation *	annot,
		GdkRGBA *	rgba
	)

ev_annotation_get_rgba: : an EvAnnotation : (out): a #GdkRGBA to be filled with the annotation color

Gets the color of .

Since: 3.6

Definition at line 647 of file ev-annotation.c.

{
        g_return_if_fail (EV_IS_ANNOTATION (annot));
        g_return_if_fail (rgba != NULL);

        *rgba = annot->rgba;
}

Here is the caller graph for this function:

GType ev_annotation_get_type

(

void

)

gboolean ev_annotation_markup_can_have_popup

(

EvAnnotationMarkup *

markup)

Definition at line 978 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), FALSE);

    props = ev_annotation_markup_get_properties (markup);
    return props->can_have_popup;
}

Here is the caller graph for this function:

const gchar* ev_annotation_markup_get_label

(

EvAnnotationMarkup *

markup)

Definition at line 915 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), NULL);

    props = ev_annotation_markup_get_properties (markup);
    return props->label;
}

Here is the caller graph for this function:

gdouble ev_annotation_markup_get_opacity

(

EvAnnotationMarkup *

markup)

Definition at line 948 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), 1.0);

    props = ev_annotation_markup_get_properties (markup);
    return props->opacity;
}

Here is the caller graph for this function:

gboolean ev_annotation_markup_get_popup_is_open

(

EvAnnotationMarkup *

markup)

Definition at line 1055 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), FALSE);

    props = ev_annotation_markup_get_properties (markup);
    return props->popup_is_open;
}

Here is the caller graph for this function:

void ev_annotation_markup_get_rectangle	(	EvAnnotationMarkup *	markup,
		EvRectangle *	ev_rect
	)

Definition at line 1019 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_if_fail (EV_IS_ANNOTATION_MARKUP (markup));
    g_return_if_fail (ev_rect != NULL);

    props = ev_annotation_markup_get_properties (markup);
    *ev_rect = props->rectangle;
}

Here is the caller graph for this function:

GType ev_annotation_markup_get_type

(

void

)

gboolean ev_annotation_markup_has_popup

(

EvAnnotationMarkup *

markup)

Definition at line 989 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), FALSE);

    props = ev_annotation_markup_get_properties (markup);
    return props->has_popup;
}

Here is the caller graph for this function:

gboolean ev_annotation_markup_set_has_popup	(	EvAnnotationMarkup *	markup,
		gboolean	has_popup
	)

Definition at line 1000 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), FALSE);

    props = ev_annotation_markup_get_properties (markup);
    if (props->has_popup == has_popup)
        return FALSE;

    props->has_popup = has_popup;

    g_object_notify (G_OBJECT (markup), "has-popup");

    return TRUE;
}

Here is the caller graph for this function:

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

Definition at line 926 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), FALSE);
    g_return_val_if_fail (label != NULL, FALSE);

    props = ev_annotation_markup_get_properties (markup);
    if (g_strcmp0 (props->label, label) == 0)
        return FALSE;

    if (props->label)
        g_free (props->label);
    props->label = g_strdup (label);

    g_object_notify (G_OBJECT (markup), "label");

    return TRUE;
}

Here is the caller graph for this function:

gboolean ev_annotation_markup_set_opacity	(	EvAnnotationMarkup *	markup,
		gdouble	opacity
	)

Definition at line 959 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), FALSE);

    props = ev_annotation_markup_get_properties (markup);
    if (props->opacity == opacity)
        return FALSE;

    props->opacity = opacity;

    g_object_notify (G_OBJECT (markup), "opacity");

    return TRUE;
}

Here is the caller graph for this function:

gboolean ev_annotation_markup_set_popup_is_open	(	EvAnnotationMarkup *	markup,
		gboolean	is_open
	)

Definition at line 1066 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), FALSE);

    props = ev_annotation_markup_get_properties (markup);
    if (props->popup_is_open == is_open)
        return FALSE;

    props->popup_is_open = is_open;

    g_object_notify (G_OBJECT (markup), "popup_is_open");

    return TRUE;
}

Here is the caller graph for this function:

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

Definition at line 1032 of file ev-annotation.c.

{
    EvAnnotationMarkupProps *props;

    g_return_val_if_fail (EV_IS_ANNOTATION_MARKUP (markup), FALSE);
    g_return_val_if_fail (ev_rect != NULL, FALSE);

    props = ev_annotation_markup_get_properties (markup);
    if (props->rectangle.x1 == ev_rect->x1 &&
        props->rectangle.y1 == ev_rect->y1 &&
        props->rectangle.x2 == ev_rect->x2 &&
        props->rectangle.y2 == ev_rect->y2)
        return FALSE;

    props->rectangle = *ev_rect;

    g_object_notify (G_OBJECT (markup), "rectangle");

    return TRUE;
}

Here is the caller graph for this function:

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

ev_annotation_set_area: : an #Evannotation : a EvRectangle

Set the area of the annotation to .

Returns: TRUE if the area has been changed, FALSE otherwise

Since: 3.18

Definition at line 715 of file ev-annotation.c.

{
        gboolean was_initial;

        g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);
        g_return_val_if_fail (area != NULL, FALSE);

        if (ev_rect_cmp ((EvRectangle *)area, &annot->area) == 0)
                return FALSE;

        was_initial = annot->area.x1 == -1 && annot->area.x2 == -1
                && annot->area.y1 == -1 && annot->area.y2 == -1;
        annot->area = *area;
        if (!was_initial)
                g_object_notify (G_OBJECT (annot), "area");

        return TRUE;
}

Here is the caller graph for this function:

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

ev_annotation_set_color: : an #Evannotation : a #GdkColor

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

Returns: TRUE when the color has been changed, FALSE otherwise.

Deprecated: 3.6: Use ev_annotation_set_rgba() instead.

Definition at line 615 of file ev-annotation.c.

{
        GdkColor annot_color;
        GdkRGBA rgba;

    g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);

        ev_annotation_get_color (annot, &annot_color);
        if (color == NULL || gdk_color_equal (color, &annot_color))
                return FALSE;

        rgba.red = color->red / 65535.;
        rgba.green = color->green / 65535.;
        rgba.blue = color->blue / 65535.;
        rgba.alpha = 1.;

        ev_annotation_set_rgba (annot, &rgba);

    return TRUE;
}

Here is the caller graph for this function:

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

ev_annotation_set_contents: : an EvAnnotation

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

Returns: TRUE if the contents have been changed, FALSE otherwise.

Definition at line 429 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);

    if (g_strcmp0 (annot->contents, contents) == 0)
        return FALSE;

    if (annot->contents)
        g_free (annot->contents);
    annot->contents = contents ? g_strdup (contents) : NULL;

    g_object_notify (G_OBJECT (annot), "contents");

    return TRUE;
}

Here is the caller graph for this function:

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

ev_annotation_set_modified: : an EvAnnotation : string with the last modification date.

Set the last modification date of to . 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 .

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

Definition at line 522 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);

    if (g_strcmp0 (annot->modified, modified) == 0)
        return FALSE;

    if (annot->modified)
        g_free (annot->modified);
    annot->modified = modified ? g_strdup (modified) : NULL;

    g_object_notify (G_OBJECT (annot), "modified");

    return TRUE;
}

Here is the caller graph for this function:

gboolean ev_annotation_set_modified_from_time	(	EvAnnotation *	annot,
		GTime	utime
	)

ev_annotation_set_modified_from_time: : an EvAnnotation : a #GTime

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

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

Definition at line 552 of file ev-annotation.c.

{
    gchar *modified;

    g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);

    modified = ev_document_misc_format_date (utime);

    if (g_strcmp0 (annot->modified, modified) == 0) {
        g_free (modified);
        return FALSE;
    }

    if (annot->modified)
        g_free (annot->modified);
    annot->modified = modified;

    g_object_notify (G_OBJECT (annot), "modified");

    return TRUE;
}

Here is the caller graph for this function:

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

ev_annotation_set_name: : an EvAnnotation

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

Returns: TRUE when the name has been changed, FALSE otherwise.

Definition at line 475 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);

    if (g_strcmp0 (annot->name, name) == 0)
        return FALSE;

    if (annot->name)
        g_free (annot->name);
    annot->name = name ? g_strdup (name) : NULL;

    g_object_notify (G_OBJECT (annot), "name");

    return TRUE;
}

Here is the caller graph for this function:

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

ev_annotation_set_rgba: : an #Evannotation : a #GdkRGBA

Set the color of the annotation to .

Returns: TRUE if the color has been changed, FALSE otherwise

Since: 3.6

Definition at line 668 of file ev-annotation.c.

{
        g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);
        g_return_val_if_fail (rgba != NULL, FALSE);

        if (gdk_rgba_equal (rgba, &annot->rgba))
                return FALSE;

        annot->rgba = *rgba;
        g_object_notify (G_OBJECT (annot), "rgba");
    g_object_notify (G_OBJECT (annot), "color");

        return TRUE;
}

Here is the caller graph for this function:

EvAnnotationTextIcon ev_annotation_text_get_icon

(

EvAnnotationText *

text)

Definition at line 1184 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION_TEXT (text), 0);

    return text->icon;
}

Here is the caller graph for this function:

gboolean ev_annotation_text_get_is_open

(

EvAnnotationText *

text)

Definition at line 1208 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION_TEXT (text), FALSE);

    return text->is_open;
}

Here is the caller graph for this function:

GType ev_annotation_text_get_type

(

void

)

EvAnnotationTextMarkupType ev_annotation_text_markup_get_markup_type

(

EvAnnotationTextMarkup *

annot)

Definition at line 1485 of file ev-annotation.c.

{
        g_return_val_if_fail (EV_IS_ANNOTATION_TEXT_MARKUP (annot), EV_ANNOTATION_TEXT_MARKUP_HIGHLIGHT);

        return annot->type;
}

Here is the caller graph for this function:

GType ev_annotation_text_markup_get_type

(

void

)

EvAnnotation* ev_annotation_text_markup_highlight_new

(

EvPage *

page)

Definition at line 1445 of file ev-annotation.c.

{
        EvAnnotation *annot = EV_ANNOTATION (g_object_new (EV_TYPE_ANNOTATION_TEXT_MARKUP,
                                                           "page", page,
                                                           "type", EV_ANNOTATION_TEXT_MARKUP_HIGHLIGHT,
                                                           NULL));
        return annot;
}

Here is the caller graph for this function:

gboolean ev_annotation_text_markup_set_markup_type	(	EvAnnotationTextMarkup *	annot,
		EvAnnotationTextMarkupType	markup_type
	)

Definition at line 1493 of file ev-annotation.c.

{
        g_return_val_if_fail (EV_IS_ANNOTATION_TEXT_MARKUP (annot), FALSE);

        if (annot->type == markup_type)
                return FALSE;

        annot->type = markup_type;
        g_object_notify (G_OBJECT (annot), "type");

        return TRUE;
}

Here is the caller graph for this function:

EvAnnotation* ev_annotation_text_markup_squiggly_new

(

EvPage *

page)

Definition at line 1475 of file ev-annotation.c.

{
        EvAnnotation *annot = EV_ANNOTATION (g_object_new (EV_TYPE_ANNOTATION_TEXT_MARKUP,
                                                           "page", page,
                                                           "type", EV_ANNOTATION_TEXT_MARKUP_SQUIGGLY,
                                                           NULL));
        return annot;
}

Here is the caller graph for this function:

EvAnnotation* ev_annotation_text_markup_strike_out_new

(

EvPage *

page)

Definition at line 1455 of file ev-annotation.c.

{
        EvAnnotation *annot = EV_ANNOTATION (g_object_new (EV_TYPE_ANNOTATION_TEXT_MARKUP,
                                                           "page", page,
                                                           "type", EV_ANNOTATION_TEXT_MARKUP_STRIKE_OUT,
                                                           NULL));
        return annot;
}

Here is the caller graph for this function:

EvAnnotation* ev_annotation_text_markup_underline_new

(

EvPage *

page)

Definition at line 1465 of file ev-annotation.c.

{
        EvAnnotation *annot = EV_ANNOTATION (g_object_new (EV_TYPE_ANNOTATION_TEXT_MARKUP,
                                                           "page", page,
                                                           "type", EV_ANNOTATION_TEXT_MARKUP_UNDERLINE,
                                                           NULL));
        return annot;
}

Here is the caller graph for this function:

EvAnnotation* ev_annotation_text_new

(

EvPage *

page)

Definition at line 1176 of file ev-annotation.c.

{
    return EV_ANNOTATION (g_object_new (EV_TYPE_ANNOTATION_TEXT,
                        "page", page,
                        NULL));
}

Here is the caller graph for this function:

gboolean ev_annotation_text_set_icon	(	EvAnnotationText *	text,
		EvAnnotationTextIcon	icon
	)

Definition at line 1192 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION_TEXT (text), FALSE);

    if (text->icon == icon)
        return FALSE;

    text->icon = icon;

    g_object_notify (G_OBJECT (text), "icon");

    return TRUE;
}

Here is the caller graph for this function:

gboolean ev_annotation_text_set_is_open	(	EvAnnotationText *	text,
		gboolean	is_open
	)

Definition at line 1216 of file ev-annotation.c.

{
    g_return_val_if_fail (EV_IS_ANNOTATION_TEXT (text), FALSE);

    if (text->is_open == is_open)
        return FALSE;

    text->is_open = is_open;

    g_object_notify (G_OBJECT (text), "is_open");

    return TRUE;
}

Here is the caller graph for this function: