← Back to branch summary

~ubuntu-branches/ubuntu/quantal/ibus/quantal

« back to all changes in this revision

Viewing changes to docs/reference/ibus/html/ibus-ibusshare.html

  • Committer: Bazaar Package Importer
  • Author(s): Barry Warsaw
  • Date: 2011-08-11 17:00:57 UTC
  • mfrom: (6.2.14 sid)
  • Revision ID: james.westby@ubuntu.com-20110811170057-6dmbfs4s3cchzl7x
Tags: 1.3.99.20110419-1ubuntu1
https://launchpad.net/bugs/457632
* Merge with Debian unstable.  Remaining Ubuntu changes:
  - Indicator support:
    + Add 05_appindicator.patch: Use an indicator rather than a notification
      icon.
    + debian/control: Recommend python-appindicator.
  - debian/control: Install im-switch instead of im-config by default.
  - debian/README.source: Removed, it was outdated and no longer correct
  - debian/patches/01_ubuntu_desktop: Fix "Desktop entry needs the
    X-Ubuntu-Gettext-Domain key"  (LP: #457632)
  - debian/patches/02_title_update.patch: Rename "IBus Preferences" to
    "Keyboard Input Methods"
  - debian/patches/06_locale_parser.patch: Cherry-picked from upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ibus/html/ibus-ibusshare.html
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="IBus Reference Manual">
8
8
<link rel="up" href="ch06.html" title="Internal">
9
 
<link rel="prev" href="IBusServer.html" title="IBusServer">
 
9
<link rel="prev" href="IBusObject.html" title="IBusObject">
10
10
<link rel="next" href="ibus-ibustypes.html" title="ibustypes">
11
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
16
<tr valign="middle">
17
 
<td><a accesskey="p" href="IBusServer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
17
<td><a accesskey="p" href="IBusObject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
18
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
20
<th width="100%" align="center">IBus Reference Manual</th>
65
65
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="ibus-ibusshare.html#ibus-get-user-name" title="ibus_get_user_name ()">ibus_get_user_name</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
66
66
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#glong"><span class="returnvalue">glong</span></a>               <a class="link" href="ibus-ibusshare.html#ibus-get-daemon-uid" title="ibus_get_daemon_uid ()">ibus_get_daemon_uid</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
67
67
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="ibus-ibusshare.html#ibus-get-socket-path" title="ibus_get_socket_path ()">ibus_get_socket_path</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
 
68
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="ibus-ibusshare.html#ibus-get-timeout" title="ibus_get_timeout ()">ibus_get_timeout</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
68
69
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="ibus-ibusshare.html#ibus-keyval-name" title="ibus_keyval_name ()">ibus_keyval_name</a>                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);
69
70
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="ibus-ibusshare.html#ibus-keyval-from-name" title="ibus_keyval_from_name ()">ibus_keyval_from_name</a>               (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *keyval_name</code></em>);
70
71
<span class="returnvalue">void</span>                <a class="link" href="ibus-ibusshare.html#ibus-free-strv" title="ibus_free_strv ()">ibus_free_strv</a>                      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **strv</code></em>);
76
77
<span class="returnvalue">void</span>                <a class="link" href="ibus-ibusshare.html#ibus-init" title="ibus_init ()">ibus_init</a>                           (<em class="parameter"><code><span class="type">void</span></code></em>);
77
78
<span class="returnvalue">void</span>                <a class="link" href="ibus-ibusshare.html#ibus-main" title="ibus_main ()">ibus_main</a>                           (<em class="parameter"><code><span class="type">void</span></code></em>);
78
79
<span class="returnvalue">void</span>                <a class="link" href="ibus-ibusshare.html#ibus-quit" title="ibus_quit ()">ibus_quit</a>                           (<em class="parameter"><code><span class="type">void</span></code></em>);
 
80
<span class="returnvalue">void</span>                <a class="link" href="ibus-ibusshare.html#ibus-set-log-handler" title="ibus_set_log_handler ()">ibus_set_log_handler</a>                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> verbose</code></em>);
79
81
</pre>
80
82
</div>
81
83
<div class="refsect1" title="Description">
277
279
<p>
278
280
Return the D-Bus address of IBus.
279
281
It will find the address from following source:
280
 
</p>
281
 
<div class="orderedlist"><ol class="orderedlist" type="1">
282
 
<li class="listitem"><p>Environment variable IBUS_ADDRESS</p></li>
283
 
<li class="listitem"><p>Socket file under ~/.config/ibus/bus/</p></li>
284
 
</ol></div>
285
 
<p>
 
282
&lt;orderedlist&gt;
 
283
   &lt;listitem&gt;&lt;para&gt;Environment variable IBUS_ADDRESS&lt;/para&gt;&lt;/listitem&gt;
 
284
   &lt;listitem&gt;&lt;para&gt;Socket file under ~/.config/ibus/bus/&lt;/para&gt;&lt;/listitem&gt;
 
