diff options
author | Ted Gould <ted@canonical.com> | 2009-04-30 14:06:45 -0500 |
---|---|---|
committer | Ted Gould <ted@canonical.com> | 2009-04-30 14:06:45 -0500 |
commit | 43f575ee79e3f0bd6f69a6ce835d5298053073fb (patch) | |
tree | e1aab23a1294fda4b9af63c064cf3ccfaff5fafb | |
parent | 1c91e431be9a8e9bf706485735efccf0a0c54283 (diff) | |
download | libayatana-indicator-43f575ee79e3f0bd6f69a6ce835d5298053073fb.tar.gz libayatana-indicator-43f575ee79e3f0bd6f69a6ce835d5298053073fb.tar.bz2 libayatana-indicator-43f575ee79e3f0bd6f69a6ce835d5298053073fb.zip |
Getting most of the indicator documentation in the pool.
-rw-r--r-- | libindicate/indicator.c | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/libindicate/indicator.c b/libindicate/indicator.c index e40975a..c867a9a 100644 --- a/libindicate/indicator.c +++ b/libindicate/indicator.c @@ -171,6 +171,14 @@ indicate_indicator_finalize (GObject * obj) } /** + indicate_indicator_get_type: + + Gets a unique #GType for the #IndicateIndicator objects. + + Return value: A unique #GType value. +*/ + +/** indicate_indicator_new: Builds a new indicator object using #g_object_new. @@ -397,6 +405,16 @@ indicate_indicator_set_property_time (IndicateIndicator * indicator, const gchar return; } +/** + indicate_indicator_get_property: + @indicator: a #IndicateIndicator to act on + @key: name of the property + + Returns the value that is set for a property or %NULL if that + property is not set. + + Return value: A constant string or NULL. +*/ const gchar * indicate_indicator_get_property (IndicateIndicator * indicator, const gchar * key) { @@ -408,6 +426,17 @@ indicate_indicator_get_property (IndicateIndicator * indicator, const gchar * ke return class->get_property(indicator, key); } +/** + indicate_indicator_list_properties: + @indicator: a #IndicateIndicator to act on + + This function gets a list of all the properties that exist + on a @indicator. The array may have zero entries but almost + always at least has 'type' in it. + + Return value: An array of strings that is the keys of all + the properties on this indicator. +*/ GPtrArray * indicate_indicator_list_properties (IndicateIndicator * indicator) { |