Mercurial > pidgin.yaz
annotate doc/imgstore-signals.dox @ 27826:5f9ca519ea9f
propagate from branch 'im.pidgin.pidgin' (head 90011f8844f95be26206d5698b603f1692f319a0)
to branch 'im.pidgin.pidgin.yaz' (head e4862d866bc0b147e783d27c1faa51f1d3e0b58a)
author | Yoshiki Yazawa <yaz@honeyplanet.jp> |
---|---|
date | Thu, 24 Apr 2008 02:28:24 +0000 |
parents | e0613cf8c493 |
children |
rev | line source |
---|---|
16688
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 |
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16688
diff
changeset
|
7 @see imgstore.h |
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16688
diff
changeset
|
8 |
16688
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
9 <hr> |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
10 |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
11 @signaldef image-deleting |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
12 @signalproto |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
13 char *(*image_deleting)(const PurpleStoredImage *img); |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
14 @endsignalproto |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
15 @signaldesc |
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16688
diff
changeset
|
16 Emitted when a #PurpleStoredImage is about to be destroyed. This allows |
16688
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
17 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
|
18 the PurpleStoredImage without actually "holding" a reference. They can |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
19 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
|
20 be destroyed. |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
21 @param img The image about to be destroyed. |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
22 @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
|
23 @endsignaldef |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
24 |
61ddeb85ab86
Document the image-deleting signal.
Richard Laager <rlaager@wiktel.com>
parents:
diff
changeset
|
25 */ |
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16688
diff
changeset
|
26 // vim: syntax=c.doxygen tw=75 et |