285
&lt;/orderedlist&gt;
286
286
</p>
287
287
<p>
288
288
<em class="parameter"><code>see_also</code></em>: <a class="link" href="ibus-ibusshare.html#ibus-write-address" title="ibus_write_address ()"><code class="function">ibus_write_address()</code></a>.
322
322
<p>
323
323
Get the current user name.
324
324
It is determined by:
325
 
</p>
326
 
<div class="orderedlist"><ol class="orderedlist" type="1">
327
 
<li class="listitem"><p><code class="function">getlogin()</code></p></li>
328
 
<li class="listitem"><p>Environment variable SUDO_USER</p></li>
329
 
<li class="listitem"><p>Environment variable USERHELPER_UID</p></li>
330
 
<li class="listitem"><p>Environment variable USERNAME</p></li>
331
 
<li class="listitem"><p>Environment variable LOGNAME</p></li>
332
 
<li class="listitem"><p>Environment variable USER</p></li>
333
 
<li class="listitem"><p>Environment variable LNAME</p></li>
334
 
</ol></div>
335
 
<p>
 
325
&lt;orderedlist&gt;
 
326
   &lt;listitem&gt;&lt;para&gt;<code class="function">getlogin()</code>&lt;/para&gt;&lt;/listitem&gt;
 
327
   &lt;listitem&gt;&lt;para&gt;Environment variable SUDO_USER&lt;/para&gt;&lt;/listitem&gt;
 
328
   &lt;listitem&gt;&lt;para&gt;Environment variable USERHELPER_UID&lt;/para&gt;&lt;/listitem&gt;
 
329
   &lt;listitem&gt;&lt;para&gt;Environment variable USERNAME&lt;/para&gt;&lt;/listitem&gt;
 
330
   &lt;listitem&gt;&lt;para&gt;Environment variable LOGNAME&lt;/para&gt;&lt;/listitem&gt;
 
331
   &lt;listitem&gt;&lt;para&gt;Environment variable USER&lt;/para&gt;&lt;/listitem&gt;
 
332
   &lt;listitem&gt;&lt;para&gt;Environment variable LNAME&lt;/para&gt;&lt;/listitem&gt;
 
333
&lt;/orderedlist&gt;
336
334
</p>
337
335
<div class="variablelist"><table border="0">
338
336
<col align="left" valign="top">
381
379
</table></div>
382
380
</div>
383
381
<hr>
 
382
<div class="refsect2" title="ibus_get_timeout ()">
 
383
<a name="ibus-get-timeout"></a><h3>ibus_get_timeout ()</h3>
 
384
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                ibus_get_timeout                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
385
<p>
 
386
Get the GDBus timeout in milliseconds. The timeout is for clients (e.g. im-ibus.so), not for ibus-daemon.
 
387
Note that the timeout for ibus-daemon could be set by --timeout command line option of the daemon.
 
388
</p>
 
389
<div class="variablelist"><table border="0">
 
390
<col align="left" valign="top">
 
391
<tbody><tr>
 
392
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
393
<td>A GDBus timeout in milliseconds. -1 when default timeout for GDBus should be used.
 
394
</td>
 
395
</tr></tbody>
 
396
</table></div>
 
397
</div>
 
398
<hr>
384
399
<div class="refsect2" title="ibus_keyval_name ()">
385
400
<a name="ibus-keyval-name"></a><h3>ibus_keyval_name ()</h3>
386
401
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_keyval_name                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);</pre>
552
567
<em class="parameter"><code>see_also</code></em>: <a class="link" href="ibus-ibusshare.html#ibus-main" title="ibus_main ()"><code class="function">ibus_main()</code></a>.
553
568
</p>
554
569
</div>
 
570
<hr>
 
571
<div class="refsect2" title="ibus_set_log_handler ()">
 
572
<a name="ibus-set-log-handler"></a><h3>ibus_set_log_handler ()</h3>
 
573
<pre class="programlisting"><span class="returnvalue">void</span>                ibus_set_log_handler                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> verbose</code></em>);</pre>
 
574
<p>
 
575
Sets GLIB's log handler to ours. Our log handler adds time info
 
576
including hour, minute, second, and microsecond, like:
 
577
</p>
 
578
<p>
 
579
(ibus-daemon:7088): IBUS-DEBUG: 18:06:45.822819: ibus-daemon started
 
580
</p>
 
581
<p>
 
582
If <em class="parameter"><code>verbose</code></em> is TRUE, all levels of messages will be logged. Otherwise,
 
583
DEBUG and WARNING messages will be ignored.  The function is used in
 
584
ibus-daemon, but can be useful for IBus client programs as well for
 
585
debugging. It's totally fine for not calling this function. If you
 
586
don't set a custom GLIB log handler, the default GLIB log handler will
 
587
be used.
 
588
</p>
 
589
<div class="variablelist"><table border="0">
 
590
<col align="left" valign="top">
 
591
<tbody><tr>
 
592
<td><p><span class="term"><em class="parameter"><code>verbose</code></em> :</span></p></td>
 
593
<td>TRUE for verbose logging.
 
594
</td>
 
595
</tr></tbody>
 
596
</table></div>
 
597
</div>
555
598
</div>
556
599
</div>
557
600
<div class="footer">