diff options
author | Carlos Garcia Campos <carlosgc@gnome.org> | 2009-05-12 09:04:14 (GMT) |
---|---|---|
committer | Carlos Garcia Campos <carlosgc@gnome.org> | 2009-05-12 09:04:14 (GMT) |
commit | 0dd0c92a0acb3d4aaecb7fd56e6ca71e89fef54a (patch) | |
tree | 993e48348bce731a7639eb48e8f58eda7bfc17d8 /libdocument/ev-annotation.h | |
parent | 13c5a93aca3d2e7b88161ae047b751af20ce277d (diff) |
[libdocument] Add annotations interface
Diffstat (limited to 'libdocument/ev-annotation.h')
-rw-r--r-- | libdocument/ev-annotation.h | 143 |
1 files changed, 143 insertions, 0 deletions
diff --git a/libdocument/ev-annotation.h b/libdocument/ev-annotation.h new file mode 100644 index 0000000..47d908d --- /dev/null +++ b/libdocument/ev-annotation.h @@ -0,0 +1,143 @@ +/* ev-annotation.h + * this file is part of evince, a gnome document viewer + * + * Copyright (C) 2009 Carlos Garcia Campos <carlosgc@gnome.org> + * Copyright (C) 2007 IƱigo Martinez <inigomartinez@gmail.com> + * + * Evince is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * Evince is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. + */ + +#ifndef EV_ANNOTATION_H +#define EV_ANNOTATION_H + +#include <glib-object.h> + +#include "ev-document.h" + +G_BEGIN_DECLS + +/* EvAnnotation */ +#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)) + +/* EvAnnotationMarkup */ +#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, EvAnnotationMarkupIface)) +#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, EvAnnotationMarkupIface)) + +/* EvAnnotationText */ +#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)) + +typedef struct _EvAnnotation EvAnnotation; +typedef struct _EvAnnotationClass EvAnnotationClass; + +typedef struct _EvAnnotationMarkup EvAnnotationMarkup; +typedef struct _EvAnnotationMarkupIface EvAnnotationMarkupIface; + +typedef struct _EvAnnotationText EvAnnotationText; +typedef struct _EvAnnotationTextClass EvAnnotationTextClass; + +struct _EvAnnotation +{ + GObject parent; + + EvPage *page; + gboolean changed; + + gchar *contents; + gchar *name; + gchar *modified; + GdkColor color; + +}; + +struct _EvAnnotationClass +{ + GObjectClass parent_class; +}; + +struct _EvAnnotationMarkupIface +{ + GTypeInterface base_iface; +}; + +struct _EvAnnotationText +{ + EvAnnotation parent; + + gboolean is_open : 1; +}; + +struct _EvAnnotationTextClass +{ + EvAnnotationClass parent_class; +}; + +/* EvAnnotation */ +GType ev_annotation_get_type (void) G_GNUC_CONST; + +/* EvAnnotationMarkup */ +GType ev_annotation_markup_get_type (void) G_GNUC_CONST; +gchar *ev_annotation_markup_get_label (EvAnnotationMarkup *markup); +void ev_annotation_markup_set_label (EvAnnotationMarkup *markup, + const gchar *label); +gdouble ev_annotation_markup_get_opacity (EvAnnotationMarkup *markup); +void ev_annotation_markup_set_opacity (EvAnnotationMarkup *markup, + gdouble opacity); +void ev_annotation_markup_get_rectangle (EvAnnotationMarkup *markup, + EvRectangle *ev_rect); +gboolean ev_annotation_markup_get_is_open (EvAnnotationMarkup *markup); +void ev_annotation_markup_set_is_open (EvAnnotationMarkup *markup, + gboolean is_open); + +/* EvAnnotationText */ +GType ev_annotation_text_get_type (void) G_GNUC_CONST; +EvAnnotation *ev_annotation_text_new (EvPage *page); + + +/* Annotation Mapping stuff */ +typedef struct _EvAnnotationMapping EvAnnotationMapping; +struct _EvAnnotationMapping +{ + EvAnnotation *annotation; + gdouble x1; + gdouble y1; + gdouble x2; + gdouble y2; +}; + +void ev_annotation_mapping_free (GList *annotation_mapping); +EvAnnotation *ev_annotation_mapping_find (GList *annotation_mapping, + gdouble x, + gdouble y); +void ev_annotation_mapping_get_area (GList *annotation_mapping, + EvAnnotation *annotation, + EvRectangle *area); + +G_END_DECLS + +#endif /* EV_ANNOTATION_H */ |