Mercurial > pidgin
annotate doc/imgstore-signals.dox @ 23194:66ccd61eaff6
merge of 'd993fb67df1d01ad9a8a18fef3e8a5de90823875'
and 'da43d67131d318f67d21afc95a349c3ab8ef8c92'
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Sun, 25 May 2008 23:48:57 +0000 |
parents | e0613cf8c493 |
children |
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 |
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16680
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:
16680
diff
changeset
|
8 |
16680
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:
16680
diff
changeset
|
16 Emitted when a #PurpleStoredImage is about to be destroyed. This allows |
16680
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:
16680
diff
changeset
|
26 // vim: syntax=c.doxygen tw=75 et |