src/savedstatuses.h

changeset 14190
4d3fc3f58cc6
parent 13683
d523c24ed269
equal deleted inserted replaced
14189:74a8004419ec 14190:4d3fc3f58cc6
169 * GaimSavedStatuses must not be free'd). 169 * GaimSavedStatuses must not be free'd).
170 */ 170 */
171 GList *gaim_savedstatuses_get_popular(unsigned int how_many); 171 GList *gaim_savedstatuses_get_popular(unsigned int how_many);
172 172
173 /** 173 /**
174 * Returns the currently selected saved status. 174 * Returns the currently selected saved status. If we are idle
175 * then this returns gaim_savedstatus_get_idleaway(). Otherwise
176 * it returns gaim_savedstatus_get_default().
175 * 177 *
176 * @return A pointer to the in-use GaimSavedStatus. 178 * @return A pointer to the in-use GaimSavedStatus.
177 * This function never returns NULL. 179 * This function never returns NULL.
178 */ 180 */
179 GaimSavedStatus *gaim_savedstatus_get_current(void); 181 GaimSavedStatus *gaim_savedstatus_get_current(void);
180 182
181 /** 183 /**
182 * Returns the saved status that gets used when your 184 * Returns the default saved status that is used when our
185 * accounts are not idle-away.
186 *
187 * @return A pointer to the in-use GaimSavedStatus.
188 * This function never returns NULL.
189 */
190 GaimSavedStatus *gaim_savedstatus_get_default(void);
191
192 /**
193 * Returns the saved status that is used when your
183 * accounts become idle-away. 194 * accounts become idle-away.
184 * 195 *
185 * @return A pointer to the idle-away GaimSavedStatus. 196 * @return A pointer to the idle-away GaimSavedStatus.
186 * This function never returns NULL. 197 * This function never returns NULL.
187 */ 198 */
188 GaimSavedStatus *gaim_savedstatus_get_idleaway(void); 199 GaimSavedStatus *gaim_savedstatus_get_idleaway(void);
200
201 /**
202 * Return TRUE if we are currently idle-away. Otherwise
203 * returns FALSE.
204 *
205 * @return TRUE if our accounts have been set to idle-away.
206 */
207 gboolean gaim_savedstatus_is_idleaway(void);
208
209 /**
210 * Set whether accounts in Gaim are idle-away or not.
211 *
212 * @param TRUE if accounts should be switched to use the
213 * idle-away saved status. FALSE if they should
214 * be switched to use the default status.
215 */
216 void gaim_savedstatus_set_idleaway(gboolean idleaway);
189 217
190 /** 218 /**
191 * Returns the status to be used when gaim is starting up 219 * Returns the status to be used when gaim is starting up
192 * 220 *
193 * @return A pointer to the startup GaimSavedStatus. 221 * @return A pointer to the startup GaimSavedStatus.

mercurial