comparison pidgin/minidialog.h @ 30909:25e200cb3532

propagate from branch 'im.pidgin.pidgin' (head dca20e09164518b0f7a773edd7e9649f41d8873d) to branch 'im.pidgin.cpw.malu.xmpp.google_refactor' (head 7823c556f2d1bbca43f5ef9f0fea30cabc5d313f)
author Marcus Lundblad <ml@update.uu.se>
date Tue, 31 Aug 2010 18:28:10 +0000
parents c62fac7ada0d
children 691c7bc95b3f
comparison
equal deleted inserted replaced
30908:c44ec533a48c 30909:25e200cb3532
71 * </dd> 71 * </dd>
72 * <dt><tt>"icon-name"</tt> (<tt>char *</tt>)</dt> 72 * <dt><tt>"icon-name"</tt> (<tt>char *</tt>)</dt>
73 * <dd>The Gtk stock id of an icon for the dialog, or @c NULL for no icon. 73 * <dd>The Gtk stock id of an icon for the dialog, or @c NULL for no icon.
74 * @see pidginstock.h 74 * @see pidginstock.h
75 * </dd> 75 * </dd>
76 * <dt><tt>"custom-icon"</tt> (<tt>GdkPixbuf *</tt>)</dt>
77 * <dd>The custom icon to use instead of a stock one (overrides the "icon-name" property).</dd>
76 * </dl> 78 * </dl>
77 */ 79 */
78 typedef struct { 80 typedef struct {
79 GtkVBox parent; 81 GtkVBox parent;
80 82
106 GtkButton *button, gpointer user_data); 108 GtkButton *button, gpointer user_data);
107 109
108 /** Get the GType of #PidginMiniDialog. */ 110 /** Get the GType of #PidginMiniDialog. */
109 GType pidgin_mini_dialog_get_type (void); 111 GType pidgin_mini_dialog_get_type (void);
110 112
111 /** Creates a new #PidginMiniDialog. This is a shortcut for creating the dialog 113 /** Creates a new #PidginMiniDialog with a stock icon. This is a shortcut for creating the dialog
112 * with @c g_object_new() then setting each property yourself. 114 * with @c g_object_new() then setting each property yourself.
113 * @return a new #PidginMiniDialog. 115 * @return a new #PidginMiniDialog.
114 */ 116 */
115 PidginMiniDialog *pidgin_mini_dialog_new(const gchar *title, 117 PidginMiniDialog *pidgin_mini_dialog_new(const gchar *title,
116 const gchar *description, const gchar *icon_name); 118 const gchar *description, const gchar *icon_name);
119
120 /** Creates a new #PidginMiniDialog with a custom icon. This is a shortcut for creating the dialog
121 * with @c g_object_new() then setting each property yourself.
122 * @return a new #PidginMiniDialog.
123 */
124 PidginMiniDialog *pidgin_mini_dialog_new_with_custom_icon(const gchar *title,
125 const gchar *description, GdkPixbuf *custom_icon);
117 126
118 /** Shortcut for setting a mini-dialog's title via GObject properties. 127 /** Shortcut for setting a mini-dialog's title via GObject properties.
119 * @param mini_dialog a mini-dialog 128 * @param mini_dialog a mini-dialog
120 * @param title the new title for @a mini_dialog 129 * @param title the new title for @a mini_dialog
121 */ 130 */
135 * @param icon_name the Gtk stock ID of an icon, or @c NULL for no icon. 144 * @param icon_name the Gtk stock ID of an icon, or @c NULL for no icon.
136 */ 145 */
137 void pidgin_mini_dialog_set_icon_name(PidginMiniDialog *mini_dialog, 146 void pidgin_mini_dialog_set_icon_name(PidginMiniDialog *mini_dialog,
138 const char *icon_name); 147 const char *icon_name);
139 148
149 /** Shortcut for setting a mini-dialog's custom icon via GObject properties.
150 * @param mini_dialog a mini-dialog
151 * @param icon_name the pixbuf to use as a custom icon
152 */
153 void pidgin_mini_dialog_set_custom_icon(PidginMiniDialog *mini_dialog,
154 GdkPixbuf *custom_icon);
155
140 /** Adds a new button to a mini-dialog, and attaches the supplied callback to 156 /** Adds a new button to a mini-dialog, and attaches the supplied callback to
141 * its <tt>clicked</tt> signal. After a button is clicked, the dialog is 157 * its <tt>clicked</tt> signal. After a button is clicked, the dialog is
142 * destroyed. 158 * destroyed.
143 * @param mini_dialog a mini-dialog 159 * @param mini_dialog a mini-dialog
144 * @param text the text to display on the new button 160 * @param text the text to display on the new button