1 /* 2 * Copyright (c) 2001-2008, 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 B_KATAKANA_HIRAGANA = 0xf2, 68 B_ZENKAKU_HANKAKU = 0xf3 69 }; 70 71 enum { 72 B_F1_KEY = 0x02, 73 B_F2_KEY = 0x03, 74 B_F3_KEY = 0x04, 75 B_F4_KEY = 0x05, 76 B_F5_KEY = 0x06, 77 B_F6_KEY = 0x07, 78 B_F7_KEY = 0x08, 79 B_F8_KEY = 0x09, 80 B_F9_KEY = 0x0a, 81 B_F10_KEY = 0x0b, 82 B_F11_KEY = 0x0c, 83 B_F12_KEY = 0x0d, 84 B_PRINT_KEY = 0x0e, 85 B_SCROLL_KEY = 0x0f, 86 B_PAUSE_KEY = 0x10 87 }; 88 89 struct key_map { 90 uint32 version; 91 uint32 caps_key; 92 uint32 scroll_key; 93 uint32 num_key; 94 uint32 left_shift_key; 95 uint32 right_shift_key; 96 uint32 left_command_key; 97 uint32 right_command_key; 98 uint32 left_control_key; 99 uint32 right_control_key; 100 uint32 left_option_key; 101 uint32 right_option_key; 102 uint32 menu_key; 103 uint32 lock_settings; 104 int32 control_map[128]; 105 int32 option_caps_shift_map[128]; 106 int32 option_caps_map[128]; 107 int32 option_shift_map[128]; 108 int32 option_map[128]; 109 int32 caps_shift_map[128]; 110 int32 caps_map[128]; 111 int32 shift_map[128]; 112 int32 normal_map[128]; 113 int32 acute_dead_key[32]; 114 int32 grave_dead_key[32]; 115 int32 circumflex_dead_key[32]; 116 int32 dieresis_dead_key[32]; 117 int32 tilde_dead_key[32]; 118 uint32 acute_tables; 119 uint32 grave_tables; 120 uint32 circumflex_tables; 121 uint32 dieresis_tables; 122 uint32 tilde_tables; 123 }; 124 125 enum { 126 B_CONTROL_TABLE = 0x00000001, 127 B_OPTION_CAPS_SHIFT_TABLE = 0x00000002, 128 B_OPTION_CAPS_TABLE = 0x00000004, 129 B_OPTION_SHIFT_TABLE = 0x00000008, 130 B_OPTION_TABLE = 0x00000010, 131 B_CAPS_SHIFT_TABLE = 0x00000020, 132 B_CAPS_TABLE = 0x00000040, 133 B_SHIFT_TABLE = 0x00000080, 134 B_NORMAL_TABLE = 0x00000100 135 }; 136 137 // modifiers 138 enum { 139 B_SHIFT_KEY = 0x00000001, 140 B_COMMAND_KEY = 0x00000002, 141 B_CONTROL_KEY = 0x00000004, 142 B_CAPS_LOCK = 0x00000008, 143 B_SCROLL_LOCK = 0x00000010, 144 B_NUM_LOCK = 0x00000020, 145 B_OPTION_KEY = 0x00000040, 146 B_MENU_KEY = 0x00000080, 147 B_LEFT_SHIFT_KEY = 0x00000100, 148 B_RIGHT_SHIFT_KEY = 0x00000200, 149 B_LEFT_COMMAND_KEY = 0x00000400, 150 B_RIGHT_COMMAND_KEY = 0x00000800, 151 B_LEFT_CONTROL_KEY = 0x00001000, 152 B_RIGHT_CONTROL_KEY = 0x00002000, 153 B_LEFT_OPTION_KEY = 0x00004000, 154 B_RIGHT_OPTION_KEY = 0x00008000 155 }; 156 157 158 // Mouse definitions 159 160 struct mouse_map { 161 uint32 button[B_MAX_MOUSE_BUTTONS]; 162 }; 163 164 enum mode_mouse { 165 B_NORMAL_MOUSE = 0, 166 B_FOCUS_FOLLOWS_MOUSE = 1, 167 B_WARP_MOUSE = 3, 168 B_INSTANT_WARP_MOUSE = 7 169 }; 170 171 172 // View orientation/alignment/style 173 174 enum border_style { 175 B_PLAIN_BORDER, 176 B_FANCY_BORDER, 177 B_NO_BORDER 178 }; 179 180 enum orientation { 181 B_HORIZONTAL, 182 B_VERTICAL 183 }; 184 185 enum button_width { 186 B_WIDTH_AS_USUAL, 187 B_WIDTH_FROM_WIDEST, 188 B_WIDTH_FROM_LABEL 189 }; 190 191 struct scroll_bar_info { 192 bool proportional; 193 bool double_arrows; 194 int32 knob; 195 int32 min_knob_size; 196 }; 197 198 enum alignment { 199 B_ALIGN_LEFT, 200 B_ALIGN_RIGHT, 201 B_ALIGN_CENTER, 202 203 B_ALIGN_HORIZONTAL_CENTER = B_ALIGN_CENTER, 204 205 B_ALIGN_HORIZONTAL_UNSET = -1L, 206 B_ALIGN_USE_FULL_WIDTH = -2L 207 }; 208 209 enum vertical_alignment { 210 B_ALIGN_TOP = 0x10L, 211 B_ALIGN_MIDDLE = 0x20, 212 B_ALIGN_BOTTOM = 0x30, 213 214 B_ALIGN_VERTICAL_CENTER = B_ALIGN_MIDDLE, 215 216 B_ALIGN_VERTICAL_UNSET = -1L, 217 B_ALIGN_NO_VERTICAL = B_ALIGN_VERTICAL_UNSET, 218 B_ALIGN_USE_FULL_HEIGHT = -2L 219 }; 220 221 222 // Line join and cap modes 223 224 enum join_mode { 225 B_ROUND_JOIN = 0, 226 B_MITER_JOIN, 227 B_BEVEL_JOIN, 228 B_BUTT_JOIN, 229 B_SQUARE_JOIN 230 }; 231 232 enum cap_mode { 233 B_ROUND_CAP = B_ROUND_JOIN, 234 B_BUTT_CAP = B_BUTT_JOIN, 235 B_SQUARE_CAP = B_SQUARE_JOIN 236 }; 237 238 const float B_DEFAULT_MITER_LIMIT = 10.0F; 239 240 241 // Bitmap and overlay constants 242 243 enum bitmap_tiling { 244 B_TILE_BITMAP_X = 0x00000001, 245 B_TILE_BITMAP_Y = 0x00000002, 246 B_TILE_BITMAP = 0x00000003 247 }; 248 249 enum overlay_options { 250 B_OVERLAY_FILTER_HORIZONTAL = 0x00010000, 251 B_OVERLAY_FILTER_VERTICAL = 0x00020000, 252 B_OVERLAY_MIRROR = 0x00040000, 253 B_OVERLAY_TRANSFER_CHANNEL = 0x00080000 254 }; 255 256 enum bitmap_filtering { 257 B_FILTER_BITMAP_BILINEAR = 0x00000100 258 // TODO: Make this simply "SMOOTH_SCALE" and use 259 // better quality methods the faster the computer? 260 }; 261 262 // Default UI Colors 263 264 enum color_which { 265 B_PANEL_BACKGROUND_COLOR = 1, 266 B_PANEL_TEXT_COLOR = 10, 267 B_DOCUMENT_BACKGROUND_COLOR = 11, 268 B_DOCUMENT_TEXT_COLOR = 12, 269 B_CONTROL_BACKGROUND_COLOR = 13, 270 B_CONTROL_TEXT_COLOR = 14, 271 B_CONTROL_BORDER_COLOR = 15, 272 B_CONTROL_HIGHLIGHT_COLOR = 16, 273 B_NAVIGATION_BASE_COLOR = 4, 274 B_NAVIGATION_PULSE_COLOR = 17, 275 B_SHINE_COLOR = 18, 276 B_SHADOW_COLOR = 19, 277 278 B_MENU_BACKGROUND_COLOR = 2, 279 B_MENU_SELECTED_BACKGROUND_COLOR = 6, 280 B_MENU_ITEM_TEXT_COLOR = 7, 281 B_MENU_SELECTED_ITEM_TEXT_COLOR = 8, 282 B_MENU_SELECTED_BORDER_COLOR = 9, 283 284 B_TOOLTIP_BACKGROUND_COLOR = 20, 285 B_TOOLTIP_TEXT_COLOR = 21, 286 287 B_SUCCESS_COLOR = 100, 288 B_FAILURE_COLOR = 101, 289 290 // Old name synonyms. 291 B_KEYBOARD_NAVIGATION_COLOR = B_NAVIGATION_BASE_COLOR, 292 B_MENU_SELECTION_BACKGROUND_COLOR = B_MENU_SELECTED_BACKGROUND_COLOR, 293 294 // These are deprecated -- do not use in new code. See BScreen for 295 // the replacement for B_DESKTOP_COLOR. 296 B_DESKTOP_COLOR = 5, 297 298 B_WINDOW_TAB_COLOR = 3, 299 B_WINDOW_TEXT_COLOR = 22, 300 B_WINDOW_INACTIVE_TAB_COLOR = 23, 301 B_WINDOW_INACTIVE_TEXT_COLOR = 24 302 }; 303 304 305 // Color tinting 306 307 const float B_LIGHTEN_MAX_TINT = 0.0f; // 216 --> 255.0 (255) 308 const float B_LIGHTEN_2_TINT = 0.385f; // 216 --> 240.0 (240) 309 const float B_LIGHTEN_1_TINT = 0.590f; // 216 --> 232.0 (232) 310 311 const float B_NO_TINT = 1.0f; // 216 --> 216.0 (216) 312 313 const float B_DARKEN_1_TINT = 1.147f; // 216 --> 184.2 (184) 314 const float B_DARKEN_2_TINT = 1.295f; // 216 --> 152.3 (152) 315 const float B_DARKEN_3_TINT = 1.407f; // 216 --> 128.1 (128) 316 const float B_DARKEN_4_TINT = 1.555f; // 216 --> 96.1 (96) 317 const float B_DARKEN_MAX_TINT = 2.0f; // 216 --> 0.0 (0) 318 // effects on standard gray level 319 320 const float B_DISABLED_LABEL_TINT = B_DARKEN_3_TINT; 321 const float B_HIGHLIGHT_BACKGROUND_TINT = B_DARKEN_2_TINT; 322 const float B_DISABLED_MARK_TINT = B_LIGHTEN_2_TINT; 323 324 325 status_t get_deskbar_frame(BRect* frame); 326 327 const color_map* system_colors(); 328 329 status_t set_screen_space(int32 index, uint32 resolution, 330 bool save = true); 331 332 status_t get_scroll_bar_info(scroll_bar_info* info); 333 status_t set_scroll_bar_info(scroll_bar_info* info); 334 335 status_t get_mouse_type(int32* type); 336 status_t set_mouse_type(int32 type); 337 status_t get_mouse_map(mouse_map* map); 338 status_t set_mouse_map(mouse_map* map); 339 status_t get_click_speed(bigtime_t* speed); 340 status_t set_click_speed(bigtime_t speed); 341 status_t get_mouse_speed(int32* speed); 342 status_t set_mouse_speed(int32 speed); 343 status_t get_mouse_acceleration(int32* speed); 344 status_t set_mouse_acceleration(int32 speed); 345 346 status_t get_key_repeat_rate(int32* rate); 347 status_t set_key_repeat_rate(int32 rate); 348 status_t get_key_repeat_delay(bigtime_t* delay); 349 status_t set_key_repeat_delay(bigtime_t delay); 350 351 uint32 modifiers(); 352 status_t get_key_info(key_info* info); 353 void get_key_map(key_map** _map, char** _keyBuffer); 354 status_t get_keyboard_id(uint16* _id); 355 status_t get_modifier_key(uint32 modifier, uint32 *key); 356 void set_modifier_key(uint32 modifier, uint32 key); 357 void set_keyboard_locks(uint32 modifiers); 358 359 rgb_color keyboard_navigation_color(); 360 361 int32 count_workspaces(); 362 void set_workspace_count(int32 count); 363 int32 current_workspace(); 364 void activate_workspace(int32 workspace); 365 366 bigtime_t idle_time(); 367 368 void run_select_printer_panel(); 369 void run_add_printer_panel(); 370 void run_be_about(); 371 372 void set_focus_follows_mouse(bool follow); 373 bool focus_follows_mouse(); 374 375 void set_mouse_mode(mode_mouse mode); 376 mode_mouse mouse_mode(); 377 378 rgb_color ui_color(color_which which); 379 void set_ui_color(const color_which& which, const rgb_color& color); 380 rgb_color tint_color(rgb_color color, float tint); 381 382 extern "C" status_t _init_interface_kit_(); 383 // for convenience, should be removed including the friend declarations 384 // in Menu.h, ... 385 386 #endif // _INTERFACE_DEFS_H 387