src/gtkutils.h

   1 /**
   2  * @file gtkutils.h GTK+ utility functions
   3  * @ingroup gtkui
   4  *
   5  * gaim
   6  *
   7  * Copyright (C) 2002-2003, Christian Hammond <chipx86@gnupdate.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 #ifndef _GAIM_GTK_UTILS_H_
  25 #define _GAIM_GTK_UTILS_H_
  26
  27 #include "gaim.h"
  28 #include "conversation.h"
  29
  30 /**
  31  * Sets up a gtkimhtml widget, loads it with smileys, and sets the
  32  * default signal handlers.
  33  *
  34  * @param imhtml The gtkimhtml widget to setup.
  35  */
  36 void gaim_setup_imhtml(GtkWidget *imhtml);
  37
  38 /**
  39  * Surrounds the selected text in a conversation with the specified
  40  * pre and post strings.
  41  *
  42  * @param gtkconv The GTK+ conversation.
  43  * @param pre     The prefix string.
  44  * @param post    The postfix string.
  45  */
  46 void gaim_gtk_surround(struct gaim_gtk_conversation *gtkconv,
  47                                            const char *pre, const char *post);
  48
  49 /**
  50  * Advances the cursor past the position of the specified tags.
  51  *
  52  * @param gtkconv The GTK+ conversation.
  53  * @param pre     The prefix string.
  54  * @param post    The postfix string.
  55  */
  56 void gaim_gtk_advance_past(struct gaim_gtk_conversation *gtkconv,
  57                                                    const char *pre, const char *post);
  58
  59 /**
  60  * Surrounds the selected text with the specified font.
  61  *
  62  * @param conv The conversation.
  63  * @param font The new font.
  64  */
  65 void gaim_gtk_set_font_face(struct gaim_gtk_conversation *gtkconv,
  66                                                         const char *font);
  67
  68 /**
  69  * Displays a dialog for saving the buddy icon in a conversation.
  70  *
  71  * @param obj  @c NULL
  72  * @param conv The conversation.
  73  */
  74 void gaim_gtk_save_icon_dialog(GtkObject *obj, struct gaim_conversation *conv);
  75
  76 /**
  77  * Returns the display style for buttons for the specified conversation
  78  * type.
  79  *
  80  * @param type The conversation type.
  81  *
  82  * @return The display style.
  83  */
  84 int gaim_gtk_get_dispstyle(GaimConversationType type);
  85
  86 /**
  87  * Changes a button to be either text or image, depending on
  88  * preferences.
  89  *
  90  * This function destroys the old button pointed to by @a button and
  91  * returns the new replacement button.
  92  *
  93  * @param text   The text for the button.
  94  * @param button The button widget.
  95  * @param stock  The stock image.
  96  * @param type   The conversation type the button belongs to.
  97  *
  98  * @return The new button widget to replace the old one.
  99  */
 100 GtkWidget *gaim_gtk_change_text(const char *text, GtkWidget *button,
 101                                                                 const char *stock, GaimConversationType type);
 102
 103 /**
 104  * Toggles the sensitivity of a widget.
 105  *
 106  * @param widget    @c NULL. Used for signal handlers.
 107  * @param to_toggle The widget to toggle.
 108  */
 109 void gaim_gtk_toggle_sensitive(GtkWidget *widget, GtkWidget *to_toggle);
 110
 111 /**
 112  * Toggles the sensitivity of all widgets in a pointer array.
 113  *
 114  * @param widget    @c NULL. Used for signal handlers.
 115  * @param to_toggle The array containing the widgets to toggle.
 116  */
 117 void gtk_toggle_sensitive_array(GtkWidget *w, GPtrArray *data);
 118
 119 /**
 120  * Adds a seperator to a menu.
 121  *
 122  * @param menu The menu to add a seperator to.
 123  */
 124 void gaim_separator(GtkWidget *menu);
 125
 126 /**
 127  * Creates a menu item.
 128  *
 129  * @param menu The menu to which to append the menu item.
 130  * @param str  The title to use for the newly created menu item.
 131  *
 132  * @return The newly created menu item.
 133  */
 134 GtkWidget *gaim_new_item(GtkWidget *menu, const char *str);
 135
 136 /**
 137  * Creates a menu item.
 138  *
 139  * @param menu       The menu to which to append the menu item.
 140  * @param str        The title for the menu item.
 141  * @param icon       An icon to place to the left of the menu item, or NULL for no icon.
 142  * @param sf         A function to call when the menu item is activated.
 143  * @param data       Data to pass to the signal function.
 144  * @param accel_key  Something.
 145  * @param accel_mods Something.
 146  * @param mod        Something.
 147  *
 148  * @return The newly created menu item.
 149  */
 150 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);
 151
 152 #endif /* _GAIM_GTK_UTILS_H_ */