Update Doxygen doc
[openjpeg.git] / doxygen / event_8c.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.10"/>
7 <title>OpenJPEG: event.c File Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
12 </head>
13 <body>
14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15 <div id="titlearea">
16 <table cellspacing="0" cellpadding="0">
17  <tbody>
18  <tr style="height: 56px;">
19   <td id="projectalign" style="padding-left: 0.5em;">
20    <div id="projectname">OpenJPEG
21    &#160;<span id="projectnumber">2.2.0</span>
22    </div>
23   </td>
24  </tr>
25  </tbody>
26 </table>
27 </div>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.10 -->
30   <div id="navrow1" class="tabs">
31     <ul class="tablist">
32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
33       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
34       <li><a href="modules.html"><span>Modules</span></a></li>
35       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
36       <li class="current"><a href="files.html"><span>Files</span></a></li>
37     </ul>
38   </div>
39   <div id="navrow2" class="tabs2">
40     <ul class="tablist">
41       <li><a href="files.html"><span>File&#160;List</span></a></li>
42       <li><a href="globals.html"><span>Globals</span></a></li>
43     </ul>
44   </div>
45 <div id="nav-path" class="navpath">
46   <ul>
47 <li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_694e20c96f4fc1be4aed4f026eadce94.html">antonin</a></li><li class="navelem"><a class="el" href="dir_3ca1ad36e65e03f9e8d67ddc2553765b.html">dev</a></li><li class="navelem"><a class="el" href="dir_181a881edfcb8646dab693a228fa6bde.html">opj</a></li><li class="navelem"><a class="el" href="dir_5064bb5511811c3176850b7e47443f14.html">github</a></li><li class="navelem"><a class="el" href="dir_0b20524d8f8835ca75acc430451c8412.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_e3f8a8e294f8271ee71cbcf3c2acacc1.html">src</a></li><li class="navelem"><a class="el" href="dir_da83fe5fdfb6c4554d36abffc03790ad.html">lib</a></li><li class="navelem"><a class="el" href="dir_68013e83e260d17d49dee5e209315608.html">openjp2</a></li>  </ul>
48 </div>
49 </div><!-- top -->
50 <div class="header">
51   <div class="summary">
52 <a href="#define-members">Macros</a> &#124;
53 <a href="#func-members">Functions</a>  </div>
54   <div class="headertitle">
55 <div class="title">event.c File Reference</div>  </div>
56 </div><!--header-->
57 <div class="contents">
58 <div class="textblock"><code>#include &quot;<a class="el" href="opj__includes_8h_source.html">opj_includes.h</a>&quot;</code><br />
59 </div><table class="memberdecls">
60 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
61 Macros</h2></td></tr>
62 <tr class="memitem:a04bd3229f3d8b05834a288b47949483e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event_8c.html#a04bd3229f3d8b05834a288b47949483e">OPJ_MSG_SIZE</a>&#160;&#160;&#160;512 /* 512 bytes should be more than enough for a short message */</td></tr>
63 <tr class="separator:a04bd3229f3d8b05834a288b47949483e"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 </table><table class="memberdecls">
65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
66 Functions</h2></td></tr>
67 <tr class="memitem:adf1fd54a14d1011ee5b9c5f0a3e99ac0"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="event_8c.html#adf1fd54a14d1011ee5b9c5f0a3e99ac0">opj_default_callback</a> (const char *msg, void *client_data)</td></tr>
68 <tr class="memdesc:adf1fd54a14d1011ee5b9c5f0a3e99ac0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default callback function.  <a href="#adf1fd54a14d1011ee5b9c5f0a3e99ac0">More...</a><br /></td></tr>
69 <tr class="separator:adf1fd54a14d1011ee5b9c5f0a3e99ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:ga87d9d4bdfd203ccd8a7522d6f197a3b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg</a> (<a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *p_event_mgr, <a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> event_type, const char *fmt,...)</td></tr>
71 <tr class="memdesc:ga87d9d4bdfd203ccd8a7522d6f197a3b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write formatted data to a string and send the string to a user callback.  <a href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">More...</a><br /></td></tr>
72 <tr class="separator:ga87d9d4bdfd203ccd8a7522d6f197a3b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:ga8584de0db0bbc62b70d5cf5089165ef2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler</a> (<a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *p_manager)</td></tr>
74 <tr class="memdesc:ga8584de0db0bbc62b70d5cf5089165ef2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the event manager with the default callback function for the 3 levels.  <a href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">More...</a><br /></td></tr>
75 <tr class="separator:ga8584de0db0bbc62b70d5cf5089165ef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 </table>
77 <h2 class="groupheader">Macro Definition Documentation</h2>
78 <a class="anchor" id="a04bd3229f3d8b05834a288b47949483e"></a>
79 <div class="memitem">
80 <div class="memproto">
81       <table class="memname">
82         <tr>
83           <td class="memname">#define OPJ_MSG_SIZE&#160;&#160;&#160;512 /* 512 bytes should be more than enough for a short message */</td>
84         </tr>
85       </table>
86 </div><div class="memdoc">
87
88 <p>Referenced by <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>.</p>
89
90 </div>
91 </div>
92 <h2 class="groupheader">Function Documentation</h2>
93 <a class="anchor" id="adf1fd54a14d1011ee5b9c5f0a3e99ac0"></a>
94 <div class="memitem">
95 <div class="memproto">
96 <table class="mlabels">
97   <tr>
98   <td class="mlabels-left">
99       <table class="memname">
100         <tr>
101           <td class="memname">static void opj_default_callback </td>
102           <td>(</td>
103           <td class="paramtype">const char *&#160;</td>
104           <td class="paramname"><em>msg</em>, </td>
105         </tr>
106         <tr>
107           <td class="paramkey"></td>
108           <td></td>
109           <td class="paramtype">void *&#160;</td>
110           <td class="paramname"><em>client_data</em>&#160;</td>
111         </tr>
112         <tr>
113           <td></td>
114           <td>)</td>
115           <td></td><td></td>
116         </tr>
117       </table>
118   </td>
119   <td class="mlabels-right">
120 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
121   </tr>
122 </table>
123 </div><div class="memdoc">
124
125 <p>Default callback function. </p>
126 <p>Do nothing. </p>
127
128 <p>References <a class="el" href="openjpeg_8h.html#a802696e43e0ad059cfb3310cb5b073bb">OPJ_ARG_NOT_USED</a>.</p>
129
130 <p>Referenced by <a class="el" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler()</a>.</p>
131
132 </div>
133 </div>
134 </div><!-- contents -->
135 <!-- start footer part -->
136 <hr class="footer"/><address class="footer"><small>
137 Generated by &#160;<a href="http://www.doxygen.org/index.html">
138 <img class="footer" src="doxygen.png" alt="doxygen"/>
139 </a> 1.8.10
140 </small></address>
141 </body>
142 </html>