comparison: libpurple/savedstatuses.h
libpurple/savedstatuses.h
- branch
- gtkdoc-conversion
- changeset 35475
- ec0d44434ba8
- parent 35472
- 474e26199560
- parent 35378
- 5d9e2581005b
- child 35486
- fe9a7f6143c1
- child 37075
- cf3f735b09b7
equal
deleted
inserted
replaced
| 35474:ff5eccb9f797 | 35475:ec0d44434ba8 |
|---|---|
| 27 */ | 27 */ |
| 28 | 28 |
| 29 #ifndef _PURPLE_SAVEDSTATUSES_H_ | 29 #ifndef _PURPLE_SAVEDSTATUSES_H_ |
| 30 #define _PURPLE_SAVEDSTATUSES_H_ | 30 #define _PURPLE_SAVEDSTATUSES_H_ |
| 31 | 31 |
| 32 #define PURPLE_TYPE_SAVEDSTATUS (purple_savedstatus_get_g_type()) | 32 #define PURPLE_TYPE_SAVEDSTATUS (purple_savedstatus_get_type()) |
| 33 | 33 |
| 34 /** | 34 /** |
| 35 * PurpleSavedStatus: | 35 * PurpleSavedStatus: |
| 36 * | 36 * |
| 37 * Saved statuses don't really interact much with the rest of Purple. It | 37 * Saved statuses don't really interact much with the rest of Purple. It |
| 71 /* Saved status subsystem */ | 71 /* Saved status subsystem */ |
| 72 /**************************************************************************/ | 72 /**************************************************************************/ |
| 73 /*@{*/ | 73 /*@{*/ |
| 74 | 74 |
| 75 /** | 75 /** |
| 76 * purple_savedstatus_get_g_type: | 76 * purple_savedstatus_get_type: |
| 77 * | 77 * |
| 78 * Returns: The #GType for the #PurpleSavedStatus boxed structure. | 78 * Returns: The #GType for the #PurpleSavedStatus boxed structure. |
| 79 */ | 79 */ |
| 80 /* TODO Boxing of PurpleSavedStatus is a temporary solution to having a GType | 80 /* TODO Boxing of PurpleSavedStatus is a temporary solution to having a GType |
| 81 * for saved statuses. This should rather be a GObject instead of a GBoxed. | 81 * for saved statuses. This should rather be a GObject instead of a GBoxed. |
| 82 */ | 82 */ |
| 83 GType purple_savedstatus_get_g_type(void); | 83 GType purple_savedstatus_get_type(void); |
| 84 | 84 |
| 85 /** | 85 /** |
| 86 * purple_savedstatus_new: | 86 * purple_savedstatus_new: |
| 87 * @title: The title of the saved status. This must be | 87 * @title: The title of the saved status. This must be |
| 88 * unique. Or, if you want to create a transient | 88 * unique. Or, if you want to create a transient |
| 107 */ | 107 */ |
| 108 void purple_savedstatus_set_title(PurpleSavedStatus *status, | 108 void purple_savedstatus_set_title(PurpleSavedStatus *status, |
| 109 const char *title); | 109 const char *title); |
| 110 | 110 |
| 111 /** | 111 /** |
| 112 * purple_savedstatus_set_type: | 112 * purple_savedstatus_set_primitive_type: |
| 113 * @status: The saved status. | 113 * @status: The saved status. |
| 114 * @type: The type of saved status. | 114 * @type: The type of saved status. |
| 115 * | 115 * |
| 116 * Set the type for the given saved status. | 116 * Set the type for the given saved status. |
| 117 */ | 117 */ |
| 118 void purple_savedstatus_set_type(PurpleSavedStatus *status, | 118 void purple_savedstatus_set_primitive_type(PurpleSavedStatus *status, |
| 119 PurpleStatusPrimitive type); | 119 PurpleStatusPrimitive type); |
| 120 | 120 |
| 121 /** | 121 /** |
| 122 * purple_savedstatus_set_message: | 122 * purple_savedstatus_set_message: |
| 123 * @status: The saved status. | 123 * @status: The saved status. |
| 131 | 131 |
| 132 /** | 132 /** |
| 133 * purple_savedstatus_set_substatus: | 133 * purple_savedstatus_set_substatus: |
| 134 * @status: The saved status. | 134 * @status: The saved status. |
| 135 * @account: The account. | 135 * @account: The account. |
| 136 * @type: The status type for the account in the staved | 136 * @type: The status type for the account in the saved |
| 137 * status. | 137 * status. |
| 138 * @message: The message for the account in the substatus. | 138 * @message: The message for the account in the substatus. |
| 139 * | 139 * |
| 140 * Set a substatus for an account in a saved status. | 140 * Set a substatus for an account in a saved status. |
| 141 */ | 141 */ |
| 337 * you should make a copy of it. | 337 * you should make a copy of it. |
| 338 */ | 338 */ |
| 339 const char *purple_savedstatus_get_title(const PurpleSavedStatus *saved_status); | 339 const char *purple_savedstatus_get_title(const PurpleSavedStatus *saved_status); |
| 340 | 340 |
| 341 /** | 341 /** |
| 342 * purple_savedstatus_get_type: | 342 * purple_savedstatus_get_primitive_type: |
| 343 * @saved_status: The saved status. | 343 * @saved_status: The saved status. |
| 344 * | 344 * |
| 345 * Return the type of a given saved status. | 345 * Return the type of a given saved status. |
| 346 * | 346 * |
| 347 * Returns: The primitive type. | 347 * Returns: The primitive type. |
| 348 */ | 348 */ |
| 349 PurpleStatusPrimitive purple_savedstatus_get_type(const PurpleSavedStatus *saved_status); | 349 PurpleStatusPrimitive purple_savedstatus_get_primitive_type(const PurpleSavedStatus *saved_status); |
| 350 | 350 |
| 351 /** | 351 /** |
| 352 * purple_savedstatus_get_message: | 352 * purple_savedstatus_get_message: |
| 353 * @saved_status: The saved status. | 353 * @saved_status: The saved status. |
| 354 * | 354 * |
| 406 PurpleSavedStatusSub *purple_savedstatus_get_substatus( | 406 PurpleSavedStatusSub *purple_savedstatus_get_substatus( |
| 407 const PurpleSavedStatus *saved_status, | 407 const PurpleSavedStatus *saved_status, |
| 408 const PurpleAccount *account); | 408 const PurpleAccount *account); |
| 409 | 409 |
| 410 /** | 410 /** |
| 411 * purple_savedstatus_substatus_get_type: | 411 * purple_savedstatus_substatus_get_status_type: |
| 412 * @substatus: The substatus. | 412 * @substatus: The substatus. |
| 413 * | 413 * |
| 414 * Get the status type of a given substatus. | 414 * Get the status type of a given substatus. |
| 415 * | 415 * |
| 416 * Returns: The status type. | 416 * Returns: The status type. |
| 417 */ | 417 */ |
| 418 const PurpleStatusType *purple_savedstatus_substatus_get_type(const PurpleSavedStatusSub *substatus); | 418 const PurpleStatusType *purple_savedstatus_substatus_get_status_type( |
| 419 const PurpleSavedStatusSub *substatus); | |
| 419 | 420 |
| 420 /** | 421 /** |
| 421 * purple_savedstatus_substatus_get_message: | 422 * purple_savedstatus_substatus_get_message: |
| 422 * @substatus: The substatus. | 423 * @substatus: The substatus. |
| 423 * | 424 * |
