ruby-libnotify 0.5.0 → 0.5.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,225 +1,227 @@
1
- <?xml version="1.0" encoding="utf-8"?>
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
2
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
4
  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
  <head>
6
- <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
6
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
7
7
 
8
- <title>Class: Notify::Notification</title>
8
+ <title>Class: Notify::Notification</title>
9
9
 
10
- <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
11
 
12
- <script src="../js/jquery.js" type="text/javascript"
13
- charset="utf-8"></script>
14
- <script src="../js/thickbox-compressed.js" type="text/javascript"
15
- charset="utf-8"></script>
16
- <script src="../js/quicksearch.js" type="text/javascript"
17
- charset="utf-8"></script>
18
- <script src="../js/darkfish.js" type="text/javascript"
19
- charset="utf-8"></script>
12
+ <script src="../js/jquery.js" type="text/javascript" charset="utf-8"></script>
13
+ <script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
14
+ <script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
15
+ <script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
20
16
 
21
17
  </head>
22
- <body class="class">
18
+ <body id="top" class="class">
23
19
 
24
- <div id="metadata">
25
- <div id="home-metadata">
26
- <div id="home-section" class="section">
20
+ <div id="metadata">
21
+ <div id="home-metadata">
22
+ <div id="home-section" class="section">
27
23
  <h3 class="section-header">
28
24
  <a href="../index.html">Home</a>
29
25
  <a href="../index.html#classes">Classes</a>
30
26
  <a href="../index.html#methods">Methods</a>
31
27
  </h3>
