ruby-snarl 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/doc/classes/AutoSnarl.html +170 -0
- data/doc/classes/Snarl.html +457 -0
- data/doc/classes/Snarl/SnarlAPI.html +255 -0
- data/doc/created.rid +1 -0
- data/doc/files/examples/example1_rb.html +108 -0
- data/doc/files/examples/example2_rb.html +108 -0
- data/doc/files/examples/example3_rb.html +108 -0
- data/doc/files/examples/example4_rb.html +108 -0
- data/doc/files/lib/autosnarl_rb.html +108 -0
- data/doc/files/lib/snarl_rb.html +109 -0
- data/doc/fr_class_index.html +29 -0
- data/doc/fr_file_index.html +32 -0
- data/doc/fr_method_index.html +40 -0
- data/doc/index.html +24 -0
- data/doc/rdoc-style.css +208 -0
- data/examples/example1.rb +3 -0
- data/examples/example2.rb +14 -0
- data/examples/example3.rb +9 -0
- data/examples/example4.rb +11 -0
- data/examples/test.png +0 -0
- data/icons/accept.png +0 -0
- data/icons/exclamation.png +0 -0
- data/icons/information.png +0 -0
- data/lib/autosnarl.rb +47 -0
- data/lib/snarl.rb +151 -0
- data/readme.txt +70 -0
- data/ruby-snarl.gemspec +18 -0
- data/test/readme.txt +8 -0
- metadata +83 -0
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
7
|
+
<head>
|
|
8
|
+
<title>Module: AutoSnarl</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
|
11
|
+
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
|
|
12
|
+
<script type="text/javascript">
|
|
13
|
+
// <![CDATA[
|
|
14
|
+
|
|
15
|
+
function popupCode( url ) {
|
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
function toggleCode( id ) {
|
|
20
|
+
if ( document.getElementById )
|
|
21
|
+
elem = document.getElementById( id );
|
|
22
|
+
else if ( document.all )
|
|
23
|
+
elem = eval( "document.all." + id );
|
|
24
|
+
else
|
|
25
|
+
return false;
|
|
26
|
+
|
|
27
|
+
elemStyle = elem.style;
|
|
28
|
+
|
|
29
|
+
if ( elemStyle.display != "block" ) {
|
|
30
|
+
elemStyle.display = "block"
|
|
31
|
+
} else {
|
|
32
|
+
elemStyle.display = "none"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Make codeblocks hidden by default
|
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
|
40
|
+
|
|
41
|
+
// ]]>
|
|
42
|
+
</script>
|
|
43
|
+
|
|
44
|
+
</head>
|
|
45
|
+
<body>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<div id="classHeader">
|
|
50
|
+
<table class="header-table">
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>Module</strong></td>
|
|
53
|
+
<td class="class-name-in-header">AutoSnarl</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr class="top-aligned-row">
|
|
56
|
+
<td><strong>In:</strong></td>
|
|
57
|
+
<td>
|
|
58
|
+
<a href="../files/lib/autosnarl_rb.html">
|
|
59
|
+
lib/autosnarl.rb
|
|
60
|
+
</a>
|
|
61
|
+
<br />
|
|
62
|
+
</td>
|
|
63
|
+
</tr>
|
|
64
|
+
|
|
65
|
+
</table>
|
|
66
|
+
</div>
|
|
67
|
+
<!-- banner header -->
|
|
68
|
+
|
|
69
|
+
<div id="bodyContent">
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<div id="contextContent">
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
</div>
|
|
78
|
+
|
|
79
|
+
<div id="method-list">
|
|
80
|
+
<h3 class="section-bar">Methods</h3>
|
|
81
|
+
|
|
82
|
+
<div class="name-list">
|
|
83
|
+
<a href="#M000013">icon</a>
|
|
84
|
+
<a href="#M000014">snarl</a>
|
|
85
|
+
</div>
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
</div>
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
<!-- if includes -->
|
|
92
|
+
|
|
93
|
+
<div id="section">
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<!-- if method_list -->
|
|
103
|
+
<div id="methods">
|
|
104
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
105
|
+
|
|
106
|
+
<div id="method-M000013" class="method-detail">
|
|
107
|
+
<a name="M000013"></a>
|
|
108
|
+
|
|
109
|
+
<div class="method-heading">
|
|
110
|
+
<a href="#M000013" class="method-signature">
|
|
111
|
+
<span class="method-name">icon</span><span class="method-args">()</span>
|
|
112
|
+
</a>
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
<div class="method-description">
|
|
116
|
+
<p><a class="source-toggle" href="#"
|
|
117
|
+
onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
|
|
118
|
+
<div class="method-source-code" id="M000013-source">
|
|
119
|
+
<pre>
|
|
120
|
+
<span class="ruby-comment cmt"># File lib/autosnarl.rb, line 4</span>
|
|
121
|
+
4: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">icon</span>
|
|
122
|
+
5: <span class="ruby-comment cmt"># icons from http://www.famfamfam.com/lab/icons/silk/</span>
|
|
123
|
+
6: <span class="ruby-identifier">path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"/../icons"</span>)
|
|
124
|
+
7: {
|
|
125
|
+
8: <span class="ruby-identifier">:green</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{path}/accept.png"</span>,
|
|
126
|
+
9: <span class="ruby-identifier">:red</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{path}/exclamation.png"</span>,
|
|
127
|
+
10: <span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{path}/information.png"</span>
|
|
128
|
+
11: }
|
|
129
|
+
12: <span class="ruby-keyword kw">end</span>
|
|
130
|
+
</pre>
|
|
131
|
+
</div>
|
|
132
|
+
</div>
|
|
133
|
+
</div>
|
|
134
|
+
|
|
135
|
+
<div id="method-M000014" class="method-detail">
|
|
136
|
+
<a name="M000014"></a>
|
|
137
|
+
|
|
138
|
+
<div class="method-heading">
|
|
139
|
+
<a href="#M000014" class="method-signature">
|
|
140
|
+
<span class="method-name">snarl</span><span class="method-args">(title, msg, ico = nil)</span>
|
|
141
|
+
</a>
|
|
142
|
+
</div>
|
|
143
|
+
|
|
144
|
+
<div class="method-description">
|
|
145
|
+
<p><a class="source-toggle" href="#"
|
|
146
|
+
onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
|
|
147
|
+
<div class="method-source-code" id="M000014-source">
|
|
148
|
+
<pre>
|
|
149
|
+
<span class="ruby-comment cmt"># File lib/autosnarl.rb, line 14</span>
|
|
150
|
+
14: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">snarl</span> <span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">ico</span> = <span class="ruby-keyword kw">nil</span>
|
|
151
|
+
15: <span class="ruby-constant">Snarl</span>.<span class="ruby-identifier">show_message</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">icon</span>[<span class="ruby-identifier">ico</span>])
|
|
152
|
+
16: <span class="ruby-keyword kw">end</span>
|
|
153
|
+
</pre>
|
|
154
|
+
</div>
|
|
155
|
+
</div>
|
|
156
|
+
</div>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</div>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
</div>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<div id="validator-badges">
|
|
166
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
167
|
+
</div>
|
|
168
|
+
|
|
169
|
+
</body>
|
|
170
|
+
</html>
|
|
@@ -0,0 +1,457 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
7
|
+
<head>
|
|
8
|
+
<title>Class: Snarl</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
|
11
|
+
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
|
|
12
|
+
<script type="text/javascript">
|
|
13
|
+
// <![CDATA[
|
|
14
|
+
|
|
15
|
+
function popupCode( url ) {
|
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
function toggleCode( id ) {
|
|
20
|
+
if ( document.getElementById )
|
|
21
|
+
elem = document.getElementById( id );
|
|
22
|
+
else if ( document.all )
|
|
23
|
+
elem = eval( "document.all." + id );
|
|
24
|
+
else
|
|
25
|
+
return false;
|
|
26
|
+
|
|
27
|
+
elemStyle = elem.style;
|
|
28
|
+
|
|
29
|
+
if ( elemStyle.display != "block" ) {
|
|
30
|
+
elemStyle.display = "block"
|
|
31
|
+
} else {
|
|
32
|
+
elemStyle.display = "none"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Make codeblocks hidden by default
|
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
|
40
|
+
|
|
41
|
+
// ]]>
|
|
42
|
+
</script>
|
|
43
|
+
|
|
44
|
+
</head>
|
|
45
|
+
<body>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<div id="classHeader">
|
|
50
|
+
<table class="header-table">
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>Class</strong></td>
|
|
53
|
+
<td class="class-name-in-header">Snarl</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr class="top-aligned-row">
|
|
56
|
+
<td><strong>In:</strong></td>
|
|
57
|
+
<td>
|
|
58
|
+
<a href="../files/lib/snarl_rb.html">
|
|
59
|
+
lib/snarl.rb
|
|
60
|
+
</a>
|
|
61
|
+
<br />
|
|
62
|
+
</td>
|
|
63
|
+
</tr>
|
|
64
|
+
|
|
65
|
+
<tr class="top-aligned-row">
|
|
66
|
+
<td><strong>Parent:</strong></td>
|
|
67
|
+
<td>
|
|
68
|
+
Object
|
|
69
|
+
</td>
|
|
70
|
+
</tr>
|
|
71
|
+
</table>
|
|
72
|
+
</div>
|
|
73
|
+
<!-- banner header -->
|
|
74
|
+
|
|
75
|
+
<div id="bodyContent">
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<div id="contextContent">
|
|
80
|
+
|
|
81
|
+
<div id="description">
|
|
82
|
+
<pre>
|
|
83
|
+
Snarl (http://www.fullphat.net/snarl.html) is a simple notification system,
|
|
84
|
+
similar to Growl under OSX. This is a simple pure Ruby wrapper to the
|
|
85
|
+
</pre>
|
|
86
|
+
<p>
|
|
87
|
+
native API (using DL).
|
|
88
|
+
</p>
|
|
89
|
+
|
|
90
|
+
</div>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
</div>
|
|
94
|
+
|
|
95
|
+
<div id="method-list">
|
|
96
|
+
<h3 class="section-bar">Methods</h3>
|
|
97
|
+
|
|
98
|
+
<div class="name-list">
|
|
99
|
+
<a href="#M000004">hide</a>
|
|
100
|
+
<a href="#M000007">id</a>
|
|
101
|
+
<a href="#M000001">new</a>
|
|
102
|
+
<a href="#M000009">send</a>
|
|
103
|
+
<a href="#M000010">send?</a>
|
|
104
|
+
<a href="#M000008">show</a>
|
|
105
|
+
<a href="#M000002">show_message</a>
|
|
106
|
+
<a href="#M000003">update</a>
|
|
107
|
+
<a href="#M000006">version</a>
|
|
108
|
+
<a href="#M000005">visible?</a>
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
<!-- if includes -->
|
|
116
|
+
<div id="includes">
|
|
117
|
+
<h3 class="section-bar">Included Modules</h3>
|
|
118
|
+
|
|
119
|
+
<div id="includes-list">
|
|
120
|
+
<span class="include-name"><a href="Snarl/SnarlAPI.html">SnarlAPI</a></span>
|
|
121
|
+
</div>
|
|
122
|
+
</div>
|
|
123
|
+
|
|
124
|
+
<div id="section">
|
|
125
|
+
|
|
126
|
+
<div id="class-list">
|
|
127
|
+
<h3 class="section-bar">Classes and Modules</h3>
|
|
128
|
+
|
|
129
|
+
Module <a href="Snarl/SnarlAPI.html" class="link">Snarl::SnarlAPI</a><br />
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
|
|
133
|
+
<div id="constants-list">
|
|
134
|
+
<h3 class="section-bar">Constants</h3>
|
|
135
|
+
|
|
136
|
+
<div class="name-list">
|
|
137
|
+
<table summary="Constants">
|
|
138
|
+
<tr class="top-aligned-row context-row">
|
|
139
|
+
<td class="context-item-name">DEFAULT_TIMEOUT</td>
|
|
140
|
+
<td>=</td>
|
|
141
|
+
<td class="context-item-value">3</td>
|
|
142
|
+
</tr>
|
|
143
|
+
</table>
|
|
144
|
+
</div>
|
|
145
|
+
</div>
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<!-- if method_list -->
|
|
153
|
+
<div id="methods">
|
|
154
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
155
|
+
|
|
156
|
+
<div id="method-M000001" class="method-detail">
|
|
157
|
+
<a name="M000001"></a>
|
|
158
|
+
|
|
159
|
+
<div class="method-heading">
|
|
160
|
+
<a href="#M000001" class="method-signature">
|
|
161
|
+
<span class="method-name">new</span><span class="method-args">(title, msg=" ", icon=nil, timeout=DEFAULT_TIMEOUT)</span>
|
|
162
|
+
</a>
|
|
163
|
+
</div>
|
|
164
|
+
|
|
165
|
+
<div class="method-description">
|
|
166
|
+
<p>
|
|
167
|
+
Create a new snarl message, the only thing you need to send is a title note
|
|
168
|
+
that if you decide to send an icon, you must provide the complete path
|
|
169
|
+
</p>
|
|
170
|
+
<p><a class="source-toggle" href="#"
|
|
171
|
+
onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
|
|
172
|
+
<div class="method-source-code" id="M000001-source">
|
|
173
|
+
<pre>
|
|
174
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 77</span>
|
|
175
|
+
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>)
|
|
176
|
+
78: <span class="ruby-ivar">@ss</span> = <span class="ruby-constant">SnarlStruct</span>.<span class="ruby-identifier">malloc</span>
|
|
177
|
+
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>)
|
|
178
|
+
80: <span class="ruby-keyword kw">end</span>
|
|
179
|
+
</pre>
|
|
180
|
+
</div>
|
|
181
|
+
</div>
|
|
182
|
+
</div>
|
|
183
|
+
|
|
184
|
+
<div id="method-M000002" class="method-detail">
|
|
185
|
+
<a name="M000002"></a>
|
|
186
|
+
|
|
187
|
+
<div class="method-heading">
|
|
188
|
+
<a href="#M000002" class="method-signature">
|
|
189
|
+
<span class="method-name">show_message</span><span class="method-args">(title, msg=" ", icon=nil, timeout=DEFAULT_TIMEOUT)</span>
|
|
190
|
+
</a>
|
|
191
|
+
</div>
|
|
192
|
+
|
|
193
|
+
<div class="method-description">
|
|
194
|
+
<p>
|
|
195
|
+
a quick and easy method to create a new message, when you don’t care
|
|
196
|
+
to access it again
|
|
197
|
+
</p>
|
|
198
|
+
<p><a class="source-toggle" href="#"
|
|
199
|
+
onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
|
|
200
|
+
<div class="method-source-code" id="M000002-source">
|
|
201
|
+
<pre>
|
|
202
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 84</span>
|
|
203
|
+
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>)
|
|
204
|
+
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>)
|
|
205
|
+
86: <span class="ruby-keyword kw">end</span>
|
|
206
|
+
</pre>
|
|
207
|
+
</div>
|
|
208
|
+
</div>
|
|
209
|
+
</div>
|
|
210
|
+
|
|
211
|
+
<div id="method-M000006" class="method-detail">
|
|
212
|
+
<a name="M000006"></a>
|
|
213
|
+
|
|
214
|
+
<div class="method-heading">
|
|
215
|
+
<a href="#M000006" class="method-signature">
|
|
216
|
+
<span class="method-name">version</span><span class="method-args">()</span>
|
|
217
|
+
</a>
|
|
218
|
+
</div>
|
|
219
|
+
|
|
220
|
+
<div class="method-description">
|
|
221
|
+
<p>
|
|
222
|
+
Return the current version of snarl (not the snarl gem) as a character
|
|
223
|
+
string "1.0" format
|
|
224
|
+
</p>
|
|
225
|
+
<p><a class="source-toggle" href="#"
|
|
226
|
+
onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
|
|
227
|
+
<div class="method-source-code" id="M000006-source">
|
|
228
|
+
<pre>
|
|
229
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 114</span>
|
|
230
|
+
114: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span>
|
|
231
|
+
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>
|
|
232
|
+
116: <span class="ruby-identifier">ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_GET_VERSION</span>
|
|
233
|
+
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>)
|
|
234
|
+
118: <span class="ruby-node">"#{version >> 16}.#{version & 0xffff}"</span>
|
|
235
|
+
119: <span class="ruby-keyword kw">end</span>
|
|
236
|
+
</pre>
|
|
237
|
+
</div>
|
|
238
|
+
</div>
|
|
239
|
+
</div>
|
|
240
|
+
|
|
241
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
|
242
|
+
|
|
243
|
+
<div id="method-M000004" class="method-detail">
|
|
244
|
+
<a name="M000004"></a>
|
|
245
|
+
|
|
246
|
+
<div class="method-heading">
|
|
247
|
+
<a href="#M000004" class="method-signature">
|
|
248
|
+
<span class="method-name">hide</span><span class="method-args">()</span>
|
|
249
|
+
</a>
|
|
250
|
+
</div>
|
|
251
|
+
|
|
252
|
+
<div class="method-description">
|
|
253
|
+
<p>
|
|
254
|
+
Hide you message — this is the same as dismissing it
|
|
255
|
+
</p>
|
|
256
|
+
<p><a class="source-toggle" href="#"
|
|
257
|
+
onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
|
|
258
|
+
<div class="method-source-code" id="M000004-source">
|
|
259
|
+
<pre>
|
|
260
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 101</span>
|
|
261
|
+
101: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hide</span>
|
|
262
|
+
102: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_HIDE</span>
|
|
263
|
+
103: <span class="ruby-identifier">send?</span>
|
|
264
|
+
104: <span class="ruby-keyword kw">end</span>
|
|
265
|
+
</pre>
|
|
266
|
+
</div>
|
|
267
|
+
</div>
|
|
268
|
+
</div>
|
|
269
|
+
|
|
270
|
+
<div id="method-M000003" class="method-detail">
|
|
271
|
+
<a name="M000003"></a>
|
|
272
|
+
|
|
273
|
+
<div class="method-heading">
|
|
274
|
+
<a href="#M000003" class="method-signature">
|
|
275
|
+
<span class="method-name">update</span><span class="method-args">(title,msg=" ",icon=nil)</span>
|
|
276
|
+
</a>
|
|
277
|
+
</div>
|
|
278
|
+
|
|
279
|
+
<div class="method-description">
|
|
280
|
+
<p>
|
|
281
|
+
Update an existing message, it will return true/false depending upon
|
|
282
|
+
success (it will fail if the message has already timed out or been
|
|
283
|
+
dismissed)
|
|
284
|
+
</p>
|
|
285
|
+
<p><a class="source-toggle" href="#"
|
|
286
|
+
onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
|
|
287
|
+
<div class="method-source-code" id="M000003-source">
|
|
288
|
+
<pre>
|
|
289
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 91</span>
|
|
290
|
+
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>)
|
|
291
|
+
92: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_UPDATE</span>
|
|
292
|
+
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>)
|
|
293
|
+
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>)
|
|
294
|
+
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>)
|
|
295
|
+
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>)
|
|
296
|
+
97: <span class="ruby-identifier">send?</span>
|
|
297
|
+
98: <span class="ruby-keyword kw">end</span>
|
|
298
|
+
</pre>
|
|
299
|
+
</div>
|
|
300
|
+
</div>
|
|
301
|
+
</div>
|
|
302
|
+
|
|
303
|
+
<div id="method-M000005" class="method-detail">
|
|
304
|
+
<a name="M000005"></a>
|
|
305
|
+
|
|
306
|
+
<div class="method-heading">
|
|
307
|
+
<a href="#M000005" class="method-signature">
|
|
308
|
+
<span class="method-name">visible?</span><span class="method-args">()</span>
|
|
309
|
+
</a>
|
|
310
|
+
</div>
|
|
311
|
+
|
|
312
|
+
<div class="method-description">
|
|
313
|
+
<p>
|
|
314
|
+
Check to see if the message is still being displayed
|
|
315
|
+
</p>
|
|
316
|
+
<p><a class="source-toggle" href="#"
|
|
317
|
+
onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
|
|
318
|
+
<div class="method-source-code" id="M000005-source">
|
|
319
|
+
<pre>
|
|
320
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 107</span>
|
|
321
|
+
107: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">visible?</span>
|
|
322
|
+
108: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_IS_VISIBLE</span>
|
|
323
|
+
109: <span class="ruby-identifier">send?</span>
|
|
324
|
+
110: <span class="ruby-keyword kw">end</span>
|
|
325
|
+
</pre>
|
|
326
|
+
</div>
|
|
327
|
+
</div>
|
|
328
|
+
</div>
|
|
329
|
+
|
|
330
|
+
<h3 class="section-bar">Protected Instance methods</h3>
|
|
331
|
+
|
|
332
|
+
<div id="method-M000007" class="method-detail">
|
|
333
|
+
<a name="M000007"></a>
|
|
334
|
+
|
|
335
|
+
<div class="method-heading">
|
|
336
|
+
<a href="#M000007" class="method-signature">
|
|
337
|
+
<span class="method-name">id</span><span class="method-args">()</span>
|
|
338
|
+
</a>
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
<div class="method-description">
|
|
342
|
+
<p>
|
|
343
|
+
Return the internal snarl id
|
|
344
|
+
</p>
|
|
345
|
+
<p><a class="source-toggle" href="#"
|
|
346
|
+
onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
|
|
347
|
+
<div class="method-source-code" id="M000007-source">
|
|
348
|
+
<pre>
|
|
349
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 123</span>
|
|
350
|
+
123: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">id</span>
|
|
351
|
+
124: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">id</span>
|
|
352
|
+
125: <span class="ruby-keyword kw">end</span>
|
|
353
|
+
</pre>
|
|
354
|
+
</div>
|
|
355
|
+
</div>
|
|
356
|
+
</div>
|
|
357
|
+
|
|
358
|
+
<div id="method-M000009" class="method-detail">
|
|
359
|
+
<a name="M000009"></a>
|
|
360
|
+
|
|
361
|
+
<div class="method-heading">
|
|
362
|
+
<a href="#M000009" class="method-signature">
|
|
363
|
+
<span class="method-name">send</span><span class="method-args">()</span>
|
|
364
|
+
</a>
|
|
365
|
+
</div>
|
|
366
|
+
|
|
367
|
+
<div class="method-description">
|
|
368
|
+
<p>
|
|
369
|
+
Send the snarl structure, return the unfiltered result
|
|
370
|
+
</p>
|
|
371
|
+
<p><a class="source-toggle" href="#"
|
|
372
|
+
onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
|
|
373
|
+
<div class="method-source-code" id="M000009-source">
|
|
374
|
+
<pre>
|
|
375
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 142</span>
|
|
376
|
+
142: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send</span>
|
|
377
|
+
143: <span class="ruby-constant">SnarlAPI</span>.<span class="ruby-identifier">send</span>(<span class="ruby-ivar">@ss</span>)
|
|
378
|
+
144: <span class="ruby-keyword kw">end</span>
|
|
379
|
+
</pre>
|
|
380
|
+
</div>
|
|
381
|
+
</div>
|
|
382
|
+
</div>
|
|
383
|
+
|
|
384
|
+
<div id="method-M000010" class="method-detail">
|
|
385
|
+
<a name="M000010"></a>
|
|
386
|
+
|
|
387
|
+
<div class="method-heading">
|
|
388
|
+
<a href="#M000010" class="method-signature">
|
|
389
|
+
<span class="method-name">send?</span><span class="method-args">()</span>
|
|
390
|
+
</a>
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
<div class="method-description">
|
|
394
|
+
<p>
|
|
395
|
+
Send the snarl structure, return a true/false (interpreted from snarl)
|
|
396
|
+
</p>
|
|
397
|
+
<p><a class="source-toggle" href="#"
|
|
398
|
+
onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
|
|
399
|
+
<div class="method-source-code" id="M000010-source">
|
|
400
|
+
<pre>
|
|
401
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 147</span>
|
|
402
|
+
147: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send?</span>
|
|
403
|
+
148: <span class="ruby-operator">!</span><span class="ruby-identifier">send</span>.<span class="ruby-identifier">zero?</span>
|
|
404
|
+
149: <span class="ruby-keyword kw">end</span>
|
|
405
|
+
</pre>
|
|
406
|
+
</div>
|
|
407
|
+
</div>
|
|
408
|
+
</div>
|
|
409
|
+
|
|
410
|
+
<div id="method-M000008" class="method-detail">
|
|
411
|
+
<a name="M000008"></a>
|
|
412
|
+
|
|
413
|
+
<div class="method-heading">
|
|
414
|
+
<a href="#M000008" class="method-signature">
|
|
415
|
+
<span class="method-name">show</span><span class="method-args">(title,msg=" ", icon=nil, timeout=DEFAULT_TIMEOUT)</span>
|
|
416
|
+
</a>
|
|
417
|
+
</div>
|
|
418
|
+
|
|
419
|
+
<div class="method-description">
|
|
420
|
+
<p>
|
|
421
|
+
exactly like the contructor — this will create a new message, loosing
|
|
422
|
+
the original
|
|
423
|
+
</p>
|
|
424
|
+
<p><a class="source-toggle" href="#"
|
|
425
|
+
onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
|
|
426
|
+
<div class="method-source-code" id="M000008-source">
|
|
427
|
+
<pre>
|
|
428
|
+
<span class="ruby-comment cmt"># File lib/snarl.rb, line 129</span>
|
|
429
|
+
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>)
|
|
430
|
+
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>)
|
|
431
|
+
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>)
|
|
432
|
+
132: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">icon</span>
|
|
433
|
+
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>)
|
|
434
|
+
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>)
|
|
435
|
+
135: <span class="ruby-keyword kw">end</span>
|
|
436
|
+
136: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">timeout</span> = <span class="ruby-identifier">timeout</span>
|
|
437
|
+
137: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">cmd</span> = <span class="ruby-constant">SNARL_SHOW</span>
|
|
438
|
+
138: <span class="ruby-ivar">@ss</span>.<span class="ruby-identifier">id</span> = <span class="ruby-identifier">send</span>
|
|
439
|
+
139: <span class="ruby-keyword kw">end</span>
|
|
440
|
+
</pre>
|
|
441
|
+
</div>
|
|
442
|
+
</div>
|
|
443
|
+
</div>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
</div>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
</div>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<div id="validator-badges">
|
|
453
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
454
|
+
</div>
|
|
455
|
+
|
|
456
|
+
</body>
|
|
457
|
+
</html>
|