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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*
* Pidgin - Internet Messenger
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* 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, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif
#ifndef PIDGIN_DISPLAY_WINDOW_H
#define PIDGIN_DISPLAY_WINDOW_H
#include <glib.h>
#include <gtk/gtk.h>
#include <purple.h>
G_BEGIN_DECLS
/**
* PidginDisplayWindow:
*
* #PidginDisplayWindow is a widget that contains #PidginConversations.
*
* Since: 3.0.0
*/
#define PIDGIN_TYPE_DISPLAY_WINDOW (pidgin_display_window_get_type())
G_DECLARE_FINAL_TYPE(PidginDisplayWindow, pidgin_display_window,
PIDGIN, DISPLAY_WINDOW, GtkApplicationWindow)
/**
* pidgin_display_window_new:
*
* Creates a new #PidginDisplayWindow instance.
*
* Returns: (transfer full): The new #PidginDisplayWindow instance.
*/
GtkWidget *pidgin_display_window_new(void);
/**
* pidgin_display_window_get_default:
*
* Gets or creates the default conversation window.
*
* Returns: (transfer none): The default #PidginDisplayWindow.
*
* Since: 3.0.0
*/
GtkWidget *pidgin_display_window_get_default(void);
/**
* pidgin_display_window_add:
* @window: The #PidginDisplayWindow instance.
* @conversation: The #PurpleConversation to add to @window.
*
* Adds @conversation to @window. If @conversation is already in @window, this
* does nothing.
*
* Since: 3.0.0
*/
void pidgin_display_window_add(PidginDisplayWindow *window, PurpleConversation *conversation);
/**
* pidgin_display_window_remove:
* @window: The #PidginDisplayWindow instance.
* @conversation: The #PurpleConversation to remove from @window.
*
* Removes @conversation from @window. If @conversation is not in @window, this
* does nothing.
*
* Since: 3.0.0
*/
void pidgin_display_window_remove(PidginDisplayWindow *window, PurpleConversation *conversation);
/**
* pidgin_display_window_get_count:
* @window: The conversation window instance.
*
* Gets the number of conversations that @window contains.
*
* Returns: The number of conversations that @window contains.
*
* Since: 3.0.0
*/
guint pidgin_display_window_get_count(PidginDisplayWindow *window);
/**
* pidgin_display_window_get_selected:
* @window: The conversation window instance.
*
* Gets the currently selected PurpleConversation or %NULL if there is no
* selection.
*
* Returns: (transfer full): The selected PurpleConversation or %NULL.
*
* Since: 3.0.0
*/
PurpleConversation *pidgin_display_window_get_selected(PidginDisplayWindow *window);
/**
* pidgin_display_window_select:
* @window: The conversation window instance.
* @conversation: The conversation to select.
*
* Selects @conversation, making it the active conversation.
*
* Since: 3.0.0
*/
void pidgin_display_window_select(PidginDisplayWindow *window, PurpleConversation *conversation);
/**
* pidgin_display_window_select_previous:
* @window: The conversation window instance.
*
* Switches to the conversation previous to the currently selected
* conversation.
*
* If no conversation is selected, the last conversation will be selected.
*
* Since: 3.0.0
*/
void pidgin_display_window_select_previous(PidginDisplayWindow *window);
/**
* pidgin_display_window_select_next:
* @window: The conversation window instance.
*
* Switches to the conversation next of the currently selected conversation.
*
* If no conversation is selected, the first conversation will be selected.
*
* Since: 3.0.0
*/
void pidgin_display_window_select_next(PidginDisplayWindow *window);
/**
* pidgin_display_window_select_first:
* @window: The conversation window instance.
*
* Selects the first conversation in @window. If there are no conversations in
* @window this does nothing.
*
* Since: 3.0.0
*/
void pidgin_display_window_select_first(PidginDisplayWindow *window);
/**
* pidgin_display_window_select_last:
* @window: The conversation window instance.
*
* Selects the last conversation in @window. If there are no conversations in
* @window this does nothing.
*
* Since: 3.0.0
*/
void pidgin_display_window_select_last(PidginDisplayWindow *window);
/**
* pidgin_display_window_select_nth:
* @window: The conversation window instance.
* @nth: The index of the conversation to switch to.
*
* Switches to the @nth conversation. @nth is a 0 based index, so the first
* conversation is at index 0.
*
* Since: 3.0.0
*/
void pidgin_display_window_select_nth(PidginDisplayWindow *window, guint nth);
/**
* pidgin_display_window_conversation_is_selected:
* @window: The conversation window instance.
* @conversation: The conversation instance.
*
* Checks whether @conversation is the active conversation in @window.
*
* Returns: %TRUE if @conversation is active.
*
* Since: 3.0.0
*/
gboolean pidgin_display_window_conversation_is_selected(PidginDisplayWindow *window, PurpleConversation *conversation);
G_END_DECLS
#endif /* PIDGIN_DISPLAY_WINDOW_H */
|
