libindicate-dev 12.10.1-0ubuntu3 / usr / include / libindicate-0.7 / libindicate / indicator.h

/*
A library to allow applictions to provide simple indications of
information to be displayed to users of the application through the
interface shell.

Copyright 2009 Canonical Ltd.

Authors:
    Ted Gould <ted@canonical.com>

This program is free software: you can redistribute it and/or modify it 
under the terms of either or both of the following licenses:

1) the GNU Lesser General Public License version 3, as published by the 
Free Software Foundation; and/or
2) the GNU Lesser General Public License version 2.1, as published by 
the Free Software Foundation.

This program is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranties of 
MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR 
PURPOSE.  See the applicable version of the GNU Lesser General Public 
License for more details.

You should have received a copy of both the GNU Lesser General Public 
License version 3 and version 2.1 along with this program.  If not, see 
<http://www.gnu.org/licenses/>
*/

#ifndef INDICATE_INDICATOR_H_INCLUDED__
#define INDICATE_INDICATOR_H_INCLUDED__ 1

#include <glib.h>
#include <glib-object.h>

G_BEGIN_DECLS

/* Boilerplate */
#define INDICATE_TYPE_INDICATOR (indicate_indicator_get_type ())
#define INDICATE_INDICATOR(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), INDICATE_TYPE_INDICATOR, IndicateIndicator))
#define INDICATE_IS_INDICATOR(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), INDICATE_TYPE_INDICATOR))
#define INDICATE_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), INDICATE_TYPE_INDICATOR, IndicateIndicatorClass))
#define INDICATE_IS_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), INDICATE_TYPE_INDICATOR))
#define INDICATE_INDICATOR_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), INDICATE_TYPE_INDICATOR, IndicateIndicatorClass))

/* Some values that are commonly used.  Most likely only
   internal, but if you need them, here they are! */
#define INDICATE_INDICATOR_VALUE_TRUE       "true"
#define INDICATE_INDICATOR_VALUE_FALSE      "false"

/* This is a signal that signals to the indicator that the user
 * has done an action where they'd like this indicator to be
 * displayed. */
#define INDICATE_INDICATOR_SIGNAL_HIDE      "hide"
#define INDICATE_INDICATOR_SIGNAL_SHOW      "show"
#define INDICATE_INDICATOR_SIGNAL_DISPLAY   "user-display"
#define INDICATE_INDICATOR_SIGNAL_MODIFIED  "modified"
#define INDICATE_INDICATOR_SIGNAL_DISPLAYED "displayed"

typedef struct _IndicateIndicator IndicateIndicator;
typedef struct _IndicateIndicatorClass IndicateIndicatorClass;

/**
 * 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 _IndicateIndicator {
	GObject parent;
};

#include "server.h"

/**
 * indicate_indicator_list_properties_slot_t:
 * @indicator: (in): Indicator to get the properties from
 *
 * Prototype for a function that will list all the properies in
 * an indicator.
 *
 * Return value: (transfer full) (array) (element-type utf8):
 *   The names of the properties that are in this indicator.
 */
typedef GPtrArray * (*indicate_indicator_list_properties_slot_t) (IndicateIndicator * indicator);

/**
 * IndicateIndicatorClass:
 * @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.
 * @displayed: Slot for #IndicateIndicator::displayed.
 * @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
 *   and should return the value requested.  Many times this is left alone.
 * @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.
 * @indicate_indicator_reserved1: Reserved for future use
 * @indicate_indicator_reserved2: Reserved for future use
 * @indicate_indicator_reserved3: Reserved for future use
 * @indicate_indicator_reserved4: Reserved for future use
 *
 * 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 {
	/* 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);
};

GType indicate_indicator_get_type(void) G_GNUC_CONST;

/* New Indicator Functions */
IndicateIndicator * indicate_indicator_new (void);
IndicateIndicator * indicate_indicator_new_with_server (IndicateServer * server);

/* Show and hide this indicator */
void indicate_indicator_show (IndicateIndicator * indicator);
void indicate_indicator_hide (IndicateIndicator * indicator);

gboolean indicate_indicator_is_visible (IndicateIndicator * indicator);

/* Define this indicator server */
void indicate_indicator_set_server (IndicateIndicator * indicator, IndicateServer * server);

/* Every entry has an ID, here's how to get it */
guint indicate_indicator_get_id (IndicateIndicator * indicator);
IndicateServer * indicate_indicator_get_server (IndicateIndicator * indicator);

void indicate_indicator_user_display (IndicateIndicator * indicator, guint timestamp);

/* Properties handling */
void indicate_indicator_set_property (IndicateIndicator * indicator, const gchar * key, const gchar * data);
void indicate_indicator_set_property_time (IndicateIndicator * indicator, const gchar * key, GTimeVal * time);
void indicate_indicator_set_property_int (IndicateIndicator * indicator, const gchar * key, gint value);
void indicate_indicator_set_property_bool (IndicateIndicator * indicator, const gchar * key, gboolean value);
void indicate_indicator_set_property_variant (IndicateIndicator * indicator, const gchar * key, GVariant * value);

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

/**
 * indicate_indicator_list_properties:
 * @indicator: (in): 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.
 *
 * Return value: (transfer full) (array) (element-type utf8): An array of
 *   strings that is the keys of all the properties on this indicator.
 */
GPtrArray * indicate_indicator_list_properties (IndicateIndicator * indicator);

/* Controling whether it's displayed */
void indicate_indicator_set_displayed (IndicateIndicator * indicator, gboolean displayed);
gboolean indicate_indicator_get_displayed (IndicateIndicator * indicator);

/**
 * SECTION:indicator
 * @short_description: A representation of state for applications
 * @stability: Unstable
 * @include: libindicate/indicator.h
 * 
 * An indicator is designed to represent a single instance of something
 * in your application.  So this might be an IM or an e-mail mail box
 * or any other thing that is a small unit of information to pass on
 * to the user.
 * 
 * Indicators make no promises about how they are preceived by the
 * user, it's up to the listener to represent them in an intutive and
 * visually appealling way.  But, what we can do is provide information
 * on the indicator to provide enough information for the listener
 * to do that.
 * 
 * Mostly this is done through properties.
 * 
 * It may be that some users don't want to create objects for every
 * indicator as it could be a lot of overhead if there are large numbers
 * and there is already a data structure representing them all.  In that
 * case it is recommended that you ignore the #IndicateIndicator object
 * tree in general and move to subclassing #IndicateServer directly.
*/

G_END_DECLS

#endif /* INDICATE_INDICATOR_H_INCLUDED__ */