atria-tools/lutin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
lutin/classlutin_1_1arg_1_1_arg_element.html

219 lines
10 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.8.8-->
<!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="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>lutin: build system and packager: lutin.arg.ArgElement Class Reference</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">lutin: build system and packager 1.2.6</a>
</div>
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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 class="current"><a href="annotated.html"><span>Classes</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="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.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)">
</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"><b>lutin</b></li><li class="navelem"><b>arg</b></li><li class="navelem"><a class="el" href="classlutin_1_1arg_1_1_arg_element.html">ArgElement</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classlutin_1_1arg_1_1_arg_element-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">lutin.arg.ArgElement Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:aa2a351679e16cccf50616557946937be"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1arg_1_1_arg_element.html#aa2a351679e16cccf50616557946937be">get_option_name</a> (self)</td></tr>
<tr class="separator:aa2a351679e16cccf50616557946937be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a612f5a6a6d396113e8ecb95aaeda2f43"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1arg_1_1_arg_element.html#a612f5a6a6d396113e8ecb95aaeda2f43">get_arg</a> (self)</td></tr>
<tr class="separator:a612f5a6a6d396113e8ecb95aaeda2f43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af96f579ae4174a56bfa6bd13a7e19ad3"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1arg_1_1_arg_element.html#af96f579ae4174a56bfa6bd13a7e19ad3">display</a> (self)</td></tr>
<tr class="separator:af96f579ae4174a56bfa6bd13a7e19ad3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:af3d63dcf0b6b4e7d67a4f436828c5968"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3d63dcf0b6b4e7d67a4f436828c5968"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>option</b></td></tr>
<tr class="separator:af3d63dcf0b6b4e7d67a4f436828c5968"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acebac537e49c852b5bea6dbec6a89fb9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acebac537e49c852b5bea6dbec6a89fb9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>arg</b></td></tr>
<tr class="separator:acebac537e49c852b5bea6dbec6a89fb9"><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>Single argument class. </p>
<p>It permit to define the getted argument. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af96f579ae4174a56bfa6bd13a7e19ad3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.arg.ArgElement.display </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Display the Argument property. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>Class handle </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a612f5a6a6d396113e8ecb95aaeda2f43"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.arg.ArgElement.get_arg </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get argument data set by the user. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>Class handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>(string) The argument value </dd></dl>
</div>
</div>
<a class="anchor" id="aa2a351679e16cccf50616557946937be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.arg.ArgElement.get_option_name </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of the argument: (write in fullmode ex: '&ndash;verbose' even if user write '-v') </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>Class handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>(string) The argument name </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>lutin/lutin/arg.py</li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 6 2016 13:29:09 for lutin: build system and packager by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink