Module: AMS::Keyboard
- Defined in:
- Documentation/ams/keyboard.rb
Overview
All methods below were made compatible with Mac OS X since 3.4.0 unless otherwise stated.
This namespace contains keyboard key state retrieval functions.
Class Method Summary collapse
-
.control_down? ⇒ Boolean
(also: ctrl_down?)
Determine whether CTRL key is down.
-
.control_up? ⇒ Boolean
(also: ctrl_up?)
Determine whether CTRL key is up.
-
.get_key_code(vk_name) ⇒ Fixnum?
Get virtual key code associated with the virtual key name.
-
.get_key_name(vk_code) ⇒ String?
Get virtual key name associated with the virtual key code.
-
.get_key_state(vk) ⇒ Fixnum
(also: key)
Get virtual key state.
-
.get_keyboard_state ⇒ Array<Fixnum>
Get an array of all virtual key states.
-
.gey_virtual_key_codes ⇒ Hash<String, Fixnum>
Get general virtual key names and their associated key codes.
-
.gey_virtual_key_codes2 ⇒ Hash<String, Fixnum>
Get extended virtual key names and their associated key codes.
-
.gey_virtual_key_names ⇒ Hash<Fixnum, String>
Get virtual key codes and their associated key names.
-
.key_down?(vk) ⇒ Boolean
Determine whether virtual key is down.
-
.key_toggled?(vk) ⇒ Boolean
Determine whether virtual key is toggled.
-
.key_up?(vk) ⇒ Boolean
Determine whether virtual key is up.
-
.keys_down?(*vks) ⇒ Boolean
Determine whether an array of virtual keys are down.
-
.keys_up?(*vks) ⇒ Boolean
Determine whether an array of virtual keys are up.
-
.lbutton_down? ⇒ Boolean
Determine whether left mouse button is down.
-
.lbutton_up? ⇒ Boolean
Determine whether left mouse button is up.
-
.lcontrol_down? ⇒ Boolean
(also: lctrl_down?)
Determine whether left CTRL key is down.
-
.lcontrol_up? ⇒ Boolean
(also: lctrl_up?)
Determine whether left CTRL key is up.
-
.lmenu_down? ⇒ Boolean
(also: lalt_down?)
Determine whether left ALT key is down.
-
.lmenu_up? ⇒ Boolean
(also: lalt_up?)
Determine whether left ALT key is up.
-
.lshift_down? ⇒ Boolean
Determine whether left SHIFT key is down.
-
.lshift_up? ⇒ Boolean
Determine whether left SHIFT key is up.
-
.mbutton_down? ⇒ Boolean
Determine whether middle mouse button is down.
-
.mbutton_up? ⇒ Boolean
Determine whether middle mouse button is up.
-
.menu_down? ⇒ Boolean
(also: alt_down?)
Determine whether ALT key is down.
-
.menu_up? ⇒ Boolean
(also: alt_up?)
Determine whether ALT key is up.
-
.rbutton_down? ⇒ Boolean
Determine whether right mouse button is down.
-
.rbutton_up? ⇒ Boolean
Determine whether right mouse button is up.
-
.rcontrol_down? ⇒ Boolean
(also: rctrl_down?)
Determine whether right CTRL key is down.
-
.rcontrol_up? ⇒ Boolean
(also: rctrl_up?)
Determine whether right CTRL key is up.
-
.rmenu_down? ⇒ Boolean
(also: ralt_down?)
Determine whether right ALT key is down.
-
.rmenu_up? ⇒ Boolean
(also: ralt_up?)
Determine whether right ALT key is up.
-
.rshift_down? ⇒ Boolean
Determine whether right SHIFT key is down.
-
.rshift_up? ⇒ Boolean
Determine whether right SHIFT key is up.
-
.shift_down? ⇒ Boolean
Determine whether SHIFT key is down.
-
.shift_up? ⇒ Boolean
Determine whether SHIFT key is up.
-
.xbutton1_down? ⇒ Boolean
Determine whether X1 mouse button is down.
-
.xbutton1_up? ⇒ Boolean
Determine whether X1 mouse button is up.
-
.xbutton2_down? ⇒ Boolean
Determine whether X2 mouse button is down.
-
.xbutton2_up? ⇒ Boolean
Determine whether X2 mouse button is up.
Class Method Details
.control_down? ⇒ Boolean Also known as: ctrl_down?
Determine whether CTRL key is down.
.control_up? ⇒ Boolean Also known as: ctrl_up?
Determine whether CTRL key is up.
.get_key_code(vk_name) ⇒ Fixnum?
Get virtual key code associated with the virtual key name.
.get_key_name(vk_code) ⇒ String?
Get virtual key name associated with the virtual key code.
.get_key_state(vk) ⇒ Fixnum Also known as: key
Get virtual key state.
.get_keyboard_state ⇒ Array<Fixnum>
Windows only!
Get an array of all virtual key states.
.gey_virtual_key_codes ⇒ Hash<String, Fixnum>
Get general virtual key names and their associated key codes.
.gey_virtual_key_codes2 ⇒ Hash<String, Fixnum>
Get extended virtual key names and their associated key codes.
.gey_virtual_key_names ⇒ Hash<Fixnum, String>
Get virtual key codes and their associated key names.
.key_down?(vk) ⇒ Boolean
Determine whether virtual key is down.
.key_toggled?(vk) ⇒ Boolean
Windows only!
Determine whether virtual key is toggled.
.key_up?(vk) ⇒ Boolean
Determine whether virtual key is up.
.keys_down?(*vks) ⇒ Boolean
Determine whether an array of virtual keys are down.
.keys_up?(*vks) ⇒ Boolean
Determine whether an array of virtual keys are up.
.lbutton_down? ⇒ Boolean
Windows only!
Determine whether left mouse button is down.
.lbutton_up? ⇒ Boolean
Windows only!
Determine whether left mouse button is up.
.lcontrol_down? ⇒ Boolean Also known as: lctrl_down?
Determine whether left CTRL key is down.
.lcontrol_up? ⇒ Boolean Also known as: lctrl_up?
Determine whether left CTRL key is up.
.lmenu_down? ⇒ Boolean Also known as: lalt_down?
Determine whether left ALT key is down.
.lmenu_up? ⇒ Boolean Also known as: lalt_up?
Determine whether left ALT key is up.
.lshift_down? ⇒ Boolean
Determine whether left SHIFT key is down.
.lshift_up? ⇒ Boolean
Determine whether left SHIFT key is up.
.mbutton_down? ⇒ Boolean
Windows only!
Determine whether middle mouse button is down.
.mbutton_up? ⇒ Boolean
Windows only!
Determine whether middle mouse button is up.
.menu_down? ⇒ Boolean Also known as: alt_down?
Determine whether ALT key is down.
.menu_up? ⇒ Boolean Also known as: alt_up?
Determine whether ALT key is up.
.rbutton_down? ⇒ Boolean
Windows only!
Determine whether right mouse button is down.
.rbutton_up? ⇒ Boolean
Windows only!
Determine whether right mouse button is up.
.rcontrol_down? ⇒ Boolean Also known as: rctrl_down?
Determine whether right CTRL key is down.
.rcontrol_up? ⇒ Boolean Also known as: rctrl_up?
Determine whether right CTRL key is up.
.rmenu_down? ⇒ Boolean Also known as: ralt_down?
Determine whether right ALT key is down.
.rmenu_up? ⇒ Boolean Also known as: ralt_up?
Determine whether right ALT key is up.
.rshift_down? ⇒ Boolean
Determine whether right SHIFT key is down.
.rshift_up? ⇒ Boolean
Determine whether right SHIFT key is up.
.shift_down? ⇒ Boolean
Determine whether SHIFT key is down.
.shift_up? ⇒ Boolean
Determine whether SHIFT key is up.
.xbutton1_down? ⇒ Boolean
Windows only!
Determine whether X1 mouse button is down.
.xbutton1_up? ⇒ Boolean
Windows only!
Determine whether X1 mouse button is up.
.xbutton2_down? ⇒ Boolean
Windows only!
Determine whether X2 mouse button is down.
.xbutton2_up? ⇒ Boolean
Windows only!
Determine whether X2 mouse button is up.