pounce.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_POUNCE_H_
#define _PURPLE_POUNCE_H_
 
typedef struct _PurplePounce PurplePounce;
 
#include <glib.h>
#include "account.h"
 
typedef enum
{
    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  
} PurplePounceEvent;
 
typedef enum
{
    PURPLE_POUNCE_OPTION_NONE       = 0x00, 
    PURPLE_POUNCE_OPTION_AWAY       = 0x01  
} PurplePounceOption;
 
typedef void (*PurplePounceCb)(PurplePounce *, PurplePounceEvent, void *);
 
struct _PurplePounce
{
    char *ui_type;                
    PurplePounceEvent events;       
    PurplePounceOption options;     
    PurpleAccount *pouncer;         
    char *pouncee;                
    GHashTable *actions;          
    gboolean save;                
    void *data;                   
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
PurplePounce *purple_pounce_new(const char *ui_type, PurpleAccount *pouncer,
                            const char *pouncee, PurplePounceEvent event,
                            PurplePounceOption option);
 
void purple_pounce_destroy(PurplePounce *pounce);
 
void purple_pounce_destroy_all_by_account(PurpleAccount *account);
 
void purple_pounce_destroy_all_by_buddy(PurpleBuddy *buddy);
 
void purple_pounce_set_events(PurplePounce *pounce, PurplePounceEvent events);
 
void purple_pounce_set_options(PurplePounce *pounce, PurplePounceOption options);
 
void purple_pounce_set_pouncer(PurplePounce *pounce, PurpleAccount *pouncer);
 
void purple_pounce_set_pouncee(PurplePounce *pounce, const char *pouncee);
 
void purple_pounce_set_save(PurplePounce *pounce, gboolean save);
 
void purple_pounce_action_register(PurplePounce *pounce, const char *name);
 
void purple_pounce_action_set_enabled(PurplePounce *pounce, const char *action,
                                    gboolean enabled);
 
void purple_pounce_action_set_attribute(PurplePounce *pounce, const char *action,
                                      const char *attr, const char *value);
 
void purple_pounce_set_data(PurplePounce *pounce, void *data);
 
PurplePounceEvent purple_pounce_get_events(const PurplePounce *pounce);
 
PurplePounceOption purple_pounce_get_options(const PurplePounce *pounce);
 
PurpleAccount *purple_pounce_get_pouncer(const PurplePounce *pounce);
 
const char *purple_pounce_get_pouncee(const PurplePounce *pounce);
 
gboolean purple_pounce_get_save(const PurplePounce *pounce);
 
gboolean purple_pounce_action_is_enabled(const PurplePounce *pounce,
                                       const char *action);
 
const char *purple_pounce_action_get_attribute(const PurplePounce *pounce,
                                             const char *action,
                                             const char *attr);
 
void *purple_pounce_get_data(const PurplePounce *pounce);
 
void purple_pounce_execute(const PurpleAccount *pouncer, const char *pouncee,
                         PurplePounceEvent events);
 
/**************************************************************************/
/**************************************************************************/
PurplePounce *purple_find_pounce(const PurpleAccount *pouncer,
                             const char *pouncee, PurplePounceEvent events);
 
 
gboolean purple_pounces_load(void);
 
void purple_pounces_register_handler(const char *ui, PurplePounceCb cb,
                                   void (*new_pounce)(PurplePounce *pounce),
                                   void (*free_pounce)(PurplePounce *pounce));
 
void purple_pounces_unregister_handler(const char *ui);
 
GList *purple_pounces_get_all(void);
 
GList *purple_pounces_get_all_for_ui(const char *ui);
 
void *purple_pounces_get_handle(void);
 
void purple_pounces_init(void);
 
void purple_pounces_uninit(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_POUNCE_H_ */