Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages | Search for 
pidgin

minidialog.h File Reference

API for the PidginMiniDialog Gtk widget. More...

#include <glib-object.h>
#include <gtk/gtkvbox.h>
#include <gtk/gtklabel.h>

Include dependency graph for minidialog.h:

Go to the source code of this file.

Data Structures

struct  PidginMiniDialog
 A widget resembling a diminutive dialog box, designed to be embedded in the PidginBuddyList. More...
struct  PidginMiniDialogClass
 The class of PidginMiniDialog objects. More...

Defines

#define PIDGIN_TYPE_MINI_DIALOG   pidgin_mini_dialog_get_type()
#define PIDGIN_MINI_DIALOG(obj)
#define PIDGIN_MINI_DIALOG_CLASS(klass)
#define PIDGIN_IS_MINI_DIALOG(obj)
#define PIDGIN_IS_MINI_DIALOG_CLASS(klass)
#define PIDGIN_MINI_DIALOG_GET_CLASS(obj)

Typedefs

typedef void(* PidginMiniDialogCallback )(PidginMiniDialog *mini_dialog, GtkButton *button, gpointer user_data)
 The type of a callback triggered by a button in a mini-dialog being pressed.

Functions

GType pidgin_mini_dialog_get_type (void)
 Get the GType of PidginMiniDialog.
PidginMiniDialog * pidgin_mini_dialog_new (const gchar *title, const gchar *description, const gchar *icon_name)
 Creates a new PidginMiniDialog.
void pidgin_mini_dialog_set_title (PidginMiniDialog *mini_dialog, const char *title)
 Shortcut for setting a mini-dialog's title via GObject properties.
void pidgin_mini_dialog_set_description (PidginMiniDialog *mini_dialog, const char *description)
 Shortcut for setting a mini-dialog's description via GObject properties.
void pidgin_mini_dialog_set_icon_name (PidginMiniDialog *mini_dialog, const char *icon_name)
 Shortcut for setting a mini-dialog's icon via GObject properties.
void pidgin_mini_dialog_add_button (PidginMiniDialog *mini_dialog, const char *text, PidginMiniDialogCallback clicked_cb, gpointer user_data)
 Adds a new button to a mini-dialog, and attaches the supplied callback to its clicked signal.
guint pidgin_mini_dialog_get_num_children (PidginMiniDialog *mini_dialog)
 Gets the number of widgets packed into PidginMiniDialog.contents.

Detailed Description

API for the PidginMiniDialog Gtk widget.

Definition in file minidialog.h.

Define Documentation

#define PIDGIN_IS_MINI_DIALOG (  obj   ) 
 

Value:

(G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
  PIDGIN_TYPE_MINI_DIALOG))

Definition at line 46 of file minidialog.h.

#define PIDGIN_IS_MINI_DIALOG_CLASS (  klass   ) 
 

Value:

(G_TYPE_CHECK_CLASS_TYPE ((klass), \
  PIDGIN_TYPE_MINI_DIALOG))

Definition at line 50 of file minidialog.h.

#define PIDGIN_MINI_DIALOG (  obj   ) 
 

Value:

(G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  PIDGIN_TYPE_MINI_DIALOG, PidginMiniDialog))

Definition at line 38 of file minidialog.h.

#define PIDGIN_MINI_DIALOG_CLASS (  klass   ) 
 

Value:

(G_TYPE_CHECK_CLASS_CAST ((klass), \
  PIDGIN_TYPE_MINI_DIALOG, PidginMiniDialogClass))

Definition at line 42 of file minidialog.h.

#define PIDGIN_MINI_DIALOG_GET_CLASS (  obj   ) 
 

Value:

(G_TYPE_INSTANCE_GET_CLASS ((obj), \
  PIDGIN_TYPE_MINI_DIALOG, PidginMiniDialogClass))

Definition at line 54 of file minidialog.h.

Typedef Documentation

typedef void(* PidginMiniDialogCallback)(PidginMiniDialog *mini_dialog, GtkButton *button, gpointer user_data)
 

The type of a callback triggered by a button in a mini-dialog being pressed.

Parameters:
mini_dialog a dialog, one of whose buttons has been pressed.
button the button which was pressed.
user_data arbitrary data, supplied to pidgin_mini_dialog_add_button() when the button was created.

Definition at line 106 of file minidialog.h.

Function Documentation

void pidgin_mini_dialog_add_button (  PidginMiniDialog *  mini_dialog,
const char *  text,
PidginMiniDialogCallback  clicked_cb,
gpointer  user_data
) 
 

Adds a new button to a mini-dialog, and attaches the supplied callback to its clicked signal.

After a button is clicked, the dialog is destroyed.

Parameters:
mini_dialog a mini-dialog
text the text to display on the new button
clicked_cb the function to call when the button is clicked
user_data arbitrary data to pass to clicked_cb when it is called.

guint pidgin_mini_dialog_get_num_children (  PidginMiniDialog *  mini_dialog  ) 
 

Gets the number of widgets packed into PidginMiniDialog.contents.

Parameters:
mini_dialog a mini-dialog
Returns:
the number of widgets in mini_dialog->contents.

PidginMiniDialog* pidgin_mini_dialog_new (  const gchar *  title,
const gchar *  description,
const gchar *  icon_name
) 
 

Creates a new PidginMiniDialog.

This is a shortcut for creating the dialog with g_object_new() then setting each property yourself.

Returns:
a new PidginMiniDialog.

void pidgin_mini_dialog_set_description (  PidginMiniDialog *  mini_dialog,
const char *  description
) 
 

Shortcut for setting a mini-dialog's description via GObject properties.

Parameters:
mini_dialog a mini-dialog
description the new description for mini_dialog, or NULL to hide the description widget.

void pidgin_mini_dialog_set_icon_name (  PidginMiniDialog *  mini_dialog,
const char *  icon_name
) 
 

Shortcut for setting a mini-dialog's icon via GObject properties.

Parameters:
mini_dialog a mini-dialog
icon_name the Gtk stock ID of an icon, or NULL for no icon.

void pidgin_mini_dialog_set_title (  PidginMiniDialog *  mini_dialog,
const char *  title
) 
 

Shortcut for setting a mini-dialog's title via GObject properties.

Parameters:
mini_dialog a mini-dialog
title the new title for mini_dialog