purple. More...
#include "status.h"
Include dependency graph for savedstatuses.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Saved status subsystem | |
PurpleSavedStatus * | purple_savedstatus_new (const char *title, PurpleStatusPrimitive type) |
Create a new saved status. | |
void | purple_savedstatus_set_title (PurpleSavedStatus *status, const char *title) |
Set the title for the given saved status. | |
void | purple_savedstatus_set_type (PurpleSavedStatus *status, PurpleStatusPrimitive type) |
Set the type for the given saved status. | |
void | purple_savedstatus_set_message (PurpleSavedStatus *status, const char *message) |
Set the message for the given saved status. | |
void | purple_savedstatus_set_substatus (PurpleSavedStatus *status, const PurpleAccount *account, const PurpleStatusType *type, const char *message) |
Set a substatus for an account in a saved status. | |
void | purple_savedstatus_unset_substatus (PurpleSavedStatus *saved_status, const PurpleAccount *account) |
Unset a substatus for an account in a saved status. | |
gboolean | purple_savedstatus_delete (const char *title) |
Delete a saved status. | |
void | purple_savedstatus_delete_by_status (PurpleSavedStatus *saved_status) |
Delete a saved status. | |
GList * | purple_savedstatuses_get_all (void) |
Returns all saved statuses. | |
GList * | purple_savedstatuses_get_popular (unsigned int how_many) |
Returns the n most popular saved statuses. | |
PurpleSavedStatus * | purple_savedstatus_get_current (void) |
Returns the currently selected saved status. | |
PurpleSavedStatus * | purple_savedstatus_get_default (void) |
Returns the default saved status that is used when our accounts are not idle-away. | |
PurpleSavedStatus * | purple_savedstatus_get_idleaway (void) |
Returns the saved status that is used when your accounts become idle-away. | |
gboolean | purple_savedstatus_is_idleaway (void) |
Return TRUE if we are currently idle-away. | |
void | purple_savedstatus_set_idleaway (gboolean idleaway) |
Set whether accounts in Purple are idle-away or not. | |
PurpleSavedStatus * | purple_savedstatus_get_startup (void) |
Returns the status to be used when purple is starting up. | |
PurpleSavedStatus * | purple_savedstatus_find (const char *title) |
Finds a saved status with the specified title. | |
PurpleSavedStatus * | purple_savedstatus_find_by_creation_time (time_t creation_time) |
Finds a saved status with the specified creation time. | |
PurpleSavedStatus * | purple_savedstatus_find_transient_by_type_and_message (PurpleStatusPrimitive type, const char *message) |
Finds a saved status with the specified primitive and message. | |
gboolean | purple_savedstatus_is_transient (const PurpleSavedStatus *saved_status) |
Determines if a given saved status is "transient." A transient saved status is one that was not explicitly added by the user. | |
const char * | purple_savedstatus_get_title (const PurpleSavedStatus *saved_status) |
Return the name of a given saved status. | |
PurpleStatusPrimitive | purple_savedstatus_get_type (const PurpleSavedStatus *saved_status) |
Return the type of a given saved status. | |
const char * | purple_savedstatus_get_message (const PurpleSavedStatus *saved_status) |
Return the default message of a given saved status. | |
time_t | purple_savedstatus_get_creation_time (const PurpleSavedStatus *saved_status) |
Return the time in seconds-since-the-epoch when this saved status was created. | |
gboolean | purple_savedstatus_has_substatuses (const PurpleSavedStatus *saved_status) |
Determine if a given saved status has "substatuses," or if it is a simple status (the same for all accounts). | |
PurpleSavedStatusSub * | purple_savedstatus_get_substatus (const PurpleSavedStatus *saved_status, const PurpleAccount *account) |
Get the substatus for an account in a saved status. | |
const PurpleStatusType * | purple_savedstatus_substatus_get_type (const PurpleSavedStatusSub *substatus) |
Get the status type of a given substatus. | |
const char * | purple_savedstatus_substatus_get_message (const PurpleSavedStatusSub *substatus) |
Get the message of a given substatus. | |
void | purple_savedstatus_activate (PurpleSavedStatus *saved_status) |
Sets the statuses for all your accounts to those specified by the given saved_status. | |
void | purple_savedstatus_activate_for_account (const PurpleSavedStatus *saved_status, PurpleAccount *account) |
Sets the statuses for a given account to those specified by the given saved_status. | |
void * | purple_savedstatuses_get_handle (void) |
Get the handle for the status subsystem. | |
void | purple_savedstatuses_init (void) |
Initializes the status subsystem. | |
void | purple_savedstatuses_uninit (void) |
Uninitializes the status subsystem. | |
Typedefs | |
typedef _PurpleSavedStatus | PurpleSavedStatus |
Saved statuses don't really interact much with the rest of Purple. | |
typedef _PurpleSavedStatusSub | PurpleSavedStatusSub |
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
Saved statuses don't really interact much with the rest of Purple. It could really be a plugin. It's just a list of away states. When a user chooses one of the saved states, their Purple accounts are set to the settings of that state. In the savedstatus API, there is the concept of a 'transient' saved status. A transient saved status is one that is not permanent. Purple will removed it automatically if it isn't used for a period of time. Transient saved statuses don't have titles and they don't show up in the list of saved statuses. In fact, if a saved status does not have a title then it is transient. If it does have a title, then it is not transient. What good is a transient status, you ask? They can be used to keep track of the user's 5 most recently used statuses, for example. Basically if they just set a message on the fly, we'll cache it for them in case they want to use it again. If they don't use it again, we'll just delete it. |
|
Sets the statuses for all your accounts to those specified by the given saved_status. This function calls purple_savedstatus_activate_for_account() for all your accounts.
|
|
Sets the statuses for a given account to those specified by the given saved_status.
|
|
Delete a saved status. This removes the saved status from the list of saved statuses, and writes the revised list to status.xml.
|
|
Delete a saved status. This removes the saved status from the list of saved statuses, and writes the revised list to status.xml.
|
|
Finds a saved status with the specified title.
|
|
Finds a saved status with the specified creation time.
|
|
Finds a saved status with the specified primitive and message.
|
|
Return the time in seconds-since-the-epoch when this saved status was created. Note: For any status created by Purple 1.5.0 or older this value will be invalid and very small (close to 0). This is because Purple 1.5.0 and older did not record the timestamp when the status was created. However, this value is guaranteed to be a unique identifier for the given saved status.
|
|
Returns the currently selected saved status. If we are idle then this returns purple_savedstatus_get_idleaway(). Otherwise it returns purple_savedstatus_get_default().
|
|
Returns the default saved status that is used when our accounts are not idle-away.
|
|
Returns the saved status that is used when your accounts become idle-away.
|
|
Return the default message of a given saved status.
|
|
Returns the status to be used when purple is starting up.
|
|
Get the substatus for an account in a saved status.
|
|
Return the name of a given saved status.
|
|
Return the type of a given saved status.
|
|
Determine if a given saved status has "substatuses," or if it is a simple status (the same for all accounts).
|
|
Return TRUE if we are currently idle-away. Otherwise returns FALSE.
|
|
Determines if a given saved status is "transient." A transient saved status is one that was not explicitly added by the user. Transient statuses are automatically removed if they are not used for a period of time. A transient saved statuses is automatically created by the status box when the user sets himself to one of the generic primitive statuses. The reason we need to save this status information is so we can restore it when Purple restarts.
|
|
Create a new saved status. This will add the saved status to the list of saved statuses and writes the revised list to status.xml.
|
|
Set whether accounts in Purple are idle-away or not.
|
|
Set the message for the given saved status.
|
|
Set a substatus for an account in a saved status.
|
|
Set the title for the given saved status.
|
|
Set the type for the given saved status.
|
|
Get the message of a given substatus.
|
|
Get the status type of a given substatus.
|
|
Unset a substatus for an account in a saved status. This clears the previosly set substatus for the PurpleSavedStatus. If this saved status is activated then this account will use the default status type and message.
|
|
Returns all saved statuses. A list of saved statuses. |
|
Get the handle for the status subsystem.
|
|
Returns the n most popular saved statuses. "Popularity" is determined by when the last time a saved_status was used and how many times it has been used. If the current status would normally show up in this list, then it is omited and instead the "how_many+1" saved status will appear in the list. Also transient statuses without messages are not included in the list.
|