12
12
<refname>IBusHotkeyProfile</refname>
13
<refpurpose></refpurpose>
13
<refpurpose>Hotkeys and associated events.</refpurpose>
15
<refsect1 id="IBusHotkeyProfile.stability-level">
16
<title>Stability Level</title>
17
Stable, unless otherwise indicated
16
20
<refsynopsisdiv id="IBusHotkeyProfile.synopsis" role="synopsis">
17
21
<title role="synopsis.title">Synopsis</title>
77
83
<title>IBusHotkeyProfile</title>
78
84
<indexterm zone="IBusHotkeyProfile-struct"><primary sortas="IBusHotkeyProfile">IBusHotkeyProfile</primary></indexterm><programlisting>typedef struct _IBusHotkeyProfile IBusHotkeyProfile;</programlisting>
86
An opaque data type representing an IBusHotkeyProfile.</para>
81
89
<refsect2 id="ibus-hotkey-profile-add-hotkey" role="function">
82
90
<title>ibus_hotkey_profile_add_hotkey ()</title>
85
93
<link linkend="guint">guint</link> modifiers,
86
94
<link linkend="GQuark">GQuark</link> event);</programlisting>
96
Add a hotkey and its associated event to an IBusHotkeyProfile.</para>
88
98
</para><variablelist role="params">
89
99
<varlistentry><term><parameter>profile</parameter> :</term>
100
<listitem><simpara> An IBusHotkeyProfile.
91
101
</simpara></listitem></varlistentry>
92
102
<varlistentry><term><parameter>keyval</parameter> :</term>
103
<listitem><simpara> Keycode of the hotkey.
94
104
</simpara></listitem></varlistentry>
95
105
<varlistentry><term><parameter>modifiers</parameter> :</term>
106
<listitem><simpara> Modifiers of the hotkey.
97
107
</simpara></listitem></varlistentry>
98
108
<varlistentry><term><parameter>event</parameter> :</term>
109
<listitem><simpara> The event to be associated.
100
110
</simpara></listitem></varlistentry>
101
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
111
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Always TRUE.
102
112
</simpara></listitem></varlistentry>
103
113
</variablelist></refsect2>
104
114
<refsect2 id="ibus-hotkey-profile-add-hotkey-from-string" role="function">
108
118
const <link linkend="gchar">gchar</link> *str,
109
119
<link linkend="GQuark">GQuark</link> event);</programlisting>
121
Add a hotkey and its associated event to an IBusHotkeyProfile.
122
The hotkey is in string format, such like <constant>Control+Shift+A</constant>.</para>
111
124
</para><variablelist role="params">
112
125
<varlistentry><term><parameter>profile</parameter> :</term>
126
<listitem><simpara> An IBusHotkeyProfile.
114
127
</simpara></listitem></varlistentry>
115
128
<varlistentry><term><parameter>str</parameter> :</term>
129
<listitem><simpara> Key in string representation. '+' is the separator.
117
130
</simpara></listitem></varlistentry>
118
131
<varlistentry><term><parameter>event</parameter> :</term>
132
<listitem><simpara> The event to be associated.
120
133
</simpara></listitem></varlistentry>
121
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
134
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> FALSE if <parameter>str</parameter> contains invalid symbol; TRUE otherwise.
122
135
</simpara></listitem></varlistentry>
123
136
</variablelist></refsect2>
124
137
<refsect2 id="ibus-hotkey-profile-remove-hotkey" role="function">
127
140
<link linkend="guint">guint</link> keyval,
128
141
<link linkend="guint">guint</link> modifiers);</programlisting>
143
Remove the hotkey for an IBusHotkeyProfile.</para>
130
145
</para><variablelist role="params">
131
146
<varlistentry><term><parameter>profile</parameter> :</term>
147
<listitem><simpara> An IBusHotkeyProfile.
133
148
</simpara></listitem></varlistentry>
134
149
<varlistentry><term><parameter>keyval</parameter> :</term>
150
<listitem><simpara> Keycode of the hotkey.
136
151
</simpara></listitem></varlistentry>
137
152
<varlistentry><term><parameter>modifiers</parameter> :</term>
153
<listitem><simpara> Modifiers of the hotkey.
139
154
</simpara></listitem></varlistentry>
140
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
155
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> FALSE if the key is not in <parameter>profile</parameter>, TRUE otherwise.
141
156
</simpara></listitem></varlistentry>
142
157
</variablelist></refsect2>
143
158
<refsect2 id="ibus-hotkey-profile-remove-hotkey-by-event" role="function">
146
161
(<link linkend="IBusHotkeyProfile">IBusHotkeyProfile</link> *profile,
147
162
<link linkend="GQuark">GQuark</link> event);</programlisting>
164
Remove the hotkey for an IBusHotkeyProfile by event.</para>
149
166
</para><variablelist role="params">
150
167
<varlistentry><term><parameter>profile</parameter> :</term>
168
<listitem><simpara> An IBusHotkeyProfile.
152
169
</simpara></listitem></varlistentry>
153
170
<varlistentry><term><parameter>event</parameter> :</term>
171
<listitem><simpara> The associated event.
155
172
</simpara></listitem></varlistentry>
156
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
173
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> FALSE if no such event in <parameter>profile</parameter>, TRUE otherwise.
157
174
</simpara></listitem></varlistentry>
158
175
</variablelist></refsect2>
159
176
<refsect2 id="ibus-hotkey-profile-filter-key-event" role="function">
166
183
<link linkend="guint">guint</link> prev_modifiers,
167
184
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
186
Emit a <constant>::trigger</constant> signal when a hotkey is in a profile.
189
<parameter>see_also</parameter>: ::trigger</para>
169
191
</para><variablelist role="params">
170
192
<varlistentry><term><parameter>profile</parameter> :</term>
193
<listitem><simpara> An IBusHotkeyProfile.
172
194
</simpara></listitem></varlistentry>
173
195
<varlistentry><term><parameter>keyval</parameter> :</term>
196
<listitem><simpara> Keycode of the hotkey.
175
197
</simpara></listitem></varlistentry>
176
198
<varlistentry><term><parameter>modifiers</parameter> :</term>
199
<listitem><simpara> Modifiers of the hotkey.
178
200
</simpara></listitem></varlistentry>
179
201
<varlistentry><term><parameter>prev_keyval</parameter> :</term>
202
<listitem><simpara> Keycode of the hotkey.
181
203
</simpara></listitem></varlistentry>
182
204
<varlistentry><term><parameter>prev_modifiers</parameter> :</term>
205
<listitem><simpara> Modifiers of the hotkey.
184
206
</simpara></listitem></varlistentry>
185
207
<varlistentry><term><parameter>user_data</parameter> :</term>
208
<listitem><simpara> user data for signal "trigger".
187
209
</simpara></listitem></varlistentry>
188
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
210
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 if releasing a hotkey and the hotkey is not in the profile ; an associated event otherwise.
189
211
</simpara></listitem></varlistentry>
190
212
</variablelist></refsect2>
194
216
<refsect1 id="IBusHotkeyProfile.signal-details" role="signals">
195
217
<title role="signals.title">Signal Details</title>
196
218
<refsect2 id="IBusHotkeyProfile-trigger" role="signal"><title>The <literal>"trigger"</literal> signal</title>
197
<indexterm zone="IBusHotkeyProfile-trigger"><primary sortas="IBusHotkeyProfile::trigger">IBusHotkeyProfile::trigger</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="IBusHotkeyProfile">IBusHotkeyProfile</link> *ibushotkeyprofile,
198
<link linkend="guint">guint</link> arg1,
199
<link linkend="gpointer">gpointer</link> arg2,
200
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Has Details</programlisting>
219
<indexterm zone="IBusHotkeyProfile-trigger"><primary sortas="IBusHotkeyProfile::trigger">IBusHotkeyProfile::trigger</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="IBusHotkeyProfile">IBusHotkeyProfile</link> *profile,
220
<link linkend="guint">guint</link> event,
221
<link linkend="gpointer">gpointer</link> user_data,
222
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Has Details</programlisting>
224
Emitted when a hotkey is pressed and the hotkey is in profile.
225
Implement the member function <link linkend="trigger"><function>trigger()</function></link> in extended class to receive this signal.
228
<note><para>The last parameter, user_data is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
202
230
</para><variablelist role="params">
203
<varlistentry><term><parameter>ibushotkeyprofile</parameter> :</term>
204
<listitem><simpara>the object which received the signal.
205
</simpara></listitem></varlistentry>
206
<varlistentry><term><parameter>arg1</parameter> :</term>
208
</simpara></listitem></varlistentry>
209
<varlistentry><term><parameter>arg2</parameter> :</term>
231
<varlistentry><term><parameter>profile</parameter> :</term>
232
<listitem><simpara> An IBusHotkeyProfile.
233
</simpara></listitem></varlistentry>
234
<varlistentry><term><parameter>event</parameter> :</term>
235
<listitem><simpara> An event in GQuark.
236
</simpara></listitem></varlistentry>
237
<varlistentry><term><parameter>user_data</parameter> :</term>
238
<listitem><simpara> User data for callback.
211
239
</simpara></listitem></varlistentry>
212
240
<varlistentry><term><parameter>user_data</parameter> :</term>
213
241
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
added
removed
docs/reference/ibus/xml/ibushotkey.xml
