Update ABI/API compatibility reports after commit 4e5501b3c72a98b3117e68263afb922092c...
[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.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: opj_event_mgr Struct Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">OpenJPEG
22    &#160;<span id="projectnumber">2.3.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 </div><!-- top -->
40 <div class="header">
41   <div class="summary">
42 <a href="#pub-attribs">Data Fields</a>  </div>
43   <div class="headertitle">
44 <div class="title">opj_event_mgr Struct Reference</div>  </div>
45 </div><!--header-->
46 <div class="contents">
47
48 <p>Message handler object used for.  
49  <a href="structopj__event__mgr.html#details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="event_8h_source.html">event.h</a>&gt;</code></p>
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
54 Data Fields</h2></td></tr>
55 <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>
56 <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>
57 <tr class="separator:a551021914bcf2da3a212f1fd128da7d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <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>
59 <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>
60 <tr class="separator:ae86cf70e19e00750bdf4df2fdae4f4b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
61 <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>
62 <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>
63 <tr class="separator:a914c15d0e74ed08bc54a93664df4402c"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <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>
65 <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>
66 <tr class="separator:a9ee0c627fefd37d56e3487af6fc250b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <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>
68 <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>
69 <tr class="separator:af0954e95dec628614f22a501f2b6ce9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <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>
71 <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>
72 <tr class="separator:ad60a40bbc655af631ec15f84ee45a708"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 </table>
74 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
75 <div class="textblock"><p>Message handler object used for. </p>
76 <ul>
77 <li>
78 Error messages </li>
79 <li>
80 Warning messages </li>
81 <li>
82 Debugging messages </li>
83 </ul>
84 </div><h2 class="groupheader">Field Documentation</h2>
85 <a id="a9ee0c627fefd37d56e3487af6fc250b6"></a>
86 <h2 class="memtitle"><span class="permalink"><a href="#a9ee0c627fefd37d56e3487af6fc250b6">&#9670;&nbsp;</a></span>error_handler</h2>
87
88 <div class="memitem">
89 <div class="memproto">
90       <table class="memname">
91         <tr>
92           <td class="memname"><a class="el" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a> opj_event_mgr::error_handler</td>
93         </tr>
94       </table>
95 </div><div class="memdoc">
96
97 <p>Error message callback if available, NULL otherwise. </p>
98
99 <p class="reference">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>
100
101 </div>
102 </div>
103 <a id="ad60a40bbc655af631ec15f84ee45a708"></a>
104 <h2 class="memtitle"><span class="permalink"><a href="#ad60a40bbc655af631ec15f84ee45a708">&#9670;&nbsp;</a></span>info_handler</h2>
105
106 <div class="memitem">
107 <div class="memproto">
108       <table class="memname">
109         <tr>
110           <td class="memname"><a class="el" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a> opj_event_mgr::info_handler</td>
111         </tr>
112       </table>
113 </div><div class="memdoc">
114
115 <p>Debug message callback if available, NULL otherwise. </p>
116
117 <p class="reference">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>
118
119 </div>
120 </div>
121 <a id="a551021914bcf2da3a212f1fd128da7d7"></a>
122 <h2 class="memtitle"><span class="permalink"><a href="#a551021914bcf2da3a212f1fd128da7d7">&#9670;&nbsp;</a></span>m_error_data</h2>
123
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 class="reference">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 id="a914c15d0e74ed08bc54a93664df4402c"></a>
140 <h2 class="memtitle"><span class="permalink"><a href="#a914c15d0e74ed08bc54a93664df4402c">&#9670;&nbsp;</a></span>m_info_data</h2>
141
142 <div class="memitem">
143 <div class="memproto">
144       <table class="memname">
145         <tr>
146           <td class="memname">void* opj_event_mgr::m_info_data</td>
147         </tr>
148       </table>
149 </div><div class="memdoc">
150
151 <p>Data to call the event manager upon. </p>
152
153 <p class="reference">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>
154
155 </div>
156 </div>
157 <a id="ae86cf70e19e00750bdf4df2fdae4f4b3"></a>
158 <h2 class="memtitle"><span class="permalink"><a href="#ae86cf70e19e00750bdf4df2fdae4f4b3">&#9670;&nbsp;</a></span>m_warning_data</h2>
159
160 <div class="memitem">
161 <div class="memproto">
162       <table class="memname">
163         <tr>
164           <td class="memname">void* opj_event_mgr::m_warning_data</td>
165         </tr>
166       </table>
167 </div><div class="memdoc">
168
169 <p>Data to call the event manager upon. </p>
170
171 <p class="reference">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>
172
173 </div>
174 </div>
175 <a id="af0954e95dec628614f22a501f2b6ce9b"></a>
176 <h2 class="memtitle"><span class="permalink"><a href="#af0954e95dec628614f22a501f2b6ce9b">&#9670;&nbsp;</a></span>warning_handler</h2>
177
178 <div class="memitem">
179 <div class="memproto">
180       <table class="memname">
181         <tr>
182           <td class="memname"><a class="el" href="openjpeg_8h.html#aeb2e489c5b4386fed6eae3123217c7f0">opj_msg_callback</a> opj_event_mgr::warning_handler</td>
183         </tr>
184       </table>
185 </div><div class="memdoc">
186
187 <p>Warning message callback if available, NULL otherwise. </p>
188
189 <p class="reference">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>
190
191 </div>
192 </div>
193 <hr/>The documentation for this struct was generated from the following file:<ul>
194 <li><a class="el" href="event_8h_source.html">event.h</a></li>
195 </ul>
196 </div><!-- contents -->
197 <!-- start footer part -->
198 <hr class="footer"/><address class="footer"><small>
199 Generated by &#160;<a href="http://www.doxygen.org/index.html">
200 <img class="footer" src="doxygen.png" alt="doxygen"/>
201 </a> 1.8.13
202 </small></address>
203 </body>
204 </html>