sass-site/source/documentation/Sass/Script/Value/ArgList.html
2018-10-22 14:13:05 -07:00

611 lines
24 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::Script::Value::ArgList
&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/Script/Value/ArgList.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 (A)</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="../../Script.html" title="Sass::Script (module)">Script</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Value</a></span></span>
&raquo;
<span class="title">ArgList</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::Script::Value::ArgList
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="List.html" title="Sass::Script::Value::List (class)">List</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Base.html" title="Sass::Script::Value::Base (class)">Base</a></span></li>
<li class="next"><span class='object_link'><a href="List.html" title="Sass::Script::Value::List (class)">List</a></span></li>
<li class="next">Sass::Script::Value::ArgList</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/script/value/arg_list.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A SassScript object representing a variable argument list. This works just
like a normal list, but can also contain keyword arguments.</p>
<p>The keyword arguments attached to this list are unused except when this is
passed as a glob argument to a function or mixin.</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="#keywords_accessed-instance_method" title="#keywords_accessed (instance method)">#<strong>keywords_accessed</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Whether <span class='object_link'><a href="#keywords-instance_method" title="Sass::Script::Value::ArgList#keywords (method)">#keywords</a></span> has been accessed.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="List.html" title="Sass::Script::Value::List (class)">List</a></span></h3>
<p class="inherited"><span class='object_link'><a href="List.html#bracketed-instance_method" title="Sass::Script::Value::List#bracketed (method)">#bracketed</a></span>, <span class='object_link'><a href="List.html#separator-instance_method" title="Sass::Script::Value::List#separator (method)">#separator</a></span>, <span class='object_link'><a href="List.html#value-instance_method" title="Sass::Script::Value::List#value (method)">#value</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Base.html" title="Sass::Script::Value::Base (class)">Base</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Base.html#options-instance_method" title="Sass::Script::Value::Base#options (method)">#options</a></span>, <span class='object_link'><a href="Base.html#source_range-instance_method" title="Sass::Script::Value::Base#source_range (method)">#source_range</a></span>, <span class='object_link'><a href="Base.html#value-instance_method" title="Sass::Script::Value::Base#value (method)">#value</a></span></p>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(value, keywords, separator) &#x21d2; ArgList </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Creates a new argument list.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#keywords-instance_method" title="#keywords (instance method)">#<strong>keywords</strong> &#x21d2; NormalizedMap&lt;Value&gt; </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The keyword arguments attached to this list.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="List.html" title="Sass::Script::Value::List (class)">List</a></span></h3>
<p class="inherited"><span class='object_link'><a href="List.html#assert_valid_index-class_method" title="Sass::Script::Value::List.assert_valid_index (method)">assert_valid_index</a></span>, <span class='object_link'><a href="List.html#eq-instance_method" title="Sass::Script::Value::List#eq (method)">#eq</a></span>, <span class='object_link'><a href="List.html#hash-instance_method" title="Sass::Script::Value::List#hash (method)">#hash</a></span>, <span class='object_link'><a href="List.html#inspect-instance_method" title="Sass::Script::Value::List#inspect (method)">#inspect</a></span>, <span class='object_link'><a href="List.html#options=-instance_method" title="Sass::Script::Value::List#options= (method)">#options=</a></span>, <span class='object_link'><a href="List.html#to_h-instance_method" title="Sass::Script::Value::List#to_h (method)">#to_h</a></span>, <span class='object_link'><a href="List.html#to_s-instance_method" title="Sass::Script::Value::List#to_s (method)">#to_s</a></span>, <span class='object_link'><a href="List.html#to_sass-instance_method" title="Sass::Script::Value::List#to_sass (method)">#to_sass</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Sass::Script::Value::Base (class)">Base</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Base.html#==-instance_method" title="Sass::Script::Value::Base#== (method)">#==</a></span>, <span class='object_link'><a href="Base.html#assert_int!-instance_method" title="Sass::Script::Value::Base#assert_int! (method)">#assert_int!</a></span>, <span class='object_link'><a href="Base.html#bracketed-instance_method" title="Sass::Script::Value::Base#bracketed (method)">#bracketed</a></span>, <span class='object_link'><a href="Base.html#div-instance_method" title="Sass::Script::Value::Base#div (method)">#div</a></span>, <span class='object_link'><a href="Base.html#eq-instance_method" title="Sass::Script::Value::Base#eq (method)">#eq</a></span>, <span class='object_link'><a href="Base.html#eql%3F-instance_method" title="Sass::Script::Value::Base#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="Base.html#hash-instance_method" title="Sass::Script::Value::Base#hash (method)">#hash</a></span>, <span class='object_link'><a href="Base.html#inspect-instance_method" title="Sass::Script::Value::Base#inspect (method)">#inspect</a></span>, <span class='object_link'><a href="Base.html#minus-instance_method" title="Sass::Script::Value::Base#minus (method)">#minus</a></span>, <span class='object_link'><a href="Base.html#neq-instance_method" title="Sass::Script::Value::Base#neq (method)">#neq</a></span>, <span class='object_link'><a href="Base.html#null%3F-instance_method" title="Sass::Script::Value::Base#null? (method)">#null?</a></span>, <span class='object_link'><a href="Base.html#plus-instance_method" title="Sass::Script::Value::Base#plus (method)">#plus</a></span>, <span class='object_link'><a href="Base.html#separator-instance_method" title="Sass::Script::Value::Base#separator (method)">#separator</a></span>, <span class='object_link'><a href="Base.html#single_eq-instance_method" title="Sass::Script::Value::Base#single_eq (method)">#single_eq</a></span>, <span class='object_link'><a href="Base.html#to_a-instance_method" title="Sass::Script::Value::Base#to_a (method)">#to_a</a></span>, <span class='object_link'><a href="Base.html#to_bool-instance_method" title="Sass::Script::Value::Base#to_bool (method)">#to_bool</a></span>, <span class='object_link'><a href="Base.html#to_h-instance_method" title="Sass::Script::Value::Base#to_h (method)">#to_h</a></span>, <span class='object_link'><a href="Base.html#to_i-instance_method" title="Sass::Script::Value::Base#to_i (method)">#to_i</a></span>, <span class='object_link'><a href="Base.html#to_s-instance_method" title="Sass::Script::Value::Base#to_s (method)">#to_s</a></span>, <span class='object_link'><a href="Base.html#unary_div-instance_method" title="Sass::Script::Value::Base#unary_div (method)">#unary_div</a></span>, <span class='object_link'><a href="Base.html#unary_minus-instance_method" title="Sass::Script::Value::Base#unary_minus (method)">#unary_minus</a></span>, <span class='object_link'><a href="Base.html#unary_not-instance_method" title="Sass::Script::Value::Base#unary_not (method)">#unary_not</a></span>, <span class='object_link'><a href="Base.html#unary_plus-instance_method" title="Sass::Script::Value::Base#unary_plus (method)">#unary_plus</a></span>, <span class='object_link'><a href="Base.html#with_contents-instance_method" title="Sass::Script::Value::Base#with_contents (method)">#with_contents</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>(value, keywords, separator) &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Script::Value::ArgList (class)">ArgList</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates a new argument list.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Array&lt;<span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Value</a></span>&gt;</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="List.html#value-instance_method" title="Sass::Script::Value::List#value (method)">List#value</a></span>.</p>
</div>
</li>
<li>
<span class='name'>keywords</span>
<span class='type'>(<tt>Hash&lt;<span class='object_link'><a href="String.html" title="Sass::Script::Value::String (class)">String</a></span>, <span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Value</a></span>&gt;</tt>, <tt>NormalizedMap&lt;<span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Value</a></span>&gt;</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="#keywords-instance_method" title="Sass::Script::Value::ArgList#keywords (method)">#keywords</a></span></p>
</div>
</li>
<li>
<span class='name'>separator</span>
<span class='type'>(<tt><span class='object_link'><a href="String.html" title="Sass::Script::Value::String (class)">String</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="List.html#separator-instance_method" title="Sass::Script::Value::List#separator (method)">List#separator</a></span>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/value/arg_list.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_keywords'>keywords</span><span class='comma'>,</span> <span class='id identifier rubyid_separator'>separator</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>separator:</span> <span class='id identifier rubyid_separator'>separator</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_keywords'>keywords</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util.html" title="Sass::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util/NormalizedMap.html" title="Sass::Util::NormalizedMap (class)">NormalizedMap</a></span></span><span class='rparen'>)</span>
<span class='ivar'>@keywords</span> <span class='op'>=</span> <span class='id identifier rubyid_keywords'>keywords</span>
<span class='kw'>else</span>
<span class='ivar'>@keywords</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util.html" title="Sass::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util/NormalizedMap.html" title="Sass::Util::NormalizedMap (class)">NormalizedMap</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Util/NormalizedMap.html#initialize-instance_method" title="Sass::Util::NormalizedMap#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_keywords'>keywords</span><span class='rparen'>)</span>
<span class='kw'>end</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>(value, keywords, separator) &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Script::Value::ArgList (class)">ArgList</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates a new argument list.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Array&lt;<span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Value</a></span>&gt;</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="List.html#value-instance_method" title="Sass::Script::Value::List#value (method)">List#value</a></span>.</p>
</div>
</li>
<li>
<span class='name'>keywords</span>
<span class='type'>(<tt>Hash&lt;<span class='object_link'><a href="String.html" title="Sass::Script::Value::String (class)">String</a></span>, <span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Value</a></span>&gt;</tt>, <tt>NormalizedMap&lt;<span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Value</a></span>&gt;</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="#keywords-instance_method" title="Sass::Script::Value::ArgList#keywords (method)">#keywords</a></span></p>
</div>
</li>
<li>
<span class='name'>separator</span>
<span class='type'>(<tt><span class='object_link'><a href="String.html" title="Sass::Script::Value::String (class)">String</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="List.html#separator-instance_method" title="Sass::Script::Value::List#separator (method)">List#separator</a></span>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/value/arg_list.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_keywords'>keywords</span><span class='comma'>,</span> <span class='id identifier rubyid_separator'>separator</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>separator:</span> <span class='id identifier rubyid_separator'>separator</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_keywords'>keywords</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util.html" title="Sass::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util/NormalizedMap.html" title="Sass::Util::NormalizedMap (class)">NormalizedMap</a></span></span><span class='rparen'>)</span>
<span class='ivar'>@keywords</span> <span class='op'>=</span> <span class='id identifier rubyid_keywords'>keywords</span>
<span class='kw'>else</span>
<span class='ivar'>@keywords</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util.html" title="Sass::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util/NormalizedMap.html" title="Sass::Util::NormalizedMap (class)">NormalizedMap</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Util/NormalizedMap.html#initialize-instance_method" title="Sass::Util::NormalizedMap#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_keywords'>keywords</span><span class='rparen'>)</span>
<span class='kw'>end</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="keywords_accessed=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="keywords_accessed-instance_method">
#<strong>keywords_accessed</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Whether <span class='object_link'><a href="#keywords-instance_method" title="Sass::Script::Value::ArgList#keywords (method)">#keywords</a></span> has been accessed. If so, we assume that all keywords
were valid for the function that created this ArgList.</p>
</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">
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/value/arg_list.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_keywords_accessed'>keywords_accessed</span>
<span class='ivar'>@keywords_accessed</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="keywords-instance_method">
#<strong>keywords</strong> &#x21d2; <tt>NormalizedMap&lt;<span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Value</a></span>&gt;</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The keyword arguments attached to this list.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>NormalizedMap&lt;<span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Value</a></span>&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/value/arg_list.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_keywords'>keywords</span>
<span class='ivar'>@keywords_accessed</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='ivar'>@keywords</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Oct 22 13:20:54 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>