savedstatuses.h

Go to the documentation of this file.

 
/* purple
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */
#ifndef _PURPLE_SAVEDSTATUSES_H_
#define _PURPLE_SAVEDSTATUSES_H_
 
/*
 * TODO: Hmm.  We should probably just be saving PurplePresences.  That's
 *       something we should look into once the status box gets fleshed
 *       out more.
 */
 
typedef struct _PurpleSavedStatus     PurpleSavedStatus;
typedef struct _PurpleSavedStatusSub  PurpleSavedStatusSub;
 
#include "status.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
PurpleSavedStatus *purple_savedstatus_new(const char *title,
                                      PurpleStatusPrimitive type);
 
void purple_savedstatus_set_title(PurpleSavedStatus *status,
                                const char *title);
 
void purple_savedstatus_set_type(PurpleSavedStatus *status,
                               PurpleStatusPrimitive type);
 
void purple_savedstatus_set_message(PurpleSavedStatus *status,
                                  const char *message);
 
void purple_savedstatus_set_substatus(PurpleSavedStatus *status,
                                    const PurpleAccount *account,
                                    const PurpleStatusType *type,
                                    const char *message);
 
void purple_savedstatus_unset_substatus(PurpleSavedStatus *saved_status,
                                                  const PurpleAccount *account);
 
gboolean purple_savedstatus_delete(const char *title);
 
void purple_savedstatus_delete_by_status(PurpleSavedStatus *saved_status);
 
GList *purple_savedstatuses_get_all(void);
 
GList *purple_savedstatuses_get_popular(unsigned int how_many);
 
PurpleSavedStatus *purple_savedstatus_get_current(void);
 
PurpleSavedStatus *purple_savedstatus_get_default(void);
 
PurpleSavedStatus *purple_savedstatus_get_idleaway(void);
 
gboolean purple_savedstatus_is_idleaway(void);
 
void purple_savedstatus_set_idleaway(gboolean idleaway);
 
PurpleSavedStatus *purple_savedstatus_get_startup(void);
 
PurpleSavedStatus *purple_savedstatus_find(const char *title);
 
PurpleSavedStatus *purple_savedstatus_find_by_creation_time(time_t creation_time);
 
PurpleSavedStatus *purple_savedstatus_find_transient_by_type_and_message(PurpleStatusPrimitive type, const char *message);
 
gboolean purple_savedstatus_is_transient(const PurpleSavedStatus *saved_status);
 
const char *purple_savedstatus_get_title(const PurpleSavedStatus *saved_status);
 
PurpleStatusPrimitive purple_savedstatus_get_type(const PurpleSavedStatus *saved_status);
 
const char *purple_savedstatus_get_message(const PurpleSavedStatus *saved_status);
 
time_t purple_savedstatus_get_creation_time(const PurpleSavedStatus *saved_status);
 
gboolean purple_savedstatus_has_substatuses(const PurpleSavedStatus *saved_status);
 
PurpleSavedStatusSub *purple_savedstatus_get_substatus(
                                    const PurpleSavedStatus *saved_status,
                                    const PurpleAccount *account);
 
const PurpleStatusType *purple_savedstatus_substatus_get_type(const PurpleSavedStatusSub *substatus);
 
const char *purple_savedstatus_substatus_get_message(const PurpleSavedStatusSub *substatus);
 
void purple_savedstatus_activate(PurpleSavedStatus *saved_status);
 
void purple_savedstatus_activate_for_account(const PurpleSavedStatus *saved_status, PurpleAccount *account);
 
void *purple_savedstatuses_get_handle(void);
 
void purple_savedstatuses_init(void);
 
void purple_savedstatuses_uninit(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_SAVEDSTATUSES_H_ */