Files
openmw.github.io/classCSMDoc_1_1WriteHeaderStage.html
Travis CI 1afc571f3d Deploy code docs to GitHub Pages Travis build: 4489
Commit: 6e51b4ff57f622c4e11205ec444ffac21e73bbf7
2017-01-24 02:13:55 +00:00

321 lines
17 KiB
HTML

<!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.6"/>
<title>OpenMW: CSMDoc::WriteHeaderStage Class 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.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 style="padding-left: 0.5em;">
<div id="projectname">OpenMW
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(13)"><span class="SelectionMark">&#160;</span>Pages</a></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="namespaceCSMDoc.html">CSMDoc</a></li><li class="navelem"><a class="el" href="classCSMDoc_1_1WriteHeaderStage.html">WriteHeaderStage</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classCSMDoc_1_1WriteHeaderStage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CSMDoc::WriteHeaderStage Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="savingstages_8hpp_source.html">savingstages.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CSMDoc::WriteHeaderStage:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classCSMDoc_1_1WriteHeaderStage__inherit__graph.svg" width="208" height="302"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<div class="dynheader">
Collaboration diagram for CSMDoc::WriteHeaderStage:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classCSMDoc_1_1WriteHeaderStage__coll__graph.svg" width="4332" height="2752"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a35168c8b408c86309fda301cc3a3e25f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSMDoc_1_1WriteHeaderStage.html#a35168c8b408c86309fda301cc3a3e25f">WriteHeaderStage</a> (<a class="el" href="classCSMDoc_1_1Document.html">Document</a> &amp;document, <a class="el" href="classCSMDoc_1_1SavingState.html">SavingState</a> &amp;state, <a class="el" href="classbool.html">bool</a> simple)</td></tr>
<tr class="separator:a35168c8b408c86309fda301cc3a3e25f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8cc1c9c0003977dcb095bc42092ac94"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classint.html">int</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSMDoc_1_1WriteHeaderStage.html#ad8cc1c9c0003977dcb095bc42092ac94">setup</a> ()</td></tr>
<tr class="separator:ad8cc1c9c0003977dcb095bc42092ac94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a9986efb2e242730c0cbd06206cde80"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSMDoc_1_1WriteHeaderStage.html#a5a9986efb2e242730c0cbd06206cde80">perform</a> (<a class="el" href="classint.html">int</a> stage, <a class="el" href="classCSMDoc_1_1Messages.html">Messages</a> &amp;messages)</td></tr>
<tr class="memdesc:a5a9986efb2e242730c0cbd06206cde80"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classCSMDoc_1_1Messages.html">Messages</a> resulting from this stage will be appended to <em>messages</em>. <a href="#a5a9986efb2e242730c0cbd06206cde80">More...</a><br/></td></tr>
<tr class="separator:a5a9986efb2e242730c0cbd06206cde80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classCSMDoc_1_1Stage"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCSMDoc_1_1Stage')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classCSMDoc_1_1Stage.html">CSMDoc::Stage</a></td></tr>
<tr class="memitem:a9241239fa8706e2093367eb584b8b553 inherit pub_methods_classCSMDoc_1_1Stage"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSMDoc_1_1Stage.html#a9241239fa8706e2093367eb584b8b553">~Stage</a> ()</td></tr>
<tr class="separator:a9241239fa8706e2093367eb584b8b553 inherit pub_methods_classCSMDoc_1_1Stage"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:adfe3b8d03ce0fc402a0b7d73a5bb2295"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCSMDoc_1_1Document.html">Document</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSMDoc_1_1WriteHeaderStage.html#adfe3b8d03ce0fc402a0b7d73a5bb2295">mDocument</a></td></tr>
<tr class="separator:adfe3b8d03ce0fc402a0b7d73a5bb2295"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adebd4bb27ac44c4ebbac3f67904ca044"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCSMDoc_1_1SavingState.html">SavingState</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSMDoc_1_1WriteHeaderStage.html#adebd4bb27ac44c4ebbac3f67904ca044">mState</a></td></tr>
<tr class="separator:adebd4bb27ac44c4ebbac3f67904ca044"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab56cbb31a262674515e3e0d7378430e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSMDoc_1_1WriteHeaderStage.html#ab56cbb31a262674515e3e0d7378430e6">mSimple</a></td></tr>
<tr class="separator:ab56cbb31a262674515e3e0d7378430e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a35168c8b408c86309fda301cc3a3e25f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSMDoc::WriteHeaderStage::WriteHeaderStage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCSMDoc_1_1Document.html">Document</a> &amp;&#160;</td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCSMDoc_1_1SavingState.html">SavingState</a> &amp;&#160;</td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbool.html">bool</a>&#160;</td>
<td class="paramname"><em>simple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">simple</td><td>Simplified header (used for project files). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5a9986efb2e242730c0cbd06206cde80"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CSMDoc::WriteHeaderStage::perform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classint.html">int</a>&#160;</td>
<td class="paramname"><em>stage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCSMDoc_1_1Messages.html">Messages</a> &amp;&#160;</td>
<td class="paramname"><em>messages</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classCSMDoc_1_1Messages.html">Messages</a> resulting from this stage will be appended to <em>messages</em>. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>refine dependency list (at least remove redundant dependencies) </dd></dl>
<p>Implements <a class="el" href="classCSMDoc_1_1Stage.html#ad1a745da9092f2fb6ac7a4942a2a2bf7">CSMDoc::Stage</a>.</p>
</div>
</div>
<a class="anchor" id="ad8cc1c9c0003977dcb095bc42092ac94"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classint.html">int</a> CSMDoc::WriteHeaderStage::setup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>number of steps </dd></dl>
<p>Implements <a class="el" href="classCSMDoc_1_1Stage.html#ae20cbb129eb111328df48dbd42092db2">CSMDoc::Stage</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="adfe3b8d03ce0fc402a0b7d73a5bb2295"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCSMDoc_1_1Document.html">Document</a>&amp; CSMDoc::WriteHeaderStage::mDocument</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab56cbb31a262674515e3e0d7378430e6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbool.html">bool</a> CSMDoc::WriteHeaderStage::mSimple</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adebd4bb27ac44c4ebbac3f67904ca044"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCSMDoc_1_1SavingState.html">SavingState</a>&amp; CSMDoc::WriteHeaderStage::mState</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/travis/build/OpenMW/openmw/apps/opencs/model/doc/<a class="el" href="savingstages_8hpp_source.html">savingstages.hpp</a></li>
<li>/home/travis/build/OpenMW/openmw/apps/opencs/model/doc/<a class="el" href="savingstages_8cpp.html">savingstages.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 24 2017 02:05:56 for OpenMW by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>