pidgin3: comparison pidgin/gtkutils.h

-:9124a345ed3a
+:e85d894af8a5
 /**
 * Retrieves the main content box (vbox) from a pidgin dialog window
 *
 * @param dialog       The dialog window
 * @param homogeneous  TRUE if all children are to be given equal space allotments.
 * @param spacing      the number of pixels to place by default between children
 *
 * @since 2.4.0
 */
 GtkWidget *pidgin_dialog_get_vbox_with_properties(GtkDialog *dialog, gboolean homogeneous, gint spacing);
 * @param to_toggle The widget to toggle.
 */
 void pidgin_toggle_sensitive(GtkWidget *widget, GtkWidget *to_toggle);
 /**
 * Checks if text has been entered into a GtkTextEntry widget.  If
 * so, the GTK_RESPONSE_OK on the given dialog is set to TRUE.
 * Otherwise GTK_RESPONSE_OK is set to FALSE.
 *
 * @param entry  The text entry widget.
 * @param dialog The dialog containing the text entry widget.
 */
 /**
 * Add autocompletion of screenames to an entry, supporting a filtering function.
 *
 * @param entry       The GtkEntry on which to setup autocomplete.
 * @param optmenu     A menu for accounts, returned by gaim_gtk_account_option_menu_new().
-*                    If @a optmenu is not @c NULL, it'll be updated when a screenname is chosen
+*                    If @a optmenu is not @c NULL, it'll be updated when a username is chosen
 *                    from the autocomplete list.
 * @param filter_func A function for checking if an autocomplete entry
 *                    should be shown. This can be @c NULL.
 * @param user_data  The data to be passed to the filter_func function.
 */
 void pidgin_setup_screenname_autocomplete_with_filter(GtkWidget *entry, GtkWidget *optmenu, PidginFilterBuddyCompletionEntryFunc filter_func, gpointer user_data);
 /**
-* The default filter function for screenname autocomplete.
+* The default filter function for username autocomplete.
 *
 * @param completion_entry The completion entry to filter.
 * @param all_accounts  If this is @c FALSE, only the autocompletion entries
 *                         which belong to an online account will be filtered.
 * @return Returns @c TRUE if the autocompletion entry is filtered.
 *   all)</tt>)
 *
 * @param entry     The GtkEntry on which to setup autocomplete.
 * @param optmenu   A menu for accounts, returned by
 *                  pidgin_account_option_menu_new().  If @a optmenu is not @c
-*                  NULL, it'll be updated when a screenname is chosen from the
+*                  NULL, it'll be updated when a username is chosen from the
 *                  autocomplete list.
-* @param all       Whether to include screennames from disconnected accounts.
+* @param all       Whether to include usernames from disconnected accounts.
 */
 void pidgin_setup_screenname_autocomplete(GtkWidget *entry, GtkWidget *optmenu, gboolean all);
 /**
 * Check if the given path is a directory or not.  If it is, then modify
 									 PurpleAccount **ret_account,
 									 char **ret_protocol, char **ret_username,
 									 char **ret_alias);
 /**
 * Sets an ATK name for a given widget.  Also sets the labelled-by
 * and label-for ATK relationships.
 *
 * @param w The widget that we want to name.
 * @param l A GtkLabel that we want to use as the ATK name for the widget.
 */
 */
 void pidgin_menu_position_func_helper(GtkMenu *menu, gint *x, gint *y,
 										gboolean *push_in, gpointer data);
 /**
 * A valid GtkMenuPositionFunc.  This is used to determine where
 * to draw context menus when the menu is activated with the
 * keyboard (shift+F10).  If the menu is activated with the mouse,
 * then you should just use GTK's built-in position function,
 * because it does a better job of positioning the menu.
 *
 * @param menu The menu we are positioning.
 * @param x Address of the gint representing the horizontal position
 *        where the menu shall be drawn. This is an output parameter.
 * Creates a File Selection widget for choosing a buddy icon
 *
 * @param parent      The parent window
 * @param callback    The callback to call when the window is closed. If the user chose an icon, the char* argument will point to its path
 * @param data        Data to pass to @a callback
 * @return            The file dialog
 */
 GtkWidget *pidgin_buddy_icon_chooser_new(GtkWindow *parent, void(*callback)(const char*,gpointer), gpointer data);
 /**
 * Converts a buddy icon to the required size and format
 *
 * @param plugin     The prpl to convert the icon
 * @param path       The path of a file to convert
 * @param len        If not @c NULL, the length of the returned data will be set here.
 *
 * @return           The converted image data, or @c NULL if an error occurred.
 */
 gboolean pidgin_tree_view_search_equal_func(GtkTreeModel *model, gint column,
 			const gchar *key, GtkTreeIter *iter, gpointer data);
 /**
 * Sets or resets a window to 'urgent,' by setting the URGENT hint in X
 * or blinking in the win32 taskbar
 *
 * @param window  The window to draw attention to
 * @param urgent  Whether to set the urgent hint or not
 */
 /**
 * Automatically make a window transient to a suitable parent window.
 *
 * @param window    The window to make transient.
 *
-* @return  Whether the window was made transient or not.
+* @return Whether the window was made transient or not.
+*
 * @since 2.4.0
 */
 gboolean pidgin_auto_parent_window(GtkWidget *window);
 /**
 * Create a GdkPixbuf from a PurpleStoredImage.
 *
 * @param  image   A PurpleStoredImage.
 *
 * @return   A GdkPixbuf created from the stored image.
+*
 * @since 2.5.0
 */
-GdkPixbuf * pidgin_pixbuf_from_imgstore(PurpleStoredImage *image);
+GdkPixbuf *pidgin_pixbuf_from_imgstore(PurpleStoredImage *image);
+/**
+* Initialize some utility functions.
+*
+* @since 2.6.0
+*/
+void pidgin_utils_init(void);
+/**
+* Uninitialize some utility functions.
+*
+* @since 2.6.0
+*/
+void pidgin_utils_uninit(void);
 #endif /* _PIDGINUTILS_H_ */

Mercurial > pidgin3 / file comparison

comparison: pidgin/gtkutils.h

pidgin/gtkutils.h