![]() |
![]() |
![]() |
IBus Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Signals |
IBusHotkeyProfile; gboolean ibus_hotkey_profile_add_hotkey (IBusHotkeyProfile *profile, guint keyval, guint modifiers, GQuark event); gboolean ibus_hotkey_profile_add_hotkey_from_string (IBusHotkeyProfile *profile, const gchar *str, GQuark event); gboolean ibus_hotkey_profile_remove_hotkey (IBusHotkeyProfile *profile, guint keyval, guint modifiers); gboolean ibus_hotkey_profile_remove_hotkey_by_event (IBusHotkeyProfile *profile, GQuark event); GQuark ibus_hotkey_profile_filter_key_event (IBusHotkeyProfile *profile, guint keyval, guint modifiers, guint prev_keyval, guint prev_modifiers, gpointer user_data);
GObject +----GInitiallyUnowned +----IBusObject +----IBusSerializable +----IBusHotkeyProfile
typedef struct _IBusHotkeyProfile IBusHotkeyProfile;
An opaque data type representing an IBusHotkeyProfile.
gboolean ibus_hotkey_profile_add_hotkey (IBusHotkeyProfile *profile, guint keyval, guint modifiers, GQuark event);
Add a hotkey and its associated event to an IBusHotkeyProfile.
|
An IBusHotkeyProfile. |
|
Keycode of the hotkey. |
|
Modifiers of the hotkey. |
|
The event to be associated. |
Returns : |
Always TRUE. |
gboolean ibus_hotkey_profile_add_hotkey_from_string (IBusHotkeyProfile *profile, const gchar *str, GQuark event);
Add a hotkey and its associated event to an IBusHotkeyProfile.
The hotkey is in string format, such like Control+Shift+A
.
|
An IBusHotkeyProfile. |
|
Key in string representation. '+' is the separator. |
|
The event to be associated. |
Returns : |
FALSE if str contains invalid symbol; TRUE otherwise.
|
gboolean ibus_hotkey_profile_remove_hotkey (IBusHotkeyProfile *profile, guint keyval, guint modifiers);
Remove the hotkey for an IBusHotkeyProfile.
|
An IBusHotkeyProfile. |
|
Keycode of the hotkey. |
|
Modifiers of the hotkey. |
Returns : |
FALSE if the key is not in profile , TRUE otherwise.
|
gboolean ibus_hotkey_profile_remove_hotkey_by_event (IBusHotkeyProfile *profile, GQuark event);
Remove the hotkey for an IBusHotkeyProfile by event.
|
An IBusHotkeyProfile. |
|
The associated event. |
Returns : |
FALSE if no such event in profile , TRUE otherwise.
|
GQuark ibus_hotkey_profile_filter_key_event (IBusHotkeyProfile *profile, guint keyval, guint modifiers, guint prev_keyval, guint prev_modifiers, gpointer user_data);
Emit a ::trigger
signal when a hotkey is in a profile.
see_also
: ::trigger
|
An IBusHotkeyProfile. |
|
Keycode of the hotkey. |
|
Modifiers of the hotkey. |
|
Keycode of the hotkey. |
|
Modifiers of the hotkey. |
|
user data for signal "trigger". |
Returns : |
0 if releasing a hotkey and the hotkey is not in the profile ; an associated event otherwise. |
"trigger"
signalvoid user_function (IBusHotkeyProfile *profile, guint event, gpointer user_data, gpointer user_data) : Run Last / Has Details
Emitted when a hotkey is pressed and the hotkey is in profile.
Implement the member function trigger()
in extended class to receive this signal.
The last parameter, user_data is not actually a valid parameter. It is displayed because of GtkDoc bug.
|
An IBusHotkeyProfile. |
|
An event in GQuark. |
|
User data for callback. |
|
user data set when the signal handler was connected. |