1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/*
* finch
*
* Finch 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#if !defined(FINCH_GLOBAL_HEADER_INSIDE) && !defined(FINCH_COMPILATION)
# error "only <finch.h> may be included directly"
#endif
#ifndef FINCH_CONV_H
#define FINCH_CONV_H
#include <gnt.h>
#include <purple.h>
/* Grabs the conv out of a PurpleConverstation */
#define FINCH_CONV(conv) ((FinchConv *)g_object_get_data(G_OBJECT(conv), "finch"))
/***************************************************************************
* GNT Conversations API
***************************************************************************/
typedef struct _FinchConv FinchConv;
typedef struct _FinchConvChat FinchConvChat;
typedef struct _FinchConvIm FinchConvIm;
/**
* FinchConversationFlag:
* @FINCH_CONV_NO_SOUND: A flag to mute a conversation.
*
* Flags that can be set for each conversation.
*/
typedef enum
{
FINCH_CONV_NO_SOUND = 1 << 0,
} FinchConversationFlag;
/**
* FinchConv:
* @list: A list of conversations being displayed in this window.
* @active_conv: The active conversation.
* @window: The #GntWindow for the conversation.
* @entry: The #GntEntry for input.
* @tv: The #GntTextView that displays the history.
* @menu: The menu for the conversation.
* @info: The info widget that shows the information about the conversation.
* @plugins: The #GntMenuItem for plugins.
* @flags: The flags for the conversation.
*
* A Finch conversation.
*/
struct _FinchConv
{
GList *list;
PurpleConversation *active_conv;
GntWidget *window; /* the container */
GntWidget *entry; /* entry */
GntWidget *tv; /* text-view */
GntWidget *menu;
GntWidget *info;
GntMenuItem *plugins;
FinchConversationFlag flags;
union
{
FinchConvChat *chat;
FinchConvIm *im;
} u;
};
/**
* FinchConvChat:
* @userlist: The widget that displays the users in the chat.
*
* The chat specific implementation for a conversation.
*/
struct _FinchConvChat
{
GntWidget *userlist; /* the userlist */
/*< private >*/
void *finch_reserved1;
void *finch_reserved2;
void *finch_reserved3;
void *finch_reserved4;
};
/**
* FinchConvIm:
* @sendto: The sendto widget which allows the user to select who they're
* messaging.
*
* The instant message implementation for a conversation.
*/
struct _FinchConvIm
{
GntMenuItem *sendto;
/*< private >*/
void *finch_reserved1;
void *finch_reserved2;
void *finch_reserved3;
void *finch_reserved4;
};
/**
* finch_conv_get_ui_ops:
*
* Get the ui-functions.
*
* Returns: The PurpleConversationUiOps populated with the appropriate functions.
*/
PurpleConversationUiOps *finch_conv_get_ui_ops(void);
/**
* finch_conversation_init:
*
* Perform the necessary initializations.
*/
void finch_conversation_init(void);
/**
* finch_conversation_uninit:
*
* Perform the necessary uninitializations.
*/
void finch_conversation_uninit(void);
/**
* finch_conversation_set_active:
* @conv: The conversation to make active.
*
* Set a conversation as active in a contactized conversation
*/
void finch_conversation_set_active(PurpleConversation *conv);
/**
* finch_conversation_set_info_widget:
* @conv: The conversation.
* @widget: The widget containing the information. If %NULL,
* the current information widget is removed.
*
* Sets the information widget for the conversation window.
*/
void finch_conversation_set_info_widget(PurpleConversation *conv, GntWidget *widget);
#endif /* FINCH_CONV_H */
|
