openck-docs/form_8h.html at master · Open-CK/openck-docs · GitHub

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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<!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 File Reference</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
   &#160;<span id="projectnumber">0.0.alpha1</span>
   </div>
   <div id="projectbrief">An Open Source replacement for Bethesda&#39;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="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">form.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Header for the abstract form class.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;array&gt;</code><br />
<code>#include &lt;QChar&gt;</code><br />
<code>#include &lt;QtEndian&gt;</code><br />
<code>#include &lt;QObject&gt;</code><br />
<code>#include &lt;<a class="el" href="reader_8h_source.html">io/reader.h</a>&gt;</code><br />
</div>
<p><a href="form_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structesx_1_1_subrecord_header.html">esx::SubrecordHeader</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The parsed header for each subrecord.  <a href="structesx_1_1_subrecord_header.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classesx_1_1_form_header.html">esx::FormHeader</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The header of the nonparsed form.  <a href="classesx_1_1_form_header.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classesx_1_1_form.html">esx::Form</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The base class for forms in .esp and .esm files.  <a href="classesx_1_1_form.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:adc72ca90f4f76fff75a9e372e36f861d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><b>FORMHEADER_MEMBER</b>(type,  name)</td></tr>
<tr class="separator:adc72ca90f4f76fff75a9e372e36f861d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a7522d04867c5d3d2fdf8f97cb98ec43d"><td class="memItemLeft" align="right" valign="top"><a id="a7522d04867c5d3d2fdf8f97cb98ec43d"></a>
typedef FormName&#160;</td><td class="memItemRight" valign="bottom"><b>esx::formName</b></td></tr>
<tr class="separator:a7522d04867c5d3d2fdf8f97cb98ec43d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a058797f68fd2164944c24ef57a029a60"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="form_8h.html#a058797f68fd2164944c24ef57a029a60">esx::FormName</a> { <br />
&#160;&#160;<b>Default</b>,
<b>TES4</b>,
<b>GameSetting</b>,
<b>Keyword</b>,
<br />
&#160;&#160;<b>LocationReferenceType</b>,
<b>Action</b>,
<b>TextureSet</b>,
<b>GlobalVariable</b>,
<br />
&#160;&#160;<b>Class</b>
<br />
 }<tr class="memdesc:a058797f68fd2164944c24ef57a029a60"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the Form.  <a href="form_8h.html#a058797f68fd2164944c24ef57a029a60">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a058797f68fd2164944c24ef57a029a60"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header for the abstract form class. </p>
<p>Header for the Global Variable form class.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="adc72ca90f4f76fff75a9e372e36f861d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc72ca90f4f76fff75a9e372e36f861d">&#9670;&nbsp;</a></span>FORMHEADER_MEMBER</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define FORMHEADER_MEMBER</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">type, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">name&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">private</span>: \</div><div class="line">    type name; \</div><div class="line">public: \</div><div class="line">    const type&amp; <span class="keyword">get</span>##name##() <span class="keyword">const</span> { <span class="keywordflow">return</span> name; } \</div><div class="line">    void <span class="keyword">set</span>##name##(<span class="keyword">const</span> type&amp; newval) { name = newval; }</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="file_a058797f68fd2164944c24ef57a029a60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#file_a058797f68fd2164944c24ef57a029a60">&#9670;&nbsp;</a></span>FormName</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="form_8h.html#a058797f68fd2164944c24ef57a029a60">esx::FormName</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The name of the Form. </p>
<p>The enum for the name of the Form. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 14 2018 18:39:56 for OpenCK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>