idle.h File Reference

Idle API. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  PurpleIdleUiOps
 Idle UI operations. More...

Functions

Idle Subsystem
PurpleIdleUiOpspurple_idle_get_ui_ops (void)
 Returns the UI operations structure used for idle reporting.
void purple_idle_init (void)
 Initializes the idle system.
void purple_idle_set_ui_ops (PurpleIdleUiOps *ops)
 Sets the UI operations structure to be used for idle reporting.
void purple_idle_uninit (void)
 Uninitializes the idle system.
Idle API
void purple_idle_set (time_t time)
 Fake our idle time by setting the time at which our accounts purportedly became idle.
void purple_idle_touch (void)
 Touch our idle tracker.


Detailed Description

Idle API.

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

Definition in file idle.h.


Function Documentation

PurpleIdleUiOps* purple_idle_get_ui_ops ( void   ) 

Returns the UI operations structure used for idle reporting.

Returns:
The UI operations structure in use.

void purple_idle_set ( time_t  time  ) 

Fake our idle time by setting the time at which our accounts purportedly became idle.

This is used by the I'dle Mak'er plugin.

void purple_idle_set_ui_ops ( PurpleIdleUiOps ops  ) 

Sets the UI operations structure to be used for idle reporting.

Parameters:
ops The UI operations structure.

void purple_idle_touch ( void   ) 

Touch our idle tracker.

This signifies that the user is 'active'. The conversation code calls this when the user sends an IM, for example.