Mercurial > pidgin3 / annotate

doc/imgstore-signals.dox@841d24b3a2bc (annotated)

doc/imgstore-signals.dox

Sat, 29 Dec 2007 06:34:59 +0000

author
Evan Schoenberg <evands@pidgin.im>
date
Sat, 29 Dec 2007 06:34:59 +0000
branch
vv
changeset 22069
841d24b3a2bc
parent 20897
2608e9e07913
permissions
-rw-r--r--

propagate from branch 'im.pidgin.pidgin' (head 5157ec7a2b6f7025fc0f6ed1f1093a725cfcf6f3)
to branch 'im.pidgin.pidgin.vv' (head defa6a4f45cc62c068c5225768278fcf586ac32c)

16740
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
1 /** @page imgstore-signals Image Store Signals
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
2
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
3 @signals
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
4 @signal image-deleting
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
5 @endsignals
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
6
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16740
diff changeset
7 @see imgstore.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16740
diff changeset
8
16740
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
9 <hr>
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
10
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
11 @signaldef image-deleting
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
12 @signalproto
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
13 char *(*image_deleting)(const PurpleStoredImage *img);
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
14 @endsignalproto
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
15 @signaldesc
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16740
diff changeset
16 Emitted when a #PurpleStoredImage is about to be destroyed. This allows
16740
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
17 for what amounts to weak references. Code can hold onto a pointer to
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
18 the PurpleStoredImage without actually "holding" a reference. They can
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
19 then use a signal handler to let them know when their img is about to
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
20 be destroyed.
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
21 @param img The image about to be destroyed.
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
22 @note It's not possible to purple_imgstore_ref() img to save it.
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
23 @endsignaldef
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
24
c95b1a276ea1 Document the image-deleting signal.
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
25 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16740
diff changeset
26 // vim: syntax=c.doxygen tw=75 et

Mercurial Repository: pidgin3

mercurial