32
- </div>
33
- </div>
34
-
35
- <div id="file-metadata">
36
- <div id="file-list-section" class="section">
37
- <h3 class="section-header">In Files</h3>
38
- <div class="section-body">
39
- <ul>
40
-
41
- <li><a href="../ext/rnotify_c.html?TB_iframe=true&amp;height=550&amp;width=785"
42
- class="thickbox" title="ext/rnotify.c">ext/rnotify.c</a></li>
43
-
44
- </ul>
45
- </div>
46
- </div>
47
-
48
-
49
- </div>
50
-
51
- <div id="class-metadata">
52
-
53
- <!-- Parent Class -->
54
-
55
- <div id="parent-class-section" class="section">
56
- <h3 class="section-header">Parent</h3>
57
-
58
- <p class="link">Object</p>
59
-
60
- </div>
61
-
62
-
63
- <!-- Namespace Contents -->
64
-
65
-
66
- <!-- Method Quickref -->
67
-
68
- <div id="method-list-section" class="section">
69
- <h3 class="section-header">Methods</h3>
70
- <ul class="link-list">
71
-
72
- <li><a href="#method-c-new">::new</a></li>
73
-
74
- <li><a href="#method-i-add_action">#add_action</a></li>
75
-
76
- <li><a href="#method-i-category%3D">#category=</a></li>
77
-
78
- <li><a href="#method-i-clear_actions">#clear_actions</a></li>
79
-
80
- <li><a href="#method-i-clear_hints">#clear_hints</a></li>
81
-
82
- <li><a href="#method-i-close">#close</a></li>
83
-
84
- <li><a href="#method-i-closed_reason">#closed_reason</a></li>
85
-
86
- <li><a href="#method-i-hint32">#hint32</a></li>
87
-
88
- <li><a href="#method-i-hint_byte">#hint_byte</a></li>
89
-
90
- <li><a href="#method-i-hint_double">#hint_double</a></li>
91
-
92
- <li><a href="#method-i-hint_string">#hint_string</a></li>
93
-
94
- <li><a href="#method-i-pixbuf_icon%3D">#pixbuf_icon=</a></li>
95
-
96
- <li><a href="#method-i-show">#show</a></li>
97
-
98
- <li><a href="#method-i-timeout%3D">#timeout=</a></li>
99
-
100
- <li><a href="#method-i-update">#update</a></li>
101
-
102
- <li><a href="#method-i-urgency%3D">#urgency=</a></li>
103
-
104
- </ul>
105
- </div>
106
-
107
-
108
- <!-- Included Modules -->
109
-
110
- </div>
111
-
112
- <div id="project-metadata">
113
-
114
-
115
-
116
- <div id="classindex-section" class="section project-section">
117
- <h3 class="section-header">Class Index
118
- <span class="search-toggle"><img src="../images/find.png"
119
- height="16" width="16" alt="[+]"
120
- title="show/hide quicksearch" /></span></h3>
121
- <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
122
- <fieldset>
123
- <legend>Quicksearch</legend>
124
- <input type="text" name="quicksearch" value=""
125
- class="quicksearch-field" />
126
- </fieldset>
127
- </form>
128
-
129
- <ul class="link-list">
130
-
131
- <li><a href="../Notify.html">Notify</a></li>
132
-
133
- <li><a href="../Notify/Notification.html">Notify::Notification</a></li>
134
-
135
- </ul>
136
- <div id="no-class-search-results" style="display: none;">No matching classes.</div>
137
- </div>
138
-
139
-
140
- </div>
141
- </div>
142
-
143
- <div id="documentation">
144
- <h1 class="class">Notify::Notification</h1>
145
-
146
- <div id="description">
147
-
148
- </div>
149
-
150
- <!-- Constants -->
151
-
152
- <div id="constants-list" class="section">
153
- <h3 class="section-header">Constants</h3>
154
- <dl>
155
-
156
- <dt><a name="URGENCY_LOW">URGENCY_LOW</a></dt>
157
-
158
- <dd class="description"></dd>
159
-
160
-
161
- <dt><a name="URGENCY_NORMAL">URGENCY_NORMAL</a></dt>
162
-
163
- <dd class="description"></dd>
164
-
165
-
166
- <dt><a name="URGENCY_CRITICAL">URGENCY_CRITICAL</a></dt>
167
-
168
- <dd class="description"></dd>
169
-
170
-
171
- <dt><a name="EXPIRES_DEFAULT">EXPIRES_DEFAULT</a></dt>
172
-
173
- <dd class="description"></dd>
174
-
175
-
176
- <dt><a name="EXPIRES_NEVER">EXPIRES_NEVER</a></dt>
177
-
178
- <dd class="description"></dd>
179
-
180
-
181
- </dl>
182
- </div>
183
-
184
-
185
- <!-- Attributes -->
186
-
187
-
188
- <!-- Methods -->
189
-
190
- <div id="public-class-method-details" class="method-section section">
191
- <h3 class="section-header">Public Class Methods</h3>
192
-
193
-
194
- <div id="new-method" class="method-detail ">
195
- <a name="method-c-new"></a>
196
-
197
- <div class="method-heading">
198
-
199
- <span class="method-callseq">new(summ, msg, icon)</span>
200
- <span class="method-click-advice">click to toggle source</span>
201
-
202
- </div>
203
-
204
- <div class="method-description">
205
-
206
- <p>
207
- summ = The summary text (required)
208
- </p>
209
- <p>
210
- msg = The body text or nil
211
- </p>
212
- <p>
213
- icon = The icon or nil
214
- </p>
215
- <p>
216
- Creates and returns a new notification, throw an exception on error
217
- </p>
218
-
219
-
220
-
221
- <div class="method-source-code"
222
- id="new-source">
28
+ </div>
29
+ </div>
30
+
31
+ <div id="file-metadata">
32
+ <div id="file-list-section" class="section">
33
+ <h3 class="section-header">In Files</h3>
34
+ <div class="section-body">
35
+ <ul>
36
+
37
+ <li><a href="../ext/rnotify_c.html?TB_iframe=true&amp;height=550&amp;width=785"
38
+ class="thickbox" title="ext/rnotify.c">ext/rnotify.c</a></li>
39
+
40
+ </ul>
41
+ </div>
42
+ </div>
43
+
44
+
45
+ </div>
46
+
47
+ <div id="class-metadata">
48
+
49
+ <!-- Parent Class -->
50
+ <div id="parent-class-section" class="section">
51
+ <h3 class="section-header">Parent</h3>
52
+
53
+ <p class="link">Object</p>
54
+
55
+ </div>
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+ <!-- Method Quickref -->
64
+ <div id="method-list-section" class="section">
65
+ <h3 class="section-header">Methods</h3>
66
+ <ul class="link-list">
67
+
68
+ <li><a href="#method-c-new">::new</a></li>
69
+
70
+ <li><a href="#method-i-add_action">#add_action</a></li>
71
+
72
+ <li><a href="#method-i-category-3D">#category=</a></li>
73
+
74
+ <li><a href="#method-i-clear_actions">#clear_actions</a></li>
75
+
76
+ <li><a href="#method-i-clear_hints">#clear_hints</a></li>
77
+
78
+ <li><a href="#method-i-close">#close</a></li>
79
+
80
+ <li><a href="#method-i-closed_reason">#closed_reason</a></li>
81
+
82
+ <li><a href="#method-i-hint32">#hint32</a></li>
83
+
84
+ <li><a href="#method-i-hint_byte">#hint_byte</a></li>
85
+
86
+ <li><a href="#method-i-hint_double">#hint_double</a></li>
87
+
88
+ <li><a href="#method-i-hint_string">#hint_string</a></li>
89
+
90
+ <li><a href="#method-i-name-3D">#name=</a></li>
91
+
92
+ <li><a href="#method-i-pixbuf_icon-3D">#pixbuf_icon=</a></li>
93
+
94
+ <li><a href="#method-i-show">#show</a></li>
95
+
96
+ <li><a href="#method-i-timeout-3D">#timeout=</a></li>
97
+
98
+ <li><a href="#method-i-update">#update</a></li>
99
+
100
+ <li><a href="#method-i-urgency-3D">#urgency=</a></li>
101
+
102
+ </ul>
103
+ </div>
104
+
105
+
106
+
107
+ </div>
108
+
109
+ <div id="project-metadata">
110
+
111
+
112
+
113
+ <div id="classindex-section" class="section project-section">
114
+ <h3 class="section-header">Class/Module Index
115
+ <span class="search-toggle"><img src="../images/find.png"
116
+ height="16" width="16" alt="[+]"
117
+ title="show/hide quicksearch" /></span></h3>
118
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
119
+ <fieldset>
120
+ <legend>Quicksearch</legend>
121
+ <input type="text" name="quicksearch" value=""
122
+ class="quicksearch-field" />
123
+ </fieldset>
124
+ </form>
125
+
126
+ <ul class="link-list">
127
+
128
+ <li><a href="../Notify.html">Notify</a></li>
129
+
130
+ <li><a href="../Notify/Notification.html">Notify::Notification</a></li>
131
+
132
+ </ul>
133
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
134
+ </div>
135
+
136
+
137
+ </div>
138
+ </div>
139
+
140
+ <div id="documentation">
141
+ <h1 class="class">Notify::Notification</h1>
142
+
143
+ <div id="description" class="description">
144
+
145
+ </div><!-- description -->
146
+
147
+
148
+
149
+
150
+ <div id="5Buntitled-5D" class="documentation-section">
151
+
152
+
153
+
154
+
155
+
156
+ <!-- Constants -->
157
+ <div id="constants-list" class="section">
158
+ <h3 class="section-header">Constants</h3>
159
+ <dl>
160
+
161
+ <dt><a name="EXPIRES_DEFAULT">EXPIRES_DEFAULT</a></dt>
162
+
163
+ <dd class="description"></dd>
164
+
165
+
166
+ <dt><a name="EXPIRES_NEVER">EXPIRES_NEVER</a></dt>
167
+
168
+ <dd class="description"></dd>
169
+
170
+
171
+ <dt><a name="URGENCY_CRITICAL">URGENCY_CRITICAL</a></dt>
172
+
173
+ <dd class="description"></dd>
174
+
175
+
176
+ <dt><a name="URGENCY_LOW">URGENCY_LOW</a></dt>
177
+
178
+ <dd class="description"></dd>
179
+
180
+
181
+ <dt><a name="URGENCY_NORMAL">URGENCY_NORMAL</a></dt>
182
+
183
+ <dd class="description"></dd>
184
+
185
+
186
+ </dl>
187
+ </div>
188
+
189
+
190
+
191
+
192
+ <!-- Methods -->
193
+
194
+ <div id="public-class-method-details" class="method-section section">
195
+ <h3 class="section-header">Public Class Methods</h3>
196
+
197
+
198
+ <div id="new-method" class="method-detail ">
199
+ <a name="method-c-new"></a>
200
+
201
+
202
+
203
+ <div class="method-heading">
204
+ <span class="method-callseq">new(summ, msg, icon)</span>
205
+
206
+ <span class="method-click-advice">click to toggle source</span>
207
+
208
+ </div>
209
+
210
+
211
+
212
+ <div class="method-description">
213
+
214
+ <p>summ = The summary text (required)</p>
215
+
216
+ <p>msg = The body text or nil</p>
217
+
218
+ <p>icon = The icon or nil</p>
219
+
220
+ <p>Creates and returns a new notification, throw an exception on error</p>
221
+
222
+
223
+
224
+ <div class="method-source-code" id="new-source">
223
225
  <pre>
