comparison: libpurple/conversation.h
libpurple/conversation.h
- branch
- soc.2013.gobjectification
- changeset 34609
- 28b0f26f011f
- parent 34608
- 3feba564faed
- child 34611
- 255148c286ab
equal
deleted
inserted
replaced
| 34608:3feba564faed | 34609:28b0f26f011f |
|---|---|
| 23 * along with this program; if not, write to the Free Software | 23 * along with this program; if not, write to the Free Software |
| 24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA | 24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
| 25 */ | 25 */ |
| 26 #ifndef _PURPLE_CONVERSATION_H_ | 26 #ifndef _PURPLE_CONVERSATION_H_ |
| 27 #define _PURPLE_CONVERSATION_H_ | 27 #define _PURPLE_CONVERSATION_H_ |
| 28 | |
| 29 #define PURPLE_TYPE_CONVERSATION (purple_conversation_get_type()) | |
| 30 #define PURPLE_CONVERSATION(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_CONVERSATION, PurpleConversation)) | |
| 31 #define PURPLE_CONVERSATION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_CONVERSATION, PurpleConversationClass)) | |
| 32 #define PURPLE_IS_CONVERSATION(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_CONVERSATION)) | |
| 33 #define PURPLE_IS_CONVERSATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_CONVERSATION)) | |
| 34 #define PURPLE_CONVERSATION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_CONVERSATION, PurpleConversationClass)) | |
| 28 | 35 |
| 29 /**************************************************************************/ | 36 /**************************************************************************/ |
| 30 /** Data Structures */ | 37 /** Data Structures */ |
| 31 /**************************************************************************/ | 38 /**************************************************************************/ |
| 32 | 39 |
| 240 /**************************************************************************/ | 247 /**************************************************************************/ |
| 241 /** @name Conversation API */ | 248 /** @name Conversation API */ |
| 242 /**************************************************************************/ | 249 /**************************************************************************/ |
| 243 /*@{*/ | 250 /*@{*/ |
| 244 | 251 |
| 245 /** TODO GObjectify | 252 /** TODO |
| 246 * Creates a new conversation of the specified type. | 253 * Returns the GType for the Conversation object. |
| 247 * | 254 */ |
| 248 * @param type The type of conversation. | 255 GType purple_conversation_get_type(void); |
| 249 * @param account The account opening the conversation window on the purple | |
| 250 * user's end. | |
| 251 * @param name The name of the conversation. For PURPLE_CONVERSATION_TYPE_IM, | |
| 252 * this is the name of the buddy. | |
| 253 * | |
| 254 * @return The new conversation. | |
| 255 */ | |
| 256 PurpleConversation *purple_conversation_new(GType type, PurpleAccount *account, | |
| 257 const char *name); | |
| 258 | 256 |
| 259 /** TODO dispose/fnalize | 257 /** TODO dispose/fnalize |
| 260 * Destroys the specified conversation and removes it from the parent | 258 * Destroys the specified conversation and removes it from the parent |
| 261 * window. | 259 * window. |
| 262 * | 260 * |
| 265 * | 263 * |
| 266 * @param conv The conversation to destroy. | 264 * @param conv The conversation to destroy. |
| 267 */ | 265 */ |
| 268 void purple_conversation_destroy(PurpleConversation *conv); | 266 void purple_conversation_destroy(PurpleConversation *conv); |
| 269 | 267 |
| 270 | |
| 271 /** | 268 /** |
| 272 * Present a conversation to the user. This allows core code to initiate a | 269 * Present a conversation to the user. This allows core code to initiate a |
| 273 * conversation by displaying the IM dialog. | 270 * conversation by displaying the IM dialog. |
| 274 * @param conv The conversation to present | 271 * @param conv The conversation to present |
| 275 */ | 272 */ |
| 276 void purple_conversation_present(PurpleConversation *conv); | 273 void purple_conversation_present(PurpleConversation *conv); |
| 277 | |
| 278 | |
| 279 /** TODO REMOVE, return the GObject GType | |
| 280 * Returns the specified conversation's type. | |
| 281 * | |
| 282 * @param conv The conversation. | |
| 283 * | |
| 284 * @return The conversation's type. | |
| 285 */ | |
| 286 /*PurpleConversationType purple_conversation_get_type(const PurpleConversation *conv);*/ | |
| 287 | 274 |
| 288 /** | 275 /** |
| 289 * Sets the specified conversation's UI operations structure. | 276 * Sets the specified conversation's UI operations structure. |
| 290 * | 277 * |
| 291 * @param conv The conversation. | 278 * @param conv The conversation. |
