libdocument: Add EvAnnotation API using GdkRGBA

Add new API to EvAnnotation that uses GdkRGBA, and deprecated the GdkColor using one. Part of https://bugzilla.gnome.org/show_bug.cgi?id=677983 taken from: https://git.gnome.org/browse/evince/commit/?id=c477923 https://git.gnome.org/browse/evince/commit/?id=87ca31d
author: Christian Persch <[email protected]> 2012-06-13 01:08:48 +0200
committer: raveit65 <[email protected]> 2017-08-14 20:02:44 +0200
commit: 0b8edc9752cc3eef784366e95f038aa442575c71 (patch)
tree: b504d260dfc0c95d6a46f2757b647c6828e77434
parent: a2e5e6d2dd44f9d2de05d5563df20989360dbdf7 (diff)
download: atril-0b8edc9752cc3eef784366e95f038aa442575c71.tar.bz2
atril-0b8edc9752cc3eef784366e95f038aa442575c71.tar.xz
3 files changed, 121 insertions, 20 deletions
diff --git a/help/reference/libdocument/libatrildocument-sections.txt b/help/reference/libdocument/libatrildocument-sections.txt
index 23a164b9..14982529 100644
--- a/help/reference/libdocument/libatrildocument-sections.txt
+++ b/help/reference/libdocument/libatrildocument-sections.txt
@@ -568,6 +568,8 @@ ev_annotation_set_modified
 ev_annotation_set_modified_from_time
 ev_annotation_get_color
 ev_annotation_set_color
+ev_annotation_get_rgba
+ev_annotation_set_rgba
 ev_annotation_markup_get_label
 ev_annotation_markup_set_label
 ev_annotation_markup_get_opacity
diff --git a/libdocument/ev-annotation.c b/libdocument/ev-annotation.c
index 4258b4a7..1120a3a9 100644
--- a/libdocument/ev-annotation.c
+++ b/libdocument/ev-annotation.c
@@ -34,8 +34,7 @@ struct _EvAnnotation {
 gchar *contents;
 gchar *name;
 gchar *modified;
- GdkColor color;
-
+ GdkRGBA rgba;
 };
 
 struct _EvAnnotationClass {
@@ -78,7 +77,8 @@ enum {
 PROP_ANNOT_CONTENTS,
 PROP_ANNOT_NAME,
 PROP_ANNOT_MODIFIED,
- PROP_ANNOT_COLOR
+ PROP_ANNOT_COLOR,
+ PROP_ANNOT_RGBA
 };
 
 /* EvAnnotationMarkup */
@@ -174,6 +174,9 @@ ev_annotation_set_property (GObject *object,
 case PROP_ANNOT_COLOR:
 ev_annotation_set_color (annot, g_value_get_pointer (value));
 break;
+ case PROP_ANNOT_RGBA:
+ ev_annotation_set_rgba (annot, g_value_get_boxed (value));
+ break;
 default:
 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 }
@@ -197,8 +200,14 @@ ev_annotation_get_property (GObject *object,
 case PROP_ANNOT_MODIFIED:
 g_value_set_string (value, ev_annotation_get_modified (annot));
 break;
- case PROP_ANNOT_COLOR:
- g_value_set_pointer (value, &annot->color);
+ case PROP_ANNOT_COLOR: {
+ GdkColor color;
+ ev_annotation_get_color (annot, &color);
+ g_value_set_pointer (value, &color);
+ break;
+ }
+ case PROP_ANNOT_RGBA:
+ g_value_set_boxed (value, &annot->rgba);
 break;
 default:
 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
@@ -242,12 +251,33 @@ ev_annotation_class_init (EvAnnotationClass *klass)
 "Last modified date as string",
 NULL,
 G_PARAM_READWRITE));
+ /**
+ * EvAnnotation:color:
+ *
+ * The colour of the annotation as a #GdkColor.
+ *
+ * Deprecated: 1.2.1: Use #EvAnnotation:rgba instead.
+ */
 g_object_class_install_property (g_object_class,
 PROP_ANNOT_COLOR,
 g_param_spec_pointer ("color",
 "Color",
 "The annotation color",
 G_PARAM_READWRITE));
+
+ /**
+ * EvAnnotation:rgba:
+ *
+ * The colour of the annotation as a #GdkRGBA.
+ *
+ * Since: 1.2.1
+ */
+ g_object_class_install_property (g_object_class,
+ PROP_ANNOT_COLOR,
+ g_param_spec_boxed ("rgba", NULL, NULL,
+ GDK_TYPE_RGBA,
+ G_PARAM_READWRITE |
+ G_PARAM_STATIC_STRINGS));
 }
 
 EvAnnotationType