224
226
  static VALUE
225
227
  _wrap_notification_init(VALUE self, VALUE summ, VALUE msg, VALUE icon)
@@ -245,78 +247,66 @@ _wrap_notification_init(VALUE self, VALUE summ, VALUE msg, VALUE icon)
245
247
 
246
248
  return self;
247
249
  }</pre>
248
- </div>
249
-
250
- </div>
251
-
252
-
253
-
254
-
255
- </div>
256
-
257
-
258
- </div>
259
-
260
- <div id="public-instance-method-details" class="method-section section">
261
- <h3 class="section-header">Public Instance Methods</h3>
262
-
263
-
264
- <div id="add-action-method" class="method-detail ">
265
- <a name="method-i-add_action"></a>
266
-
267
- <div class="method-heading">
268
-
269
- <span class="method-callseq">add_action(action, label, user_data)</span>
270
- <span class="method-click-advice">click to toggle source</span>
271
-
272
- </div>
273
-
274
- <div class="method-description">
275
-
276
- <p>
277
- action = The action id
278
- </p>
279
- <p>
280
- label = The action label
281
- </p>
282
- <p>
283
- user_data = Custom data to pass into the block (optional)
284
- </p>
285
- <p>
286
- Adds an action. When the action is invoked, the specified block will be
287
- called
288
- </p>
289
- <p>
290
- Examples:
291
- </p>
292
- <p>
293
- myinstance.add_action( &#8220;MyAction&#8221;, &#8220;MyLabel&#8221; ) do
294
- |action|
295
- </p>
296
- <pre>
297
- # something to do
298
- </pre>
299
- <p>
300
- end
301
- </p>
302
- <p>
303
- Or
304
- </p>
305
- <p>
306
- myinstance.add_action( &#8220;MyAction&#8221;, &#8220;MyLabel&#8221;,
307
- MyData ) do |action, mydata|
308
- </p>
309
- <pre>
310
- # something to do
311
- </pre>
312
- <p>
313
- end
314
- </p>
315
-
316
-
317
-
318
- <div class="method-source-code"
319
- id="add-action-source">
250
+ </div><!-- new-source -->
251
+
252
+ </div>
253
+
254
+
255
+
256
+
257
+ </div><!-- new-method -->
258
+
259
+
260
+ </div><!-- public-class-method-details -->
261
+
262
+ <div id="public-instance-method-details" class="method-section section">
263
+ <h3 class="section-header">Public Instance Methods</h3>
264
+
265
+
266
+ <div id="add_action-method" class="method-detail ">
267
+ <a name="method-i-add_action"></a>
268
+
269
+
270
+
271
+ <div class="method-heading">
272
+ <span class="method-callseq">add_action(action, label, user_data) { |action, user_data| ... }</span>
273
+
274
+ <span class="method-click-advice">click to toggle source</span>
275
+
276
+ </div>
277
+
278
+
279
+
280
+ <div class="method-description">
281
+
282
+ <p>action = The action id</p>
283
+
284
+ <p>label = The action label</p>
285
+
286
+ <p>user_data = Custom data to pass into the block (optional)</p>
287
+
288
+ <p>Adds an action. When the action is invoked, the specified block will be
289
+ called</p>
290
+
291
+ <p>Examples:</p>
292
+
293
+ <p>myinstance.add_action( “MyAction”, “MyLabel” ) do |action|</p>
294
+
295
+ <pre># something to do</pre>
296
+
297
+ <p>end</p>
298
+
299
+ <p>Or</p>
300
+
301
+ <p>myinstance.add_action( “MyAction”, “MyLabel”, MyData ) do |action, mydata|</p>
302
+
303
+ <pre># something to do</pre>
304
+
305
+ <p>end</p>
306
+
307
+
308
+
309
+ <div class="method-source-code" id="add_action-source">
320
310
  <pre>
321
311
  static VALUE
322
312
  _wrap_notification_add_action(int argc, VALUE *argv, VALUE self)
@@ -350,39 +340,39 @@ _wrap_notification_add_action(int argc, VALUE *argv, VALUE self)
350
340
 
351
341
  return Qnil;
352
342
  }</pre>
