Mercurial > pidgin.yaz

comparison src/savedstatuses.h @ 10419:c9b1f3fac753

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[gaim-migrate @ 11670] Added some GaimStatusPrimitive<-->text mapping functions Renamed the GaimStatusSaved data types to GaimSavedStatus Modifying a status will now bring up an editor thing with the correct values set committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Sun, 26 Dec 2004 02:03:14 +0000
parents bed2c96bc1fb
children 854c972ea863
comparison
equal deleted inserted replaced
10418:bed2c96bc1fb 10419:c9b1f3fac753
30 * could really be a plugin. It's just a list of away states. When 30 * could really be a plugin. It's just a list of away states. When
31 * a user chooses one of the saved states, their Gaim accounts are set 31 * a user chooses one of the saved states, their Gaim accounts are set
32 * to the settings of that state. 32 * to the settings of that state.
33 */ 33 */
34 34
35 typedef struct _GaimStatusSaved GaimStatusSaved; 35 typedef struct _GaimSavedStatus GaimSavedStatus;
36 typedef struct _GaimStatusSavedSub GaimStatusSavedSub; 36 typedef struct _GaimSavedStatusSub GaimSavedStatusSub;
37 37
38 /**************************************************************************/ 38 /**************************************************************************/
39 /** @name Saved status subsystem */ 39 /** @name Saved status subsystem */
40 /**************************************************************************/ 40 /**************************************************************************/
41 /*@{*/ 41 /*@{*/
47 * @param title The title of the saved status. This must be unique. 47 * @param title The title of the saved status. This must be unique.
48 * @param type The type of saved status. 48 * @param type The type of saved status.
49 * 49 *
50 * @return The newly created saved status. 50 * @return The newly created saved status.
51 */ 51 */
52 GaimStatusSaved *gaim_savedstatuses_new(const char *title, GaimStatusPrimitive type); 52 GaimSavedStatus *gaim_savedstatus_new(const char *title,
53 GaimStatusPrimitive type);
53 54
54 /** 55 /**
55 * Delete a saved status. This removes the saved status from the list 56 * Delete a saved status. This removes the saved status from the list
56 * of saved statuses, and writes the revised list to status.xml. 57 * of saved statuses, and writes the revised list to status.xml.
57 * 58 *
59 * 60 *
60 * @return TRUE if the status was successfully deleted. FALSE if the 61 * @return TRUE if the status was successfully deleted. FALSE if the
61 * status could not be deleted because no saved status exists 62 * status could not be deleted because no saved status exists
62 * with the given title. 63 * with the given title.
63 */ 64 */
64 gboolean gaim_savedstatuses_delete(const char *title); 65 gboolean gaim_savedstatus_delete(const char *title);
65 66
66 /** 67 /**
67 * Returns all saved statuses. 68 * Returns all saved statuses.
68 * 69 *
69 * @return A list of saved statuses. 70 * @return A list of saved statuses.
75 * 76 *
76 * @param title The name of the saved status. 77 * @param title The name of the saved status.
77 * 78 *
78 * @return The saved status if found, or NULL. 79 * @return The saved status if found, or NULL.
79 */ 80 */
80 GaimStatusSaved *gaim_savedstatuses_find(const char *title); 81 GaimSavedStatus *gaim_savedstatus_find(const char *title);
81
82 /**
83 * Create a new saved status and add it to the list
84 * of saved statuses.
85 *
86 * @param title The title for the new saved status.
87 * @param type The type of saved status.
88 *
89 * @return The newly created saved status.
90 */
91 GaimStatusSaved *gaim_savedstatuses_new(const char *title,
92 GaimStatusPrimitive type);
93 82
94 /** 83 /**
95 * Return the name of a given saved status. 84 * Return the name of a given saved status.
96 * 85 *
97 * @param saved_status The saved status. 86 * @param saved_status The saved status.
98 * 87 *
99 * @return The title. 88 * @return The title.
100 */ 89 */
101 const char *gaim_savedstatuses_get_title(const GaimStatusSaved *saved_status); 90 const char *gaim_savedstatus_get_title(const GaimSavedStatus *saved_status);
102 91
103 /** 92 /**
104 * Return the name of a given saved status. 93 * Return the name of a given saved status.
105 * 94 *
106 * @param saved_status The saved status. 95 * @param saved_status The saved status.
107 * 96 *
108 * @return The name. 97 * @return The name.
109 */ 98 */
110 GaimStatusPrimitive gaim_savedstatuses_get_type(const GaimStatusSaved *saved_status); 99 GaimStatusPrimitive gaim_savedstatus_get_type(const GaimSavedStatus *saved_status);
111 100
112 /** 101 /**
113 * Return the name of a given saved status. 102 * Return the name of a given saved status.
114 * 103 *
115 * @param saved_status The saved status. 104 * @param saved_status The saved status.
116 * 105 *
117 * @return The name. 106 * @return The name.
118 */ 107 */
119 const char *gaim_savedstatuses_get_message(const GaimStatusSaved *saved_status); 108 const char *gaim_savedstatus_get_message(const GaimSavedStatus *saved_status);
120 109
121 /** 110 /**
122 * Get the handle for the status subsystem. 111 * Get the handle for the status subsystem.
123 * 112 *
124 * @return the handle to the status subsystem 113 * @return the handle to the status subsystem