sass-site/source/documentation/Sass/Engine/Line.html
2018-10-22 14:13:05 -07:00

880 lines
17 KiB
HTML

<!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" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Sass::Engine::Line
&mdash; Documentation by YARD 0.9.12
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../../assets/css/docs.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!Sass/Engine/Line.html";
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (L)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Sass.html" title="Sass (module)">Sass</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Engine.html" title="Sass::Engine (class)">Engine</a></span></span>
&raquo;
<span class="title">Line</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Sass::Engine::Line
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Struct</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Struct</li>
<li class="next">Sass::Engine::Line</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">.ruby-sass/lib/sass/engine.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A line of Sass code.</p>
<p>`text`: `String` : The text in the line, without any whitespace at the
beginning or end.</p>
<p>`tabs`: `Integer` : The level of indentation of the line.</p>
<p>`index`: `Integer` : The line number in the original document.</p>
<p>`offset`: `Integer` : The number of bytes in on the line that the text
begins.</p>
<pre class="code ruby"><code class="ruby">This ends up being the number of bytes of leading whitespace.
</code></pre>
<p>`filename`: `String` : The name of the file in which this line appeared.</p>
<p>`children`: `Array&lt;Line&gt;` : The lines nested below this one.</p>
<p>`comment_tab_str`: `String?` : The prefix indentation for this comment, if
it is a comment.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#children-instance_method" title="#children (instance method)">#<strong>children</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute children.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#comment_tab_str-instance_method" title="#comment_tab_str (instance method)">#<strong>comment_tab_str</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute comment_tab_str.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#filename-instance_method" title="#filename (instance method)">#<strong>filename</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute filename.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#index-instance_method" title="#index (instance method)">#<strong>index</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute index.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#offset-instance_method" title="#offset (instance method)">#<strong>offset</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute offset.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tabs-instance_method" title="#tabs (instance method)">#<strong>tabs</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute tabs.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#text-instance_method" title="#text (instance method)">#<strong>text</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute text.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#comment%3F-instance_method" title="#comment? (instance method)">#<strong>comment?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="children=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="children-instance_method">
#<strong>children</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute children</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of children</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/engine.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_children'>children</span>
<span class='ivar'>@children</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="comment_tab_str=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="comment_tab_str-instance_method">
#<strong>comment_tab_str</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute comment_tab_str</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of comment_tab_str</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/engine.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_comment_tab_str'>comment_tab_str</span>
<span class='ivar'>@comment_tab_str</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="filename=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="filename-instance_method">
#<strong>filename</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute filename</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of filename</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/engine.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_filename'>filename</span>
<span class='ivar'>@filename</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="index=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="index-instance_method">
#<strong>index</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute index</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of index</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/engine.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span>
<span class='ivar'>@index</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="offset=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="offset-instance_method">
#<strong>offset</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute offset</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of offset</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/engine.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_offset'>offset</span>
<span class='ivar'>@offset</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="tabs=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="tabs-instance_method">
#<strong>tabs</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute tabs</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of tabs</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/engine.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_tabs'>tabs</span>
<span class='ivar'>@tabs</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="text=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="text-instance_method">
#<strong>text</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute text</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of text</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/engine.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_text'>text</span>
<span class='ivar'>@text</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="comment?-instance_method">
#<strong>comment?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
125
126
127</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/engine.rb', line 125</span>
<span class='kw'>def</span> <span class='id identifier rubyid_comment?'>comment?</span>
<span class='id identifier rubyid_text'>text</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="../Engine.html#COMMENT_CHAR-constant" title="Sass::Engine::COMMENT_CHAR (constant)">COMMENT_CHAR</a></span></span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="../Engine.html#SASS_COMMENT_CHAR-constant" title="Sass::Engine::SASS_COMMENT_CHAR (constant)">SASS_COMMENT_CHAR</a></span></span> <span class='op'>||</span> <span class='id identifier rubyid_text'>text</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="../Engine.html#CSS_COMMENT_CHAR-constant" title="Sass::Engine::CSS_COMMENT_CHAR (constant)">CSS_COMMENT_CHAR</a></span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Oct 22 13:20:51 2018 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.12 (ruby-2.5.3).
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-535380-14', 'sass-lang.com');
ga('send', 'pageview');
</script>
</body>
</html>