summaryrefslogtreecommitdiff
path: root/doc/man/en/man3/event_group.3
blob: f517de4766b8155c1ce48aaa55311859567ce7b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
.TH "Sending events" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Sending events \- 
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef void \fBevent_t\fP"
.br
.ti -1c
.RI "typedef void (* \fBevent_listener_t\fP )(\fBxine_t\fP *xine, \fBevent_t\fP *event, void *data)"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBxine_register_event_listener\fP (\fBxine_t\fP *self, \fBevent_listener_t\fP listener)"
.br
.RI "\fIregisters an event listener callback.\fP"
.ti -1c
.RI "int \fBxine_remove_event_listener\fP (\fBxine_t\fP *self, \fBevent_listener_t\fP listener)"
.br
.RI "\fIAttempts to remove a registered event listener.\fP"
.ti -1c
.RI "void \fBxine_send_event\fP (\fBxine_t\fP *self, \fBevent_t\fP *event, void *data)"
.br
.RI "\fIsends an event to all listeners.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Event dispatcher mechanism 
.SH "TYPEDEF DOCUMENTATION"
.PP 
.SS "typedef void(* event_listener_t)(\fBxine_t\fP *xine, \fBevent_t\fP *event, void *data)"
.PP
Event listener callback. 
.PP
\fBSee also: \fP
.in +1c
\fBxine_register_event_listener\fP, \fBxine_remove_event_listener\fP 
.SS "typedef void event_t"
.PP
Opaque data type. 
.PP
\fBSee also: \fP
.in +1c
\fBevent_listener_t\fP, \fBxine_send_event\fP 
.SH "FUNCTION DOCUMENTATION"
.PP 
.SS "int xine_register_event_listener (\fBxine_t\fP * self, \fBevent_listener_t\fP listener)"
.PP
registers an event listener callback.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() ) 
.TP
\fB\fIlistener\fP\fP
callback function. 
.PP
\fBReturns: \fP
.in +1c
0 if the listener was registerd, non-zero if it could not. 
.PP
\fBSee also: \fP
.in +1c
\fBevent_listener_t\fP 
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
 
.TP
\fB\fIlistener\fP\fP
 
.SS "int xine_remove_event_listener (\fBxine_t\fP * self, \fBevent_listener_t\fP listener)"
.PP
Attempts to remove a registered event listener.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() ) 
.TP
\fB\fIlistener\fP\fP
callback function. 
.PP
\fBReturns: \fP
.in +1c
0 if the listener was removes, non-zero if it wasn't (e.g. not found). 
.PP
\fBSee also: \fP
.in +1c
\fBevent_listener_t\fP 
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
 
.TP
\fB\fIlistener\fP\fP
 
.SS "void xine_send_event (\fBxine_t\fP * self, \fBevent_t\fP * event, void * data)"
.PP
sends an event to all listeners.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() ) 
.TP
\fB\fIevent\fP\fP
FILLME 
.TP
\fB\fIdata\fP\fP
FILLME. 
.PP
\fBSee also: \fP
.in +1c
\fBevent_t\fP 
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
 
.TP
\fB\fIevent\fP\fP
 
.TP
\fB\fIdata\fP\fP