353
- </div>
354
-
355
- </div>
356
-
357
-
358
-
359
-
360
- </div>
361
-
362
-
363
- <div id="category--method" class="method-detail ">
364
- <a name="method-i-category%3D"></a>
365
-
366
- <div class="method-heading">
367
-
368
- <span class="method-callseq">category=(category_name)</span>
369
- <span class="method-click-advice">click to toggle source</span>
370
-
371
- </div>
372
-
373
- <div class="method-description">
374
-
375
- <p>
376
- category_name = The category name
377
- </p>
378
- <p>
379
- Sets the category
380
- </p>
381
-
382
-
383
-
384
- <div class="method-source-code"
385
- id="category--source">
343
+ </div><!-- add_action-source -->
344
+
345
+ </div>
346
+
347
+
348
+
349
+
350
+ </div><!-- add_action-method -->
351
+
352
+
353
+ <div id="category-3D-method" class="method-detail ">
354
+ <a name="method-i-category-3D"></a>
355
+
356
+
357
+
358
+ <div class="method-heading">
359
+ <span class="method-callseq">category=(category_name)</span>
360
+
361
+ <span class="method-click-advice">click to toggle source</span>
362
+
363
+ </div>
364
+
365
+
366
+
367
+ <div class="method-description">
368
+
369
+ <p>category_name = The category name</p>
370
+
371
+ <p>Sets the category</p>
372
+
373
+
374
+
375
+ <div class="method-source-code" id="category-3D-source">
386
376
  <pre>
387
377
  static VALUE
388
378
  _wrap_notification_set_category(VALUE self, VALUE cat_name)
@@ -401,38 +391,39 @@ _wrap_notification_set_category(VALUE self, VALUE cat_name)
401
391
 
402
392
  return Qnil;
403
393
  }</pre>
404
- </div>
405
-
406
- </div>
407
-
408
-
409
-
410
-
411
- </div>
412
-
413
-
414
- <div id="clear-actions-method" class="method-detail ">
415
- <a name="method-i-clear_actions"></a>
416
-
417
- <div class="method-heading">
418
-
419
- <span class="method-callseq">clear_actions</span>
420
- <span class="method-click-advice">click to toggle source</span>
421
-
422
- </div>
423
-
424
- <div class="method-description">
425
-
426
- <p>
427
- Clears all actions from the notification. Remember to use this method
394
+ </div><!-- category-3D-source -->
395
+
396
+ </div>
397
+
398
+
399
+
400
+
401
+ </div><!-- category-3D-method -->
402
+
403
+
404
+ <div id="clear_actions-method" class="method-detail ">
405
+ <a name="method-i-clear_actions"></a>
406
+
407
+
408
+
409
+ <div class="method-heading">
410
+ <span class="method-callseq">clear_actions</span>
411
+
412
+ <span class="method-click-advice">click to toggle source</span>
413
+
414
+ </div>
415
+
416
+
417
+
418
+ <div class="method-description">
419
+
420
+ <p>Clears all actions from the notification. Remember to use this method
428
421
  before call the <a
429
- href="Notification.html#method-i-close">Notification#close</a> method.
430
- </p>
431
-
422
+ href="Notification.html#method-i-close">Notification#close</a> method.</p>
423
+
432
424
 
433
-
434
- <div class="method-source-code"
435
- id="clear-actions-source">
425
+
426
+ <div class="method-source-code" id="clear_actions-source">
436
427
  <pre>
437
428
  static VALUE
438
429
  _wrap_notification_clear_actions(VALUE self)
@@ -450,38 +441,39 @@ _wrap_notification_clear_actions(VALUE self)
450
441
 
451
442
  return Qnil;
452
443
  }</pre>
453
- </div>
454
-
455
- </div>
456
-
457
-
458
-
459
-
460
- </div>
461
-
462
-
463
- <div id="clear-hints-method" class="method-detail ">
464
- <a name="method-i-clear_hints"></a>
465
-
466
- <div class="method-heading">
467
-
468
- <span class="method-callseq">clear_hints</span>
469
- <span class="method-click-advice">click to toggle source</span>
470
-
471
- </div>
472
-
473
- <div class="method-description">
474
-
475
- <p>
476
- Clears all hints from the notification. Remember to use this method before
444
+ </div><!-- clear_actions-source -->
445
+
446
+ </div>
447
+
448
+
449
+
450
+
451
+ </div><!-- clear_actions-method -->
452
+
453
+
454
+ <div id="clear_hints-method" class="method-detail ">
455
+ <a name="method-i-clear_hints"></a>
456
+
457
+
458
+
459
+ <div class="method-heading">
460
+ <span class="method-callseq">clear_hints</span>
461
+
462
+ <span class="method-click-advice">click to toggle source</span>
463
+
464
+ </div>
465
+
466
+
467
+
468
+ <div class="method-description">
469
+
470
+ <p>Clears all hints from the notification. Remember to use this method before
477
471
  call the <a href="Notification.html#method-i-close">Notification#close</a>
478
- method.
479
- </p>
480
-
472
+ method.</p>
473
+
481
474
 
482
-
483
- <div class="method-source-code"
484
- id="clear-hints-source">
475
+
476
+ <div class="method-source-code" id="clear_hints-source">
485
477
  <pre>
486
478
  static VALUE
487
479
  _wrap_notification_clear_hints(VALUE self)
@@ -499,36 +491,37 @@ _wrap_notification_clear_hints(VALUE self)
499
491
 
500
492
  return Qnil;
501
493
  }</pre>
502
- </div>
503
-
504
- </div>
505
-
506
-
507
-
508
-
509
- </div>
510
-
511
-
512
- <div id="close-method" class="method-detail ">
513
- <a name="method-i-close"></a>
514
-
515
- <div class="method-heading">
516
-
517
- <span class="method-callseq">close</span>
518
- <span class="method-click-advice">click to toggle source</span>
519
-
520
- </div>
521
-
522
- <div class="method-description">
523
-
524
- <p>
525
- Tells the notification server to hide the notification on the screen.
526
- </p>
527
-
528
-
529
-
530
- <div class="method-source-code"
531
- id="close-source">
494
+ </div><!-- clear_hints-source -->
495
+
496
+ </div>
497
+
498
+
499
+
500
+
501
+ </div><!-- clear_hints-method -->
502
+
503
+
504
+ <div id="close-method" class="method-detail ">
505
+ <a name="method-i-close"></a>
506
+
507
+
508
+
509
+ <div class="method-heading">
510
+ <span class="method-callseq">close</span>
511
+
512
+ <span class="method-click-advice">click to toggle source</span>
513
+
514
+ </div>
515
+
516
+
517
+
518
+ <div class="method-description">
519
+
520
+ <p>Tells the notification server to hide the notification on the screen.</p>
521
+
522
+
523
+
524
+ <div class="method-source-code" id="close-source">
532
525
  <pre>
