doc/Notify/Notification.html in ruby-libnotify-0.5.0 vs doc/Notify/Notification.html in ruby-libnotify-0.5.1

- old
+ new

@@ -1,227 +1,229 @@ -<?xml version="1.0" encoding="utf-8"?> +<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> - <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /> + <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" /> - <title>Class: Notify::Notification</title> + <title>Class: Notify::Notification</title> - <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" /> + <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" /> - <script src="../js/jquery.js" type="text/javascript" - charset="utf-8"></script> - <script src="../js/thickbox-compressed.js" type="text/javascript" - charset="utf-8"></script> - <script src="../js/quicksearch.js" type="text/javascript" - charset="utf-8"></script> - <script src="../js/darkfish.js" type="text/javascript" - charset="utf-8"></script> + <script src="../js/jquery.js" type="text/javascript" charset="utf-8"></script> + <script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script> + <script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script> + <script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script> </head> -<body class="class"> +<body id="top" class="class"> - <div id="metadata"> - <div id="home-metadata"> - <div id="home-section" class="section"> + <div id="metadata"> + <div id="home-metadata"> + <div id="home-section" class="section"> <h3 class="section-header"> <a href="../index.html">Home</a> <a href="../index.html#classes">Classes</a> <a href="../index.html#methods">Methods</a> </h3> - </div> - </div> + </div> + </div> - <div id="file-metadata"> - <div id="file-list-section" class="section"> - <h3 class="section-header">In Files</h3> - <div class="section-body"> - <ul> - - <li><a href="../ext/rnotify_c.html?TB_iframe=true&amp;height=550&amp;width=785" - class="thickbox" title="ext/rnotify.c">ext/rnotify.c</a></li> - - </ul> - </div> - </div> + <div id="file-metadata"> + <div id="file-list-section" class="section"> + <h3 class="section-header">In Files</h3> + <div class="section-body"> + <ul> + + <li><a href="../ext/rnotify_c.html?TB_iframe=true&amp;height=550&amp;width=785" + class="thickbox" title="ext/rnotify.c">ext/rnotify.c</a></li> + + </ul> + </div> + </div> - - </div> + + </div> - <div id="class-metadata"> + <div id="class-metadata"> + + <!-- Parent Class --> + <div id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object</p> + + </div> + - <!-- Parent Class --> - - <div id="parent-class-section" class="section"> - <h3 class="section-header">Parent</h3> - - <p class="link">Object</p> - - </div> - + - <!-- Namespace Contents --> - + - <!-- Method Quickref --> - - <div id="method-list-section" class="section"> - <h3 class="section-header">Methods</h3> - <ul class="link-list"> - - <li><a href="#method-c-new">::new</a></li> - - <li><a href="#method-i-add_action">#add_action</a></li> - - <li><a href="#method-i-category%3D">#category=</a></li> - - <li><a href="#method-i-clear_actions">#clear_actions</a></li> - - <li><a href="#method-i-clear_hints">#clear_hints</a></li> - - <li><a href="#method-i-close">#close</a></li> - - <li><a href="#method-i-closed_reason">#closed_reason</a></li> - - <li><a href="#method-i-hint32">#hint32</a></li> - - <li><a href="#method-i-hint_byte">#hint_byte</a></li> - - <li><a href="#method-i-hint_double">#hint_double</a></li> - - <li><a href="#method-i-hint_string">#hint_string</a></li> - - <li><a href="#method-i-pixbuf_icon%3D">#pixbuf_icon=</a></li> - - <li><a href="#method-i-show">#show</a></li> - - <li><a href="#method-i-timeout%3D">#timeout=</a></li> - - <li><a href="#method-i-update">#update</a></li> - - <li><a href="#method-i-urgency%3D">#urgency=</a></li> - - </ul> - </div> - + + <!-- Method Quickref --> + <div id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + <ul class="link-list"> + + <li><a href="#method-c-new">::new</a></li> + + <li><a href="#method-i-add_action">#add_action</a></li> + + <li><a href="#method-i-category-3D">#category=</a></li> + + <li><a href="#method-i-clear_actions">#clear_actions</a></li> + + <li><a href="#method-i-clear_hints">#clear_hints</a></li> + + <li><a href="#method-i-close">#close</a></li> + + <li><a href="#method-i-closed_reason">#closed_reason</a></li> + + <li><a href="#method-i-hint32">#hint32</a></li> + + <li><a href="#method-i-hint_byte">#hint_byte</a></li> + + <li><a href="#method-i-hint_double">#hint_double</a></li> + + <li><a href="#method-i-hint_string">#hint_string</a></li> + + <li><a href="#method-i-name-3D">#name=</a></li> + + <li><a href="#method-i-pixbuf_icon-3D">#pixbuf_icon=</a></li> + + <li><a href="#method-i-show">#show</a></li> + + <li><a href="#method-i-timeout-3D">#timeout=</a></li> + + <li><a href="#method-i-update">#update</a></li> + + <li><a href="#method-i-urgency-3D">#urgency=</a></li> + + </ul> + </div> + - <!-- Included Modules --> - - </div> + + </div> - <div id="project-metadata"> - - + <div id="project-metadata"> + + - <div id="classindex-section" class="section project-section"> - <h3 class="section-header">Class Index - <span class="search-toggle"><img src="../images/find.png" - height="16" width="16" alt="[+]" - title="show/hide quicksearch" /></span></h3> - <form action="#" method="get" accept-charset="utf-8" class="initially-hidden"> - <fieldset> - <legend>Quicksearch</legend> - <input type="text" name="quicksearch" value="" - class="quicksearch-field" /> - </fieldset> - </form> + <div id="classindex-section" class="section project-section"> + <h3 class="section-header">Class/Module Index + <span class="search-toggle"><img src="../images/find.png" + height="16" width="16" alt="[+]" + title="show/hide quicksearch" /></span></h3> + <form action="#" method="get" accept-charset="utf-8" class="initially-hidden"> + <fieldset> + <legend>Quicksearch</legend> + <input type="text" name="quicksearch" value="" + class="quicksearch-field" /> + </fieldset> + </form> - <ul class="link-list"> - - <li><a href="../Notify.html">Notify</a></li> - - <li><a href="../Notify/Notification.html">Notify::Notification</a></li> - - </ul> - <div id="no-class-search-results" style="display: none;">No matching classes.</div> - </div> + <ul class="link-list"> + + <li><a href="../Notify.html">Notify</a></li> + + <li><a href="../Notify/Notification.html">Notify::Notification</a></li> + + </ul> + <div id="no-class-search-results" style="display: none;">No matching classes.</div> + </div> - - </div> - </div> + + </div> + </div> - <div id="documentation"> - <h1 class="class">Notify::Notification</h1> + <div id="documentation"> + <h1 class="class">Notify::Notification</h1> - <div id="description"> - - </div> + <div id="description" class="description"> + + </div><!-- description --> - <!-- Constants --> - - <div id="constants-list" class="section"> - <h3 class="section-header">Constants</h3> - <dl> - - <dt><a name="URGENCY_LOW">URGENCY_LOW</a></dt> - - <dd class="description"></dd> - - - <dt><a name="URGENCY_NORMAL">URGENCY_NORMAL</a></dt> - - <dd class="description"></dd> - - - <dt><a name="URGENCY_CRITICAL">URGENCY_CRITICAL</a></dt> - - <dd class="description"></dd> - - - <dt><a name="EXPIRES_DEFAULT">EXPIRES_DEFAULT</a></dt> - - <dd class="description"></dd> - - - <dt><a name="EXPIRES_NEVER">EXPIRES_NEVER</a></dt> - - <dd class="description"></dd> - - - </dl> - </div> - + + + + <div id="5Buntitled-5D" class="documentation-section"> + - <!-- Attributes --> - + - <!-- Methods --> - - <div id="public-class-method-details" class="method-section section"> - <h3 class="section-header">Public Class Methods</h3> + + <!-- Constants --> + <div id="constants-list" class="section"> + <h3 class="section-header">Constants</h3> + <dl> + + <dt><a name="EXPIRES_DEFAULT">EXPIRES_DEFAULT</a></dt> + + <dd class="description"></dd> + + + <dt><a name="EXPIRES_NEVER">EXPIRES_NEVER</a></dt> + + <dd class="description"></dd> + + + <dt><a name="URGENCY_CRITICAL">URGENCY_CRITICAL</a></dt> + + <dd class="description"></dd> + + + <dt><a name="URGENCY_LOW">URGENCY_LOW</a></dt> + + <dd class="description"></dd> + + + <dt><a name="URGENCY_NORMAL">URGENCY_NORMAL</a></dt> + + <dd class="description"></dd> + + + </dl> + </div> + - - <div id="new-method" class="method-detail "> - <a name="method-c-new"></a> + - <div class="method-heading"> - - <span class="method-callseq">new(summ, msg, icon)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + <!-- Methods --> + + <div id="public-class-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> - <div class="method-description"> - - <p> -summ = The summary text (required) -</p> -<p> -msg = The body text or nil -</p> -<p> -icon = The icon or nil -</p> -<p> -Creates and returns a new notification, throw an exception on error -</p> - + + <div id="new-method" class="method-detail "> + <a name="method-c-new"></a> - - <div class="method-source-code" - id="new-source"> + + + <div class="method-heading"> + <span class="method-callseq">new(summ, msg, icon)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>summ = The summary text (required)</p> + +<p>msg = The body text or nil</p> + +<p>icon = The icon or nil</p> + +<p>Creates and returns a new notification, throw an exception on error</p> + + + + <div class="method-source-code" id="new-source"> <pre> static VALUE _wrap_notification_init(VALUE self, VALUE summ, VALUE msg, VALUE icon) { char *nsumm = NIL_P(summ) ? NULL : StringValuePtr(summ); @@ -243,82 +245,70 @@ rb_warn(&quot;init, ok&quot;); #endif return self; }</pre> - </div> - - </div> + </div><!-- new-source --> + + </div> - + - - </div> + + </div><!-- new-method --> - - </div> - - <div id="public-instance-method-details" class="method-section section"> - <h3 class="section-header">Public Instance Methods</h3> + + </div><!-- public-class-method-details --> + + <div id="public-instance-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> - - <div id="add-action-method" class="method-detail "> - <a name="method-i-add_action"></a> + + <div id="add_action-method" class="method-detail "> + <a name="method-i-add_action"></a> - <div class="method-heading"> - - <span class="method-callseq">add_action(action, label, user_data)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">add_action(action, label, user_data) { |action, user_data| ... }</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -action = The action id -</p> -<p> -label = The action label -</p> -<p> -user_data = Custom data to pass into the block (optional) -</p> -<p> -Adds an action. When the action is invoked, the specified block will be -called -</p> -<p> -Examples: -</p> -<p> -myinstance.add_action( &#8220;MyAction&#8221;, &#8220;MyLabel&#8221; ) do -|action| -</p> -<pre> - # something to do -</pre> -<p> -end -</p> -<p> -Or -</p> -<p> -myinstance.add_action( &#8220;MyAction&#8221;, &#8220;MyLabel&#8221;, -MyData ) do |action, mydata| -</p> -<pre> - # something to do -</pre> -<p> -end -</p> - + <div class="method-description"> + + <p>action = The action id</p> - - <div class="method-source-code" - id="add-action-source"> +<p>label = The action label</p> + +<p>user_data = Custom data to pass into the block (optional)</p> + +<p>Adds an action. When the action is invoked, the specified block will be +called</p> + +<p>Examples:</p> + +<p>myinstance.add_action( “MyAction”, “MyLabel” ) do |action|</p> + +<pre># something to do</pre> + +<p>end</p> + +<p>Or</p> + +<p>myinstance.add_action( “MyAction”, “MyLabel”, MyData ) do |action, mydata|</p> + +<pre># something to do</pre> + +<p>end</p> + + + + <div class="method-source-code" id="add_action-source"> <pre> static VALUE _wrap_notification_add_action(int argc, VALUE *argv, VALUE self) { NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -348,43 +338,43 @@ NOTIFY_ACTION_CALLBACK(_notification_action_cb), actionData, (GFreeFunc)_notification_action_free); return Qnil; }</pre> - </div> - - </div> + </div><!-- add_action-source --> + + </div> - + - - </div> + + </div><!-- add_action-method --> - - <div id="category--method" class="method-detail "> - <a name="method-i-category%3D"></a> + + <div id="category-3D-method" class="method-detail "> + <a name="method-i-category-3D"></a> - <div class="method-heading"> - - <span class="method-callseq">category=(category_name)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">category=(category_name)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -category_name = The category name -</p> -<p> -Sets the category -</p> - + <div class="method-description"> + + <p>category_name = The category name</p> - - <div class="method-source-code" - id="category--source"> +<p>Sets the category</p> + + + + <div class="method-source-code" id="category-3D-source"> <pre> static VALUE _wrap_notification_set_category(VALUE self, VALUE cat_name) { char *cname = NIL_P(cat_name) ? NULL : StringValuePtr(cat_name); @@ -399,42 +389,43 @@ notify_notification_set_category(n, cname); return Qnil; }</pre> - </div> - - </div> + </div><!-- category-3D-source --> + + </div> - + - - </div> + + </div><!-- category-3D-method --> - - <div id="clear-actions-method" class="method-detail "> - <a name="method-i-clear_actions"></a> + + <div id="clear_actions-method" class="method-detail "> + <a name="method-i-clear_actions"></a> - <div class="method-heading"> - - <span class="method-callseq">clear_actions</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">clear_actions</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -Clears all actions from the notification. Remember to use this method + <div class="method-description"> + + <p>Clears all actions from the notification. Remember to use this method before call the <a -href="Notification.html#method-i-close">Notification#close</a> method. -</p> - +href="Notification.html#method-i-close">Notification#close</a> method.</p> + - - <div class="method-source-code" - id="clear-actions-source"> + + <div class="method-source-code" id="clear_actions-source"> <pre> static VALUE _wrap_notification_clear_actions(VALUE self) { NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -448,42 +439,43 @@ notify_notification_clear_actions(n); return Qnil; }</pre> - </div> - - </div> + </div><!-- clear_actions-source --> + + </div> - + - - </div> + + </div><!-- clear_actions-method --> - - <div id="clear-hints-method" class="method-detail "> - <a name="method-i-clear_hints"></a> + + <div id="clear_hints-method" class="method-detail "> + <a name="method-i-clear_hints"></a> - <div class="method-heading"> - - <span class="method-callseq">clear_hints</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">clear_hints</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -Clears all hints from the notification. Remember to use this method before + <div class="method-description"> + + <p>Clears all hints from the notification. Remember to use this method before call the <a href="Notification.html#method-i-close">Notification#close</a> -method. -</p> - +method.</p> + - - <div class="method-source-code" - id="clear-hints-source"> + + <div class="method-source-code" id="clear_hints-source"> <pre> static VALUE _wrap_notification_clear_hints(VALUE self) { NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -497,40 +489,41 @@ notify_notification_clear_hints(n); return Qnil; }</pre> - </div> - - </div> + </div><!-- clear_hints-source --> + + </div> - + - - </div> + + </div><!-- clear_hints-method --> - - <div id="close-method" class="method-detail "> - <a name="method-i-close"></a> + + <div id="close-method" class="method-detail "> + <a name="method-i-close"></a> - <div class="method-heading"> - - <span class="method-callseq">close</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">close</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -Tells the notification server to hide the notification on the screen. -</p> - + <div class="method-description"> + + <p>Tells the notification server to hide the notification on the screen.</p> + - - <div class="method-source-code" - id="close-source"> + + <div class="method-source-code" id="close-source"> <pre> static VALUE _wrap_notification_close(VALUE self) { NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -545,40 +538,41 @@ if(notify_notification_close(n, NULL)) return Qtrue; return Qfalse; }</pre> - </div> - - </div> + </div><!-- close-source --> + + </div> - + - - </div> + + </div><!-- close-method --> - - <div id="closed-reason-method" class="method-detail "> - <a name="method-i-closed_reason"></a> + + <div id="closed_reason-method" class="method-detail "> + <a name="method-i-closed_reason"></a> - <div class="method-heading"> - - <span class="method-callseq">closed_reason</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">closed_reason</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -Returns the reason code why the notification was closed -</p> - + <div class="method-description"> + + <p>Returns the reason code why the notification was closed</p> + - - <div class="method-source-code" - id="closed-reason-source"> + + <div class="method-source-code" id="closed_reason-source"> <pre> static VALUE _wrap_notification_get_closed_reason(VALUE self) { NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -593,46 +587,50 @@ reason = notify_notification_get_closed_reason(n); return INT2FIX(reason); }</pre> - </div> - - </div> + </div><!-- closed_reason-source --> + + </div> - + - - </div> + + </div><!-- closed_reason-method --> - - <div id="hint--method" class="method-detail "> - <a name="method-i-hint32"></a> + + <div id="hint32-method" class="method-detail "> + <a name="method-i-hint32"></a> - <div class="method-heading"> - - <span class="method-callseq">hint32(key, value)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">hint32(key, value)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq">*</span> + + </div> + + - <div class="method-description"> - - <p> -key = The hint -</p> -<p> -value = The hint&#8217;s value -</p> -<p> -Sets a hint with a 32-bit integer value -</p> - + <div class="method-description"> + + <p>key = The hint</p> - - <div class="method-source-code" - id="hint--source"> +<p>value = The hint’s value</p> + +<p>Sets a hint with a 32-bit integer value</p> + + + + <div class="method-source-code" id="hint32-source"> <pre> static VALUE _wrap_notification_set_hint32(VALUE self, VALUE key, VALUE value) { char *vkey = NIL_P(key) ? NULL : StringValuePtr(key); @@ -647,46 +645,50 @@ notify_notification_set_hint_int32(n, vkey, FIX2INT(value)); return Qnil; }</pre> - </div> - - </div> + </div><!-- hint32-source --> + + </div> - + - - </div> + + </div><!-- hint32-method --> - - <div id="hint-byte-method" class="method-detail "> - <a name="method-i-hint_byte"></a> + + <div id="hint_byte-method" class="method-detail "> + <a name="method-i-hint_byte"></a> - <div class="method-heading"> - - <span class="method-callseq">hint_byte(key, value)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">hint_byte(key, value)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq">*</span> + + </div> + + - <div class="method-description"> - - <p> -key = The hint -</p> -<p> -value = The hint&#8217;s value -</p> -<p> -Sets a hint with a byte value -</p> - + <div class="method-description"> + + <p>key = The hint</p> - - <div class="method-source-code" - id="hint-byte-source"> +<p>value = The hint’s value</p> + +<p>Sets a hint with a byte value</p> + + + + <div class="method-source-code" id="hint_byte-source"> <pre> static VALUE _wrap_notification_set_hint_byte(VALUE self, VALUE key, VALUE value) { char *vkey = NIL_P(key) ? NULL : StringValuePtr(key); @@ -701,46 +703,50 @@ notify_notification_set_hint_byte(n, vkey, FIX2INT(value)); return Qnil; }</pre> - </div> - - </div> + </div><!-- hint_byte-source --> + + </div> - + - - </div> + + </div><!-- hint_byte-method --> - - <div id="hint-double-method" class="method-detail "> - <a name="method-i-hint_double"></a> + + <div id="hint_double-method" class="method-detail "> + <a name="method-i-hint_double"></a> - <div class="method-heading"> - - <span class="method-callseq">hint_double(key, value)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">hint_double(key, value)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq">*</span> + + </div> + + - <div class="method-description"> - - <p> -key = The hint -</p> -<p> -value = The hint&#8217;s value -</p> -<p> -Sets a hint with a double value -</p> - + <div class="method-description"> + + <p>key = The hint</p> - - <div class="method-source-code" - id="hint-double-source"> +<p>value = The hint’s value</p> + +<p>Sets a hint with a double value</p> + + + + <div class="method-source-code" id="hint_double-source"> <pre> static VALUE _wrap_notification_set_hint_double(VALUE self, VALUE key, VALUE value) { char *vkey = NIL_P(key) ? NULL : StringValuePtr(key); @@ -755,46 +761,50 @@ notify_notification_set_hint_double(n, vkey, NUM2DBL(value)); return Qnil; }</pre> - </div> - - </div> + </div><!-- hint_double-source --> + + </div> - + - - </div> + + </div><!-- hint_double-method --> - - <div id="hint-string-method" class="method-detail "> - <a name="method-i-hint_string"></a> + + <div id="hint_string-method" class="method-detail "> + <a name="method-i-hint_string"></a> - <div class="method-heading"> - - <span class="method-callseq">hint_string(key, value)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">hint_string(key, value)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq">*</span> + + </div> + + - <div class="method-description"> - - <p> -key = The hint -</p> -<p> -value = The hint&#8217;s value -</p> -<p> -Sets a hint with a string value -</p> - + <div class="method-description"> + + <p>key = The hint</p> - - <div class="method-source-code" - id="hint-string-source"> +<p>value = The hint’s value</p> + +<p>Sets a hint with a string value</p> + + + + <div class="method-source-code" id="hint_string-source"> <pre> static VALUE _wrap_notification_set_hint_string(VALUE self, VALUE key, VALUE value) { char *vkey = NIL_P(key) ? NULL : StringValuePtr(key); @@ -810,45 +820,90 @@ notify_notification_set_hint_string(n, vkey, vvalue); return Qnil; }</pre> - </div> - - </div> + </div><!-- hint_string-source --> + + </div> - + - - </div> + + </div><!-- hint_string-method --> - - <div id="pixbuf-icon--method" class="method-detail "> - <a name="method-i-pixbuf_icon%3D"></a> + + <div id="name-3D-method" class="method-detail "> + <a name="method-i-name-3D"></a> - <div class="method-heading"> - - <span class="method-callseq">pixbuf_icon=(icon)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">name= new_name</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -icon = The icon -</p> -<p> -Sets the icon from a Gdk::Pixbuf -</p> - + <div class="method-description"> + + <p>if new_name is a valid string, sets the application name for the +notification. otherwise nothing will be changed</p> - - <div class="method-source-code" - id="pixbuf-icon--source"> +<p>** ONLY WHEN COMPILED AGAINST LIBNOTIFY &gt;= 0.7.3 **</p> + + + + <div class="method-source-code" id="name-3D-source"> <pre> static VALUE +_wrap_notification_set_app_pname(VALUE self, VALUE notification_name) +{ + char *name = NIL_P(notification_name) ? NULL : StringValuePtr(notification_name); + + if(name != NULL || *name != '\0') + notify_notification_set_app_name(name); + + return Qnil; +}</pre> + </div><!-- name-3D-source --> + + </div> + + + + + </div><!-- name-3D-method --> + + + <div id="pixbuf_icon-3D-method" class="method-detail "> + <a name="method-i-pixbuf_icon-3D"></a> + + + + <div class="method-heading"> + <span class="method-callseq">pixbuf_icon=(icon)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>icon = The icon</p> + +<p>Sets the icon from a Gdk::Pixbuf</p> + + + + <div class="method-source-code" id="pixbuf_icon-3D-source"> +<pre> +static VALUE _wrap_notification_set_pixbuf_icon(VALUE self, VALUE icon) { GdkPixbuf *pix = GDK_PIXBUF(RVAL2GOBJ(icon)); NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -861,41 +916,42 @@ notify_notification_set_image_from_pixbuf(n, pix); return Qnil; }</pre> - </div> - - </div> + </div><!-- pixbuf_icon-3D-source --> + + </div> - + - - </div> + + </div><!-- pixbuf_icon-3D-method --> - - <div id="show-method" class="method-detail "> - <a name="method-i-show"></a> + + <div id="show-method" class="method-detail "> + <a name="method-i-show"></a> - <div class="method-heading"> - - <span class="method-callseq">show</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">show</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -Tells the notification server to display the notification on the screen. if -TRUE returns, show the notification otherwise returns FALSE -</p> - + <div class="method-description"> + + <p>Tells the notification server to display the notification on the screen. if +TRUE returns, show the notification otherwise returns FALSE</p> + - - <div class="method-source-code" - id="show-source"> + + <div class="method-source-code" id="show-source"> <pre> static VALUE _wrap_notification_show(VALUE self) { NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -910,40 +966,41 @@ if(notify_notification_show(n, NULL) == TRUE) return Qtrue; return Qfalse; }</pre> - </div> - - </div> + </div><!-- show-source --> + + </div> - + - - </div> + + </div><!-- show-method --> - - <div id="timeout--method" class="method-detail "> - <a name="method-i-timeout%3D"></a> + + <div id="timeout-3D-method" class="method-detail "> + <a name="method-i-timeout-3D"></a> - <div class="method-heading"> - - <span class="method-callseq">timeout=(milliseconds)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">timeout=(milliseconds)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -Sets the timeout in milliseconds. -</p> - + <div class="method-description"> + + <p>Sets the timeout in milliseconds.</p> + - - <div class="method-source-code" - id="timeout--source"> + + <div class="method-source-code" id="timeout-3D-source"> <pre> static VALUE _wrap_notification_set_timeout(VALUE self, VALUE ml) { NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -957,54 +1014,51 @@ notify_notification_set_timeout(n, FIX2INT(ml)); return Qnil; }</pre> - </div> - - </div> + </div><!-- timeout-3D-source --> + + </div> - + - - </div> + + </div><!-- timeout-3D-method --> - - <div id="update-method" class="method-detail "> - <a name="method-i-update"></a> + + <div id="update-method" class="method-detail "> + <a name="method-i-update"></a> - <div class="method-heading"> - - <span class="method-callseq">update(summ, msg, icon)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">update(summ, msg, icon)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -summ = The new summary text (required) -</p> -<p> -msg = The new body text or nil -</p> -<p> -icon = The new icon or nil -</p> -<p> -This won&#8217;t send the update out and display it on the screen. For -that, you will need to call the <a -href="Notification.html#method-i-show">Notification#show</a> method. -</p> -<p> -Returns TRUE if ok, FALSE otherwise -</p> - + <div class="method-description"> + + <p>summ = The new summary text (required)</p> - - <div class="method-source-code" - id="update-source"> +<p>msg = The new body text or nil</p> + +<p>icon = The new icon or nil</p> + +<p>This won’t send the update out and display it on the screen. For that, you +will need to call the <a +href="Notification.html#method-i-show">Notification#show</a> method.</p> + +<p>Returns TRUE if ok, FALSE otherwise</p> + + + + <div class="method-source-code" id="update-source"> <pre> static VALUE _wrap_notification_update(VALUE self, VALUE summ, VALUE msg, VALUE icon) { NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -1025,43 +1079,43 @@ if(notify_notification_update(n, nsumm, nmsg, nicon) == TRUE) return Qtrue; return Qfalse; }</pre> - </div> - - </div> + </div><!-- update-source --> + + </div> - + - - </div> + + </div><!-- update-method --> - - <div id="urgency--method" class="method-detail "> - <a name="method-i-urgency%3D"></a> + + <div id="urgency-3D-method" class="method-detail "> + <a name="method-i-urgency-3D"></a> - <div class="method-heading"> - - <span class="method-callseq">urgency=(urgency_level)</span> - <span class="method-click-advice">click to toggle source</span> - - </div> + + + <div class="method-heading"> + <span class="method-callseq">urgency=(urgency_level)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + - <div class="method-description"> - - <p> -urgency_level = The urgency level -</p> -<p> -Sets the urgency level -</p> - + <div class="method-description"> + + <p>urgency_level = The urgency level</p> - - <div class="method-source-code" - id="urgency--source"> +<p>Sets the urgency level</p> + + + + <div class="method-source-code" id="urgency-3D-source"> <pre> static VALUE _wrap_notification_set_urgency(VALUE self, VALUE urgency) { NotifyNotification *n = NOTIFY_NOTIFICATION(RVAL2GOBJ(self)); @@ -1088,36 +1142,31 @@ notify_notification_set_urgency(n, NOTIFY_URGENCY_NORMAL); } return Qnil; }</pre> - </div> - - </div> + </div><!-- urgency-3D-source --> + + </div> - + - - </div> + + </div><!-- urgency-3D-method --> - - </div> - + + </div><!-- public-instance-method-details --> + + </div><!-- 5Buntitled-5D --> + - </div> + </div><!-- documentation --> - - <div id="rdoc-debugging-section-dump" class="debugging-section"> - - <p>Disabled; run with --debug to generate this.</p> - - </div> - - <div id="validator-badges"> - <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> - <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish - Rdoc Generator</a> 1.1.6</small>.</p> - </div> + <div id="validator-badges"> + <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> + <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish + Rdoc Generator</a> 2</small>.</p> + </div> </body> </html>