classCustomFormatter.html 12.8 KB
Newer Older
RomainFeron's avatar
RomainFeron committed
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Romain Feron's avatar
Romain Feron committed
2
3
4
5
<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"/>
RomainFeron's avatar
RomainFeron committed
6
<meta name="generator" content="Doxygen 1.8.17"/>
Romain Feron's avatar
Romain Feron committed
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
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RADSex: CustomFormatter 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">RADSex
   &#160;<span id="projectnumber">1.0.0</span>
   </div>
   <div id="projectbrief">RAD-Sequencing analysis pipeline for sex determination</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
RomainFeron's avatar
RomainFeron committed
38
<!-- Generated by Doxygen 1.8.17 -->
Romain Feron's avatar
Romain Feron committed
39
<script type="text/javascript">
RomainFeron's avatar
RomainFeron committed
40
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Romain Feron's avatar
Romain Feron committed
41
var searchBox = new SearchBox("searchBox", "search",false,'Search');
RomainFeron's avatar
RomainFeron committed
42
/* @license-end */
Romain Feron's avatar
Romain Feron committed
43
44
45
46
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
RomainFeron's avatar
RomainFeron committed
47
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Romain Feron's avatar
Romain Feron committed
48
49
50
51
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
RomainFeron's avatar
RomainFeron committed
52
/* @license-end */</script>
Romain Feron's avatar
Romain Feron committed
53
54
55
56
57
58
59
60
61
62
63
64
65
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
RomainFeron's avatar
RomainFeron committed
66
67
68
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classCustomFormatter.html',''); initResizable(); });
/* @license-end */
Romain Feron's avatar
Romain Feron committed
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
</script>
<div id="doc-content">
<!-- 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 class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classCustomFormatter-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CustomFormatter Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Custom CLI11 Formatter.  
 <a href="classCustomFormatter.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="arg__parser_8h_source.html">arg_parser.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CustomFormatter:</div>
<div class="dyncontent">
 <div class="center">
RomainFeron's avatar
RomainFeron committed
103
  <img src="classCustomFormatter.png" alt=""/>
Romain Feron's avatar
Romain Feron committed
104
105
106
107
108
 </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:a2cd26a35befd81c507255cc61f2ea0c6"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCustomFormatter.html#a2cd26a35befd81c507255cc61f2ea0c6">make_option</a> (const CLI::Option *opt, const bool is_positional) const</td></tr>
RomainFeron's avatar
RomainFeron committed
109
<tr class="memdesc:a2cd26a35befd81c507255cc61f2ea0c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format help message for an option.  <a href="classCustomFormatter.html#a2cd26a35befd81c507255cc61f2ea0c6">More...</a><br /></td></tr>
Romain Feron's avatar
Romain Feron committed
110
111
<tr class="separator:a2cd26a35befd81c507255cc61f2ea0c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebb02977b6d292d00213472667f76046"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCustomFormatter.html#aebb02977b6d292d00213472667f76046">make_description</a> (const CLI::App *) const</td></tr>
RomainFeron's avatar
RomainFeron committed
112
<tr class="memdesc:aebb02977b6d292d00213472667f76046"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format command description.  <a href="classCustomFormatter.html#aebb02977b6d292d00213472667f76046">More...</a><br /></td></tr>
Romain Feron's avatar
Romain Feron committed
113
114
<tr class="separator:aebb02977b6d292d00213472667f76046"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2578999ac91d0136d0349ebdeb3c6435"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCustomFormatter.html#a2578999ac91d0136d0349ebdeb3c6435">set_column_widths</a> (const CLI::App &amp;parser)</td></tr>
RomainFeron's avatar
RomainFeron committed
115
<tr class="memdesc:a2578999ac91d0136d0349ebdeb3c6435"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set column widths in help message for a CLI::App.  <a href="classCustomFormatter.html#a2578999ac91d0136d0349ebdeb3c6435">More...</a><br /></td></tr>
Romain Feron's avatar
Romain Feron committed
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<tr class="separator:a2578999ac91d0136d0349ebdeb3c6435"><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:abbcaea7bc716a16ed5fe23ed8caf5c9b"><td class="memItemLeft" align="right" valign="top"><a id="abbcaea7bc716a16ed5fe23ed8caf5c9b"></a>
uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCustomFormatter.html#abbcaea7bc716a16ed5fe23ed8caf5c9b">column_widths</a> [3] {0, 0, 0}</td></tr>
<tr class="memdesc:abbcaea7bc716a16ed5fe23ed8caf5c9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum width of each column, in order: flags, type, description. <br /></td></tr>
<tr class="separator:abbcaea7bc716a16ed5fe23ed8caf5c9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8976f459918d11b5696efdb76dc2cff2"><td class="memItemLeft" align="right" valign="top"><a id="a8976f459918d11b5696efdb76dc2cff2"></a>
uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCustomFormatter.html#a8976f459918d11b5696efdb76dc2cff2">border_width</a> = 4</td></tr>
<tr class="memdesc:a8976f459918d11b5696efdb76dc2cff2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define number of spaces between two columns. <br /></td></tr>
<tr class="separator:a8976f459918d11b5696efdb76dc2cff2"><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>Custom CLI11 Formatter. </p>
<p>This class is used to override default help message format in CLI11 Formatter. </p>

