Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

gtkblist.h File Reference

GTK+ Buddy List API. More...

#include "gtkgaim.h"
#include "blist.h"

Include dependency graph for gtkblist.h:

Include dependency graph

Go to the source code of this file.

Data Structures

struct  GaimGtkBuddyList
 Like, everything you need to know about the gtk buddy list. More...
struct  gaim_gtk_blist_sort_method

Defines

#define GAIM_GTK_BLIST(list)   ((GaimGtkBuddyList *)(list)->ui_data)
#define GAIM_IS_GTK_BLIST(list)   ((list)->ui_ops == gaim_gtk_blist_get_ui_ops())

Typedefs

typedef GtkTreeIter(* gaim_gtk_blist_sort_function )(GaimBlistNode *new, GaimBuddyList *blist, GtkTreeIter group, GtkTreeIter *cur)

Enumerations

enum  {
  STATUS_ICON_COLUMN, STATUS_ICON_VISIBLE_COLUMN, NAME_COLUMN, WARNING_COLUMN,
  IDLE_COLUMN, BUDDY_ICON_COLUMN, NODE_COLUMN, BLIST_COLUMNS
}
enum  GaimStatusIconSize { GAIM_STATUS_ICON_LARGE, GAIM_STATUS_ICON_SMALL }

Functions

void * gaim_gtk_blist_get_handle ()
 Get the handle for the GTK+ blist system.
void gaim_gtk_blist_init (void)
 Initializes the GTK+ blist system.
void gaim_gtk_blist_uninit (void)
 Uninitializes the GTK+ blist system.
GaimBlistUiOpsgaim_gtk_blist_get_ui_ops (void)
 Returns the UI operations structure for the buddy list.
GdkPixbuf * create_prpl_icon (GaimAccount *account)
 Returns the base image to represent the account, based on the currently selected theme.
void gaim_gtk_blist_make_buddy_menu (GtkWidget *menu, GaimBuddy *buddy)
 Populates a menu with the items shown on the buddy list for a buddy.
void gaim_gtk_blist_refresh (GaimBuddyList *list)
 Refreshes all the nodes of the buddy list.
void gaim_gtk_blist_update_toolbar ()
 Tells the buddy list to update its toolbar based on the preferences.
void gaim_gtk_blist_docklet_toggle ()
 Useful for the docklet plugin and also for the win32 tray icon This is called when one of those is clicked--it will show/hide the buddy list/login window--depending on which is active.
void gaim_gtk_blist_docklet_add ()
void gaim_gtk_blist_docklet_remove ()
void gaim_gtk_blist_update_columns ()
void gaim_gtk_blist_update_refresh_timeout ()
GdkPixbuf * gaim_gtk_blist_get_status_icon (GaimBlistNode *node, GaimStatusIconSize size)
 Useful for the buddy ticker.
void gaim_gtk_blist_sort_method_reg (const char *id, const char *name, gaim_gtk_blist_sort_function func)
 Registers a buddy list sorting method.
void gaim_gtk_blist_sort_method_unreg (const char *id)
 Unregisters a buddy list sorting method.
void gaim_gtk_blist_sort_method_set (const char *id)
 Sets a buddy list sorting method.
void gaim_gtk_blist_setup_sort_methods ()
 Sets up the programs default sort methods.
void gaim_gtk_blist_update_protocol_actions ()
 Updates the protocol actions menu on the GTK+ buddy list window.
void gaim_gtk_blist_update_plugin_actions ()
 Updates the plugin actions menu on the GTK+ buddy list window.
gboolean gaim_gtk_blist_joinchat_is_showable (void)
 Determines if showing the join chat dialog is a valid action.
void gaim_gtk_blist_joinchat_show (void)
 Shows the join chat dialog.
void gaim_gtk_append_blist_node_proto_menu (GtkWidget *menu, GaimConnection *gc, GaimBlistNode *node)
 Appends the protocol specific menu items for a GaimBlistNode.
void gaim_gtk_append_blist_node_extended_menu (GtkWidget *menu, GaimBlistNode *node)
 Appends the extended menu items for a GaimBlistNode.

Variables

GSList * gaim_gtk_blist_sort_methods


Detailed Description

GTK+ Buddy List API.

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

GdkPixbuf* create_prpl_icon GaimAccount *  account  ) 
 

Returns the base image to represent the account, based on the currently selected theme.

Parameters:
account The account.
Returns:
The icon

void* gaim_gtk_blist_get_handle  ) 
 

Get the handle for the GTK+ blist system.

Returns:
the handle to the blist system

GaimBlistUiOps* gaim_gtk_blist_get_ui_ops void   ) 
 

Returns the UI operations structure for the buddy list.

Returns:
The GTK list operations structure.

gboolean gaim_gtk_blist_joinchat_is_showable void   ) 
 

Determines if showing the join chat dialog is a valid action.

Returns:
Returns TRUE if there are accounts online capable of joining chat rooms. Otherwise returns FALSE.

void gaim_gtk_blist_make_buddy_menu GtkWidget *  menu,
GaimBuddy buddy
 

Populates a menu with the items shown on the buddy list for a buddy.

Parameters:
menu The menu to populate
buddy The buddy who's menu to get

void gaim_gtk_blist_refresh GaimBuddyList list  ) 
 

Refreshes all the nodes of the buddy list.

This should only be called when something changes to affect most of the nodes (such as a ui preference changing)

Parameters:
list This is the core list that gets updated from

void gaim_gtk_blist_sort_method_reg const char *  id,
const char *  name,
gaim_gtk_blist_sort_function  func
 

Registers a buddy list sorting method.

Parameters:
id The unique ID of the sorting method
name The method's name.
func A pointer to the function.

void gaim_gtk_blist_sort_method_set const char *  id  ) 
 

Sets a buddy list sorting method.

Parameters:
id The method's id.

void gaim_gtk_blist_sort_method_unreg const char *  id  ) 
 

Unregisters a buddy list sorting method.

Parameters:
id The method's id


Generated on Tue Aug 9 15:33:01 2005 for gaim by  doxygen 1.3.9.1