Update Doxygen doc
[openjpeg.git] / doxygen / structopj__event__mgr.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: opj_event_mgr Struct 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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
36       <li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
42       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
43     </ul>
44   </div>
45 </div><!-- top -->
46 <div class="header">
47   <div class="summary">
48 <a href="#pub-attribs">Data Fields</a>  </div>
49   <div class="headertitle">
50 <div class="title">opj_event_mgr Struct Reference</div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>Message handler object used for.  
55  <a href="structopj__event__mgr.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="event_8h_source.html">event.h</a>&gt;</code></p>
58 <table class="memberdecls">
59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
60 Data Fields</h2></td></tr>
61 <tr class="memitem:a551021914bcf2da3a212f1fd128da7d7"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__event__mgr.html#a551021914bcf2da3a212f1fd128da7d7">m_error_data</a></td></tr>
62 <tr class="memdesc:a551021914bcf2da3a212f1fd128da7d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data to call the event manager upon.  <a href="#a551021914bcf2da3a212f1fd128da7d7">More...</a><br /></td></tr>
63 <tr class="separator:a551021914bcf2da3a212f1fd128da7d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:ae86cf70e19e00750bdf4df2fdae4f4b3"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__event__mgr.html#ae86cf70e19e00750bdf4df2fdae4f4b3">m_warning_data</a></td></tr>
65 <tr class="memdesc:ae86cf70e19e00750bdf4df2fdae4f4b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data to call the event manager upon.  <a href="#ae86cf70e19e00750bdf4df2fdae4f4b3">More...</a><br /></td></tr>
66 <tr class="separator:ae86cf70e19e00750bdf4df2fdae4f4b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:a914c15d0e74ed08bc54a93664df4402c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__event__mgr.html#a914c15d0e74ed08bc54a93664df4402c">m_info_data</a></td></tr>
68 <tr class="memdesc:a914c15d0e74ed08bc54a93664df4402c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data to call the event manager upon.  <a href="#a914c15d0e74ed08bc54a93664df4402c">More...</a><br /></td></tr>
69 <tr class="separator:a914c15d0e74ed08bc54a93664df4402c"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a9ee0c627fefd37d56e3487af6fc250b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__event__mgr.html#a9ee0c627fefd37d56e3487af6fc250b6">error_handler</a></td></tr>
71 <tr class="memdesc:a9ee0c627fefd37d56e3487af6fc250b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error message callback if available, NULL otherwise.  <a href="#a9ee0c627fefd37d56e3487af6fc250b6">More...</a><br /></td></tr>
72 <tr class="separator:a9ee0c627fefd37d56e3487af6fc250b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:af0954e95dec628614f22a501f2b6ce9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__event__mgr.html#af0954e95dec628614f22a501f2b6ce9b">warning_handler</a></td></tr>
74 <tr class="memdesc:af0954e95dec628614f22a501f2b6ce9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Warning message callback if available, NULL otherwise.  <a href="#af0954e95dec628614f22a501f2b6ce9b">More...</a><br /></td></tr>
75 <tr class="separator:af0954e95dec628614f22a501f2b6ce9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:ad60a40bbc655af631ec15f84ee45a708"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__event__mgr.html#ad60a40bbc655af631ec15f84ee45a708">info_handler</a></td></tr>
77 <tr class="memdesc:ad60a40bbc655af631ec15f84ee45a708"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug message callback if available, NULL otherwise.  <a href="#ad60a40bbc655af631ec15f84ee45a708">More...</a><br /></td></tr>
78 <tr class="separator:ad60a40bbc655af631ec15f84ee45a708"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 </table>
80 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
81 <div class="textblock"><p>Message handler object used for. </p>
82 <ul>
83 <li>
84 Error messages </li>
85 <li>
86 Warning messages </li>
87 <li>
88 Debugging messages </li>
89 </ul>
90 </div><h2 class="groupheader">Field Documentation</h2>
91 <a class="anchor" id="a9ee0c627fefd37d56e3487af6fc250b6"></a>
92 <div class="memitem">
93 <div class="memproto">
94       <table class="memname">
95         <tr>
96           <td class="memname"><a class="el" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a> opj_event_mgr::error_handler</td>
97         </tr>
98       </table>
99 </div><div class="memdoc">
100
101 <p>Error message callback if available, NULL otherwise. </p>
102
103 <p>Referenced by <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler()</a>, and <a class="el" href="openjpeg_8h.html#a52a1f826dd3a2d257fa5b935b60a82ac">opj_set_error_handler()</a>.</p>
104
105 </div>
106 </div>
107 <a class="anchor" id="ad60a40bbc655af631ec15f84ee45a708"></a>
108 <div class="memitem">
109 <div class="memproto">
110       <table class="memname">
111         <tr>
112           <td class="memname"><a class="el" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a> opj_event_mgr::info_handler</td>
113         </tr>
114       </table>
115 </div><div class="memdoc">
116
117 <p>Debug message callback if available, NULL otherwise. </p>
118
119 <p>Referenced by <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler()</a>, and <a class="el" href="openjpeg_8h.html#ac887f1d80d30a49fe20b673836783696">opj_set_info_handler()</a>.</p>
120
121 </div>
122 </div>
123 <a class="anchor" id="a551021914bcf2da3a212f1fd128da7d7"></a>
124 <div class="memitem">
125 <div class="memproto">
126       <table class="memname">
127         <tr>
128           <td class="memname">void* opj_event_mgr::m_error_data</td>
129         </tr>
130       </table>
131 </div><div class="memdoc">
132
133 <p>Data to call the event manager upon. </p>
134
135 <p>Referenced by <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler()</a>, and <a class="el" href="openjpeg_8h.html#a52a1f826dd3a2d257fa5b935b60a82ac">opj_set_error_handler()</a>.</p>
136
137 </div>
138 </div>
139 <a class="anchor" id="a914c15d0e74ed08bc54a93664df4402c"></a>
140 <div class="memitem">
141 <div class="memproto">
142       <table class="memname">
143         <tr>
144           <td class="memname">void* opj_event_mgr::m_info_data</td>
145         </tr>
146       </table>
147 </div><div class="memdoc">
148
149 <p>Data to call the event manager upon. </p>
150
151 <p>Referenced by <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler()</a>, and <a class="el" href="openjpeg_8h.html#ac887f1d80d30a49fe20b673836783696">opj_set_info_handler()</a>.</p>
152
153 </div>
154 </div>
155 <a class="anchor" id="ae86cf70e19e00750bdf4df2fdae4f4b3"></a>
156 <div class="memitem">
157 <div class="memproto">
158       <table class="memname">
159         <tr>
160           <td class="memname">void* opj_event_mgr::m_warning_data</td>
161         </tr>
162       </table>
163 </div><div class="memdoc">
164
165 <p>Data to call the event manager upon. </p>
166
167 <p>Referenced by <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler()</a>, and <a class="el" href="openjpeg_8h.html#ae24aa81acf8ec8154f099bbe35703c0a">opj_set_warning_handler()</a>.</p>
168
169 </div>
170 </div>
171 <a class="anchor" id="af0954e95dec628614f22a501f2b6ce9b"></a>
172 <div class="memitem">
173 <div class="memproto">
174       <table class="memname">
175         <tr>
176           <td class="memname"><a class="el" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a> opj_event_mgr::warning_handler</td>
177         </tr>
178       </table>
179 </div><div class="memdoc">
180
181 <p>Warning message callback if available, NULL otherwise. </p>
182
183 <p>Referenced by <a class="el" href="group___e_v_e_n_t.html#ga87d9d4bdfd203ccd8a7522d6f197a3b7">opj_event_msg()</a>, <a class="el" href="group___e_v_e_n_t.html#ga8584de0db0bbc62b70d5cf5089165ef2">opj_set_default_event_handler()</a>, and <a class="el" href="openjpeg_8h.html#ae24aa81acf8ec8154f099bbe35703c0a">opj_set_warning_handler()</a>.</p>
184
185 </div>
186 </div>
187 <hr/>The documentation for this struct was generated from the following file:<ul>
188 <li><a class="el" href="event_8h_source.html">event.h</a></li>
189 </ul>
190 </div><!-- contents -->
191 <!-- start footer part -->
192 <hr class="footer"/><address class="footer"><small>
193 Generated by &#160;<a href="http://www.doxygen.org/index.html">
194 <img class="footer" src="doxygen.png" alt="doxygen"/>
195 </a> 1.8.10
196 </small></address>
197 </body>
198 </html>