Defines standard interface definitions for controls. More...
Enumerations | |
enum | border_style { B_PLAIN_BORDER , B_FANCY_BORDER , B_NO_BORDER } |
enum | button_width { B_WIDTH_AS_USUAL , B_WIDTH_FROM_WIDEST , B_WIDTH_FROM_LABEL } |
enum | cap_mode { B_ROUND_CAP = B_ROUND_JOIN , B_BUTT_CAP = B_BUTT_JOIN , B_SQUARE_CAP = B_SQUARE_JOIN } |
enum | join_mode { B_ROUND_JOIN = 0 , B_MITER_JOIN , B_BEVEL_JOIN , B_BUTT_JOIN , B_SQUARE_JOIN } |
enum | orientation { B_HORIZONTAL , B_VERTICAL } |
Functions | |
status_t | get_key_info (key_info *info) |
Fills out the key_info struct with the current state of the keyboard. | |
void | get_key_map (key_map **_map, char **_keyBuffer) |
Provides a copy of the system keymap. | |
status_t | get_keyboard_id (uint16 *_id) |
Fills out _id with the id of the currently attached keyboard. | |
status_t | get_modifier_key (uint32 modifier, uint32 *key) |
Gets the code of the requested modifier key from the system keymap. | |
status_t | get_mouse_speed (int32 *speed) |
Get the mouse speed. | |
status_t | get_mouse_type (int32 *type) |
Get the number of buttons of the mouse. | |
uint32 | modifiers () |
Gets a bitmap of each modifier key pressed down and each active keyboard lock. | |
void | set_keyboard_locks (uint32 modifiers) |
Set the keyboard locks. | |
void | set_modifier_key (uint32 modifier, uint32 key) |
Set the modifier key to the specified code in the system keymap. | |
Variables | |
const float | B_DEFAULT_MITER_LIMIT = 10.0F |
Defines standard interface definitions for controls.
enum border_style |
enum button_width |
enum cap_mode |
enum join_mode |
enum orientation |
status_t get_key_info | ( | key_info * | info | ) |
Fills out the key_info struct with the current state of the keyboard.
info | The key_info struct to fill out. |
B_OK | Everything went fine. |
B_ERROR | There was an error retrieving the key_info struct. |
void get_key_map | ( | key_map ** | _map, |
char ** | _keyBuffer | ||
) |
Provides a copy of the system keymap.
_map | A pointer to the system keymap structure. |
_keyBuffer | A pointer containing the UTF-8 character encodings. |
Fills out _id with the id of the currently attached keyboard.
B_OK | Everything went fine. |
B_ERROR | There was an error retrieving the keyboard id. |
Gets the code of the requested modifier key from the system keymap.
modifier | The modifier key to get from the system keymap. |
key | A pointer to an int32 to store the key code. |
B_OK | Everything went fine. |
B_ERROR | There was an error retrieving the modifier key. |
Get the mouse speed.
If there are multiple mouses connected, this function return the speed from a random one.
Get the number of buttons of the mouse.
If there are multiple mouses connected, the number of buttons for one of them picked at random will be returned.
uint32 modifiers | ( | ) |
Gets a bitmap of each modifier key pressed down and each active keyboard lock.
Test the bitmap returned using a bit mask composed of the following modifier key constants:
B_CAPS_LOCK
B_COMMAND_KEY
B_CONTROL_KEY
B_MENU_KEY
B_NUM_LOCK
B_OPTION_KEY
B_SCROLL_LOCK
B_SHIFT_KEY
You may use a bit mask of 0 to test that no modifier keys are pressed. If it is important to know if the left or right modifier key is pressed down you can use the following additional constants:
B_LEFT_SHIFT_KEY
B_RIGHT_SHIFT_KEY
B_LEFT_CONTROL_KEY
B_RIGHT_CONTROL_KEY
B_LEFT_OPTION_KEY
B_RIGHT_OPTION_KEY
B_LEFT_COMMAND_KEY
B_RIGHT_COMMAND_KEY
void set_keyboard_locks | ( | uint32 | modifiers | ) |
Set the keyboard locks.
Pass in a bit mask containing the following constants:
B_CAPS_LOCK
B_NUM_LOCK
B_SCROLL_LOCK
The constants present in the bit mask will turn the lock on, those absent will turn the lock off. Pass 0 in to turn off all locks.
modifiers | A bitmap of lock keys to set. |
Set the modifier key to the specified code in the system keymap.
modifier | The modifier key to set in the system keymap. |
key | The key code to set the modifier key to. |
B_DEFAULT_MITER_LIMIT = 10.0F |
Default miter limit used to calculate the angle cut off for miter joins.