← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/ibus/html/IBusHotkeyProfile.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/IBusHotkeyProfile.html
68
68
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> prev_keyval</code></em>,
69
69
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> prev_modifiers</code></em>,
70
70
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
 
71
<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              <a class="link" href="IBusHotkeyProfile.html#ibus-hotkey-profile-lookup-hotkey" title="ibus_hotkey_profile_lookup_hotkey ()">ibus_hotkey_profile_lookup_hotkey</a>   (<em class="parameter"><code><a class="link" href="IBusHotkeyProfile.html" title="IBusHotkeyProfile"><span class="type">IBusHotkeyProfile</span></a> *profile</code></em>,
 
72
                                                         <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>,
 
73
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> modifiers</code></em>);
71
74
</pre>
72
75
</div>
73
76
<div class="refsect1" title="Object Hierarchy">
165
168
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> event</code></em>);</pre>
166
169
<p>
167
170
Add a hotkey and its associated event to an IBusHotkeyProfile.
168
 
The hotkey is in string format, such like <code class="constant">Control+Shift+A</code>.
 
171
The hotkey is in string format, such like &lt;constant&gt;Control+Shift+A&lt;/constant&gt;.
169
172
</p>
170
173
<div class="variablelist"><table border="0">
171
174
<col align="left" valign="top">
269
272
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> prev_modifiers</code></em>,
270
273
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
271
274
<p>
272
 
Emit a <code class="constant">::trigger</code> signal when a hotkey is in a profile.
 
275
Emit a &lt;constant&gt;::trigger&lt;/constant&gt; signal when a hotkey is in a profile.
273
276
</p>
274
277
<p>
275
278
<em class="parameter"><code>see_also</code></em>: ::trigger
315
318
</tbody>
316
319
</table></div>
317
320
</div>
 
321
<hr>
 
322
<div class="refsect2" title="ibus_hotkey_profile_lookup_hotkey ()">
 
323
<a name="ibus-hotkey-profile-lookup-hotkey"></a><h3>ibus_hotkey_profile_lookup_hotkey ()</h3>
 
324
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              ibus_hotkey_profile_lookup_hotkey   (<em class="parameter"><code><a class="link" href="IBusHotkeyProfile.html" title="IBusHotkeyProfile"><span class="type">IBusHotkeyProfile</span></a> *profile</code></em>,
 
325
                                                         <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>,
 
326
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> modifiers</code></em>);</pre>
 
327
<div class="variablelist"><table border="0">
 
328
<col align="left" valign="top">
 
329
<tbody>
 
330
<tr>
 
331
<td><p><span class="term"><em class="parameter"><code>profile</code></em> :</span></p></td>
 
332
<td>An IBusHotkeyProfile.
 
333
</td>
 
334
</tr>
 
335
<tr>
 
336
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
 
337
<td>Keycode of the hotkey.
 
338
</td>
 
339
</tr>
 
340
<tr>
 
341
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
342
<td>Modifiers of the hotkey.
 
343
</td>
 
344
</tr>
 
345
<tr>
 
346
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
347
<td>The event associated to the hotkey or 0 if the hotkey is not in the
 
348
profile.
 
349
</td>
 
350
</tr>
 
351
</tbody>
 
352
</table></div>
 
353
</div>
318
354
</div>
319
355
<div class="refsect1" title="Signal Details">
320
356
<a name="IBusHotkeyProfile.signal-details"></a><h2>Signal Details</h2>
329
365
Implement the member function <code class="function">trigger()</code> in extended class to receive this signal.
330
366
</p>
331
367
<p>
332
 
</p>
333
 
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
334
 
<h3 class="title">Note</h3>
335
 
<p>The last parameter, user_data is not actually a valid parameter. It is displayed because of GtkDoc bug.</p>
336
 
</div>
337
 
<p>
 
368
&lt;note&gt;&lt;para&gt;The last parameter, user_data is not actually a valid parameter. It is displayed because of GtkDoc bug.&lt;/para&gt;&lt;/note&gt;
338
369
</p>
339
370
<div class="variablelist"><table border="0">
340
371
<col align="left" valign="top">