Mercurial > pidgin.yaz
view src/gtkutils.h @ 8273:f24172f53650
[gaim-migrate @ 8997]
This is Scott Lamb's eventloop abstraction patch. If it breaks things,
Scott Lamb will be glad to take the punishment. If it doesn't, it should
make integration into other event loops easier. Well, no, not easier,
harder actually, but it'll be done more appropriately and less hackily..
er, hacky. Is hackily a word?
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Tue, 17 Feb 2004 02:17:48 +0000 |
parents | 9af78e73f0b2 |
children | e39ea2b4f6cd |
line wrap: on
line source
/** * @file gtkutils.h GTK+ utility functions * @ingroup gtkui * * gaim * * Gaim is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _GAIM_GTK_UTILS_H_ #define _GAIM_GTK_UTILS_H_ #include <gtk/gtk.h> #include "gtkconv.h" #include "prpl.h" typedef enum { GAIM_BUTTON_HORIZONTAL, GAIM_BUTTON_VERTICAL } GaimButtonOrientation; typedef enum { GAIM_BUTTON_NONE = 0, GAIM_BUTTON_TEXT, GAIM_BUTTON_IMAGE, GAIM_BUTTON_TEXT_IMAGE } GaimButtonStyle; #ifndef _WIN32 typedef enum { GAIM_BROWSER_DEFAULT = 0, GAIM_BROWSER_CURRENT, GAIM_BROWSER_NEW_WINDOW, GAIM_BROWSER_NEW_TAB } GaimBrowserPlace; #endif /* _WIN32 */ typedef gboolean (*GaimCheckAccountFunc)(GaimAccount *account); extern guint accels_save_timer; /** * Sets up a gtkimhtml widget, loads it with smileys, and sets the * default signal handlers. * * @param imhtml The gtkimhtml widget to setup. */ void gaim_setup_imhtml(GtkWidget *imhtml); /** * Surrounds the selected text in a conversation with the specified * pre and post strings. * * @param gtkconv The GTK+ conversation. * @param pre The prefix string. * @param post The postfix string. */ void gaim_gtk_surround(GaimGtkConversation *gtkconv, const char *pre, const char *post); /** * Advances the cursor past the position of the specified tags. * * @param gtkconv The GTK+ conversation. * @param pre The prefix string. * @param post The postfix string. */ void gaim_gtk_advance_past(GaimGtkConversation *gtkconv, const char *pre, const char *post); /** * Surrounds the selected text with the specified font. * * @param gtkconv The GTK+ conversation. * @param font The new font. */ void gaim_gtk_set_font_face(GaimGtkConversation *gtkconv, const char *font); /** * Displays a dialog for saving the buddy icon in a conversation. * * @param obj @c NULL * @param conv The conversation. */ void gaim_gtk_save_icon_dialog(GtkObject *obj, GaimConversation *conv); /** * Returns the display style for buttons for the specified conversation * type. * * @param type The conversation type. * * @return The display style. */ int gaim_gtk_get_dispstyle(GaimConversationType type); /** * Changes a button to be either text or image, depending on * preferences. * * This function destroys the old button pointed to by @a button and * returns the new replacement button. * * @param text The text for the button. * @param button The button widget. * @param stock The stock image. * @param type The conversation type the button belongs to. * * @return The new button widget to replace the old one. */ GtkWidget *gaim_gtk_change_text(const char *text, GtkWidget *button, const char *stock, GaimConversationType type); /** * Toggles the sensitivity of a widget. * * @param widget @c NULL. Used for signal handlers. * @param to_toggle The widget to toggle. */ void gaim_gtk_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. */ void gaim_gtk_set_sensitive_if_input(GtkWidget *entry, GtkWidget *dialog); /** * Toggles the sensitivity of all widgets in a pointer array. * * @param w @c NULL. Used for signal handlers. * @param data The array containing the widgets to toggle. */ void gtk_toggle_sensitive_array(GtkWidget *w, GPtrArray *data); /** * Adds a seperator to a menu. * * @param menu The menu to add a seperator to. */ void gaim_separator(GtkWidget *menu); /** * Creates a menu item. * * @param menu The menu to which to append the menu item. * @param str The title to use for the newly created menu item. * * @return The newly created menu item. */ GtkWidget *gaim_new_item(GtkWidget *menu, const char *str); /** * Creates a check menu item. * * @param menu The menu to which to append the check menu item. * @param str The title to use for the newly created menu item. * @param sf A function to call when the menu item is activated. * @param data Data to pass to the signal function. * @param checked The initial state of the check item * * @return The newly created menu item. */ GtkWidget *gaim_new_check_item(GtkWidget *menu, const char *str, GtkSignalFunc sf, gpointer data, gboolean checked); /** * Creates a menu item. * * @param menu The menu to which to append the menu item. * @param str The title for the menu item. * @param icon An icon to place to the left of the menu item, * or @c NULL for no icon. * @param sf A function to call when the menu item is activated. * @param data Data to pass to the signal function. * @param accel_key Something. * @param accel_mods Something. * @param mod Something. * * @return The newly created menu item. */ GtkWidget *gaim_new_item_from_stock(GtkWidget *menu, const char *str, const char *icon, GtkSignalFunc sf, gpointer data, guint accel_key, guint accel_mods, char *mod); /** * Creates a button with the specified text and stock icon. * * @param text The text for the button. * @param icon The stock icon name. * @param style The orientation of the button. * * @return The button. */ GtkWidget *gaim_pixbuf_button_from_stock(const char *text, const char *icon, GaimButtonOrientation style); /** * Creates a toolbar button with the stock icon. * * @param stock The stock icon name. * * @return The button. */ GtkWidget *gaim_pixbuf_toolbar_button_from_stock(const char *stock); /** * Creates a HIG preferences frame. * * @param parent The widget to put the frame into. * @param title The title for the frame. * * @return The vbox to put things into. */ GtkWidget *gaim_gtk_make_frame(GtkWidget *parent, const char *title); /** * Creates a drop-down option menu filled with protocols. * * @param id The protocol to select by default. * @param cb The callback to call when a protocol is selected. * @param user_data Data to pass to the callback function. * * @return The drop-down option menu. */ GtkWidget *gaim_gtk_protocol_option_menu_new(const char *id, GCallback cb, gpointer user_data); /** * Creates a drop-down option menu filled with accounts. * * @param default_account The account to select by default. * @param show_all Whether or not to show all accounts, or just * active accounts. * @param cb The callback to call when an account is selected. * @param check_account_func A function for checking if an account should * be shown. This can be NULL. * @param user_data Data to pass to the callback function. * * @return The drop-down option menu. */ GtkWidget *gaim_gtk_account_option_menu_new(GaimAccount *default_account, gboolean show_all, GCallback cb, GaimCheckAccountFunc check_account_func, gpointer user_data); /** * Check if the given path is a directory or not. If it is, then modify * the given GtkFileSelection dialog so that it displays the given path. * If the given path is not a directory, then do nothing. * * @param path The path entered in the file selection window by the user. * @param filesel The file selection window. * * @return TRUE if given path is a directory, FALSE otherwise. */ gboolean gaim_gtk_check_if_dir(const char *path, GtkFileSelection *filesel); /** * Parses a message to find \<IMG\> tags with valid ID attributes that * refer to images in Gaim's image store, and load them into a list * of GdkPixbufs. Image tags with missing ID paramaters, or those that * refer to images that are not in the store will have a corresponding * NULL entry on the list. * * @param message The message to parse for image tags. * @param list A pointer to the GSList of GdkPixbufs that will be created. */ void gaim_gtk_find_images(const char *message, GSList **list); /** * Sets up GtkSpell for the given GtkTextView, reporting errors * if encountered. * * This does nothing if Gaim is not compiled with GtkSpell support. * * @param textview The textview widget to setup spellchecking for. */ void gaim_gtk_setup_gtkspell(GtkTextView *textview); /** * Stylizes the specified text using HTML, according to the current * font options. * * @param text The text to stylize. * @param len The intended length of the new buffer. * * @return A newly allocated string of length @a len, containing the * stylized version of @a text. * * @todo Move this to a UI-specific file. */ char *stylize(const gchar *text, int len); /** * Save menu accelerators callback */ void gaim_gtk_save_accels_cb(GtkAccelGroup *accel_group, guint arg1, GdkModifierType arg2, GClosure *arg3, gpointer data); /** * Save menu accelerators */ gboolean gaim_gtk_save_accels(gpointer data); /** * Load menu accelerators */ void gaim_gtk_load_accels(); /** * Parses an application/x-im-contact MIME message and returns the * data inside. * * @param msg The MIME message. * @param all_accounts If TRUE, check all compatible accounts, online or * offline. If FALSE, check only online accounts. * @param ret_account The best guess at a compatible protocol, * based on ret_protocol. If NULL, no account was found. * @param ret_protocol The returned protocol type. * @param ret_username The returned username. * @param ret_alias The returned alias. * * @return TRUE if the message was parsed for the minimum necessary data. * FALSE otherwise. */ gboolean gaim_gtk_parse_x_im_contact(const char *msg, gboolean all_accounts, GaimAccount **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. * * @w The widget that we want to name. * @l A GtkLabel that we want to use as the ATK name for the widget. */ void gaim_set_accessible_label(GtkWidget *w, GtkWidget *l); /** * A valid GtkMenuPositionFunc. This is used to determine where * to draw context menu's 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. * @param y Address of the gint representing the vertical position * where the menu shall be drawn. This is an output parameter. * @param push_in This is an output parameter? * @param user_data Not used by this particular position function. */ void gaim_gtk_treeview_popup_menu_position_func(GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer user_data); #endif /* _GAIM_GTK_UTILS_H_ */