indicate_indicator_get_id ()

guint
indicate_indicator_get_id (IndicateIndicator *indicator);

Gets the ID value of the indicator .

indicate_indicator_get_property ()

const gchar *
indicate_indicator_get_property (IndicateIndicator *indicator,
                                 const gchar *key);

Returns the value that is set for a property or NULL if that property is not set.

indicate_indicator_hide ()

void
indicate_indicator_hide (IndicateIndicator *indicator);

Hides the indicator from the bus. Does not effect the indicator's IndicateServer in any way.

indicate_indicator_is_visible ()

gboolean
indicate_indicator_is_visible (IndicateIndicator *indicator);

Checkes the visibility status of indicator .

indicate_indicator_list_properties ()

GPtrArray *
indicate_indicator_list_properties (IndicateIndicator *indicator);

This function gets a list of all the properties that exist on a indicator . The array may have zero entries.

indicate_indicator_new ()

IndicateIndicator *
indicate_indicator_new (void);

Builds a new indicator object using g_object_new().

indicate_indicator_set_property ()

void
indicate_indicator_set_property (IndicateIndicator *indicator,
                                 const gchar *key,
                                 const gchar *data);

Sets a simple string property on indicator . If the property had previously been set it will replace it with the new value, otherwise it will create the property. This will include an emition of “modified” if the property value was changed.

indicate_indicator_set_property_time ()

void
indicate_indicator_set_property_time (IndicateIndicator *indicator,
                                      const gchar *key,
                                      GTimeVal *time);

This is a helper function that wraps around indicate_indicator_set_property but takes an GTimeVal parameter. It then takes the data parameter converts it to an ISO 8601 time string and uses that data to call indicate_indicator_set_property.

indicate_indicator_show ()

void
indicate_indicator_show (IndicateIndicator *indicator);

Shows this indicator on the bus. If the IndicateServer that it's connected to is not shown itself this function will show the server as well using indicate_server_show.

indicate_indicator_user_display ()

void
indicate_indicator_user_display (IndicateIndicator *indicator,
                                 guint timestamp);

Emits the “user-display” signal simliar to a user clicking on indicator over the bus. Signal will not be sent if the indicator is not visible.

struct IndicateIndicator

struct IndicateIndicator;

The indicator object represents a single item that is shared over the indicator bus. This could be something like one IM, one e-mail or a single system update. It should be accessed only through its accessors.

struct IndicateIndicatorClass

struct IndicateIndicatorClass {
	/* Parents */
	GObjectClass parent_class;

	/* Signals */
	void (*hide) (IndicateIndicator * indicator, gpointer data);
	void (*show) (IndicateIndicator * indicator, gpointer data);
	void (*user_display) (IndicateIndicator * indicator, guint timestamp, gpointer data);
	void (*modified) (IndicateIndicator * indicator, gchar * property, gpointer data);
	void (*displayed) (IndicateIndicator * indicator, gboolean displayed);

	/* Subclassable functions */
	void (*set_property) (IndicateIndicator * indicator, const gchar * key, GVariant * data);
	GVariant * (*get_property) (IndicateIndicator * indicator, const gchar * key);
	indicate_indicator_list_properties_slot_t list_properties;

	/* Reserver for future use */
	void (*indicate_indicator_reserved1)(void);
	void (*indicate_indicator_reserved2)(void);
	void (*indicate_indicator_reserved3)(void);
	void (*indicate_indicator_reserved4)(void);
};

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.

The “displayed” signal

void
user_function (IndicateIndicator *arg0,
               gboolean           arg1,
               gpointer           user_data)

This is the signal that the indicator has been displayed, or hidden by a listener. In most cases, the signal will be that it has been displayed as most folks don't go hiding it later.

Flags: Run Last

The “hide” signal

void
user_function (IndicateIndicator *arg0,
               gpointer           user_data)

Emitted every time this indicator is hidden. This is mostly used by IndicateServer.

Typically this results in an emition of “indicator-removed”.

Flags: Run Last

The “modified” signal

void
user_function (IndicateIndicator *arg0,
               gchar             *arg1,
               gpointer           user_data)

Emitted every time an indicator property is changed. This is mostly used by IndicateServer.

Typically this results in an emition of “indicator-modified”.

Flags: Run Last

The “show” signal

void
user_function (IndicateIndicator *arg0,
               gpointer           user_data)

Emitted every time this indicator is shown. This is mostly used by IndicateServer.

Typically this results in an emition of “indicator-added”.

Flags: Run Last

The “user-display” signal

void
user_function (IndicateIndicator *indicateindicator,
               guint              arg1,
               gpointer           user_data)

Flags: Run Last