82 lines
3.5 KiB
HTML
82 lines
3.5 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8"/>
|
|
<title>Pluie.Color.s – pluie-echo-0.1 – Vala Binding Reference</title>
|
|
<link href="../style.css" rel="stylesheet" type="text/css"/><script src="../scripts.js" type="text/javascript">
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div class="site_header">Pluie.Color.s – pluie-echo-0.1 Reference Manual</div>
|
|
<div class="site_body">
|
|
<div class="site_navigation">
|
|
<ul class="navi_main">
|
|
<li class="package_index"><a href="../index.html">Packages</a></li>
|
|
</ul>
|
|
<hr class="navi_hr"/>
|
|
<ul class="navi_main">
|
|
<li class="package"><a href="index.htm">pluie-echo-0.1</a></li>
|
|
</ul>
|
|
<hr class="navi_hr"/>
|
|
<ul class="navi_main">
|
|
<li class="namespace"><a href="Pluie.html">Pluie</a></li>
|
|
</ul>
|
|
<hr class="navi_hr"/>
|
|
<ul class="navi_main">
|
|
<li class="class"><a href="Pluie.Color.html">Color</a></li>
|
|
</ul>
|
|
<hr class="navi_hr"/>
|
|
<ul class="navi_main">
|
|
<li class="property"><a href="Pluie.Color.bg.html">bg</a></li>
|
|
<li class="property"><a href="Pluie.Color.bold.html">bold</a></li>
|
|
<li class="property"><a href="Pluie.Color.fg.html">fg</a></li>
|
|
<li class="static_method"><a href="Pluie.Color.off.html">off</a></li>
|
|
<li class="creation_method"><a href="Pluie.Color.Color.html">Color</a></li>
|
|
<li class="method">s</li>
|
|
<li class="method"><a href="Pluie.Color.to_string.html">to_string</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="site_content">
|
|
<h1 class="main_title">s</h1>
|
|
<hr class="main_hr"/>
|
|
<h2 class="main_title">Description:</h2>
|
|
<div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="class">string</span></span> <b><span class="method">s</span></b> (<span class="main_basic_type"><span class="class">string</span></span>? label = <span class="main_literal">null</span>, <span class="main_basic_type"><span class="struct">bool</span></span> off = <span class="main_literal">true</span>, <span class="main_basic_type"><span class="struct">bool</span></span>? bold = <span class="main_literal">null</span>)
|
|
</div>
|
|
<div class="description">
|
|
<p>colorize a string</p>
|
|
<h2 class="main_title">Parameters:</h2>
|
|
<table class="main_parameter_table">
|
|
<tr>
|
|
<td class="main_parameter_table_name">label</td>
|
|
<td>
|
|
<p>the string to colorize </p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="main_parameter_table_name">off</td>
|
|
<td>
|
|
<p>enable/disable off sequence at end of label </p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="main_parameter_table_name">bold</td>
|
|
<td>
|
|
<p>override bold attribute for label </p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="main_title">Returns:</h2>
|
|
<table class="main_parameter_table">
|
|
<tr>
|
|
<td>
|
|
<p>the colorized string with proper ansi escape color sequence </p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div><br/>
|
|
<div class="site_footer">Generated by <a href="http://www.valadoc.org/">Valadoc</a>
|
|
</div>
|
|
</body>
|
|
</html> |