Mercurial > pidgin.yaz
annotate finch/gntconv.h @ 19025:c3e80350c270
- Added a lovely Doxygen signals tutorial
author | William Ehlhardt <williamehlhardt@gmail.com> |
---|---|
date | Sun, 15 Jul 2007 06:28:08 +0000 |
parents | 5e6f8b92a2a5 |
children | 68a3b83795c6 |
rev | line source |
---|---|
15818 | 1 /** |
2 * @file gntconv.h GNT Conversation API | |
16194
0f0832c13fcb
Rename the Doxygen group from gntui to finch and define the finch group
Richard Laager <rlaager@wiktel.com>
parents:
16168
diff
changeset
|
3 * @ingroup finch |
15818 | 4 * |
15871
66dff3dfdea6
Re-sed the copyright notices so they don't all talk about Purple.
Richard Laager <rlaager@wiktel.com>
parents:
15823
diff
changeset
|
5 * finch |
15818 | 6 * |
15871
66dff3dfdea6
Re-sed the copyright notices so they don't all talk about Purple.
Richard Laager <rlaager@wiktel.com>
parents:
15823
diff
changeset
|
7 * Finch is the legal property of its developers, whose names are too numerous |
15818 | 8 * to list here. Please refer to the COPYRIGHT file distributed with this |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 #ifndef _GNT_CONV_H | |
26 #define _GNT_CONV_H | |
27 | |
28 #include <gnt.h> | |
29 #include <gntwidget.h> | |
30 | |
31 #include "conversation.h" | |
32 | |
33 /*************************************************************************** | |
34 * @name GNT Conversations API | |
35 ***************************************************************************/ | |
36 /*@{*/ | |
37 | |
38 typedef struct _FinchConv FinchConv; | |
39 typedef struct _FinchConvChat FinchConvChat; | |
40 typedef struct _FinchConvIm FinchConvIm; | |
41 | |
42 struct _FinchConv | |
43 { | |
44 GList *list; | |
15823 | 45 PurpleConversation *active_conv; |
15818 | 46 |
47 GntWidget *window; /* the container */ | |
48 GntWidget *entry; /* entry */ | |
49 GntWidget *tv; /* text-view */ | |
16129
8bb00667532f
Add this now so we don't break abi right after release
Richard Nelson <wabz@pidgin.im>
parents:
15871
diff
changeset
|
50 GntWidget *menu; /* future use */ |
16128
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
51 GntWidget *info; |
16671
5e6f8b92a2a5
Preemptive padding.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
52 void *pad; |
15818 | 53 |
54 union | |
55 { | |
56 FinchConvChat *chat; | |
57 FinchConvIm *im; | |
58 } u; | |
59 }; | |
60 | |
61 struct _FinchConvChat | |
62 { | |
63 GntWidget *userlist; /* the userlist */ | |
16671
5e6f8b92a2a5
Preemptive padding.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
64 void *pad1; |
5e6f8b92a2a5
Preemptive padding.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
65 void *pad2; |
15818 | 66 }; |
67 | |
68 struct _FinchConvIm | |
69 { | |
70 void *nothing_for_now; | |
16671
5e6f8b92a2a5
Preemptive padding.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16194
diff
changeset
|
71 void *something_for_later; |
15818 | 72 }; |
73 | |
74 /** | |
75 * Get the ui-functions. | |
76 * | |
15823 | 77 * @return The PurpleConversationUiOps populated with the appropriate functions. |
15818 | 78 */ |
15823 | 79 PurpleConversationUiOps *finch_conv_get_ui_ops(void); |
15818 | 80 |
81 /** | |
82 * Perform the necessary initializations. | |
83 */ | |
84 void finch_conversation_init(void); | |
85 | |
86 /** | |
87 * Perform the necessary uninitializations. | |
88 */ | |
89 void finch_conversation_uninit(void); | |
90 | |
91 /** | |
92 * Set a conversation as active in a contactized conversation | |
93 * | |
94 * @param conv The conversation to make active. | |
95 */ | |
15823 | 96 void finch_conversation_set_active(PurpleConversation *conv); |
15818 | 97 |
16128
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
98 /** |
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
99 * Sets the information widget for the conversation window. |
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
100 * |
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
101 * @param conv The conversation. |
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
102 * @param widget The widget containing the information. If @c NULL, |
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
103 * the current information widget is removed. |
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
104 */ |
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
105 void finch_conversation_set_info_widget(PurpleConversation *conv, GntWidget *widget); |
7a2ffa981c1a
Allow adding information widgets in the conversation window.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15871
diff
changeset
|
106 |
15818 | 107 /*@}*/ |
108 | |
109 #endif |