Mercurial > pidgin
annotate doc/imgstore-signals.dox @ 20081:2fefc7eaa36f
merge of '22f6ff41c9fffdd5267c9c96f8208a6071443e62'
and '9a8e007dbbbdee9fe816195d04b6372d67f4450b'
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sat, 15 Sep 2007 23:49:13 +0000 |
parents | 61ddeb85ab86 |
children | e0613cf8c493 |
rev | line source |
---|---|
16680
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
1 /** @page imgstore-signals Image Store Signals |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
2 |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
3 @signals |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
4 @signal image-deleting |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
5 @endsignals |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
6 |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
7 <hr> |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
8 |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
9 @signaldef image-deleting |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
10 @signalproto |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
11 char *(*image_deleting)(const PurpleStoredImage *img); |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
12 @endsignalproto |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
13 @signaldesc |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
14 Emitted when a PurpleStoredImage is about to be destroyed. This allows |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
15 for what amounts to weak references. Code can hold onto a pointer to |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
16 the PurpleStoredImage without actually "holding" a reference. They can |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
17 then use a signal handler to let them know when their img is about to |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
18 be destroyed. |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
19 @param img The image about to be destroyed. |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
20 @note It's not possible to purple_imgstore_ref() img to save it. |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
21 @endsignaldef |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
22 |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
23 */ |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
24 // vim: syntax=c tw=75 et |