pidgin/pidgindisplaywindow.h

changeset 42466
ca3374c1cdba
parent 42465
b7d530551c1b
child 42467
2b1d9d0770f2
equal deleted inserted replaced
42465:b7d530551c1b 42466:ca3374c1cdba
67 * 67 *
68 * Returns: (transfer none): The default #PidginDisplayWindow. 68 * Returns: (transfer none): The default #PidginDisplayWindow.
69 * 69 *
70 * Since: 3.0.0 70 * Since: 3.0.0
71 */ 71 */
72 PIDGIN_AVAILABLE_IN_3_0
72 GtkWidget *pidgin_display_window_get_default(void); 73 GtkWidget *pidgin_display_window_get_default(void);
73 74
74 /** 75 /**
75 * pidgin_display_window_add: 76 * pidgin_display_window_add:
76 * @window: The #PidginDisplayWindow instance. 77 * @window: The #PidginDisplayWindow instance.
79 * Adds @conversation to @window. If @conversation is already in @window, this 80 * Adds @conversation to @window. If @conversation is already in @window, this
80 * does nothing. 81 * does nothing.
81 * 82 *
82 * Since: 3.0.0 83 * Since: 3.0.0
83 */ 84 */
85 PIDGIN_AVAILABLE_IN_3_0
84 void pidgin_display_window_add(PidginDisplayWindow *window, PurpleConversation *conversation); 86 void pidgin_display_window_add(PidginDisplayWindow *window, PurpleConversation *conversation);
85 87
86 /** 88 /**
87 * pidgin_display_window_remove: 89 * pidgin_display_window_remove:
88 * @window: The #PidginDisplayWindow instance. 90 * @window: The #PidginDisplayWindow instance.
91 * Removes @conversation from @window. If @conversation is not in @window, this 93 * Removes @conversation from @window. If @conversation is not in @window, this
92 * does nothing. 94 * does nothing.
93 * 95 *
94 * Since: 3.0.0 96 * Since: 3.0.0
95 */ 97 */
98 PIDGIN_AVAILABLE_IN_3_0
96 void pidgin_display_window_remove(PidginDisplayWindow *window, PurpleConversation *conversation); 99 void pidgin_display_window_remove(PidginDisplayWindow *window, PurpleConversation *conversation);
97 100
98 /** 101 /**
99 * pidgin_display_window_get_count: 102 * pidgin_display_window_get_count:
100 * @window: The conversation window instance. 103 * @window: The conversation window instance.
103 * 106 *
104 * Returns: The number of conversations that @window contains. 107 * Returns: The number of conversations that @window contains.
105 * 108 *
106 * Since: 3.0.0 109 * Since: 3.0.0
107 */ 110 */
111 PIDGIN_AVAILABLE_IN_3_0
108 guint pidgin_display_window_get_count(PidginDisplayWindow *window); 112 guint pidgin_display_window_get_count(PidginDisplayWindow *window);
109 113
110 /** 114 /**
111 * pidgin_display_window_get_selected: 115 * pidgin_display_window_get_selected:
112 * @window: The conversation window instance. 116 * @window: The conversation window instance.
116 * 120 *
117 * Returns: (transfer full): The selected PurpleConversation or %NULL. 121 * Returns: (transfer full): The selected PurpleConversation or %NULL.
118 * 122 *
119 * Since: 3.0.0 123 * Since: 3.0.0
120 */ 124 */
125 PIDGIN_AVAILABLE_IN_3_0
121 PurpleConversation *pidgin_display_window_get_selected(PidginDisplayWindow *window); 126 PurpleConversation *pidgin_display_window_get_selected(PidginDisplayWindow *window);
122 127
123 /** 128 /**
124 * pidgin_display_window_select: 129 * pidgin_display_window_select:
125 * @window: The conversation window instance. 130 * @window: The conversation window instance.
127 * 132 *
128 * Selects @conversation, making it the active conversation. 133 * Selects @conversation, making it the active conversation.
129 * 134 *
130 * Since: 3.0.0 135 * Since: 3.0.0
131 */ 136 */
137 PIDGIN_AVAILABLE_IN_3_0
132 void pidgin_display_window_select(PidginDisplayWindow *window, PurpleConversation *conversation); 138 void pidgin_display_window_select(PidginDisplayWindow *window, PurpleConversation *conversation);
133 139
134 /** 140 /**
135 * pidgin_display_window_select_previous: 141 * pidgin_display_window_select_previous:
136 * @window: The conversation window instance. 142 * @window: The conversation window instance.
140 * 146 *
141 * If no conversation is selected, the last conversation will be selected. 147 * If no conversation is selected, the last conversation will be selected.
142 * 148 *
143 * Since: 3.0.0 149 * Since: 3.0.0
144 */ 150 */
151 PIDGIN_AVAILABLE_IN_3_0
145 void pidgin_display_window_select_previous(PidginDisplayWindow *window); 152 void pidgin_display_window_select_previous(PidginDisplayWindow *window);
146 153
147 /** 154 /**
148 * pidgin_display_window_select_next: 155 * pidgin_display_window_select_next:
149 * @window: The conversation window instance. 156 * @window: The conversation window instance.
152 * 159 *
153 * If no conversation is selected, the first conversation will be selected. 160 * If no conversation is selected, the first conversation will be selected.
154 * 161 *
155 * Since: 3.0.0 162 * Since: 3.0.0
156 */ 163 */
164 PIDGIN_AVAILABLE_IN_3_0
157 void pidgin_display_window_select_next(PidginDisplayWindow *window); 165 void pidgin_display_window_select_next(PidginDisplayWindow *window);
158 166
159 /** 167 /**
160 * pidgin_display_window_select_first: 168 * pidgin_display_window_select_first:
161 * @window: The conversation window instance. 169 * @window: The conversation window instance.
163 * Selects the first conversation in @window. If there are no conversations in 171 * Selects the first conversation in @window. If there are no conversations in
164 * @window this does nothing. 172 * @window this does nothing.
165 * 173 *
166 * Since: 3.0.0 174 * Since: 3.0.0
167 */ 175 */
176 PIDGIN_AVAILABLE_IN_3_0
168 void pidgin_display_window_select_first(PidginDisplayWindow *window); 177 void pidgin_display_window_select_first(PidginDisplayWindow *window);
169 178
170 /** 179 /**
171 * pidgin_display_window_select_last: 180 * pidgin_display_window_select_last:
172 * @window: The conversation window instance. 181 * @window: The conversation window instance.
174 * Selects the last conversation in @window. If there are no conversations in 183 * Selects the last conversation in @window. If there are no conversations in
175 * @window this does nothing. 184 * @window this does nothing.
176 * 185 *
177 * Since: 3.0.0 186 * Since: 3.0.0
178 */ 187 */
188 PIDGIN_AVAILABLE_IN_3_0
179 void pidgin_display_window_select_last(PidginDisplayWindow *window); 189 void pidgin_display_window_select_last(PidginDisplayWindow *window);
180 190
181 /** 191 /**
182 * pidgin_display_window_select_nth: 192 * pidgin_display_window_select_nth:
183 * @window: The conversation window instance. 193 * @window: The conversation window instance.
186 * Switches to the @nth conversation. @nth is a 0 based index, so the first 196 * Switches to the @nth conversation. @nth is a 0 based index, so the first
187 * conversation is at index 0. 197 * conversation is at index 0.
188 * 198 *
189 * Since: 3.0.0 199 * Since: 3.0.0
190 */ 200 */
201 PIDGIN_AVAILABLE_IN_3_0
191 void pidgin_display_window_select_nth(PidginDisplayWindow *window, guint nth); 202 void pidgin_display_window_select_nth(PidginDisplayWindow *window, guint nth);
192 203
193 /** 204 /**
194 * pidgin_display_window_conversation_is_selected: 205 * pidgin_display_window_conversation_is_selected:
195 * @window: The conversation window instance. 206 * @window: The conversation window instance.
199 * 210 *
200 * Returns: %TRUE if @conversation is active. 211 * Returns: %TRUE if @conversation is active.
201 * 212 *
202 * Since: 3.0.0 213 * Since: 3.0.0
203 */ 214 */
215 PIDGIN_AVAILABLE_IN_3_0
204 gboolean pidgin_display_window_conversation_is_selected(PidginDisplayWindow *window, PurpleConversation *conversation); 216 gboolean pidgin_display_window_conversation_is_selected(PidginDisplayWindow *window, PurpleConversation *conversation);
205 217
206 G_END_DECLS 218 G_END_DECLS
207 219
208 #endif /* PIDGIN_DISPLAY_WINDOW_H */ 220 #endif /* PIDGIN_DISPLAY_WINDOW_H */

mercurial