108 lines
8.3 KiB
HTML
108 lines
8.3 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8"/>
|
|
<title>Pluie.Color – 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 – 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">Color</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"><a href="Pluie.Color.s.html">s</a></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">Color</h1>
|
|
<hr class="main_hr"/>
|
|
<h2 class="main_title">Object Hierarchy:</h2>
|
|
<img class="main_diagram" usemap="#Pluie.Color" alt="Object hierarchy for Color" src="img/Pluie.Color.png"/>
|
|
|
|
<map id="Pluie.Color" name="Pluie.Color">
|
|
<area shape="rect" id="node1" href="Pluie.Color.html" title="Pluie.Color" alt="" coords="5,5,111,53"/>
|
|
</map>
|
|
|
|
<h2 class="main_title">Description:</h2>
|
|
<div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">class</span> <b><span class="class">Color</span></b>
|
|
</div>
|
|
<div class="description">
|
|
<p>a Class representing an Ansi Extended 8 bit Color with foreground, background and bold attributes</p>
|
|
<p><pre class="main_source"><code><span class="main_keyword">using</span> Pluie;<br/><br/><span class="main_basic_type">int</span> main (<span class="main_basic_type">string</span>[] args)<br/>{<br/> <span class="main_keyword">var</span> c<span class="main_literal">1</span> = <span class="main_keyword">new</span> Color(<span class="main_literal">37</span>, <span class="main_literal">false</span>);<br/> <span class="main_keyword">var</span> c<span class="main_literal">2</span> = <span class="main_keyword">new</span> Color(<span class="main_literal">204</span>, <span class="main_literal">true</span>);<br/> <span class="main_keyword">var</span> c<span class="main_literal">3</span> = <span class="main_keyword">new</span> Color(<span class="main_literal">15</span>, <span class="main_literal">true</span>, <span class="main_literal">24</span>);<br/> stdout.printf (<span class="main_literal">"[</span><span class="main_escape">%s</span><span class="main_literal">][</span><span class="main_escape">%s</span><span class="main_literal">] </span><span class="main_escape">%s</span><span class="main_literal"> "</span>, c<span class="main_literal">1</span>.s (<span class="main_literal">"oki"</span>), c<span class="main_literal">2</span>.s (<span class="main_literal">"very"</span>), c<span class="main_literal">3</span>.s (<span class="main_literal">"cool"</span>));<br/> <span class="main_keyword">return</span> <span class="main_literal">0</span>;<br/>}</code></pre>
|
|
</p>
|
|
<p>valac --pkg pluie-echo-0.1 color.vala</p>
|
|
</div><br/>
|
|
<div class="namespace_note"><b>Namespace:</b> <a href="Pluie.html">Pluie</a>
|
|
</div>
|
|
<div class="package_note"><b>Package:</b> <a href="index.htm">pluie-echo-0.1</a>
|
|
</div>
|
|
<h2 class="main_title">Content:</h2>
|
|
<h3 class="main_title">Properties:</h3>
|
|
<ul class="navi_inline">
|
|
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">uint8</span></span>? <b><a href="Pluie.Color.fg.html" class="property">fg</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
|
|
</span>
|
|
<div class="leaf_brief_description"><span class="brief_description">foreground color code - 0 to 255</span>
|
|
</div></li>
|
|
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">uint8</span></span>? <b><a href="Pluie.Color.bg.html" class="property">bg</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
|
|
</span>
|
|
<div class="leaf_brief_description"><span class="brief_description">background color code - 0 to 255</span>
|
|
</div></li>
|
|
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">bool</span></span> <b><a href="Pluie.Color.bold.html" class="property">bold</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
|
|
</span>
|
|
<div class="leaf_brief_description"><span class="brief_description">enable bold attribute</span>
|
|
</div></li>
|
|
</ul>
|
|
<h3 class="main_title">Static methods:</h3>
|
|
<ul class="navi_inline">
|
|
<li class="static_method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">static</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Pluie.Color.off.html" class="static_method">off</a></b> ()
|
|
</span>
|
|
<div class="leaf_brief_description"><span class="brief_description">disable escape color sequence</span>
|
|
</div></li>
|
|
</ul>
|
|
<h3 class="main_title">Creation methods:</h3>
|
|
<ul class="navi_inline">
|
|
<li class="creation_method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <b><a href="Pluie.Color.Color.html" class="creation_method">Color</a></b> (<span class="main_basic_type"><span class="struct">uint8</span></span>? fg = <span class="main_literal">15</span>, <span class="main_basic_type"><span class="struct">bool</span></span> bold = <span class="main_literal">false</span>, <span class="main_basic_type"><span class="struct">uint8</span></span>? bg = <span class="main_literal">null</span>)
|
|
</span>
|
|
<div class="leaf_brief_description">
|
|
</div></li>
|
|
</ul>
|
|
<h3 class="main_title">Methods:</h3>
|
|
<ul class="navi_inline">
|
|
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Pluie.Color.to_string.html" class="method">to_string</a></b> ()
|
|
</span>
|
|
<div class="leaf_brief_description"><span class="brief_description">return ansi extended color escape string sequence</span>
|
|
</div></li>
|
|
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Pluie.Color.s.html" class="method">s</a></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>)
|
|
</span>
|
|
<div class="leaf_brief_description"><span class="brief_description">colorize a string</span>
|
|
</div></li>
|
|
</ul>
|
|
</div>
|
|
</div><br/>
|
|
<div class="site_footer">Generated by <a href="http://www.valadoc.org/">Valadoc</a>
|
|
</div>
|
|
</body>
|
|
</html> |