533
526
  static VALUE
534
527
  _wrap_notification_close(VALUE self)
@@ -547,36 +540,37 @@ _wrap_notification_close(VALUE self)
547
540
 
548
541
  return Qfalse;
549
542
  }</pre>
550
- </div>
551
-
552
- </div>
553
-
554
-
555
-
556
-
557
- </div>
558
-
559
-
560
- <div id="closed-reason-method" class="method-detail ">
561
- <a name="method-i-closed_reason"></a>
562
-
563
- <div class="method-heading">
564
-
565
- <span class="method-callseq">closed_reason</span>
566
- <span class="method-click-advice">click to toggle source</span>
567
-
568
- </div>
569
-
570
- <div class="method-description">
571
-
572
- <p>
573
- Returns the reason code why the notification was closed
574
- </p>
575
-
576
-
577
-
578
- <div class="method-source-code"
579
- id="closed-reason-source">
543
+ </div><!-- close-source -->
544
+
545
+ </div>
546
+
547
+
548
+
549
+
550
+ </div><!-- close-method -->
551
+
552
+
553
+ <div id="closed_reason-method" class="method-detail ">
554
+ <a name="method-i-closed_reason"></a>
555
+
556
+
557
+
558
+ <div class="method-heading">
559
+ <span class="method-callseq">closed_reason</span>
560
+
561
+ <span class="method-click-advice">click to toggle source</span>
562
+
563
+ </div>
564
+
565
+
566
+
567
+ <div class="method-description">
568
+
569
+ <p>Returns the reason code why the notification was closed</p>
570
+
571
+
572
+
573
+ <div class="method-source-code" id="closed_reason-source">
580
574
  <pre>
581
575
  static VALUE
582
576
  _wrap_notification_get_closed_reason(VALUE self)
@@ -595,42 +589,46 @@ _wrap_notification_get_closed_reason(VALUE self)
595
589
 
596
590
  return INT2FIX(reason);
597
591
  }</pre>
598
- </div>
599
-
600
- </div>
601
-
602
-
603
-
604
-
605
- </div>
606
-
607
-
608
- <div id="hint--method" class="method-detail ">
609
- <a name="method-i-hint32"></a>
610
-
611
- <div class="method-heading">
612
-
613
- <span class="method-callseq">hint32(key, value)</span>
614
- <span class="method-click-advice">click to toggle source</span>
615
-
616
- </div>
617
-
618
- <div class="method-description">
619
-
620
- <p>
621
- key = The hint
622
- </p>
623
- <p>
624
- value = The hint&#8217;s value
625
- </p>
626
- <p>
627
- Sets a hint with a 32-bit integer value
628
- </p>
629
-
630
-
631
-
632
- <div class="method-source-code"
633
- id="hint--source">
592
+ </div><!-- closed_reason-source -->
593
+
594
+ </div>
595
+
596
+
597
+
598
+
599
+ </div><!-- closed_reason-method -->
600
+
601
+
602
+ <div id="hint32-method" class="method-detail ">
603
+ <a name="method-i-hint32"></a>
604
+
605
+
606
+
607
+ <div class="method-heading">
608
+ <span class="method-callseq">hint32(key, value)</span>
609
+
610
+ <span class="method-click-advice">click to toggle source</span>
611
+
612
+ </div>
613
+
614
+ <div class="method-heading">
615
+ <span class="method-callseq">*</span>
616
+
617
+ </div>
618
+
619
+
620
+
621
+ <div class="method-description">
622
+
623
+ <p>key = The hint</p>
624
+
625
+ <p>value = The hint’s value</p>
626
+
627
+ <p>Sets a hint with a 32-bit integer value</p>
628
+
629
+
630
+
631
+ <div class="method-source-code" id="hint32-source">
634
632
  <pre>
635
633
  static VALUE
636
634
  _wrap_notification_set_hint32(VALUE self, VALUE key, VALUE value)
@@ -649,42 +647,46 @@ _wrap_notification_set_hint32(VALUE self, VALUE key, VALUE value)
649
647
 
650
648
  return Qnil;
651
649
  }</pre>
652
- </div>
653
-
654
- </div>
655
-
656
-
657
-
658
-
659
- </div>
660
-
661
-
662
- <div id="hint-byte-method" class="method-detail ">
663
- <a name="method-i-hint_byte"></a>
664
-
665
- <div class="method-heading">
666
-
667
- <span class="method-callseq">hint_byte(key, value)</span>
668
- <span class="method-click-advice">click to toggle source</span>
669
-
670
- </div>
671
-
672
- <div class="method-description">
673
-
674
- <p>
675
- key = The hint
676
- </p>
677
- <p>
678
- value = The hint&#8217;s value
679
- </p>
680
- <p>
681
- Sets a hint with a byte value
682
- </p>
683
-
684
-
685
-
686
- <div class="method-source-code"
687
- id="hint-byte-source">
650
+ </div><!-- hint32-source -->
651
+
652
+ </div>
653
+
654
+
655
+
656
+
657
+ </div><!-- hint32-method -->
658
+
659
+
660
+ <div id="hint_byte-method" class="method-detail ">
661
+ <a name="method-i-hint_byte"></a>
662
+
663
+
664
+
665
+ <div class="method-heading">
666
+ <span class="method-callseq">hint_byte(key, value)</span>
667
+
668
+ <span class="method-click-advice">click to toggle source</span>
669
+
670
+ </div>
671
+
672
+ <div class="method-heading">
673
+ <span class="method-callseq">*</span>
674
+
675
+ </div>
676
+
677
+
678
+
679
+ <div class="method-description">
680
+
681
+ <p>key = The hint</p>
682
+
683
+ <p>value = The hint’s value</p>
684
+
685
+ <p>Sets a hint with a byte value</p>
686
+
687
+
688
+
689
+ <div class="method-source-code" id="hint_byte-source">
688
690
  <pre>
