Enumerations | Functions | Variables
InterfaceDefs.h File Reference

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. More...
 
void get_key_map (key_map **_map, char **_keyBuffer)
 Provides a copy of the system keymap. More...
 
status_t get_keyboard_id (uint16 *_id)
 Fills out _id with the id of the currently attached keyboard. More...
 
status_t get_modifier_key (uint32 modifier, uint32 *key)
 Gets the code of the requested modifier key from the system keymap. More...
 
uint32 modifiers ()
 Gets a bitmap of each modifier key pressed down and each active keyboard lock. More...
 
void set_keyboard_locks (uint32 modifiers)
 Set the keyboard locks. More...
 
void set_modifier_key (uint32 modifier, uint32 key)
 Set the modifier key to the specified code in the system keymap. More...
 

Variables

const float B_DEFAULT_MITER_LIMIT = 10.0F
 

Detailed Description

Defines standard interface definitions for controls.

Since
BeOS R3

Enumeration Type Documentation

◆ button_width

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

Since
BeOS R3
Enumerator
B_WIDTH_AS_USUAL 

Set the width of each button based on the standard width.

Since
BeOS R3
B_WIDTH_FROM_WIDEST 

Set the width of each button based on the width of the widest button.

Since
BeOS R3
B_WIDTH_FROM_LABEL 

Set the width of each button to accommodate the label.

Since
BeOS R5

◆ cap_mode

enum cap_mode

PostScript-style line cap modes used by BView::SetLineMode()

Since
BeOS R3
Enumerator
B_ROUND_CAP 

Round cap mode.

Since
BeOS R3
B_BUTT_CAP 

Butt cap mode.

Since
BeOS R3
B_SQUARE_CAP 

Square cap mode.

Since
BeOS R3

◆ join_mode

enum join_mode

PostScript-style line join modes used by BView::SetLineMode()

Since
BeOS R3
Enumerator
B_ROUND_JOIN 

Round join mode.

Since
BeOS R3
B_MITER_JOIN 

Miter join mode.

Since
BeOS R3
B_BEVEL_JOIN 

Bevel join mode.

Since
BeOS R3
B_BUTT_JOIN 

Butt join mode.

Since
BeOS R3
B_SQUARE_JOIN 

Square join mode.

Since
BeOS R3

◆ orientation

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

Since
BeOS R3
Enumerator
B_HORIZONTAL 

Horizontal alignment

B_VERTICAL 

Vertical alignment

Since
BeOS R3

Function Documentation

◆ get_key_info()

status_t get_key_info ( key_info *  info)

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

Parameters
infoThe key_info struct to fill out.
Return values
B_OKEverything went fine.
B_ERRORThere was an error retrieving the key_info struct.
Since
BeOS R3

◆ get_key_map()

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
_mapA pointer to the system keymap structure.
_keyBufferA pointer containing the UTF-8 character encodings.
Since
BeOS R3

◆ get_keyboard_id()

status_t get_keyboard_id ( uint16 *  _id)

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

Return values
B_OKEverything went fine.
B_ERRORThere was an error retrieving the keyboard id.
Since
BeOS R3

◆ get_modifier_key()

status_t get_modifier_key ( uint32  modifier,
uint32 *  key 
)

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

Parameters
modifierThe modifier key to get from the system keymap.
keyA pointer to an int32 to store the key code.
Return values
B_OKEverything went fine.
B_ERRORThere was an error retrieving the modifier key.
Since
BeOS R3

◆ modifiers()

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.
Since
BeOS R3

◆ set_keyboard_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
modifiersA bitmap of lock keys to set.
Since
BeOS R3

◆ set_modifier_key()

void set_modifier_key ( uint32  modifier,
uint32  key 
)

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

Parameters
modifierThe modifier key to set in the system keymap.
keyThe key code to set the modifier key to.
Since
BeOS R3

Variable Documentation

◆ B_DEFAULT_MITER_LIMIT

B_DEFAULT_MITER_LIMIT = 10.0F

Default miter limit used to calculate the angle cut off for miter joins.

Since
BeOS R3