1 /* 2 * Copyright (c) 2001-2006, Haiku, Inc. 3 * Distributed under the terms of the MIT license. 4 * 5 * Authors: 6 * Erik Jaesler (erik@cgsoftware.com) 7 */ 8 #ifndef _INTERFACE_DEFS_H 9 #define _INTERFACE_DEFS_H 10 11 12 #include <BeBuild.h> 13 #include <GraphicsDefs.h> 14 #include <OS.h> 15 16 class BRect; 17 18 19 // some handy UTF-8 characters 20 21 #define B_UTF8_BULLET "\xE2\x80\xA2" 22 #define B_UTF8_ELLIPSIS "\xE2\x80\xA6" 23 #define B_UTF8_OPEN_QUOTE "\xE2\x80\x9C" 24 #define B_UTF8_CLOSE_QUOTE "\xE2\x80\x9D" 25 #define B_UTF8_COPYRIGHT "\xC2\xA9" 26 #define B_UTF8_REGISTERED "\xC2\xAE" 27 #define B_UTF8_TRADEMARK "\xE2\x84\xA2" 28 #define B_UTF8_SMILING_FACE "\xE2\x98\xBB" 29 #define B_UTF8_HIROSHI "\xE5\xBC\x98" 30 #ifdef COMPILE_FOR_R5 31 #define B_MAX_MOUSE_BUTTONS 3 32 #else 33 #define B_MAX_MOUSE_BUTTONS 16 34 #endif 35 36 37 // key definitions 38 39 struct key_info { 40 uint32 modifiers; 41 uint8 key_states[16]; 42 }; 43 44 enum { 45 B_BACKSPACE = 0x08, 46 B_RETURN = 0x0a, 47 B_ENTER = 0x0a, 48 B_SPACE = 0x20, 49 B_TAB = 0x09, 50 B_ESCAPE = 0x1b, 51 B_SUBSTITUTE = 0x1a, 52 53 B_LEFT_ARROW = 0x1c, 54 B_RIGHT_ARROW = 0x1d, 55 B_UP_ARROW = 0x1e, 56 B_DOWN_ARROW = 0x1f, 57 58 B_INSERT = 0x05, 59 B_DELETE = 0x7f, 60 B_HOME = 0x01, 61 B_END = 0x04, 62 B_PAGE_UP = 0x0b, 63 B_PAGE_DOWN = 0x0c, 64 65 B_FUNCTION_KEY = 0x10 66 }; 67 68 enum { 69 B_F1_KEY = 0x02, 70 B_F2_KEY = 0x03, 71 B_F3_KEY = 0x04, 72 B_F4_KEY = 0x05, 73 B_F5_KEY = 0x06, 74 B_F6_KEY = 0x07, 75 B_F7_KEY = 0x08, 76 B_F8_KEY = 0x09, 77 B_F9_KEY = 0x0a, 78 B_F10_KEY = 0x0b, 79 B_F11_KEY = 0x0c, 80 B_F12_KEY = 0x0d, 81 B_PRINT_KEY = 0x0e, 82 B_SCROLL_KEY = 0x0f, 83 B_PAUSE_KEY = 0x10 84 }; 85 86 struct key_map { 87 uint32 version; 88 uint32 caps_key; 89 uint32 scroll_key; 90 uint32 num_key; 91 uint32 left_shift_key; 92 uint32 right_shift_key; 93 uint32 left_command_key; 94 uint32 right_command_key; 95 uint32 left_control_key; 96 uint32 right_control_key; 97 uint32 left_option_key; 98 uint32 right_option_key; 99 uint32 menu_key; 100 uint32 lock_settings; 101 int32 control_map[128]; 102 int32 option_caps_shift_map[128]; 103 int32 option_caps_map[128]; 104 int32 option_shift_map[128]; 105 int32 option_map[128]; 106 int32 caps_shift_map[128]; 107 int32 caps_map[128]; 108 int32 shift_map[128]; 109 int32 normal_map[128]; 110 int32 acute_dead_key[32]; 111 int32 grave_dead_key[32]; 112 int32 circumflex_dead_key[32]; 113 int32 dieresis_dead_key[32]; 114 int32 tilde_dead_key[32]; 115 uint32 acute_tables; 116 uint32 grave_tables; 117 uint32 circumflex_tables; 118 uint32 dieresis_tables; 119 uint32 tilde_tables; 120 }; 121 122 struct mouse_map { 123 uint32 button[B_MAX_MOUSE_BUTTONS]; 124 }; 125 126 127 /*----------------------------------------------------------------*/ 128 129 enum border_style { 130 B_PLAIN_BORDER, 131 B_FANCY_BORDER, 132 B_NO_BORDER 133 }; 134 135 /*----------------------------------------------------------------*/ 136 137 enum orientation { 138 B_HORIZONTAL, 139 B_VERTICAL 140 }; 141 142 /*----------------------------------------------------------------*/ 143 144 enum button_width { 145 B_WIDTH_AS_USUAL, 146 B_WIDTH_FROM_WIDEST, 147 B_WIDTH_FROM_LABEL 148 }; 149 150 /*----------------------------------------------------------------*/ 151 152 enum join_mode { 153 B_ROUND_JOIN = 0, 154 B_MITER_JOIN, 155 B_BEVEL_JOIN, 156 B_BUTT_JOIN, 157 B_SQUARE_JOIN 158 }; 159 160 enum cap_mode { 161 B_ROUND_CAP=B_ROUND_JOIN, 162 B_BUTT_CAP=B_BUTT_JOIN, 163 B_SQUARE_CAP=B_SQUARE_JOIN 164 }; 165 166 const float B_DEFAULT_MITER_LIMIT = 10.0F; 167 168 /*----------------------------------------------------------------*/ 169 170 struct scroll_bar_info { 171 bool proportional; 172 bool double_arrows; 173 int32 knob; 174 int32 min_knob_size; 175 }; 176 177 /*----------------------------------------------------------------*/ 178 179 enum alignment { 180 B_ALIGN_LEFT, 181 B_ALIGN_RIGHT, 182 B_ALIGN_CENTER, 183 184 B_ALIGN_HORIZONTAL_CENTER = B_ALIGN_CENTER, 185 186 B_ALIGN_HORIZONTAL_UNSET = -1L, 187 B_ALIGN_USE_FULL_WIDTH = -2L 188 }; 189 190 enum vertical_alignment { 191 B_ALIGN_TOP = 0x10L, 192 B_ALIGN_MIDDLE = 0x20, 193 B_ALIGN_BOTTOM = 0x30, 194 195 B_ALIGN_VERTICAL_CENTER = B_ALIGN_MIDDLE, 196 197 B_ALIGN_VERTICAL_UNSET = -1L, 198 B_ALIGN_NO_VERTICAL = B_ALIGN_VERTICAL_UNSET, 199 B_ALIGN_USE_FULL_HEIGHT = -2L 200 }; 201 202 /*----------------------------------------------------------------*/ 203 204 enum { 205 B_CONTROL_TABLE = 0x00000001, 206 B_OPTION_CAPS_SHIFT_TABLE = 0x00000002, 207 B_OPTION_CAPS_TABLE = 0x00000004, 208 B_OPTION_SHIFT_TABLE = 0x00000008, 209 B_OPTION_TABLE = 0x00000010, 210 B_CAPS_SHIFT_TABLE = 0x00000020, 211 B_CAPS_TABLE = 0x00000040, 212 B_SHIFT_TABLE = 0x00000080, 213 B_NORMAL_TABLE = 0x00000100 214 }; 215 216 /*----------------------------------------------------------------*/ 217 218 enum { 219 B_SHIFT_KEY = 0x00000001, 220 B_COMMAND_KEY = 0x00000002, 221 B_CONTROL_KEY = 0x00000004, 222 B_CAPS_LOCK = 0x00000008, 223 B_SCROLL_LOCK = 0x00000010, 224 B_NUM_LOCK = 0x00000020, 225 B_OPTION_KEY = 0x00000040, 226 B_MENU_KEY = 0x00000080, 227 B_LEFT_SHIFT_KEY = 0x00000100, 228 B_RIGHT_SHIFT_KEY = 0x00000200, 229 B_LEFT_COMMAND_KEY = 0x00000400, 230 B_RIGHT_COMMAND_KEY = 0x00000800, 231 B_LEFT_CONTROL_KEY = 0x00001000, 232 B_RIGHT_CONTROL_KEY = 0x00002000, 233 B_LEFT_OPTION_KEY = 0x00004000, 234 B_RIGHT_OPTION_KEY = 0x00008000 235 }; 236 237 /*----------------------------------------------------------------*/ 238 239 enum bitmap_tiling { 240 B_TILE_BITMAP_X = 0x00000001, 241 B_TILE_BITMAP_Y = 0x00000002, 242 B_TILE_BITMAP = 0x00000003 243 }; 244 245 enum overlay_options { 246 B_OVERLAY_FILTER_HORIZONTAL = 0x00010000, 247 B_OVERLAY_FILTER_VERTICAL = 0x00020000, 248 B_OVERLAY_MIRROR = 0x00040000, 249 B_OVERLAY_TRANSFER_CHANNEL = 0x00080000 250 }; 251 252 /*----------------------------------------------------------------*/ 253 254 _IMPEXP_BE status_t get_deskbar_frame(BRect *frame); 255 256 _IMPEXP_BE const color_map *system_colors(); 257 258 _IMPEXP_BE status_t set_screen_space(int32 index, uint32 res, 259 bool stick = true); 260 261 _IMPEXP_BE status_t get_scroll_bar_info(scroll_bar_info *info); 262 _IMPEXP_BE status_t set_scroll_bar_info(scroll_bar_info *info); 263 264 _IMPEXP_BE status_t get_mouse_type(int32 *type); 265 _IMPEXP_BE status_t set_mouse_type(int32 type); 266 _IMPEXP_BE status_t get_mouse_map(mouse_map *map); 267 _IMPEXP_BE status_t set_mouse_map(mouse_map *map); 268 _IMPEXP_BE status_t get_click_speed(bigtime_t *speed); 269 _IMPEXP_BE status_t set_click_speed(bigtime_t speed); 270 _IMPEXP_BE status_t get_mouse_speed(int32 *speed); 271 _IMPEXP_BE status_t set_mouse_speed(int32 speed); 272 _IMPEXP_BE status_t get_mouse_acceleration(int32 *speed); 273 _IMPEXP_BE status_t set_mouse_acceleration(int32 speed); 274 275 _IMPEXP_BE status_t get_key_repeat_rate(int32 *rate); 276 _IMPEXP_BE status_t set_key_repeat_rate(int32 rate); 277 _IMPEXP_BE status_t get_key_repeat_delay(bigtime_t *delay); 278 _IMPEXP_BE status_t set_key_repeat_delay(bigtime_t delay); 279 280 _IMPEXP_BE uint32 modifiers(); 281 _IMPEXP_BE status_t get_key_info(key_info *info); 282 _IMPEXP_BE void get_key_map(key_map **map, char **key_buffer); 283 _IMPEXP_BE status_t get_keyboard_id(uint16 *id); 284 _IMPEXP_BE void set_modifier_key(uint32 modifier, uint32 key); 285 _IMPEXP_BE void set_keyboard_locks(uint32 modifiers); 286 287 _IMPEXP_BE rgb_color keyboard_navigation_color(); 288 289 _IMPEXP_BE int32 count_workspaces(); 290 _IMPEXP_BE void set_workspace_count(int32 count); 291 _IMPEXP_BE int32 current_workspace(); 292 _IMPEXP_BE void activate_workspace(int32 workspace); 293 294 _IMPEXP_BE bigtime_t idle_time(); 295 296 _IMPEXP_BE void run_select_printer_panel(); 297 _IMPEXP_BE void run_add_printer_panel(); 298 _IMPEXP_BE void run_be_about(); 299 300 _IMPEXP_BE void set_focus_follows_mouse(bool follow); 301 _IMPEXP_BE bool focus_follows_mouse(); 302 303 enum mode_mouse { 304 B_NORMAL_MOUSE = 0, 305 B_FOCUS_FOLLOWS_MOUSE = 1, 306 B_WARP_MOUSE = 3, 307 B_INSTANT_WARP_MOUSE = 7 308 }; 309 310 _IMPEXP_BE void set_mouse_mode(mode_mouse mode); 311 _IMPEXP_BE mode_mouse mouse_mode(); 312 313 enum color_which { 314 B_PANEL_BACKGROUND_COLOR = 1, 315 B_PANEL_TEXT_COLOR = 10, 316 B_DOCUMENT_BACKGROUND_COLOR = 11, 317 B_DOCUMENT_TEXT_COLOR = 12, 318 B_CONTROL_BACKGROUND_COLOR = 13, 319 B_CONTROL_TEXT_COLOR = 14, 320 B_CONTROL_BORDER_COLOR = 15, 321 B_CONTROL_HIGHLIGHT_COLOR = 16, 322 B_NAVIGATION_BASE_COLOR = 4, 323 B_NAVIGATION_PULSE_COLOR = 17, 324 B_SHINE_COLOR = 18, 325 B_SHADOW_COLOR = 19, 326 327 B_MENU_BACKGROUND_COLOR = 2, 328 B_MENU_SELECTED_BACKGROUND_COLOR = 6, 329 B_MENU_ITEM_TEXT_COLOR = 7, 330 B_MENU_SELECTED_ITEM_TEXT_COLOR = 8, 331 B_MENU_SELECTED_BORDER_COLOR = 9, 332 333 B_TOOLTIP_BACKGROUND_COLOR = 20, 334 B_TOOLTIP_TEXT_COLOR = 21, 335 336 B_SUCCESS_COLOR = 100, 337 B_FAILURE_COLOR = 101, 338 339 // Old name synonyms. 340 B_KEYBOARD_NAVIGATION_COLOR = B_NAVIGATION_BASE_COLOR, 341 B_MENU_SELECTION_BACKGROUND_COLOR = B_MENU_SELECTED_BACKGROUND_COLOR, 342 343 // These are deprecated -- do not use in new code. See BScreen for 344 // the replacement for B_DESKTOP_COLOR. 345 B_DESKTOP_COLOR = 5, 346 347 B_WINDOW_TAB_COLOR = 3, 348 B_WINDOW_TEXT_COLOR = 22, 349 B_WINDOW_INACTIVE_TAB_COLOR = 23, 350 B_WINDOW_INACTIVE_TEXT_COLOR = 24 351 }; 352 353 _IMPEXP_BE rgb_color ui_color(color_which which); 354 _IMPEXP_BE void set_ui_color(const color_which &which, 355 const rgb_color &color); 356 _IMPEXP_BE rgb_color tint_color(rgb_color color, float tint); 357 358 extern "C" status_t _init_interface_kit_(); 359 /* effects on standard gray level */ 360 const float B_LIGHTEN_MAX_TINT = 0.0F; /* 216 --> 255.0 (255) */ 361 const float B_LIGHTEN_2_TINT = 0.385F; /* 216 --> 240.0 (240) */ 362 const float B_LIGHTEN_1_TINT = 0.590F; /* 216 --> 232.0 (232) */ 363 364 const float B_NO_TINT = 1.0F; /* 216 --> 216.0 (216) */ 365 366 const float B_DARKEN_1_TINT = 1.147F; /* 216 --> 184.2 (184) */ 367 const float B_DARKEN_2_TINT = 1.295F; /* 216 --> 152.3 (152) */ 368 const float B_DARKEN_3_TINT = 1.407F; /* 216 --> 128.1 (128) */ 369 const float B_DARKEN_4_TINT = 1.555F; /* 216 --> 96.1 (96) */ 370 const float B_DARKEN_MAX_TINT = 2.0F; /* 216 --> 0.0 (0) */ 371 372 const float B_DISABLED_LABEL_TINT = B_DARKEN_3_TINT; 373 const float B_HIGHLIGHT_BACKGROUND_TINT = B_DARKEN_2_TINT; 374 const float B_DISABLED_MARK_TINT = B_LIGHTEN_2_TINT; 375 376 #endif // _INTERFACE_DEFS_H 377