gtkutils.h File Reference

GTK+ utility functions. More...

#include "gtkconv.h"
#include "gtkgaim.h"
#include "prpl.h"

Include dependency graph for gtkutils.h:

Go to the source code of this file.

Enumerations

enum  GaimButtonOrientation { GAIM_BUTTON_HORIZONTAL, GAIM_BUTTON_VERTICAL }
enum  GaimButtonStyle { GAIM_BUTTON_NONE = 0, GAIM_BUTTON_TEXT, GAIM_BUTTON_IMAGE, GAIM_BUTTON_TEXT_IMAGE }
enum  GaimBrowserPlace { GAIM_BROWSER_DEFAULT = 0, GAIM_BROWSER_CURRENT, GAIM_BROWSER_NEW_WINDOW, GAIM_BROWSER_NEW_TAB }

Functions

void gaim_setup_imhtml (GtkWidget *imhtml)
 Sets up a gtkimhtml widget, loads it with smileys, and sets the default signal handlers.
void gaim_gtk_toggle_sensitive (GtkWidget *widget, GtkWidget *to_toggle)
 Toggles the sensitivity of a widget.
void gaim_gtk_set_sensitive_if_input (GtkWidget *entry, GtkWidget *dialog)
 Checks if text has been entered into a GtkTextEntry widget.
void gtk_toggle_sensitive_array (GtkWidget *w, GPtrArray *data)
 Toggles the sensitivity of all widgets in a pointer array.
void gaim_gtk_toggle_showhide (GtkWidget *widget, GtkWidget *to_toggle)
 Toggles the visibility of a widget.
void gaim_separator (GtkWidget *menu)
 Adds a separator to a menu.
GtkWidget * gaim_new_item (GtkWidget *menu, const char *str)
 Creates a menu item.
GtkWidget * gaim_new_check_item (GtkWidget *menu, const char *str, GtkSignalFunc sf, gpointer data, gboolean checked)
 Creates a check 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 menu item.
GtkWidget * gaim_pixbuf_button_from_stock (const char *text, const char *icon, GaimButtonOrientation style)
 Creates a button with the specified text and stock icon.
GtkWidget * gaim_pixbuf_toolbar_button_from_stock (const char *stock)
 Creates a toolbar button with the stock icon.
GtkWidget * gaim_gtk_make_frame (GtkWidget *parent, const char *title)
 Creates a HIG preferences frame.
GtkWidget * gaim_gtk_protocol_option_menu_new (const char *id, GCallback cb, gpointer user_data)
 Creates a drop-down option menu filled with protocols.
GtkWidget * gaim_gtk_account_option_menu_new (GaimAccount *default_account, gboolean show_all, GCallback cb, GaimFilterAccountFunc filter_func, gpointer user_data)
 Creates a drop-down option menu filled with accounts.
GaimAccount * gaim_gtk_account_option_menu_get_selected (GtkWidget *optmenu)
 Gets the currently selected account from an account drop down box.
void gaim_gtk_account_option_menu_set_selected (GtkWidget *optmenu, GaimAccount *account)
 Sets the currently selected account for an account drop down box.
gboolean gaim_gtk_check_if_dir (const char *path, GtkFileSelection *filesel)
 Check if the given path is a directory or not.
void gaim_gtk_setup_gtkspell (GtkTextView *textview)
 Sets up GtkSpell for the given GtkTextView, reporting errors if encountered.
char * stylize (const gchar *text, int len)
 Stylizes the specified text using HTML, according to the current font options.
void gaim_gtk_save_accels_cb (GtkAccelGroup *accel_group, guint arg1, GdkModifierType arg2, GClosure *arg3, gpointer data)
 Save menu accelerators callback.
gboolean gaim_gtk_save_accels (gpointer data)
 Save menu accelerators.
void gaim_gtk_load_accels ()
 Load menu accelerators.
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)
 Parses an application/x-im-contact MIME message and returns the data inside.
void gaim_set_accessible_label (GtkWidget *w, GtkWidget *l)
 Sets an ATK name for a given widget.
void gaim_gtk_treeview_popup_menu_position_func (GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer user_data)
 A valid GtkMenuPositionFunc.
gboolean gaim_running_gnome (void)
 Check if running Gnome.

Variables

guint accels_save_timer


Detailed Description

GTK+ utility functions.

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


Function Documentation

GaimAccount* gaim_gtk_account_option_menu_get_selected ( GtkWidget *  optmenu  ) 

Gets the currently selected account from an account drop down box.

Parameters:
optmenu The GtkOptionMenu created by gaim_gtk_account_option_menu_new.
Returns:
Returns the GaimAccount that is currently selected.

GtkWidget* gaim_gtk_account_option_menu_new ( GaimAccount *  default_account,
gboolean  show_all,
GCallback  cb,
GaimFilterAccountFunc  filter_func,
gpointer  user_data 
)

Creates a drop-down option menu filled with accounts.

Parameters:
default_account The account to select by default.
show_all Whether or not to show all accounts, or just active accounts.
cb The callback to call when an account is selected.
filter_func A function for checking if an account should be shown. This can be NULL.
user_data Data to pass to the callback function.
Returns:
The drop-down option menu.

void gaim_gtk_account_option_menu_set_selected ( GtkWidget *  optmenu,
GaimAccount *  account 
)

Sets the currently selected account for an account drop down box.

Parameters:
optmenu The GtkOptionMenu created by gaim_gtk_account_option_menu_new.
account The GaimAccount to select.

gboolean gaim_gtk_check_if_dir ( const char *  path,
GtkFileSelection *  filesel 
)

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.

