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	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.
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.

Detailed Description

Defines standard interface definitions for controls.

Enumeration Type Documentation

enum button_width

Collection of flags that determine how wide to draw the buttons in a BAlert dialog.

Enumerator:

B_WIDTH_AS_USUAL	Set the width of each button based on the standard width.
B_WIDTH_FROM_WIDEST	Set the width of each button based on the width of the widest button.
B_WIDTH_FROM_LABEL	Set the width of each button to accomidate the width of the button's label.

enum orientation

Orientation flag sets the layout to either horizontal or vertical alignment.

Enumerator:

B_HORIZONTAL	Horizontal alignment
B_VERTICAL	Vertical alignment

Function Documentation

status_t get_key_info ( key_info * info )

Fills out the key_info struct with the current state of the keyboard.

Parameters:

info	The key_info struct to fill out.

Return values:

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.

Attention:: You must free _map and _keyBuffer when you are done with them.

Parameters:

_map	A pointer to the system keymap structure.
_keyBuffer	A pointer containing the UTF-8 character encodings.

status_t get_keyboard_id ( uint16 * _id )

Fills out _id with the id of the currently attached keyboard.

Return values:

B_OK	Everything went fine.
B_ERROR	There was an error retrieving the keyboard id.

status_t get_modifier_key	(	uint32	modifier,
		uint32 *	key
	)

Gets the code of the requested modifier key from the system keymap.

Parameters:

modifier	The modifier key to get from the system keymap.
key	A pointer to an int32 to store the key code.

Return values:

B_OK	Everything went fine.
B_ERROR	There was an error retrieving the modifier key.

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

Returns:: A bitmap containing each active modifier keys and locks.

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.

Parameters:

modifiers A bitmap of lock keys to set.

void set_modifier_key	(	uint32	modifier,
		uint32	key
	)

Set the modifier key to the specified code in the system keymap.

Parameters:

modifier	The modifier key to set in the system keymap.
key	The key code to set the modifier key to.

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation