323 lines
15 KiB
HTML
323 lines
15 KiB
HTML
<!-- 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.ArgDefine 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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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_define.html">ArgDefine</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="classlutin_1_1arg_1_1_arg_define-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">lutin.arg.ArgDefine 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:a1b85e317865d3370499722e657a52352"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1arg_1_1_arg_define.html#a1b85e317865d3370499722e657a52352">get_option_small</a> (self)</td></tr>
|
|
<tr class="separator:a1b85e317865d3370499722e657a52352"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1d6c8e96f7824cce5d35e6c0abaed3d"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1arg_1_1_arg_define.html#ad1d6c8e96f7824cce5d35e6c0abaed3d">get_option_big</a> (self)</td></tr>
|
|
<tr class="separator:ad1d6c8e96f7824cce5d35e6c0abaed3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf67ee7ad93cae020955fa518e4637fa"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1arg_1_1_arg_define.html#adf67ee7ad93cae020955fa518e4637fa">need_parameters</a> (self)</td></tr>
|
|
<tr class="separator:adf67ee7ad93cae020955fa518e4637fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5034434b50ce4e0bf16181a88ae30c67"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1arg_1_1_arg_define.html#a5034434b50ce4e0bf16181a88ae30c67">get_porperties</a> (self)</td></tr>
|
|
<tr class="separator:a5034434b50ce4e0bf16181a88ae30c67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c32d0423801b5df641261418680f9a7"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1arg_1_1_arg_define.html#a1c32d0423801b5df641261418680f9a7">check_availlable</a> (self, argument)</td></tr>
|
|
<tr class="separator:a1c32d0423801b5df641261418680f9a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acdbc408e7a630a3217a65b6c384f8a8a"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1arg_1_1_arg_define.html#acdbc408e7a630a3217a65b6c384f8a8a">display</a> (self)</td></tr>
|
|
<tr class="separator:acdbc408e7a630a3217a65b6c384f8a8a"><td class="memSeparator" colspan="2"> </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:a34dc47b5d1dcdfc3f65144b0a1f3e84e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34dc47b5d1dcdfc3f65144b0a1f3e84e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>option_small</b></td></tr>
|
|
<tr class="separator:a34dc47b5d1dcdfc3f65144b0a1f3e84e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a941c62c0e01781150540fcce25705095"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a941c62c0e01781150540fcce25705095"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>option_big</b></td></tr>
|
|
<tr class="separator:a941c62c0e01781150540fcce25705095"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96371ecbe866705480f6ddf49f7ea8ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96371ecbe866705480f6ddf49f7ea8ca"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>list</b></td></tr>
|
|
<tr class="separator:a96371ecbe866705480f6ddf49f7ea8ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b93aa879ff4fb5bf92c4886a79a414f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b93aa879ff4fb5bf92c4886a79a414f"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>have_param</b></td></tr>
|
|
<tr class="separator:a7b93aa879ff4fb5bf92c4886a79a414f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17af2f55c2267236293ebd2dc21010f2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17af2f55c2267236293ebd2dc21010f2"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>description</b></td></tr>
|
|
<tr class="separator:a17af2f55c2267236293ebd2dc21010f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Declare a possibility of an argument value. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a1c32d0423801b5df641261418680f9a7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def lutin.arg.ArgDefine.check_availlable </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>argument</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if the user added value is correct or not with the list of availlable value. </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>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">argument</td><td>(string) User parameter value (string) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True The parameter is OK </dd>
|
|
<dd>
|
|
False The parameter is NOT Availlable </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acdbc408e7a630a3217a65b6c384f8a8a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def lutin.arg.ArgDefine.display </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Display the argument property when user request help. </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="ad1d6c8e96f7824cce5d35e6c0abaed3d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def lutin.arg.ArgDefine.get_option_big </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the big name of the option ex: '–verbose'. </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) Big name value </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1b85e317865d3370499722e657a52352"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def lutin.arg.ArgDefine.get_option_small </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the small name of the option ex: '-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) Small name value </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5034434b50ce4e0bf16181a88ae30c67"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def lutin.arg.ArgDefine.get_porperties </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Compatibility with <a class="el" href="classlutin_1_1arg_1_1_arg_section.html">ArgSection</a> class. </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) empty string </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adf67ee7ad93cae020955fa518e4637fa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def lutin.arg.ArgDefine.need_parameters </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the status of getting user parameter value. </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>True The user must write a value </dd>
|
|
<dd>
|
|
False The user must NOT write a value </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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|