sass-site/source/documentation/Sass/Media/QueryList.html

851 lines
23 KiB
HTML
Raw Normal View History

2018-10-22 23:13:05 +02:00
<!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::Media::QueryList
&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/Media/QueryList.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 (Q)</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="../Media.html" title="Sass::Media (module)">Media</a></span></span>
&raquo;
<span class="title">QueryList</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::Media::QueryList
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Sass::Media::QueryList</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/media.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A comma-separated list of queries.</p>
<pre class="code ruby"><code class="ruby">media_query [ &#39;,&#39; S* media_query ]*
</code></pre>
</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="#queries-instance_method" title="#queries (instance method)">#<strong>queries</strong> &#x21d2; Array&lt;Query&gt; </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The queries contained in this list.</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="#deep_copy-instance_method" title="#deep_copy (instance method)">#<strong>deep_copy</strong> &#x21d2; QueryList </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns a deep copy of this query list and all its children.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(queries) &#x21d2; QueryList </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of QueryList.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#merge-instance_method" title="#merge (instance method)">#<strong>merge</strong>(other) &#x21d2; QueryList? </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Merges this query list with another.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_a-instance_method" title="#to_a (instance method)">#<strong>to_a</strong> &#x21d2; Array&lt;String, Sass::Script::Tree::Node&gt; </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns a representation of the query as an array of strings and
potentially <span class='object_link'><a href="../Script/Tree/Node.html" title="Sass::Script::Tree::Node (class)">Script::Tree::Node</a></span>s (if there&#39;s interpolation in
it).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_css-instance_method" title="#to_css (instance method)">#<strong>to_css</strong> &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the CSS for the media query list.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_src-instance_method" title="#to_src (instance method)">#<strong>to_src</strong>(options) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the Sass/SCSS code for the media query list.</p>
</div></span>
</li>
</ul>
<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>(queries) &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Media::QueryList (class)">QueryList</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of QueryList</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>queries</span>
<span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Query.html" title="Sass::Media::Query (class)">Query</a></span>&gt;</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="#queries-instance_method" title="Sass::Media::QueryList#queries (method)">#queries</a></span></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/media.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_queries'>queries</span><span class='rparen'>)</span>
<span class='ivar'>@queries</span> <span class='op'>=</span> <span class='id identifier rubyid_queries'>queries</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>(queries) &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Media::QueryList (class)">QueryList</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of QueryList</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>queries</span>
<span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Query.html" title="Sass::Media::Query (class)">Query</a></span>&gt;</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="#queries-instance_method" title="Sass::Media::QueryList#queries (method)">#queries</a></span></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/media.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_queries'>queries</span><span class='rparen'>)</span>
<span class='ivar'>@queries</span> <span class='op'>=</span> <span class='id identifier rubyid_queries'>queries</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="queries=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="queries-instance_method">
#<strong>queries</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="Query.html" title="Sass::Media::Query (class)">Query</a></span>&gt;</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The queries contained in this list.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Query.html" title="Sass::Media::Query (class)">Query</a></span>&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/media.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_queries'>queries</span>
<span class='ivar'>@queries</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="deep_copy-instance_method">
#<strong>deep_copy</strong> &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Media::QueryList (class)">QueryList</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a deep copy of this query list and all its children.</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::Media::QueryList (class)">QueryList</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/media.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_deep_copy'>deep_copy</span>
<span class='const'><span class='object_link'><a href="" title="Sass::Media::QueryList (class)">QueryList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Sass::Media::QueryList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_queries'>queries</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_q'>q</span><span class='op'>|</span> <span class='id identifier rubyid_q'>q</span><span class='period'>.</span><span class='id identifier rubyid_deep_copy'>deep_copy</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="merge-instance_method">
#<strong>merge</strong>(other) &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Media::QueryList (class)">QueryList</a></span>?</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Merges this query list with another. The returned query list queries for
the intersection between the two inputs.</p>
<p>Both query lists should be resolved.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>other</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Sass::Media::QueryList (class)">QueryList</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Sass::Media::QueryList (class)">QueryList</a></span>?</tt>)</span>
&mdash;
<div class='inline'>
<p>The merged list, or nil if there is no intersection.</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/media.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
<span class='id identifier rubyid_new_queries'>new_queries</span> <span class='op'>=</span> <span class='id identifier rubyid_queries'>queries</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_q1'>q1</span><span class='op'>|</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_queries'>queries</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_q2'>q2</span><span class='op'>|</span> <span class='id identifier rubyid_q1'>q1</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_q2'>q2</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_new_queries'>new_queries</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='const'><span class='object_link'><a href="" title="Sass::Media::QueryList (class)">QueryList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Sass::Media::QueryList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_new_queries'>new_queries</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_a-instance_method">
#<strong>to_a</strong> &#x21d2; <tt>Array&lt;String, <span class='object_link'><a href="../Script/Tree/Node.html" title="Sass::Script::Tree::Node (class)">Sass::Script::Tree::Node</a></span>&gt;</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a representation of the query as an array of strings and
potentially <span class='object_link'><a href="../Script/Tree/Node.html" title="Sass::Script::Tree::Node (class)">Script::Tree::Node</a></span>s (if there&#39;s interpolation in
it). When the interpolation is resolved and the strings are joined
together, this will be the string representation of this query.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array&lt;String, <span class='object_link'><a href="../Script/Tree/Node.html" title="Sass::Script::Tree::Node (class)">Sass::Script::Tree::Node</a></span>&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/media.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_a'>to_a</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='period'>.</span><span class='id identifier rubyid_intersperse'><span class='object_link'><a href="../Util.html#intersperse-instance_method" title="Sass::Util#intersperse (method)">intersperse</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_queries'>queries</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_q'>q</span><span class='op'>|</span> <span class='id identifier rubyid_q'>q</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>, </span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_css-instance_method">
#<strong>to_css</strong> &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the CSS for the media query list.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/media.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_css'>to_css</span>
<span class='id identifier rubyid_queries'>queries</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_q'>q</span><span class='op'>|</span> <span class='id identifier rubyid_q'>q</span><span class='period'>.</span><span class='id identifier rubyid_to_css'>to_css</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>, </span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_src-instance_method">
#<strong>to_src</strong>(options) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the Sass/SCSS code for the media query list.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>{Symbol =&gt; Object}</tt>)</span>
&mdash;
<div class='inline'>
<p>An options hash (see <span class='object_link'><a href="../CSS.html#initialize-instance_method" title="Sass::CSS#initialize (method)">CSS#initialize</a></span>).</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/media.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_src'>to_src</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_queries'>queries</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_q'>q</span><span class='op'>|</span> <span class='id identifier rubyid_q'>q</span><span class='period'>.</span><span class='id identifier rubyid_to_src'>to_src</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>, </span><span class='tstring_end'>&#39;</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:52 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>