gtkconv.h File Reference

GTK+ Conversation API. More...

#include "pidgin.h"
#include "conversation.h"
#include "gtkconvwin.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  _PidginChatPane
 GTK+ Chat panes. More...
struct  _PidginConversation
 A GTK+ conversation pane. More...
struct  _PidginImPane
 A GTK+ Instant Message pane. More...

Defines

#define PIDGIN_CONVERSATION(conv)   ((PidginConversation *)(conv)->ui_data)
#define PIDGIN_IS_PIDGIN_CONVERSATION(conv)

Typedefs

typedef _PidginChatPane PidginChatPane
typedef _PidginConversation PidginConversation
typedef _PidginImPane PidginImPane

Enumerations

enum  {
  CHAT_USERS_ICON_COLUMN, CHAT_USERS_ALIAS_COLUMN, CHAT_USERS_ALIAS_KEY_COLUMN, CHAT_USERS_NAME_COLUMN,
  CHAT_USERS_FLAGS_COLUMN, CHAT_USERS_COLOR_COLUMN, CHAT_USERS_WEIGHT_COLUMN, CHAT_USERS_COLUMNS
}
enum  PidginUnseenState {
  PIDGIN_UNSEEN_NONE, PIDGIN_UNSEEN_EVENT, PIDGIN_UNSEEN_NO_LOG, PIDGIN_UNSEEN_TEXT,
  PIDGIN_UNSEEN_NICK
}
 Unseen text states. More...

Functions

int pidgin_conv_get_tab_at_xy (PidginWindow *win, int x, int y, gboolean *to_right)
GdkPixbuf * pidgin_conv_get_tab_icon (PurpleConversation *conv, gboolean small_icon)
PidginWindowpidgin_conv_get_window (PidginConversation *gtkconv)
gboolean pidgin_conv_is_hidden (PidginConversation *gtkconv)
void pidgin_conv_new (PurpleConversation *conv)
void pidgin_conv_present_conversation (PurpleConversation *conv)
 Presents a purple conversation to the user.
void pidgin_conv_switch_active_conversation (PurpleConversation *conv)
 Sets the active conversation within a GTK-conversation.
void pidgin_conv_update_buddy_icon (PurpleConversation *conv)
 Updates the buddy icon on a conversation.
void pidgin_conv_update_buttons_by_protocol (PurpleConversation *conv)
 Updates conversation buttons by protocol.
guint pidgin_conversations_fill_menu (GtkWidget *menu, GList *convs)
 Fill a menu with a list of conversations.
GList * pidgin_conversations_find_unseen_list (PurpleConversationType type, PidginUnseenState min_state, gboolean hidden_only, guint max_count)
 Returns a list of conversations of the given type which have an unseen state greater than or equal to the specified minimum state.
PurpleConversationUiOpspidgin_conversations_get_conv_ui_ops (void)
 Returns the UI operations structure for GTK+ conversations.
GTK+ Conversations Subsystem
void * pidgin_conversations_get_handle (void)
 Returns the gtk conversations subsystem handle.
void pidgin_conversations_init (void)
 Initializes the GTK+ conversations subsystem.
void pidgin_conversations_uninit (void)
 Uninitialized the GTK+ conversation subsystem.

Detailed Description

GTK+ Conversation API.

pidgin

Pidgin 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

Definition in file gtkconv.h.


Define Documentation

#define PIDGIN_IS_PIDGIN_CONVERSATION ( conv   ) 

Value:

Definition at line 58 of file gtkconv.h.


Enumeration Type Documentation

Unseen text states.

Enumerator:
PIDGIN_UNSEEN_NONE  No unseen text in the conversation.
PIDGIN_UNSEEN_EVENT  Unseen events in the conversation.
PIDGIN_UNSEEN_NO_LOG  Unseen text with NO_LOG flag.
PIDGIN_UNSEEN_TEXT  Unseen text in the conversation.
PIDGIN_UNSEEN_NICK  Unseen text and the nick was said.

Definition at line 35 of file gtkconv.h.


Function Documentation

void pidgin_conv_present_conversation ( PurpleConversation conv  ) 

Presents a purple conversation to the user.

Parameters:
conv The conversation.

void pidgin_conv_switch_active_conversation ( PurpleConversation conv  ) 

Sets the active conversation within a GTK-conversation.

Parameters:
conv The conversation

void pidgin_conv_update_buddy_icon ( PurpleConversation conv  ) 

Updates the buddy icon on a conversation.

Parameters:
conv The conversation.

void pidgin_conv_update_buttons_by_protocol ( PurpleConversation conv  ) 

Updates conversation buttons by protocol.

Parameters:
conv The conversation.

guint pidgin_conversations_fill_menu ( GtkWidget *  menu,
GList *  convs 
)

Fill a menu with a list of conversations.

Clicking the conversation menu item will present that conversation to the user.

Parameters:
menu Menu widget to add items to.
convs List of PurpleConversation to add to menu.
Returns:
Number of conversations added to menu.

GList* pidgin_conversations_find_unseen_list ( PurpleConversationType  type,
PidginUnseenState  min_state,
gboolean  hidden_only,
guint  max_count 
)

Returns a list of conversations of the given type which have an unseen state greater than or equal to the specified minimum state.

Using the hidden_only parameter, this search can be limited to hidden conversations. The max_count parameter will limit the total number of converations returned if greater than zero. The returned list should be freed by the caller.

Parameters:
type The type of conversation.
min_state The minimum unseen state.
hidden_only If TRUE, only consider hidden conversations.
max_count Maximum number of conversations to return, or 0 for no maximum.
Returns:
List of PurpleConversation matching criteria, or NULL.

PurpleConversationUiOps* pidgin_conversations_get_conv_ui_ops ( void   ) 

Returns the UI operations structure for GTK+ conversations.

Returns:
The GTK+ conversation operations structure.

void* pidgin_conversations_get_handle ( void   ) 

Returns the gtk conversations subsystem handle.

Returns:
The conversations subsystem handle.

All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!