diff options
Diffstat (limited to 'libraries/irrlicht-1.8.1/doc/html/classirr_1_1_i_event_receiver.html')
-rw-r--r-- | libraries/irrlicht-1.8.1/doc/html/classirr_1_1_i_event_receiver.html | 225 |
1 files changed, 0 insertions, 225 deletions
diff --git a/libraries/irrlicht-1.8.1/doc/html/classirr_1_1_i_event_receiver.html b/libraries/irrlicht-1.8.1/doc/html/classirr_1_1_i_event_receiver.html deleted file mode 100644 index 37924f1..0000000 --- a/libraries/irrlicht-1.8.1/doc/html/classirr_1_1_i_event_receiver.html +++ /dev/null | |||
@@ -1,225 +0,0 @@ | |||
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 | <title>Irrlicht 3D Engine: irr::IEventReceiver Class Reference</title> | ||
6 | |||
7 | <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||
8 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
9 | <link href="navtree.css" rel="stylesheet" type="text/css"/> | ||
10 | <script type="text/javascript" src="jquery.js"></script> | ||
11 | <script type="text/javascript" src="resize.js"></script> | ||
12 | <script type="text/javascript" src="navtree.js"></script> | ||
13 | <script type="text/javascript"> | ||
14 | $(document).ready(initResizable); | ||
15 | </script> | ||
16 | <link href="search/search.css" rel="stylesheet" type="text/css"/> | ||
17 | <script type="text/javascript" src="search/search.js"></script> | ||
18 | <script type="text/javascript"> | ||
19 | $(document).ready(function() { searchBox.OnSelectItem(0); }); | ||
20 | </script> | ||
21 | |||
22 | </head> | ||
23 | <body> | ||
24 | <div id="top"><!-- do not remove this div! --> | ||
25 | |||
26 | |||
27 | <div id="titlearea"> | ||
28 | <table cellspacing="0" cellpadding="0"> | ||
29 | <tbody> | ||
30 | <tr style="height: 56px;"> | ||
31 | |||
32 | <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td> | ||
33 | |||
34 | |||
35 | <td style="padding-left: 0.5em;"> | ||
36 | <div id="projectname">Irrlicht 3D Engine | ||
37 | |||
38 | </div> | ||
39 | |||
40 | </td> | ||
41 | |||
42 | |||
43 | |||
44 | |||
45 | <td> <div id="MSearchBox" class="MSearchBoxInactive"> | ||
46 | <span class="left"> | ||
47 | <img id="MSearchSelect" src="search/mag_sel.png" | ||
48 | onmouseover="return searchBox.OnSearchSelectShow()" | ||
49 | onmouseout="return searchBox.OnSearchSelectHide()" | ||
50 | alt=""/> | ||
51 | <input type="text" id="MSearchField" value="Search" accesskey="S" | ||
52 | onfocus="searchBox.OnSearchFieldFocus(true)" | ||
53 | onblur="searchBox.OnSearchFieldFocus(false)" | ||
54 | onkeyup="searchBox.OnSearchFieldChange(event)"/> | ||
55 | </span><span class="right"> | ||
56 | <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> | ||
57 | </span> | ||
58 | </div> | ||
59 | </td> | ||
60 | |||
61 | |||
62 | </tr> | ||
63 | </tbody> | ||
64 | </table> | ||
65 | </div> | ||
66 | |||
67 | <!-- Generated by Doxygen 1.7.5.1 --> | ||
68 | <script type="text/javascript"> | ||
69 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); | ||
70 | </script> | ||
71 | <script type="text/javascript" src="dynsections.js"></script> | ||
72 | </div> | ||
73 | <div id="side-nav" class="ui-resizable side-nav-resizable"> | ||
74 | <div id="nav-tree"> | ||
75 | <div id="nav-tree-contents"> | ||
76 | </div> | ||
77 | </div> | ||
78 | <div id="splitbar" style="-moz-user-select:none;" | ||
79 | class="ui-resizable-handle"> | ||
80 | </div> | ||
81 | </div> | ||
82 | <script type="text/javascript"> | ||
83 | initNavTree('classirr_1_1_i_event_receiver.html',''); | ||
84 | </script> | ||
85 | <div id="doc-content"> | ||
86 | <div class="header"> | ||
87 | <div class="summary"> | ||
88 | <a href="#pub-methods">Public Member Functions</a> </div> | ||
89 | <div class="headertitle"> | ||
90 | <div class="title">irr::IEventReceiver Class Reference</div> </div> | ||
91 | </div> | ||
92 | <div class="contents"> | ||
93 | <!-- doxytag: class="irr::IEventReceiver" --> | ||
94 | <p>Interface of an object which can receive events. | ||
95 | <a href="classirr_1_1_i_event_receiver.html#details">More...</a></p> | ||
96 | |||
97 | <p><code>#include <<a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>></code></p> | ||
98 | <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> | ||
99 | <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::IEventReceiver:</div> | ||
100 | <div id="dynsection-0-summary" class="dynsummary" style="display:block;"> | ||
101 | </div> | ||
102 | <div id="dynsection-0-content" class="dyncontent" style="display:none;"> | ||
103 | <div class="center"> | ||
104 | <img src="classirr_1_1_i_event_receiver.png" usemap="#irr::IEventReceiver_map" alt=""/> | ||
105 | <map id="irr::IEventReceiver_map" name="irr::IEventReceiver_map"> | ||
106 | <area href="classirr_1_1gui_1_1_i_g_u_i_element.html" title="Base class of all GUI elements." alt="irr::gui::IGUIElement" shape="rect" coords="0,56,293,80"/> | ||
107 | <area href="classirr_1_1scene_1_1_i_camera_scene_node.html" title="Scene Node which is a (controlable) camera." alt="irr::scene::ICameraSceneNode" shape="rect" coords="303,56,596,80"/> | ||
108 | <area href="classirr_1_1scene_1_1_i_scene_node_animator.html" title="Animates a scene node. Can animate position, rotation, material, and so on." alt="irr::scene::ISceneNodeAnimator" shape="rect" coords="606,56,899,80"/> | ||
109 | <area href="classirr_1_1gui_1_1_i_g_u_i_button.html" title="GUI Button interface." alt="irr::gui::IGUIButton" shape="rect" coords="303,112,596,136"/> | ||
110 | <area href="classirr_1_1gui_1_1_i_g_u_i_check_box.html" title="GUI Check box interface." alt="irr::gui::IGUICheckBox" shape="rect" coords="303,168,596,192"/> | ||
111 | <area href="classirr_1_1gui_1_1_i_g_u_i_color_select_dialog.html" title="Standard color chooser dialog." alt="irr::gui::IGUIColorSelectDialog" shape="rect" coords="303,224,596,248"/> | ||
112 | <area href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html" title="Combobox widget." alt="irr::gui::IGUIComboBox" shape="rect" coords="303,280,596,304"/> | ||
113 | <area href="classirr_1_1gui_1_1_i_g_u_i_context_menu.html" title="GUI Context menu interface." alt="irr::gui::IGUIContextMenu" shape="rect" coords="303,336,596,360"/> | ||
114 | <area href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html" title="Single line edit box for editing simple text." alt="irr::gui::IGUIEditBox" shape="rect" coords="303,392,596,416"/> | ||
115 | <area href="classirr_1_1gui_1_1_i_g_u_i_file_open_dialog.html" title="Standard file chooser dialog." alt="irr::gui::IGUIFileOpenDialog" shape="rect" coords="303,448,596,472"/> | ||
116 | <area href="classirr_1_1gui_1_1_i_g_u_i_image.html" title="GUI element displaying an image." alt="irr::gui::IGUIImage" shape="rect" coords="303,504,596,528"/> | ||
117 | <area href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html" title="Element for fading out or in." alt="irr::gui::IGUIInOutFader" shape="rect" coords="303,560,596,584"/> | ||
118 | <area href="classirr_1_1gui_1_1_i_g_u_i_list_box.html" title="Default list box GUI element." alt="irr::gui::IGUIListBox" shape="rect" coords="303,616,596,640"/> | ||
119 | <area href="classirr_1_1gui_1_1_i_g_u_i_mesh_viewer.html" title="3d mesh viewing GUI element." alt="irr::gui::IGUIMeshViewer" shape="rect" coords="303,672,596,696"/> | ||
120 | <area href="classirr_1_1gui_1_1_i_g_u_i_scroll_bar.html" title="Default scroll bar GUI element." alt="irr::gui::IGUIScrollBar" shape="rect" coords="303,728,596,752"/> | ||
121 | <area href="classirr_1_1gui_1_1_i_g_u_i_spin_box.html" title="Single line edit box + spin buttons." alt="irr::gui::IGUISpinBox" shape="rect" coords="303,784,596,808"/> | ||
122 | <area href="classirr_1_1gui_1_1_i_g_u_i_static_text.html" title="Multi or single line text label." alt="irr::gui::IGUIStaticText" shape="rect" coords="303,840,596,864"/> | ||
123 | <area href="classirr_1_1gui_1_1_i_g_u_i_tab.html" title="A tab-page, onto which other gui elements could be added." alt="irr::gui::IGUITab" shape="rect" coords="303,896,596,920"/> | ||
124 | <area href="classirr_1_1gui_1_1_i_g_u_i_tab_control.html" title="A standard tab control." alt="irr::gui::IGUITabControl" shape="rect" coords="303,952,596,976"/> | ||
125 | <area href="classirr_1_1gui_1_1_i_g_u_i_table.html" title="Default list box GUI element." alt="irr::gui::IGUITable" shape="rect" coords="303,1008,596,1032"/> | ||
126 | <area href="classirr_1_1gui_1_1_i_g_u_i_tool_bar.html" title="Stays at the top of its parent like the menu bar and contains tool buttons." alt="irr::gui::IGUIToolBar" shape="rect" coords="303,1064,596,1088"/> | ||
127 | <area href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html" title="Default tree view GUI element." alt="irr::gui::IGUITreeView" shape="rect" coords="303,1120,596,1144"/> | ||
128 | <area href="classirr_1_1gui_1_1_i_g_u_i_window.html" title="Default moveable window GUI element with border, caption and close icons." alt="irr::gui::IGUIWindow" shape="rect" coords="303,1176,596,1200"/> | ||
129 | <area href="classirr_1_1scene_1_1_i_scene_node_animator_camera_f_p_s.html" title="Special scene node animator for FPS cameras." alt="irr::scene::ISceneNodeAnimatorCameraFPS" shape="rect" coords="909,112,1202,136"/> | ||
130 | <area href="classirr_1_1scene_1_1_i_scene_node_animator_camera_maya.html" title="Special scene node animator for Maya-style cameras." alt="irr::scene::ISceneNodeAnimatorCameraMaya" shape="rect" coords="909,168,1202,192"/> | ||
131 | <area href="classirr_1_1scene_1_1_i_scene_node_animator_collision_response.html" title="Special scene node animator for doing automatic collision detection and response." alt="irr::scene::ISceneNodeAnimatorCollisionResponse" shape="rect" coords="909,224,1202,248"/> | ||
132 | </map> | ||
133 | </div></div> | ||
134 | |||
135 | <p><a href="classirr_1_1_i_event_receiver-members.html">List of all members.</a></p> | ||
136 | <h2><a name="pub-methods"></a> | ||
137 | Public Member Functions</h2> | ||
138 | <ul> | ||
139 | <li>virtual <a class="el" href="classirr_1_1_i_event_receiver.html#a4ec011612f02017d95654cf5b5d567b6">~IEventReceiver</a> () | ||
140 | <dl class="el"><dd class="mdescRight">Destructor. <a href="#a4ec011612f02017d95654cf5b5d567b6"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1_i_event_receiver.html#a571f744ceffc3b4fe8a81f529163eb97">OnEvent</a> (const <a class="el" href="structirr_1_1_s_event.html">SEvent</a> &event)=0 | ||
141 | <dl class="el"><dd class="mdescRight">Called if an event happened. <a href="#a571f744ceffc3b4fe8a81f529163eb97"></a><br/></dl></ul> | ||
142 | <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> | ||
143 | <div class="textblock"><p>Interface of an object which can receive events. </p> | ||
144 | <p>Many of the engine's classes inherit <a class="el" href="classirr_1_1_i_event_receiver.html" title="Interface of an object which can receive events.">IEventReceiver</a> so they are able to process events. Events usually start at a postEventFromUser function and are passed down through a chain of event receivers until OnEvent returns true. See <a class="el" href="namespaceirr.html#ac9eed96e06e85ce3c86fcbbbe9e48a0c" title="Enumeration for all event types there are.">irr::EEVENT_TYPE</a> for a description of where each type of event starts, and the path it takes through the system. </p> | ||
145 | |||
146 | <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00433">433</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> | ||
147 | </div><hr/><h2>Constructor & Destructor Documentation</h2> | ||
148 | <a class="anchor" id="a4ec011612f02017d95654cf5b5d567b6"></a><!-- doxytag: member="irr::IEventReceiver::~IEventReceiver" ref="a4ec011612f02017d95654cf5b5d567b6" args="()" --> | ||
149 | <div class="memitem"> | ||
150 | <div class="memproto"> | ||
151 | <table class="memname"> | ||
152 | <tr> | ||
153 | <td class="memname">virtual irr::IEventReceiver::~IEventReceiver </td> | ||
154 | <td>(</td> | ||
155 | <td class="paramname"></td><td>)</td> | ||
156 | <td><code> [inline, virtual]</code></td> | ||
157 | </tr> | ||
158 | </table> | ||
159 | </div> | ||
160 | <div class="memdoc"> | ||
161 | |||
162 | <p>Destructor. </p> | ||
163 | |||
164 | <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00438">438</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> | ||
165 | |||
166 | </div> | ||
167 | </div> | ||
168 | <hr/><h2>Member Function Documentation</h2> | ||
169 | <a class="anchor" id="a571f744ceffc3b4fe8a81f529163eb97"></a><!-- doxytag: member="irr::IEventReceiver::OnEvent" ref="a571f744ceffc3b4fe8a81f529163eb97" args="(const SEvent &event)=0" --> | ||
170 | <div class="memitem"> | ||
171 | <div class="memproto"> | ||
172 | <table class="memname"> | ||
173 | <tr> | ||
174 | <td class="memname">virtual bool irr::IEventReceiver::OnEvent </td> | ||
175 | <td>(</td> | ||
176 | <td class="paramtype">const <a class="el" href="structirr_1_1_s_event.html">SEvent</a> & </td> | ||
177 | <td class="paramname"><em>event</em></td><td>)</td> | ||
178 | <td><code> [pure virtual]</code></td> | ||
179 | </tr> | ||
180 | </table> | ||
181 | </div> | ||
182 | <div class="memdoc"> | ||
183 | |||
184 | <p>Called if an event happened. </p> | ||
185 | <p>Please take care that you should only return 'true' when you want to _prevent_ Irrlicht from processing the event any further. So 'true' does mean that an event is completely done. Therefore your return value for all unprocessed events should be 'false'. </p> | ||
186 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if the event was processed. </dd></dl> | ||
187 | |||
188 | <p>Implemented in <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html#a54b1799e21722d9e6ce5b8e4bdb2e80a">irr::gui::IGUIElement</a>, <a class="el" href="classirr_1_1scene_1_1_i_camera_scene_node.html#af27145518f43a17f803cdea086f68f3c">irr::scene::ICameraSceneNode</a>, and <a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html#aca20b841bb586cd9654464b001a7b6aa">irr::scene::ISceneNodeAnimator</a>.</p> | ||
189 | |||
190 | </div> | ||
191 | </div> | ||
192 | <hr/>The documentation for this class was generated from the following file:<ul> | ||
193 | <li><a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a></li> | ||
194 | </ul> | ||
195 | </div> | ||
196 | </div> | ||
197 | <div id="nav-path" class="navpath"> | ||
198 | <ul> | ||
199 | <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li> | ||
200 | <li class="navelem"><a class="el" href="classirr_1_1_i_event_receiver.html">IEventReceiver</a> </li> | ||
201 | <!-- window showing the filter options --> | ||
202 | <div id="MSearchSelectWindow" | ||
203 | onmouseover="return searchBox.OnSearchSelectShow()" | ||
204 | onmouseout="return searchBox.OnSearchSelectHide()" | ||
205 | onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
206 | <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div> | ||
207 | |||
208 | <!-- iframe showing the search results (closed by default) --> | ||
209 | <div id="MSearchResultsWindow"> | ||
210 | <iframe src="javascript:void(0)" frameborder="0" | ||
211 | name="MSearchResults" id="MSearchResults"> | ||
212 | </iframe> | ||
213 | </div> | ||
214 | |||
215 | |||
216 | <li class="footer"> | ||
217 | <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht | ||
218 | Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:42 for Irrlicht 3D Engine by | ||
219 | <a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li> | ||
220 | </ul> | ||
221 | </div> | ||
222 | |||
223 | |||
224 | </body> | ||
225 | </html> | ||