-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathform_8h_source.html
88 lines (86 loc) · 18.9 KB
/
form_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenCK: form.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="openck48x48.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenCK
 <span id="projectnumber">0.0.alpha1</span>
</div>
<div id="projectbrief">An Open Source replacement for Bethesda's Creation Kit written in C++ in the Qt framework.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_c1be8d27e7f84178e95f152701110b19.html">data</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">form.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="form_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">** recordparent.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">**</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">** Copyright © Beyond Skyrim Development Team, 2017.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">** This file is part of OPENCK (https://github.com/Beyond-Skyrim/openck)</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">**</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">** OpenCK is free software; this file may be used under the terms of the GNU</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">** General Public License version 3.0 or later as published by the Free Software</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">** Foundation and appearing in the file LICENSE.GPL included in the</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">** packaging of this file.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">**</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">** OpenCK is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">** but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">**</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">** Please review the following information to ensure the GNU General Public</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">** License version 3.0 requirements will be met:</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">** http://www.gnu.org/copyleft/gpl.html.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">**</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">** You should have received a copy of the GNU General Public License version</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">** 3.0 along with OpenCK; if not, write to the Free Software Foundation,</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">** Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">**</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">** Created Date: 10-Jul-2017</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">*/</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifndef FORM_H</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define FORM_H</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define FORMHEADER_MEMBER(type, name) \</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">private: \</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"> type name; \</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">public: \</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"> const type& get##name##() const { return name; } \</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"> void set##name##(const type& newval) { name = newval; }</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include <array></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include <QChar></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include <QtEndian></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include <QObject></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include <<a class="code" href="reader_8h.html">io/reader.h</a>></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">namespace </span><a class="code" href="namespaceesx.html">esx</a></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> {</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="form_8h.html#a058797f68fd2164944c24ef57a029a60"> 53</a></span>  <span class="keyword">enum</span> <a class="code" href="form_8h.html#a058797f68fd2164944c24ef57a029a60">FormName</a></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  Default,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  TES4,</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  GameSetting,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  Keyword,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  LocationReferenceType,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  Action,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  TextureSet,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  GlobalVariable,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  Class</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  };</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">typedef</span> <a class="code" href="form_8h.html#a058797f68fd2164944c24ef57a029a60">FormName</a> <a class="code" href="form_8h.html#a058797f68fd2164944c24ef57a029a60">formName</a>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structesx_1_1_subrecord_header.html"> 72</a></span>  <span class="keyword">struct </span><a class="code" href="structesx_1_1_subrecord_header.html">SubrecordHeader</a></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  quint32 type;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  quint16 size;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  };</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classesx_1_1_form_header.html"> 82</a></span>  <span class="keyword">class </span><a class="code" href="classesx_1_1_form_header.html">FormHeader</a></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  FORMHEADER_MEMBER(formName, Name)</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  FORMHEADER_MEMBER(quint32, Type)</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  FORMHEADER_MEMBER(quint32, DataSize)</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  FORMHEADER_MEMBER(quint32, Flags)</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  FORMHEADER_MEMBER(quint32, ID)</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  FORMHEADER_MEMBER(quint32, Revision)</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  FORMHEADER_MEMBER(quint32, Version)</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  FORMHEADER_MEMBER(quint16, Unknown)</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  };</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classesx_1_1_form.html"> 98</a></span>  <span class="keyword">class </span><a class="code" href="classesx_1_1_form.html">Form</a> : <span class="keyword">public</span> QObject</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  {</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classesx_1_1_form.html">Form</a>() {}</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">virtual</span> ~<a class="code" href="classesx_1_1_form.html">Form</a>() {}</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(<a class="code" href="classio_1_1_reader.html">io::Reader</a>& r) {}</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> addForm() {}</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> readForm() {}</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">void</span> readHeader(<a class="code" href="classio_1_1_reader.html">io::Reader</a>& r, <span class="keyword">const</span> quint32 type);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="classesx_1_1_form_header.html">FormHeader</a> getHeader() <span class="keyword">const</span>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="structesx_1_1_subrecord_header.html">SubrecordHeader</a> readSubrecord(<a class="code" href="classio_1_1_reader.html">io::Reader</a>& r, quint32* read);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  quint32 getSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classesx_1_1_form.html#a61483cc9f38e8da57caeedc9053ffc2f"> 118</a></span>  <a class="code" href="classesx_1_1_form_header.html">FormHeader</a> <a class="code" href="classesx_1_1_form.html#a61483cc9f38e8da57caeedc9053ffc2f">header</a>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  };</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> }</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor">#endif // FORM_H</span></div><div class="ttc" id="reader_8h_html"><div class="ttname"><a href="reader_8h.html">reader.h</a></div><div class="ttdoc">Functions to read raw data from the file stream. </div></div>
<div class="ttc" id="classesx_1_1_form_html"><div class="ttname"><a href="classesx_1_1_form.html">esx::Form</a></div><div class="ttdoc">The base class for forms in .esp and .esm files. </div><div class="ttdef"><b>Definition:</b> form.h:98</div></div>
<div class="ttc" id="namespaceesx_html"><div class="ttname"><a href="namespaceesx.html">esx</a></div><div class="ttdef"><b>Definition:</b> form.cpp:32</div></div>
<div class="ttc" id="form_8h_html_a058797f68fd2164944c24ef57a029a60"><div class="ttname"><a href="form_8h.html#a058797f68fd2164944c24ef57a029a60">esx::FormName</a></div><div class="ttdeci">FormName</div><div class="ttdoc">The name of the Form. </div><div class="ttdef"><b>Definition:</b> form.h:53</div></div>
<div class="ttc" id="classio_1_1_reader_html"><div class="ttname"><a href="classio_1_1_reader.html">io::Reader</a></div><div class="ttdoc">Static class from which files are read. </div><div class="ttdef"><b>Definition:</b> reader.h:46</div></div>
<div class="ttc" id="classesx_1_1_form_header_html"><div class="ttname"><a href="classesx_1_1_form_header.html">esx::FormHeader</a></div><div class="ttdoc">The header of the nonparsed form. </div><div class="ttdef"><b>Definition:</b> form.h:82</div></div>
<div class="ttc" id="classesx_1_1_form_html_a61483cc9f38e8da57caeedc9053ffc2f"><div class="ttname"><a href="classesx_1_1_form.html#a61483cc9f38e8da57caeedc9053ffc2f">esx::Form::header</a></div><div class="ttdeci">FormHeader header</div><div class="ttdoc">header Form header. </div><div class="ttdef"><b>Definition:</b> form.h:118</div></div>
<div class="ttc" id="structesx_1_1_subrecord_header_html"><div class="ttname"><a href="structesx_1_1_subrecord_header.html">esx::SubrecordHeader</a></div><div class="ttdoc">The parsed header for each subrecord. </div><div class="ttdef"><b>Definition:</b> form.h:72</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 14 2018 18:39:56 for OpenCK by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>