[gtk+/xi2] changed gdk_device_get_relative() to gdk_device_get_associated_device().

[Carlos Garnacho <carlosg src gnome org>]

commit 02a4201cee42033378a36eb3a6b85d0999dca2a0
Author: Carlos Garnacho <carlos lanedo com>
Date:   Fri Oct 30 18:38:29 2009 +0100

    changed gdk_device_get_relative() to gdk_device_get_associated_device().
    
    Peter Hutterer pointed out that the word "relative" already has connotations
    in this context, so a more descriptive name is used now. All callers have
    been updated as well, and missing docs were added.

 gdk/gdk.symbols                 |    1 +
 gdk/gdkdevice.c                 |   62 ++++++++++++++++++++++++--------------
 gdk/gdkdevice.h                 |    2 +-
 gdk/gdkdeviceprivate.h          |    4 +-
 gdk/x11/gdkdevicemanager-core.c |    4 +-
 gdk/x11/gdkdevicemanager-xi2.c  |    4 +-
 6 files changed, 47 insertions(+), 30 deletions(-)
---
diff --git a/gdk/gdk.symbols b/gdk/gdk.symbols
index c891eee..cb8fc52 100644
--- a/gdk/gdk.symbols
+++ b/gdk/gdk.symbols
@@ -404,6 +404,7 @@ gdk_device_manager_get_type G_GNUC_CONST
 #if IN_HEADER(__GDK_DEVICE_H__)
 #if IN_FILE(__GDK_DEVICE_C__)
 gdk_device_free_history
+gdk_device_get_associated_device
 gdk_device_get_axis
 gdk_device_get_history
 gdk_device_get_type G_GNUC_CONST
diff --git a/gdk/gdkdevice.c b/gdk/gdkdevice.c
index 2fa58ab..6955c32 100644
--- a/gdk/gdkdevice.c
+++ b/gdk/gdkdevice.c
@@ -45,7 +45,7 @@ struct _GdkDevicePrivate
 {
   GdkDeviceManager *device_manager;
   GdkDisplay *display;
-  GdkDevice *relative;
+  GdkDevice *associated;
   GdkDeviceType type;
   GArray *axes;
 };
