gtkconv.h File Reference

GTK+ Conversation API. More...

#include "gtkgaim.h"
#include "conversation.h"

Include dependency graph for gtkconv.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _GaimGtkWindow
 A GTK+ representation of a graphical window containing one or more conversations. More...
struct  _GaimGtkImPane
 A GTK+ Instant Message pane. More...
struct  _GaimGtkChatPane
 GTK+ Chat panes. More...
struct  _GaimGtkConversation
 A GTK+ conversation pane. More...
#define GAIM_GTK_WINDOW(win)   ((GaimGtkWindow *)(win)->ui_data)
#define GAIM_GTK_CONVERSATION(conv)   ((GaimGtkConversation *)(conv)->ui_data)
#define GAIM_IS_GTK_WINDOW(win)   (gaim_conv_window_get_ui_ops(win) == gaim_gtk_conversations_get_win_ui_ops())
#define GAIM_IS_GTK_CONVERSATION(conv)
typedef _GaimGtkWindow GaimGtkWindow
typedef _GaimGtkImPane GaimGtkImPane
typedef _GaimGtkChatPane GaimGtkChatPane
typedef _GaimGtkConversation GaimGtkConversation

Enumerations

enum  { CHAT_USERS_ICON_COLUMN, CHAT_USERS_NAME_COLUMN, CHAT_USERS_FLAGS_COLUMN, CHAT_USERS_COLUMNS }

Functions

GaimConvWindowUiOpsgaim_gtk_conversations_get_win_ui_ops (void)
 Returns the UI operations structure for GTK windows.
GaimConversationUiOpsgaim_gtk_conversations_get_conv_ui_ops (void)
 Returns the UI operations structure for GTK conversations.
void gaim_gtkconv_update_buddy_icon (GaimConversation *conv)
 Updates the buddy icon on a conversation.
void gaim_gtkconv_update_tabs (void)
 Updates the tab positions on all conversation windows to reflect any changed preferences.
void gaim_gtkconv_update_chat_button_style ()
 Updates the button style on chat windows to reflect any changed preferences.
void gaim_gtkconv_update_im_button_style ()
 Updates the button style on IM windows to reflect any changed preferences.
void gaim_gtkconv_update_buttons_by_protocol (GaimConversation *conv)
 Updates conversation buttons by protocol.
GtkWidget * gaim_gtkconv_button_new (const char *icon, const char *text, const char *tooltip, GtkTooltips *tooltips, void *callback, void *data)
 Creates a conversation button.
GaimConvWindowgaim_gtkwin_get_at_xy (int x, int y)
 Returns the window at the specified X, Y location.
int gaim_gtkconv_get_tab_at_xy (GaimConvWindow *win, int x, int y)
 Returns the index of the tab at the specified X, Y location in a notebook.
int gaim_gtkconv_get_dest_tab_at_xy (GaimConvWindow *win, int x, int y)
 Returns the index of the destination tab at the specified X, Y location in a notebook.
GTK+ Conversations Subsystem
void * gaim_gtk_conversations_get_handle (void)
 Returns the gtk conversations subsystem handle.
void gaim_gtk_conversations_init (void)
 Initializes the GTK+ conversations subsystem.
void gaim_gtk_conversations_uninit (void)
 Uninitialized the GTK+ conversation subsystem.


Detailed Description

GTK+ Conversation 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


Define Documentation

#define GAIM_IS_GTK_CONVERSATION ( conv   ) 

Value:


Function Documentation

GaimConversationUiOps* gaim_gtk_conversations_get_conv_ui_ops ( void   ) 

Returns the UI operations structure for GTK conversations.

Returns:
The GTK conversation operations structure.

void* gaim_gtk_conversations_get_handle ( void   ) 

Returns the gtk conversations subsystem handle.

Returns:
The conversations subsystem handle.

GaimConvWindowUiOps* gaim_gtk_conversations_get_win_ui_ops ( void   ) 

Returns the UI operations structure for GTK windows.

Returns:
The GTK window operations structure.

GtkWidget* gaim_gtkconv_button_new ( const char *  icon,
const char *  text,
const char *  tooltip,
GtkTooltips *  tooltips,
void *  callback,
void *  data 
)

Creates a conversation button.

Parameters:
icon The stock icon name.
text The text for the button.
tooltip The tooltip text.
tooltips The group of tooltips.
callback A function to call when the button is clicked.
data Data to pass to the callback.
Returns:
The button

int gaim_gtkconv_get_dest_tab_at_xy ( GaimConvWindow win,
int  x,
int  y 
)

Returns the index of the destination tab at the specified X, Y location in a notebook.

This is used for drag-and-drop functions when the tab at the index is a destination tab.

Parameters:
win The GTK+ window containing the notebook.
x The X coordinate.
y The Y coordinate.
Returns:
The index of the tab at the location.

int gaim_gtkconv_get_tab_at_xy ( GaimConvWindow win,
int  x,
int  y 
)

Returns the index of the tab at the specified X, Y location in a notebook.

Parameters:
win The GTK+ window containing the notebook.
x The X coordinate.
y The Y coordinate.
Returns:
The index of the tab at the location.

void gaim_gtkconv_update_buddy_icon ( GaimConversation conv  ) 

Updates the buddy icon on a conversation.

Parameters:
conv The conversation.

void gaim_gtkconv_update_buttons_by_protocol ( GaimConversation conv  ) 

Updates conversation buttons by protocol.

Parameters:
conv The conversation.

GaimConvWindow* gaim_gtkwin_get_at_xy ( int  x,
int  y 
)

Returns the window at the specified X, Y location.

If the window is not a GTK+ window, NULL is returned.

Parameters:
x The X coordinate.
y The Y coordinate.
Returns:
The GTK+ window at the location, if it exists, or NULL otherwise.


Generated on Sun Feb 18 07:52:23 2007 for gaim by  doxygen 1.5.1