diff options
Diffstat (limited to 'libindicate')
| -rw-r--r-- | libindicate/indicator.h | 26 |
1 files changed, 10 insertions, 16 deletions
diff --git a/libindicate/indicator.h b/libindicate/indicator.h index 61cc1d2..77ffb7d 100644 --- a/libindicate/indicator.h +++ b/libindicate/indicator.h @@ -70,34 +70,28 @@ struct _IndicateIndicator { /** IndicateIndicatorClass: - - All of the functions that are used to modify or change data that is - in the indicator. Typically gets subclassed by other types of - indicators, for example #IndicateIndicatorMessages. - + @parent_class: Parent class #GObjectClass. @hide: Slot for #IndicateIndicator::hide. - @show: Slot for #IndicateIndicator::show. - @user_display: Slot for #IndicateIndicator::user-display. - @modified: Slot for #IndicateIndicator::modified. - @get_type: Returns a constant string for the type of this indicator. Typically gets overridden by subclasses and defines the type of - the indicator. - - @set_property: Called when #indicate_indicator_set_property is called + the indicator. Is called by indicate_indicator_get_indicator_type(). + @set_property: Called when indicate_indicator_set_property() is called and should set the value. While typically it is overridden by subclasses they usually handle special properties themselves and then call the superclass for storage. - - @get_property: Called when #indicate_indicator_get_property is called + @get_property: Called when indicate_indicator_get_property() is called and should return the value requested. Many times this is left alone. - - @list_properties: Called when #indicate_indicator_list_properties is called + @list_properties: Called when indicate_indicator_list_properties() is called and returns a list of the properties available. Again this can be overridden by subclasses to handle special properties. + + All of the functions that are used to modify or change data that is + in the indicator. Typically gets subclassed by other types of + indicators, for example #IndicateIndicatorMessages. + */ struct _IndicateIndicatorClass { GObjectClass parent_class; |