doc/classes/Snarl.html in ruby-snarl-0.0.5 vs doc/classes/Snarl.html in ruby-snarl-0.0.6
- old
+ new
@@ -138,10 +138,15 @@
<tr class="top-aligned-row context-row">
<td class="context-item-name">DEFAULT_TIMEOUT</td>
<td>=</td>
<td class="context-item-value">3</td>
</tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">NO_TIMEOUT</td>
+ <td>=</td>
+ <td class="context-item-value">0</td>
+ </tr>
</table>
</div>
</div>
@@ -163,21 +168,24 @@
</div>
<div class="method-description">
<p>
Create a new snarl message, the only thing you need to send is a title note
-that if you decide to send an icon, you must provide the complete path
+that if you decide to send an icon, you must provide the complete path. The
+timeout file has a default value (DEFAULT_TIMEOUT -> 3 seconds) but can
+be set to Snarl::NO_TIMEOUT, to force a manual acknowledgement of the
+notification.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000001-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 77</span>
-77: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>=<span class="ruby-value str">" "</span>, <span class="ruby-identifier">icon</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span>=<span class="ruby-constant">DEFAULT_TIMEOUT</span>)
-78: <span class="ruby-ivar">@ss</span> = <span class="ruby-constant">SnarlStruct</span>.<span class="ruby-identifier">malloc</span>
-79: <span class="ruby-identifier">show</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">icon</span>, <span class="ruby-identifier">timeout</span>)
-80: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 80</span>
+80: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>=<span class="ruby-value str">" "</span>, <span class="ruby-identifier">icon</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span>=<span class="ruby-constant">DEFAULT_TIMEOUT</span>)
+81: <span class="ruby-ivar">@ss</span> = <span class="ruby-constant">SnarlStruct</span>.<span class="ruby-identifier">malloc</span>
+82: <span class="ruby-identifier">show</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">icon</span>, <span class="ruby-identifier">timeout</span>)
+83: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
@@ -191,20 +199,23 @@
</div>
<div class="method-description">
<p>
a quick and easy method to create a new message, when you don’t care
-to access it again
+to access it again. Note that if you decide to send an icon, you must
+provide the complete path. The timeout file has a default value
+(DEFAULT_TIMEOUT -> 3 seconds) but can be set to Snarl::NO_TIMEOUT, to
+force a manual acknowledgement of the notification.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000002-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 84</span>
-84: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">show_message</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>=<span class="ruby-value str">" "</span>, <span class="ruby-identifier">icon</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span>=<span class="ruby-constant">DEFAULT_TIMEOUT</span>)
-85: <span class="ruby-constant">Snarl</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">icon</span>, <span class="ruby-identifier">timeout</span>)
-86: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 91</span>
+91: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">show_message</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>=<span class="ruby-value str">" "</span>, <span class="ruby-identifier">icon</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span>=<span class="ruby-constant">DEFAULT_TIMEOUT</span>)
+92: <span class="ruby-constant">Snarl</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">icon</span>, <span class="ruby-identifier">timeout</span>)
+93: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
@@ -224,17 +235,17 @@
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000006-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 114</span>
-114: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span>
-115: <span class="ruby-identifier">ss</span> = <span class="ruby-constant">SnarlAPI</span><span class="ruby-operator">::</span><span class="ruby-constant">SnarlStruct</span>.<span class="ruby-identifier">malloc</span>
-116: <span class="ruby-identifier">ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_GET_VERSION</span>
-117: <span class="ruby-identifier">version</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">ss</span>)
-118: <span class="ruby-node">"#{version >> 16}.#{version & 0xffff}"</span>
-119: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 128</span>
+128: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span>
+129: <span class="ruby-identifier">ss</span> = <span class="ruby-constant">SnarlAPI</span><span class="ruby-operator">::</span><span class="ruby-constant">SnarlStruct</span>.<span class="ruby-identifier">malloc</span>
+130: <span class="ruby-identifier">ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_GET_VERSION</span>
+131: <span class="ruby-identifier">version</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">ss</span>)
+132: <span class="ruby-node">"#{version >> 16}.#{version & 0xffff}"</span>
+133: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
@@ -255,48 +266,54 @@
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000004-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 101</span>
-101: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hide</span>
-102: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_HIDE</span>
-103: <span class="ruby-identifier">send?</span>
-104: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 115</span>
+115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hide</span>
+116: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_HIDE</span>
+117: <span class="ruby-identifier">send?</span>
+118: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000003" class="method-detail">
<a name="M000003"></a>
<div class="method-heading">
<a href="#M000003" class="method-signature">
- <span class="method-name">update</span><span class="method-args">(title,msg=" ",icon=nil)</span>
+ <span class="method-name">update</span><span class="method-args">(title,msg=" ",icon=nil, timeout=DEFAULT_TIMEOUT)</span>
</a>
</div>
<div class="method-description">
<p>
Update an existing message, it will return true/false depending upon
success (it will fail if the message has already timed out or been
-dismissed)
+dismissed) Note that if you decide to send an icon, you must provide the
+complete path. The timeout file has a default value (DEFAULT_TIMEOUT ->
+3 seconds) but can be set to Snarl::NO_TIMEOUT, to force a manual
+acknowledgement of the notification.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000003-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 91</span>
-91: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update</span>(<span class="ruby-identifier">title</span>,<span class="ruby-identifier">msg</span>=<span class="ruby-value str">" "</span>,<span class="ruby-identifier">icon</span>=<span class="ruby-keyword kw">nil</span>)
-92: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_UPDATE</span>
-93: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">title</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">title</span>)
-94: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">text</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">msg</span>)
-95: <span class="ruby-identifier">icon</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">icon</span>)
-96: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">icon</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">icon</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">icon</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">icon</span>)
-97: <span class="ruby-identifier">send?</span>
-98: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 102</span>
+102: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update</span>(<span class="ruby-identifier">title</span>,<span class="ruby-identifier">msg</span>=<span class="ruby-value str">" "</span>,<span class="ruby-identifier">icon</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span>=<span class="ruby-constant">DEFAULT_TIMEOUT</span>)
+103: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_UPDATE</span>
+104: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">title</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">title</span>)
+105: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">text</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">msg</span>)
+106: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">icon</span>
+107: <span class="ruby-identifier">icon</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">icon</span>)
+108: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">icon</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">icon</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">icon</span>.<span class="ruby-identifier">to_s</span>)
+109: <span class="ruby-keyword kw">end</span>
+110: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">timeout</span> = <span class="ruby-identifier">timeout</span>
+111: <span class="ruby-identifier">send?</span>
+112: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
@@ -315,15 +332,15 @@
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000005-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 107</span>
-107: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">visible?</span>
-108: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_IS_VISIBLE</span>
-109: <span class="ruby-identifier">send?</span>
-110: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 121</span>
+121: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">visible?</span>
+122: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_IS_VISIBLE</span>
+123: <span class="ruby-identifier">send?</span>
+124: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
@@ -344,14 +361,14 @@
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000007-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 123</span>
-123: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">id</span>
-124: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">id</span>
-125: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 137</span>
+137: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">id</span>
+138: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">id</span>
+139: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
@@ -370,14 +387,14 @@
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000009-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 142</span>
-142: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send</span>
-143: <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">send</span>(<span class="ruby-ivar">@ss</span>)
-144: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 156</span>
+156: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send</span>
+157: <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">send</span>(<span class="ruby-ivar">@ss</span>)
+158: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
@@ -396,14 +413,14 @@
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000010-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 147</span>
-147: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send?</span>
-148: <span class="ruby-operator">!</span><span class="ruby-identifier">send</span>.<span class="ruby-identifier">zero?</span>
-149: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 161</span>
+161: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send?</span>
+162: <span class="ruby-operator">!</span><span class="ruby-identifier">send</span>.<span class="ruby-identifier">zero?</span>
+163: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
@@ -423,21 +440,21 @@
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000008-source">
<pre>
- <span class="ruby-comment cmt"># File lib/snarl.rb, line 129</span>
-129: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">show</span>(<span class="ruby-identifier">title</span>,<span class="ruby-identifier">msg</span>=<span class="ruby-value str">" "</span>, <span class="ruby-identifier">icon</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span>=<span class="ruby-constant">DEFAULT_TIMEOUT</span>)
-130: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">title</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">title</span>)
-131: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">text</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">msg</span>)
-132: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">icon</span>
-133: <span class="ruby-identifier">icon</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">icon</span>)
-134: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">icon</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">icon</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">icon</span>.<span class="ruby-identifier">to_s</span>)
-135: <span class="ruby-keyword kw">end</span>
-136: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">timeout</span> = <span class="ruby-identifier">timeout</span>
-137: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_SHOW</span>
-138: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">id</span> = <span class="ruby-identifier">send</span>
-139: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/snarl.rb, line 143</span>
+143: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">show</span>(<span class="ruby-identifier">title</span>,<span class="ruby-identifier">msg</span>=<span class="ruby-value str">" "</span>, <span class="ruby-identifier">icon</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span>=<span class="ruby-constant">DEFAULT_TIMEOUT</span>)
+144: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">title</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">title</span>)
+145: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">text</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">msg</span>)
+146: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">icon</span>
+147: <span class="ruby-identifier">icon</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">icon</span>)
+148: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">icon</span> = <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">to_cha</span>(<span class="ruby-identifier">icon</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">icon</span>.<span class="ruby-identifier">to_s</span>)
+149: <span class="ruby-keyword kw">end</span>
+150: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">timeout</span> = <span class="ruby-identifier">timeout</span>
+151: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_SHOW</span>
+152: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">id</span> = <span class="ruby-identifier">send</span>
+153: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
\ No newline at end of file