libpurple/signals.h

changeset 40186
d7e2aba4d9f4
parent 39659
e4dfb99b0cef
child 40474
1341be8e3402
equal deleted inserted replaced
40079:a37a1e349491 40186:d7e2aba4d9f4
77 77
78 /** 78 /**
79 * purple_signal_register: 79 * purple_signal_register:
80 * @instance: The instance to register the signal for. 80 * @instance: The instance to register the signal for.
81 * @signal: The signal name. 81 * @signal: The signal name.
82 * @marshal: The marshal function. 82 * @marshal: (scope notified): The marshal function.
83 * @ret_type: The return type, or G_TYPE_NONE for no return type. 83 * @ret_type: The return type, or G_TYPE_NONE for no return type.
84 * @num_values: The number of values to be passed to the callbacks. 84 * @num_values: The number of values to be passed to the callbacks.
85 * @...: The types of the parameters for the callbacks. 85 * @...: The types of the parameters for the callbacks.
86 * 86 *
87 * Registers a signal in an instance. 87 * Registers a signal in an instance.
128 /** 128 /**
129 * purple_signal_connect_priority: 129 * purple_signal_connect_priority:
130 * @instance: The instance to connect to. 130 * @instance: The instance to connect to.
131 * @signal: The name of the signal to connect. 131 * @signal: The name of the signal to connect.
132 * @handle: The handle of the receiver. 132 * @handle: The handle of the receiver.
133 * @func: The callback function. 133 * @func: (scope notified): The callback function.
134 * @data: The data to pass to the callback function. 134 * @data: The data to pass to the callback function.
135 * @priority: The priority with which the handler should be called. Signal 135 * @priority: The priority with which the handler should be called. Signal
136 * handlers are called in ascending numerical order of 136 * handlers are called in ascending numerical order of
137 * @priority from #PURPLE_SIGNAL_PRIORITY_LOWEST to 137 * @priority from #PURPLE_SIGNAL_PRIORITY_LOWEST to
138 * #PURPLE_SIGNAL_PRIORITY_HIGHEST. 138 * #PURPLE_SIGNAL_PRIORITY_HIGHEST.
152 /** 152 /**
153 * purple_signal_connect: 153 * purple_signal_connect:
154 * @instance: The instance to connect to. 154 * @instance: The instance to connect to.
155 * @signal: The name of the signal to connect. 155 * @signal: The name of the signal to connect.
156 * @handle: The handle of the receiver. 156 * @handle: The handle of the receiver.
157 * @func: The callback function. 157 * @func: (scope notified): The callback function.
158 * @data: The data to pass to the callback function. 158 * @data: The data to pass to the callback function.
159 * 159 *
160 * Connects a signal handler to a signal for a particular object. 160 * Connects a signal handler to a signal for a particular object.
161 * (Its priority defaults to 0, aka #PURPLE_SIGNAL_PRIORITY_DEFAULT.) 161 * (Its priority defaults to 0, aka #PURPLE_SIGNAL_PRIORITY_DEFAULT.)
162 * 162 *
173 /** 173 /**
174 * purple_signal_connect_priority_vargs: 174 * purple_signal_connect_priority_vargs:
175 * @instance: The instance to connect to. 175 * @instance: The instance to connect to.
176 * @signal: The name of the signal to connect. 176 * @signal: The name of the signal to connect.
177 * @handle: The handle of the receiver. 177 * @handle: The handle of the receiver.
178 * @func: The callback function. 178 * @func: (scope notified): The callback function.
179 * @data: The data to pass to the callback function. 179 * @data: The data to pass to the callback function.
180 * @priority: The priority with which the handler should be called. Signal 180 * @priority: The priority with which the handler should be called. Signal
181 * handlers are called in ascending numerical order of 181 * handlers are called in ascending numerical order of
182 * @priority from #PURPLE_SIGNAL_PRIORITY_LOWEST to 182 * @priority from #PURPLE_SIGNAL_PRIORITY_LOWEST to
183 * #PURPLE_SIGNAL_PRIORITY_HIGHEST. 183 * #PURPLE_SIGNAL_PRIORITY_HIGHEST.
200 /** 200 /**
201 * purple_signal_connect_vargs: 201 * purple_signal_connect_vargs:
202 * @instance: The instance to connect to. 202 * @instance: The instance to connect to.
203 * @signal: The name of the signal to connect. 203 * @signal: The name of the signal to connect.
204 * @handle: The handle of the receiver. 204 * @handle: The handle of the receiver.
205 * @func: The callback function. 205 * @func: (scope notified): The callback function.
206 * @data: The data to pass to the callback function. 206 * @data: The data to pass to the callback function.
207 * 207 *
208 * Connects a signal handler to a signal for a particular object. 208 * Connects a signal handler to a signal for a particular object.
209 * (Its priority defaults to 0, aka #PURPLE_SIGNAL_PRIORITY_DEFAULT.) 209 * (Its priority defaults to 0, aka #PURPLE_SIGNAL_PRIORITY_DEFAULT.)
210 * 210 *
224 /** 224 /**
225 * purple_signal_disconnect: 225 * purple_signal_disconnect:
226 * @instance: The instance to disconnect from. 226 * @instance: The instance to disconnect from.
227 * @signal: The name of the signal to disconnect. 227 * @signal: The name of the signal to disconnect.
228 * @handle: The handle of the receiver. 228 * @handle: The handle of the receiver.
229 * @func: The registered function to disconnect. 229 * @func: (scope call): The registered function to disconnect.
230 * 230 *
231 * Disconnects a signal handler from a signal on an object. 231 * Disconnects a signal handler from a signal on an object.
232 * 232 *
233 * See purple_signal_connect() 233 * See purple_signal_connect()
234 */ 234 */

mercurial