hildon-status-bar-lib.h File Reference

DESCRIPTION: Status bar library functions. More...

#include <glib.h>
#include <gtk/gtkdialog.h>

Go to the source code of this file.

Classes
struct	system_dialog_st
Defines
#define	HILDON_STATUS_BAR_MAX_NOTE_TYPE   3
#define	HILDON_STATUS_BAR_MAX_NO_OF_DIALOGS   30
Typedefs
typedef system_dialog_st	SystemDialog
typedef void(*	dialog_closed_cb )(gint type, gpointer data)
Functions
void	hildon_status_bar_lib_prepare_dialog (gint type, const gchar *icon, const gchar *msg, gint int_type, dialog_closed_cb cb, gpointer data)
void	hildon_status_bar_lib_queue_dialog (const gchar *icon, const gchar *msg, gint int_type, dialog_closed_cb cb, gpointer data)
gint	hildon_status_bar_lib_open_closeable_dialog (gint type, const gchar *msg, const gchar *btext, gboolean save_result)
void	hildon_status_bar_lib_close_closeable_dialog (gint id)
gint	hildon_status_bar_lib_get_dialog_response (gint id)

---

Detailed Description

DESCRIPTION: Status bar library functions.

---

Function Documentation

void hildon_status_bar_lib_close_closeable_dialog (  gint  id  )

Parameters: id  Dialog to close. Returns: This function closes a system modal dialog opened with hildon_status_bar_lib_open_closeable_dialog, if it was not closed by the user already. NOTICE: This API is not stable.

gint hildon_status_bar_lib_get_dialog_response (  gint  id  )

Parameters: id  Dialog id. Returns: Response value (<0), or 2 if the dialog is not closed, or 1 if the id is invalid (e.g. it was not saved for the dialog, or the value has been asked already). This function returns the response value of the dialog (value telling what button was pressed). The value can be asked only once. NOTICE: This API is not stable.

gint hildon_status_bar_lib_open_closeable_dialog (  gint  type, const gchar *  msg, const gchar *  btext, gboolean  save_result )

Parameters: *type  Dialog type, must be valid osso_system_note_type_t (defined in libosso.h). *msg  Message string to show. *btext  Text shown on the button, or NULL for default text. save_result  Whether the response value should be saved. If this is TRUE, the caller must call hildon_status_bar_lib_get_dialog_response to get the value, even if the value is not interesting anymore. Returns: Id of the dialog or -1 on error. This id can be used to close the dialog with hildon_status_bar_lib_close_closeable_dialog. This function shows a system modal dialog. If there is already a dialog shown, then the dialog is queued and shown later. The dialog can be closed by calling hildon_status_bar_lib_close_closeable_dialog (if it was not already closed by the user). NOTICE: This API is not stable.

void hildon_status_bar_lib_prepare_dialog (  gint  type, const gchar *  icon, const gchar *  msg, gint  int_type, dialog_closed_cb  cb, gpointer  data )

Parameters: *type  Dialog type, must be valid osso_system_note_type_t (defined in libosso.h). *icon  Stock icon to show on the dialog. This parameter is ignored, the type determines the icon to show. *msg  Message string to show. int_type  First parameter to the callback, ignored by this function. cb  Callback to call after dialog closes, or when there was an error. data  Second parameter to the callback, ignored by this function. This function shows a system modal dialog. If there is already a dialog shown, then the dialog is queued and shown later.

void hildon_status_bar_lib_queue_dialog (  const gchar *  icon, const gchar *  msg, gint  int_type, dialog_closed_cb  cb, gpointer  data )

Parameters: *icon  Stock icon to show on the dialog. *msg  Message string to show. int_type  First parameter to the callback, ignored by this function. *cb  Callback to be called after dialog is closed. It is also called if there is an error. data  Second parameter to the callback, ignored by this function. This function shows a system modal dialog. If there is already a dialog shown, then the dialog is queued and shown later. This is almost identical to hildon_status_bar_lib_prepare_dialog but meant for plugins.

---