Functions related to the help browser. More...
This graph shows which files directly or indirectly include this file:
Functions | |
| void | Button_Help (int) |
| Called to open the help window with the keyboard shortcut. More... | |
| void | Button_Stats (int) |
| Displays and runs the "Statistics" window. More... | |
| void | Window_help (int section, const char *sub_section) |
| Displays and runs the "Help / About..." window. More... | |
| void | Window_set_shortcut (int action_id) |
| Opens a window where you can change a shortcut key(s). More... | |
| short | Print_help (short x_pos, short y_pos, const char *line, char line_type, short link_position, short link_size) |
| Print a line with the 'help' (6x8) font. More... | |
| const char * | Keyboard_shortcut_value (word shortcut_number) |
| void | Remove_duplicate_shortcuts (void) |
| Browse the complete list of shortcuts and ensure that a key only triggers one of them. More... | |
Detailed Description
Functions related to the help browser.
The help data is in helpfile.h
Function Documentation
◆ Button_Help()
| void Button_Help | ( | int | btn | ) |
Called to open the help window with the keyboard shortcut.
If the mouse is over a button, its contextual help will be displayed. Else, the default helpscreen will be shown.
References Button_under_mouse(), Key, NULL, and Window_help().
◆ Button_Stats()
| void Button_Stats | ( | int | btn | ) |
Displays and runs the "Statistics" window.
References BUTTON_HELP, Close_window(), Count_used_colors(), T_Selector_settings::Directory, Display_cursor(), GFX2_DEBUG, GFX2_DiskFreeSpace(), GFX2_Log(), T_Document::image_height, T_Document::image_width, Is_shortcut(), Key, KEY_ESC, KEY_RETURN, Lua_version(), Main, MC_Black, Memory_free(), NULL, Open_window(), Print_in_window(), Print_in_window_limited(), Program_version, Quit_is_required, Screen_height, Screen_width, T_Document::selector, STATS_DATA_COLOR, Stats_pages_memory, Stats_pages_number, STATS_TITLE_COLOR, SVN_revision, TrueType_is_supported(), Unselect_button(), Update_window_area, WIN_HEIGHT, Window_clicked_button(), Window_display_frame_in(), Window_rectangle(), and Window_set_normal_button().
◆ Window_help()
| void Window_help | ( | int | section, |
| const char * | sub_section | ||
| ) |
Displays and runs the "Help / About..." window.
- Parameters
-
section Number of the help section page to display (equals the button number the mouse was hovering for the contextual help), -1 for the main help page. sub_section Help sub-section title (the page will be scrolled so this title is at the top).
References BUTTON_HELP, Close_window(), Compute_slider_cursor_length(), Current_help_section, Display_cursor(), Display_help(), GFX2_DEBUG, GFX2_Log(), Help_position, Help_section, Hide_cursor, Is_shortcut(), Key, KEY_a, KEY_c, KEY_DOWN, KEY_END, KEY_ESC, KEY_h, KEY_HOME, KEY_l, KEY_MOUSEWHEELDOWN, KEY_MOUSEWHEELUP, KEY_PAGEDOWN, KEY_PAGEUP, KEY_RETURN, KEY_UP, T_Help_section::Length, MC_Black, Menu_factor_Y, Mouse_Y, T_Scroller_button::Nb_elements, NULL, Open_window(), T_Scroller_button::Position, Quit_is_required, Scroll_help(), Unselect_button(), Update_window_area, Wait_end_of_click(), Window_attribute2, Window_clicked_button(), Window_display_frame_in(), Window_draw_slider(), Window_help_follow_link(), Window_pos_Y, Window_rectangle(), Window_set_normal_button(), Window_set_scroller_button(), Window_set_shortcut(), and Window_set_special_button().
Referenced by Button_Airbrush_menu(), Button_Anim_time(), Button_Brush_FX(), Button_Colorize_menu(), Button_Constraint_menu(), Button_Copy_page(), Button_Effects(), Button_Gradients(), Button_Grid_menu(), Button_Help(), Button_Layer_menu(), Button_Load_or_Save(), Button_Paintbrush_menu(), Button_Palette(), Button_Quick_shade_menu(), Button_Quit_local_function(), Button_Resolution(), Button_Secondary_palette(), Button_Settings(), Button_Sieve_menu(), Button_Skins(), Button_Smooth_menu(), Button_Text(), Button_Tilemap_menu(), Button_Tiling_menu(), Button_Transform_menu(), Menu_shade(), Menu_tag_colors(), Save_C64_window(), and Save_MOTO_window().
◆ Window_set_shortcut()
| void Window_set_shortcut | ( | int | action_id | ) |
Opens a window where you can change a shortcut key(s).
References T_Config::Allow_multi_shortcuts, Close_window(), Config, ConfigKey, Display_cursor(), Error, Hide_cursor, Key, T_Key_config::Key, T_Key_config::Key2, KEY_ESC, Key_name(), KEY_NONE, KEY_RETURN, MC_Black, MC_Light, MC_White, NB_SHORTCUTS, NULL, Open_window(), Ordering, Print_in_window(), Print_in_window_limited(), Redefine_control(), Shortcut(), Update_window_area, Window_clicked_button(), Window_display_frame_in(), Window_rectangle(), and Window_set_normal_button().
Referenced by Window_help().
◆ Print_help()
| short Print_help | ( | short | x_pos, |
| short | y_pos, | ||
| const char * | line, | ||
| char | line_type, | ||
| short | link_position, | ||
| short | link_size | ||
| ) |
Print a line with the 'help' (6x8) font.
References T_Gui_skin::Bold_font, Display_line_fast, Gfx, T_Gui_skin::Help_font_norm, T_Gui_skin::Help_font_t1, T_Gui_skin::Help_font_t2, T_Gui_skin::Help_font_t3, T_Gui_skin::Help_font_t4, Horizontal_line_buffer, MC_Dark, MC_Light, MC_White, Menu_factor_X, Menu_factor_Y, Pixel_width, ToWinX, and ToWinY.
Referenced by Display_help().
◆ Keyboard_shortcut_value()
| const char * Keyboard_shortcut_value | ( | word | shortcut_number | ) |
References Key_name(), NULL, and Shortcut().
Referenced by Display_help().
◆ Remove_duplicate_shortcuts()
| void Remove_duplicate_shortcuts | ( | void | ) |
Browse the complete list of shortcuts and ensure that a key only triggers one of them.
References NB_SHORTCUTS, Ordering, and Shortcut().
Referenced by Button_Settings(), and Init_program().
