comparison: pidgin/gtkconv.h
pidgin/gtkconv.h
- branch
- gtkdoc-conversion
- changeset 35393
- 00f876b129bc
- parent 35117
- 97f98eebab48
- child 35415
- ba28be1a7611
- child 37035
- e85ed7f4d6e3
equal
deleted
inserted
replaced
| 35392:cc123f0d84af | 35393:00f876b129bc |
|---|---|
| 154 /*@{*/ | 154 /*@{*/ |
| 155 | 155 |
| 156 /** | 156 /** |
| 157 * Returns the UI operations structure for GTK+ conversations. | 157 * Returns the UI operations structure for GTK+ conversations. |
| 158 * | 158 * |
| 159 * @return The GTK+ conversation operations structure. | 159 * Returns: The GTK+ conversation operations structure. |
| 160 */ | 160 */ |
| 161 PurpleConversationUiOps *pidgin_conversations_get_conv_ui_ops(void); | 161 PurpleConversationUiOps *pidgin_conversations_get_conv_ui_ops(void); |
| 162 | 162 |
| 163 /** | 163 /** |
| 164 * Returns the default theme for GTK+ conversations. | 164 * Returns the default theme for GTK+ conversations. |
| 165 * | 165 * |
| 166 * @return The default GTK+ conversation theme. | 166 * Returns: The default GTK+ conversation theme. |
| 167 */ | 167 */ |
| 168 PurpleTheme *pidgin_conversations_get_default_theme(void); | 168 PurpleTheme *pidgin_conversations_get_default_theme(void); |
| 169 | 169 |
| 170 /** | 170 /** |
| 171 * Updates the buddy icon on a conversation. | 171 * Updates the buddy icon on a conversation. |
| 172 * | 172 * |
| 173 * @param conv The conversation. | 173 * @conv: The conversation. |
| 174 */ | 174 */ |
| 175 void pidgin_conv_update_buddy_icon(PurpleIMConversation *im); | 175 void pidgin_conv_update_buddy_icon(PurpleIMConversation *im); |
| 176 | 176 |
| 177 /** | 177 /** |
| 178 * Sets the active conversation within a GTK-conversation. | 178 * Sets the active conversation within a GTK-conversation. |
| 179 * | 179 * |
| 180 * @param conv The conversation | 180 * @conv: The conversation |
| 181 */ | 181 */ |
| 182 void pidgin_conv_switch_active_conversation(PurpleConversation *conv); | 182 void pidgin_conv_switch_active_conversation(PurpleConversation *conv); |
| 183 | 183 |
| 184 /** | 184 /** |
| 185 * Updates conversation buttons by protocol. | 185 * Updates conversation buttons by protocol. |
| 186 * | 186 * |
| 187 * @param conv The conversation. | 187 * @conv: The conversation. |
| 188 */ | 188 */ |
| 189 void pidgin_conv_update_buttons_by_protocol(PurpleConversation *conv); | 189 void pidgin_conv_update_buttons_by_protocol(PurpleConversation *conv); |
| 190 | 190 |
| 191 /** | 191 /** |
| 192 * Returns a list of conversations of any type which have an unseen | 192 * Returns a list of conversations of any type which have an unseen |
| 194 * hidden_only parameter, this search can be limited to hidden | 194 * hidden_only parameter, this search can be limited to hidden |
| 195 * conversations. The max_count parameter will limit the total number of | 195 * conversations. The max_count parameter will limit the total number of |
| 196 * converations returned if greater than zero. The returned list should | 196 * converations returned if greater than zero. The returned list should |
| 197 * be freed by the caller. | 197 * be freed by the caller. |
| 198 * | 198 * |
| 199 * @param min_state The minimum unseen state. | 199 * @min_state: The minimum unseen state. |
| 200 * @param hidden_only If TRUE, only consider hidden conversations. | 200 * @hidden_only: If TRUE, only consider hidden conversations. |
| 201 * @param max_count Maximum number of conversations to return, or 0 for | 201 * @max_count: Maximum number of conversations to return, or 0 for |
| 202 * no maximum. | 202 * no maximum. |
| 203 * @return List of PurpleConversation matching criteria, or NULL. | 203 * Returns: List of PurpleConversation matching criteria, or NULL. |
| 204 */ | 204 */ |
| 205 GList * | 205 GList * |
| 206 pidgin_conversations_get_unseen_all(PidginUnseenState min_state, | 206 pidgin_conversations_get_unseen_all(PidginUnseenState min_state, |
| 207 gboolean hidden_only, | 207 gboolean hidden_only, |
| 208 guint max_count); | 208 guint max_count); |
| 213 * parameter, this search can be limited to hidden IM conversations. The | 213 * parameter, this search can be limited to hidden IM conversations. The |
| 214 * max_count parameter will limit the total number of IM converations | 214 * max_count parameter will limit the total number of IM converations |
| 215 * returned if greater than zero. The returned list should be freed by the | 215 * returned if greater than zero. The returned list should be freed by the |
| 216 * caller. | 216 * caller. |
| 217 * | 217 * |
| 218 * @param min_state The minimum unseen state. | 218 * @min_state: The minimum unseen state. |
| 219 * @param hidden_only If TRUE, only consider hidden conversations. | 219 * @hidden_only: If TRUE, only consider hidden conversations. |
| 220 * @param max_count Maximum number of conversations to return, or 0 for | 220 * @max_count: Maximum number of conversations to return, or 0 for |
| 221 * no maximum. | 221 * no maximum. |
| 222 * @return List of PurpleIMConversation matching criteria, | 222 * Returns: List of PurpleIMConversation matching criteria, |
| 223 * or NULL. | 223 * or NULL. |
| 224 */ | 224 */ |
| 225 GList * | 225 GList * |
| 226 pidgin_conversations_get_unseen_ims(PidginUnseenState min_state, | 226 pidgin_conversations_get_unseen_ims(PidginUnseenState min_state, |
| 227 gboolean hidden_only, | 227 gboolean hidden_only, |
| 233 * parameter, this search can be limited to hidden chat conversations. The | 233 * parameter, this search can be limited to hidden chat conversations. The |
| 234 * max_count parameter will limit the total number of chat converations | 234 * max_count parameter will limit the total number of chat converations |
| 235 * returned if greater than zero. The returned list should be freed by the | 235 * returned if greater than zero. The returned list should be freed by the |
| 236 * caller. | 236 * caller. |
| 237 * | 237 * |
| 238 * @param min_state The minimum unseen state. | 238 * @min_state: The minimum unseen state. |
| 239 * @param hidden_only If TRUE, only consider hidden conversations. | 239 * @hidden_only: If TRUE, only consider hidden conversations. |
| 240 * @param max_count Maximum number of conversations to return, or 0 for | 240 * @max_count: Maximum number of conversations to return, or 0 for |
| 241 * no maximum. | 241 * no maximum. |
| 242 * @return List of PurpleChatConversation matching criteria, | 242 * Returns: List of PurpleChatConversation matching criteria, |
| 243 * or NULL. | 243 * or NULL. |
| 244 */ | 244 */ |
| 245 GList * | 245 GList * |
| 246 pidgin_conversations_get_unseen_chats(PidginUnseenState min_state, | 246 pidgin_conversations_get_unseen_chats(PidginUnseenState min_state, |
| 247 gboolean hidden_only, | 247 gboolean hidden_only, |
| 249 | 249 |
| 250 /** | 250 /** |
| 251 * Fill a menu with a list of conversations. Clicking the conversation | 251 * Fill a menu with a list of conversations. Clicking the conversation |
| 252 * menu item will present that conversation to the user. | 252 * menu item will present that conversation to the user. |
| 253 * | 253 * |
| 254 * @param menu Menu widget to add items to. | 254 * @menu: Menu widget to add items to. |
| 255 * @param convs List of PurpleConversation to add to menu. | 255 * @convs: List of PurpleConversation to add to menu. |
| 256 * @return Number of conversations added to menu. | 256 * Returns: Number of conversations added to menu. |
| 257 */ | 257 */ |
| 258 guint | 258 guint |
| 259 pidgin_conversations_fill_menu(GtkWidget *menu, GList *convs); | 259 pidgin_conversations_fill_menu(GtkWidget *menu, GList *convs); |
| 260 | 260 |
| 261 /** | 261 /** |
| 262 * Presents a purple conversation to the user. | 262 * Presents a purple conversation to the user. |
| 263 * | 263 * |
| 264 * @param conv The conversation. | 264 * @conv: The conversation. |
| 265 */ | 265 */ |
| 266 void pidgin_conv_present_conversation(PurpleConversation *conv); | 266 void pidgin_conv_present_conversation(PurpleConversation *conv); |
| 267 | 267 |
| 268 /** | 268 /** |
| 269 * Reattach Pidgin UI to a conversation. | 269 * Reattach Pidgin UI to a conversation. |
| 270 * | 270 * |
| 271 * @param conv The conversation. | 271 * @conv: The conversation. |
| 272 * | 272 * |
| 273 * @return Wheter Pidgin UI was successfully attached. | 273 * Returns: Wheter Pidgin UI was successfully attached. |
| 274 */ | 274 */ |
| 275 gboolean pidgin_conv_attach_to_conversation(PurpleConversation *conv); | 275 gboolean pidgin_conv_attach_to_conversation(PurpleConversation *conv); |
| 276 | 276 |
| 277 PidginWindow *pidgin_conv_get_window(PidginConversation *gtkconv); | 277 PidginWindow *pidgin_conv_get_window(PidginConversation *gtkconv); |
| 278 GdkPixbuf *pidgin_conv_get_tab_icon(PurpleConversation *conv, gboolean small_icon); | 278 GdkPixbuf *pidgin_conv_get_tab_icon(PurpleConversation *conv, gboolean small_icon); |
| 287 /*@{*/ | 287 /*@{*/ |
| 288 | 288 |
| 289 /** | 289 /** |
| 290 * Returns the gtk conversations subsystem handle. | 290 * Returns the gtk conversations subsystem handle. |
| 291 * | 291 * |
| 292 * @return The conversations subsystem handle. | 292 * Returns: The conversations subsystem handle. |
| 293 */ | 293 */ |
| 294 void *pidgin_conversations_get_handle(void); | 294 void *pidgin_conversations_get_handle(void); |
| 295 | 295 |
| 296 /** | 296 /** |
| 297 * Initializes the GTK+ conversations subsystem. | 297 * Initializes the GTK+ conversations subsystem. |
