ppg_event.h File Reference

#include "ppg_input.h"
#include "ppg_signals.h"
#include "ppg_time.h"
#include "ppg_layer.h"

Go to the source code of this file.

Data Structures
struct	PPG_Event
	Specification of an input event. More...

Typedefs
typedef void(*	PPG_Event_Processor_Fun )(PPG_Event *event, void *user_data)
	A callback function that is used during processing of stored input events. More...

Enumerations
enum	PPG_Event_Flags { PPG_Event_Flags_Empty = 0, PPG_Event_Active = (1 << 0), PPG_Event_Considered = (PPG_Event_Active << 1) }
	Flags that are used to tag events. More...

Functions
void	ppg_event_process (PPG_Event *event)
	This is the main entry function for input event processing. More...

Typedef Documentation

typedef void(* PPG_Event_Processor_Fun)(PPG_Event *event, void *user_data)

A callback function that is used during processing of stored input events.

Parameters

event	A pointer to a PPG_Event struct that provides information about the input event
signal_id	The signal identifier informs about the signal that triggered input event processing
user_data	Optional user data

Returns

A boolean value that decides about whether input event processing is continued (true) or aborted (false).

Enumeration Type Documentation

enum PPG_Event_Flags

Flags that are used to tag events.

Please note that currently only the flag PPG_Event_Active is supposed to be set by user. Read flags by using the binary operator & to test a flag value against a variable, e.g. if(event->flags & PPG_Event_Considered) { ... }

Enumerator
PPG_Event_Flags_Empty	Initial value of the flags variable.
PPG_Event_Active	Set to mark the activation of an input through an event.
PPG_Event_Considered	This flag bit tells if an event has been considered as part of a pattern or as control event (e.g. as set by ppg_global_set_abort_trigger.

Function Documentation

void ppg_event_process

(

PPG_Event *

event

)

This is the main entry function for input event processing.

Parameters

event

A pointer to an input event to process by papagenop

Returns

If further input event processing by other input event processors is desired