purple. More...
#include <glib.h>
#include "account.h"
Include dependency graph for pounce.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
struct | _PurplePounce |
A buddy pounce structure. More... | |
Buddy Pounce API | |
PurplePounce * | purple_pounce_new (const char *ui_type, PurpleAccount *pouncer, const char *pouncee, PurplePounceEvent event, PurplePounceOption option) |
Creates a new buddy pounce. | |
void | purple_pounce_destroy (PurplePounce *pounce) |
Destroys a buddy pounce. | |
void | purple_pounce_destroy_all_by_account (PurpleAccount *account) |
Destroys all buddy pounces for the account. | |
void | purple_pounce_set_events (PurplePounce *pounce, PurplePounceEvent events) |
Sets the events a pounce should watch for. | |
void | purple_pounce_set_options (PurplePounce *pounce, PurplePounceOption options) |
Sets the options for a pounce. | |
void | purple_pounce_set_pouncer (PurplePounce *pounce, PurpleAccount *pouncer) |
Sets the account that will do the pouncing. | |
void | purple_pounce_set_pouncee (PurplePounce *pounce, const char *pouncee) |
Sets the buddy a pounce should pounce on. | |
void | purple_pounce_set_save (PurplePounce *pounce, gboolean save) |
Sets whether or not the pounce should be saved after execution. | |
void | purple_pounce_action_register (PurplePounce *pounce, const char *name) |
Registers an action type for the pounce. | |
void | purple_pounce_action_set_enabled (PurplePounce *pounce, const char *action, gboolean enabled) |
Enables or disables an action for a pounce. | |
void | purple_pounce_action_set_attribute (PurplePounce *pounce, const char *action, const char *attr, const char *value) |
Sets a value for an attribute in an action. | |
void | purple_pounce_set_data (PurplePounce *pounce, void *data) |
Sets the pounce-specific data. | |
PurplePounceEvent | purple_pounce_get_events (const PurplePounce *pounce) |
Returns the events a pounce should watch for. | |
PurplePounceOption | purple_pounce_get_options (const PurplePounce *pounce) |
Returns the options for a pounce. | |
PurpleAccount * | purple_pounce_get_pouncer (const PurplePounce *pounce) |
Returns the account that will do the pouncing. | |
const char * | purple_pounce_get_pouncee (const PurplePounce *pounce) |
Returns the buddy a pounce should pounce on. | |
gboolean | purple_pounce_get_save (const PurplePounce *pounce) |
Returns whether or not the pounce should save after execution. | |
gboolean | purple_pounce_action_is_enabled (const PurplePounce *pounce, const char *action) |
Returns whether or not an action is enabled. | |
const char * | purple_pounce_action_get_attribute (const PurplePounce *pounce, const char *action, const char *attr) |
Returns the value for an attribute in an action. | |
void * | purple_pounce_get_data (const PurplePounce *pounce) |
Returns the pounce-specific data. | |
void | purple_pounce_execute (const PurpleAccount *pouncer, const char *pouncee, PurplePounceEvent events) |
Executes a pounce with the specified pouncer, pouncee, and event type. | |
Buddy Pounce Subsystem API | |
PurplePounce * | purple_find_pounce (const PurpleAccount *pouncer, const char *pouncee, PurplePounceEvent events) |
Finds a pounce with the specified event(s) and buddy. | |
gboolean | purple_pounces_load (void) |
Loads the pounces. | |
void | purple_pounces_register_handler (const char *ui, PurplePounceCb cb, void(*new_pounce)(PurplePounce *pounce), void(*free_pounce)(PurplePounce *pounce)) |
Registers a pounce handler for a UI. | |
void | purple_pounces_unregister_handler (const char *ui) |
Unregisters a pounce handle for a UI. | |
GList * | purple_pounces_get_all (void) |
Returns a list of all registered buddy pounces. | |
GList * | purple_pounces_get_all_for_ui (const char *ui) |
Returns a list of registered buddy pounces for the ui-type. | |
void * | purple_pounces_get_handle (void) |
Returns the buddy pounce subsystem handle. | |
void | purple_pounces_init (void) |
Initializes the pounces subsystem. | |
void | purple_pounces_uninit (void) |
Uninitializes the pounces subsystem. | |
Typedefs | |
typedef _PurplePounce | PurplePounce |
typedef void(* | PurplePounceCb )(PurplePounce *, PurplePounceEvent, void *) |
A pounce callback. | |
Enumerations | |
enum | PurplePounceEvent { PURPLE_POUNCE_NONE = 0x000, PURPLE_POUNCE_SIGNON = 0x001, PURPLE_POUNCE_SIGNOFF = 0x002, PURPLE_POUNCE_AWAY = 0x004, PURPLE_POUNCE_AWAY_RETURN = 0x008, PURPLE_POUNCE_IDLE = 0x010, PURPLE_POUNCE_IDLE_RETURN = 0x020, PURPLE_POUNCE_TYPING = 0x040, PURPLE_POUNCE_TYPED = 0x080, PURPLE_POUNCE_TYPING_STOPPED = 0x100, PURPLE_POUNCE_MESSAGE_RECEIVED = 0x200 } |
Events that trigger buddy pounces. More... | |
enum | PurplePounceOption { PURPLE_POUNCE_OPTION_NONE = 0x00, PURPLE_POUNCE_OPTION_AWAY = 0x01 } |
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
|
|
|
|
Finds a pounce with the specified event(s) and buddy.
|
|
Returns the value for an attribute in an action.
|
|
Returns whether or not an action is enabled.
|
|
Registers an action type for the pounce.
|
|
Sets a value for an attribute in an action.
If value is
|
|
Enables or disables an action for a pounce.
|
|
Destroys a buddy pounce.
|
|
Destroys all buddy pounces for the account.
|
|
Executes a pounce with the specified pouncer, pouncee, and event type.
|
|
Returns the pounce-specific data.
|
|
Returns the events a pounce should watch for.
|
|
Returns the options for a pounce.
|
|
Returns the buddy a pounce should pounce on.
|
|
Returns the account that will do the pouncing.
|
|
Returns whether or not the pounce should save after execution.
|
|
Creates a new buddy pounce.
|
|
Sets the pounce-specific data.
|
|
Sets the events a pounce should watch for.
|
|
Sets the options for a pounce.
|
|
Sets the buddy a pounce should pounce on.
|
|
Sets the account that will do the pouncing.
|
|
Sets whether or not the pounce should be saved after execution.
|
|
Returns a list of all registered buddy pounces.
|
|
Returns a list of registered buddy pounces for the ui-type.
|
|
Returns the buddy pounce subsystem handle.
|
|
Loads the pounces.
|
|
Registers a pounce handler for a UI.
|
|
Unregisters a pounce handle for a UI.
|