689
691
  static VALUE
690
692
  _wrap_notification_set_hint_byte(VALUE self, VALUE key, VALUE value)
@@ -703,42 +705,46 @@ _wrap_notification_set_hint_byte(VALUE self, VALUE key, VALUE value)
703
705
 
704
706
  return Qnil;
705
707
  }</pre>
706
- </div>
707
-
708
- </div>
709
-
710
-
711
-
712
-
713
- </div>
714
-
715
-
716
- <div id="hint-double-method" class="method-detail ">
717
- <a name="method-i-hint_double"></a>
718
-
719
- <div class="method-heading">
720
-
721
- <span class="method-callseq">hint_double(key, value)</span>
722
- <span class="method-click-advice">click to toggle source</span>
723
-
724
- </div>
725
-
726
- <div class="method-description">
727
-
728
- <p>
729
- key = The hint
730
- </p>
731
- <p>
732
- value = The hint&#8217;s value
733
- </p>
734
- <p>
735
- Sets a hint with a double value
736
- </p>
737
-
738
-
739
-
740
- <div class="method-source-code"
741
- id="hint-double-source">
708
+ </div><!-- hint_byte-source -->
709
+
710
+ </div>
711
+
712
+
713
+
714
+
715
+ </div><!-- hint_byte-method -->
716
+
717
+
718
+ <div id="hint_double-method" class="method-detail ">
719
+ <a name="method-i-hint_double"></a>
720
+
721
+
722
+
723
+ <div class="method-heading">
724
+ <span class="method-callseq">hint_double(key, value)</span>
725
+
726
+ <span class="method-click-advice">click to toggle source</span>
727
+
728
+ </div>
729
+
730
+ <div class="method-heading">
731
+ <span class="method-callseq">*</span>
732
+
733
+ </div>
734
+
735
+
736
+
737
+ <div class="method-description">
738
+
739
+ <p>key = The hint</p>
740
+
741
+ <p>value = The hint’s value</p>
742
+
743
+ <p>Sets a hint with a double value</p>
744
+
745
+
746
+
747
+ <div class="method-source-code" id="hint_double-source">
742
748
  <pre>
743
749
  static VALUE
744
750
  _wrap_notification_set_hint_double(VALUE self, VALUE key, VALUE value)
@@ -757,42 +763,46 @@ _wrap_notification_set_hint_double(VALUE self, VALUE key, VALUE value)
757
763
 
758
764
  return Qnil;
759
765
  }</pre>
760
- </div>
761
-
762
- </div>
763
-
764
-
765
-
766
-
767
- </div>
768
-
769
-
770
- <div id="hint-string-method" class="method-detail ">
771
- <a name="method-i-hint_string"></a>
772
-
773
- <div class="method-heading">
774
-
775
- <span class="method-callseq">hint_string(key, value)</span>
776
- <span class="method-click-advice">click to toggle source</span>
777
-
778
- </div>
779
-
780
- <div class="method-description">
781
-
782
- <p>
783
- key = The hint
784
- </p>
785
- <p>
786
- value = The hint&#8217;s value
787
- </p>
788
- <p>
789
- Sets a hint with a string value
790
- </p>
791
-
792
-
793
-
794
- <div class="method-source-code"
795
- id="hint-string-source">
766
+ </div><!-- hint_double-source -->
767
+
768
+ </div>
769
+
770
+
771
+
772
+
773
+ </div><!-- hint_double-method -->
774
+
775
+
776
+ <div id="hint_string-method" class="method-detail ">
777
+ <a name="method-i-hint_string"></a>
778
+
779
+
780
+
781
+ <div class="method-heading">
782
+ <span class="method-callseq">hint_string(key, value)</span>
783
+
784
+ <span class="method-click-advice">click to toggle source</span>
785
+
786
+ </div>
787
+
788
+ <div class="method-heading">
789
+ <span class="method-callseq">*</span>
790
+
791
+ </div>
792
+
793
+
794
+
795
+ <div class="method-description">
796
+
797
+ <p>key = The hint</p>
798
+
799
+ <p>value = The hint’s value</p>
800
+
801
+ <p>Sets a hint with a string value</p>
802
+
803
+
804
+
805
+ <div class="method-source-code" id="hint_string-source">
796
806
  <pre>
797
807
  static VALUE
798
808
  _wrap_notification_set_hint_string(VALUE self, VALUE key, VALUE value)
@@ -812,39 +822,84 @@ _wrap_notification_set_hint_string(VALUE self, VALUE key, VALUE value)
812
822
 
813
823
  return Qnil;
814
824
  }</pre>