@@ -489,18 +519,27 @@ ev_annotation_set_modified_from_time (EvAnnotation *annot,
 /**
 * ev_annotation_get_color:
 * @annot: an #EvAnnotation
- * @color (out): a #GdkColor to be filled with the Annotation color.
+ * @color: (out): a #GdkColor to be filled with the Annotation color.
 *
 * Get the color of @annot.
+ *
+ * Deprecated: 1.2.1: Use ev_annotation_get_rgba() instead.
 */
 void
 ev_annotation_get_color (EvAnnotation *annot,
- GdkColor *color)
+ GdkColor *color)
 {
- g_return_if_fail (EV_IS_ANNOTATION (annot));
+ GdkRGBA rgba;
+
+ g_return_if_fail (EV_IS_ANNOTATION (annot));
+ g_return_if_fail (color != NULL);
 
- if (color)
- *color = annot->color;
+ 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);
 }
 
 /**
@@ -513,24 +552,77 @@ ev_annotation_get_color (EvAnnotation *annot,
 * notify::color signal on @annot.
 *
 * Returns: %TRUE when the color has been changed, %FALSE otherwise.
+ *
+ * Deprecated: 1.2.1: Use ev_annotation_set_rgba() instead.
 */
 gboolean
 ev_annotation_set_color (EvAnnotation *annot,
- const GdkColor *color)
+ const GdkColor *color)
 {
- g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);
+ GdkColor annot_color;
+ GdkRGBA rgba;
 
- if (annot->color.red == color->red &&
- annot->color.green == color->green &&
- annot->color.blue == color->blue)
- return FALSE;
+ g_return_val_if_fail (EV_IS_ANNOTATION (annot), FALSE);
 
- if (color)
- annot->color = *color;
+ ev_annotation_get_color (annot, &annot_color);
+ if (color == NULL || gdk_color_equal (color, &annot_color))
+ return FALSE;
 
- g_object_notify (G_OBJECT (annot), "color");
+ rgba.red = color->red / 65535.;
+ rgba.green = color->green / 65535.;
+ rgba.blue = color->blue / 65535.;
+ rgba.alpha = 1.;
 
- return TRUE;
+ ev_annotation_set_rgba (annot, &rgba);
+ g_object_notify (G_OBJECT (annot), "color");
+
+ return TRUE;
+}
+
+/**
+ * ev_annotation_get_rgba:
+ * @annot: an #EvAnnotation
+ * @rgba: (out): a #GdkRGBA to be filled with the annotation color
+ *
+ * Gets the color of @annot.
+ *
+ * Since: 1.2.1
+ */
+void
+ev_annotation_get_rgba (EvAnnotation *annot,
+ GdkRGBA *rgba)
+{
+ g_return_if_fail (EV_IS_ANNOTATION (annot));
+ g_return_if_fail (rgba != NULL);
+
+ *rgba = annot->rgba;
+}
+
+/**
+ * ev_annotation_set_rgba:
+ * @annot: an #Evannotation
+ * @rgba: a #GdkRGBA
+ *
+ * Set the color of the annotation to @rgba.
+ *
+ * Returns: %TRUE if the color has been changed, %FALSE otherwise
+ *
+ * Since: 1.2.1
+ */
+gboolean
+ev_annotation_set_rgba (EvAnnotation *annot,
+ const GdkRGBA *rgba)
+{
+ 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");
+
+ return TRUE;
 }
 
 /* EvAnnotationMarkup */
diff --git a/libdocument/ev-annotation.h b/libdocument/ev-annotation.h
index 395270e1..408c4577 100644
--- a/libdocument/ev-annotation.h
+++ b/libdocument/ev-annotation.h
@@ -31,6 +31,7 @@
 
 #include "ev-document.h"
 #include "ev-attachment.h"
+#include "ev-macros.h"
 
 G_BEGIN_DECLS
 
@@ -115,10 +116,16 @@ gboolean ev_annotation_set_modified (EvAnnotation
 const gchar *modified);
 gboolean ev_annotation_set_modified_from_time (EvAnnotation *annot,
 GTime utime);
+EV_DEPRECATED_FOR(ev_annotaion_get_rgba)
 void ev_annotation_get_color (EvAnnotation *annot,
 GdkColor *color);
+EV_DEPRECATED_FOR(ev_annotaion_set_rgba)
 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);
 
 /* EvAnnotationMarkup */
 GType ev_annotation_markup_get_type (void) G_GNUC_CONST;
author	Christian Persch <[email protected]>	2012-06-13 01:08:48 +0200
committer	raveit65 <[email protected]>	2017-08-14 20:02:44 +0200
commit	0b8edc9752cc3eef784366e95f038aa442575c71 (patch)
tree	b504d260dfc0c95d6a46f2757b647c6828e77434
parent	a2e5e6d2dd44f9d2de05d5563df20989360dbdf7 (diff)
download	atril-0b8edc9752cc3eef784366e95f038aa442575c71.tar.bz2 atril-0b8edc9752cc3eef784366e95f038aa442575c71.tar.xz