<p class="definition">Definition at line <a class="el" href="arg__parser_8h_source.html#l00073">73</a> of file <a class="el" href="arg__parser_8h_source.html">arg_parser.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aebb02977b6d292d00213472667f76046"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebb02977b6d292d00213472667f76046">&#9670;&nbsp;</a></span>make_description()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string CustomFormatter::make_description </td>
          <td>(</td>
          <td class="paramtype">const CLI::App *&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Format command description. </p>
<p>Remove command description in CLI help message. </p><dl class="section return"><dt>Returns</dt><dd>An empty string </dd></dl>

<p class="definition">Definition at line <a class="el" href="arg__parser_8h_source.html#l00135">135</a> of file <a class="el" href="arg__parser_8h_source.html">arg_parser.h</a>.</p>

</div>
</div>
<a id="a2cd26a35befd81c507255cc61f2ea0c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cd26a35befd81c507255cc61f2ea0c6">&#9670;&nbsp;</a></span>make_option()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string CustomFormatter::make_option </td>
          <td>(</td>
          <td class="paramtype">const CLI::Option *&#160;</td>
          <td class="paramname"><em>opt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const bool&#160;</td>
          <td class="paramname"><em>is_positional</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Format help message for an option. </p>
<p>Generate a nicely formatted help message for an option, using column widths to align columns for all options properly.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">opt</td><td>Pointer to an CLI::Option instance </td></tr>
    <tr><td class="paramname">is_positional</td><td>Boolean indicating whether the option is positional</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string containing the formatted help message for the option </dd></dl>

<p class="definition">Definition at line <a class="el" href="arg__parser_8h_source.html#l00093">93</a> of file <a class="el" href="arg__parser_8h_source.html">arg_parser.h</a>.</p>

</div>
</div>
<a id="a2578999ac91d0136d0349ebdeb3c6435"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2578999ac91d0136d0349ebdeb3c6435">&#9670;&nbsp;</a></span>set_column_widths()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void CustomFormatter::set_column_widths </td>
          <td>(</td>
          <td class="paramtype">const CLI::App &amp;&#160;</td>
          <td class="paramname"><em>parser</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set column widths in help message for a CLI::App. </p>
<p>Determine column widths from the maximum element length in each column</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">parser</td><td>Pointer to a CLI::App instance </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="arg__parser_8h_source.html#l00149">149</a> of file <a class="el" href="arg__parser_8h_source.html">arg_parser.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
253
<li>/home/romain/work/code/radsex/src/<a class="el" href="arg__parser_8h_source.html">arg_parser.h</a></li>
Romain Feron's avatar
Romain Feron committed
254
255
256
257
258
259
260
261
262
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classCustomFormatter.html">CustomFormatter</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
RomainFeron's avatar
RomainFeron committed
263
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
Romain Feron's avatar
Romain Feron committed
264
265
266
267
  </ul>
</div>
</body>
</html>