1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/Frameworks/libpurple.framework/Versions/0.6.2/Headers/idle.h Fri Aug 21 13:25:11 2009 -0700
1.3 @@ -0,0 +1,104 @@
1.4 +/**
1.5 + * @file idle.h Idle API
1.6 + * @ingroup core
1.7 + */
1.8 +
1.9 +/* purple
1.10 + *
1.11 + * Purple is the legal property of its developers, whose names are too numerous
1.12 + * to list here. Please refer to the COPYRIGHT file distributed with this
1.13 + * source distribution.
1.14 + *
1.15 + * This program is free software; you can redistribute it and/or modify
1.16 + * it under the terms of the GNU General Public License as published by
1.17 + * the Free Software Foundation; either version 2 of the License, or
1.18 + * (at your option) any later version.
1.19 + *
1.20 + * This program is distributed in the hope that it will be useful,
1.21 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
1.22 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1.23 + * GNU General Public License for more details.
1.24 + *
1.25 + * You should have received a copy of the GNU General Public License
1.26 + * along with this program; if not, write to the Free Software
1.27 + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
1.28 + */
1.29 +#ifndef _PURPLE_IDLE_H_
1.30 +#define _PURPLE_IDLE_H_
1.31 +
1.32 +#include <time.h>
1.33 +
1.34 +/**
1.35 + * Idle UI operations.
1.36 + */
1.37 +typedef struct
1.38 +{
1.39 + time_t (*get_time_idle)(void);
1.40 +
1.41 + void (*_purple_reserved1)(void);
1.42 + void (*_purple_reserved2)(void);
1.43 + void (*_purple_reserved3)(void);
1.44 + void (*_purple_reserved4)(void);
1.45 +} PurpleIdleUiOps;
1.46 +
1.47 +#ifdef __cplusplus
1.48 +extern "C" {
1.49 +#endif
1.50 +
1.51 +/**************************************************************************/
1.52 +/** @name Idle API */
1.53 +/**************************************************************************/
1.54 +/*@{*/
1.55 +
1.56 +/**
1.57 + * Touch our idle tracker. This signifies that the user is
1.58 + * 'active'. The conversation code calls this when the
1.59 + * user sends an IM, for example.
1.60 + */
1.61 +void purple_idle_touch(void);
1.62 +
1.63 +/**
1.64 + * Fake our idle time by setting the time at which our
1.65 + * accounts purportedly became idle. This is used by
1.66 + * the I'dle Mak'er plugin.
1.67 + */
1.68 +void purple_idle_set(time_t time);
1.69 +
1.70 +/*@}*/
1.71 +
1.72 +/**************************************************************************/
1.73 +/** @name Idle Subsystem */
1.74 +/**************************************************************************/
1.75 +/*@{*/
1.76 +
1.77 +/**
1.78 + * Sets the UI operations structure to be used for idle reporting.
1.79 + *
1.80 + * @param ops The UI operations structure.
1.81 + */
1.82 +void purple_idle_set_ui_ops(PurpleIdleUiOps *ops);
1.83 +
1.84 +/**
1.85 + * Returns the UI operations structure used for idle reporting.
1.86 + *
1.87 + * @return The UI operations structure in use.
1.88 + */
1.89 +PurpleIdleUiOps *purple_idle_get_ui_ops(void);
1.90 +
1.91 +/**
1.92 + * Initializes the idle system.
1.93 + */
1.94 +void purple_idle_init(void);
1.95 +
1.96 +/**
1.97 + * Uninitializes the idle system.
1.98 + */
1.99 +void purple_idle_uninit(void);
1.100 +
1.101 +/*@}*/
1.102 +
1.103 +#ifdef __cplusplus
1.104 +}
1.105 +#endif
1.106 +
1.107 +#endif /* _PURPLE_IDLE_H_ */