@@ -68,7 +68,7 @@ enum {
   PROP_DISPLAY,
   PROP_DEVICE_MANAGER,
   PROP_NAME,
-  PROP_RELATIVE,
+  PROP_ASSOCIATED_DEVICE,
   PROP_TYPE,
   PROP_INPUT_SOURCE,
   PROP_INPUT_MODE,
@@ -116,10 +116,10 @@ gdk_device_class_init (GdkDeviceClass *klass)
                                                       GDK_DEVICE_TYPE_MASTER,
                                                       G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
   g_object_class_install_property (object_class,
-				   PROP_RELATIVE,
-				   g_param_spec_object ("relative",
-                                                        P_("Relative device"),
-                                                        P_("Corresponding pointer or keyboard to this device"),
+				   PROP_ASSOCIATED_DEVICE,
+				   g_param_spec_object ("associated-device",
+                                                        P_("Associated device"),
+                                                        P_("Associated pointer or keyboard to this device"),
                                                         GDK_TYPE_DEVICE,
                                                         G_PARAM_READABLE));
   g_object_class_install_property (object_class,
@@ -174,11 +174,11 @@ gdk_device_dispose (GObject *object)
   device = GDK_DEVICE (object);
   priv = GDK_DEVICE_GET_PRIVATE (device);
 
-  if (priv->relative)
+  if (priv->associated)
     {
-      _gdk_device_set_relative (priv->relative, NULL);
-      g_object_unref (priv->relative);
-      priv->relative = NULL;
+      _gdk_device_set_associated_device (priv->associated, NULL);
+      g_object_unref (priv->associated);
+      priv->associated = NULL;
     }
 
   if (priv->axes)
@@ -256,8 +256,8 @@ gdk_device_get_property (GObject    *object,
     case PROP_DEVICE_MANAGER:
       g_value_set_object (value, priv->device_manager);
       break;
-    case PROP_RELATIVE:
-      g_value_set_object (value, priv->relative);
+    case PROP_ASSOCIATED_DEVICE:
+      g_value_set_object (value, priv->associated);
       break;
     case PROP_NAME:
       g_value_set_string (value,
@@ -464,8 +464,24 @@ gdk_device_get_display (GdkDevice *device)
   return priv->display;
 }
 
+/**
+ * gdk_device_get_associated_device:
+ * @device: a #GdkDevice
+ *
+ * Returns the associated device to @device, if @device is of type
+ * %GDK_DEVICE_TYPE_MASTER, it will return the paired pointer or
+ * keyboard.
+ *
+ * If @device is of type %GDK_DEVICE_TYPE_SLAVE, it will return
+ * the master device to which @device is attached to.
+ *
+ * If @device is of type %GDK_DEVICE_TYPE_FLOATING, %NULL will be
+ * returned, as there is no associated device.
+ *
+ * Returns: The associated device, or %NULL
+ **/
 GdkDevice *
-gdk_device_get_relative (GdkDevice *device)
+gdk_device_get_associated_device (GdkDevice *device)
 {
   GdkDevicePrivate *priv;
 
@@ -473,31 +489,31 @@ gdk_device_get_relative (GdkDevice *device)
 
   priv = GDK_DEVICE_GET_PRIVATE (device);
 
-  return priv->relative;
+  return priv->associated;
 }
 
 void
-_gdk_device_set_relative (GdkDevice *device,
-                          GdkDevice *relative)
+_gdk_device_set_associated_device (GdkDevice *device,
+                                   GdkDevice *associated)
 {
   GdkDevicePrivate *priv;
 
   g_return_if_fail (GDK_IS_DEVICE (device));
-  g_return_if_fail (GDK_IS_DEVICE (relative));
+  g_return_if_fail (GDK_IS_DEVICE (associated));
 
   priv = GDK_DEVICE_GET_PRIVATE (device);
 
-  if (priv->relative == relative)
+  if (priv->associated == associated)
     return;
 
-  if (priv->relative)
+  if (priv->associated)
     {
-      g_object_unref (priv->relative);
-      priv->relative = NULL;
+      g_object_unref (priv->associated);
+      priv->associated = NULL;
     }
 
-  if (relative)
-    priv->relative = g_object_ref (relative);
+  if (associated)
+    priv->associated = g_object_ref (associated);
 }
 
 /**
diff --git a/gdk/gdkdevice.h b/gdk/gdkdevice.h
index 3f4eae2..3107315 100644
--- a/gdk/gdkdevice.h
+++ b/gdk/gdkdevice.h
@@ -164,7 +164,7 @@ gboolean gdk_device_get_axis     (GdkDevice         *device,
 				  gdouble           *value);
 GdkDisplay * gdk_device_get_display (GdkDevice      *device);
 
-GdkDevice  * gdk_device_get_relative (GdkDevice     *device);
+GdkDevice  * gdk_device_get_associated_device (GdkDevice     *device);
 
 GdkDeviceType gdk_device_get_device_type (GdkDevice *device);
 
diff --git a/gdk/gdkdeviceprivate.h b/gdk/gdkdeviceprivate.h
index 9ce5875..15f0546 100644
--- a/gdk/gdkdeviceprivate.h
+++ b/gdk/gdkdeviceprivate.h
@@ -88,8 +88,8 @@ struct _GdkDeviceClass
                                       GdkEventMask     event_mask);
 };
 
-void  _gdk_device_set_relative (GdkDevice *device,
-                                GdkDevice *relative);
+void  _gdk_device_set_associated_device (GdkDevice *device,
+                                         GdkDevice *relative);
 
 void  _gdk_device_reset_axes (GdkDevice   *device);
 guint _gdk_device_add_axis   (GdkDevice   *device,
diff --git a/gdk/x11/gdkdevicemanager-core.c b/gdk/x11/gdkdevicemanager-core.c
index 04e7f93..627e751 100644
--- a/gdk/x11/gdkdevicemanager-core.c
+++ b/gdk/x11/gdkdevicemanager-core.c
@@ -127,8 +127,8 @@ gdk_device_manager_core_constructed (GObject *object)
   device_manager->core_pointer = create_core_pointer (GDK_DEVICE_MANAGER (device_manager), display);
   device_manager->core_keyboard = create_core_keyboard (GDK_DEVICE_MANAGER (device_manager), display);
 
-  _gdk_device_set_relative (device_manager->core_pointer, device_manager->core_keyboard);
-  _gdk_device_set_relative (device_manager->core_keyboard, device_manager->core_pointer);
+  _gdk_device_set_associated_device (device_manager->core_pointer, device_manager->core_keyboard);
+  _gdk_device_set_associated_device (device_manager->core_keyboard, device_manager->core_pointer);
 }
 
 static void
diff --git a/gdk/x11/gdkdevicemanager-xi2.c b/gdk/x11/gdkdevicemanager-xi2.c
index d0ccb2a..9f381bb 100644
--- a/gdk/x11/gdkdevicemanager-xi2.c
+++ b/gdk/x11/gdkdevicemanager-xi2.c
@@ -306,8 +306,8 @@ relate_devices (gpointer key,
   device = g_hash_table_lookup (device_manager->id_table, key);
   relative = g_hash_table_lookup (device_manager->id_table, value);
 
-  _gdk_device_set_relative (device, relative);
-  _gdk_device_set_relative (relative, device);
+  _gdk_device_set_associated_device (device, relative);
+  _gdk_device_set_associated_device (relative, device);
 }
 
 static void