wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/INSTALL.md +35 -29
- data/README.md +24 -15
- data/ext/wxbase32u_gcc_custom.dll +0 -0
- data/ext/wxbase32u_net_gcc_custom.dll +0 -0
- data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
- data/lib/wx/core/bitmap_combobox.rb +17 -21
- data/lib/wx/core/combobox.rb +13 -3
- data/lib/wx/core/controlwithitems.rb +40 -130
- data/lib/wx/core/enum.rb +17 -1
- data/lib/wx/core/event.rb +6 -1
- data/lib/wx/core/events/evt_list.rb +5 -4
- data/lib/wx/core/evthandler.rb +8 -2
- data/lib/wx/core/generic_validator.rb +312 -0
- data/lib/wx/core/listbox.rb +2 -2
- data/lib/wx/core/log.rb +1 -1
- data/lib/wx/core/owner_drawn_combobox.rb +45 -0
- data/lib/wx/core/size.rb +4 -0
- data/lib/wx/core/sizer.rb +1 -2
- data/lib/wx/core/standard_paths.rb +22 -0
- data/lib/wx/core/text_entry.rb +4 -1
- data/lib/wx/core/validator.rb +70 -5
- data/lib/wx/core/window.rb +3 -7
- data/lib/wx/doc/art_locator.rb +1 -0
- data/lib/wx/doc/comboctrl.rb +18 -0
- data/lib/wx/doc/controlwithitems.rb +16 -0
- data/lib/wx/doc/date_picker_ctrl.rb +23 -0
- data/lib/wx/doc/editable_listbox.rb +44 -0
- data/lib/wx/doc/enum.rb +15 -0
- data/lib/wx/doc/event.rb +12 -0
- data/lib/wx/doc/extra/12_client_data.md +89 -0
- data/lib/wx/doc/extra/13_validators.md +139 -0
- data/lib/wx/doc/gdi_common.rb +4 -0
- data/lib/wx/doc/gen/about_dialog_info.rb +25 -0
- data/lib/wx/doc/gen/accelerator.rb +7 -1
- data/lib/wx/doc/gen/accessible.rb +13 -0
- data/lib/wx/doc/gen/activity_indicator.rb +7 -0
- data/lib/wx/doc/gen/animation.rb +12 -0
- data/lib/wx/doc/gen/animation_ctrl.rb +10 -0
- data/lib/wx/doc/gen/any_button.rb +17 -1
- data/lib/wx/doc/gen/app.rb +35 -1
- data/lib/wx/doc/gen/app_traits.rb +38 -5
- data/lib/wx/doc/gen/art_provider.rb +14 -0
- data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -0
- data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
- data/lib/wx/doc/gen/aui/aui_manager.rb +24 -1
- data/lib/wx/doc/gen/aui/aui_manager_event.rb +9 -1
- data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +3 -0
- data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +2 -0
- data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +3 -1
- data/lib/wx/doc/gen/aui/aui_notebook.rb +20 -2
- data/lib/wx/doc/gen/aui/aui_notebook_event.rb +2 -1
- data/lib/wx/doc/gen/aui/aui_pane_info.rb +30 -1
- data/lib/wx/doc/gen/aui/aui_tab_art.rb +6 -0
- data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +1 -0
- data/lib/wx/doc/gen/aui/aui_tool_bar.rb +11 -0
- data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -0
- data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +2 -1
- data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +4 -0
- data/lib/wx/doc/gen/banner_window.rb +7 -0
- data/lib/wx/doc/gen/bitmap.rb +64 -3
- data/lib/wx/doc/gen/bitmap_button.rb +6 -1
- data/lib/wx/doc/gen/bitmap_combo_box.rb +9 -3
- data/lib/wx/doc/gen/book_ctrl_base.rb +17 -2
- data/lib/wx/doc/gen/book_ctrl_event.rb +3 -1
- data/lib/wx/doc/gen/box_sizer.rb +5 -0
- data/lib/wx/doc/gen/brush.rb +16 -1
- data/lib/wx/doc/gen/busy_info.rb +8 -0
- data/lib/wx/doc/gen/button.rb +11 -3
- data/lib/wx/doc/gen/calculate_layout_event.rb +4 -0
- data/lib/wx/doc/gen/calendar_ctrl.rb +22 -0
- data/lib/wx/doc/gen/calendar_date_attr.rb +1 -0
- data/lib/wx/doc/gen/calendar_event.rb +3 -1
- data/lib/wx/doc/gen/caret.rb +3 -0
- data/lib/wx/doc/gen/check_box.rb +10 -0
- data/lib/wx/doc/gen/check_list_box.rb +3 -0
- data/lib/wx/doc/gen/choice.rb +14 -2
- data/lib/wx/doc/gen/choicebook.rb +1 -0
- data/lib/wx/doc/gen/client_dc.rb +1 -0
- data/lib/wx/doc/gen/clipboard.rb +9 -0
- data/lib/wx/doc/gen/collapsible_pane.rb +3 -0
- data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -0
- data/lib/wx/doc/gen/colour.rb +20 -0
- data/lib/wx/doc/gen/colour_dialog.rb +10 -0
- data/lib/wx/doc/gen/colour_picker_ctrl.rb +4 -0
- data/lib/wx/doc/gen/colour_picker_event.rb +1 -0
- data/lib/wx/doc/gen/combo_box.rb +20 -1
- data/lib/wx/doc/gen/combo_ctrl.rb +54 -295
- data/lib/wx/doc/gen/command_link_button.rb +8 -0
- data/lib/wx/doc/gen/context_help_button.rb +7 -1
- data/lib/wx/doc/gen/control.rb +12 -0
- data/lib/wx/doc/gen/control_with_items.rb +45 -9
- data/lib/wx/doc/gen/core.rb +2 -2
- data/lib/wx/doc/gen/cursor.rb +4 -0
- data/lib/wx/doc/gen/data_format.rb +1 -0
- data/lib/wx/doc/gen/data_object.rb +27 -5
- data/lib/wx/doc/gen/date_event.rb +2 -1
- data/lib/wx/doc/gen/date_picker_ctrl.rb +7 -1
- data/lib/wx/doc/gen/dc.rb +87 -3
- data/lib/wx/doc/gen/dial_up_event.rb +2 -0
- data/lib/wx/doc/gen/dial_up_manager.rb +12 -0
- data/lib/wx/doc/gen/dialog.rb +42 -3
- data/lib/wx/doc/gen/dir_dialog.rb +6 -1
- data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
- data/lib/wx/doc/gen/dir_picker_ctrl.rb +5 -0
- data/lib/wx/doc/gen/drag_drop.rb +20 -0
- data/lib/wx/doc/gen/drag_image.rb +7 -0
- data/lib/wx/doc/gen/editable_list_box.rb +5 -3
- data/lib/wx/doc/gen/event.rb +26 -11
- data/lib/wx/doc/gen/event_blocker.rb +2 -1
- data/lib/wx/doc/gen/event_filter.rb +3 -0
- data/lib/wx/doc/gen/event_list.rb +4 -4
- data/lib/wx/doc/gen/events.rb +165 -26
- data/lib/wx/doc/gen/evt_handler.rb +40 -2
- data/lib/wx/doc/gen/ext_help_controller.rb +9 -0
- data/lib/wx/doc/gen/file_ctrl.rb +11 -2
- data/lib/wx/doc/gen/file_ctrl_event.rb +5 -1
- data/lib/wx/doc/gen/file_dialog.rb +13 -0
- data/lib/wx/doc/gen/file_dialog_custom_control.rb +12 -0
- data/lib/wx/doc/gen/file_dialog_customize_hook.rb +9 -0
- data/lib/wx/doc/gen/file_dir_picker_event.rb +2 -1
- data/lib/wx/doc/gen/file_picker_ctrl.rb +4 -0
- data/lib/wx/doc/gen/file_system.rb +17 -1
- data/lib/wx/doc/gen/find_dialog_event.rb +2 -1
- data/lib/wx/doc/gen/find_replace_data.rb +1 -0
- data/lib/wx/doc/gen/find_replace_dialog.rb +3 -0
- data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -0
- data/lib/wx/doc/gen/font.rb +75 -3
- data/lib/wx/doc/gen/font_data.rb +14 -0
- data/lib/wx/doc/gen/font_dialog.rb +6 -0
- data/lib/wx/doc/gen/font_picker_ctrl.rb +8 -0
- data/lib/wx/doc/gen/font_picker_event.rb +1 -0
- data/lib/wx/doc/gen/frame.rb +24 -7
- data/lib/wx/doc/gen/fs_file.rb +22 -0
- data/lib/wx/doc/gen/gauge.rb +8 -0
- data/lib/wx/doc/gen/gb_sizer_item.rb +5 -0
- data/lib/wx/doc/gen/gcdc.rb +2 -0
- data/lib/wx/doc/gen/gdi_common.rb +50 -0
- data/lib/wx/doc/gen/gdi_object.rb +1 -0
- data/lib/wx/doc/gen/generic_dir_ctrl.rb +7 -0
- data/lib/wx/doc/gen/graphics_context.rb +36 -7
- data/lib/wx/doc/gen/graphics_object.rb +24 -0
- data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_attr.rb +14 -2
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_editor.rb +9 -0
- data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +6 -0
- data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_ctrl.rb +229 -7
- data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +4 -1
- data/lib/wx/doc/gen/grid/grid_event.rb +4 -1
- data/lib/wx/doc/gen/grid/grid_range_select_event.rb +2 -1
- data/lib/wx/doc/gen/grid/grid_size_event.rb +2 -1
- data/lib/wx/doc/gen/grid/grid_string_table.rb +7 -0
- data/lib/wx/doc/gen/grid/grid_table_base.rb +27 -1
- data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
- data/lib/wx/doc/gen/grid_bag_sizer.rb +24 -4
- data/lib/wx/doc/gen/grid_sizer.rb +11 -0
- data/lib/wx/doc/gen/gui_event_loop.rb +12 -0
- data/lib/wx/doc/gen/header_ctrl.rb +106 -0
- data/lib/wx/doc/gen/header_ctrl_event.rb +5 -1
- data/lib/wx/doc/gen/help_controller.rb +11 -0
- data/lib/wx/doc/gen/help_provider.rb +12 -3
- data/lib/wx/doc/gen/html/html_cell.rb +25 -0
- data/lib/wx/doc/gen/html/html_cell_event.rb +3 -1
- data/lib/wx/doc/gen/html/html_easy_printing.rb +13 -1
- data/lib/wx/doc/gen/html/html_help_controller.rb +18 -0
- data/lib/wx/doc/gen/html/html_help_data.rb +5 -0
- data/lib/wx/doc/gen/html/html_help_window.rb +8 -0
- data/lib/wx/doc/gen/html/html_link_event.rb +1 -0
- data/lib/wx/doc/gen/html/html_list_box.rb +49 -9
- data/lib/wx/doc/gen/html/html_printout.rb +7 -0
- data/lib/wx/doc/gen/html/html_window.rb +31 -0
- data/lib/wx/doc/gen/hyperlink_ctrl.rb +2 -1
- data/lib/wx/doc/gen/hyperlink_event.rb +1 -0
- data/lib/wx/doc/gen/icon.rb +19 -1
- data/lib/wx/doc/gen/icon_location.rb +1 -0
- data/lib/wx/doc/gen/image.rb +67 -10
- data/lib/wx/doc/gen/image_list.rb +12 -2
- data/lib/wx/doc/gen/info_bar.rb +12 -0
- data/lib/wx/doc/gen/keyboard_state.rb +11 -0
- data/lib/wx/doc/gen/list_box.rb +20 -3
- data/lib/wx/doc/gen/list_ctrl.rb +89 -0
- data/lib/wx/doc/gen/list_event.rb +11 -1
- data/lib/wx/doc/gen/listbook.rb +1 -0
- data/lib/wx/doc/gen/locale.rb +22 -0
- data/lib/wx/doc/gen/log.rb +42 -0
- data/lib/wx/doc/gen/mdi_client_window.rb +4 -1
- data/lib/wx/doc/gen/mdi_frame.rb +27 -4
- data/lib/wx/doc/gen/media_ctrl.rb +17 -0
- data/lib/wx/doc/gen/media_event.rb +2 -1
- data/lib/wx/doc/gen/memory_dc.rb +10 -0
- data/lib/wx/doc/gen/menu.rb +48 -7
- data/lib/wx/doc/gen/menu_bar.rb +32 -13
- data/lib/wx/doc/gen/menu_item.rb +26 -0
- data/lib/wx/doc/gen/message_dialog.rb +10 -0
- data/lib/wx/doc/gen/mini_frame.rb +5 -2
- data/lib/wx/doc/gen/mirror_dc.rb +1 -0
- data/lib/wx/doc/gen/mouse_state.rb +1 -0
- data/lib/wx/doc/gen/multi_choice_dialog.rb +3 -1
- data/lib/wx/doc/gen/non_owned_window.rb +3 -0
- data/lib/wx/doc/gen/notebook.rb +11 -1
- data/lib/wx/doc/gen/num_validator.rb +37 -0
- data/lib/wx/doc/gen/number_entry_dialog.rb +4 -0
- data/lib/wx/doc/gen/object.rb +3 -0
- data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
- data/lib/wx/doc/gen/paint_dc.rb +1 -0
- data/lib/wx/doc/gen/palette.rb +5 -0
- data/lib/wx/doc/gen/panel.rb +10 -2
- data/lib/wx/doc/gen/pen.rb +30 -1
- data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -1
- data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +4 -1
- data/lib/wx/doc/gen/pg/pg_cell.rb +6 -1
- data/lib/wx/doc/gen/pg/pg_editor.rb +61 -15
- data/lib/wx/doc/gen/pg/pg_multi_button.rb +2 -0
- data/lib/wx/doc/gen/pg/pg_properties.rb +198 -81
- data/lib/wx/doc/gen/pg/pg_property.rb +129 -52
- data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
- data/lib/wx/doc/gen/pg/property_grid.rb +56 -14
- data/lib/wx/doc/gen/pg/property_grid_event.rb +16 -6
- data/lib/wx/doc/gen/pg/property_grid_interface.rb +98 -37
- data/lib/wx/doc/gen/pg/property_grid_manager.rb +29 -7
- data/lib/wx/doc/gen/pg/property_grid_page.rb +11 -4
- data/lib/wx/doc/gen/pg/property_grid_page_state.rb +7 -2
- data/lib/wx/doc/gen/picker_base.rb +11 -1
- data/lib/wx/doc/gen/platform_info.rb +31 -0
- data/lib/wx/doc/gen/popup_window.rb +5 -0
- data/lib/wx/doc/gen/progress_dialog.rb +4 -0
- data/lib/wx/doc/gen/property_sheet_dialog.rb +7 -1
- data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -0
- data/lib/wx/doc/gen/prt/post_script_dc.rb +1 -0
- data/lib/wx/doc/gen/prt/preview_frame.rb +4 -0
- data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -0
- data/lib/wx/doc/gen/prt/print_data.rb +27 -0
- data/lib/wx/doc/gen/prt/print_dialog.rb +4 -0
- data/lib/wx/doc/gen/prt/printer.rb +42 -5
- data/lib/wx/doc/gen/prt/printer_dc.rb +2 -0
- data/lib/wx/doc/gen/query_layout_info_event.rb +9 -0
- data/lib/wx/doc/gen/radio_box.rb +19 -0
- data/lib/wx/doc/gen/radio_button.rb +9 -0
- data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +63 -0
- data/lib/wx/doc/gen/rbn/ribbon_bar.rb +23 -0
- data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -1
- data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +35 -9
- data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -1
- data/lib/wx/doc/gen/rbn/ribbon_control.rb +10 -0
- data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +17 -7
- data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -1
- data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -0
- data/lib/wx/doc/gen/rbn/ribbon_panel.rb +11 -0
- data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -1
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +25 -0
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
- data/lib/wx/doc/gen/rearrange_ctrl.rb +4 -0
- data/lib/wx/doc/gen/rearrange_list.rb +9 -0
- data/lib/wx/doc/gen/region.rb +42 -13
- data/lib/wx/doc/gen/region_iterator.rb +1 -0
- data/lib/wx/doc/gen/rtc/rich_text_box.rb +25 -8
- data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +41 -4
- data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -0
- data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -11
- data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +74 -0
- data/lib/wx/doc/gen/rtc/rich_text_event.rb +6 -1
- data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -0
- data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +6 -0
- data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +1 -0
- data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +4 -0
- data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -0
- data/lib/wx/doc/gen/rtc/rich_text_object.rb +64 -4
- data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +51 -4
- data/lib/wx/doc/gen/rtc/rich_text_printing.rb +13 -0
- data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +9 -4
- data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +3 -0
- data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +2 -0
- data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +1 -0
- data/lib/wx/doc/gen/sash_event.rb +5 -1
- data/lib/wx/doc/gen/sash_layout_window.rb +10 -0
- data/lib/wx/doc/gen/sash_window.rb +3 -0
- data/lib/wx/doc/gen/screen_dc.rb +1 -0
- data/lib/wx/doc/gen/scroll_bar.rb +11 -2
- data/lib/wx/doc/gen/scrolled_canvas.rb +20 -4
- data/lib/wx/doc/gen/scrolled_control.rb +20 -4
- data/lib/wx/doc/gen/scrolled_window.rb +20 -4
- data/lib/wx/doc/gen/search_ctrl.rb +6 -0
- data/lib/wx/doc/gen/simplebook.rb +7 -0
- data/lib/wx/doc/gen/single_choice_dialog.rb +3 -1
- data/lib/wx/doc/gen/sizer.rb +79 -9
- data/lib/wx/doc/gen/sizer_item.rb +16 -2
- data/lib/wx/doc/gen/slider.rb +23 -0
- data/lib/wx/doc/gen/spin_button.rb +9 -0
- data/lib/wx/doc/gen/spin_ctrl.rb +11 -0
- data/lib/wx/doc/gen/spin_ctrl_double.rb +7 -0
- data/lib/wx/doc/gen/spin_double_event.rb +4 -1
- data/lib/wx/doc/gen/spin_event.rb +2 -1
- data/lib/wx/doc/gen/splash_screen.rb +2 -0
- data/lib/wx/doc/gen/splitter_event.rb +10 -1
- data/lib/wx/doc/gen/splitter_window.rb +38 -14
- data/lib/wx/doc/gen/static_bitmap.rb +99 -2
- data/lib/wx/doc/gen/static_box.rb +6 -0
- data/lib/wx/doc/gen/static_box_sizer.rb +3 -0
- data/lib/wx/doc/gen/static_line.rb +4 -0
- data/lib/wx/doc/gen/static_text.rb +5 -0
- data/lib/wx/doc/gen/status_bar.rb +17 -3
- data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +174 -6
- data/lib/wx/doc/gen/stc/styled_text_event.rb +27 -1
- data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -0
- data/lib/wx/doc/gen/svg_file_dc.rb +9 -0
- data/lib/wx/doc/gen/system_options.rb +8 -0
- data/lib/wx/doc/gen/system_settings.rb +7 -0
- data/lib/wx/doc/gen/task_bar_button.rb +12 -0
- data/lib/wx/doc/gen/task_bar_icon.rb +5 -0
- data/lib/wx/doc/gen/task_bar_icon_event.rb +2 -1
- data/lib/wx/doc/gen/text_attr.rb +27 -0
- data/lib/wx/doc/gen/text_ctrl.rb +27 -3
- data/lib/wx/doc/gen/text_entry.rb +43 -5
- data/lib/wx/doc/gen/text_entry_dialog.rb +12 -0
- data/lib/wx/doc/gen/text_validator.rb +16 -0
- data/lib/wx/doc/gen/time_picker_ctrl.rb +6 -0
- data/lib/wx/doc/gen/timer.rb +8 -0
- data/lib/wx/doc/gen/timer_event.rb +1 -0
- data/lib/wx/doc/gen/tip_provider.rb +5 -0
- data/lib/wx/doc/gen/toggle_button.rb +68 -0
- data/lib/wx/doc/gen/tool_bar.rb +57 -14
- data/lib/wx/doc/gen/tool_tip.rb +6 -0
- data/lib/wx/doc/gen/toolbook.rb +3 -0
- data/lib/wx/doc/gen/top_level_window.rb +34 -3
- data/lib/wx/doc/gen/tree_ctrl.rb +49 -0
- data/lib/wx/doc/gen/tree_event.rb +7 -1
- data/lib/wx/doc/gen/treebook.rb +9 -0
- data/lib/wx/doc/gen/ui_action_simulator.rb +4 -0
- data/lib/wx/doc/gen/utils.rb +55 -0
- data/lib/wx/doc/gen/v_list_box.rb +21 -0
- data/lib/wx/doc/gen/v_scrolled_window.rb +15 -0
- data/lib/wx/doc/gen/validator.rb +9 -13
- data/lib/wx/doc/gen/variant.rb +6 -0
- data/lib/wx/doc/gen/window.rb +260 -52
- data/lib/wx/doc/gen/window_dc.rb +2 -0
- data/lib/wx/doc/gen/window_disabler.rb +1 -0
- data/lib/wx/doc/gen/with_images.rb +7 -1
- data/lib/wx/doc/gen/wizard.rb +18 -0
- data/lib/wx/doc/gen/wizard_event.rb +3 -1
- data/lib/wx/doc/gen/wizard_page.rb +5 -0
- data/lib/wx/doc/gen/wizard_page_simple.rb +4 -0
- data/lib/wx/doc/gen/wrap_sizer.rb +5 -0
- data/lib/wx/doc/gen/xml_node.rb +14 -0
- data/lib/wx/doc/gen/xml_resource.rb +22 -0
- data/lib/wx/doc/generic_validator.rb +95 -0
- data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
- data/lib/wx/doc/num_validator.rb +387 -0
- data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
- data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
- data/lib/wx/doc/static_bitmap.rb +25 -0
- data/lib/wx/doc/text_validator.rb +10 -0
- data/lib/wx/doc/validator.rb +113 -0
- data/lib/wx/doc/window.rb +30 -0
- data/lib/wx/html/events/evt_list.rb +0 -10
- data/lib/wx/html/simple_html_listbox.rb +24 -91
- data/lib/wx/keyword_defs.rb +34 -2
- data/lib/wx/rbn/ribbon_gallery.rb +0 -21
- data/lib/wx/version.rb +1 -1
- data/lib/wxruby_aui.so +0 -0
- data/lib/wxruby_core.so +0 -0
- data/lib/wxruby_grid.so +0 -0
- data/lib/wxruby_html.so +0 -0
- data/lib/wxruby_pg.so +0 -0
- data/lib/wxruby_prt.so +0 -0
- data/lib/wxruby_rbn.so +0 -0
- data/lib/wxruby_rtc.so +0 -0
- data/lib/wxruby_stc.so +0 -0
- data/rakelib/lib/config/mingw.rb +12 -0
- data/samples/aui/aui.rb +1237 -1233
- data/samples/calendar/calendar.rb +293 -289
- data/samples/controls/get_item_sample.rb +83 -79
- data/samples/controls/htlbox.rb +331 -327
- data/samples/dialogs/dialogs.rb +682 -694
- data/samples/dialogs/wizard.rb +52 -55
- data/samples/dragdrop/dragdrop.rb +146 -142
- data/samples/drawing/bitmap.rb +29 -26
- data/samples/drawing/bitmap_image.rb +84 -80
- data/samples/drawing/graphics_drawing.rb +209 -205
- data/samples/drawing/image_prt.rb +344 -340
- data/samples/drawing/maths_images.rb +18 -1
- data/samples/drawing/rmagic_bitmap_image.rb +88 -84
- data/samples/etc/caret.rb +306 -0
- data/samples/etc/miniframe.rb +65 -60
- data/samples/etc/sash.rb +109 -105
- data/samples/etc/scrollwin.rb +86 -80
- data/samples/etc/system_settings.rb +216 -209
- data/samples/event/activation.rb +72 -67
- data/samples/event/event.rb +160 -153
- data/samples/event/threaded.rb +8 -1
- data/samples/event/update_ui_event.rb +67 -60
- data/samples/grid/grid.rb +188 -181
- data/samples/grid/gridtablebase.rb +136 -129
- data/samples/html/html.rb +208 -204
- data/samples/mdi/mdi.rb +59 -54
- data/samples/minimal/minimal.rb +54 -51
- data/samples/minimal/nothing.rb +1 -0
- data/samples/printing/printing.rb +367 -377
- data/samples/printing/printing2.rb +203 -198
- data/samples/propgrid/propgrid.rb +2312 -2308
- data/samples/propgrid/propgrid_minimal.rb +57 -50
- data/samples/ribbon/ribbon.rb +780 -774
- data/samples/sampler/ext.rb +0 -33
- data/samples/sampler/sample.rb +4 -9
- data/samples/sampler.rb +1 -1
- data/samples/splash/splash.rb +118 -116
- data/samples/text/rich_textctrl.rb +207 -201
- data/samples/text/richtext.rb +1409 -1405
- data/samples/text/scintilla.rb +137 -128
- data/samples/text/textctrl.rb +89 -83
- data/samples/text/unicode.rb +175 -168
- data/samples/treectrl/treectrl.rb +1430 -1426
- data/samples/widgets/activityindicator.rb +95 -0
- data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
- data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
- data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
- data/samples/widgets/art/widgets/button.xpm +54 -0
- data/samples/widgets/art/widgets/checkbox.xpm +54 -0
- data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
- data/samples/widgets/art/widgets/choicebk.xpm +54 -0
- data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
- data/samples/widgets/art/widgets/combobox.xpm +54 -0
- data/samples/widgets/art/widgets/datepick.xpm +200 -0
- data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
- data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
- data/samples/widgets/art/widgets/filepicker.xpm +214 -0
- data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
- data/samples/widgets/art/widgets/gauge.xpm +54 -0
- data/samples/widgets/art/widgets/header.xpm +54 -0
- data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
- data/samples/widgets/art/widgets/listbook.xpm +54 -0
- data/samples/widgets/art/widgets/listbox.xpm +54 -0
- data/samples/widgets/art/widgets/native.xpm +81 -0
- data/samples/widgets/art/widgets/notebook.xpm +54 -0
- data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
- data/samples/widgets/art/widgets/radiobox.xpm +54 -0
- data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
- data/samples/widgets/art/widgets/slider.xpm +54 -0
- data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
- data/samples/widgets/art/widgets/statbmp.xpm +40 -0
- data/samples/widgets/art/widgets/statbox.xpm +54 -0
- data/samples/widgets/art/widgets/stattext.xpm +54 -0
- data/samples/widgets/art/widgets/text.xpm +54 -0
- data/samples/widgets/art/widgets/timepick.xpm +207 -0
- data/samples/widgets/art/widgets/toggle.xpm +54 -0
- data/samples/widgets/art/widgets/toucan.png +0 -0
- data/samples/widgets/bmpcombobox.rb +651 -0
- data/samples/widgets/button.rb +462 -0
- data/samples/widgets/checkbox.rb +211 -0
- data/samples/widgets/choice.rb +287 -0
- data/samples/widgets/clrpicker.rb +156 -0
- data/samples/widgets/combobox.rb +516 -0
- data/samples/widgets/datepick.rb +215 -0
- data/samples/widgets/dirctrl.rb +265 -0
- data/samples/widgets/dirpicker.rb +158 -0
- data/samples/widgets/editlbox.rb +122 -0
- data/samples/widgets/filectrl.rb +216 -0
- data/samples/widgets/filepicker.rb +214 -0
- data/samples/widgets/fontpicker.rb +135 -0
- data/samples/widgets/gauge.rb +311 -0
- data/samples/widgets/headerctrl.rb +236 -0
- data/samples/widgets/hyperlink.rb +203 -0
- data/samples/widgets/itemcontainer.rb +185 -0
- data/samples/widgets/listbox.rb +473 -0
- data/samples/widgets/notebook.rb +488 -0
- data/samples/widgets/odcombobox.rb +608 -0
- data/samples/widgets/radiobox.rb +328 -0
- data/samples/widgets/searchctrl.rb +159 -0
- data/samples/widgets/slider.rb +594 -0
- data/samples/widgets/spinbtn.rb +443 -0
- data/samples/widgets/statbmp.rb +130 -0
- data/samples/widgets/static.rb +436 -0
- data/samples/widgets/textctrl.rb +700 -0
- data/samples/widgets/timepick.rb +148 -0
- data/samples/widgets/tn_widgets.png +0 -0
- data/samples/widgets/toggle.rb +385 -0
- data/samples/widgets/widgets.rb +1233 -0
- data/samples/xrc/custom_xrc_sample.rb +47 -41
- data/samples/xrc/xrc_sample.rb +53 -47
- data/tests/test_event_handling.rb +52 -34
- data/tests/test_events.rb +7 -0
- data/tests/test_item_data.rb +24 -0
- data/tests/test_sizer.rb +44 -1
- data/tests/test_validators.rb +805 -0
- metadata +87 -137
- data/lib/wx/core/choice.rb +0 -14
- data/lib/wx/core/combo_ctrl.rb +0 -110
- data/samples/bigdemo/About.rbw +0 -39
- data/samples/bigdemo/ColorPanel.rbw +0 -23
- data/samples/bigdemo/GridSimple.rbw +0 -78
- data/samples/bigdemo/MDIDemo.rbw +0 -57
- data/samples/bigdemo/PopupMenu.rbw +0 -146
- data/samples/bigdemo/ShapedWindow.rbw +0 -128
- data/samples/bigdemo/Sizers.rbw +0 -541
- data/samples/bigdemo/bigdemo.rb +0 -817
- data/samples/bigdemo/demoTemplate.rbw +0 -33
- data/samples/bigdemo/helpfile.htb +0 -0
- data/samples/bigdemo/icons/Test 015.jpg +0 -0
- data/samples/bigdemo/icons/Test 015.png +0 -0
- data/samples/bigdemo/icons/choice.bmp +0 -0
- data/samples/bigdemo/icons/combo.bmp +0 -0
- data/samples/bigdemo/icons/combo.xpm +0 -27
- data/samples/bigdemo/icons/copy.xpm +0 -25
- data/samples/bigdemo/icons/cut.xpm +0 -24
- data/samples/bigdemo/icons/gauge.bmp +0 -0
- data/samples/bigdemo/icons/gauge.xpm +0 -27
- data/samples/bigdemo/icons/help.xpm +0 -25
- data/samples/bigdemo/icons/list.bmp +0 -0
- data/samples/bigdemo/icons/list.xpm +0 -27
- data/samples/bigdemo/icons/mondrian.ico +0 -0
- data/samples/bigdemo/icons/mondrian.xpm +0 -44
- data/samples/bigdemo/icons/new.xpm +0 -24
- data/samples/bigdemo/icons/ogl.ico +0 -0
- data/samples/bigdemo/icons/ogl.xpm +0 -45
- data/samples/bigdemo/icons/open.xpm +0 -26
- data/samples/bigdemo/icons/paste.bmp +0 -0
- data/samples/bigdemo/icons/paste.xpm +0 -38
- data/samples/bigdemo/icons/pointy.png +0 -0
- data/samples/bigdemo/icons/preview.xpm +0 -26
- data/samples/bigdemo/icons/print.xpm +0 -26
- data/samples/bigdemo/icons/radio.bmp +0 -0
- data/samples/bigdemo/icons/radio.xpm +0 -27
- data/samples/bigdemo/icons/robert.xpm +0 -415
- data/samples/bigdemo/icons/sashtest.ico +0 -0
- data/samples/bigdemo/icons/save.xpm +0 -25
- data/samples/bigdemo/icons/smiles.bmp +0 -0
- data/samples/bigdemo/icons/smiles.xpm +0 -39
- data/samples/bigdemo/icons/smiley.ico +0 -0
- data/samples/bigdemo/icons/smiley.xpm +0 -42
- data/samples/bigdemo/icons/stattext.xpm +0 -24
- data/samples/bigdemo/icons/test2.bmp +0 -0
- data/samples/bigdemo/icons/test2.png +0 -0
- data/samples/bigdemo/icons/test2.xpm +0 -79
- data/samples/bigdemo/icons/text.bmp +0 -0
- data/samples/bigdemo/icons/text.xpm +0 -27
- data/samples/bigdemo/icons/tog1.bmp +0 -0
- data/samples/bigdemo/icons/tog1.xpm +0 -38
- data/samples/bigdemo/icons/tog2.bmp +0 -0
- data/samples/bigdemo/icons/tog2.xpm +0 -38
- data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
- data/samples/bigdemo/icons/wxwin.ico +0 -0
- data/samples/bigdemo/icons/wxwin16x16.png +0 -0
- data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
- data/samples/bigdemo/icons/wxwin32x32.png +0 -0
- data/samples/bigdemo/icons/wxwin48x48.png +0 -0
- data/samples/bigdemo/run.rb +0 -98
- data/samples/bigdemo/tips.txt +0 -7
- data/samples/bigdemo/utils.rb +0 -20
- data/samples/bigdemo/wxArtProvider.rbw +0 -282
- data/samples/bigdemo/wxBitmapButton.rbw +0 -65
- data/samples/bigdemo/wxButton.rbw +0 -64
- data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
- data/samples/bigdemo/wxCheckBox.rbw +0 -50
- data/samples/bigdemo/wxCheckListBox.rbw +0 -65
- data/samples/bigdemo/wxChoice.rbw +0 -47
- data/samples/bigdemo/wxChoicebook.rbw +0 -78
- data/samples/bigdemo/wxColourDialog.rbw +0 -33
- data/samples/bigdemo/wxComboBox.rbw +0 -77
- data/samples/bigdemo/wxCursor.rbw +0 -136
- data/samples/bigdemo/wxDialog.rbw +0 -74
- data/samples/bigdemo/wxDirDialog.rbw +0 -29
- data/samples/bigdemo/wxDragImage.rbw +0 -70
- data/samples/bigdemo/wxFileDialog.rbw +0 -37
- data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
- data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
- data/samples/bigdemo/wxFontDialog.rbw +0 -200
- data/samples/bigdemo/wxFrame.rbw +0 -53
- data/samples/bigdemo/wxGauge.rbw +0 -65
- data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
- data/samples/bigdemo/wxGrid.rbw +0 -66
- data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
- data/samples/bigdemo/wxListBox.rbw +0 -140
- data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
- data/samples/bigdemo/wxMDIWindows.rbw +0 -50
- data/samples/bigdemo/wxMenu.rbw +0 -247
- data/samples/bigdemo/wxMessageDialog.rbw +0 -27
- data/samples/bigdemo/wxMiniFrame.rbw +0 -70
- data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
- data/samples/bigdemo/wxNotebook.rbw +0 -136
- data/samples/bigdemo/wxProgressDialog.rbw +0 -43
- data/samples/bigdemo/wxRadioBox.rbw +0 -72
- data/samples/bigdemo/wxRadioButton.rbw +0 -125
- data/samples/bigdemo/wxSashWindow.rbw +0 -141
- data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
- data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
- data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
- data/samples/bigdemo/wxSlider.rbw +0 -42
- data/samples/bigdemo/wxSpinButton.rbw +0 -50
- data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
- data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
- data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
- data/samples/bigdemo/wxStaticText.rbw +0 -55
- data/samples/bigdemo/wxStatusBar.rbw +0 -126
- data/samples/bigdemo/wxTextCtrl.rbw +0 -149
- data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
- data/samples/bigdemo/wxToggleButton.rbw +0 -49
- data/samples/bigdemo/wxToolBar.rbw +0 -131
- data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
- data/samples/caret/caret.rb +0 -298
- data/samples/caret/mondrian.xpm +0 -44
- data/samples/controls/books.rb +0 -189
- data/samples/controls/choice.xpm +0 -27
- data/samples/controls/combo.xpm +0 -27
- data/samples/controls/controls.rb +0 -1099
- data/samples/controls/gauge.xpm +0 -27
- data/samples/controls/list.xpm +0 -27
- data/samples/controls/mondrian.ico +0 -0
- data/samples/controls/mondrian.xpm +0 -44
- data/samples/controls/radio.xpm +0 -27
- data/samples/controls/stattext.xpm +0 -24
- data/samples/controls/test2.bmp +0 -0
- data/samples/controls/text.xpm +0 -27
- data/samples/controls/tn_books.png +0 -0
- data/samples/controls/tn_controls.png +0 -0
- data/samples/etc/choice.rb +0 -87
- data/samples/etc/tn_choice.png +0 -0
- data/samples/text/mondrian.ico +0 -0
- data/samples/text/mondrian.xpm +0 -44
- /data/samples/{caret → etc}/tn_caret.png +0 -0
data/lib/wx/doc/gen/events.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
module Wx
|
8
8
|
|
9
9
|
# This class is used for idle events, which are generated when the system becomes idle.
|
10
|
+
#
|
10
11
|
# Note that, unless you do something specifically, the idle events are not sent if the system remains idle once it has become it, e.g. only a single idle event will be generated until something else resulting in more normal events happens and only then is the next idle event sent again.
|
11
12
|
# If you need to ensure a continuous stream of idle events, you can either use {Wx::IdleEvent#request_more} method in your handler or call {wake_up_idle} periodically (for example from a timer event handler), but note that both of these approaches (and especially the first one) increase the system load and so should be avoided if possible.
|
12
13
|
# By default, idle events are sent to all windows, including even the hidden ones because they may be shown if some condition is met from their {Wx::EVT_IDLE} (or related {Wx::EVT_UPDATE_UI}) handler. The children of hidden windows do not receive idle events however as they can't change their state in any way noticeable by the user. Finally, the global {Wx::App} object also receives these events, as usual, so it can be used for any global idle time processing.
|
@@ -38,11 +39,13 @@ module Wx
|
|
38
39
|
|
39
40
|
# Returns true if the OnIdle function processing this event requested more processing time.
|
40
41
|
#
|
42
|
+
#
|
41
43
|
# @see Wx::IdleEvent#request_more
|
42
44
|
# @return [Boolean]
|
43
45
|
def more_requested; end
|
44
46
|
|
45
47
|
# Tells wxWidgets that more processing is required.
|
48
|
+
#
|
46
49
|
# This function can be called by an OnIdle handler for a window or window event handler to indicate that {Wx::App::OnIdle} should forward the OnIdle event once more to the application windows.
|
47
50
|
# If no window calls this function during OnIdle, then the application will remain in a passive event loop (not calling OnIdle) until a new event is posted to the application by the windowing system.
|
48
51
|
# @see Wx::IdleEvent#more_requested
|
@@ -52,6 +55,7 @@ module Wx
|
|
52
55
|
|
53
56
|
# Static function returning a value specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events.
|
54
57
|
#
|
58
|
+
#
|
55
59
|
# @see Wx::IdleEvent.set_mode.
|
56
60
|
# @return [Wx::IdleMode]
|
57
61
|
def self.get_mode; end
|
@@ -64,6 +68,7 @@ module Wx
|
|
64
68
|
end # IdleEvent
|
65
69
|
|
66
70
|
# This class is not used by the event handlers by itself, but is a base class for other event classes (such as {Wx::BookCtrlEvent}).
|
71
|
+
#
|
67
72
|
# It (or an object of a derived class) is sent when the controls state is being changed and allows the program to {Wx::NotifyEvent#veto} this change if it wants to prevent it from happening.
|
68
73
|
#
|
69
74
|
# Category: {Wx::Events}
|
@@ -73,12 +78,13 @@ module Wx
|
|
73
78
|
class NotifyEvent < CommandEvent
|
74
79
|
|
75
80
|
# Constructor (used internally by wxWidgets only).
|
76
|
-
# @param eventType [Wx::
|
81
|
+
# @param eventType [Wx::StaticLine::EventType]
|
77
82
|
# @param id [Integer]
|
78
83
|
# @return [Wx::NotifyEvent]
|
79
84
|
def initialize(eventType=Wx::EVT_NULL, id=0) end
|
80
85
|
|
81
86
|
# This is the opposite of {Wx::NotifyEvent#veto}: it explicitly allows the event to be processed.
|
87
|
+
#
|
82
88
|
# For most events it is not necessary to call this method as the events are allowed anyhow but some are forbidden by default (this will be mentioned in the corresponding event description).
|
83
89
|
# @return [void]
|
84
90
|
def allow; end
|
@@ -89,6 +95,7 @@ module Wx
|
|
89
95
|
alias_method :allowed?, :is_allowed
|
90
96
|
|
91
97
|
# Prevents the change announced by this event from happening.
|
98
|
+
#
|
92
99
|
# It is in general a good idea to notify the user about the reasons for vetoing the change because otherwise the applications behaviour (which just refuses to do what the user wants) might be quite surprising.
|
93
100
|
# @return [void]
|
94
101
|
def veto; end
|
@@ -96,6 +103,7 @@ module Wx
|
|
96
103
|
end # NotifyEvent
|
97
104
|
|
98
105
|
# A scroll event holds information about events sent from stand-alone scrollbars (see {Wx::ScrollBar}) and sliders (see {Wx::Slider}).
|
106
|
+
#
|
99
107
|
# Note that scrolled windows send the {Wx::ScrollWinEvent} which does not derive from {Wx::CommandEvent}, but from {Wx::Event} directly - don't confuse these two kinds of events and use the event table macros mentioned below only for the scrollbar-like controls.
|
100
108
|
#
|
101
109
|
# ## The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
|
@@ -108,7 +116,7 @@ module Wx
|
|
108
116
|
# <b>Remark:</b>
|
109
117
|
# <p>Note that unless specifying a scroll control identifier, you will need to test for scrollbar orientation with {Wx::ScrollEvent#get_orientation}, since horizontal and vertical scroll events are processed using the same event handler.
|
110
118
|
# </p>
|
111
|
-
# </div
|
119
|
+
# </div>
|
112
120
|
#
|
113
121
|
# ### Events using this class
|
114
122
|
#
|
@@ -166,7 +174,7 @@ module Wx
|
|
166
174
|
class ScrollEvent < CommandEvent
|
167
175
|
|
168
176
|
# Constructor.
|
169
|
-
# @param commandType [Wx::
|
177
|
+
# @param commandType [Wx::StaticLine::EventType]
|
170
178
|
# @param id [Integer]
|
171
179
|
# @param pos [Integer]
|
172
180
|
# @param orientation [Integer]
|
@@ -196,6 +204,7 @@ module Wx
|
|
196
204
|
end # ScrollEvent
|
197
205
|
|
198
206
|
# A scroll event holds information about events sent from scrolling windows.
|
207
|
+
#
|
199
208
|
# Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events from the receiving window.
|
200
209
|
# ### Events using this class
|
201
210
|
#
|
@@ -228,19 +237,21 @@ module Wx
|
|
228
237
|
class ScrollWinEvent < Event
|
229
238
|
|
230
239
|
# Constructor.
|
231
|
-
# @param commandType [Wx::
|
240
|
+
# @param commandType [Wx::StaticLine::EventType]
|
232
241
|
# @param pos [Integer]
|
233
242
|
# @param orientation [Integer]
|
234
243
|
# @return [Wx::ScrollWinEvent]
|
235
244
|
def initialize(commandType=Wx::EVT_NULL, pos=0, orientation=0) end
|
236
245
|
|
237
246
|
# Returns {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}, depending on the orientation of the scrollbar.
|
247
|
+
#
|
238
248
|
# Todo{Wx::Orientation::HORIZONTAL} and {Wx::Orientation::VERTICAL} should go in their own enum
|
239
249
|
# @return [Integer]
|
240
250
|
def get_orientation; end
|
241
251
|
alias_method :orientation, :get_orientation
|
242
252
|
|
243
253
|
# Returns the position of the scrollbar for the thumb track and release events.
|
254
|
+
#
|
244
255
|
# Note that this field can't be used for the other events, you need to query the window itself for the current position in that case.
|
245
256
|
# @return [Integer]
|
246
257
|
def get_position; end
|
@@ -259,6 +270,7 @@ module Wx
|
|
259
270
|
end # ScrollWinEvent
|
260
271
|
|
261
272
|
# This event class contains information about the events generated by the mouse: they include mouse buttons press and release events and mouse move events.
|
273
|
+
#
|
262
274
|
# All mouse events involving the buttons use {Wx::MouseButton::MOUSE_BTN_LEFT} for the left mouse button, {Wx::MouseButton::MOUSE_BTN_MIDDLE} for the middle one and {Wx::MouseButton::MOUSE_BTN_RIGHT} for the right one. And if the system supports more buttons, the {Wx::MouseButton::MOUSE_BTN_AUX1} and {Wx::MouseButton::MOUSE_BTN_AUX2} events can also be generated. Note that not all mice have even a middle button so a portable application should avoid relying on the events from it (but the right button click can be emulated using the left mouse button with the control key under Mac platforms with a single button mouse).
|
263
275
|
# For the {Wx::EVT_ENTER_WINDOW} and {Wx::EVT_LEAVE_WINDOW} events purposes, the mouse is considered to be inside the window if it is in the window client area and not inside one of its children. In other words, the parent window receives {Wx::EVT_LEAVE_WINDOW} event not only when the mouse leaves the window entirely but also when it enters one of its children.
|
264
276
|
# The position associated with a mouse event is expressed in the window coordinates of the window which generated the event, you can use {Wx::Window#client_to_screen} to convert it to screen coordinates and possibly call {Wx::Window#screen_to_client} next to convert it to window coordinates of another window.
|
@@ -323,6 +335,7 @@ module Wx
|
|
323
335
|
class MouseEvent < Event
|
324
336
|
|
325
337
|
# Constructor.
|
338
|
+
#
|
326
339
|
# Valid event types are:
|
327
340
|
#
|
328
341
|
# - {Wx::EVT_ENTER_WINDOW}
|
@@ -364,7 +377,7 @@ module Wx
|
|
364
377
|
# - {Wx::EVT_MOUSEWHEEL}
|
365
378
|
#
|
366
379
|
# - {Wx::EVT_MAGNIFY}
|
367
|
-
# @param mouseEventType [Wx::
|
380
|
+
# @param mouseEventType [Wx::StaticLine::EventType]
|
368
381
|
# @return [Wx::MouseEvent]
|
369
382
|
def initialize(mouseEventType=Wx::EVT_NULL) end
|
370
383
|
|
@@ -394,24 +407,28 @@ module Wx
|
|
394
407
|
|
395
408
|
# Returns true if the event was generated by the specified button.
|
396
409
|
#
|
410
|
+
#
|
397
411
|
# @see wxMouseState::ButtoinIsDown()
|
398
412
|
# @param but [Wx::MouseButton]
|
399
413
|
# @return [Boolean]
|
400
414
|
def button(but) end
|
401
415
|
|
402
416
|
# If the argument is omitted, this returns true if the event was a mouse double click event.
|
417
|
+
#
|
403
418
|
# Otherwise the argument specifies which double click event was generated (see {Wx::MouseEvent#button} for the possible values).
|
404
419
|
# @param but [Wx::MouseButton]
|
405
420
|
# @return [Boolean]
|
406
421
|
def button_d_click(but=Wx::MouseButton::MOUSE_BTN_ANY) end
|
407
422
|
|
408
423
|
# If the argument is omitted, this returns true if the event was a mouse button down event.
|
424
|
+
#
|
409
425
|
# Otherwise the argument specifies which button-down event was generated (see {Wx::MouseEvent#button} for the possible values).
|
410
426
|
# @param but [Wx::MouseButton]
|
411
427
|
# @return [Boolean]
|
412
428
|
def button_down(but=Wx::MouseButton::MOUSE_BTN_ANY) end
|
413
429
|
|
414
430
|
# If the argument is omitted, this returns true if the event was a mouse button up event.
|
431
|
+
#
|
415
432
|
# Otherwise the argument specifies which button-up event was generated (see {Wx::MouseEvent#button} for the possible values).
|
416
433
|
# @param but [Wx::MouseButton]
|
417
434
|
# @return [Boolean]
|
@@ -419,28 +436,33 @@ module Wx
|
|
419
436
|
|
420
437
|
# Returns true if this was a dragging event (motion while a button is depressed).
|
421
438
|
#
|
439
|
+
#
|
422
440
|
# @see Wx::MouseEvent#moving
|
423
441
|
# @return [Boolean]
|
424
442
|
def dragging; end
|
425
443
|
|
426
444
|
# Returns true if the mouse was entering the window.
|
427
445
|
#
|
446
|
+
#
|
428
447
|
# @see Wx::MouseEvent#leaving
|
429
448
|
# @return [Boolean]
|
430
449
|
def entering; end
|
431
450
|
|
432
451
|
# Returns the mouse button which generated this event or {Wx::MouseButton::MOUSE_BTN_NONE} if no button is involved (for mouse move, enter or leave event, for example).
|
452
|
+
#
|
433
453
|
# Otherwise {Wx::MouseButton::MOUSE_BTN_LEFT} is returned for the left button down, up and double click events, {Wx::MouseButton::MOUSE_BTN_MIDDLE} and {Wx::MouseButton::MOUSE_BTN_RIGHT} for the same events for the middle and the right buttons respectively.
|
434
454
|
# @return [Integer]
|
435
455
|
def get_button; end
|
436
456
|
|
437
457
|
# Returns the number of mouse clicks for this event: 1 for a simple click, 2 for a double-click, 3 for a triple-click and so on.
|
458
|
+
#
|
438
459
|
# Currently this function is implemented only in WXOSX and returns -1 for the other platforms (you can still distinguish simple clicks from double-clicks as they generate different kinds of events however).
|
439
460
|
# @return [Integer]
|
440
461
|
def get_click_count; end
|
441
462
|
alias_method :click_count, :get_click_count
|
442
463
|
|
443
464
|
# Returns the configured number of lines (or whatever) to be scrolled per wheel action.
|
465
|
+
#
|
444
466
|
# Default value under most platforms is three.
|
445
467
|
# @see Wx::MouseEvent#get_columns_per_action
|
446
468
|
# @return [Integer]
|
@@ -448,6 +470,7 @@ module Wx
|
|
448
470
|
alias_method :lines_per_action, :get_lines_per_action
|
449
471
|
|
450
472
|
# Returns the configured number of columns (or whatever) to be scrolled per wheel action.
|
473
|
+
#
|
451
474
|
# Default value under most platforms is three.
|
452
475
|
# @see Wx::MouseEvent#get_lines_per_action
|
453
476
|
# @return [Integer]
|
@@ -461,6 +484,7 @@ module Wx
|
|
461
484
|
alias_method :logical_position, :get_logical_position
|
462
485
|
|
463
486
|
# For magnify (pinch to zoom) events: returns the change in magnification.
|
487
|
+
#
|
464
488
|
# A value of 0 means no change, a positive value means we should enlarge (or zoom in), a negative value means we should shrink (or zoom out).
|
465
489
|
# This method is only valid to call for {Wx::EVT_MAGNIFY} events which are currently only generated under macOS.
|
466
490
|
# @see Wx::MouseEvent#magnify
|
@@ -469,18 +493,21 @@ module Wx
|
|
469
493
|
alias_method :magnification, :get_magnification
|
470
494
|
|
471
495
|
# Get wheel delta, normally 120.
|
496
|
+
#
|
472
497
|
# This is the threshold for action to be taken, and one such action (for example, scrolling one increment) should occur for each delta.
|
473
498
|
# @return [Integer]
|
474
499
|
def get_wheel_delta; end
|
475
500
|
alias_method :wheel_delta, :get_wheel_delta
|
476
501
|
|
477
502
|
# On Mac, has the user selected "Natural" scrolling in their System Preferences? Currently false on all other OS's.
|
503
|
+
#
|
478
504
|
# "Natural" scrolling means that content scrolling happens in the opposite direction, and if you are indeed scrolling content then you don't need to use this function because macOS has already inverted the scroll direction. But there can be special situations where you want the mouse wheel action to work always in the same direction and in that case you will need this function.
|
479
505
|
# @return [Boolean]
|
480
506
|
def is_wheel_inverted; end
|
481
507
|
alias_method :wheel_inverted?, :is_wheel_inverted
|
482
508
|
|
483
509
|
# Get wheel rotation, positive or negative indicates direction of rotation.
|
510
|
+
#
|
484
511
|
# Current devices all send an event when rotation is at least +/-WheelDelta, but finer resolution devices can be created in the future.
|
485
512
|
# Because of this you shouldn't assume that one event is equal to 1 line, but you should be able to either do partial line scrolling or wait until several events accumulate before scrolling.
|
486
513
|
# @return [Integer]
|
@@ -488,6 +515,7 @@ module Wx
|
|
488
515
|
alias_method :wheel_rotation, :get_wheel_rotation
|
489
516
|
|
490
517
|
# Gets the axis the wheel operation concerns.
|
518
|
+
#
|
491
519
|
# Usually the mouse wheel is used to scroll vertically so {Wx::MouseWheelAxis::MOUSE_WHEEL_VERTICAL} is returned but some mice (and most trackpads) also allow to use the wheel to scroll horizontally in which case {Wx::MouseWheelAxis::MOUSE_WHEEL_HORIZONTAL} is returned.
|
492
520
|
# Notice that before wxWidgets 2.9.4 this method returned int.
|
493
521
|
# @return [Wx::MouseWheelAxis]
|
@@ -506,6 +534,7 @@ module Wx
|
|
506
534
|
|
507
535
|
# Returns true if the mouse was leaving the window.
|
508
536
|
#
|
537
|
+
#
|
509
538
|
# @see Wx::MouseEvent#entering.
|
510
539
|
# @return [Boolean]
|
511
540
|
def leaving; end
|
@@ -523,6 +552,7 @@ module Wx
|
|
523
552
|
def left_up; end
|
524
553
|
|
525
554
|
# Returns true if the event is a magnify (i.e. pinch to zoom) event.
|
555
|
+
#
|
526
556
|
# Such events are currently generated only under macOS.
|
527
557
|
# @see Wx::MouseEvent#get_magnification
|
528
558
|
# @return [Boolean]
|
@@ -545,6 +575,7 @@ module Wx
|
|
545
575
|
def middle_up; end
|
546
576
|
|
547
577
|
# Returns true if this was a motion event and no mouse buttons were pressed.
|
578
|
+
#
|
548
579
|
# If any mouse button is held pressed, then this method returns false and {Wx::MouseEvent#dragging} returns true.
|
549
580
|
# @return [Boolean]
|
550
581
|
def moving; end
|
@@ -642,6 +673,7 @@ module Wx
|
|
642
673
|
alias_method :state=, :set_state
|
643
674
|
|
644
675
|
# Return the bit mask of all pressed modifier keys.
|
676
|
+
#
|
645
677
|
# The return value is a combination of {Wx::KeyModifier::MOD_ALT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_SHIFT} and {Wx::KeyModifier::MOD_META} bit masks. Additionally, {Wx::KeyModifier::MOD_NONE} is defined as 0, i.e. corresponds to no modifiers (see {Wx::MouseEvent#has_any_modifiers}) and {Wx::KeyModifier::MOD_CMD} is either {Wx::KeyModifier::MOD_CONTROL} (MSW and Unix) or {Wx::KeyModifier::MOD_META} (Mac), see {Wx::MouseEvent#cmd_down}. See {Wx::KeyModifier} for the full list of modifiers.
|
646
678
|
# Notice that this function is easier to use correctly than, for example, {Wx::MouseEvent#control_down} because when using the latter you also have to remember to test that none of the other modifiers is pressed:
|
647
679
|
#
|
@@ -663,6 +695,7 @@ module Wx
|
|
663
695
|
alias_method :modifiers, :get_modifiers
|
664
696
|
|
665
697
|
# Returns true if any modifiers at all are pressed.
|
698
|
+
#
|
666
699
|
# This is equivalent to <code>Wx::MouseEvent#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
|
667
700
|
# Notice that this is different from {Wx::MouseEvent#has_modifiers} method which doesn't take e.g. Shift modifier into account. This method is most suitable for mouse events when any modifier, including Shift, can change the interpretation of the event.
|
668
701
|
# @return [Boolean]
|
@@ -670,6 +703,7 @@ module Wx
|
|
670
703
|
alias_method :has_any_modifiers?, :has_any_modifiers
|
671
704
|
|
672
705
|
# Returns true if Control or Alt are pressed.
|
706
|
+
#
|
673
707
|
# Checks if Control, Alt or, under macOS only, Command key are pressed (notice that the real Control key is still taken into account under OS X too).
|
674
708
|
# This method returns false if only Shift is pressed for compatibility reasons and also because pressing Shift usually doesn't change the interpretation of key events, see {Wx::MouseEvent#has_any_modifiers} if you want to take Shift into account as well.
|
675
709
|
# @return [Boolean]
|
@@ -677,29 +711,34 @@ module Wx
|
|
677
711
|
alias_method :has_modifiers?, :has_modifiers
|
678
712
|
|
679
713
|
# Returns true if the Control key or Apple/Command key under macOS is pressed.
|
714
|
+
#
|
680
715
|
# This function doesn't distinguish between right and left control keys.
|
681
716
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
682
717
|
# @return [Boolean]
|
683
718
|
def control_down; end
|
684
719
|
|
685
720
|
# Returns true if the Control key (also under macOS).
|
721
|
+
#
|
686
722
|
# This function doesn't distinguish between right and left control keys.
|
687
723
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
688
724
|
# @return [Boolean]
|
689
725
|
def raw_control_down; end
|
690
726
|
|
691
727
|
# Returns true if the Shift key is pressed.
|
728
|
+
#
|
692
729
|
# This function doesn't distinguish between right and left shift keys.
|
693
730
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
694
731
|
# @return [Boolean]
|
695
732
|
def shift_down; end
|
696
733
|
|
697
734
|
# Returns true if the Alt key is pressed.
|
735
|
+
#
|
698
736
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
699
737
|
# @return [Boolean]
|
700
738
|
def alt_down; end
|
701
739
|
|
702
740
|
# Returns true if the key used for command accelerators is pressed.
|
741
|
+
#
|
703
742
|
# Same as {Wx::MouseEvent#control_down}. Deprecated.
|
704
743
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
705
744
|
# @return [Boolean]
|
@@ -733,6 +772,7 @@ module Wx
|
|
733
772
|
end # MouseEvent
|
734
773
|
|
735
774
|
# A {Wx::SetCursorEvent} is generated from {Wx::Window} when the mouse cursor is about to be set as a result of mouse motion.
|
775
|
+
#
|
736
776
|
# This event gives the application the chance to perform specific mouse cursor processing based on the current position of the mouse within the window. Use {Wx::SetCursorEvent#set_cursor} to specify the cursor you want to be displayed.
|
737
777
|
# ### Events using this class
|
738
778
|
#
|
@@ -770,11 +810,12 @@ module Wx
|
|
770
810
|
alias_method :y, :get_y
|
771
811
|
|
772
812
|
# Returns true if the cursor specified by this event is a valid cursor.
|
813
|
+
#
|
773
814
|
# <div class="wxrb-remark">
|
774
815
|
# <b>Remark:</b>
|
775
816
|
# <p>You cannot specify {Wx::NULL_CURSOR} with this event, as it is not considered a valid cursor.
|
776
817
|
# </p>
|
777
|
-
# </div
|
818
|
+
# </div>
|
778
819
|
# @return [Boolean]
|
779
820
|
def has_cursor; end
|
780
821
|
alias_method :has_cursor?, :has_cursor
|
@@ -788,6 +829,7 @@ module Wx
|
|
788
829
|
end # SetCursorEvent
|
789
830
|
|
790
831
|
# This is the base class for all supported gesture events.
|
832
|
+
#
|
791
833
|
# <div class="wxrb-note">
|
792
834
|
# <b>Note:</b>
|
793
835
|
# <p>Gesture events are not generated by default, you must call {Wx::Window#enable_touch_events} with the appropriate parameter to request their generation.
|
@@ -804,7 +846,7 @@ module Wx
|
|
804
846
|
|
805
847
|
# Constructor.
|
806
848
|
# @param winid [Integer]
|
807
|
-
# @param type [Wx::
|
849
|
+
# @param type [Wx::StaticLine::EventType]
|
808
850
|
# @return [Wx::GestureEvent]
|
809
851
|
def initialize(winid=0, type=Wx::EVT_NULL) end
|
810
852
|
|
@@ -844,6 +886,7 @@ module Wx
|
|
844
886
|
end # GestureEvent
|
845
887
|
|
846
888
|
# This event is generated when the user moves a finger on the surface.
|
889
|
+
#
|
847
890
|
# WXGTK also generates this event during mouse dragging (mouse motion while a left mouse button is depressed).
|
848
891
|
# Note that OSX requires the primary mouse button to be pressed while performing the finger movement.
|
849
892
|
# ### Events using this class
|
@@ -876,6 +919,7 @@ module Wx
|
|
876
919
|
end # PanGestureEvent
|
877
920
|
|
878
921
|
# This event is generated when two fingers pinch the surface to zoom in or out.
|
922
|
+
#
|
879
923
|
# ### Events using this class
|
880
924
|
#
|
881
925
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ZoomGestureEvent} events.
|
@@ -893,6 +937,7 @@ module Wx
|
|
893
937
|
def initialize(windid=0) end
|
894
938
|
|
895
939
|
# Returns the zoom Factor since the gesture started.
|
940
|
+
#
|
896
941
|
# Hence, starting of the gesture is considered as 1:1. A value greater than 1.0 means we should enlarge (or zoom in), a value less than 1.0 means we should shrink (or zoom out).
|
897
942
|
# @return [Float]
|
898
943
|
def get_zoom_factor; end
|
@@ -907,6 +952,7 @@ module Wx
|
|
907
952
|
end # ZoomGestureEvent
|
908
953
|
|
909
954
|
# This event is generated when two fingers move in opposite directions on the surface.
|
955
|
+
#
|
910
956
|
# ### Events using this class
|
911
957
|
#
|
912
958
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::RotateGestureEvent} events.
|
@@ -924,12 +970,14 @@ module Wx
|
|
924
970
|
def initialize(windid=0) end
|
925
971
|
|
926
972
|
# Returns the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
|
973
|
+
#
|
927
974
|
# when {Wx::RotateGestureEvent#is_gesture_start} returned true. This value is always greater than or equal to zero.
|
928
975
|
# @return [Float]
|
929
976
|
def get_rotation_angle; end
|
930
977
|
alias_method :rotation_angle, :get_rotation_angle
|
931
978
|
|
932
979
|
# Sets the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
|
980
|
+
#
|
933
981
|
# when {Wx::RotateGestureEvent#is_gesture_start} returned true. This value is always greater than or equal to zero.
|
934
982
|
# @param rotationAngle [Float]
|
935
983
|
# @return [void]
|
@@ -939,6 +987,7 @@ module Wx
|
|
939
987
|
end # RotateGestureEvent
|
940
988
|
|
941
989
|
# This event is generated when two fingers touch the surface at the same time.
|
990
|
+
#
|
942
991
|
# ### Events using this class
|
943
992
|
#
|
944
993
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::TwoFingerTapEvent} events.
|
@@ -958,6 +1007,7 @@ module Wx
|
|
958
1007
|
end # TwoFingerTapEvent
|
959
1008
|
|
960
1009
|
# This event is generated when one finger touches the surface and remains stationary.
|
1010
|
+
#
|
961
1011
|
# Note that currently it is only generated under WXGTK and WXOSX.
|
962
1012
|
# WXGTK also generates this event when left mouse button is being pressed for some minimum duration of time.
|
963
1013
|
# ### Events using this class
|
@@ -979,6 +1029,7 @@ module Wx
|
|
979
1029
|
end # LongPressEvent
|
980
1030
|
|
981
1031
|
# This event is generated when the user press the surface with one finger and taps with another.
|
1032
|
+
#
|
982
1033
|
# Note that once started the event will also be generated when the finger that was pressed moves on surface.
|
983
1034
|
# ### Events using this class
|
984
1035
|
#
|
@@ -999,6 +1050,7 @@ module Wx
|
|
999
1050
|
end # PressAndTapEvent
|
1000
1051
|
|
1001
1052
|
# This event class contains information about key press and release events.
|
1053
|
+
#
|
1002
1054
|
# The main information carried by this event is the key being pressed or released. It can be accessed using one of {Wx::KeyEvent#get_unicode_key}, {Wx::KeyEvent#get_key_code} or {Wx::KeyEvent#get_raw_key_code} functions. For the printable characters, {Wx::KeyEvent#get_unicode_key} should be used as it works for any keys, including non-Latin-1 characters that can be entered when using national keyboard layouts. {Wx::KeyEvent#get_key_code} should be used to handle special characters (such as cursor arrows keys or HOME or INS and so on) which correspond to {Wx::KeyCode} enum elements above the {Wx::KeyCode::K_START} constant. While {Wx::KeyEvent#get_key_code} also returns the character code for Latin-1 keys for compatibility, it doesn't work for Unicode characters in general and will return {Wx::KeyCode::K_NONE} for any non-Latin-1 ones. If both {Wx::KeyEvent#get_unicode_key} and {Wx::KeyEvent#get_key_code} return {Wx::KeyCode::K_NONE} then the key has no WXK_xxx mapping and {Wx::KeyEvent#get_raw_key_code} can be used to distinguish between keys, but raw key codes are platform specific. For these reasons, it is recommended to always use {Wx::KeyEvent#get_unicode_key} and only fall back to {Wx::KeyEvent#get_key_code} if {Wx::KeyEvent#get_unicode_key} returned {Wx::KeyCode::K_NONE}, meaning that the event corresponds to a non-printable special keys, then optionally check {Wx::KeyEvent#get_raw_key_code} if {Wx::KeyEvent#get_key_code} also returned {Wx::KeyCode::K_NONE} or simply ignore that key.
|
1003
1055
|
# While these three functions can be used with the events of {Wx::EVT_KEY_DOWN}, {Wx::EVT_KEY_UP} and {Wx::EVT_CHAR} types, the values returned by them are different for the first two events and the last one. For the latter, the key returned corresponds to the character that would appear in e.g. a text zone if the user pressed the key in it. As such, its value depends on the current state of the Shift key and, for the letters, on the state of Caps Lock modifier. For example, if A key is pressed without Shift being held down, {Wx::KeyEvent} of type {Wx::EVT_CHAR} generated for this key press will return (from either {Wx::KeyEvent#get_key_code} or {Wx::KeyEvent#get_unicode_key} as their meanings coincide for ASCII characters) key code of 97 corresponding the ASCII value of a. And if the same key is pressed but with Shift being held (or Caps Lock being active), then the key could would be 65, i.e. ASCII value of capital A.
|
1004
1056
|
# However for the key down and up events the returned key code will instead be A independently of the state of the modifier keys i.e. it depends only on physical key being pressed and is not translated to its logical representation using the current keyboard state. Such untranslated key codes are defined as follows:
|
@@ -1060,6 +1112,7 @@ module Wx
|
|
1060
1112
|
class KeyEvent < Event
|
1061
1113
|
|
1062
1114
|
# Obtains the position (in client coordinates) at which the key was pressed.
|
1115
|
+
#
|
1063
1116
|
# Notice that under most platforms this position is simply the current mouse pointer position and has no special relationship to the key event itself.
|
1064
1117
|
# x and y may be NULL if the corresponding coordinate is not needed.
|
1065
1118
|
# @return [Wx::Point]
|
@@ -1067,12 +1120,14 @@ module Wx
|
|
1067
1120
|
alias_method :position, :get_position
|
1068
1121
|
|
1069
1122
|
# Constructor.
|
1123
|
+
#
|
1070
1124
|
# Currently, the only valid event types are {Wx::EVT_CHAR} and {Wx::EVT_CHAR_HOOK}.
|
1071
|
-
# @param keyEventType [Wx::
|
1125
|
+
# @param keyEventType [Wx::StaticLine::EventType]
|
1072
1126
|
# @return [Wx::KeyEvent]
|
1073
1127
|
def initialize(keyEventType=Wx::EVT_NULL) end
|
1074
1128
|
|
1075
1129
|
# Returns the key code of the key that generated this event.
|
1130
|
+
#
|
1076
1131
|
# ASCII symbols return normal ASCII values, while events from special keys such as "left cursor arrow" ({Wx::KeyCode::K_LEFT}) return values outside of the ASCII range. See {Wx::KeyCode} for a full list of the virtual key codes.
|
1077
1132
|
# Note that this method returns a meaningful value only for special non-alphanumeric keys or if the user entered a Latin-1 character (this includes ASCII and the accented letters found in Western European languages but not letters of other alphabets such as e.g. Cyrillic). Otherwise it simply method returns {Wx::KeyCode::K_NONE} and {Wx::KeyEvent#get_unicode_key} should be used to obtain the corresponding Unicode character.
|
1078
1133
|
# Using {Wx::KeyEvent#get_unicode_key} is in general the right thing to do if you are interested in the characters typed by the user, {Wx::KeyEvent#get_key_code} should be only used for special keys (for which {Wx::KeyEvent#get_unicode_key} returns {Wx::KeyCode::K_NONE}). To handle both kinds of keys you might write:
|
@@ -1117,6 +1172,7 @@ module Wx
|
|
1117
1172
|
alias_method :auto_repeat?, :is_auto_repeat
|
1118
1173
|
|
1119
1174
|
# Returns the raw key code for this event.
|
1175
|
+
#
|
1120
1176
|
# The flags are platform-dependent and should only be used if the functionality provided by other {Wx::KeyEvent} methods is insufficient.
|
1121
1177
|
# Under MSW, the raw key code is the value of wParam parameter of the corresponding message.
|
1122
1178
|
# Under GTK, the raw key code is the keyval field of the corresponding GDK event.
|
@@ -1132,6 +1188,7 @@ module Wx
|
|
1132
1188
|
alias_method :raw_key_code, :get_raw_key_code
|
1133
1189
|
|
1134
1190
|
# Returns the low level key flags for this event.
|
1191
|
+
#
|
1135
1192
|
# The flags are platform-dependent and should only be used if the functionality provided by other {Wx::KeyEvent} methods is insufficient.
|
1136
1193
|
# Under MSW, the raw flags are just the value of lParam parameter of the corresponding message.
|
1137
1194
|
# Under GTK, the raw flags contain the hardware_keycode field of the corresponding GDK event.
|
@@ -1147,6 +1204,7 @@ module Wx
|
|
1147
1204
|
alias_method :raw_key_flags, :get_raw_key_flags
|
1148
1205
|
|
1149
1206
|
# Returns the Unicode character corresponding to this key event.
|
1207
|
+
#
|
1150
1208
|
# If the key pressed doesn't have any character value (e.g. a cursor key) this method will return {Wx::KeyCode::K_NONE}. In this case you should use {Wx::KeyEvent#get_key_code} to retrieve the value of the key.
|
1151
1209
|
# This function is only available in Unicode build, i.e. when {Wx::Setup::USE_UNICODE} is 1.
|
1152
1210
|
# @return [String]
|
@@ -1155,6 +1213,7 @@ module Wx
|
|
1155
1213
|
|
1156
1214
|
# Returns the X position (in client coordinates) of the event.
|
1157
1215
|
#
|
1216
|
+
#
|
1158
1217
|
# @see Wx::KeyEvent#get_position
|
1159
1218
|
# @return [Integer]
|
1160
1219
|
def get_x; end
|
@@ -1162,24 +1221,28 @@ module Wx
|
|
1162
1221
|
|
1163
1222
|
# Returns the Y position (in client coordinates) of the event.
|
1164
1223
|
#
|
1224
|
+
#
|
1165
1225
|
# @see Wx::KeyEvent#get_position
|
1166
1226
|
# @return [Integer]
|
1167
1227
|
def get_y; end
|
1168
1228
|
alias_method :y, :get_y
|
1169
1229
|
|
1170
1230
|
# Allow normal key events generation.
|
1231
|
+
#
|
1171
1232
|
# Can be called from {Wx::EVT_CHAR_HOOK} handler to indicate that the generation of normal events should not be suppressed, as it happens by default when this event is handled.
|
1172
1233
|
# The intended use of this method is to allow some window object to prevent {Wx::EVT_CHAR_HOOK} handler in its parent window from running by defining its own handler for this event. Without calling this method, this would result in not generating {Wx::EVT_KEY_DOWN} nor {Wx::EVT_CHAR} events at all but by calling it you can ensure that these events would still be generated, even if {Wx::EVT_CHAR_HOOK} event was handled.
|
1173
1234
|
# @return [void]
|
1174
1235
|
def do_allow_next_event; end
|
1175
1236
|
|
1176
1237
|
# Returns true if {Wx::KeyEvent#do_allow_next_event} had been called, false by default.
|
1238
|
+
#
|
1177
1239
|
# This method is used by wxWidgets itself to determine whether the normal key events should be generated after {Wx::EVT_CHAR_HOOK} processing.
|
1178
1240
|
# @return [Boolean]
|
1179
1241
|
def is_next_event_allowed; end
|
1180
1242
|
alias_method :next_event_allowed?, :is_next_event_allowed
|
1181
1243
|
|
1182
1244
|
# Return the bit mask of all pressed modifier keys.
|
1245
|
+
#
|
1183
1246
|
# The return value is a combination of {Wx::KeyModifier::MOD_ALT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_SHIFT} and {Wx::KeyModifier::MOD_META} bit masks. Additionally, {Wx::KeyModifier::MOD_NONE} is defined as 0, i.e. corresponds to no modifiers (see {Wx::KeyEvent#has_any_modifiers}) and {Wx::KeyModifier::MOD_CMD} is either {Wx::KeyModifier::MOD_CONTROL} (MSW and Unix) or {Wx::KeyModifier::MOD_META} (Mac), see {Wx::KeyEvent#cmd_down}. See {Wx::KeyModifier} for the full list of modifiers.
|
1184
1247
|
# Notice that this function is easier to use correctly than, for example, {Wx::KeyEvent#control_down} because when using the latter you also have to remember to test that none of the other modifiers is pressed:
|
1185
1248
|
#
|
@@ -1201,6 +1264,7 @@ module Wx
|
|
1201
1264
|
alias_method :modifiers, :get_modifiers
|
1202
1265
|
|
1203
1266
|
# Returns true if any modifiers at all are pressed.
|
1267
|
+
#
|
1204
1268
|
# This is equivalent to <code>Wx::KeyEvent#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
|
1205
1269
|
# Notice that this is different from {Wx::KeyEvent#has_modifiers} method which doesn't take e.g. Shift modifier into account. This method is most suitable for mouse events when any modifier, including Shift, can change the interpretation of the event.
|
1206
1270
|
# @return [Boolean]
|
@@ -1208,6 +1272,7 @@ module Wx
|
|
1208
1272
|
alias_method :has_any_modifiers?, :has_any_modifiers
|
1209
1273
|
|
1210
1274
|
# Returns true if Control or Alt are pressed.
|
1275
|
+
#
|
1211
1276
|
# Checks if Control, Alt or, under macOS only, Command key are pressed (notice that the real Control key is still taken into account under OS X too).
|
1212
1277
|
# This method returns false if only Shift is pressed for compatibility reasons and also because pressing Shift usually doesn't change the interpretation of key events, see {Wx::KeyEvent#has_any_modifiers} if you want to take Shift into account as well.
|
1213
1278
|
# @return [Boolean]
|
@@ -1215,35 +1280,41 @@ module Wx
|
|
1215
1280
|
alias_method :has_modifiers?, :has_modifiers
|
1216
1281
|
|
1217
1282
|
# Returns true if the Control key or Apple/Command key under macOS is pressed.
|
1283
|
+
#
|
1218
1284
|
# This function doesn't distinguish between right and left control keys.
|
1219
1285
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1220
1286
|
# @return [Boolean]
|
1221
1287
|
def control_down; end
|
1222
1288
|
|
1223
1289
|
# Returns true if the Control key (also under macOS).
|
1290
|
+
#
|
1224
1291
|
# This function doesn't distinguish between right and left control keys.
|
1225
1292
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1226
1293
|
# @return [Boolean]
|
1227
1294
|
def raw_control_down; end
|
1228
1295
|
|
1229
1296
|
# Returns true if the Shift key is pressed.
|
1297
|
+
#
|
1230
1298
|
# This function doesn't distinguish between right and left shift keys.
|
1231
1299
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1232
1300
|
# @return [Boolean]
|
1233
1301
|
def shift_down; end
|
1234
1302
|
|
1235
1303
|
# Returns true if the Meta/Windows/Apple key is pressed.
|
1304
|
+
#
|
1236
1305
|
# This function tests the state of the key traditionally called Meta under Unix systems, Windows keys under MSW Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1237
1306
|
# @see Wx::KeyEvent#cmd_down
|
1238
1307
|
# @return [Boolean]
|
1239
1308
|
def meta_down; end
|
1240
1309
|
|
1241
1310
|
# Returns true if the Alt key is pressed.
|
1311
|
+
#
|
1242
1312
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1243
1313
|
# @return [Boolean]
|
1244
1314
|
def alt_down; end
|
1245
1315
|
|
1246
1316
|
# Returns true if the key used for command accelerators is pressed.
|
1317
|
+
#
|
1247
1318
|
# Same as {Wx::KeyEvent#control_down}. Deprecated.
|
1248
1319
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1249
1320
|
# @return [Boolean]
|
@@ -1277,6 +1348,7 @@ module Wx
|
|
1277
1348
|
end # KeyEvent
|
1278
1349
|
|
1279
1350
|
# A size event holds information about size change events of {Wx::Window}.
|
1351
|
+
#
|
1280
1352
|
# The EVT_SIZE handler function will be called when the window has been resized.
|
1281
1353
|
# You may wish to use this for frames to resize their child windows as appropriate.
|
1282
1354
|
# Note that the size passed is of the whole window: call {Wx::Window#get_client_size} for the area which may be used by the application.
|
@@ -1303,6 +1375,7 @@ module Wx
|
|
1303
1375
|
def initialize(sz, id=0) end
|
1304
1376
|
|
1305
1377
|
# Returns the entire size of the window generating the size change event.
|
1378
|
+
#
|
1306
1379
|
# This is the new total size of the window, i.e. the same size as would be returned by {Wx::Window#get_size} if it were called now. Use {Wx::Window#get_client_size} if you catch this event in a top level window such as {Wx::Frame} to find the size available for the window contents.
|
1307
1380
|
# @return [Wx::Size]
|
1308
1381
|
def get_size; end
|
@@ -1325,6 +1398,7 @@ module Wx
|
|
1325
1398
|
end # SizeEvent
|
1326
1399
|
|
1327
1400
|
# A move event holds information about window position change.
|
1401
|
+
#
|
1328
1402
|
# These events are currently generated for top level (see {Wx::TopLevelWindow}) windows in all ports, but are not generated for the child windows in WXGTK.
|
1329
1403
|
# ### Events using this class
|
1330
1404
|
#
|
@@ -1374,6 +1448,7 @@ module Wx
|
|
1374
1448
|
end # MoveEvent
|
1375
1449
|
|
1376
1450
|
# A paint event is sent when a window's contents needs to be repainted.
|
1451
|
+
#
|
1377
1452
|
# The handler of this event must create a {Wx::PaintDC} object and use it for painting the window contents. For example:
|
1378
1453
|
# ```ruby
|
1379
1454
|
# def on_paint(event)
|
@@ -1408,7 +1483,7 @@ module Wx
|
|
1408
1483
|
# <b>Remark:</b>
|
1409
1484
|
# <p>Please notice that in general it is impossible to change the drawing of a standard control (such as {Wx::Button}) and so you shouldn't attempt to handle paint events for them as even if it might work on some platforms, this is inherently not portable and won't work everywhere.
|
1410
1485
|
# </p>
|
1411
|
-
# </div
|
1486
|
+
# </div>
|
1412
1487
|
#
|
1413
1488
|
# ### Events using this class
|
1414
1489
|
#
|
@@ -1424,6 +1499,7 @@ module Wx
|
|
1424
1499
|
class PaintEvent < Event
|
1425
1500
|
|
1426
1501
|
# Constructor for exclusive use of wxWidgets itself.
|
1502
|
+
#
|
1427
1503
|
# Note that the objects of this class can not be created from application code, they're only created by the library itself. If you need a window to be repainted, use {Wx::Window#refresh} instead of trying to manually create an event of this class.
|
1428
1504
|
# @param window [Wx::Window]
|
1429
1505
|
# @return [Wx::PaintEvent]
|
@@ -1432,6 +1508,7 @@ module Wx
|
|
1432
1508
|
end # PaintEvent
|
1433
1509
|
|
1434
1510
|
# An erase event is sent when a window's background needs to be repainted.
|
1511
|
+
#
|
1435
1512
|
# On some platforms, such as GTK+, this event is simulated (simply generated just before the paint event) and may cause flicker. It is therefore recommended that you set the text background colour explicitly in order to prevent flicker. The default background colour under GTK+ is grey.
|
1436
1513
|
# To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table definition.
|
1437
1514
|
# You must use the device context returned by {Wx::EraseEvent#get_dc} to draw on, don't create a {Wx::PaintDC} in the event handler.
|
@@ -1455,6 +1532,7 @@ module Wx
|
|
1455
1532
|
def initialize(id=0, dc=nil) end
|
1456
1533
|
|
1457
1534
|
# Returns the device context associated with the erase event to draw on.
|
1535
|
+
#
|
1458
1536
|
# The returned pointer is never NULL.
|
1459
1537
|
# @return [Wx::DC]
|
1460
1538
|
def get_dc; end
|
@@ -1463,6 +1541,7 @@ module Wx
|
|
1463
1541
|
end # EraseEvent
|
1464
1542
|
|
1465
1543
|
# A focus event is sent when a window's focus changes.
|
1544
|
+
#
|
1466
1545
|
# The window losing focus receives a "kill focus" event while the window gaining it gets a "set focus" one.
|
1467
1546
|
# Notice that the set focus event happens both when the user gives focus to the window (whether using the mouse or keyboard) and when it is done from the program itself using {Wx::Window#set_focus}.
|
1468
1547
|
# The focus event handlers should almost invariably call {Wx::Event#skip} on their event argument to allow the default handling to take place. Failure to do this may result in incorrect behaviour of the native controls. Also note that {Wx::EVT_KILL_FOCUS} handler must not call {Wx::Window#set_focus} as this, again, is not supported by all native controls. If you need to do this, consider using the Delayed Action Mechanism described in {Wx::IdleEvent} documentation.
|
@@ -1482,12 +1561,13 @@ module Wx
|
|
1482
1561
|
class FocusEvent < Event
|
1483
1562
|
|
1484
1563
|
# Constructor.
|
1485
|
-
# @param eventType [Wx::
|
1564
|
+
# @param eventType [Wx::StaticLine::EventType]
|
1486
1565
|
# @param id [Integer]
|
1487
1566
|
# @return [Wx::FocusEvent]
|
1488
1567
|
def initialize(eventType=Wx::EVT_NULL, id=0) end
|
1489
1568
|
|
1490
1569
|
# Returns the window associated with this event, that is the window which had the focus before for the {Wx::EVT_SET_FOCUS} event and the window which is going to receive focus for the {Wx::EVT_KILL_FOCUS} one.
|
1570
|
+
#
|
1491
1571
|
# Warning: the window pointer may be NULL!
|
1492
1572
|
# @return [Wx::Window]
|
1493
1573
|
def get_window; end
|
@@ -1501,6 +1581,7 @@ module Wx
|
|
1501
1581
|
end # FocusEvent
|
1502
1582
|
|
1503
1583
|
# An activate event is sent when a window or application is being activated or deactivated.
|
1584
|
+
#
|
1504
1585
|
# ### Events using this class
|
1505
1586
|
#
|
1506
1587
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ActivateEvent} events.
|
@@ -1542,10 +1623,10 @@ module Wx
|
|
1542
1623
|
end # Reason
|
1543
1624
|
|
1544
1625
|
# Constructor.
|
1545
|
-
# @param eventType [Wx::
|
1626
|
+
# @param eventType [Wx::StaticLine::EventType]
|
1546
1627
|
# @param active [Boolean]
|
1547
1628
|
# @param id [Integer]
|
1548
|
-
# @param activationReason [Wx::
|
1629
|
+
# @param activationReason [Wx::ActivateEvent::Reason]
|
1549
1630
|
# @return [Wx::ActivateEvent]
|
1550
1631
|
def initialize(eventType=Wx::EVT_NULL, active=true, id=0, activationReason=Wx::ActivateEvent::Reason::Reason_Unknown) end
|
1551
1632
|
|
@@ -1555,15 +1636,17 @@ module Wx
|
|
1555
1636
|
alias_method :active, :get_active
|
1556
1637
|
|
1557
1638
|
# Allows checking if the window was activated by clicking it with the mouse or in some other way.
|
1639
|
+
#
|
1558
1640
|
# This method is currently only implemented in WXMSW and returns Reason_Mouse there if the window was activated by a mouse click and Reason_Unknown if it was activated in any other way (e.g. from keyboard or programmatically).
|
1559
1641
|
# Under all the other platforms, Reason_Unknown is always returned.
|
1560
|
-
# @return [Wx::
|
1642
|
+
# @return [Wx::ActivateEvent::Reason]
|
1561
1643
|
def get_activation_reason; end
|
1562
1644
|
alias_method :activation_reason, :get_activation_reason
|
1563
1645
|
|
1564
1646
|
end # ActivateEvent
|
1565
1647
|
|
1566
1648
|
# A {Wx::InitDialogEvent} is sent as a dialog or panel is being initialised.
|
1649
|
+
#
|
1567
1650
|
# Handlers for this event can transfer data to the window.
|
1568
1651
|
# The default handler calls {Wx::Window#transfer_data_to_window}.
|
1569
1652
|
# ### Events using this class
|
@@ -1587,6 +1670,7 @@ module Wx
|
|
1587
1670
|
end # InitDialogEvent
|
1588
1671
|
|
1589
1672
|
# This class is used for a variety of menu-related events.
|
1673
|
+
#
|
1590
1674
|
# Note that these do not include menu command events, which are handled using {Wx::CommandEvent} objects.
|
1591
1675
|
# Events of this class are generated by both menus that are part of a {Wx::MenuBar}, attached to {Wx::Frame}, and popup menus shown by {Wx::Window#popup_menu}. They are sent to the following objects until one of them handles the event:
|
1592
1676
|
#
|
@@ -1618,31 +1702,34 @@ module Wx
|
|
1618
1702
|
class MenuEvent < Event
|
1619
1703
|
|
1620
1704
|
# Constructor.
|
1621
|
-
# @param type [Wx::
|
1705
|
+
# @param type [Wx::StaticLine::EventType]
|
1622
1706
|
# @param id [Integer]
|
1623
1707
|
# @param menu [Wx::Menu]
|
1624
1708
|
# @return [Wx::MenuEvent]
|
1625
1709
|
def initialize(type=Wx::EVT_NULL, id=0, menu=nil) end
|
1626
1710
|
|
1627
1711
|
# Returns the menu which is being opened or closed, or the menu containing the highlighted item.
|
1712
|
+
#
|
1628
1713
|
# Note that the returned value can be NULL if the menu being opened doesn't have a corresponding {Wx::Menu}, e.g. this happens when opening the system menu in WXMSW port.
|
1629
1714
|
#
|
1630
1715
|
# <div class="wxrb-remark">
|
1631
1716
|
# <b>Remark:</b>
|
1632
1717
|
# <p>Since 3.1.3 this function can be used with OPEN, CLOSE and HIGHLIGHT events. Before 3.1.3, this method can only be used with the OPEN and CLOSE events.
|
1633
1718
|
# </p>
|
1634
|
-
# </div
|
1719
|
+
# </div>
|
1635
1720
|
# @return [Wx::Menu]
|
1636
1721
|
def get_menu; end
|
1637
1722
|
alias_method :menu, :get_menu
|
1638
1723
|
|
1639
1724
|
# Returns the menu identifier associated with the event.
|
1725
|
+
#
|
1640
1726
|
# This method should be only used with the HIGHLIGHT events.
|
1641
1727
|
# @return [Integer]
|
1642
1728
|
def get_menu_id; end
|
1643
1729
|
alias_method :menu_id, :get_menu_id
|
1644
1730
|
|
1645
1731
|
# Returns true if the menu which is being opened or closed is a popup menu, false if it is a normal one.
|
1732
|
+
#
|
1646
1733
|
# This method should only be used with the OPEN and CLOSE events.
|
1647
1734
|
# @return [Boolean]
|
1648
1735
|
def is_popup; end
|
@@ -1651,6 +1738,7 @@ module Wx
|
|
1651
1738
|
end # MenuEvent
|
1652
1739
|
|
1653
1740
|
# This event class contains information about window and session close events.
|
1741
|
+
#
|
1654
1742
|
# The handler function for EVT_CLOSE is called when the user has tried to close a a frame or dialog box using the window manager (X) or system menu (Windows). It can also be invoked by the application itself programmatically, for example by calling the {Wx::Window#close} function.
|
1655
1743
|
# You should check whether the application is forcing the deletion of the window using {Wx::CloseEvent#can_veto}. If this is false, you must destroy the window using {Wx::Window#destroy}.
|
1656
1744
|
# If the return value is true, it is up to you whether you respond by destroying the window.
|
@@ -1694,18 +1782,20 @@ module Wx
|
|
1694
1782
|
class CloseEvent < Event
|
1695
1783
|
|
1696
1784
|
# Constructor.
|
1697
|
-
# @param commandEventType [Wx::
|
1785
|
+
# @param commandEventType [Wx::StaticLine::EventType]
|
1698
1786
|
# @param id [Integer]
|
1699
1787
|
# @return [Wx::CloseEvent]
|
1700
1788
|
def initialize(commandEventType=Wx::EVT_NULL, id=0) end
|
1701
1789
|
|
1702
1790
|
# Returns true if you can veto a system shutdown or a window close event.
|
1791
|
+
#
|
1703
1792
|
# Vetoing a window close event is not possible if the calling code wishes to force the application to exit, and so this function must be called to check this.
|
1704
1793
|
# @return [Boolean]
|
1705
1794
|
def can_veto; end
|
1706
1795
|
alias_method :can_veto?, :can_veto
|
1707
1796
|
|
1708
1797
|
# Returns true if the user is just logging off or false if the system is shutting down.
|
1798
|
+
#
|
1709
1799
|
# This method can only be called for end session and query end session events, it doesn't make sense for close window event.
|
1710
1800
|
# @return [Boolean]
|
1711
1801
|
def get_logging_off; end
|
@@ -1724,6 +1814,7 @@ module Wx
|
|
1724
1814
|
alias_method :logging_off=, :set_logging_off
|
1725
1815
|
|
1726
1816
|
# Call this from your event handler to veto a system shutdown or to signal to the calling application that a window close did not happen.
|
1817
|
+
#
|
1727
1818
|
# You can only veto a shutdown if {Wx::CloseEvent#can_veto} returns true.
|
1728
1819
|
# @param veto [Boolean]
|
1729
1820
|
# @return [void]
|
@@ -1736,6 +1827,7 @@ module Wx
|
|
1736
1827
|
end # CloseEvent
|
1737
1828
|
|
1738
1829
|
# An event being sent when the window is shown or hidden.
|
1830
|
+
#
|
1739
1831
|
# The event is triggered by calls to {Wx::Window#show}, and any user action showing a previously hidden window or vice versa (if allowed by the current platform and/or window manager). Notice that the event is not triggered when the application is iconized (minimized) or restored under WXMSW.
|
1740
1832
|
# ### Events using this class
|
1741
1833
|
#
|
@@ -1772,6 +1864,7 @@ module Wx
|
|
1772
1864
|
end # ShowEvent
|
1773
1865
|
|
1774
1866
|
# An event being sent when the frame is iconized (minimized) or restored.
|
1867
|
+
#
|
1775
1868
|
# ### Events using this class
|
1776
1869
|
#
|
1777
1870
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::IconizeEvent} events.
|
@@ -1801,6 +1894,7 @@ module Wx
|
|
1801
1894
|
end # IconizeEvent
|
1802
1895
|
|
1803
1896
|
# An event being sent when a top level window is maximized.
|
1897
|
+
#
|
1804
1898
|
# Notice that it is not sent when the window is restored to its original size after it had been maximized, only a normal {Wx::SizeEvent} is generated in this case.
|
1805
1899
|
# Currently this event is only generated in WXMSW, WXGTK and WXOSX/Cocoa ports so portable programs should only rely on receiving {Wx::EVT_SIZE} and not necessarily this event when the window is maximized.
|
1806
1900
|
# ### Events using this class
|
@@ -1819,6 +1913,7 @@ module Wx
|
|
1819
1913
|
class MaximizeEvent < Event
|
1820
1914
|
|
1821
1915
|
# Constructor.
|
1916
|
+
#
|
1822
1917
|
# Only used by wxWidgets internally.
|
1823
1918
|
# @param id [Integer]
|
1824
1919
|
# @return [Wx::MaximizeEvent]
|
@@ -1827,6 +1922,7 @@ module Wx
|
|
1827
1922
|
end # MaximizeEvent
|
1828
1923
|
|
1829
1924
|
# An event being sent when the user enters or exits full screen mode.
|
1925
|
+
#
|
1830
1926
|
# Currently this event is only generated in the WXOSX/Cocoa port when {Wx::TopLevelWindow#enable_full_screen_view} is enabled and the user the user enters or exits full screen. Note that this event is not generated when {Wx::TopLevelWindow#show_full_screen}.
|
1831
1927
|
# ### Events using this class
|
1832
1928
|
#
|
@@ -1857,6 +1953,7 @@ module Wx
|
|
1857
1953
|
end # FullScreenEvent
|
1858
1954
|
|
1859
1955
|
# This event class contains information about joystick events, particularly events received by windows.
|
1956
|
+
#
|
1860
1957
|
# ### Events using this class
|
1861
1958
|
#
|
1862
1959
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::JoystickEvent} events.
|
@@ -1879,7 +1976,7 @@ module Wx
|
|
1879
1976
|
class JoystickEvent < Event
|
1880
1977
|
|
1881
1978
|
# Constructor.
|
1882
|
-
# @param eventType [Wx::
|
1979
|
+
# @param eventType [Wx::StaticLine::EventType]
|
1883
1980
|
# @param state [Integer]
|
1884
1981
|
# @param joystick [Integer]
|
1885
1982
|
# @param change [Integer]
|
@@ -1902,6 +1999,7 @@ module Wx
|
|
1902
1999
|
def button_up(button=Wx::JOY_BUTTON_ANY) end
|
1903
2000
|
|
1904
2001
|
# Returns the identifier of the button changing state.
|
2002
|
+
#
|
1905
2003
|
# The return value is
|
1906
2004
|
# ```
|
1907
2005
|
# 1 << n
|
@@ -1914,12 +2012,14 @@ module Wx
|
|
1914
2012
|
|
1915
2013
|
# Returns the 0-indexed ordinal of the button changing state.
|
1916
2014
|
#
|
2015
|
+
#
|
1917
2016
|
# @see Wx::JoystickEvent#get_button_change
|
1918
2017
|
# @return [Integer]
|
1919
2018
|
def get_button_ordinal; end
|
1920
2019
|
alias_method :button_ordinal, :get_button_ordinal
|
1921
2020
|
|
1922
2021
|
# Returns the down state of the buttons.
|
2022
|
+
#
|
1923
2023
|
# This is a {Wx::JOY_BUTTONn} identifier, where n is one of 1, 2, 3, 4.
|
1924
2024
|
# @return [Integer]
|
1925
2025
|
def get_button_state; end
|
@@ -1931,12 +2031,14 @@ module Wx
|
|
1931
2031
|
alias_method :joystick, :get_joystick
|
1932
2032
|
|
1933
2033
|
# Returns the x, y position of the joystick event.
|
2034
|
+
#
|
1934
2035
|
# These coordinates are valid for all the events except {Wx::EVT_JOY_ZMOVE}.
|
1935
2036
|
# @return [Wx::Point]
|
1936
2037
|
def get_position; end
|
1937
2038
|
alias_method :position, :get_position
|
1938
2039
|
|
1939
2040
|
# Returns the z position of the joystick event.
|
2041
|
+
#
|
1940
2042
|
# This method can only be used for {Wx::EVT_JOY_ZMOVE} events.
|
1941
2043
|
# @return [Integer]
|
1942
2044
|
def get_z_position; end
|
@@ -1960,6 +2062,7 @@ module Wx
|
|
1960
2062
|
end # JoystickEvent
|
1961
2063
|
|
1962
2064
|
# This class is used for drop files events, that is, when files have been dropped onto the window.
|
2065
|
+
#
|
1963
2066
|
# The window must have previously been enabled for dropping by calling {Wx::Window#drag_accept_files}.
|
1964
2067
|
# Important note: this is a separate implementation to the more general drag and drop implementation documented in the Drag and Drop Overview. It uses the older, Windows message-based approach of dropping files.
|
1965
2068
|
# ### Events using this class
|
@@ -1973,7 +2076,7 @@ module Wx
|
|
1973
2076
|
# <b>Remark:</b>
|
1974
2077
|
# <p>Windows only until version 2.8.9, available on all platforms since 2.8.10.
|
1975
2078
|
# </p>
|
1976
|
-
# </div
|
2079
|
+
# </div>
|
1977
2080
|
#
|
1978
2081
|
# Category: {Wx::Events}
|
1979
2082
|
# @see Events and Event Handling
|
@@ -1983,7 +2086,7 @@ module Wx
|
|
1983
2086
|
class DropFilesEvent < Event
|
1984
2087
|
|
1985
2088
|
# Constructor.
|
1986
|
-
# @param id [Wx::
|
2089
|
+
# @param id [Wx::StaticLine::EventType]
|
1987
2090
|
# @param noFiles [Integer]
|
1988
2091
|
# @param files [String]
|
1989
2092
|
# @return [Wx::DropFilesEvent]
|
@@ -2000,6 +2103,7 @@ module Wx
|
|
2000
2103
|
alias_method :number_of_files, :get_number_of_files
|
2001
2104
|
|
2002
2105
|
# Returns the position at which the files were dropped.
|
2106
|
+
#
|
2003
2107
|
# Returns an array of filenames.
|
2004
2108
|
# @return [Wx::Point]
|
2005
2109
|
def get_position; end
|
@@ -2008,6 +2112,7 @@ module Wx
|
|
2008
2112
|
end # DropFilesEvent
|
2009
2113
|
|
2010
2114
|
# This class is used for pseudo-events which are called by wxWidgets to give an application the chance to update various user interface elements.
|
2115
|
+
#
|
2011
2116
|
# Without update UI events, an application has to work hard to check/uncheck, enable/disable, show/hide, and set the text for elements such as menu items and toolbar buttons. The code for doing this has to be mixed up with the code that is invoked when an action is invoked for a menu item or button.
|
2012
2117
|
# With update UI events, you define an event handler to look at the state of the application and change UI elements accordingly. wxWidgets will call your member functions in idle time, so you don't have to worry where to call this code.
|
2013
2118
|
# In addition to being a clearer and more declarative method, it also means you don't have to worry whether you're updating a toolbar or menubar identifier. The same handler can update a menu item and toolbar button, if the identifier is the same. Instead of directly manipulating the menu or button, you call functions in the event object, such as {Wx::UpdateUIEvent#check}. wxWidgets will determine whether such a call has been made, and which UI element to update.
|
@@ -2061,6 +2166,7 @@ module Wx
|
|
2061
2166
|
alias_method :enabled, :get_enabled
|
2062
2167
|
|
2063
2168
|
# Returns true if the UI element can be checked.
|
2169
|
+
#
|
2064
2170
|
# For the event handlers that can be used for multiple items, not all of which can be checked, this method can be useful to determine whether to call {Wx::UpdateUIEvent#check} on the event object or not, i.e. the main use case for this method is:
|
2065
2171
|
# ```ruby
|
2066
2172
|
# def on_update_ui(event)
|
@@ -2074,24 +2180,28 @@ module Wx
|
|
2074
2180
|
alias_method :checkable?, :is_checkable
|
2075
2181
|
|
2076
2182
|
# Returns true if the application has called {Wx::UpdateUIEvent#check}.
|
2183
|
+
#
|
2077
2184
|
# For wxWidgets internal use only.
|
2078
2185
|
# @return [Boolean]
|
2079
2186
|
def get_set_checked; end
|
2080
2187
|
alias_method :set_checked, :get_set_checked
|
2081
2188
|
|
2082
2189
|
# Returns true if the application has called {Wx::UpdateUIEvent#enable}.
|
2190
|
+
#
|
2083
2191
|
# For wxWidgets internal use only.
|
2084
2192
|
# @return [Boolean]
|
2085
2193
|
def get_set_enabled; end
|
2086
2194
|
alias_method :set_enabled, :get_set_enabled
|
2087
2195
|
|
2088
2196
|
# Returns true if the application has called {Wx::UpdateUIEvent#show}.
|
2197
|
+
#
|
2089
2198
|
# For wxWidgets internal use only.
|
2090
2199
|
# @return [Boolean]
|
2091
2200
|
def get_set_shown; end
|
2092
2201
|
alias_method :set_shown, :get_set_shown
|
2093
2202
|
|
2094
2203
|
# Returns true if the application has called {Wx::UpdateUIEvent#set_text}.
|
2204
|
+
#
|
2095
2205
|
# For wxWidgets internal use only.
|
2096
2206
|
# @return [Boolean]
|
2097
2207
|
def get_set_text; end
|
@@ -2118,6 +2228,7 @@ module Wx
|
|
2118
2228
|
def show(show) end
|
2119
2229
|
|
2120
2230
|
# Returns true if it is appropriate to update (send UI update events to) this window.
|
2231
|
+
#
|
2121
2232
|
# This function looks at the mode used (see {Wx::UpdateUIEvent.set_mode}), the {Wx::WS_EX_PROCESS_UI_UPDATES} flag in window, the time update events were last sent in idle time, and the update interval, to determine whether events should be sent to this window now. By default this will always return true because the update mode is initially {Wx::UpdateUIMode::UPDATE_UI_PROCESS_ALL} and the interval is set to 0; so update events will be sent as often as possible. You can reduce the frequency that events are sent by changing the mode and/or setting an update interval.
|
2122
2233
|
# @see Wx::UpdateUIEvent.reset_update_time
|
2123
2234
|
# @see Wx::UpdateUIEvent.set_update_interval
|
@@ -2128,17 +2239,20 @@ module Wx
|
|
2128
2239
|
|
2129
2240
|
# Static function returning a value specifying how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events.
|
2130
2241
|
#
|
2242
|
+
#
|
2131
2243
|
# @see Wx::UpdateUIEvent.set_mode
|
2132
2244
|
# @return [Wx::UpdateUIMode]
|
2133
2245
|
def self.get_mode; end
|
2134
2246
|
|
2135
2247
|
# Returns the current interval between updates in milliseconds.
|
2248
|
+
#
|
2136
2249
|
# The value -1 disables updates, 0 updates as frequently as possible.
|
2137
2250
|
# @see Wx::UpdateUIEvent.set_update_interval.
|
2138
2251
|
# @return [Integer]
|
2139
2252
|
def self.get_update_interval; end
|
2140
2253
|
|
2141
2254
|
# Used internally to reset the last-updated time to the current time.
|
2255
|
+
#
|
2142
2256
|
# It is assumed that update events are normally sent in idle time, so this is called at the end of idle processing.
|
2143
2257
|
# @see Wx::UpdateUIEvent.can_update
|
2144
2258
|
# @see Wx::UpdateUIEvent.set_update_interval
|
@@ -2152,6 +2266,7 @@ module Wx
|
|
2152
2266
|
def self.set_mode(mode) end
|
2153
2267
|
|
2154
2268
|
# Sets the interval between updates in milliseconds.
|
2269
|
+
#
|
2155
2270
|
# Set to -1 to disable updates, or to 0 to update as frequently as possible. The default is 0.
|
2156
2271
|
# Use this to reduce the overhead of UI update events if your application has a lot of windows. If you set the value to -1 or greater than 0, you may also need to call {Wx::Window#update_window_ui} at appropriate points in your application, such as when a dialog is about to be shown.
|
2157
2272
|
# @param updateInterval [Integer]
|
@@ -2161,13 +2276,14 @@ module Wx
|
|
2161
2276
|
end # UpdateUIEvent
|
2162
2277
|
|
2163
2278
|
# This class is used for system colour change events, which are generated when the user changes the colour settings or when the system theme changes (e.g. automatic dark mode switching on macOS).
|
2279
|
+
#
|
2164
2280
|
# Event handlers for this event can access the new system colour settings through {Wx::SystemSettings.get_colour}.
|
2165
2281
|
#
|
2166
2282
|
# <div class="wxrb-remark">
|
2167
2283
|
# <b>Remark:</b>
|
2168
2284
|
# <p>The default event handler for this event propagates the event to child windows, since the system events are only sent to top-level windows. If intercepting this event for a top-level window, remember to either call {Wx::Event#skip} on the event, call the base class handler, or pass the event on to the window's children explicitly.
|
2169
2285
|
# </p>
|
2170
|
-
# </div
|
2286
|
+
# </div>
|
2171
2287
|
#
|
2172
2288
|
# ### Events using this class
|
2173
2289
|
#
|
@@ -2189,6 +2305,7 @@ module Wx
|
|
2189
2305
|
end # SysColourChangedEvent
|
2190
2306
|
|
2191
2307
|
# A mouse capture changed event is sent to a window that loses its mouse capture.
|
2308
|
+
#
|
2192
2309
|
# This is called even if {Wx::Window#release_mouse} was called by the application code. Handling this event allows an application to cater for unexpected capture releases which might otherwise confuse mouse handling code.
|
2193
2310
|
# Availability: only available for the WXMSW port.
|
2194
2311
|
# ### Events using this class
|
@@ -2222,6 +2339,7 @@ module Wx
|
|
2222
2339
|
end # MouseCaptureChangedEvent
|
2223
2340
|
|
2224
2341
|
# A mouse capture lost event is sent to a window that had obtained mouse capture, which was subsequently lost due to an "external" event (for example, when a dialog box is shown or if another application captures the mouse).
|
2342
|
+
#
|
2225
2343
|
# If this happens, this event is sent to all windows that are on the capture stack (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is not sent if the capture changes because of a call to CaptureMouse or ReleaseMouse.
|
2226
2344
|
# This event is currently emitted under Windows only.
|
2227
2345
|
# ### Events using this class
|
@@ -2251,6 +2369,7 @@ module Wx
|
|
2251
2369
|
end # MouseCaptureLostEvent
|
2252
2370
|
|
2253
2371
|
# A display changed event is sent to top-level windows when the display resolution has changed.
|
2372
|
+
#
|
2254
2373
|
# This event is currently emitted under Windows only.
|
2255
2374
|
# ### Events using this class
|
2256
2375
|
#
|
@@ -2273,6 +2392,7 @@ module Wx
|
|
2273
2392
|
end # DisplayChangedEvent
|
2274
2393
|
|
2275
2394
|
# Event sent when the display scale factor or pixel density (measured in dots-per-inch, or DPI) of the monitor a window is on changes.
|
2395
|
+
#
|
2276
2396
|
# The event is sent to each {Wx::TopLevelWindow} affected by the change, and all its children recursively (post-order traversal). For example, this event is sent to the window when it is moved, by the user, from a display using some DPI value to another display using a different DPI value. It also sent to all program windows on the given display if its DPI changes due to a change in the system settings.
|
2277
2397
|
# If you define an event handler for this event, you should almost always call <code>event.Skip()</code> in it in order to allow the base class handler to execute, as many controls rely on processing this event in order to update their appearance when the DPI changes. However the default handler for the top level window itself only sets the new window size, by scaling the current size by the DPI ratio e.g. doubling it if the DPI has changed from normal to "high", i.e. 200%, one and also ensuring that the window is still bigger than its best size, as returned by {Wx::Window#get_best_size}. Note that in some cases this may cause the window size to grow unexpectedly and you may prefer to call {Wx::Window#set_size} in your handler of this event for the top level window and not call <code>event.Skip()</code> to prevent the default handler from resizing the window.
|
2278
2398
|
# Currently this event is generated by WXMSW port if only and only if the MSW application runs under Windows 10 Creators Update (v1703) or later and is marked as being "per-monitor DPI aware", i.e. contains a dpiAwareness tag with the value "PerMonitorV2" in its manifest (see Microsoft "Application Manifests" documentation for more details).
|
@@ -2300,6 +2420,7 @@ module Wx
|
|
2300
2420
|
alias_method :new_dpi, :get_new_dpi
|
2301
2421
|
|
2302
2422
|
# Rescale a value in pixels to match the new DPI.
|
2423
|
+
#
|
2303
2424
|
# This is a convenience function to use in {Wx::EVT_DPI_CHANGED} event handlers, as they often need to update some sizes to the new DPI. It simply calls {mul_div_int32} with new and old DPI values, but is more readable and less error-prone.
|
2304
2425
|
# For example, the returned value will be twice bigger than the original one when switching from normal (96) DPI to high (2x, 192) DPI.
|
2305
2426
|
# @param sz [Wx::Size]
|
@@ -2307,12 +2428,14 @@ module Wx
|
|
2307
2428
|
def scale(sz) end
|
2308
2429
|
|
2309
2430
|
# Rescale horizontal component to match the new DPI.
|
2431
|
+
#
|
2310
2432
|
# This is the same as {Wx::DPIChangedEvent#scale}, but for the horizontal component only.
|
2311
2433
|
# @param x [Integer]
|
2312
2434
|
# @return [Integer]
|
2313
2435
|
def scale_x(x) end
|
2314
2436
|
|
2315
2437
|
# Rescale vertical component to match the new DPI.
|
2438
|
+
#
|
2316
2439
|
# This is the same as {Wx::DPIChangedEvent#scale}, but for the vertical component only.
|
2317
2440
|
# @param y [Integer]
|
2318
2441
|
# @return [Integer]
|
@@ -2323,6 +2446,7 @@ module Wx
|
|
2323
2446
|
#
|
2324
2447
|
#
|
2325
2448
|
#
|
2449
|
+
#
|
2326
2450
|
class PaletteChangedEvent < Event
|
2327
2451
|
|
2328
2452
|
# @param winid [Integer]
|
@@ -2343,6 +2467,7 @@ module Wx
|
|
2343
2467
|
#
|
2344
2468
|
#
|
2345
2469
|
#
|
2470
|
+
#
|
2346
2471
|
class QueryNewPaletteEvent < Event
|
2347
2472
|
|
2348
2473
|
# @param winid [Integer]
|
@@ -2361,6 +2486,7 @@ module Wx
|
|
2361
2486
|
end # QueryNewPaletteEvent
|
2362
2487
|
|
2363
2488
|
# This event class contains information about navigation events, generated by navigation keys such as tab and page down.
|
2489
|
+
#
|
2364
2490
|
# This event is mainly used by wxWidgets implementations. A {Wx::NavigationKeyEvent} handler is automatically provided by wxWidgets when you enable keyboard navigation inside a window by inheriting it from {Wx::NavigationEnabled}<>.
|
2365
2491
|
# ### Events using this class
|
2366
2492
|
#
|
@@ -2418,6 +2544,7 @@ module Wx
|
|
2418
2544
|
alias_method :direction, :get_direction
|
2419
2545
|
|
2420
2546
|
# Returns true if the navigation event was from a tab key.
|
2547
|
+
#
|
2421
2548
|
# This is required for proper navigation over radio buttons.
|
2422
2549
|
# @return [Boolean]
|
2423
2550
|
def is_from_tab; end
|
@@ -2441,6 +2568,7 @@ module Wx
|
|
2441
2568
|
alias_method :direction=, :set_direction
|
2442
2569
|
|
2443
2570
|
# Sets the flags for this event.
|
2571
|
+
#
|
2444
2572
|
# The flags can be a combination of the {Wx::NavigationKeyEvent::NavigationKeyEventFlags} values.
|
2445
2573
|
# @param flags [Integer]
|
2446
2574
|
# @return [void]
|
@@ -2462,6 +2590,7 @@ module Wx
|
|
2462
2590
|
end # NavigationKeyEvent
|
2463
2591
|
|
2464
2592
|
# This event is sent just after the actual window associated with a {Wx::Window} object has been created.
|
2593
|
+
#
|
2465
2594
|
# Since it is derived from {Wx::CommandEvent}, the event propagates up the window hierarchy.
|
2466
2595
|
# ### Events using this class
|
2467
2596
|
#
|
@@ -2490,6 +2619,7 @@ module Wx
|
|
2490
2619
|
end # WindowCreateEvent
|
2491
2620
|
|
2492
2621
|
# This event is sent as early as possible during the window destruction process.
|
2622
|
+
#
|
2493
2623
|
# For the top level windows, as early as possible means that this is done by {Wx::Frame} or {Wx::Dialog} destructor, i.e. after the destructor of the derived class was executed and so any methods specific to the derived class can't be called any more from this event handler. If you need to do this, you must call {Wx::Window#send_destroy_event} from your derived class destructor.
|
2494
2624
|
# For the child windows, this event is generated just before deleting the window from {Wx::Window#destroy} (which is also called when the parent window is deleted) or from the window destructor if operator delete was used directly (which is not recommended for this very reason).
|
2495
2625
|
# It is usually pointless to handle this event in the window itself but it ca be very useful to receive notifications about the window destruction in the parent window or in any other object interested in this window.
|
@@ -2514,6 +2644,7 @@ module Wx
|
|
2514
2644
|
end # WindowDestroyEvent
|
2515
2645
|
|
2516
2646
|
# A help event is sent when the user has requested context-sensitive help.
|
2647
|
+
#
|
2517
2648
|
# This can either be caused by the application requesting context-sensitive help mode via {Wx::ContextHelp}, or (on MS Windows) by the system generating a WM_HELP message when the user pressed F1 or clicked on the query button in a dialog caption.
|
2518
2649
|
# A help event is sent to the window that the user clicked on, and is propagated up the window hierarchy until the event is processed or there are no more event handlers.
|
2519
2650
|
# The application should call {Wx::Event#get_id} to check the identity of the clicked-on window, and then either show some suitable help or call {Wx::Event#skip} if the identifier is unrecognised.
|
@@ -2556,21 +2687,23 @@ module Wx
|
|
2556
2687
|
end # Origin
|
2557
2688
|
|
2558
2689
|
# Constructor.
|
2559
|
-
# @param type [Wx::
|
2690
|
+
# @param type [Wx::StaticLine::EventType]
|
2560
2691
|
# @param winid [Integer]
|
2561
2692
|
# @param pt [Array(Integer, Integer), Wx::Point]
|
2562
|
-
# @param origin [Wx::
|
2693
|
+
# @param origin [Wx::HelpEvent::Origin]
|
2563
2694
|
# @return [Wx::HelpEvent]
|
2564
2695
|
def initialize(type=Wx::EVT_NULL, winid=0, pt=Wx::DEFAULT_POSITION, origin=Wx::HelpEvent::Origin::Origin_Unknown) end
|
2565
2696
|
|
2566
2697
|
# Returns the origin of the help event which is one of the {Wx::HelpEvent::Origin} values.
|
2698
|
+
#
|
2567
2699
|
# The application may handle events generated using the keyboard or mouse differently, e.g. by using {get_mouse_position} for the mouse events.
|
2568
2700
|
# @see Wx::HelpEvent#set_origin
|
2569
|
-
# @return [Wx::
|
2701
|
+
# @return [Wx::HelpEvent::Origin]
|
2570
2702
|
def get_origin; end
|
2571
2703
|
alias_method :origin, :get_origin
|
2572
2704
|
|
2573
2705
|
# Returns the left-click position of the mouse, in screen coordinates.
|
2706
|
+
#
|
2574
2707
|
# This allows the application to position the help appropriately.
|
2575
2708
|
# @return [Wx::Point]
|
2576
2709
|
def get_position; end
|
@@ -2578,8 +2711,9 @@ module Wx
|
|
2578
2711
|
|
2579
2712
|
# Set the help event origin, only used internally by wxWidgets normally.
|
2580
2713
|
#
|
2714
|
+
#
|
2581
2715
|
# @see Wx::HelpEvent#get_origin
|
2582
|
-
# @param origin [Wx::
|
2716
|
+
# @param origin [Wx::HelpEvent::Origin]
|
2583
2717
|
# @return [void]
|
2584
2718
|
def set_origin(origin) end
|
2585
2719
|
alias_method :origin=, :set_origin
|
@@ -2593,6 +2727,7 @@ module Wx
|
|
2593
2727
|
end # HelpEvent
|
2594
2728
|
|
2595
2729
|
# This class represents the events generated by a control (typically a {Wx::TextCtrl} but other windows can generate these events as well) when its content gets copied or cut to, or pasted from the clipboard.
|
2730
|
+
#
|
2596
2731
|
# There are three types of corresponding events {Wx::EVT_TEXT_COPY}, {Wx::EVT_TEXT_CUT} and {Wx::EVT_TEXT_PASTE}.
|
2597
2732
|
# If any of these events is processed (without being skipped) by an event handler, the corresponding operation doesn't take place which allows preventing the text from being copied from or pasted to a control. It is also possible to examine the clipboard contents in the PASTE event handler and transform it in some way before inserting in a control for example, changing its case or removing invalid characters.
|
2598
2733
|
# Finally notice that a CUT event is always preceded by the COPY event which makes it possible to only process the latter if it doesn't matter if the text was copied or cut.
|
@@ -2621,7 +2756,7 @@ module Wx
|
|
2621
2756
|
class ClipboardTextEvent < CommandEvent
|
2622
2757
|
|
2623
2758
|
# Constructor.
|
2624
|
-
# @param commandType [Wx::
|
2759
|
+
# @param commandType [Wx::StaticLine::EventType]
|
2625
2760
|
# @param id [Integer]
|
2626
2761
|
# @return [Wx::ClipboardTextEvent]
|
2627
2762
|
def initialize(commandType=Wx::EVT_NULL, id=0) end
|
@@ -2629,6 +2764,7 @@ module Wx
|
|
2629
2764
|
end # ClipboardTextEvent
|
2630
2765
|
|
2631
2766
|
# This class is used for context menu events, sent to give the application a chance to show a context (popup) menu for a {Wx::Window}.
|
2767
|
+
#
|
2632
2768
|
# Note that if {Wx::ContextMenuEvent#get_position} returns {Wx::DEFAULT_POSITION}, this means that the event originated from a keyboard context button event, and you should compute a suitable position yourself, for example by calling {get_mouse_position}.
|
2633
2769
|
# Notice that the exact sequence of mouse events is different across the platforms. For example, under MSW the context menu event is generated after EVT_RIGHT_UP event and only if it was not handled but under GTK the context menu event is generated after EVT_RIGHT_DOWN event. This is correct in the sense that it ensures that the context menu is shown according to the current platform UI conventions and also means that you must not handle (or call {Wx::Event#skip} in your handler if you do have one) neither right mouse down nor right mouse up event if you plan on handling EVT_CONTEXT_MENU event.
|
2634
2770
|
# ### Events using this class
|
@@ -2646,13 +2782,14 @@ module Wx
|
|
2646
2782
|
class ContextMenuEvent < CommandEvent
|
2647
2783
|
|
2648
2784
|
# Constructor.
|
2649
|
-
# @param type [Wx::
|
2785
|
+
# @param type [Wx::StaticLine::EventType]
|
2650
2786
|
# @param id [Integer]
|
2651
2787
|
# @param pos [Array(Integer, Integer), Wx::Point]
|
2652
2788
|
# @return [Wx::ContextMenuEvent]
|
2653
2789
|
def initialize(type=Wx::EVT_NULL, id=0, pos=Wx::DEFAULT_POSITION) end
|
2654
2790
|
|
2655
2791
|
# Returns the position in screen coordinates at which the menu should be shown.
|
2792
|
+
#
|
2656
2793
|
# Use {Wx::Window#screen_to_client} to convert to client coordinates.
|
2657
2794
|
# You can also omit a position from {Wx::Window#popup_menu} in order to use the current mouse pointer position.
|
2658
2795
|
# If the event originated from a keyboard event, the value returned from this function will be {Wx::DEFAULT_POSITION}.
|
@@ -2669,6 +2806,7 @@ module Wx
|
|
2669
2806
|
end # ContextMenuEvent
|
2670
2807
|
|
2671
2808
|
# A child focus event is sent to a (parent-)window when one of its child windows gains focus, so that the window could restore the focus back to its corresponding child if it loses it now and regains later.
|
2809
|
+
#
|
2672
2810
|
# Notice that child window is the direct child of the window receiving event. Use {Wx::Window.find_focus} to retrieve the window which is actually getting focus.
|
2673
2811
|
# ### Events using this class
|
2674
2812
|
#
|
@@ -2689,6 +2827,7 @@ module Wx
|
|
2689
2827
|
def initialize(win=nil) end
|
2690
2828
|
|
2691
2829
|
# Returns the direct child which receives the focus, or a (grand-)parent of the control receiving the focus.
|
2830
|
+
#
|
2692
2831
|
# To get the actually focused control use {Wx::Window.find_focus}.
|
2693
2832
|
# @return [Wx::Window]
|
2694
2833
|
def get_window; end
|