Parameters:
path The path entered in the file selection window by the user.
filesel The file selection window.
Returns:
TRUE if given path is a directory, FALSE otherwise.

GtkWidget* gaim_gtk_make_frame ( GtkWidget *  parent,
const char *  title 
)

Creates a HIG preferences frame.

Parameters:
parent The widget to put the frame into.
title The title for the frame.
Returns:
The vbox to put things into.

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 
)

Parses an application/x-im-contact MIME message and returns the data inside.

Parameters:
msg The MIME message.
all_accounts If TRUE, check all compatible accounts, online or offline. If FALSE, check only online accounts.
ret_account The best guess at a compatible protocol, based on ret_protocol. If NULL, no account was found.
ret_protocol The returned protocol type.
ret_username The returned username.
ret_alias The returned alias.
Returns:
TRUE if the message was parsed for the minimum necessary data. FALSE otherwise.

GtkWidget* gaim_gtk_protocol_option_menu_new ( const char *  id,
GCallback  cb,
gpointer  user_data 
)

Creates a drop-down option menu filled with protocols.

Parameters:
id The protocol to select by default.
cb The callback to call when a protocol is selected.
user_data Data to pass to the callback function.
Returns:
The drop-down option menu.

void gaim_gtk_set_sensitive_if_input ( GtkWidget *  entry,
GtkWidget *  dialog 
)

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.

Parameters:
entry The text entry widget.
dialog The dialog containing the text entry widget.

void gaim_gtk_setup_gtkspell ( GtkTextView *  textview  ) 

Sets up GtkSpell for the given GtkTextView, reporting errors if encountered.

This does nothing if Gaim is not compiled with GtkSpell support.

Parameters:
textview The textview widget to setup spellchecking for.

void gaim_gtk_toggle_sensitive ( GtkWidget *  widget,
GtkWidget *  to_toggle 
)

Toggles the sensitivity of a widget.

Parameters:
widget NULL. Used for signal handlers.
to_toggle The widget to toggle.

void gaim_gtk_toggle_showhide ( GtkWidget *  widget,
GtkWidget *  to_toggle 
)

Toggles the visibility of a widget.

Parameters:
widget NULL. Used for signal handlers.
to_toggle The widget to toggle.

void gaim_gtk_treeview_popup_menu_position_func ( GtkMenu *  menu,
gint *  x,
gint *  y,
gboolean *  push_in,
gpointer  user_data 
)

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.

Parameters:
menu The menu we are positioning.
x Address of the gint representing the horizontal position where the menu shall be drawn. This is an output parameter.
y Address of the gint representing the vertical position where the menu shall be drawn. This is an output parameter.
push_in This is an output parameter?
user_data Not used by this particular position function.

GtkWidget* gaim_new_check_item ( GtkWidget *  menu,
const char *  str,
GtkSignalFunc  sf,
gpointer  data,
gboolean  checked 
)

Creates a check menu item.

Parameters:
menu The menu to which to append the check menu item.
str The title to use for the newly created menu item.
sf A function to call when the menu item is activated.
data Data to pass to the signal function.
checked The initial state of the check item
Returns:
The newly created menu item.

GtkWidget* gaim_new_item ( GtkWidget *  menu,
const char *  str 
)

Creates a menu item.

Parameters:
menu The menu to which to append the menu item.
str The title to use for the newly created menu item.
Returns:
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 menu item.

Parameters:
menu The menu to which to append the menu item.
str The title for the menu item.
icon An icon to place to the left of the menu item, or NULL for no icon.
sf A function to call when the menu item is activated.
data Data to pass to the signal function.
accel_key Something.
accel_mods Something.
mod Something.
Returns:
The newly created menu item.

GtkWidget* gaim_pixbuf_button_from_stock ( const char *  text,
const char *  icon,
GaimButtonOrientation  style 
)

Creates a button with the specified text and stock icon.

Parameters:
text The text for the button.
icon The stock icon name.
style The orientation of the button.
Returns:
The button.

GtkWidget* gaim_pixbuf_toolbar_button_from_stock ( const char *  stock  ) 

Creates a toolbar button with the stock icon.

Parameters:
stock The stock icon name.
Returns:
The button.

gboolean gaim_running_gnome ( void   ) 

Check if running Gnome.

Returns:
TRUE if running Gnome, FALSE otherwise.

void gaim_separator ( GtkWidget *  menu  ) 

Adds a separator to a menu.

Parameters:
menu The menu to add a separator to.

void gaim_set_accessible_label ( GtkWidget *  w,
GtkWidget *  l 
)

Sets an ATK name for a given widget.

Also sets the labelled-by and label-for ATK relationships.

Parameters:
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_setup_imhtml ( GtkWidget *  imhtml  ) 

Sets up a gtkimhtml widget, loads it with smileys, and sets the default signal handlers.

Parameters:
imhtml The gtkimhtml widget to setup.

void gtk_toggle_sensitive_array ( GtkWidget *  w,
GPtrArray *  data 
)

Toggles the sensitivity of all widgets in a pointer array.

Parameters:
w NULL. Used for signal handlers.
data The array containing the widgets to toggle.

char* stylize ( const gchar *  text,
int  len 
)

Stylizes the specified text using HTML, according to the current font options.

Parameters:
text The text to stylize.
len The intended length of the new buffer.
Returns:
A newly allocated string of length len, containing the stylized version of text.
Todo:
Move this to a UI-specific file.


Generated on Sun Feb 18 07:36:27 2007 for gaim by  doxygen 1.5.1