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

746 lines
21 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::Tree::IfNode
&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/Tree/IfNode.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 (I)</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="../Tree.html" title="Sass::Tree (module)">Tree</a></span></span>
&raquo;
<span class="title">IfNode</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::Tree::IfNode
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="Node.html" title="Sass::Tree::Node (class)">Node</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Sass::Tree::Node (class)">Node</a></span></li>
<li class="next">Sass::Tree::IfNode</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/tree/if_node.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A dynamic node representing a Sass `@if` statement.</p>
<p><span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span>s are a little odd, in that they also represent `@else` and `@else
if`s. This is done as a linked list: each <span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span> has a link (<span class='object_link'><a href="#else-instance_method" title="Sass::Tree::IfNode#else (method)">#else</a></span>) to
the next <span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../Tree.html" title="Sass::Tree (module)">Sass::Tree</a></span></li>
</ul>
</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="#else-instance_method" title="#else (instance method)">#<strong>else</strong> &#x21d2; IfNode </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The next <span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span> in the if-else list, or `nil`.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expr-instance_method" title="#expr (instance method)">#<strong>expr</strong> &#x21d2; Script::Expr </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The conditional expression.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Sass::Tree::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#children-instance_method" title="Sass::Tree::Node#children (method)">#children</a></span>, <span class='object_link'><a href="Node.html#filename-instance_method" title="Sass::Tree::Node#filename (method)">#filename</a></span>, <span class='object_link'><a href="Node.html#has_children-instance_method" title="Sass::Tree::Node#has_children (method)">#has_children</a></span>, <span class='object_link'><a href="Node.html#line-instance_method" title="Sass::Tree::Node#line (method)">#line</a></span>, <span class='object_link'><a href="Node.html#options-instance_method" title="Sass::Tree::Node#options (method)">#options</a></span>, <span class='object_link'><a href="Node.html#source_range-instance_method" title="Sass::Tree::Node#source_range (method)">#source_range</a></span></p>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#_load-class_method" title="_load (class method)">.<strong>_load</strong>(data) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></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="#_dump-instance_method" title="#_dump (instance method)">#<strong>_dump</strong>(f) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#add_else-instance_method" title="#add_else (instance method)">#<strong>add_else</strong>(node) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Append an `@else` node to the end of the list.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(expr) &#x21d2; IfNode </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of IfNode.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Sass::Tree::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#<<-instance_method" title="Sass::Tree::Node#&lt;&lt; (method)">#<<</a></span>, <span class='object_link'><a href="Node.html#==-instance_method" title="Sass::Tree::Node#== (method)">#==</a></span>, <span class='object_link'><a href="Node.html#bubbles%3F-instance_method" title="Sass::Tree::Node#bubbles? (method)">#bubbles?</a></span>, <span class='object_link'><a href="Node.html#css-instance_method" title="Sass::Tree::Node#css (method)">#css</a></span>, <span class='object_link'><a href="Node.html#css_with_sourcemap-instance_method" title="Sass::Tree::Node#css_with_sourcemap (method)">#css_with_sourcemap</a></span>, <span class='object_link'><a href="Node.html#deep_copy-instance_method" title="Sass::Tree::Node#deep_copy (method)">#deep_copy</a></span>, <span class='object_link'><a href="Node.html#each-instance_method" title="Sass::Tree::Node#each (method)">#each</a></span>, <span class='object_link'><a href="Node.html#inherited-class_method" title="Sass::Tree::Node.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Node.html#inspect-instance_method" title="Sass::Tree::Node#inspect (method)">#inspect</a></span>, <span class='object_link'><a href="Node.html#invisible%3F-instance_method" title="Sass::Tree::Node#invisible? (method)">#invisible?</a></span>, <span class='object_link'><a href="Node.html#style-instance_method" title="Sass::Tree::Node#style (method)">#style</a></span>, <span class='object_link'><a href="Node.html#to_sass-instance_method" title="Sass::Tree::Node#to_sass (method)">#to_sass</a></span>, <span class='object_link'><a href="Node.html#to_scss-instance_method" title="Sass::Tree::Node#to_scss (method)">#to_scss</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(expr) &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of IfNode</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>expr</span>
<span class='type'>(<tt>Script::Expr</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="#expr-instance_method" title="Sass::Tree::IfNode#expr (method)">#expr</a></span></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/tree/if_node.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_expr'>expr</span><span class='rparen'>)</span>
<span class='ivar'>@expr</span> <span class='op'>=</span> <span class='id identifier rubyid_expr'>expr</span>
<span class='ivar'>@last_else</span> <span class='op'>=</span> <span class='kw'>self</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(expr) &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of IfNode</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>expr</span>
<span class='type'>(<tt>Script::Expr</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="#expr-instance_method" title="Sass::Tree::IfNode#expr (method)">#expr</a></span></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/tree/if_node.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_expr'>expr</span><span class='rparen'>)</span>
<span class='ivar'>@expr</span> <span class='op'>=</span> <span class='id identifier rubyid_expr'>expr</span>
<span class='ivar'>@last_else</span> <span class='op'>=</span> <span class='kw'>self</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="else=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="else-instance_method">
#<strong>else</strong> &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>The next <span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">Sass::Tree::IfNode</a></span> in the if-else list, or `nil`.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/tree/if_node.rb', line 21</span>
<span class='kw'>def</span> <span class='kw'>else</span>
<span class='ivar'>@else</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="expr=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="expr-instance_method">
#<strong>expr</strong> &#x21d2; <tt>Script::Expr</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The conditional expression. If this is nil, this is an `@else` node, not an
`@else if`.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Script::Expr</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/tree/if_node.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_expr'>expr</span>
<span class='ivar'>@expr</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="_load-class_method">
.<strong>_load</strong>(data) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44
45
46
47
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/tree/if_node.rb', line 42</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__load'>_load</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expr'>expr</span><span class='comma'>,</span> <span class='id identifier rubyid_else_'>else_</span><span class='comma'>,</span> <span class='id identifier rubyid_children'>children</span> <span class='op'>=</span> <span class='const'>Marshal</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='id identifier rubyid_node'>node</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Sass::Tree::IfNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_expr'>expr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_else'>else</span> <span class='op'>=</span> <span class='id identifier rubyid_else_'>else_</span>
<span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_children'>children</span> <span class='op'>=</span> <span class='id identifier rubyid_children'>children</span>
<span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>@last_else</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_else'>else</span> <span class='op'>?</span> <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_else'>else</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>@last_else</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
<span class='id identifier rubyid_node'>node</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="_dump-instance_method">
#<strong>_dump</strong>(f) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/tree/if_node.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid__dump'>_dump</span><span class='lparen'>(</span><span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span>
<span class='const'>Marshal</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_expr'>expr</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_else'>else</span><span class='comma'>,</span> <span class='id identifier rubyid_children'>children</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="add_else-instance_method">
#<strong>add_else</strong>(node) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Append an `@else` node to the end of the list.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>node</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Sass::Tree::IfNode (class)">IfNode</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The `@else` node to append</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/tree/if_node.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_add_else'>add_else</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
<span class='ivar'>@last_else</span><span class='period'>.</span><span class='id identifier rubyid_else'>else</span> <span class='op'>=</span> <span class='id identifier rubyid_node'>node</span>
<span class='ivar'>@last_else</span> <span class='op'>=</span> <span class='id identifier rubyid_node'>node</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Oct 22 13:20:58 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>