815
- </div>
816
-
817
- </div>
818
-
819
-
820
-
821
-
822
- </div>
823
-
824
-
825
- <div id="pixbuf-icon--method" class="method-detail ">
826
- <a name="method-i-pixbuf_icon%3D"></a>
827
-
828
- <div class="method-heading">
829
-
830
- <span class="method-callseq">pixbuf_icon=(icon)</span>
831
- <span class="method-click-advice">click to toggle source</span>
832
-
833
- </div>
834
-
835
- <div class="method-description">
836
-
837
- <p>
838
- icon = The icon
839
- </p>
840
- <p>
841
- Sets the icon from a Gdk::Pixbuf
842
- </p>
843
-
844
-
845
-
846
- <div class="method-source-code"
847
- id="pixbuf-icon--source">
825
+ </div><!-- hint_string-source -->
826
+
827
+ </div>
828
+
829
+
830
+
831
+
832
+ </div><!-- hint_string-method -->
833
+
834
+
835
+ <div id="name-3D-method" class="method-detail ">
836
+ <a name="method-i-name-3D"></a>
837
+
838
+
839
+
840
+ <div class="method-heading">
841
+ <span class="method-callseq">name= new_name</span>
842
+
843
+ <span class="method-click-advice">click to toggle source</span>
844
+
845
+ </div>
846
+
847
+
848
+
849
+ <div class="method-description">
850
+
851
+ <p>if new_name is a valid string, sets the application name for the
852
+ notification. otherwise nothing will be changed</p>
853
+
854
+ <p>** ONLY WHEN COMPILED AGAINST LIBNOTIFY &gt;= 0.7.3 **</p>
855
+
856
+
857
+
858
+ <div class="method-source-code" id="name-3D-source">
859
+ <pre>
860
+ static VALUE
861
+ _wrap_notification_set_app_pname(VALUE self, VALUE notification_name)
862
+ {
863
+ char *name = NIL_P(notification_name) ? NULL : StringValuePtr(notification_name);
864
+
865
+ if(name != NULL || *name != '\0')
866
+ notify_notification_set_app_name(name);
867
+
868
+ return Qnil;
869
+ }</pre>
870
+ </div><!-- name-3D-source -->
871
+
872
+ </div>
873
+
874
+
875
+
876
+
877
+ </div><!-- name-3D-method -->
878
+
879
+
880
+ <div id="pixbuf_icon-3D-method" class="method-detail ">
881
+ <a name="method-i-pixbuf_icon-3D"></a>
882
+
883
+
884
+
885
+ <div class="method-heading">
886
+ <span class="method-callseq">pixbuf_icon=(icon)</span>
887
+
888
+ <span class="method-click-advice">click to toggle source</span>
889
+
890
+ </div>
891
+
892
+
893
+
894
+ <div class="method-description">
895
+
896
+ <p>icon = The icon</p>
897
+
898
+ <p>Sets the icon from a Gdk::Pixbuf</p>
899
+
900
+
901
+
902
+ <div class="method-source-code" id="pixbuf_icon-3D-source">
848
903
  <pre>
849
904
  static VALUE
850
905
  _wrap_notification_set_pixbuf_icon(VALUE self, VALUE icon)
@@ -863,37 +918,38 @@ _wrap_notification_set_pixbuf_icon(VALUE self, VALUE icon)
863
918
 
864
919
  return Qnil;
865
920
  }</pre>
866
- </div>
867
-
868
- </div>
869
-
870
-
871
-
872
-
873
- </div>
874
-
875
-
876
- <div id="show-method" class="method-detail ">
877
- <a name="method-i-show"></a>
878
-
879
- <div class="method-heading">
880
-
881
- <span class="method-callseq">show</span>
882
- <span class="method-click-advice">click to toggle source</span>
883
-
884
- </div>
885
-
886
- <div class="method-description">
887
-
888
- <p>
889
- Tells the notification server to display the notification on the screen. if
890
- TRUE returns, show the notification otherwise returns FALSE
891
- </p>
892
-
893
-
894
-
895
- <div class="method-source-code"
896
- id="show-source">
921
+ </div><!-- pixbuf_icon-3D-source -->
922
+
923
+ </div>
924
+
925
+
926
+
927
+
928
+ </div><!-- pixbuf_icon-3D-method -->
929
+
930
+
931
+ <div id="show-method" class="method-detail ">
932
+ <a name="method-i-show"></a>
933
+
934
+
935
+
936
+ <div class="method-heading">
937
+ <span class="method-callseq">show</span>
938
+
939
+ <span class="method-click-advice">click to toggle source</span>
940
+
941
+ </div>
942
+
943
+
944
+
945
+ <div class="method-description">
946
+
947
+ <p>Tells the notification server to display the notification on the screen. if
948
+ TRUE returns, show the notification otherwise returns FALSE</p>
949
+
950
+
951
+
952
+ <div class="method-source-code" id="show-source">
897
953
  <pre>
898
954
  static VALUE
899
955
  _wrap_notification_show(VALUE self)
@@ -912,36 +968,37 @@ _wrap_notification_show(VALUE self)
912
968
 
913
969
  return Qfalse;
914
970
  }</pre>
915
- </div>
916
-
917
- </div>
918
-
919
-
920
-
921
-
922
- </div>
923
-
924
-
925
- <div id="timeout--method" class="method-detail ">
926
- <a name="method-i-timeout%3D"></a>
927
-
928
- <div class="method-heading">
929
-
930
- <span class="method-callseq">timeout=(milliseconds)</span>
931
- <span class="method-click-advice">click to toggle source</span>
932
-
933
- </div>
934
-
935
- <div class="method-description">
936
-
937
- <p>
938
- Sets the timeout in milliseconds.
939
- </p>
940
-
941
-
942
-
943
- <div class="method-source-code"
944
- id="timeout--source">
971
+ </div><!-- show-source -->
972
+
973
+ </div>
974
+
975
+
976
+
977
+
978
+ </div><!-- show-method -->
979
+
980
+
981
+ <div id="timeout-3D-method" class="method-detail ">
982
+ <a name="method-i-timeout-3D"></a>
983
+
984
+
985
+
986
+ <div class="method-heading">
987
+ <span class="method-callseq">timeout=(milliseconds)</span>
988
+
989
+ <span class="method-click-advice">click to toggle source</span>
990
+
991
+ </div>
992
+
993
+
994
+
995
+ <div class="method-description">
996
+
997
+ <p>Sets the timeout in milliseconds.</p>
998
+
999
+
1000
+
1001
+ <div class="method-source-code" id="timeout-3D-source">
945
1002
  <pre>
946
1003
  static VALUE
947
1004
  _wrap_notification_set_timeout(VALUE self, VALUE ml)
@@ -959,50 +1016,47 @@ _wrap_notification_set_timeout(VALUE self, VALUE ml)
959
1016
 
960
1017
  return Qnil;
961
1018
  }</pre>
