From afd2420fa8875f07b9758e1cb41d623b4ad05797 Mon Sep 17 00:00:00 2001 From: David Zeuthen Date: Sun, 21 Dec 2008 17:33:48 -0500 Subject: add docs for EggDBusVariant --- docs/eggdbus/eggdbus-docs.xml | 113 ++-- src/eggdbus/eggdbusvariant.c | 625 ++++++++++++++++++++- .../org.freedesktop.DBus.Introspectable.xml | 2 +- src/eggdbus/org.freedesktop.DBus.Peer.xml | 2 +- src/eggdbus/org.freedesktop.DBus.Properties.xml | 2 +- src/eggdbus/org.freedesktop.DBus.xml | 2 +- 6 files changed, 690 insertions(+), 56 deletions(-) diff --git a/docs/eggdbus/eggdbus-docs.xml b/docs/eggdbus/eggdbus-docs.xml index eeac764..b3f79fa 100644 --- a/docs/eggdbus/eggdbus-docs.xml +++ b/docs/eggdbus/eggdbus-docs.xml @@ -55,71 +55,84 @@ + + EggDBus Overview + + Introduction + + TODO: write me. + + + + - EggDBus API Reference - - - - - - - - - - - - - Collections - - - - + API Reference + + Types and Collections + + + + + + + + + + D-Bus Operations + + + + + + + + - Standard D-Bus Interfaces - - - - - - - - + Well-known D-Bus Interfaces + + + + + + + + - Example - - - - - - - - - - - - - - - - - - - - Object Hierarchy - + Example of Generated Code + + + + + + + + + + + + + + + + - Programs + Tools Reference + + Object Hierarchy + + + Index diff --git a/src/eggdbus/eggdbusvariant.c b/src/eggdbus/eggdbusvariant.c index 5f32c2c..6fb00bf 100644 --- a/src/eggdbus/eggdbusvariant.c +++ b/src/eggdbus/eggdbusvariant.c @@ -35,6 +35,16 @@ #include #include +/** + * SECTION:eggdbusvariant + * @title: EggDBusVariant + * @short_description: Holds a value and a type + * + * The #EggDBusVariant type is used to represent D-Bus variants. It is a polymorphic type + * in the sense that it can hold any values of any type used in D-Bus. It is similar to + * #GValue but provides a simpler API in addition to knowledge about the D-Bus signature. + */ + typedef struct { gchar *signature; GValue value; @@ -141,6 +151,14 @@ egg_dbus_variant_class_init (EggDBusVariantClass *klass) G_PARAM_STATIC_BLURB)); } +/** + * egg_dbus_variant_get_variant_signature: + * @variant: A #EggDBusVariant. + * + * Gets the signature of the type that @variant holds. + * + * Returns: A D-Bus signature. Do not free, the value is owned by @variant. + **/ const gchar * egg_dbus_variant_get_variant_signature (EggDBusVariant *variant) { @@ -253,6 +271,13 @@ set_signature_for_hash_table (EggDBusVariant *variant, /* ---------------------------------------------------------------------------------------------------- */ +/** + * egg_dbus_variant_new: + * + * Creates a new #EggDBusVariant that doesn't hold any value. + * + * Returns: A #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new (void) { @@ -261,6 +286,15 @@ egg_dbus_variant_new (void) return variant; } +/** + * egg_dbus_variant_new_for_gvalue: + * @value: A #GValue. + * @signature: D-Bus signature for @value. + * + * Creates a new #EggDBusVariant from @value and @signature. + * + * Returns: A #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_gvalue (const GValue *value, const gchar *signature) @@ -278,6 +312,14 @@ egg_dbus_variant_new_for_gvalue (const GValue *value, return variant; } +/** + * egg_dbus_variant_get_gvalue: + * @variant: A #EggDBusVariant. + * + * Gets the value of @variant as a #GValue. + * + * Returns: A pointer to a #GValue owned by @variant. Do not free. + **/ const GValue * egg_dbus_variant_get_gvalue (EggDBusVariant *variant) { @@ -289,6 +331,14 @@ egg_dbus_variant_get_gvalue (EggDBusVariant *variant) /* ---------------------------------------------------------------------------------------------------- */ +/** + * egg_dbus_variant_new_for_string: + * @value: A string. + * + * Creates a new variant that holds a copy of @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_string (const gchar *value) { @@ -298,6 +348,14 @@ egg_dbus_variant_new_for_string (const gchar *value) return variant; } +/** + * egg_dbus_variant_new_for_object_path: + * @value: An object path. + * + * Creates a new variant that holds a copy of @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_object_path (const gchar *value) { @@ -307,6 +365,31 @@ egg_dbus_variant_new_for_object_path (const gchar *value) return variant; } +/** + * egg_dbus_variant_new_for_signature: + * @value: A D-Bus signature. + * + * Creates a new variant that holds a copy of @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ +EggDBusVariant * +egg_dbus_variant_new_for_signature (const gchar *value) +{ + EggDBusVariant *variant; + variant = egg_dbus_variant_new (); + egg_dbus_variant_set_signature (variant, value); + return variant; +} + +/** + * egg_dbus_variant_new_for_string_array: + * @value: A string array. + * + * Creates a new variant that holds a copy of @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_string_array (gchar **value) { @@ -316,6 +399,14 @@ egg_dbus_variant_new_for_string_array (gchar **value) return variant; } +/** + * egg_dbus_variant_new_for_object_path_array: + * @value: An object path array. + * + * Creates a new variant that holds a copy of @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_object_path_array (gchar **value) { @@ -325,6 +416,14 @@ egg_dbus_variant_new_for_object_path_array (gchar **value) return variant; } +/** + * egg_dbus_variant_new_for_signature_array: + * @value: A signature array. + * + * Creates a new variant that holds a copy of @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_signature_array (gchar **value) { @@ -334,6 +433,14 @@ egg_dbus_variant_new_for_signature_array (gchar **value) return variant; } +/** + * egg_dbus_variant_new_for_byte: + * @value: A #guchar. + * + * Creates a new variant that holds a #guchar equal to @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_byte (guchar value) { @@ -343,6 +450,14 @@ egg_dbus_variant_new_for_byte (guchar value) return variant; } +/** + * egg_dbus_variant_new_for_int16: + * @value: A #gint16. + * + * Creates a new variant that holds a #gint16 equal to @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_int16 (gint16 value) { @@ -352,6 +467,14 @@ egg_dbus_variant_new_for_int16 (gint16 value) return variant; } +/** + * egg_dbus_variant_new_for_uint16: + * @value: A #guint16. + * + * Creates a new variant that holds a #guint16 equal to @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_uint16 (guint16 value) { @@ -361,6 +484,14 @@ egg_dbus_variant_new_for_uint16 (guint16 value) return variant; } +/** + * egg_dbus_variant_new_for_int: + * @value: A #gint. + * + * Creates a new variant that holds a #gint equal to @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_int (gint value) { @@ -370,6 +501,14 @@ egg_dbus_variant_new_for_int (gint value) return variant; } +/** + * egg_dbus_variant_new_for_uint: + * @value: A #guint. + * + * Creates a new variant that holds a #guint equal to @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_uint (guint value) { @@ -379,6 +518,14 @@ egg_dbus_variant_new_for_uint (guint value) return variant; } +/** + * egg_dbus_variant_new_for_int64: + * @value: A #gint64. + * + * Creates a new variant that holds a #gint64 equal to @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_int64 (gint64 value) { @@ -388,6 +535,14 @@ egg_dbus_variant_new_for_int64 (gint64 value) return variant; } +/** + * egg_dbus_variant_new_for_uint64: + * @value: A #guint64. + * + * Creates a new variant that holds a #guint64 equal to @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_uint64 (guint64 value) { @@ -397,6 +552,14 @@ egg_dbus_variant_new_for_uint64 (guint64 value) return variant; } +/** + * egg_dbus_variant_new_for_boolean: + * @value: A #gboolean. + * + * Creates a new variant that holds a #gboolean equal to @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_boolean (gboolean value) { @@ -406,6 +569,14 @@ egg_dbus_variant_new_for_boolean (gboolean value) return variant; } +/** + * egg_dbus_variant_new_for_double: + * @value: A #gdouble. + * + * Creates a new variant that holds a #gdouble equal to @value. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_double (gdouble value) { @@ -415,6 +586,15 @@ egg_dbus_variant_new_for_double (gdouble value) return variant; } +/** + * egg_dbus_variant_new_for_seq: + * @seq: A #EggDBusArraySeq. + * @element_signature: D-Bus signature of the elements stored in @seq. + * + * Creates a new variant that holds a reference to @seq. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_seq (EggDBusArraySeq *seq, const gchar *element_signature) @@ -425,17 +605,35 @@ egg_dbus_variant_new_for_seq (EggDBusArraySeq *seq, return variant; } +/** + * egg_dbus_variant_new_for_map: + * @map: A #EggDBusHashMap. + * @key_signature: D-Bus signature of the keys stored in @map. + * @value_signature: D-Bus signature of the values stored in @map. + * + * Creates a new variant that holds a reference to @map. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * -egg_dbus_variant_new_for_map (EggDBusHashMap *hash_map, +egg_dbus_variant_new_for_map (EggDBusHashMap *map, const gchar *key_signature, const gchar *value_signature) { EggDBusVariant *variant; variant = egg_dbus_variant_new (); - egg_dbus_variant_set_map (variant, hash_map, key_signature, value_signature); + egg_dbus_variant_set_map (variant, map, key_signature, value_signature); return variant; } +/** + * egg_dbus_variant_new_for_structure: + * @structure: A #EggDBusStructure. + * + * Creates a new variant that holds a reference to @structure. + * + * Returns: A new #EggDBusVariant. Free with g_object_unref(). + **/ EggDBusVariant * egg_dbus_variant_new_for_structure (EggDBusStructure *structure) { @@ -447,6 +645,13 @@ egg_dbus_variant_new_for_structure (EggDBusStructure *structure) /* ---------------------------------------------------------------------------------------------------- */ +/** + * egg_dbus_variant_set_string: + * @variant: A #EggDBusVariant. + * @value: A string. + * + * Makes @variant hold a copy of @value. + **/ void egg_dbus_variant_set_string (EggDBusVariant *variant, const gchar *value) @@ -461,6 +666,13 @@ egg_dbus_variant_set_string (EggDBusVariant *variant, set_signature (variant, "s"); } +/** + * egg_dbus_variant_set_object_path: + * @variant: A #EggDBusVariant. + * @value: An object path. + * + * Makes @variant hold a copy of @value. + **/ void egg_dbus_variant_set_object_path (EggDBusVariant *variant, const gchar *value) @@ -475,6 +687,34 @@ egg_dbus_variant_set_object_path (EggDBusVariant *variant, set_signature (variant, "o"); } +/** + * egg_dbus_variant_set_signature: + * @variant: A #EggDBusVariant. + * @value: A signature. + * + * Makes @variant hold a copy of @value. + **/ +void +egg_dbus_variant_set_signature (EggDBusVariant *variant, + const gchar *value) +{ + EggDBusVariantPrivate *priv; + g_return_if_fail (EGG_DBUS_IS_VARIANT (variant)); + priv = EGG_DBUS_VARIANT_GET_PRIVATE (variant); + if (priv->signature != NULL) + g_value_unset (&priv->value); + g_value_init (&priv->value, EGG_DBUS_TYPE_OBJECT_PATH); + g_value_set_boxed (&priv->value, value); + set_signature (variant, "o"); +} + +/** + * egg_dbus_variant_set_string_array: + * @variant: A #EggDBusVariant. + * @value: A %NULL-terminated string array. + * + * Makes @variant hold a copy of @value. + **/ void egg_dbus_variant_set_string_array (EggDBusVariant *variant, gchar **value) @@ -489,6 +729,13 @@ egg_dbus_variant_set_string_array (EggDBusVariant *variant, set_signature (variant, "as"); } +/** + * egg_dbus_variant_set_object_path_array: + * @variant: A #EggDBusVariant. + * @value: A %NULL-terminated object path array. + * + * Makes @variant hold a copy of @value. + **/ void egg_dbus_variant_set_object_path_array (EggDBusVariant *variant, gchar **value) @@ -503,6 +750,13 @@ egg_dbus_variant_set_object_path_array (EggDBusVariant *variant, set_signature (variant, "ao"); } +/** + * egg_dbus_variant_set_signature_array: + * @variant: A #EggDBusVariant. + * @value: A %NULL-terminated signature array. + * + * Makes @variant hold a copy of @value. + **/ void egg_dbus_variant_set_signature_array (EggDBusVariant *variant, gchar **value) @@ -517,6 +771,13 @@ egg_dbus_variant_set_signature_array (EggDBusVariant *variant, set_signature (variant, "ao"); } +/** + * egg_dbus_variant_set_byte: + * @variant: A #EggDBusVariant. + * @value: A #guchar. + * + * Makes @variant hold a #guchar equal to @value. + **/ void egg_dbus_variant_set_byte (EggDBusVariant *variant, guchar value) @@ -531,6 +792,13 @@ egg_dbus_variant_set_byte (EggDBusVariant *variant, set_signature (variant, "y"); } +/** + * egg_dbus_variant_set_int16: + * @variant: A #EggDBusVariant. + * @value: A #gint16. + * + * Makes @variant hold a #gint16 equal to @value. + **/ void egg_dbus_variant_set_int16 (EggDBusVariant *variant, gint16 value) @@ -545,6 +813,13 @@ egg_dbus_variant_set_int16 (EggDBusVariant *variant, set_signature (variant, "n"); } +/** + * egg_dbus_variant_set_uint16: + * @variant: A #EggDBusVariant. + * @value: A #guint16. + * + * Makes @variant hold a #guint64 equal to @value. + **/ void egg_dbus_variant_set_uint16 (EggDBusVariant *variant, guint16 value) @@ -559,6 +834,13 @@ egg_dbus_variant_set_uint16 (EggDBusVariant *variant, set_signature (variant, "q"); } +/** + * egg_dbus_variant_set_int: + * @variant: A #EggDBusVariant. + * @value: A #gint. + * + * Makes @variant hold a #gint equal to @value. + **/ void egg_dbus_variant_set_int (EggDBusVariant *variant, gint value) @@ -573,6 +855,13 @@ egg_dbus_variant_set_int (EggDBusVariant *variant, set_signature (variant, "i"); } +/** + * egg_dbus_variant_set_uint: + * @variant: A #EggDBusVariant. + * @value: A #guint. + * + * Makes @variant hold a #guint equal to @value. + **/ void egg_dbus_variant_set_uint (EggDBusVariant *variant, guint value) @@ -587,6 +876,13 @@ egg_dbus_variant_set_uint (EggDBusVariant *variant, set_signature (variant, "u"); } +/** + * egg_dbus_variant_set_int64: + * @variant: A #EggDBusVariant. + * @value: A #gint64. + * + * Makes @variant hold a #gint64 equal to @value. + **/ void egg_dbus_variant_set_int64 (EggDBusVariant *variant, gint64 value) @@ -601,6 +897,13 @@ egg_dbus_variant_set_int64 (EggDBusVariant *variant, set_signature (variant, "x"); } +/** + * egg_dbus_variant_set_uint64: + * @variant: A #EggDBusVariant. + * @value: A #guint64. + * + * Makes @variant hold a #guint64 equal to @value. + **/ void egg_dbus_variant_set_uint64 (EggDBusVariant *variant, guint64 value) @@ -615,6 +918,13 @@ egg_dbus_variant_set_uint64 (EggDBusVariant *variant, set_signature (variant, "t"); } +/** + * egg_dbus_variant_set_boolean: + * @variant: A #EggDBusVariant. + * @value: A #gboolean. + * + * Makes @variant hold a #gboolean equal to @value. + **/ void egg_dbus_variant_set_boolean (EggDBusVariant *variant, gboolean value) @@ -629,6 +939,13 @@ egg_dbus_variant_set_boolean (EggDBusVariant *variant, set_signature (variant, "b"); } +/** + * egg_dbus_variant_set_double: + * @variant: A #EggDBusVariant. + * @value: A #gdouble. + * + * Makes @variant hold a #gdouble equal to @value. + **/ void egg_dbus_variant_set_double (EggDBusVariant *variant, gdouble value) @@ -643,6 +960,14 @@ egg_dbus_variant_set_double (EggDBusVariant *variant, set_signature (variant, "d"); } +/** + * egg_dbus_variant_set_seq: + * @variant: A #EggDBusVariant. + * @seq: A #EggDBusArraySeq. + * @element_signature: D-Bus signature of the elements stored in @seq. + * + * Makes @variant hold a reference to @seq. + **/ void egg_dbus_variant_set_seq (EggDBusVariant *variant, EggDBusArraySeq *seq, @@ -658,6 +983,15 @@ egg_dbus_variant_set_seq (EggDBusVariant *variant, set_signature_for_array (variant, element_signature); } +/** + * egg_dbus_variant_set_map: + * @variant: A #EggDBusVariant. + * @map: A #EggDBusHashMap. + * @key_signature: D-Bus signature of the keys stored in @map. + * @value_signature: D-Bus signature of the values stored in @map. + * + * Makes @variant hold a reference to @map. + **/ void egg_dbus_variant_set_map (EggDBusVariant *variant, EggDBusHashMap *map, @@ -676,6 +1010,13 @@ egg_dbus_variant_set_map (EggDBusVariant *variant, value_signature); } +/** + * egg_dbus_variant_set_structure: + * @variant: A #EggDBusVariant. + * @structure: A #EggDBusStructure. + * + * Makes @variant hold a reference to @structure. + **/ void egg_dbus_variant_set_structure (EggDBusVariant *variant, EggDBusStructure *structure) @@ -692,6 +1033,14 @@ egg_dbus_variant_set_structure (EggDBusVariant *variant, /* ---------------------------------------------------------------------------------------------------- */ +/** + * egg_dbus_variant_get_string: + * @variant: A #EggDBusVariant. + * + * Gets the string stored in @variant. + * + * Returns: A string. Free with g_free(). + **/ const gchar * egg_dbus_variant_get_string (EggDBusVariant *variant) { @@ -701,6 +1050,14 @@ egg_dbus_variant_get_string (EggDBusVariant *variant) return g_value_get_string (&priv->value); } +/** + * egg_dbus_variant_get_object_path: + * @variant: A #EggDBusVariant. + * + * Gets the object path stored in @variant. + * + * Returns: An object path. Free with g_free(). + **/ const gchar * egg_dbus_variant_get_object_path (EggDBusVariant *variant) { @@ -710,6 +1067,14 @@ egg_dbus_variant_get_object_path (EggDBusVariant *variant) return g_value_get_boxed (&priv->value); } +/** + * egg_dbus_variant_get_string_array: + * @variant: A #EggDBusVariant. + * + * Gets the string array stored in @variant. + * + * Returns: A %NULL-terminated string array. Free with g_strfreev(). + **/ gchar ** egg_dbus_variant_get_string_array (EggDBusVariant *variant) { @@ -719,6 +1084,14 @@ egg_dbus_variant_get_string_array (EggDBusVariant *variant) return g_value_get_boxed (&priv->value); } +/** + * egg_dbus_variant_get_object_path_array: + * @variant: A #EggDBusVariant. + * + * Gets the object path array stored in @variant. + * + * Returns: A %NULL-terminated object path array. Free with g_strfreev(). + **/ gchar ** egg_dbus_variant_get_object_path_array (EggDBusVariant *variant) { @@ -728,6 +1101,14 @@ egg_dbus_variant_get_object_path_array (EggDBusVariant *variant) return g_value_get_boxed (&priv->value); } +/** + * egg_dbus_variant_get_signature_array: + * @variant: A #EggDBusVariant. + * + * Gets the signature array stored in @variant. + * + * Returns: A %NULL-terminated signature array. Free with g_strfreev(). + **/ gchar ** egg_dbus_variant_get_signature_array (EggDBusVariant *variant) { @@ -737,6 +1118,14 @@ egg_dbus_variant_get_signature_array (EggDBusVariant *variant) return g_value_get_boxed (&priv->value); } +/** + * egg_dbus_variant_get_byte: + * @variant: A #EggDBusVariant. + * + * Gets the #guchar stored in @variant. + * + * Returns: A #guchar. + **/ guchar egg_dbus_variant_get_byte (EggDBusVariant *variant) { @@ -746,6 +1135,14 @@ egg_dbus_variant_get_byte (EggDBusVariant *variant) return g_value_get_uchar (&priv->value); } +/** + * egg_dbus_variant_get_int16: + * @variant: A #EggDBusVariant. + * + * Gets the #gint16 stored in @variant. + * + * Returns: A #gint16. + **/ gint16 egg_dbus_variant_get_int16 (EggDBusVariant *variant) { @@ -755,6 +1152,14 @@ egg_dbus_variant_get_int16 (EggDBusVariant *variant) return egg_dbus_value_get_int16 (&priv->value); } +/** + * egg_dbus_variant_get_uint16: + * @variant: A #EggDBusVariant. + * + * Gets the #guint16 stored in @variant. + * + * Returns: A #guint16. + **/ guint16 egg_dbus_variant_get_uint16 (EggDBusVariant *variant) { @@ -764,6 +1169,14 @@ egg_dbus_variant_get_uint16 (EggDBusVariant *variant) return egg_dbus_value_get_uint16 (&priv->value); } +/** + * egg_dbus_variant_get_int: + * @variant: A #EggDBusVariant. + * + * Gets the #gint stored in @variant. + * + * Returns: A #gint. + **/ gint egg_dbus_variant_get_int (EggDBusVariant *variant) { @@ -773,6 +1186,14 @@ egg_dbus_variant_get_int (EggDBusVariant *variant) return g_value_get_int (&priv->value); } +/** + * egg_dbus_variant_get_uint: + * @variant: A #EggDBusVariant. + * + * Gets the #guint stored in @variant. + * + * Returns: A #guint. + **/ guint egg_dbus_variant_get_uint (EggDBusVariant *variant) { @@ -782,6 +1203,14 @@ egg_dbus_variant_get_uint (EggDBusVariant *variant) return g_value_get_uint (&priv->value); } +/** + * egg_dbus_variant_get_int64: + * @variant: A #EggDBusVariant. + * + * Gets the #gint64 stored in @variant. + * + * Returns: A #gint64. + **/ gint64 egg_dbus_variant_get_int64 (EggDBusVariant *variant) { @@ -791,6 +1220,14 @@ egg_dbus_variant_get_int64 (EggDBusVariant *variant) return g_value_get_int64 (&priv->value); } +/** + * egg_dbus_variant_get_uint64: + * @variant: A #EggDBusVariant. + * + * Gets the #guint64 stored in @variant. + * + * Returns: A #guint64. + **/ guint64 egg_dbus_variant_get_uint64 (EggDBusVariant *variant) { @@ -800,6 +1237,14 @@ egg_dbus_variant_get_uint64 (EggDBusVariant *variant) return g_value_get_uint64 (&priv->value); } +/** + * egg_dbus_variant_get_boolean: + * @variant: A #EggDBusVariant. + * + * Gets the #gboolean stored in @variant. + * + * Returns: A #gboolean. + **/ gboolean egg_dbus_variant_get_boolean (EggDBusVariant *variant) { @@ -809,6 +1254,14 @@ egg_dbus_variant_get_boolean (EggDBusVariant *variant) return g_value_get_boolean (&priv->value); } +/** + * egg_dbus_variant_get_double: + * @variant: A #EggDBusVariant. + * + * Gets the #gdouble stored in @variant. + * + * Returns: A #gdouble. + **/ gdouble egg_dbus_variant_get_double (EggDBusVariant *variant) { @@ -818,6 +1271,14 @@ egg_dbus_variant_get_double (EggDBusVariant *variant) return g_value_get_double (&priv->value); } +/** + * egg_dbus_variant_get_seq: + * @variant: A #EggDBusVariant. + * + * Gets the sequence stored in @variant. + * + * Returns: A #EggDBusArraySeq. Free with g_object_unref(). + **/ EggDBusArraySeq * egg_dbus_variant_get_seq (EggDBusVariant *variant) { @@ -827,6 +1288,14 @@ egg_dbus_variant_get_seq (EggDBusVariant *variant) return g_value_get_object (&priv->value); } +/** + * egg_dbus_variant_get_map: + * @variant: A #EggDBusVariant. + * + * Gets the map stored in @variant. + * + * Returns: A #EggDBusHashMap. Free with g_object_unref(). + **/ EggDBusHashMap * egg_dbus_variant_get_map (EggDBusVariant *variant) { @@ -836,6 +1305,14 @@ egg_dbus_variant_get_map (EggDBusVariant *variant) return g_value_get_object (&priv->value); } +/** + * egg_dbus_variant_get_structure: + * @variant: A #EggDBusVariant. + * + * Gets the structure stored in @variant. + * + * Returns: A #EggDBusStructure. Free with g_object_unref(). + **/ EggDBusStructure * egg_dbus_variant_get_structure (EggDBusVariant *variant) { @@ -847,6 +1324,14 @@ egg_dbus_variant_get_structure (EggDBusVariant *variant) /* ---------------------------------------------------------------------------------------------------- */ +/** + * egg_dbus_variant_is_unset: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a value. + * + * Returns: %TRUE if @variant doesn't hold a value. + **/ gboolean egg_dbus_variant_is_unset (EggDBusVariant *variant) { @@ -856,6 +1341,14 @@ egg_dbus_variant_is_unset (EggDBusVariant *variant) return priv->signature != NULL; } +/** + * egg_dbus_variant_is_string: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a string. + * + * Returns: %TRUE only if @variant holds a string. + **/ gboolean egg_dbus_variant_is_string (EggDBusVariant *variant) { @@ -867,6 +1360,14 @@ egg_dbus_variant_is_string (EggDBusVariant *variant) priv->signature[0] == 's'; } +/** + * egg_dbus_variant_is_object_path: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds an object path. + * + * Returns: %TRUE only if @variant holds an object path. + **/ gboolean egg_dbus_variant_is_object_path (EggDBusVariant *variant) { @@ -878,6 +1379,14 @@ egg_dbus_variant_is_object_path (EggDBusVariant *variant) priv->signature[0] == 'o'; } +/** + * egg_dbus_variant_is_string_array: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a string array. + * + * Returns: %TRUE only if @variant holds a string array. + **/ gboolean egg_dbus_variant_is_string_array (EggDBusVariant *variant) { @@ -890,6 +1399,14 @@ egg_dbus_variant_is_string_array (EggDBusVariant *variant) priv->signature[1] == 's'; } +/** + * egg_dbus_variant_is_object_path_array: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds an object path array. + * + * Returns: %TRUE only if @variant holds an object path array. + **/ gboolean egg_dbus_variant_is_object_path_array (EggDBusVariant *variant) { @@ -902,6 +1419,14 @@ egg_dbus_variant_is_object_path_array (EggDBusVariant *variant) priv->signature[1] == 'o'; } +/** + * egg_dbus_variant_is_signature_array: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a signature array. + * + * Returns: %TRUE only if @variant holds a signature array. + **/ gboolean egg_dbus_variant_is_signature_array (EggDBusVariant *variant) { @@ -914,6 +1439,14 @@ egg_dbus_variant_is_signature_array (EggDBusVariant *variant) priv->signature[1] == 'g'; } +/** + * egg_dbus_variant_is_byte: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a #guchar. + * + * Returns: %TRUE only if @variant holds a #guchar. + **/ gboolean egg_dbus_variant_is_byte (EggDBusVariant *variant) { @@ -925,6 +1458,14 @@ egg_dbus_variant_is_byte (EggDBusVariant *variant) priv->signature[0] == 'y'; } +/** + * egg_dbus_variant_is_int16: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a #gint16. + * + * Returns: %TRUE only if @variant holds a #gint16. + **/ gboolean egg_dbus_variant_is_int16 (EggDBusVariant *variant) { @@ -936,6 +1477,14 @@ egg_dbus_variant_is_int16 (EggDBusVariant *variant) priv->signature[0] == 'n'; } +/** + * egg_dbus_variant_is_uint16: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a #guint16. + * + * Returns: %TRUE only if @variant holds a #guint16. + **/ gboolean egg_dbus_variant_is_uint16 (EggDBusVariant *variant) { @@ -947,6 +1496,14 @@ egg_dbus_variant_is_uint16 (EggDBusVariant *variant) priv->signature[0] == 'q'; } +/** + * egg_dbus_variant_is_int: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a #gint. + * + * Returns: %TRUE only if @variant holds a #gint. + **/ gboolean egg_dbus_variant_is_int (EggDBusVariant *variant) { @@ -958,6 +1515,14 @@ egg_dbus_variant_is_int (EggDBusVariant *variant) priv->signature[0] == 'i'; } +/** + * egg_dbus_variant_is_uint: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a #guint. + * + * Returns: %TRUE only if @variant holds a #guint. + **/ gboolean egg_dbus_variant_is_uint (EggDBusVariant *variant) { @@ -969,6 +1534,14 @@ egg_dbus_variant_is_uint (EggDBusVariant *variant) priv->signature[0] == 'u'; } +/** + * egg_dbus_variant_is_int64: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a #gint64. + * + * Returns: %TRUE only if @variant holds a #gint64. + **/ gboolean egg_dbus_variant_is_int64 (EggDBusVariant *variant) { @@ -980,6 +1553,14 @@ egg_dbus_variant_is_int64 (EggDBusVariant *variant) priv->signature[0] == 'x'; } +/** + * egg_dbus_variant_is_uint64: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a #guint64. + * + * Returns: %TRUE only if @variant holds a #guint64. + **/ gboolean egg_dbus_variant_is_uint64 (EggDBusVariant *variant) { @@ -991,6 +1572,14 @@ egg_dbus_variant_is_uint64 (EggDBusVariant *variant) priv->signature[0] == 't'; } +/** + * egg_dbus_variant_is_boolean: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a #gboolean. + * + * Returns: %TRUE only if @variant holds a #gboolean. + **/ gboolean egg_dbus_variant_is_boolean (EggDBusVariant *variant) { @@ -1002,6 +1591,14 @@ egg_dbus_variant_is_boolean (EggDBusVariant *variant) priv->signature[0] == 'b'; } +/** + * egg_dbus_variant_is_double: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a #gdouble. + * + * Returns: %TRUE only if @variant holds a #gdouble. + **/ gboolean egg_dbus_variant_is_double (EggDBusVariant *variant) { @@ -1013,6 +1610,14 @@ egg_dbus_variant_is_double (EggDBusVariant *variant) priv->signature[0] == 'd'; } +/** + * egg_dbus_variant_is_seq: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a sequence. + * + * Returns: %TRUE only if @variant holds a sequence. + **/ gboolean egg_dbus_variant_is_seq (EggDBusVariant *variant) { @@ -1035,6 +1640,14 @@ egg_dbus_variant_is_seq (EggDBusVariant *variant) priv->signature[1] == '('); } +/** + * egg_dbus_variant_is_map: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a map. + * + * Returns: %TRUE only if @variant holds a map. + **/ gboolean egg_dbus_variant_is_map (EggDBusVariant *variant) { @@ -1047,6 +1660,14 @@ egg_dbus_variant_is_map (EggDBusVariant *variant) priv->signature[1] == '{'; } +/** + * egg_dbus_variant_is_structure: + * @variant: A #EggDBusVariant. + * + * Checks if @variant holds a structure. + * + * Returns: %TRUE only if @variant holds a structure. + **/ gboolean egg_dbus_variant_is_structure (EggDBusVariant *variant) { diff --git a/src/eggdbus/org.freedesktop.DBus.Introspectable.xml b/src/eggdbus/org.freedesktop.DBus.Introspectable.xml index bab4cbd..feb7863 100644 --- a/src/eggdbus/org.freedesktop.DBus.Introspectable.xml +++ b/src/eggdbus/org.freedesktop.DBus.Introspectable.xml @@ -4,7 +4,7 @@ - + diff --git a/src/eggdbus/org.freedesktop.DBus.Peer.xml b/src/eggdbus/org.freedesktop.DBus.Peer.xml index a483730..dd552ef 100644 --- a/src/eggdbus/org.freedesktop.DBus.Peer.xml +++ b/src/eggdbus/org.freedesktop.DBus.Peer.xml @@ -4,7 +4,7 @@ - + diff --git a/src/eggdbus/org.freedesktop.DBus.Properties.xml b/src/eggdbus/org.freedesktop.DBus.Properties.xml index d7341b3..a1a2d64 100644 --- a/src/eggdbus/org.freedesktop.DBus.Properties.xml +++ b/src/eggdbus/org.freedesktop.DBus.Properties.xml @@ -4,7 +4,7 @@ - + diff --git a/src/eggdbus/org.freedesktop.DBus.xml b/src/eggdbus/org.freedesktop.DBus.xml index fd265ba..7485532 100644 --- a/src/eggdbus/org.freedesktop.DBus.xml +++ b/src/eggdbus/org.freedesktop.DBus.xml @@ -86,7 +86,7 @@ - + -- cgit v1.2.3