962
- </div>
963
-
964
- </div>
965
-
966
-
967
-
968
-
969
- </div>
970
-
971
-
972
- <div id="update-method" class="method-detail ">
973
- <a name="method-i-update"></a>
974
-
975
- <div class="method-heading">
976
-
977
- <span class="method-callseq">update(summ, msg, icon)</span>
978
- <span class="method-click-advice">click to toggle source</span>
979
-
980
- </div>
981
-
982
- <div class="method-description">
983
-
984
- <p>
985
- summ = The new summary text (required)
986
- </p>
987
- <p>
988
- msg = The new body text or nil
989
- </p>
990
- <p>
991
- icon = The new icon or nil
992
- </p>
993
- <p>
994
- This won&#8217;t send the update out and display it on the screen. For
995
- that, you will need to call the <a
996
- href="Notification.html#method-i-show">Notification#show</a> method.
997
- </p>
998
- <p>
999
- Returns TRUE if ok, FALSE otherwise
1000
- </p>
1001
-
1002
-
1003
-
1004
- <div class="method-source-code"
1005
- id="update-source">
1019
+ </div><!-- timeout-3D-source -->
1020
+
1021
+ </div>
1022
+
1023
+
1024
+
1025
+
1026
+ </div><!-- timeout-3D-method -->
1027
+
1028
+
1029
+ <div id="update-method" class="method-detail ">
1030
+ <a name="method-i-update"></a>
1031
+
1032
+
1033
+
1034
+ <div class="method-heading">
1035
+ <span class="method-callseq">update(summ, msg, icon)</span>
1036
+
1037
+ <span class="method-click-advice">click to toggle source</span>
1038
+
1039
+ </div>
1040
+
1041
+
1042
+
1043
+ <div class="method-description">
1044
+
1045
+ <p>summ = The new summary text (required)</p>
1046
+
1047
+ <p>msg = The new body text or nil</p>
1048
+
1049
+ <p>icon = The new icon or nil</p>
1050
+
1051
+ <p>This wont send the update out and display it on the screen. For that, you
1052
+ will need to call the <a
1053
+ href="Notification.html#method-i-show">Notification#show</a> method.</p>
1054
+
1055
+ <p>Returns TRUE if ok, FALSE otherwise</p>
1056
+
1057
+
1058
+
1059
+ <div class="method-source-code" id="update-source">
1006
1060
  <pre>
1007
1061
  static VALUE
1008
1062
  _wrap_notification_update(VALUE self, VALUE summ, VALUE msg, VALUE icon)
@@ -1027,39 +1081,39 @@ _wrap_notification_update(VALUE self, VALUE summ, VALUE msg, VALUE icon)
1027
1081
 
1028
1082
  return Qfalse;
1029
1083
  }</pre>
1030
- </div>
1031
-
1032
- </div>
1033
-
1034
-
1035
-
1036
-
1037
- </div>
1038
-
1039
-
1040
- <div id="urgency--method" class="method-detail ">
1041
- <a name="method-i-urgency%3D"></a>
1042
-
1043
- <div class="method-heading">
1044
-
1045
- <span class="method-callseq">urgency=(urgency_level)</span>
1046
- <span class="method-click-advice">click to toggle source</span>
1047
-
1048
- </div>
1049
-
1050
- <div class="method-description">
1051
-
1052
- <p>
1053
- urgency_level = The urgency level
1054
- </p>
1055
- <p>
1056
- Sets the urgency level
1057
- </p>
1058
-
1059
-
1060
-
1061
- <div class="method-source-code"
1062
- id="urgency--source">
1084
+ </div><!-- update-source -->
1085
+
1086
+ </div>
1087
+
1088
+
1089
+
1090
+
1091
+ </div><!-- update-method -->
1092
+
1093
+
1094
+ <div id="urgency-3D-method" class="method-detail ">
1095
+ <a name="method-i-urgency-3D"></a>
1096
+
1097
+
1098
+
1099
+ <div class="method-heading">
1100
+ <span class="method-callseq">urgency=(urgency_level)</span>
1101
+
1102
+ <span class="method-click-advice">click to toggle source</span>
1103
+
1104
+ </div>
1105
+
1106
+
1107
+
1108
+ <div class="method-description">
1109
+
1110
+ <p>urgency_level = The urgency level</p>
1111
+
1112
+ <p>Sets the urgency level</p>
1113
+
1114
+
1115
+
1116
+ <div class="method-source-code" id="urgency-3D-source">
1063
1117
  <pre>
1064
1118
  static VALUE
1065
1119
  _wrap_notification_set_urgency(VALUE self, VALUE urgency)
@@ -1090,33 +1144,28 @@ _wrap_notification_set_urgency(VALUE self, VALUE urgency)
1090
1144
 
1091
1145
  return Qnil;
1092
1146
  }</pre>
1093
- </div>
1094
-
1095
- </div>
1096
-
1097
-
1098
-
1099
-
1100
- </div>
1147
+ </div><!-- urgency-3D-source -->
1148
+
1149
+ </div>
1101
1150
 
1102
-
1103
- </div>
1104
-
1151
+
1105
1152
 
1106
- </div>
1153
+
1154
+ </div><!-- urgency-3D-method -->
1107
1155
 
1156
+
1157
+ </div><!-- public-instance-method-details -->
1158
+
1159
+ </div><!-- 5Buntitled-5D -->
1160
+
1108
1161
 
1109
- <div id="rdoc-debugging-section-dump" class="debugging-section">
1110
-
1111
- <p>Disabled; run with --debug to generate this.</p>
1112
-
1113
- </div>
1162
+ </div><!-- documentation -->
1114
1163
 
1115
- <div id="validator-badges">
1116
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
1117
- <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
1118
- Rdoc Generator</a> 1.1.6</small>.</p>
1119
- </div>
1164
+ <div id="validator-badges">
1165
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
1166
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
1167
+ Rdoc Generator</a> 2</small>.</p>
1168
+ </div>
1120
1169
 
1121
1170
  </body>
1122
1171
  </html>