wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-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 +30 -8
- data/README.md +3 -3
- data/ext/mkrf_conf_bingem.rb +4 -1
- 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/accessors.rb +10 -2
- data/lib/wx/aui/auifloatframe.rb +20 -0
- data/lib/wx/aui/auimanager.rb +3 -0
- data/lib/wx/aui/auinotebook.rb +17 -0
- data/lib/wx/aui/events/evt_list.rb +7 -7
- data/lib/wx/aui/require.rb +5 -1
- data/lib/wx/aui.rb +4 -1
- data/lib/wx/core/acceleratortable.rb +8 -0
- data/lib/wx/core/animation.rb +8 -0
- data/lib/wx/core/app.rb +8 -0
- data/lib/wx/core/array_ext.rb +7 -0
- data/lib/wx/core/art_locator.rb +7 -0
- data/lib/wx/core/artprovider.rb +9 -0
- data/lib/wx/core/bitmap.rb +16 -4
- data/lib/wx/core/bitmap_combobox.rb +7 -0
- data/lib/wx/core/brush.rb +7 -0
- data/lib/wx/core/busycursor.rb +9 -0
- data/lib/wx/core/choice.rb +7 -0
- data/lib/wx/core/choicedlg.rb +7 -0
- data/lib/wx/core/clientdc.rb +9 -0
- data/lib/wx/core/clipboard.rb +8 -0
- data/lib/wx/core/collapsible_pane.rb +8 -1
- data/lib/wx/core/colour.rb +8 -0
- data/lib/wx/core/combo_ctrl.rb +110 -0
- data/lib/wx/core/combobox.rb +7 -0
- data/lib/wx/core/config.rb +303 -0
- data/lib/wx/core/controlwithitems.rb +12 -1
- data/lib/wx/core/cursor.rb +14 -4
- data/lib/wx/core/data_object.rb +7 -0
- data/lib/wx/core/dataformat.rb +9 -0
- data/lib/wx/core/datetime.rb +14 -0
- data/lib/wx/core/dc.rb +7 -0
- data/lib/wx/core/dialog.rb +18 -1
- data/lib/wx/core/enum.rb +7 -0
- data/lib/wx/core/event.rb +7 -0
- data/lib/wx/core/event_blocker.rb +7 -0
- data/lib/wx/core/event_loop.rb +14 -0
- data/lib/wx/core/events/evt_list.rb +76 -0
- data/lib/wx/core/evthandler.rb +8 -0
- data/lib/wx/core/ext.rb +7 -0
- data/lib/wx/core/file_dialog.rb +23 -0
- data/lib/wx/core/find_replace_dialog.rb +7 -0
- data/lib/wx/core/functions.rb +8 -0
- data/lib/wx/core/gauge.rb +10 -1
- data/lib/wx/core/genericdirctrl.rb +9 -0
- data/lib/wx/core/hboxsizer.rb +16 -0
- data/lib/wx/core/helpcontroller.rb +8 -0
- data/lib/wx/core/helpcontrollerhelpprovider.rb +9 -0
- data/lib/wx/core/helpprovider.rb +10 -1
- data/lib/wx/core/icon.rb +17 -6
- data/lib/wx/core/id_helper.rb +7 -0
- data/lib/wx/core/image.rb +49 -4
- data/lib/wx/core/imagelist.rb +8 -1
- data/lib/wx/core/listbox.rb +7 -0
- data/lib/wx/core/listctrl.rb +26 -13
- data/lib/wx/core/locale.rb +8 -0
- data/lib/wx/core/log.rb +114 -0
- data/lib/wx/core/menu.rb +9 -0
- data/lib/wx/core/menu_bar.rb +7 -0
- data/lib/wx/core/menuitem.rb +9 -0
- data/lib/wx/core/notebook.rb +9 -0
- data/lib/wx/core/object.rb +9 -0
- data/lib/wx/core/paintdc.rb +7 -0
- data/lib/wx/core/pen.rb +7 -0
- data/lib/wx/core/pen_info.rb +7 -0
- data/lib/wx/core/platform_info.rb +7 -0
- data/lib/wx/core/point.rb +8 -0
- data/lib/wx/core/real_point.rb +8 -0
- data/lib/wx/core/rect.rb +9 -0
- data/lib/wx/core/region_iterator.rb +7 -0
- data/lib/wx/core/simplehelpprovider.rb +9 -0
- data/lib/wx/core/size.rb +8 -0
- data/lib/wx/core/sizer.rb +9 -0
- data/lib/wx/core/splash_screen.rb +22 -2
- data/lib/wx/core/text_entry.rb +7 -0
- data/lib/wx/core/textctrl.rb +86 -5
- data/lib/wx/core/timer.rb +9 -0
- data/lib/wx/core/toolbar.rb +9 -0
- data/lib/wx/core/toolbartool.rb +8 -0
- data/lib/wx/core/treectrl.rb +9 -0
- data/lib/wx/core/v_list_box.rb +7 -0
- data/lib/wx/core/validator.rb +7 -0
- data/lib/wx/core/variant.rb +7 -0
- data/lib/wx/core/vboxsizer.rb +16 -0
- data/lib/wx/core/window.rb +8 -0
- data/lib/wx/core/window_update_locker.rb +9 -0
- data/lib/wx/core/xmlresource.rb +8 -0
- data/lib/wx/core.rb +4 -1
- data/lib/wx/doc/app.rb +7 -1
- data/lib/wx/doc/array_ext.rb +6 -0
- data/lib/wx/doc/art_locator.rb +7 -0
- data/lib/wx/doc/aui/auimanager.rb +6 -0
- data/lib/wx/doc/aui/auinotebook.rb +6 -0
- data/lib/wx/doc/bitmap.rb +19 -15
- data/lib/wx/doc/brush.rb +6 -0
- data/lib/wx/doc/busy_info.rb +6 -0
- data/lib/wx/doc/client_dc.rb +6 -0
- data/lib/wx/doc/clipboard.rb +6 -0
- data/lib/wx/doc/colour_dialog.rb +6 -0
- data/lib/wx/doc/config.rb +190 -0
- data/lib/wx/doc/const.rb +7 -0
- data/lib/wx/doc/controlwithitems.rb +6 -0
- data/lib/wx/doc/core.rb +6 -0
- data/lib/wx/doc/cursor.rb +13 -5
- data/lib/wx/doc/data_object.rb +6 -0
- data/lib/wx/doc/datetime.rb +16 -0
- data/lib/wx/doc/dc.rb +6 -0
- data/lib/wx/doc/enum.rb +8 -1
- data/lib/wx/doc/event.rb +12 -0
- data/lib/wx/doc/event_blocker.rb +6 -0
- data/lib/wx/doc/event_loop.rb +13 -0
- data/lib/wx/doc/events.rb +6 -0
- data/lib/wx/doc/evthandler.rb +8 -0
- data/lib/wx/doc/extra/00_starting.md +6 -6
- data/lib/wx/doc/extra/01_packages.md +52 -51
- data/lib/wx/doc/extra/02_lifecycles.md +9 -8
- data/lib/wx/doc/extra/05_event-handling.md +37 -12
- data/lib/wx/doc/extra/06_geometry.md +5 -5
- data/lib/wx/doc/extra/07_colour_and_font.md +2 -2
- data/lib/wx/doc/extra/09_exceptions.md +2 -2
- data/lib/wx/doc/extra/10_art.md +18 -12
- data/lib/wx/doc/extra/11_drawing_and_dc.md +8 -8
- data/lib/wx/doc/font.rb +7 -1
- data/lib/wx/doc/font_data.rb +16 -0
- data/lib/wx/doc/functions.rb +60 -24
- data/lib/wx/doc/gc_dc.rb +7 -1
- data/lib/wx/doc/gdi_common.rb +8 -1
- data/lib/wx/doc/gen/about_dialog_info.rb +10 -10
- data/lib/wx/doc/gen/accelerator.rb +8 -13
- data/lib/wx/doc/gen/accessible.rb +27 -23
- data/lib/wx/doc/gen/activity_indicator.rb +7 -7
- data/lib/wx/doc/gen/animation.rb +20 -20
- data/lib/wx/doc/gen/animation_ctrl.rb +14 -13
- data/lib/wx/doc/gen/any_button.rb +3 -3
- data/lib/wx/doc/gen/app.rb +25 -88
- data/lib/wx/doc/gen/app_traits.rb +381 -0
- data/lib/wx/doc/gen/art_provider.rb +64 -4
- data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -12
- data/lib/wx/doc/gen/aui/aui_floating_frame.rb +6 -6
- data/lib/wx/doc/gen/aui/aui_manager.rb +57 -41
- data/lib/wx/doc/gen/aui/aui_manager_event.rb +16 -10
- data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +19 -20
- data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +7 -7
- data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +12 -12
- data/lib/wx/doc/gen/aui/aui_notebook.rb +136 -26
- data/lib/wx/doc/gen/aui/aui_notebook_event.rb +17 -2
- data/lib/wx/doc/gen/aui/aui_pane_info.rb +95 -95
- data/lib/wx/doc/gen/aui/aui_tab_art.rb +17 -17
- data/lib/wx/doc/gen/aui/aui_tool_bar.rb +61 -46
- data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +18 -18
- data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +6 -6
- data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +11 -11
- data/lib/wx/doc/gen/aui/event_list.rb +7 -0
- data/lib/wx/doc/gen/banner_window.rb +98 -0
- data/lib/wx/doc/gen/bitmap.rb +56 -81
- data/lib/wx/doc/gen/bitmap_button.rb +13 -9
- data/lib/wx/doc/gen/bitmap_combo_box.rb +14 -9
- data/lib/wx/doc/gen/book_ctrl_base.rb +20 -16
- data/lib/wx/doc/gen/book_ctrl_event.rb +2 -2
- data/lib/wx/doc/gen/box_sizer.rb +1 -1
- data/lib/wx/doc/gen/brush.rb +24 -12
- data/lib/wx/doc/gen/busy_info.rb +1 -1
- data/lib/wx/doc/gen/button.rb +23 -11
- data/lib/wx/doc/gen/calculate_layout_event.rb +2 -1
- data/lib/wx/doc/gen/calendar_ctrl.rb +34 -22
- data/lib/wx/doc/gen/calendar_date_attr.rb +13 -13
- data/lib/wx/doc/gen/calendar_event.rb +4 -10
- data/lib/wx/doc/gen/caret.rb +6 -6
- data/lib/wx/doc/gen/check_box.rb +19 -15
- data/lib/wx/doc/gen/check_list_box.rb +10 -9
- data/lib/wx/doc/gen/choice.rb +10 -9
- data/lib/wx/doc/gen/choicebook.rb +13 -7
- data/lib/wx/doc/gen/client_dc.rb +1 -1
- data/lib/wx/doc/gen/clipboard.rb +10 -10
- data/lib/wx/doc/gen/collapsible_pane.rb +13 -10
- data/lib/wx/doc/gen/collapsible_pane_event.rb +5 -4
- data/lib/wx/doc/gen/colour.rb +42 -32
- data/lib/wx/doc/gen/colour_dialog.rb +12 -12
- data/lib/wx/doc/gen/colour_picker_ctrl.rb +16 -10
- data/lib/wx/doc/gen/colour_picker_event.rb +7 -4
- data/lib/wx/doc/gen/combo_box.rb +29 -20
- data/lib/wx/doc/gen/combo_ctrl.rb +960 -0
- data/lib/wx/doc/gen/command_link_button.rb +110 -0
- data/lib/wx/doc/gen/config_base.rb +10 -0
- data/lib/wx/doc/gen/context_help_button.rb +7 -6
- data/lib/wx/doc/gen/control.rb +12 -9
- data/lib/wx/doc/gen/control_with_items.rb +5 -5
- data/lib/wx/doc/gen/core.rb +8 -5
- data/lib/wx/doc/gen/cursor.rb +18 -18
- data/lib/wx/doc/gen/data_format.rb +5 -5
- data/lib/wx/doc/gen/data_object.rb +32 -25
- data/lib/wx/doc/gen/date_event.rb +3 -3
- data/lib/wx/doc/gen/date_picker_ctrl.rb +16 -11
- data/lib/wx/doc/gen/dc.rb +162 -74
- data/lib/wx/doc/gen/defs.rb +16 -16
- data/lib/wx/doc/gen/dialog.rb +65 -22
- data/lib/wx/doc/gen/dir_dialog.rb +6 -2
- data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +3 -3
- data/lib/wx/doc/gen/dir_picker_ctrl.rb +17 -12
- data/lib/wx/doc/gen/drag_drop.rb +26 -52
- data/lib/wx/doc/gen/drag_image.rb +13 -38
- data/lib/wx/doc/gen/editable_list_box.rb +9 -5
- data/lib/wx/doc/gen/event.rb +55 -32
- data/lib/wx/doc/gen/event_blocker.rb +1 -1
- data/lib/wx/doc/gen/event_filter.rb +5 -2
- data/lib/wx/doc/gen/event_list.rb +117 -19
- data/lib/wx/doc/gen/events.rb +351 -215
- data/lib/wx/doc/gen/evt_handler.rb +8 -8
- data/lib/wx/doc/gen/ext_help_controller.rb +9 -9
- data/lib/wx/doc/gen/file_dialog.rb +20 -9
- data/lib/wx/doc/gen/file_dialog_custom_control.rb +146 -0
- data/lib/wx/doc/gen/file_dialog_customize_hook.rb +159 -0
- data/lib/wx/doc/gen/file_dir_picker_event.rb +5 -3
- data/lib/wx/doc/gen/file_picker_ctrl.rb +19 -11
- data/lib/wx/doc/gen/file_system.rb +250 -0
- data/lib/wx/doc/gen/find_dialog_event.rb +7 -2
- data/lib/wx/doc/gen/find_replace_data.rb +1 -1
- data/lib/wx/doc/gen/find_replace_dialog.rb +2 -2
- data/lib/wx/doc/gen/flex_grid_sizer.rb +16 -10
- data/lib/wx/doc/gen/font.rb +90 -94
- data/lib/wx/doc/gen/font_data.rb +15 -11
- data/lib/wx/doc/gen/font_dialog.rb +5 -5
- data/lib/wx/doc/gen/font_picker_ctrl.rb +11 -7
- data/lib/wx/doc/gen/font_picker_event.rb +2 -1
- data/lib/wx/doc/gen/frame.rb +36 -27
- data/lib/wx/doc/gen/fs_file.rb +65 -38
- data/lib/wx/doc/gen/gauge.rb +14 -10
- data/lib/wx/doc/gen/gb_sizer_item.rb +12 -26
- data/lib/wx/doc/gen/gcdc.rb +5 -1
- data/lib/wx/doc/gen/gdi_common.rb +43 -41
- data/lib/wx/doc/gen/gdi_object.rb +1 -1
- data/lib/wx/doc/gen/generic_dir_ctrl.rb +19 -13
- data/lib/wx/doc/gen/graphics_context.rb +320 -88
- data/lib/wx/doc/gen/graphics_object.rb +48 -102
- data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +4 -2
- data/lib/wx/doc/gen/grid/grid_cell_attr.rb +41 -56
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +4 -2
- data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +7 -12
- data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_editor.rb +19 -14
- data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +15 -13
- data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_ctrl.rb +446 -189
- data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +5 -3
- data/lib/wx/doc/gen/grid/grid_event.rb +26 -9
- data/lib/wx/doc/gen/grid/grid_range_select_event.rb +15 -11
- data/lib/wx/doc/gen/grid/grid_size_event.rb +13 -7
- data/lib/wx/doc/gen/grid/grid_string_table.rb +8 -8
- data/lib/wx/doc/gen/grid/grid_table_base.rb +21 -21
- data/lib/wx/doc/gen/grid/grid_table_message.rb +5 -5
- data/lib/wx/doc/gen/grid_bag_sizer.rb +15 -15
- data/lib/wx/doc/gen/grid_sizer.rb +4 -4
- data/lib/wx/doc/gen/gui_event_loop.rb +132 -0
- data/lib/wx/doc/gen/header_ctrl.rb +755 -0
- data/lib/wx/doc/gen/header_ctrl_event.rb +131 -0
- data/lib/wx/doc/gen/help_controller.rb +25 -19
- data/lib/wx/doc/gen/help_provider.rb +3 -3
- data/lib/wx/doc/gen/html/html_cell.rb +100 -59
- data/lib/wx/doc/gen/html/html_cell_event.rb +7 -5
- data/lib/wx/doc/gen/html/html_easy_printing.rb +14 -9
- data/lib/wx/doc/gen/html/html_help_controller.rb +60 -46
- data/lib/wx/doc/gen/html/html_help_data.rb +5 -5
- data/lib/wx/doc/gen/html/html_help_window.rb +33 -35
- data/lib/wx/doc/gen/html/html_link_event.rb +4 -3
- data/lib/wx/doc/gen/html/html_list_box.rb +21 -13
- data/lib/wx/doc/gen/html/html_printout.rb +16 -6
- data/lib/wx/doc/gen/html/html_window.rb +54 -39
- data/lib/wx/doc/gen/hyperlink_ctrl.rb +15 -10
- data/lib/wx/doc/gen/hyperlink_event.rb +2 -1
- data/lib/wx/doc/gen/icon.rb +24 -24
- data/lib/wx/doc/gen/icon_location.rb +1 -1
- data/lib/wx/doc/gen/image.rb +164 -114
- data/lib/wx/doc/gen/image_list.rb +24 -30
- data/lib/wx/doc/gen/info_bar.rb +152 -0
- data/lib/wx/doc/gen/keyboard_state.rb +24 -24
- data/lib/wx/doc/gen/list_box.rb +40 -31
- data/lib/wx/doc/gen/list_ctrl.rb +223 -167
- data/lib/wx/doc/gen/list_event.rb +25 -3
- data/lib/wx/doc/gen/listbook.rb +13 -7
- data/lib/wx/doc/gen/locale.rb +22 -71
- data/lib/wx/doc/gen/log.rb +133 -106
- data/lib/wx/doc/gen/mdi_client_window.rb +3 -3
- data/lib/wx/doc/gen/mdi_frame.rb +23 -17
- data/lib/wx/doc/gen/media_ctrl.rb +22 -19
- data/lib/wx/doc/gen/media_event.rb +8 -2
- data/lib/wx/doc/gen/memory_dc.rb +26 -33
- data/lib/wx/doc/gen/menu.rb +24 -25
- data/lib/wx/doc/gen/menu_bar.rb +11 -28
- data/lib/wx/doc/gen/menu_item.rb +127 -46
- data/lib/wx/doc/gen/message_dialog.rb +54 -36
- data/lib/wx/doc/gen/mini_frame.rb +14 -5
- data/lib/wx/doc/gen/mouse_state.rb +51 -11
- data/lib/wx/doc/gen/multi_choice_dialog.rb +4 -2
- data/lib/wx/doc/gen/non_owned_window.rb +8 -9
- data/lib/wx/doc/gen/notebook.rb +27 -22
- data/lib/wx/doc/gen/number_entry_dialog.rb +3 -3
- data/lib/wx/doc/gen/object.rb +3 -14
- data/lib/wx/doc/gen/palette.rb +15 -17
- data/lib/wx/doc/gen/panel.rb +8 -7
- data/lib/wx/doc/gen/pen.rb +50 -37
- data/lib/wx/doc/gen/pg/numeric_property_validator.rb +3 -3
- data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +17 -17
- data/lib/wx/doc/gen/pg/pg_cell.rb +13 -16
- data/lib/wx/doc/gen/pg/pg_editor.rb +95 -93
- data/lib/wx/doc/gen/pg/pg_multi_button.rb +64 -89
- data/lib/wx/doc/gen/pg/pg_properties.rb +379 -349
- data/lib/wx/doc/gen/pg/pg_property.rb +260 -307
- data/lib/wx/doc/gen/pg/pg_validation_info.rb +3 -3
- data/lib/wx/doc/gen/pg/property_grid.rb +49 -49
- data/lib/wx/doc/gen/pg/property_grid_event.rb +24 -11
- data/lib/wx/doc/gen/pg/property_grid_interface.rb +75 -69
- data/lib/wx/doc/gen/pg/property_grid_manager.rb +51 -54
- data/lib/wx/doc/gen/pg/property_grid_page.rb +22 -30
- data/lib/wx/doc/gen/pg/property_grid_page_state.rb +17 -26
- data/lib/wx/doc/gen/picker_base.rb +17 -16
- data/lib/wx/doc/gen/platform_info.rb +180 -20
- data/lib/wx/doc/gen/popup_window.rb +8 -8
- data/lib/wx/doc/gen/progress_dialog.rb +3 -3
- data/lib/wx/doc/gen/property_sheet_dialog.rb +20 -18
- data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -2
- data/lib/wx/doc/gen/prt/preview_frame.rb +18 -2
- data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -1
- data/lib/wx/doc/gen/prt/print_data.rb +68 -62
- data/lib/wx/doc/gen/prt/print_dialog.rb +4 -4
- data/lib/wx/doc/gen/prt/printer.rb +44 -49
- data/lib/wx/doc/gen/query_layout_info_event.rb +6 -5
- data/lib/wx/doc/gen/radio_box.rb +21 -19
- data/lib/wx/doc/gen/radio_button.rb +13 -11
- data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +67 -67
- data/lib/wx/doc/gen/rbn/ribbon_bar.rb +38 -20
- data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +5 -5
- data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +22 -15
- data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +6 -6
- data/lib/wx/doc/gen/rbn/ribbon_control.rb +11 -11
- data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +14 -16
- data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +5 -5
- data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -12
- data/lib/wx/doc/gen/rbn/ribbon_panel.rb +24 -22
- data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +5 -5
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +17 -15
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +6 -6
- data/lib/wx/doc/gen/rearrange_ctrl.rb +60 -0
- data/lib/wx/doc/gen/rearrange_list.rb +99 -0
- data/lib/wx/doc/gen/region.rb +35 -43
- data/lib/wx/doc/gen/region_iterator.rb +3 -3
- data/lib/wx/doc/gen/rtc/rich_text_box.rb +423 -0
- data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +626 -1538
- data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +37 -0
- data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +525 -0
- data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +488 -503
- data/lib/wx/doc/gen/rtc/rich_text_event.rb +31 -12
- data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +18 -18
- data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +282 -0
- data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +23 -19
- data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +9 -18
- data/lib/wx/doc/gen/rtc/rich_text_image.rb +328 -0
- data/lib/wx/doc/gen/rtc/rich_text_object.rb +2849 -0
- data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1174 -0
- data/lib/wx/doc/gen/rtc/rich_text_printing.rb +29 -29
- data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +305 -0
- data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +183 -0
- data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +3 -3
- data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +34 -37
- data/lib/wx/doc/gen/sash_event.rb +8 -6
- data/lib/wx/doc/gen/sash_layout_window.rb +13 -11
- data/lib/wx/doc/gen/sash_window.rb +14 -9
- data/lib/wx/doc/gen/scroll_bar.rb +33 -12
- data/lib/wx/doc/gen/scrolled_canvas.rb +49 -37
- data/lib/wx/doc/gen/scrolled_control.rb +49 -37
- data/lib/wx/doc/gen/scrolled_window.rb +49 -37
- data/lib/wx/doc/gen/search_ctrl.rb +20 -13
- data/lib/wx/doc/gen/simplebook.rb +7 -7
- data/lib/wx/doc/gen/single_choice_dialog.rb +5 -4
- data/lib/wx/doc/gen/sizer.rb +69 -73
- data/lib/wx/doc/gen/sizer_item.rb +5 -5
- data/lib/wx/doc/gen/slider.rb +51 -18
- data/lib/wx/doc/gen/spin_button.rb +17 -11
- data/lib/wx/doc/gen/spin_ctrl.rb +15 -9
- data/lib/wx/doc/gen/spin_ctrl_double.rb +146 -0
- data/lib/wx/doc/gen/spin_double_event.rb +53 -0
- data/lib/wx/doc/gen/spin_event.rb +5 -2
- data/lib/wx/doc/gen/splash_screen.rb +16 -12
- data/lib/wx/doc/gen/splitter_event.rb +6 -2
- data/lib/wx/doc/gen/splitter_window.rb +36 -16
- data/lib/wx/doc/gen/static_bitmap.rb +9 -9
- data/lib/wx/doc/gen/static_box.rb +41 -37
- data/lib/wx/doc/gen/static_box_sizer.rb +13 -10
- data/lib/wx/doc/gen/static_line.rb +8 -7
- data/lib/wx/doc/gen/static_text.rb +15 -9
- data/lib/wx/doc/gen/status_bar.rb +53 -10
- data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +200 -184
- data/lib/wx/doc/gen/stc/styled_text_event.rb +229 -54
- data/lib/wx/doc/gen/std_dialog_button_sizer.rb +11 -2
- data/lib/wx/doc/gen/svg_file_dc.rb +8 -8
- data/lib/wx/doc/gen/system_options.rb +13 -3
- data/lib/wx/doc/gen/system_settings.rb +9 -9
- data/lib/wx/doc/gen/task_bar_icon.rb +17 -9
- data/lib/wx/doc/gen/task_bar_icon_event.rb +3 -3
- data/lib/wx/doc/gen/text_attr.rb +67 -61
- data/lib/wx/doc/gen/text_ctrl.rb +58 -113
- data/lib/wx/doc/gen/text_entry.rb +44 -56
- data/lib/wx/doc/gen/text_entry_dialog.rb +23 -23
- data/lib/wx/doc/gen/text_validator.rb +3 -19
- data/lib/wx/doc/gen/time_picker_ctrl.rb +11 -10
- data/lib/wx/doc/gen/timer.rb +13 -9
- data/lib/wx/doc/gen/timer_event.rb +19 -26
- data/lib/wx/doc/gen/tip_provider.rb +3 -3
- data/lib/wx/doc/gen/toggle_button.rb +10 -9
- data/lib/wx/doc/gen/tool_bar.rb +71 -61
- data/lib/wx/doc/gen/tool_tip.rb +2 -10
- data/lib/wx/doc/gen/toolbook.rb +12 -9
- data/lib/wx/doc/gen/top_level_window.rb +53 -113
- data/lib/wx/doc/gen/tree_ctrl.rb +83 -33
- data/lib/wx/doc/gen/tree_event.rb +24 -3
- data/lib/wx/doc/gen/treebook.rb +20 -16
- data/lib/wx/doc/gen/ui_action_simulator.rb +20 -19
- data/lib/wx/doc/gen/utils.rb +20 -14
- data/lib/wx/doc/gen/v_list_box.rb +11 -11
- data/lib/wx/doc/gen/v_scrolled_window.rb +9 -9
- data/lib/wx/doc/gen/validator.rb +10 -8
- data/lib/wx/doc/gen/variant.rb +56 -119
- data/lib/wx/doc/gen/window.rb +314 -224
- data/lib/wx/doc/gen/window_dc.rb +1 -1
- data/lib/wx/doc/gen/with_images.rb +2 -2
- data/lib/wx/doc/gen/wizard.rb +21 -8
- data/lib/wx/doc/gen/wizard_event.rb +11 -4
- data/lib/wx/doc/gen/wizard_page.rb +3 -3
- data/lib/wx/doc/gen/wizard_page_simple.rb +8 -8
- data/lib/wx/doc/gen/wrap_sizer.rb +65 -0
- data/lib/wx/doc/gen/xml_node.rb +13 -13
- data/lib/wx/doc/gen/xml_resource.rb +24 -21
- data/lib/wx/doc/graphics_context.rb +59 -39
- data/lib/wx/doc/grid/grid.rb +16 -1
- data/lib/wx/doc/hboxsizer.rb +33 -0
- data/lib/wx/doc/help_controller.rb +6 -0
- data/lib/wx/doc/html/html_help_controller.rb +6 -0
- data/lib/wx/doc/icon.rb +13 -5
- data/lib/wx/doc/id_helper.rb +6 -0
- data/lib/wx/doc/image.rb +50 -12
- data/lib/wx/doc/list_ctrl.rb +38 -0
- data/lib/wx/doc/log.rb +45 -0
- data/lib/wx/doc/memory_dc.rb +6 -0
- data/lib/wx/doc/mirror_dc.rb +6 -0
- data/lib/wx/doc/pen.rb +6 -0
- data/lib/wx/doc/pg/events.rb +6 -0
- data/lib/wx/doc/pg/pg_property.rb +17 -0
- data/lib/wx/doc/pg/pgeditor.rb +6 -0
- data/lib/wx/doc/pg/property_grid.rb +6 -0
- data/lib/wx/doc/pg/property_grid_interface.rb +6 -0
- data/lib/wx/doc/progress_dialog.rb +6 -0
- data/lib/wx/doc/prt/page_setup_dialog.rb +6 -0
- data/lib/wx/doc/prt/print_data.rb +6 -0
- data/lib/wx/doc/prt/print_dialog.rb +6 -0
- data/lib/wx/doc/prt/printer.rb +6 -0
- data/lib/wx/doc/prt/printer_dc.rb +8 -2
- data/lib/wx/doc/radio_box.rb +6 -0
- data/lib/wx/doc/rbn/ribbon_bar.rb +6 -0
- data/lib/wx/doc/rbn/ribbon_button_bar.rb +6 -0
- data/lib/wx/doc/rbn/ribbon_gallery.rb +6 -0
- data/lib/wx/doc/rbn/ribbon_tool_bar.rb +6 -0
- data/lib/wx/doc/region_iterator.rb +6 -0
- data/lib/wx/doc/rtc/richtext_buffer.rb +28 -0
- data/lib/wx/doc/rtc/richtext_formatting_dialog.rb +68 -0
- data/lib/wx/doc/rtc/richtext_printing.rb +6 -0
- data/lib/wx/doc/rtc/richtext_style_sheet.rb +20 -0
- data/lib/wx/doc/scaled_dc.rb +7 -1
- data/lib/wx/doc/screen_dc.rb +6 -0
- data/lib/wx/doc/stock_objects.rb +6 -0
- data/lib/wx/doc/stream.rb +6 -0
- data/lib/wx/doc/svg_file_dc.rb +6 -0
- data/lib/wx/doc/system_settings.rb +6 -0
- data/lib/wx/doc/text_validator.rb +18 -0
- data/lib/wx/doc/textctrl.rb +89 -0
- data/lib/wx/doc/tree_event.rb +20 -0
- data/lib/wx/doc/treebook.rb +6 -0
- data/lib/wx/doc/v_list_box.rb +6 -0
- data/lib/wx/doc/variant.rb +6 -0
- data/lib/wx/doc/vboxsizer.rb +33 -0
- data/lib/wx/doc/window.rb +6 -0
- data/lib/wx/doc/window_disabler.rb +6 -0
- data/lib/wx/doc/xml_resource.rb +8 -0
- data/lib/wx/global_const.rb +4 -1
- data/lib/wx/grid/grid.rb +23 -3
- data/lib/wx/grid/keyword_defs.rb +8 -1
- data/lib/wx/grid/require.rb +4 -1
- data/lib/wx/grid.rb +4 -1
- data/lib/wx/helpers.rb +8 -1
- data/lib/wx/html/htmlhelpcontroller.rb +29 -3
- data/lib/wx/html/htmlwindow.rb +23 -12
- data/lib/wx/html/keyword_defs.rb +8 -1
- data/lib/wx/html/require.rb +4 -1
- data/lib/wx/html/simple_html_listbox.rb +3 -0
- data/lib/wx/html.rb +4 -1
- data/lib/wx/keyword_ctors.rb +22 -3
- data/lib/wx/keyword_defs.rb +55 -3
- data/lib/wx/pg/events.rb +4 -1
- data/lib/wx/pg/keyword_defs.rb +8 -1
- data/lib/wx/pg/pg_editor.rb +3 -0
- data/lib/wx/pg/pg_properties.rb +4 -1
- data/lib/wx/pg/pg_property.rb +18 -5
- data/lib/wx/pg/property_grid.rb +4 -1
- data/lib/wx/pg/property_grid_interface.rb +3 -0
- data/lib/wx/pg/require.rb +4 -1
- data/lib/wx/pg.rb +4 -1
- data/lib/wx/prt/keyword_defs.rb +8 -1
- data/lib/wx/prt/page_setup_dialog.rb +3 -0
- data/lib/wx/prt/previewframe.rb +5 -0
- data/lib/wx/prt/require.rb +4 -1
- data/lib/wx/prt.rb +4 -1
- data/lib/wx/rbn/events.rb +4 -1
- data/lib/wx/rbn/keyword_defs.rb +8 -1
- data/lib/wx/rbn/require.rb +5 -1
- data/lib/wx/rbn/ribbon_art_provider.rb +3 -1
- data/lib/wx/rbn/ribbon_bar.rb +3 -0
- data/lib/wx/rbn/ribbon_button_bar.rb +3 -0
- data/lib/wx/rbn/ribbon_control.rb +3 -0
- data/lib/wx/rbn/ribbon_gallery.rb +10 -0
- data/lib/wx/rbn/ribbon_page.rb +3 -0
- data/lib/wx/rbn/ribbon_panel.rb +3 -0
- data/lib/wx/rbn/ribbon_tool_bar.rb +3 -0
- data/lib/wx/rbn.rb +4 -1
- data/lib/wx/rtc/ext.rb +4 -1
- data/lib/wx/rtc/keyword_defs.rb +18 -7
- data/lib/wx/rtc/require.rb +8 -1
- data/lib/wx/rtc/richtext_buffer.rb +36 -0
- data/lib/wx/rtc/richtext_formatting_dialog.rb +88 -0
- data/lib/wx/rtc/richtext_style_organiser_dialog.rb +46 -0
- data/lib/wx/rtc/symbol_picker_dialog.rb +47 -0
- data/lib/wx/rtc.rb +5 -1
- data/lib/wx/stc/keyword_defs.rb +8 -1
- data/lib/wx/stc/require.rb +4 -1
- data/lib/wx/stc.rb +4 -1
- data/lib/wx/version.rb +5 -1
- data/lib/wx/wxruby/base.rb +4 -1
- data/lib/wx/wxruby/cmd/sampler.rb +4 -1
- data/lib/wx/wxruby/cmd/test.rb +4 -1
- data/lib/wx.rb +4 -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/install.rb +4 -1
- data/rakelib/lib/config/cygwin.rb +4 -1
- data/rakelib/lib/config/linux.rb +4 -1
- data/rakelib/lib/config/macosx.rb +5 -2
- data/rakelib/lib/config/mingw.rb +4 -1
- data/rakelib/lib/config/netbsd.rb +4 -1
- data/rakelib/lib/config/unixish.rb +10 -7
- data/rakelib/lib/config.rb +7 -2
- data/rakelib/lib/ext/enum_chain.rb +4 -1
- data/rakelib/prepost.rake +4 -1
- data/rakelib/prepost.rb +4 -1
- data/samples/aui/aui.rb +8 -3
- data/samples/bigdemo/bigdemo.rb +9 -2
- data/samples/bigdemo/run.rb +9 -2
- data/samples/bigdemo/utils.rb +9 -1
- data/samples/calendar/calendar.rb +9 -4
- data/samples/caret/caret.rb +8 -3
- data/samples/controls/books.rb +8 -2
- data/samples/controls/controls.rb +33 -77
- data/samples/controls/get_item_sample.rb +8 -2
- data/samples/controls/htlbox.rb +10 -3
- data/samples/dialogs/dialogs.rb +9 -4
- data/samples/dialogs/wizard.rb +8 -3
- data/samples/dragdrop/dragdrop.rb +8 -3
- data/samples/drawing/bitmap.rb +8 -3
- data/samples/drawing/bitmap_image.rb +8 -3
- data/samples/drawing/graphics_drawing.rb +44 -33
- data/samples/drawing/image_prt.rb +8 -2
- data/samples/drawing/maths_images.rb +8 -3
- data/samples/drawing/rmagic_bitmap_image.rb +8 -3
- data/samples/etc/choice.rb +8 -3
- data/samples/etc/miniframe.rb +8 -3
- data/samples/etc/sash.rb +8 -3
- data/samples/etc/scrollwin.rb +8 -3
- data/samples/etc/system_settings.rb +8 -3
- data/samples/event/activation.rb +8 -3
- data/samples/event/event.rb +8 -3
- data/samples/event/threaded.rb +8 -3
- data/samples/event/update_ui_event.rb +8 -3
- data/samples/grid/grid.rb +9 -3
- data/samples/grid/gridtablebase.rb +8 -3
- data/samples/html/html.rb +8 -3
- data/samples/mdi/mdi.rb +8 -3
- data/samples/minimal/minimal.rb +8 -3
- data/samples/minimal/nothing.rb +8 -3
- data/samples/printing/printing.rb +8 -3
- data/samples/printing/printing2.rb +8 -2
- data/samples/propgrid/propgrid.rb +4 -1
- data/samples/propgrid/propgrid_minimal.rb +4 -2
- data/samples/propgrid/sample_props.rb +4 -1
- data/samples/ribbon/ribbon.rb +4 -1
- data/samples/sampler/editor.rb +4 -1
- data/samples/sampler/ext.rb +4 -1
- data/samples/sampler/sample.rb +13 -4
- data/samples/sampler/stc_editor.rb +4 -1
- data/samples/sampler/txt_editor.rb +4 -1
- data/samples/sampler.rb +11 -3
- data/samples/splash/splash.rb +4 -2
- data/samples/text/art/richtext/alignleft.xpm +24 -0
- data/samples/text/art/richtext/alignright.xpm +24 -0
- data/samples/text/art/richtext/bold.xpm +24 -0
- data/samples/text/art/richtext/centre.xpm +24 -0
- data/samples/text/art/richtext/copy.xpm +45 -0
- data/samples/text/art/richtext/cut.xpm +47 -0
- data/samples/text/art/richtext/font.xpm +25 -0
- data/samples/text/art/richtext/idea.xpm +47 -0
- data/samples/text/art/richtext/indentless.xpm +25 -0
- data/samples/text/art/richtext/indentmore.xpm +25 -0
- data/samples/text/art/richtext/italic.xpm +25 -0
- data/samples/text/art/richtext/open.xpm +58 -0
- data/samples/text/art/richtext/paste.xpm +47 -0
- data/samples/text/art/richtext/redo.xpm +59 -0
- data/samples/text/art/richtext/save.xpm +43 -0
- data/samples/text/art/richtext/smiley.xpm +42 -0
- data/samples/text/art/richtext/underline.xpm +25 -0
- data/samples/text/art/richtext/undo.xpm +59 -0
- data/samples/text/art/richtext/zebra.xpm +409 -0
- data/samples/text/rich_textctrl.rb +8 -3
- data/samples/text/richtext.rb +1824 -0
- data/samples/text/scintilla.rb +8 -3
- data/samples/text/textctrl.rb +21 -4
- data/samples/text/tn_richtext.png +0 -0
- data/samples/text/unicode.rb +9 -4
- data/samples/treectrl/treectrl.rb +10 -5
- data/samples/xrc/custom_xrc_sample.rb +8 -3
- data/samples/xrc/xrc_sample.rb +8 -3
- data/tests/art/test_art/bitmap/wxruby-128x128.png +0 -0
- data/tests/art/test_art/bitmap/wxruby-256x256.png +0 -0
- data/tests/art/test_art/bitmap/wxruby-64x64.png +0 -0
- data/tests/lib/item_container_tests.rb +3 -0
- data/tests/lib/text_entry_tests.rb +3 -0
- data/tests/lib/wxapp_runner.rb +3 -0
- data/tests/lib/wxframe_runner.rb +81 -3
- data/tests/test_app_event_filter.rb +3 -0
- data/tests/test_app_traits.rb +33 -0
- data/tests/test_art.rb +31 -0
- data/tests/test_art_provider.rb +3 -0
- data/tests/test_aui.rb +65 -0
- data/tests/test_basic.rb +5 -1
- data/tests/test_box_sizer.rb +164 -0
- data/tests/test_clipboard.rb +3 -0
- data/tests/test_config.rb +150 -0
- data/tests/test_dc.rb +3 -0
- data/tests/test_dialog.rb +3 -0
- data/tests/test_event_handling.rb +3 -0
- data/tests/test_events.rb +3 -0
- data/tests/test_ext_controls.rb +286 -3
- data/tests/test_file_dialog.rb +55 -0
- data/tests/test_font.rb +8 -5
- data/tests/test_gdi_object.rb +3 -0
- data/tests/test_geometry.rb +4 -0
- data/tests/test_grid_sizer.rb +151 -0
- data/tests/test_intl.rb +3 -0
- data/tests/test_item_data.rb +3 -0
- data/tests/test_list_ctrl.rb +56 -0
- data/tests/test_log.rb +226 -0
- data/tests/test_proof_check.rb +52 -0
- data/tests/test_richtext.rb +204 -0
- data/tests/test_std_controls.rb +99 -31
- data/tests/test_timer.rb +98 -0
- data/tests/test_variant.rb +3 -0
- data/tests/test_window.rb +10 -8
- data/tests/testapp.rb +4 -0
- data/tests/testapp_noframe.rb +4 -0
- metadata +87 -3
- data/lib/wx/doc/gen/html/html_help_frame.rb +0 -112
data/lib/wx/doc/gen/events.rb
CHANGED
@@ -15,6 +15,7 @@ module Wx
|
|
15
15
|
#
|
16
16
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::IdleEvent} events.
|
17
17
|
# Event handler methods:
|
18
|
+
#
|
18
19
|
# - {Wx::EvtHandler#evt_idle}(meth = nil, &block): Process a {Wx::EVT_IDLE} event.
|
19
20
|
#
|
20
21
|
# ===
|
@@ -34,31 +35,31 @@ module Wx
|
|
34
35
|
class IdleEvent < Event
|
35
36
|
|
36
37
|
# Constructor.
|
37
|
-
# @return [IdleEvent]
|
38
|
+
# @return [Wx::IdleEvent]
|
38
39
|
def initialize; end
|
39
40
|
|
40
41
|
# Returns true if the OnIdle function processing this event requested more processing time.
|
41
42
|
#
|
42
43
|
# @see Wx::IdleEvent#request_more
|
43
|
-
# @return [
|
44
|
+
# @return [Boolean]
|
44
45
|
def more_requested; end
|
45
46
|
|
46
47
|
# Tells wxWidgets that more processing is required.
|
47
48
|
# 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.
|
48
49
|
# 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.
|
49
50
|
# @see Wx::IdleEvent#more_requested
|
50
|
-
# @param needMore [
|
51
|
+
# @param needMore [Boolean]
|
51
52
|
# @return [void]
|
52
53
|
def request_more(needMore=true) end
|
53
54
|
|
54
55
|
# 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.
|
55
56
|
#
|
56
57
|
# @see Wx::IdleEvent.set_mode.
|
57
|
-
# @return [IdleMode]
|
58
|
+
# @return [Wx::IdleMode]
|
58
59
|
def self.get_mode; end
|
59
60
|
|
60
61
|
# Static function for specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events.
|
61
|
-
# @param mode [IdleMode] Can be one of the {Wx::IdleMode} values. The default is {Wx::IdleMode::IDLE_PROCESS_ALL}.
|
62
|
+
# @param mode [Wx::IdleMode] Can be one of the {Wx::IdleMode} values. The default is {Wx::IdleMode::IDLE_PROCESS_ALL}.
|
62
63
|
# @return [void]
|
63
64
|
def self.set_mode(mode) end
|
64
65
|
|
@@ -75,9 +76,9 @@ module Wx
|
|
75
76
|
class NotifyEvent < CommandEvent
|
76
77
|
|
77
78
|
# Constructor (used internally by wxWidgets only).
|
78
|
-
# @param eventType [
|
79
|
+
# @param eventType [Wx::CommandLinkButton::EventType]
|
79
80
|
# @param id [Integer]
|
80
|
-
# @return [NotifyEvent]
|
81
|
+
# @return [Wx::NotifyEvent]
|
81
82
|
def initialize(eventType=Wx::EVT_NULL, id=0) end
|
82
83
|
|
83
84
|
# This is the opposite of {Wx::NotifyEvent#veto}: it explicitly allows the event to be processed.
|
@@ -86,7 +87,7 @@ module Wx
|
|
86
87
|
def allow; end
|
87
88
|
|
88
89
|
# Returns true if the change is allowed ({Wx::NotifyEvent#veto} hasn't been called) or false otherwise (if it was).
|
89
|
-
# @return [
|
90
|
+
# @return [Boolean]
|
90
91
|
def is_allowed; end
|
91
92
|
alias_method :allowed?, :is_allowed
|
92
93
|
|
@@ -111,25 +112,45 @@ module Wx
|
|
111
112
|
#
|
112
113
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollEvent} events.
|
113
114
|
# Event handler methods: except for this, the macros behave exactly the same.
|
115
|
+
#
|
114
116
|
# - {Wx::EvtHandler#evt_scroll}(meth = nil, &block): Process all scroll events.
|
117
|
+
#
|
115
118
|
# - {Wx::EvtHandler#evt_scroll_top}(meth = nil, &block): Process {Wx::EVT_SCROLL_TOP} scroll-to-top events (minimum position).
|
119
|
+
#
|
116
120
|
# - {Wx::EvtHandler#evt_scroll_bottom}(meth = nil, &block): Process {Wx::EVT_SCROLL_BOTTOM} scroll-to-bottom events (maximum position).
|
121
|
+
#
|
117
122
|
# - {Wx::EvtHandler#evt_scroll_lineup}(meth = nil, &block): Process {Wx::EVT_SCROLL_LINEUP} line up events.
|
123
|
+
#
|
118
124
|
# - {Wx::EvtHandler#evt_scroll_linedown}(meth = nil, &block): Process {Wx::EVT_SCROLL_LINEDOWN} line down events.
|
125
|
+
#
|
119
126
|
# - {Wx::EvtHandler#evt_scroll_pageup}(meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEUP} page up events.
|
127
|
+
#
|
120
128
|
# - {Wx::EvtHandler#evt_scroll_pagedown}(meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEDOWN} page down events.
|
129
|
+
#
|
121
130
|
# - {Wx::EvtHandler#evt_scroll_thumbtrack}(meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack).
|
131
|
+
#
|
122
132
|
# - {Wx::EvtHandler#evt_scroll_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBRELEASE} thumb release events.
|
133
|
+
#
|
123
134
|
# - {Wx::EvtHandler#evt_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only).
|
135
|
+
#
|
124
136
|
# - {Wx::EvtHandler#evt_command_scroll}(id, meth = nil, &block): Process all scroll events.
|
137
|
+
#
|
125
138
|
# - {Wx::EvtHandler#evt_command_scroll_top}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_TOP} scroll-to-top events (minimum position).
|
139
|
+
#
|
126
140
|
# - {Wx::EvtHandler#evt_command_scroll_bottom}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_BOTTOM} scroll-to-bottom events (maximum position).
|
141
|
+
#
|
127
142
|
# - {Wx::EvtHandler#evt_command_scroll_lineup}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_LINEUP} line up events.
|
143
|
+
#
|
128
144
|
# - {Wx::EvtHandler#evt_command_scroll_linedown}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_LINEDOWN} line down events.
|
145
|
+
#
|
129
146
|
# - {Wx::EvtHandler#evt_command_scroll_pageup}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEUP} page up events.
|
147
|
+
#
|
130
148
|
# - {Wx::EvtHandler#evt_command_scroll_pagedown}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEDOWN} page down events.
|
149
|
+
#
|
131
150
|
# - {Wx::EvtHandler#evt_command_scroll_thumbtrack}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack).
|
151
|
+
#
|
132
152
|
# - {Wx::EvtHandler#evt_command_scroll_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBRELEASE} thumb release events.
|
153
|
+
#
|
133
154
|
# - {Wx::EvtHandler#evt_command_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only).
|
134
155
|
#
|
135
156
|
# ===
|
@@ -145,11 +166,11 @@ module Wx
|
|
145
166
|
class ScrollEvent < CommandEvent
|
146
167
|
|
147
168
|
# Constructor.
|
148
|
-
# @param commandType [
|
169
|
+
# @param commandType [Wx::CommandLinkButton::EventType]
|
149
170
|
# @param id [Integer]
|
150
171
|
# @param pos [Integer]
|
151
172
|
# @param orientation [Integer]
|
152
|
-
# @return [ScrollEvent]
|
173
|
+
# @return [Wx::ScrollEvent]
|
153
174
|
def initialize(commandType=Wx::EVT_NULL, id=0, pos=0, orientation=0) end
|
154
175
|
|
155
176
|
# Returns {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}, depending on the orientation of the scrollbar.
|
@@ -180,14 +201,23 @@ module Wx
|
|
180
201
|
#
|
181
202
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
|
182
203
|
# Event handler methods:
|
204
|
+
#
|
183
205
|
# - {Wx::EvtHandler#evt_scrollwin}(meth = nil, &block): Process all scroll events.
|
206
|
+
#
|
184
207
|
# - {Wx::EvtHandler#evt_scrollwin_top}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_TOP} scroll-to-top events.
|
208
|
+
#
|
185
209
|
# - {Wx::EvtHandler#evt_scrollwin_bottom}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_BOTTOM} scroll-to-bottom events.
|
210
|
+
#
|
186
211
|
# - {Wx::EvtHandler#evt_scrollwin_lineup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEUP} line up events.
|
212
|
+
#
|
187
213
|
# - {Wx::EvtHandler#evt_scrollwin_linedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEDOWN} line down events.
|
214
|
+
#
|
188
215
|
# - {Wx::EvtHandler#evt_scrollwin_pageup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEUP} page up events.
|
216
|
+
#
|
189
217
|
# - {Wx::EvtHandler#evt_scrollwin_pagedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEDOWN} page down events.
|
218
|
+
#
|
190
219
|
# - {Wx::EvtHandler#evt_scrollwin_thumbtrack}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack).
|
220
|
+
#
|
191
221
|
# - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events.
|
192
222
|
#
|
193
223
|
# ===
|
@@ -200,10 +230,10 @@ module Wx
|
|
200
230
|
class ScrollWinEvent < Event
|
201
231
|
|
202
232
|
# Constructor.
|
203
|
-
# @param commandType [
|
233
|
+
# @param commandType [Wx::CommandLinkButton::EventType]
|
204
234
|
# @param pos [Integer]
|
205
235
|
# @param orientation [Integer]
|
206
|
-
# @return [ScrollWinEvent]
|
236
|
+
# @return [Wx::ScrollWinEvent]
|
207
237
|
def initialize(commandType=Wx::EVT_NULL, pos=0, orientation=0) end
|
208
238
|
|
209
239
|
# Returns {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}, depending on the orientation of the scrollbar.
|
@@ -231,7 +261,7 @@ module Wx
|
|
231
261
|
end # ScrollWinEvent
|
232
262
|
|
233
263
|
# This event class contains information about the events generated by the mouse: they include mouse buttons press and release events and mouse move events.
|
234
|
-
# All mouse events involving the buttons use {Wx::MOUSE_BTN_LEFT} for the left mouse button, {Wx::MOUSE_BTN_MIDDLE} for the middle one and {Wx::MOUSE_BTN_RIGHT} for the right one. And if the system supports more buttons, the {Wx::MOUSE_BTN_AUX1} and {Wx::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).
|
264
|
+
# 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).
|
235
265
|
# 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.
|
236
266
|
# 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.
|
237
267
|
# Note the difference between methods like {Wx::MouseEvent#left_down} and the inherited {Wx::MouseState#left_is_down}: the former returns true when the event corresponds to the left mouse button click while the latter returns true if the left mouse button is currently being pressed. For example, when the user is dragging the mouse you can use {Wx::MouseEvent::LeftIsDown} to test whether the left mouse button is (still) depressed. Also, by convention, if {Wx::MouseEvent#left_down} returns true, {Wx::MouseEvent::LeftIsDown} will also return true in wxWidgets whatever the underlying GUI behaviour is (which is platform-dependent). The same applies, of course, to other mouse buttons as well.
|
@@ -240,26 +270,47 @@ module Wx
|
|
240
270
|
#
|
241
271
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseEvent} events.
|
242
272
|
# Event handler methods:
|
273
|
+
#
|
243
274
|
# - {Wx::EvtHandler#evt_left_down}(meth = nil, &block): Process a {Wx::EVT_LEFT_DOWN} event. The handler of this event should normally call event.Skip() to allow the default processing to take place as otherwise the window under mouse wouldn't get the focus.
|
275
|
+
#
|
244
276
|
# - {Wx::EvtHandler#evt_left_up}(meth = nil, &block): Process a {Wx::EVT_LEFT_UP} event.
|
277
|
+
#
|
245
278
|
# - {Wx::EvtHandler#evt_left_dclick}(meth = nil, &block): Process a {Wx::EVT_LEFT_DCLICK} event.
|
279
|
+
#
|
246
280
|
# - {Wx::EvtHandler#evt_middle_down}(meth = nil, &block): Process a {Wx::EVT_MIDDLE_DOWN} event.
|
281
|
+
#
|
247
282
|
# - {Wx::EvtHandler#evt_middle_up}(meth = nil, &block): Process a {Wx::EVT_MIDDLE_UP} event.
|
283
|
+
#
|
248
284
|
# - {Wx::EvtHandler#evt_middle_dclick}(meth = nil, &block): Process a {Wx::EVT_MIDDLE_DCLICK} event.
|
285
|
+
#
|
249
286
|
# - {Wx::EvtHandler#evt_right_down}(meth = nil, &block): Process a {Wx::EVT_RIGHT_DOWN} event.
|
287
|
+
#
|
250
288
|
# - {Wx::EvtHandler#evt_right_up}(meth = nil, &block): Process a {Wx::EVT_RIGHT_UP} event.
|
289
|
+
#
|
251
290
|
# - {Wx::EvtHandler#evt_right_dclick}(meth = nil, &block): Process a {Wx::EVT_RIGHT_DCLICK} event.
|
291
|
+
#
|
252
292
|
# - EVT_MOUSE_AUX1_DOWN(func): Process a {Wx::EVT_AUX1_DOWN} event.
|
293
|
+
#
|
253
294
|
# - EVT_MOUSE_AUX1_UP(func): Process a {Wx::EVT_AUX1_UP} event.
|
295
|
+
#
|
254
296
|
# - EVT_MOUSE_AUX1_DCLICK(func): Process a {Wx::EVT_AUX1_DCLICK} event.
|
297
|
+
#
|
255
298
|
# - EVT_MOUSE_AUX2_DOWN(func): Process a {Wx::EVT_AUX2_DOWN} event.
|
299
|
+
#
|
256
300
|
# - EVT_MOUSE_AUX2_UP(func): Process a {Wx::EVT_AUX2_UP} event.
|
301
|
+
#
|
257
302
|
# - EVT_MOUSE_AUX2_DCLICK(func): Process a {Wx::EVT_AUX2_DCLICK} event.
|
303
|
+
#
|
258
304
|
# - {Wx::EvtHandler#evt_motion}(meth = nil, &block): Process a {Wx::EVT_MOTION} event.
|
305
|
+
#
|
259
306
|
# - {Wx::EvtHandler#evt_enter_window}(meth = nil, &block): Process a {Wx::EVT_ENTER_WINDOW} event.
|
307
|
+
#
|
260
308
|
# - {Wx::EvtHandler#evt_leave_window}(meth = nil, &block): Process a {Wx::EVT_LEAVE_WINDOW} event.
|
309
|
+
#
|
261
310
|
# - {Wx::EvtHandler#evt_mousewheel}(meth = nil, &block): Process a {Wx::EVT_MOUSEWHEEL} event.
|
311
|
+
#
|
262
312
|
# - {Wx::EvtHandler#evt_mouse_events}(meth = nil, &block): Process all mouse events.
|
313
|
+
#
|
263
314
|
# - {Wx::EvtHandler#evt_magnify}(meth = nil, &block): Process a {Wx::EVT_MAGNIFY} event (new since wxWidgets 3.1.0).
|
264
315
|
#
|
265
316
|
# ===
|
@@ -274,92 +325,111 @@ module Wx
|
|
274
325
|
# Valid event types are:
|
275
326
|
#
|
276
327
|
# - {Wx::EVT_ENTER_WINDOW}
|
328
|
+
#
|
277
329
|
# - {Wx::EVT_LEAVE_WINDOW}
|
330
|
+
#
|
278
331
|
# - {Wx::EVT_LEFT_DOWN}
|
332
|
+
#
|
279
333
|
# - {Wx::EVT_LEFT_UP}
|
334
|
+
#
|
280
335
|
# - {Wx::EVT_LEFT_DCLICK}
|
336
|
+
#
|
281
337
|
# - {Wx::EVT_MIDDLE_DOWN}
|
338
|
+
#
|
282
339
|
# - {Wx::EVT_MIDDLE_UP}
|
340
|
+
#
|
283
341
|
# - {Wx::EVT_MIDDLE_DCLICK}
|
342
|
+
#
|
284
343
|
# - {Wx::EVT_RIGHT_DOWN}
|
344
|
+
#
|
285
345
|
# - {Wx::EVT_RIGHT_UP}
|
346
|
+
#
|
286
347
|
# - {Wx::EVT_RIGHT_DCLICK}
|
348
|
+
#
|
287
349
|
# - {Wx::EVT_AUX1_DOWN}
|
350
|
+
#
|
288
351
|
# - {Wx::EVT_AUX1_UP}
|
352
|
+
#
|
289
353
|
# - {Wx::EVT_AUX1_DCLICK}
|
354
|
+
#
|
290
355
|
# - {Wx::EVT_AUX2_DOWN}
|
356
|
+
#
|
291
357
|
# - {Wx::EVT_AUX2_UP}
|
358
|
+
#
|
292
359
|
# - {Wx::EVT_AUX2_DCLICK}
|
360
|
+
#
|
293
361
|
# - {Wx::EVT_MOTION}
|
362
|
+
#
|
294
363
|
# - {Wx::EVT_MOUSEWHEEL}
|
364
|
+
#
|
295
365
|
# - {Wx::EVT_MAGNIFY}
|
296
|
-
# @param mouseEventType [
|
297
|
-
# @return [MouseEvent]
|
366
|
+
# @param mouseEventType [Wx::CommandLinkButton::EventType]
|
367
|
+
# @return [Wx::MouseEvent]
|
298
368
|
def initialize(mouseEventType=Wx::EVT_NULL) end
|
299
369
|
|
300
370
|
# Returns true if the event was a first extra button double click.
|
301
|
-
# @return [
|
371
|
+
# @return [Boolean]
|
302
372
|
def aux1d_click; end
|
303
373
|
|
304
374
|
# Returns true if the first extra button mouse button changed to down.
|
305
|
-
# @return [
|
375
|
+
# @return [Boolean]
|
306
376
|
def aux1down; end
|
307
377
|
|
308
378
|
# Returns true if the first extra button mouse button changed to up.
|
309
|
-
# @return [
|
379
|
+
# @return [Boolean]
|
310
380
|
def aux1up; end
|
311
381
|
|
312
382
|
# Returns true if the event was a second extra button double click.
|
313
|
-
# @return [
|
383
|
+
# @return [Boolean]
|
314
384
|
def aux2d_click; end
|
315
385
|
|
316
386
|
# Returns true if the second extra button mouse button changed to down.
|
317
|
-
# @return [
|
387
|
+
# @return [Boolean]
|
318
388
|
def aux2down; end
|
319
389
|
|
320
390
|
# Returns true if the second extra button mouse button changed to up.
|
321
|
-
# @return [
|
391
|
+
# @return [Boolean]
|
322
392
|
def aux2up; end
|
323
393
|
|
324
394
|
# Returns true if the event was generated by the specified button.
|
325
395
|
#
|
326
396
|
# @see wxMouseState::ButtoinIsDown()
|
327
|
-
# @param but [MouseButton]
|
328
|
-
# @return [
|
397
|
+
# @param but [Wx::MouseButton]
|
398
|
+
# @return [Boolean]
|
329
399
|
def button(but) end
|
330
400
|
|
331
401
|
# If the argument is omitted, this returns true if the event was a mouse double click event.
|
332
402
|
# Otherwise the argument specifies which double click event was generated (see {Wx::MouseEvent#button} for the possible values).
|
333
|
-
# @param but [MouseButton]
|
334
|
-
# @return [
|
335
|
-
def button_d_click(but=Wx::MOUSE_BTN_ANY) end
|
403
|
+
# @param but [Wx::MouseButton]
|
404
|
+
# @return [Boolean]
|
405
|
+
def button_d_click(but=Wx::MouseButton::MOUSE_BTN_ANY) end
|
336
406
|
|
337
407
|
# If the argument is omitted, this returns true if the event was a mouse button down event.
|
338
408
|
# Otherwise the argument specifies which button-down event was generated (see {Wx::MouseEvent#button} for the possible values).
|
339
|
-
# @param but [MouseButton]
|
340
|
-
# @return [
|
341
|
-
def button_down(but=Wx::MOUSE_BTN_ANY) end
|
409
|
+
# @param but [Wx::MouseButton]
|
410
|
+
# @return [Boolean]
|
411
|
+
def button_down(but=Wx::MouseButton::MOUSE_BTN_ANY) end
|
342
412
|
|
343
413
|
# If the argument is omitted, this returns true if the event was a mouse button up event.
|
344
414
|
# Otherwise the argument specifies which button-up event was generated (see {Wx::MouseEvent#button} for the possible values).
|
345
|
-
# @param but [MouseButton]
|
346
|
-
# @return [
|
347
|
-
def button_up(but=Wx::MOUSE_BTN_ANY) end
|
415
|
+
# @param but [Wx::MouseButton]
|
416
|
+
# @return [Boolean]
|
417
|
+
def button_up(but=Wx::MouseButton::MOUSE_BTN_ANY) end
|
348
418
|
|
349
419
|
# Returns true if this was a dragging event (motion while a button is depressed).
|
350
420
|
#
|
351
421
|
# @see Wx::MouseEvent#moving
|
352
|
-
# @return [
|
422
|
+
# @return [Boolean]
|
353
423
|
def dragging; end
|
354
424
|
|
355
425
|
# Returns true if the mouse was entering the window.
|
356
426
|
#
|
357
427
|
# @see Wx::MouseEvent#leaving
|
358
|
-
# @return [
|
428
|
+
# @return [Boolean]
|
359
429
|
def entering; end
|
360
430
|
|
361
|
-
# Returns the mouse button which generated this event or {Wx::MOUSE_BTN_NONE} if no button is involved (for mouse move, enter or leave event, for example).
|
362
|
-
# Otherwise {Wx::MOUSE_BTN_LEFT} is returned for the left button down, up and double click events, {Wx::MOUSE_BTN_MIDDLE} and {Wx::MOUSE_BTN_RIGHT} for the same events for the middle and the right buttons respectively.
|
431
|
+
# 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).
|
432
|
+
# 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.
|
363
433
|
# @return [Integer]
|
364
434
|
def get_button; end
|
365
435
|
|
@@ -405,7 +475,7 @@ module Wx
|
|
405
475
|
|
406
476
|
# On Mac, has the user selected "Natural" scrolling in their System Preferences? Currently false on all other OS's.
|
407
477
|
# "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.
|
408
|
-
# @return [
|
478
|
+
# @return [Boolean]
|
409
479
|
def is_wheel_inverted; end
|
410
480
|
alias_method :wheel_inverted?, :is_wheel_inverted
|
411
481
|
|
@@ -419,75 +489,75 @@ module Wx
|
|
419
489
|
# Gets the axis the wheel operation concerns.
|
420
490
|
# 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.
|
421
491
|
# Notice that before wxWidgets 2.9.4 this method returned int.
|
422
|
-
# @return [MouseWheelAxis]
|
492
|
+
# @return [Wx::MouseWheelAxis]
|
423
493
|
def get_wheel_axis; end
|
424
494
|
alias_method :wheel_axis, :get_wheel_axis
|
425
495
|
|
426
496
|
# Returns true if the event was a mouse button event (not necessarily a button down event - that may be tested using {Wx::MouseEvent#button_down}).
|
427
|
-
# @return [
|
497
|
+
# @return [Boolean]
|
428
498
|
def is_button; end
|
429
499
|
alias_method :button?, :is_button
|
430
500
|
|
431
501
|
# Returns true if the system has been setup to do page scrolling with the mouse wheel instead of line scrolling.
|
432
|
-
# @return [
|
502
|
+
# @return [Boolean]
|
433
503
|
def is_page_scroll; end
|
434
504
|
alias_method :page_scroll?, :is_page_scroll
|
435
505
|
|
436
506
|
# Returns true if the mouse was leaving the window.
|
437
507
|
#
|
438
508
|
# @see Wx::MouseEvent#entering.
|
439
|
-
# @return [
|
509
|
+
# @return [Boolean]
|
440
510
|
def leaving; end
|
441
511
|
|
442
512
|
# Returns true if the event was a left double click.
|
443
|
-
# @return [
|
513
|
+
# @return [Boolean]
|
444
514
|
def left_d_click; end
|
445
515
|
|
446
516
|
# Returns true if the left mouse button changed to down.
|
447
|
-
# @return [
|
517
|
+
# @return [Boolean]
|
448
518
|
def left_down; end
|
449
519
|
|
450
520
|
# Returns true if the left mouse button changed to up.
|
451
|
-
# @return [
|
521
|
+
# @return [Boolean]
|
452
522
|
def left_up; end
|
453
523
|
|
454
524
|
# Returns true if the event is a magnify (i.e. pinch to zoom) event.
|
455
525
|
# Such events are currently generated only under macOS.
|
456
526
|
# @see Wx::MouseEvent#get_magnification
|
457
|
-
# @return [
|
527
|
+
# @return [Boolean]
|
458
528
|
def magnify; end
|
459
529
|
|
460
530
|
# Returns true if the Meta key was down at the time of the event.
|
461
|
-
# @return [
|
531
|
+
# @return [Boolean]
|
462
532
|
def meta_down; end
|
463
533
|
|
464
534
|
# Returns true if the event was a middle double click.
|
465
|
-
# @return [
|
535
|
+
# @return [Boolean]
|
466
536
|
def middle_d_click; end
|
467
537
|
|
468
538
|
# Returns true if the middle mouse button changed to down.
|
469
|
-
# @return [
|
539
|
+
# @return [Boolean]
|
470
540
|
def middle_down; end
|
471
541
|
|
472
542
|
# Returns true if the middle mouse button changed to up.
|
473
|
-
# @return [
|
543
|
+
# @return [Boolean]
|
474
544
|
def middle_up; end
|
475
545
|
|
476
546
|
# Returns true if this was a motion event and no mouse buttons were pressed.
|
477
547
|
# If any mouse button is held pressed, then this method returns false and {Wx::MouseEvent#dragging} returns true.
|
478
|
-
# @return [
|
548
|
+
# @return [Boolean]
|
479
549
|
def moving; end
|
480
550
|
|
481
551
|
# Returns true if the event was a right double click.
|
482
|
-
# @return [
|
552
|
+
# @return [Boolean]
|
483
553
|
def right_d_click; end
|
484
554
|
|
485
555
|
# Returns true if the right mouse button changed to down.
|
486
|
-
# @return [
|
556
|
+
# @return [Boolean]
|
487
557
|
def right_down; end
|
488
558
|
|
489
559
|
# Returns true if the right mouse button changed to up.
|
490
|
-
# @return [
|
560
|
+
# @return [Boolean]
|
491
561
|
def right_up; end
|
492
562
|
|
493
563
|
# Returns the physical mouse position.
|
@@ -506,23 +576,23 @@ module Wx
|
|
506
576
|
alias_method :y, :get_y
|
507
577
|
|
508
578
|
# Returns true if the left mouse button is currently down.
|
509
|
-
# @return [
|
579
|
+
# @return [Boolean]
|
510
580
|
def left_is_down; end
|
511
581
|
|
512
582
|
# Returns true if the middle mouse button is currently down.
|
513
|
-
# @return [
|
583
|
+
# @return [Boolean]
|
514
584
|
def middle_is_down; end
|
515
585
|
|
516
586
|
# Returns true if the right mouse button is currently down.
|
517
|
-
# @return [
|
587
|
+
# @return [Boolean]
|
518
588
|
def right_is_down; end
|
519
589
|
|
520
590
|
# Returns true if the first extra button mouse button is currently down.
|
521
|
-
# @return [
|
591
|
+
# @return [Boolean]
|
522
592
|
def aux1is_down; end
|
523
593
|
|
524
594
|
# Returns true if the second extra button mouse button is currently down.
|
525
|
-
# @return [
|
595
|
+
# @return [Boolean]
|
526
596
|
def aux2is_down; end
|
527
597
|
|
528
598
|
# @param x [Integer]
|
@@ -540,27 +610,27 @@ module Wx
|
|
540
610
|
def set_position(pos) end
|
541
611
|
alias_method :position=, :set_position
|
542
612
|
|
543
|
-
# @param down [
|
613
|
+
# @param down [Boolean]
|
544
614
|
# @return [void]
|
545
615
|
def set_left_down(down) end
|
546
616
|
alias_method :left_down=, :set_left_down
|
547
617
|
|
548
|
-
# @param down [
|
618
|
+
# @param down [Boolean]
|
549
619
|
# @return [void]
|
550
620
|
def set_middle_down(down) end
|
551
621
|
alias_method :middle_down=, :set_middle_down
|
552
622
|
|
553
|
-
# @param down [
|
623
|
+
# @param down [Boolean]
|
554
624
|
# @return [void]
|
555
625
|
def set_right_down(down) end
|
556
626
|
alias_method :right_down=, :set_right_down
|
557
627
|
|
558
|
-
# @param down [
|
628
|
+
# @param down [Boolean]
|
559
629
|
# @return [void]
|
560
630
|
def set_aux1down(down) end
|
561
631
|
alias_method :aux1down=, :set_aux1down
|
562
632
|
|
563
|
-
# @param down [
|
633
|
+
# @param down [Boolean]
|
564
634
|
# @return [void]
|
565
635
|
def set_aux2down(down) end
|
566
636
|
alias_method :aux2down=, :set_aux2down
|
@@ -594,67 +664,67 @@ module Wx
|
|
594
664
|
# Returns true if any modifiers at all are pressed.
|
595
665
|
# This is equivalent to <code>Wx::MouseEvent#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
|
596
666
|
# 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.
|
597
|
-
# @return [
|
667
|
+
# @return [Boolean]
|
598
668
|
def has_any_modifiers; end
|
599
669
|
alias_method :has_any_modifiers?, :has_any_modifiers
|
600
670
|
|
601
671
|
# Returns true if Control or Alt are pressed.
|
602
672
|
# 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).
|
603
673
|
# 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.
|
604
|
-
# @return [
|
674
|
+
# @return [Boolean]
|
605
675
|
def has_modifiers; end
|
606
676
|
alias_method :has_modifiers?, :has_modifiers
|
607
677
|
|
608
678
|
# Returns true if the Control key or Apple/Command key under macOS is pressed.
|
609
679
|
# This function doesn't distinguish between right and left control keys.
|
610
680
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
611
|
-
# @return [
|
681
|
+
# @return [Boolean]
|
612
682
|
def control_down; end
|
613
683
|
|
614
684
|
# Returns true if the Control key (also under macOS).
|
615
685
|
# This function doesn't distinguish between right and left control keys.
|
616
686
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
617
|
-
# @return [
|
687
|
+
# @return [Boolean]
|
618
688
|
def raw_control_down; end
|
619
689
|
|
620
690
|
# Returns true if the Shift key is pressed.
|
621
691
|
# This function doesn't distinguish between right and left shift keys.
|
622
692
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
623
|
-
# @return [
|
693
|
+
# @return [Boolean]
|
624
694
|
def shift_down; end
|
625
695
|
|
626
696
|
# Returns true if the Alt key is pressed.
|
627
697
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
628
|
-
# @return [
|
698
|
+
# @return [Boolean]
|
629
699
|
def alt_down; end
|
630
700
|
|
631
701
|
# Returns true if the key used for command accelerators is pressed.
|
632
702
|
# Same as {Wx::MouseEvent#control_down}. Deprecated.
|
633
703
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
634
|
-
# @return [
|
704
|
+
# @return [Boolean]
|
635
705
|
def cmd_down; end
|
636
706
|
|
637
|
-
# @param down [
|
707
|
+
# @param down [Boolean]
|
638
708
|
# @return [void]
|
639
709
|
def set_control_down(down) end
|
640
710
|
alias_method :control_down=, :set_control_down
|
641
711
|
|
642
|
-
# @param down [
|
712
|
+
# @param down [Boolean]
|
643
713
|
# @return [void]
|
644
714
|
def set_raw_control_down(down) end
|
645
715
|
alias_method :raw_control_down=, :set_raw_control_down
|
646
716
|
|
647
|
-
# @param down [
|
717
|
+
# @param down [Boolean]
|
648
718
|
# @return [void]
|
649
719
|
def set_shift_down(down) end
|
650
720
|
alias_method :shift_down=, :set_shift_down
|
651
721
|
|
652
|
-
# @param down [
|
722
|
+
# @param down [Boolean]
|
653
723
|
# @return [void]
|
654
724
|
def set_alt_down(down) end
|
655
725
|
alias_method :alt_down=, :set_alt_down
|
656
726
|
|
657
|
-
# @param down [
|
727
|
+
# @param down [Boolean]
|
658
728
|
# @return [void]
|
659
729
|
def set_meta_down(down) end
|
660
730
|
alias_method :meta_down=, :set_meta_down
|
@@ -667,6 +737,7 @@ module Wx
|
|
667
737
|
#
|
668
738
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::SetCursorEvent} events.
|
669
739
|
# Event handler methods:
|
740
|
+
#
|
670
741
|
# - {Wx::EvtHandler#evt_set_cursor}(meth = nil, &block): Process a {Wx::EVT_SET_CURSOR} event.
|
671
742
|
#
|
672
743
|
# ===
|
@@ -681,7 +752,7 @@ module Wx
|
|
681
752
|
# Constructor, used by the library itself internally to initialize the event object.
|
682
753
|
# @param x [Integer]
|
683
754
|
# @param y [Integer]
|
684
|
-
# @return [SetCursorEvent]
|
755
|
+
# @return [Wx::SetCursorEvent]
|
685
756
|
def initialize(x=0, y=0) end
|
686
757
|
|
687
758
|
# Returns a reference to the cursor specified by this event.
|
@@ -701,7 +772,7 @@ module Wx
|
|
701
772
|
|
702
773
|
# Returns true if the cursor specified by this event is a valid cursor.
|
703
774
|
# You cannot specify {Wx::NULL_CURSOR} with this event, as it is not considered a valid cursor.
|
704
|
-
# @return [
|
775
|
+
# @return [Boolean]
|
705
776
|
def has_cursor; end
|
706
777
|
alias_method :has_cursor?, :has_cursor
|
707
778
|
|
@@ -728,8 +799,8 @@ module Wx
|
|
728
799
|
|
729
800
|
# Constructor.
|
730
801
|
# @param winid [Integer]
|
731
|
-
# @param type [
|
732
|
-
# @return [GestureEvent]
|
802
|
+
# @param type [Wx::CommandLinkButton::EventType]
|
803
|
+
# @return [Wx::GestureEvent]
|
733
804
|
def initialize(winid=0, type=Wx::EVT_NULL) end
|
734
805
|
|
735
806
|
# Returns the position where the event took effect, in client coordinates: position of Pan event, center of zoom for Zoom event, center of rotation for Rotate event, center of box formed by 2 fingers for Two Finger Tap event and position of the pressed finger for Press and Tap Event.
|
@@ -738,12 +809,12 @@ module Wx
|
|
738
809
|
alias_method :position, :get_position
|
739
810
|
|
740
811
|
# Returns true if the event was the first in a gesture sequence.
|
741
|
-
# @return [
|
812
|
+
# @return [Boolean]
|
742
813
|
def is_gesture_start; end
|
743
814
|
alias_method :gesture_start?, :is_gesture_start
|
744
815
|
|
745
816
|
# Returns true if the event was the last in a gesture sequence.
|
746
|
-
# @return [
|
817
|
+
# @return [Boolean]
|
747
818
|
def is_gesture_end; end
|
748
819
|
alias_method :gesture_end?, :is_gesture_end
|
749
820
|
|
@@ -754,13 +825,13 @@ module Wx
|
|
754
825
|
alias_method :position=, :set_position
|
755
826
|
|
756
827
|
# Sets the event to be the first in a gesture sequence.
|
757
|
-
# @param isStart [
|
828
|
+
# @param isStart [Boolean]
|
758
829
|
# @return [void]
|
759
830
|
def set_gesture_start(isStart=true) end
|
760
831
|
alias_method :gesture_start=, :set_gesture_start
|
761
832
|
|
762
833
|
# Sets the event to be the last in a gesture sequence.
|
763
|
-
# @param isEnd [
|
834
|
+
# @param isEnd [Boolean]
|
764
835
|
# @return [void]
|
765
836
|
def set_gesture_end(isEnd=true) end
|
766
837
|
alias_method :gesture_end=, :set_gesture_end
|
@@ -768,12 +839,13 @@ module Wx
|
|
768
839
|
end # GestureEvent
|
769
840
|
|
770
841
|
# This event is generated when the user moves a finger on the surface.
|
771
|
-
#
|
842
|
+
# wxGTK also generates this event during mouse dragging (mouse motion while a left mouse button is depressed).
|
772
843
|
# Note that OSX requires the primary mouse button to be pressed while performing the finger movement.
|
773
844
|
# === Events using this class
|
774
845
|
#
|
775
846
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::PanGestureEvent} events.
|
776
847
|
# Event handler methods:
|
848
|
+
#
|
777
849
|
# - {Wx::EvtHandler#evt_gesture_pan}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_PAN}.
|
778
850
|
#
|
779
851
|
# ===
|
@@ -784,7 +856,7 @@ module Wx
|
|
784
856
|
|
785
857
|
# Constructor.
|
786
858
|
# @param winid [Integer]
|
787
|
-
# @return [PanGestureEvent]
|
859
|
+
# @return [Wx::PanGestureEvent]
|
788
860
|
def initialize(winid=0) end
|
789
861
|
|
790
862
|
# Returns the distance covered since the previous panning event.
|
@@ -805,6 +877,7 @@ module Wx
|
|
805
877
|
#
|
806
878
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ZoomGestureEvent} events.
|
807
879
|
# Event handler methods:
|
880
|
+
#
|
808
881
|
# - {Wx::EvtHandler#evt_gesture_zoom}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_ZOOM}.
|
809
882
|
#
|
810
883
|
# ===
|
@@ -815,7 +888,7 @@ module Wx
|
|
815
888
|
|
816
889
|
# Constructor.
|
817
890
|
# @param windid [Integer]
|
818
|
-
# @return [ZoomGestureEvent]
|
891
|
+
# @return [Wx::ZoomGestureEvent]
|
819
892
|
def initialize(windid=0) end
|
820
893
|
|
821
894
|
# Returns the zoom Factor since the gesture started.
|
@@ -837,6 +910,7 @@ module Wx
|
|
837
910
|
#
|
838
911
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::RotateGestureEvent} events.
|
839
912
|
# Event handler methods:
|
913
|
+
#
|
840
914
|
# - {Wx::EvtHandler#evt_gesture_rotate}(id, meth = nil, &block): Process a {Wx::EVT_GESTURE_ROTATE}.
|
841
915
|
#
|
842
916
|
# ===
|
@@ -847,7 +921,7 @@ module Wx
|
|
847
921
|
|
848
922
|
# Constructor.
|
849
923
|
# @param windid [Integer]
|
850
|
-
# @return [RotateGestureEvent]
|
924
|
+
# @return [Wx::RotateGestureEvent]
|
851
925
|
def initialize(windid=0) end
|
852
926
|
|
853
927
|
# Returns the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
|
@@ -870,6 +944,7 @@ module Wx
|
|
870
944
|
#
|
871
945
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::TwoFingerTapEvent} events.
|
872
946
|
# Event handler methods:
|
947
|
+
#
|
873
948
|
# - {Wx::EvtHandler#evt_two_finger_tap}(id, meth = nil, &block): Process a {Wx::EVT_TWO_FINGER_TAP}.
|
874
949
|
#
|
875
950
|
# ===
|
@@ -880,18 +955,19 @@ module Wx
|
|
880
955
|
|
881
956
|
# Constructor.
|
882
957
|
# @param windid [Integer]
|
883
|
-
# @return [TwoFingerTapEvent]
|
958
|
+
# @return [Wx::TwoFingerTapEvent]
|
884
959
|
def initialize(windid=0) end
|
885
960
|
|
886
961
|
end # TwoFingerTapEvent
|
887
962
|
|
888
963
|
# This event is generated when one finger touches the surface and remains stationary.
|
889
|
-
# Note that currently it is only generated under
|
890
|
-
#
|
964
|
+
# Note that currently it is only generated under wxGTK and wxOSX.
|
965
|
+
# wxGTK also generates this event when left mouse button is being pressed for some minimum duration of time.
|
891
966
|
# === Events using this class
|
892
967
|
#
|
893
968
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::LongPressEvent} events.
|
894
969
|
# Event handler methods:
|
970
|
+
#
|
895
971
|
# - {Wx::EvtHandler#evt_long_press}(id, meth = nil, &block): Process a {Wx::EVT_LONG_PRESS}.
|
896
972
|
#
|
897
973
|
# ===
|
@@ -902,7 +978,7 @@ module Wx
|
|
902
978
|
|
903
979
|
# Constructor.
|
904
980
|
# @param windid [Integer]
|
905
|
-
# @return [LongPressEvent]
|
981
|
+
# @return [Wx::LongPressEvent]
|
906
982
|
def initialize(windid=0) end
|
907
983
|
|
908
984
|
end # LongPressEvent
|
@@ -913,6 +989,7 @@ module Wx
|
|
913
989
|
#
|
914
990
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::PressAndTapEvent} events.
|
915
991
|
# Event handler methods:
|
992
|
+
#
|
916
993
|
# - {Wx::EvtHandler#evt_press_and_tap}(id, meth = nil, &block): Process a {Wx::EVT_PRESS_AND_TAP}.
|
917
994
|
#
|
918
995
|
# ===
|
@@ -923,7 +1000,7 @@ module Wx
|
|
923
1000
|
|
924
1001
|
# Constructor.
|
925
1002
|
# @param windid [Integer]
|
926
|
-
# @return [PressAndTapEvent]
|
1003
|
+
# @return [Wx::PressAndTapEvent]
|
927
1004
|
def initialize(windid=0) end
|
928
1005
|
|
929
1006
|
end # PressAndTapEvent
|
@@ -932,7 +1009,10 @@ module Wx
|
|
932
1009
|
# 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::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::K_NONE} for any non-Latin-1 ones. If both {Wx::KeyEvent#get_unicode_key} and {Wx::KeyEvent#get_key_code} return {Wx::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::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::K_NONE} or simply ignore that key.
|
933
1010
|
# 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.
|
934
1011
|
# 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:
|
935
|
-
#
|
1012
|
+
#
|
1013
|
+
# - For the letters they correspond to the upper case value of the letter.
|
1014
|
+
# - For the other alphanumeric keys (e.g. 7 or <code>+</code>), the untranslated key code corresponds to the character produced by the key when it is pressed without Shift. E.g. in standard US keyboard layout the untranslated key code for the key <code>=/+</code> in the upper right corner of the keyboard is 61 which is the ASCII value of <code>=</code>.
|
1015
|
+
# - For the rest of the keys (i.e. special non-printable keys) it is the same as the normal key code as no translation is used anyhow.
|
936
1016
|
#
|
937
1017
|
# Notice that the first rule applies to all Unicode letters, not just the usual Latin-1 ones. However for non-Latin-1 letters only {Wx::KeyEvent#get_unicode_key} can be used to retrieve the key code as {Wx::KeyEvent#get_key_code} just returns {Wx::K_NONE} in this case.
|
938
1018
|
# Also, note that {Wx::EVT_CHAR} events are not generated for keys which do not have a wxWidgets mapping, so {Wx::KeyEvent#get_raw_key_code} should never be required for this event.
|
@@ -953,9 +1033,13 @@ module Wx
|
|
953
1033
|
#
|
954
1034
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::KeyEvent} events.
|
955
1035
|
# Event handler methods:
|
1036
|
+
#
|
956
1037
|
# - {Wx::EvtHandler#evt_key_down}(meth = nil, &block): Process a {Wx::EVT_KEY_DOWN} event (any key has been pressed). If this event is handled and not skipped, {Wx::EVT_CHAR} will not be generated at all for this key press (but {Wx::EVT_KEY_UP} will be).
|
1038
|
+
#
|
957
1039
|
# - {Wx::EvtHandler#evt_key_up}(meth = nil, &block): Process a {Wx::EVT_KEY_UP} event (any key has been released).
|
1040
|
+
#
|
958
1041
|
# - {Wx::EvtHandler#evt_char}(meth = nil, &block): Process a {Wx::EVT_CHAR} event.
|
1042
|
+
#
|
959
1043
|
# - {Wx::EvtHandler#evt_char_hook}(meth = nil, &block): Process a {Wx::EVT_CHAR_HOOK} event. Unlike all the other key events, this event is propagated upwards the window hierarchy which allows intercepting it in the parent window of the focused window to which it is sent initially (if there is no focused window, this event is sent to the {Wx::App} global object). It is also generated before any other key events and so gives the parent window an opportunity to modify the keyboard handling of its children, e.g. it is used internally by wxWidgets in some ports to intercept pressing Esc key in any child of a dialog to close the dialog itself when it's pressed. By default, if this event is handled, i.e. the handler doesn't call {Wx::Event#skip}, neither {Wx::EVT_KEY_DOWN} nor {Wx::EVT_CHAR} events will be generated (although {Wx::EVT_KEY_UP} still will be), i.e. it replaces the normal key events. However by calling the special {Wx::KeyEvent#do_allow_next_event} method you can handle {Wx::EVT_CHAR_HOOK} and still allow normal events generation. This is something that is rarely useful but can be required if you need to prevent a parent {Wx::EVT_CHAR_HOOK} handler from running without suppressing the normal key events. Finally notice that this event is not generated when the mouse is captured as it is considered that the window which has the capture should receive all the keyboard events too without allowing its parent {Wx::TopLevelWindow} to interfere with their processing.
|
960
1044
|
#
|
961
1045
|
# ===
|
@@ -975,8 +1059,8 @@ module Wx
|
|
975
1059
|
|
976
1060
|
# Constructor.
|
977
1061
|
# Currently, the only valid event types are {Wx::EVT_CHAR} and {Wx::EVT_CHAR_HOOK}.
|
978
|
-
# @param keyEventType [
|
979
|
-
# @return [KeyEvent]
|
1062
|
+
# @param keyEventType [Wx::CommandLinkButton::EventType]
|
1063
|
+
# @return [Wx::KeyEvent]
|
980
1064
|
def initialize(keyEventType=Wx::EVT_NULL) end
|
981
1065
|
|
982
1066
|
# Returns the key code of the key that generated this event.
|
@@ -1014,12 +1098,12 @@ module Wx
|
|
1014
1098
|
|
1015
1099
|
# Returns true if the key is in the given key category.
|
1016
1100
|
# @param category [Integer] A bitwise combination of named {Wx::KeyCategoryFlags} constants.
|
1017
|
-
# @return [
|
1101
|
+
# @return [Boolean]
|
1018
1102
|
def is_key_in_category(category) end
|
1019
1103
|
alias_method :key_in_category?, :is_key_in_category
|
1020
1104
|
|
1021
1105
|
# Returns true if this event is an auto-repeat of the key, false if this is the initial key press.
|
1022
|
-
# @return [
|
1106
|
+
# @return [Boolean]
|
1023
1107
|
def is_auto_repeat; end
|
1024
1108
|
alias_method :auto_repeat?, :is_auto_repeat
|
1025
1109
|
|
@@ -1072,7 +1156,7 @@ module Wx
|
|
1072
1156
|
|
1073
1157
|
# Returns true if {Wx::KeyEvent#do_allow_next_event} had been called, false by default.
|
1074
1158
|
# This method is used by wxWidgets itself to determine whether the normal key events should be generated after {Wx::EVT_CHAR_HOOK} processing.
|
1075
|
-
# @return [
|
1159
|
+
# @return [Boolean]
|
1076
1160
|
def is_next_event_allowed; end
|
1077
1161
|
alias_method :next_event_allowed?, :is_next_event_allowed
|
1078
1162
|
|
@@ -1100,73 +1184,73 @@ module Wx
|
|
1100
1184
|
# Returns true if any modifiers at all are pressed.
|
1101
1185
|
# This is equivalent to <code>Wx::KeyEvent#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
|
1102
1186
|
# 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.
|
1103
|
-
# @return [
|
1187
|
+
# @return [Boolean]
|
1104
1188
|
def has_any_modifiers; end
|
1105
1189
|
alias_method :has_any_modifiers?, :has_any_modifiers
|
1106
1190
|
|
1107
1191
|
# Returns true if Control or Alt are pressed.
|
1108
1192
|
# 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).
|
1109
1193
|
# 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.
|
1110
|
-
# @return [
|
1194
|
+
# @return [Boolean]
|
1111
1195
|
def has_modifiers; end
|
1112
1196
|
alias_method :has_modifiers?, :has_modifiers
|
1113
1197
|
|
1114
1198
|
# Returns true if the Control key or Apple/Command key under macOS is pressed.
|
1115
1199
|
# This function doesn't distinguish between right and left control keys.
|
1116
1200
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1117
|
-
# @return [
|
1201
|
+
# @return [Boolean]
|
1118
1202
|
def control_down; end
|
1119
1203
|
|
1120
1204
|
# Returns true if the Control key (also under macOS).
|
1121
1205
|
# This function doesn't distinguish between right and left control keys.
|
1122
1206
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1123
|
-
# @return [
|
1207
|
+
# @return [Boolean]
|
1124
1208
|
def raw_control_down; end
|
1125
1209
|
|
1126
1210
|
# Returns true if the Shift key is pressed.
|
1127
1211
|
# This function doesn't distinguish between right and left shift keys.
|
1128
1212
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1129
|
-
# @return [
|
1213
|
+
# @return [Boolean]
|
1130
1214
|
def shift_down; end
|
1131
1215
|
|
1132
1216
|
# Returns true if the Meta/Windows/Apple key is pressed.
|
1133
1217
|
# 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.
|
1134
1218
|
# @see Wx::KeyEvent#cmd_down
|
1135
|
-
# @return [
|
1219
|
+
# @return [Boolean]
|
1136
1220
|
def meta_down; end
|
1137
1221
|
|
1138
1222
|
# Returns true if the Alt key is pressed.
|
1139
1223
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1140
|
-
# @return [
|
1224
|
+
# @return [Boolean]
|
1141
1225
|
def alt_down; end
|
1142
1226
|
|
1143
1227
|
# Returns true if the key used for command accelerators is pressed.
|
1144
1228
|
# Same as {Wx::KeyEvent#control_down}. Deprecated.
|
1145
1229
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1146
|
-
# @return [
|
1230
|
+
# @return [Boolean]
|
1147
1231
|
def cmd_down; end
|
1148
1232
|
|
1149
|
-
# @param down [
|
1233
|
+
# @param down [Boolean]
|
1150
1234
|
# @return [void]
|
1151
1235
|
def set_control_down(down) end
|
1152
1236
|
alias_method :control_down=, :set_control_down
|
1153
1237
|
|
1154
|
-
# @param down [
|
1238
|
+
# @param down [Boolean]
|
1155
1239
|
# @return [void]
|
1156
1240
|
def set_raw_control_down(down) end
|
1157
1241
|
alias_method :raw_control_down=, :set_raw_control_down
|
1158
1242
|
|
1159
|
-
# @param down [
|
1243
|
+
# @param down [Boolean]
|
1160
1244
|
# @return [void]
|
1161
1245
|
def set_shift_down(down) end
|
1162
1246
|
alias_method :shift_down=, :set_shift_down
|
1163
1247
|
|
1164
|
-
# @param down [
|
1248
|
+
# @param down [Boolean]
|
1165
1249
|
# @return [void]
|
1166
1250
|
def set_alt_down(down) end
|
1167
1251
|
alias_method :alt_down=, :set_alt_down
|
1168
1252
|
|
1169
|
-
# @param down [
|
1253
|
+
# @param down [Boolean]
|
1170
1254
|
# @return [void]
|
1171
1255
|
def set_meta_down(down) end
|
1172
1256
|
alias_method :meta_down=, :set_meta_down
|
@@ -1183,6 +1267,7 @@ module Wx
|
|
1183
1267
|
#
|
1184
1268
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::SizeEvent} events.
|
1185
1269
|
# Event handler methods:
|
1270
|
+
#
|
1186
1271
|
# - {Wx::EvtHandler#evt_size}(meth = nil, &block): Process a {Wx::EVT_SIZE} event.
|
1187
1272
|
#
|
1188
1273
|
# ===
|
@@ -1197,7 +1282,7 @@ module Wx
|
|
1197
1282
|
# Constructor.
|
1198
1283
|
# @param sz [Array(Integer, Integer), Wx::Size]
|
1199
1284
|
# @param id [Integer]
|
1200
|
-
# @return [SizeEvent]
|
1285
|
+
# @return [Wx::SizeEvent]
|
1201
1286
|
def initialize(sz, id=0) end
|
1202
1287
|
|
1203
1288
|
# Returns the entire size of the window generating the size change event.
|
@@ -1223,15 +1308,19 @@ module Wx
|
|
1223
1308
|
end # SizeEvent
|
1224
1309
|
|
1225
1310
|
# A move event holds information about window position change.
|
1226
|
-
# These events are currently generated for top level (see {Wx::TopLevelWindow}) windows in all ports, but are not generated for the child windows in
|
1311
|
+
# 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.
|
1227
1312
|
# === Events using this class
|
1228
1313
|
#
|
1229
1314
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::MoveEvent} events.
|
1230
1315
|
# Event handler methods:
|
1316
|
+
#
|
1231
1317
|
# - {Wx::EvtHandler#evt_move}(meth = nil, &block): Process a {Wx::EVT_MOVE} event, which is generated when a window is moved.
|
1232
|
-
#
|
1233
|
-
# - {Wx::EvtHandler#
|
1234
|
-
#
|
1318
|
+
#
|
1319
|
+
# - {Wx::EvtHandler#evt_move_start}(meth = nil, &block): Process a {Wx::EVT_MOVE_START} event, which is generated when the user starts to move or size a window. wxMSW only.
|
1320
|
+
#
|
1321
|
+
# - {Wx::EvtHandler#evt_moving}(meth = nil, &block): Process a {Wx::EVT_MOVING} event, which is generated while the user is moving the window. wxMSW only.
|
1322
|
+
#
|
1323
|
+
# - {Wx::EvtHandler#evt_move_end}(meth = nil, &block): Process a {Wx::EVT_MOVE_END} event, which is generated when the user stops moving or sizing a window. wxMSW only.
|
1235
1324
|
#
|
1236
1325
|
# ===
|
1237
1326
|
#
|
@@ -1245,7 +1334,7 @@ module Wx
|
|
1245
1334
|
# Constructor.
|
1246
1335
|
# @param pt [Array(Integer, Integer), Wx::Point]
|
1247
1336
|
# @param id [Integer]
|
1248
|
-
# @return [MoveEvent]
|
1337
|
+
# @return [Wx::MoveEvent]
|
1249
1338
|
def initialize(pt, id=0) end
|
1250
1339
|
|
1251
1340
|
# Returns the position of the window generating the move change event.
|
@@ -1310,6 +1399,7 @@ module Wx
|
|
1310
1399
|
#
|
1311
1400
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::PaintEvent} events.
|
1312
1401
|
# Event handler methods:
|
1402
|
+
#
|
1313
1403
|
# - {Wx::EvtHandler#evt_paint}(meth = nil, &block): Process a {Wx::EVT_PAINT} event.
|
1314
1404
|
#
|
1315
1405
|
# ===
|
@@ -1323,7 +1413,7 @@ module Wx
|
|
1323
1413
|
# Constructor for exclusive use of wxWidgets itself.
|
1324
1414
|
# 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.
|
1325
1415
|
# @param window [Wx::Window]
|
1326
|
-
# @return [PaintEvent]
|
1416
|
+
# @return [Wx::PaintEvent]
|
1327
1417
|
def initialize(window) end
|
1328
1418
|
|
1329
1419
|
end # PaintEvent
|
@@ -1336,6 +1426,7 @@ module Wx
|
|
1336
1426
|
#
|
1337
1427
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::EraseEvent} events.
|
1338
1428
|
# Event handler methods:
|
1429
|
+
#
|
1339
1430
|
# - {Wx::EvtHandler#evt_erase_background}(meth = nil, &block): Process a {Wx::EVT_ERASE_BACKGROUND} event.
|
1340
1431
|
#
|
1341
1432
|
# ===
|
@@ -1349,7 +1440,7 @@ module Wx
|
|
1349
1440
|
# Constructor.
|
1350
1441
|
# @param id [Integer]
|
1351
1442
|
# @param dc [Wx::DC]
|
1352
|
-
# @return [EraseEvent]
|
1443
|
+
# @return [Wx::EraseEvent]
|
1353
1444
|
def initialize(id=0, dc=nil) end
|
1354
1445
|
|
1355
1446
|
# Returns the device context associated with the erase event to draw on.
|
@@ -1368,7 +1459,9 @@ module Wx
|
|
1368
1459
|
#
|
1369
1460
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::FocusEvent} events.
|
1370
1461
|
# Event handler methods:
|
1462
|
+
#
|
1371
1463
|
# - {Wx::EvtHandler#evt_set_focus}(meth = nil, &block): Process a {Wx::EVT_SET_FOCUS} event.
|
1464
|
+
#
|
1372
1465
|
# - {Wx::EvtHandler#evt_kill_focus}(meth = nil, &block): Process a {Wx::EVT_KILL_FOCUS} event.
|
1373
1466
|
#
|
1374
1467
|
# ===
|
@@ -1380,9 +1473,9 @@ module Wx
|
|
1380
1473
|
class FocusEvent < Event
|
1381
1474
|
|
1382
1475
|
# Constructor.
|
1383
|
-
# @param eventType [
|
1476
|
+
# @param eventType [Wx::CommandLinkButton::EventType]
|
1384
1477
|
# @param id [Integer]
|
1385
|
-
# @return [FocusEvent]
|
1478
|
+
# @return [Wx::FocusEvent]
|
1386
1479
|
def initialize(eventType=Wx::EVT_NULL, id=0) end
|
1387
1480
|
|
1388
1481
|
# 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.
|
@@ -1403,11 +1496,14 @@ module Wx
|
|
1403
1496
|
#
|
1404
1497
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ActivateEvent} events.
|
1405
1498
|
# Event handler methods:
|
1499
|
+
#
|
1406
1500
|
# - {Wx::EvtHandler#evt_activate}(meth = nil, &block): Process a {Wx::EVT_ACTIVATE} event.
|
1501
|
+
#
|
1407
1502
|
# - {Wx::EvtHandler#evt_activate_app}(meth = nil, &block): Process a {Wx::EVT_ACTIVATE_APP} event. This event is received by the {Wx::App}-derived instance only.
|
1503
|
+
#
|
1408
1504
|
# - {Wx::EvtHandler#evt_hibernate}(meth = nil, &block): Process a hibernate event, supplying the member function. This event applies to {Wx::App} only, and only on Windows SmartPhone and PocketPC. It is generated when the system is low on memory; the application should free up as much memory as possible, and restore full working state when it receives a {Wx::EVT_ACTIVATE} or {Wx::EVT_ACTIVATE_APP} event.
|
1409
1505
|
#
|
1410
|
-
# Until wxWidgets 3.1.0 activation events could be sent by
|
1506
|
+
# Until wxWidgets 3.1.0 activation events could be sent by wxMSW when the window was minimized. This reflected the native MSW behaviour but was often surprising and unexpected, so starting from 3.1.0 such events are not sent any more when the window is in the minimized state.
|
1411
1507
|
#
|
1412
1508
|
# ===
|
1413
1509
|
#
|
@@ -1435,22 +1531,22 @@ module Wx
|
|
1435
1531
|
end # Reason
|
1436
1532
|
|
1437
1533
|
# Constructor.
|
1438
|
-
# @param eventType [
|
1439
|
-
# @param active [
|
1534
|
+
# @param eventType [Wx::CommandLinkButton::EventType]
|
1535
|
+
# @param active [Boolean]
|
1440
1536
|
# @param id [Integer]
|
1441
|
-
# @param activationReason [Reason]
|
1442
|
-
# @return [ActivateEvent]
|
1537
|
+
# @param activationReason [Wx::wxActivateEvent::Reason]
|
1538
|
+
# @return [Wx::ActivateEvent]
|
1443
1539
|
def initialize(eventType=Wx::EVT_NULL, active=true, id=0, activationReason=Wx::ActivateEvent::Reason::Reason_Unknown) end
|
1444
1540
|
|
1445
1541
|
# Returns true if the application or window is being activated, false otherwise.
|
1446
|
-
# @return [
|
1542
|
+
# @return [Boolean]
|
1447
1543
|
def get_active; end
|
1448
1544
|
alias_method :active, :get_active
|
1449
1545
|
|
1450
1546
|
# Allows checking if the window was activated by clicking it with the mouse or in some other way.
|
1451
|
-
# This method is currently only implemented in
|
1547
|
+
# 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).
|
1452
1548
|
# Under all the other platforms, Reason_Unknown is always returned.
|
1453
|
-
# @return [Reason]
|
1549
|
+
# @return [Wx::wxActivateEvent::Reason]
|
1454
1550
|
def get_activation_reason; end
|
1455
1551
|
alias_method :activation_reason, :get_activation_reason
|
1456
1552
|
|
@@ -1463,6 +1559,7 @@ module Wx
|
|
1463
1559
|
#
|
1464
1560
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::InitDialogEvent} events.
|
1465
1561
|
# Event handler methods:
|
1562
|
+
#
|
1466
1563
|
# - {Wx::EvtHandler#evt_init_dialog}(meth = nil, &block): Process a {Wx::EVT_INIT_DIALOG} event.
|
1467
1564
|
#
|
1468
1565
|
# ===
|
@@ -1475,7 +1572,7 @@ module Wx
|
|
1475
1572
|
|
1476
1573
|
# Constructor.
|
1477
1574
|
# @param id [Integer]
|
1478
|
-
# @return [InitDialogEvent]
|
1575
|
+
# @return [Wx::InitDialogEvent]
|
1479
1576
|
def initialize(id=0) end
|
1480
1577
|
|
1481
1578
|
end # InitDialogEvent
|
@@ -1483,7 +1580,11 @@ module Wx
|
|
1483
1580
|
# This class is used for a variety of menu-related events.
|
1484
1581
|
# Note that these do not include menu command events, which are handled using {Wx::CommandEvent} objects.
|
1485
1582
|
# 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:
|
1486
|
-
#
|
1583
|
+
#
|
1584
|
+
# - The menu object itself, as returned by {Wx::MenuEvent#get_menu}, if any.
|
1585
|
+
# - The {Wx::MenuBar} to which this menu is attached, if any.
|
1586
|
+
# - The window associated with the menu, e.g. the one calling PopupMenu() for the popup menus.
|
1587
|
+
# - The top level parent of that window if it's different from the window itself.
|
1487
1588
|
#
|
1488
1589
|
# This is similar to command events generated by the menu items, but, unlike them, {Wx::MenuEvent} are only sent to the window itself and its top level parent but not any intermediate windows in the hierarchy.
|
1489
1590
|
# The default handler for {Wx::EVT_MENU_HIGHLIGHT} in {Wx::Frame} displays help text in the status bar, see {Wx::Frame#set_status_bar_pane}.
|
@@ -1491,9 +1592,13 @@ module Wx
|
|
1491
1592
|
#
|
1492
1593
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::MenuEvent} events.
|
1493
1594
|
# Event handler methods:
|
1595
|
+
#
|
1494
1596
|
# - {Wx::EvtHandler#evt_menu_open}(meth = nil, &block): A menu is about to be opened. On Windows, this is only sent once for each navigation of the menubar (up until all menus have closed).
|
1597
|
+
#
|
1495
1598
|
# - {Wx::EvtHandler#evt_menu_close}(meth = nil, &block): A menu has been just closed. Notice that this event is currently being sent before the menu selection ({Wx::EVT_MENU}) event, if any.
|
1599
|
+
#
|
1496
1600
|
# - {Wx::EvtHandler#evt_menu_highlight}(id, meth = nil, &block): The menu item with the specified id has been highlighted: used to show help prompts in the status bar by {Wx::Frame}
|
1601
|
+
#
|
1497
1602
|
# - {Wx::EvtHandler#evt_menu_highlight_all}(meth = nil, &block): A menu item has been highlighted, i.e. the currently selected menu item has changed.
|
1498
1603
|
#
|
1499
1604
|
# ===
|
@@ -1506,14 +1611,14 @@ module Wx
|
|
1506
1611
|
class MenuEvent < Event
|
1507
1612
|
|
1508
1613
|
# Constructor.
|
1509
|
-
# @param type [
|
1614
|
+
# @param type [Wx::CommandLinkButton::EventType]
|
1510
1615
|
# @param id [Integer]
|
1511
1616
|
# @param menu [Wx::Menu]
|
1512
|
-
# @return [MenuEvent]
|
1617
|
+
# @return [Wx::MenuEvent]
|
1513
1618
|
def initialize(type=Wx::EVT_NULL, id=0, menu=nil) end
|
1514
1619
|
|
1515
1620
|
# Returns the menu which is being opened or closed, or the menu containing the highlighted item.
|
1516
|
-
# 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
|
1621
|
+
# 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.
|
1517
1622
|
# 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.
|
1518
1623
|
# @return [Wx::Menu]
|
1519
1624
|
def get_menu; end
|
@@ -1527,7 +1632,7 @@ module Wx
|
|
1527
1632
|
|
1528
1633
|
# Returns true if the menu which is being opened or closed is a popup menu, false if it is a normal one.
|
1529
1634
|
# This method should only be used with the OPEN and CLOSE events.
|
1530
|
-
# @return [
|
1635
|
+
# @return [Boolean]
|
1531
1636
|
def is_popup; end
|
1532
1637
|
alias_method :popup?, :is_popup
|
1533
1638
|
|
@@ -1562,8 +1667,11 @@ module Wx
|
|
1562
1667
|
#
|
1563
1668
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::CloseEvent} events.
|
1564
1669
|
# Event handler methods:
|
1670
|
+
#
|
1565
1671
|
# - {Wx::EvtHandler#evt_close}(meth = nil, &block): Process a {Wx::EVT_CLOSE_WINDOW} command event, supplying the member function. This event applies to {Wx::Frame} and {Wx::Dialog} classes.
|
1672
|
+
#
|
1566
1673
|
# - {Wx::EvtHandler#evt_query_end_session}(meth = nil, &block): Process a {Wx::EVT_QUERY_END_SESSION} session event, supplying the member function. This event can be handled in {Wx::App}-derived class only.
|
1674
|
+
#
|
1567
1675
|
# - {Wx::EvtHandler#evt_end_session}(meth = nil, &block): Process a {Wx::EVT_END_SESSION} session event, supplying the member function. This event can be handled in {Wx::App}-derived class only.
|
1568
1676
|
#
|
1569
1677
|
# ===
|
@@ -1576,53 +1684,54 @@ module Wx
|
|
1576
1684
|
class CloseEvent < Event
|
1577
1685
|
|
1578
1686
|
# Constructor.
|
1579
|
-
# @param commandEventType [
|
1687
|
+
# @param commandEventType [Wx::CommandLinkButton::EventType]
|
1580
1688
|
# @param id [Integer]
|
1581
|
-
# @return [CloseEvent]
|
1689
|
+
# @return [Wx::CloseEvent]
|
1582
1690
|
def initialize(commandEventType=Wx::EVT_NULL, id=0) end
|
1583
1691
|
|
1584
1692
|
# Returns true if you can veto a system shutdown or a window close event.
|
1585
1693
|
# 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.
|
1586
|
-
# @return [
|
1694
|
+
# @return [Boolean]
|
1587
1695
|
def can_veto; end
|
1588
1696
|
alias_method :can_veto?, :can_veto
|
1589
1697
|
|
1590
1698
|
# Returns true if the user is just logging off or false if the system is shutting down.
|
1591
1699
|
# This method can only be called for end session and query end session events, it doesn't make sense for close window event.
|
1592
|
-
# @return [
|
1700
|
+
# @return [Boolean]
|
1593
1701
|
def get_logging_off; end
|
1594
1702
|
alias_method :logging_off, :get_logging_off
|
1595
1703
|
|
1596
1704
|
# Sets the 'can veto' flag.
|
1597
|
-
# @param canVeto [
|
1705
|
+
# @param canVeto [Boolean]
|
1598
1706
|
# @return [void]
|
1599
1707
|
def set_can_veto(canVeto) end
|
1600
1708
|
alias_method :can_veto=, :set_can_veto
|
1601
1709
|
|
1602
1710
|
# Sets the 'logging off' flag.
|
1603
|
-
# @param loggingOff [
|
1711
|
+
# @param loggingOff [Boolean]
|
1604
1712
|
# @return [void]
|
1605
1713
|
def set_logging_off(loggingOff) end
|
1606
1714
|
alias_method :logging_off=, :set_logging_off
|
1607
1715
|
|
1608
1716
|
# 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.
|
1609
1717
|
# You can only veto a shutdown if {Wx::CloseEvent#can_veto} returns true.
|
1610
|
-
# @param veto [
|
1718
|
+
# @param veto [Boolean]
|
1611
1719
|
# @return [void]
|
1612
1720
|
def veto(veto=true) end
|
1613
1721
|
|
1614
1722
|
# Returns whether the Veto flag was set.
|
1615
|
-
# @return [
|
1723
|
+
# @return [Boolean]
|
1616
1724
|
def get_veto; end
|
1617
1725
|
|
1618
1726
|
end # CloseEvent
|
1619
1727
|
|
1620
1728
|
# An event being sent when the window is shown or hidden.
|
1621
|
-
# 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
|
1729
|
+
# 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.
|
1622
1730
|
# === Events using this class
|
1623
1731
|
#
|
1624
1732
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ShowEvent} events.
|
1625
1733
|
# Event handler methods:
|
1734
|
+
#
|
1626
1735
|
# - {Wx::EvtHandler#evt_show}(meth = nil, &block): Process a {Wx::EVT_SHOW} event.
|
1627
1736
|
#
|
1628
1737
|
# ===
|
@@ -1637,18 +1746,18 @@ module Wx
|
|
1637
1746
|
|
1638
1747
|
# Constructor.
|
1639
1748
|
# @param winid [Integer]
|
1640
|
-
# @param show [
|
1641
|
-
# @return [ShowEvent]
|
1749
|
+
# @param show [Boolean]
|
1750
|
+
# @return [Wx::ShowEvent]
|
1642
1751
|
def initialize(winid=0, show=false) end
|
1643
1752
|
|
1644
1753
|
# Set whether the windows was shown or hidden.
|
1645
|
-
# @param show [
|
1754
|
+
# @param show [Boolean]
|
1646
1755
|
# @return [void]
|
1647
1756
|
def set_show(show) end
|
1648
1757
|
alias_method :show=, :set_show
|
1649
1758
|
|
1650
1759
|
# Return true if the window has been shown, false if it has been hidden.
|
1651
|
-
# @return [
|
1760
|
+
# @return [Boolean]
|
1652
1761
|
def is_shown; end
|
1653
1762
|
alias_method :shown?, :is_shown
|
1654
1763
|
|
@@ -1659,6 +1768,7 @@ module Wx
|
|
1659
1768
|
#
|
1660
1769
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::IconizeEvent} events.
|
1661
1770
|
# Event handler methods:
|
1771
|
+
#
|
1662
1772
|
# - {Wx::EvtHandler#evt_iconize}(meth = nil, &block): Process a {Wx::EVT_ICONIZE} event.
|
1663
1773
|
#
|
1664
1774
|
# ===
|
@@ -1673,12 +1783,12 @@ module Wx
|
|
1673
1783
|
|
1674
1784
|
# Constructor.
|
1675
1785
|
# @param id [Integer]
|
1676
|
-
# @param iconized [
|
1677
|
-
# @return [IconizeEvent]
|
1786
|
+
# @param iconized [Boolean]
|
1787
|
+
# @return [Wx::IconizeEvent]
|
1678
1788
|
def initialize(id=0, iconized=true) end
|
1679
1789
|
|
1680
1790
|
# Returns true if the frame has been iconized, false if it has been restored.
|
1681
|
-
# @return [
|
1791
|
+
# @return [Boolean]
|
1682
1792
|
def is_iconized; end
|
1683
1793
|
alias_method :iconized?, :is_iconized
|
1684
1794
|
|
@@ -1686,11 +1796,12 @@ module Wx
|
|
1686
1796
|
|
1687
1797
|
# An event being sent when a top level window is maximized.
|
1688
1798
|
# 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.
|
1689
|
-
# Currently this event is only generated in
|
1799
|
+
# 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.
|
1690
1800
|
# === Events using this class
|
1691
1801
|
#
|
1692
1802
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::MaximizeEvent} events.
|
1693
1803
|
# Event handler methods:
|
1804
|
+
#
|
1694
1805
|
# - {Wx::EvtHandler#evt_maximize}(meth = nil, &block): Process a {Wx::EVT_MAXIMIZE} event.
|
1695
1806
|
#
|
1696
1807
|
# ===
|
@@ -1706,17 +1817,18 @@ module Wx
|
|
1706
1817
|
# Constructor.
|
1707
1818
|
# Only used by wxWidgets internally.
|
1708
1819
|
# @param id [Integer]
|
1709
|
-
# @return [MaximizeEvent]
|
1820
|
+
# @return [Wx::MaximizeEvent]
|
1710
1821
|
def initialize(id=0) end
|
1711
1822
|
|
1712
1823
|
end # MaximizeEvent
|
1713
1824
|
|
1714
1825
|
# An event being sent when the user enters or exits full screen mode.
|
1715
|
-
# Currently this event is only generated in the
|
1826
|
+
# 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}.
|
1716
1827
|
# === Events using this class
|
1717
1828
|
#
|
1718
1829
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::FullScreenEvent} events.
|
1719
1830
|
# Event handler methods:
|
1831
|
+
#
|
1720
1832
|
# - {Wx::EvtHandler#evt_fullscreen}(meth = nil, &block): Process a {Wx::EVT_FULLSCREEN} event.
|
1721
1833
|
#
|
1722
1834
|
# ===
|
@@ -1731,12 +1843,12 @@ module Wx
|
|
1731
1843
|
|
1732
1844
|
# Constructor.
|
1733
1845
|
# @param id [Integer]
|
1734
|
-
# @param fullscreen [
|
1735
|
-
# @return [FullScreenEvent]
|
1846
|
+
# @param fullscreen [Boolean]
|
1847
|
+
# @return [Wx::FullScreenEvent]
|
1736
1848
|
def initialize(id=0, fullscreen=true) end
|
1737
1849
|
|
1738
1850
|
# Returns true if the frame entered full screen, false if exited full screen.
|
1739
|
-
# @return [
|
1851
|
+
# @return [Boolean]
|
1740
1852
|
def is_full_screen; end
|
1741
1853
|
alias_method :full_screen?, :is_full_screen
|
1742
1854
|
|
@@ -1747,10 +1859,15 @@ module Wx
|
|
1747
1859
|
#
|
1748
1860
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::JoystickEvent} events.
|
1749
1861
|
# Event handler methods:
|
1862
|
+
#
|
1750
1863
|
# - {Wx::EvtHandler#evt_joy_button_down}(meth = nil, &block): Process a {Wx::EVT_JOY_BUTTON_DOWN} event.
|
1864
|
+
#
|
1751
1865
|
# - {Wx::EvtHandler#evt_joy_button_up}(meth = nil, &block): Process a {Wx::EVT_JOY_BUTTON_UP} event.
|
1866
|
+
#
|
1752
1867
|
# - {Wx::EvtHandler#evt_joy_move}(meth = nil, &block): Process a {Wx::EVT_JOY_MOVE} event.
|
1868
|
+
#
|
1753
1869
|
# - {Wx::EvtHandler#evt_joy_zmove}(meth = nil, &block): Process a {Wx::EVT_JOY_ZMOVE} event.
|
1870
|
+
#
|
1754
1871
|
# - {Wx::EvtHandler#evt_joystick_events}(meth = nil, &block): Processes all joystick events.
|
1755
1872
|
#
|
1756
1873
|
# ===
|
@@ -1762,26 +1879,26 @@ module Wx
|
|
1762
1879
|
class JoystickEvent < Event
|
1763
1880
|
|
1764
1881
|
# Constructor.
|
1765
|
-
# @param eventType [
|
1882
|
+
# @param eventType [Wx::CommandLinkButton::EventType]
|
1766
1883
|
# @param state [Integer]
|
1767
1884
|
# @param joystick [Integer]
|
1768
1885
|
# @param change [Integer]
|
1769
|
-
# @return [JoystickEvent]
|
1886
|
+
# @return [Wx::JoystickEvent]
|
1770
1887
|
def initialize(eventType=Wx::EVT_NULL, state=0, joystick=wxJOYSTICK1, change=0) end
|
1771
1888
|
|
1772
1889
|
# Returns true if the event was a down event from the specified button (or any button).
|
1773
1890
|
# @param button [Integer] Can be {Wx::JOY_BUTTONn} where n is 1, 2, 3 or 4; or {Wx::JOY_BUTTON_ANY} to indicate any button down event.
|
1774
|
-
# @return [
|
1891
|
+
# @return [Boolean]
|
1775
1892
|
def button_down(button=Wx::JOY_BUTTON_ANY) end
|
1776
1893
|
|
1777
1894
|
# Returns true if the specified button (or any button) was in a down state.
|
1778
1895
|
# @param button [Integer] Can be {Wx::JOY_BUTTONn} where n is 1, 2, 3 or 4; or {Wx::JOY_BUTTON_ANY} to indicate any button down event.
|
1779
|
-
# @return [
|
1896
|
+
# @return [Boolean]
|
1780
1897
|
def button_is_down(button=Wx::JOY_BUTTON_ANY) end
|
1781
1898
|
|
1782
1899
|
# Returns true if the event was an up event from the specified button (or any button).
|
1783
1900
|
# @param button [Integer] Can be {Wx::JOY_BUTTONn} where n is 1, 2, 3 or 4; or {Wx::JOY_BUTTON_ANY} to indicate any button down event.
|
1784
|
-
# @return [
|
1901
|
+
# @return [Boolean]
|
1785
1902
|
def button_up(button=Wx::JOY_BUTTON_ANY) end
|
1786
1903
|
|
1787
1904
|
# Returns the identifier of the button changing state.
|
@@ -1826,17 +1943,17 @@ module Wx
|
|
1826
1943
|
alias_method :z_position, :get_z_position
|
1827
1944
|
|
1828
1945
|
# Returns true if this was a button up or down event (not 'is any button down?').
|
1829
|
-
# @return [
|
1946
|
+
# @return [Boolean]
|
1830
1947
|
def is_button; end
|
1831
1948
|
alias_method :button?, :is_button
|
1832
1949
|
|
1833
1950
|
# Returns true if this was an x, y move event.
|
1834
|
-
# @return [
|
1951
|
+
# @return [Boolean]
|
1835
1952
|
def is_move; end
|
1836
1953
|
alias_method :move?, :is_move
|
1837
1954
|
|
1838
1955
|
# Returns true if this was a z move event.
|
1839
|
-
# @return [
|
1956
|
+
# @return [Boolean]
|
1840
1957
|
def is_z_move; end
|
1841
1958
|
alias_method :z_move?, :is_z_move
|
1842
1959
|
|
@@ -1849,6 +1966,7 @@ module Wx
|
|
1849
1966
|
#
|
1850
1967
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::DropFilesEvent} events.
|
1851
1968
|
# Event handler methods:
|
1969
|
+
#
|
1852
1970
|
# - {Wx::EvtHandler#evt_drop_files}(meth = nil, &block): Process a {Wx::EVT_DROP_FILES} event.
|
1853
1971
|
#
|
1854
1972
|
# Windows only until version 2.8.9, available on all platforms since 2.8.10.
|
@@ -1863,10 +1981,10 @@ module Wx
|
|
1863
1981
|
class DropFilesEvent < Event
|
1864
1982
|
|
1865
1983
|
# Constructor.
|
1866
|
-
# @param id [
|
1984
|
+
# @param id [Wx::CommandLinkButton::EventType]
|
1867
1985
|
# @param noFiles [Integer]
|
1868
1986
|
# @param files [String]
|
1869
|
-
# @return [DropFilesEvent]
|
1987
|
+
# @return [Wx::DropFilesEvent]
|
1870
1988
|
def initialize(id=0, noFiles=0, files=nil) end
|
1871
1989
|
|
1872
1990
|
# Returns an array of filenames.
|
@@ -1893,7 +2011,9 @@ module Wx
|
|
1893
2011
|
# 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.
|
1894
2012
|
# These events will work for popup menus as well as menubars. Just before a menu is popped up, {Wx::Menu::UpdateUI} is called to process any UI events for the window that owns the menu.
|
1895
2013
|
# If you find that the overhead of UI update processing is affecting your application, you can do one or both of the following:
|
2014
|
+
#
|
1896
2015
|
# - Call {Wx::UpdateUIEvent.set_mode} with a value of {Wx::UpdateUIMode::UPDATE_UI_PROCESS_SPECIFIED}, and set the extra style {Wx::WS_EX_PROCESS_UI_UPDATES} for every window that should receive update events. No other windows will receive update events.
|
2016
|
+
#
|
1897
2017
|
# - Call {Wx::UpdateUIEvent.set_update_interval} with a millisecond value to set the delay between updates. You may need to call {Wx::Window#update_window_ui} at critical points, for example when a dialog is about to be shown, in case the user sees a slight delay before windows are updated.
|
1898
2018
|
#
|
1899
2019
|
# Note that although events are sent in idle time, defining a {Wx::IdleEvent} handler for a window does not affect this because the events are sent from {Wx::Window#on_internal_idle} which is always called in idle time.
|
@@ -1902,7 +2022,9 @@ module Wx
|
|
1902
2022
|
#
|
1903
2023
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::UpdateUIEvent} events.
|
1904
2024
|
# Event handler methods:
|
2025
|
+
#
|
1905
2026
|
# - {Wx::EvtHandler#evt_update_ui}(id, meth = nil, &block): Process a {Wx::EVT_UPDATE_UI} event for the command with the given id.
|
2027
|
+
#
|
1906
2028
|
# - {Wx::EvtHandler#evt_update_ui_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_UPDATE_UI} event for any command with id included in the given range.
|
1907
2029
|
#
|
1908
2030
|
# ===
|
@@ -1915,26 +2037,26 @@ module Wx
|
|
1915
2037
|
|
1916
2038
|
# Constructor.
|
1917
2039
|
# @param commandId [Integer]
|
1918
|
-
# @return [UpdateUIEvent]
|
2040
|
+
# @return [Wx::UpdateUIEvent]
|
1919
2041
|
def initialize(commandId=0) end
|
1920
2042
|
|
1921
2043
|
# Check or uncheck the UI element.
|
1922
|
-
# @param check [
|
2044
|
+
# @param check [Boolean]
|
1923
2045
|
# @return [void]
|
1924
2046
|
def check(check) end
|
1925
2047
|
|
1926
2048
|
# Enable or disable the UI element.
|
1927
|
-
# @param enable [
|
2049
|
+
# @param enable [Boolean]
|
1928
2050
|
# @return [void]
|
1929
2051
|
def enable(enable) end
|
1930
2052
|
|
1931
2053
|
# Returns true if the UI element should be checked.
|
1932
|
-
# @return [
|
2054
|
+
# @return [Boolean]
|
1933
2055
|
def get_checked; end
|
1934
2056
|
alias_method :checked, :get_checked
|
1935
2057
|
|
1936
2058
|
# Returns true if the UI element should be enabled.
|
1937
|
-
# @return [
|
2059
|
+
# @return [Boolean]
|
1938
2060
|
def get_enabled; end
|
1939
2061
|
alias_method :enabled, :get_enabled
|
1940
2062
|
|
@@ -1947,35 +2069,35 @@ module Wx
|
|
1947
2069
|
# event.check(...some condition...)
|
1948
2070
|
# end
|
1949
2071
|
# ```
|
1950
|
-
# @return [
|
2072
|
+
# @return [Boolean]
|
1951
2073
|
def is_checkable; end
|
1952
2074
|
alias_method :checkable?, :is_checkable
|
1953
2075
|
|
1954
2076
|
# Returns true if the application has called {Wx::UpdateUIEvent#check}.
|
1955
2077
|
# For wxWidgets internal use only.
|
1956
|
-
# @return [
|
2078
|
+
# @return [Boolean]
|
1957
2079
|
def get_set_checked; end
|
1958
2080
|
alias_method :set_checked, :get_set_checked
|
1959
2081
|
|
1960
2082
|
# Returns true if the application has called {Wx::UpdateUIEvent#enable}.
|
1961
2083
|
# For wxWidgets internal use only.
|
1962
|
-
# @return [
|
2084
|
+
# @return [Boolean]
|
1963
2085
|
def get_set_enabled; end
|
1964
2086
|
alias_method :set_enabled, :get_set_enabled
|
1965
2087
|
|
1966
2088
|
# Returns true if the application has called {Wx::UpdateUIEvent#show}.
|
1967
2089
|
# For wxWidgets internal use only.
|
1968
|
-
# @return [
|
2090
|
+
# @return [Boolean]
|
1969
2091
|
def get_set_shown; end
|
1970
2092
|
alias_method :set_shown, :get_set_shown
|
1971
2093
|
|
1972
2094
|
# Returns true if the application has called {Wx::UpdateUIEvent#set_text}.
|
1973
2095
|
# For wxWidgets internal use only.
|
1974
|
-
# @return [
|
2096
|
+
# @return [Boolean]
|
1975
2097
|
def get_set_text; end
|
1976
2098
|
|
1977
2099
|
# Returns true if the UI element should be shown.
|
1978
|
-
# @return [
|
2100
|
+
# @return [Boolean]
|
1979
2101
|
def get_shown; end
|
1980
2102
|
alias_method :shown, :get_shown
|
1981
2103
|
|
@@ -1991,7 +2113,7 @@ module Wx
|
|
1991
2113
|
alias_method :text=, :set_text
|
1992
2114
|
|
1993
2115
|
# Show or hide the UI element.
|
1994
|
-
# @param show [
|
2116
|
+
# @param show [Boolean]
|
1995
2117
|
# @return [void]
|
1996
2118
|
def show(show) end
|
1997
2119
|
|
@@ -2001,13 +2123,13 @@ module Wx
|
|
2001
2123
|
# @see Wx::UpdateUIEvent.set_update_interval
|
2002
2124
|
# @see Wx::UpdateUIEvent.set_mode
|
2003
2125
|
# @param window [Wx::Window]
|
2004
|
-
# @return [
|
2126
|
+
# @return [Boolean]
|
2005
2127
|
def self.can_update(window) end
|
2006
2128
|
|
2007
2129
|
# 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.
|
2008
2130
|
#
|
2009
2131
|
# @see Wx::UpdateUIEvent.set_mode
|
2010
|
-
# @return [UpdateUIMode]
|
2132
|
+
# @return [Wx::UpdateUIMode]
|
2011
2133
|
def self.get_mode; end
|
2012
2134
|
|
2013
2135
|
# Returns the current interval between updates in milliseconds.
|
@@ -2025,7 +2147,7 @@ module Wx
|
|
2025
2147
|
def self.reset_update_time; end
|
2026
2148
|
|
2027
2149
|
# Specify how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events.
|
2028
|
-
# @param mode [UpdateUIMode] this parameter may be one of the {Wx::UpdateUIMode} enumeration values. The default mode is {Wx::UpdateUIMode::UPDATE_UI_PROCESS_ALL}.
|
2150
|
+
# @param mode [Wx::UpdateUIMode] this parameter may be one of the {Wx::UpdateUIMode} enumeration values. The default mode is {Wx::UpdateUIMode::UPDATE_UI_PROCESS_ALL}.
|
2029
2151
|
# @return [void]
|
2030
2152
|
def self.set_mode(mode) end
|
2031
2153
|
|
@@ -2046,6 +2168,7 @@ module Wx
|
|
2046
2168
|
#
|
2047
2169
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::SysColourChangedEvent} events.
|
2048
2170
|
# Event handler methods:
|
2171
|
+
#
|
2049
2172
|
# - {Wx::EvtHandler#evt_sys_colour_changed}(meth = nil, &block): Process a {Wx::EVT_SYS_COLOUR_CHANGED} event.
|
2050
2173
|
#
|
2051
2174
|
# ===
|
@@ -2057,18 +2180,19 @@ module Wx
|
|
2057
2180
|
class SysColourChangedEvent < Event
|
2058
2181
|
|
2059
2182
|
# Constructor.
|
2060
|
-
# @return [SysColourChangedEvent]
|
2183
|
+
# @return [Wx::SysColourChangedEvent]
|
2061
2184
|
def initialize; end
|
2062
2185
|
|
2063
2186
|
end # SysColourChangedEvent
|
2064
2187
|
|
2065
2188
|
# A mouse capture changed event is sent to a window that loses its mouse capture.
|
2066
2189
|
# 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.
|
2067
|
-
# Availability: only available for the
|
2190
|
+
# Availability: only available for the wxMSW port. {Wx::msw}
|
2068
2191
|
# === Events using this class
|
2069
2192
|
#
|
2070
2193
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseCaptureChangedEvent} events.
|
2071
2194
|
# Event handler methods:
|
2195
|
+
#
|
2072
2196
|
# - {Wx::EvtHandler#evt_mouse_capture_changed}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_CHANGED} event.
|
2073
2197
|
#
|
2074
2198
|
# ===
|
@@ -2086,7 +2210,7 @@ module Wx
|
|
2086
2210
|
# Constructor.
|
2087
2211
|
# @param windowId [Integer]
|
2088
2212
|
# @param gainedCapture [Wx::Window]
|
2089
|
-
# @return [MouseCaptureChangedEvent]
|
2213
|
+
# @return [Wx::MouseCaptureChangedEvent]
|
2090
2214
|
def initialize(windowId=0, gainedCapture=nil) end
|
2091
2215
|
|
2092
2216
|
# Returns the window that gained the capture, or NULL if it was a non-wxWidgets window.
|
@@ -2103,9 +2227,10 @@ module Wx
|
|
2103
2227
|
#
|
2104
2228
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::MouseCaptureLostEvent} events.
|
2105
2229
|
# Event handler methods:
|
2230
|
+
#
|
2106
2231
|
# - {Wx::EvtHandler#evt_mouse_capture_lost}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_LOST} event.
|
2107
2232
|
#
|
2108
|
-
# Availability: only available for the
|
2233
|
+
# Availability: only available for the wxMSW port. {Wx::msw}
|
2109
2234
|
# ===
|
2110
2235
|
#
|
2111
2236
|
# Category: {Wx::Events}
|
@@ -2120,7 +2245,7 @@ module Wx
|
|
2120
2245
|
|
2121
2246
|
# Constructor.
|
2122
2247
|
# @param windowId [Integer]
|
2123
|
-
# @return [MouseCaptureLostEvent]
|
2248
|
+
# @return [Wx::MouseCaptureLostEvent]
|
2124
2249
|
def initialize(windowId=0) end
|
2125
2250
|
|
2126
2251
|
end # MouseCaptureLostEvent
|
@@ -2131,9 +2256,10 @@ module Wx
|
|
2131
2256
|
#
|
2132
2257
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::DisplayChangedEvent} events.
|
2133
2258
|
# Event handler methods:
|
2259
|
+
#
|
2134
2260
|
# - {Wx::EvtHandler#evt_display_changed}(meth = nil, &block): Process a {Wx::EVT_DISPLAY_CHANGED} event.
|
2135
2261
|
#
|
2136
|
-
# Availability: only available for the
|
2262
|
+
# Availability: only available for the wxMSW port. {Wx::msw}
|
2137
2263
|
# ===
|
2138
2264
|
#
|
2139
2265
|
# Category: {Wx::Events}
|
@@ -2142,7 +2268,7 @@ module Wx
|
|
2142
2268
|
#
|
2143
2269
|
class DisplayChangedEvent < Event
|
2144
2270
|
|
2145
|
-
# @return [DisplayChangedEvent]
|
2271
|
+
# @return [Wx::DisplayChangedEvent]
|
2146
2272
|
def initialize; end
|
2147
2273
|
|
2148
2274
|
end # DisplayChangedEvent
|
@@ -2150,11 +2276,12 @@ module Wx
|
|
2150
2276
|
# 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.
|
2151
2277
|
# 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.
|
2152
2278
|
# 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.
|
2153
|
-
# Currently this event is generated by
|
2279
|
+
# 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).
|
2154
2280
|
# === Events using this class
|
2155
2281
|
#
|
2156
2282
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::DPIChangedEvent} events.
|
2157
2283
|
# Event handler methods:
|
2284
|
+
#
|
2158
2285
|
# - {Wx::EvtHandler#evt_dpi_changed}(meth = nil, &block): Process a {Wx::EVT_DPI_CHANGED} event.
|
2159
2286
|
#
|
2160
2287
|
# ===
|
@@ -2202,7 +2329,7 @@ module Wx
|
|
2202
2329
|
class PaletteChangedEvent < Event
|
2203
2330
|
|
2204
2331
|
# @param winid [Integer]
|
2205
|
-
# @return [PaletteChangedEvent]
|
2332
|
+
# @return [Wx::PaletteChangedEvent]
|
2206
2333
|
def initialize(winid=0) end
|
2207
2334
|
|
2208
2335
|
# @param win [Wx::Window]
|
@@ -2222,15 +2349,15 @@ module Wx
|
|
2222
2349
|
class QueryNewPaletteEvent < Event
|
2223
2350
|
|
2224
2351
|
# @param winid [Integer]
|
2225
|
-
# @return [QueryNewPaletteEvent]
|
2352
|
+
# @return [Wx::QueryNewPaletteEvent]
|
2226
2353
|
def initialize(winid=0) end
|
2227
2354
|
|
2228
|
-
# @param realized [
|
2355
|
+
# @param realized [Boolean]
|
2229
2356
|
# @return [void]
|
2230
2357
|
def set_palette_realized(realized) end
|
2231
2358
|
alias_method :palette_realized=, :set_palette_realized
|
2232
2359
|
|
2233
|
-
# @return [
|
2360
|
+
# @return [Boolean]
|
2234
2361
|
def get_palette_realized; end
|
2235
2362
|
alias_method :palette_realized, :get_palette_realized
|
2236
2363
|
|
@@ -2242,6 +2369,7 @@ module Wx
|
|
2242
2369
|
#
|
2243
2370
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::NavigationKeyEvent} events.
|
2244
2371
|
# Event handler methods:
|
2372
|
+
#
|
2245
2373
|
# - {Wx::EvtHandler#evt_navigation_key}(meth = nil, &block): Process a navigation key event.
|
2246
2374
|
#
|
2247
2375
|
# ===
|
@@ -2278,10 +2406,10 @@ module Wx
|
|
2278
2406
|
end # NavigationKeyEventFlags
|
2279
2407
|
|
2280
2408
|
# @overload initialize()
|
2281
|
-
# @return [NavigationKeyEvent]
|
2409
|
+
# @return [Wx::NavigationKeyEvent]
|
2282
2410
|
# @overload initialize(event)
|
2283
2411
|
# @param event [Wx::NavigationKeyEvent]
|
2284
|
-
# @return [NavigationKeyEvent]
|
2412
|
+
# @return [Wx::NavigationKeyEvent]
|
2285
2413
|
def initialize(*args) end
|
2286
2414
|
|
2287
2415
|
# Returns the child that has the focus, or NULL.
|
@@ -2290,18 +2418,18 @@ module Wx
|
|
2290
2418
|
alias_method :current_focus, :get_current_focus
|
2291
2419
|
|
2292
2420
|
# Returns true if the navigation was in the forward direction.
|
2293
|
-
# @return [
|
2421
|
+
# @return [Boolean]
|
2294
2422
|
def get_direction; end
|
2295
2423
|
alias_method :direction, :get_direction
|
2296
2424
|
|
2297
2425
|
# Returns true if the navigation event was from a tab key.
|
2298
2426
|
# This is required for proper navigation over radio buttons.
|
2299
|
-
# @return [
|
2427
|
+
# @return [Boolean]
|
2300
2428
|
def is_from_tab; end
|
2301
2429
|
alias_method :from_tab?, :is_from_tab
|
2302
2430
|
|
2303
2431
|
# Returns true if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook).
|
2304
|
-
# @return [
|
2432
|
+
# @return [Boolean]
|
2305
2433
|
def is_window_change; end
|
2306
2434
|
alias_method :window_change?, :is_window_change
|
2307
2435
|
|
@@ -2312,7 +2440,7 @@ module Wx
|
|
2312
2440
|
alias_method :current_focus=, :set_current_focus
|
2313
2441
|
|
2314
2442
|
# Sets the direction to forward if direction is true, or backward if false.
|
2315
|
-
# @param direction [
|
2443
|
+
# @param direction [Boolean]
|
2316
2444
|
# @return [void]
|
2317
2445
|
def set_direction(direction) end
|
2318
2446
|
alias_method :direction=, :set_direction
|
@@ -2325,13 +2453,13 @@ module Wx
|
|
2325
2453
|
alias_method :flags=, :set_flags
|
2326
2454
|
|
2327
2455
|
# Marks the navigation event as from a tab key.
|
2328
|
-
# @param fromTab [
|
2456
|
+
# @param fromTab [Boolean]
|
2329
2457
|
# @return [void]
|
2330
2458
|
def set_from_tab(fromTab) end
|
2331
2459
|
alias_method :from_tab=, :set_from_tab
|
2332
2460
|
|
2333
2461
|
# Marks the event as a window change event.
|
2334
|
-
# @param windowChange [
|
2462
|
+
# @param windowChange [Boolean]
|
2335
2463
|
# @return [void]
|
2336
2464
|
def set_window_change(windowChange) end
|
2337
2465
|
alias_method :window_change=, :set_window_change
|
@@ -2344,6 +2472,7 @@ module Wx
|
|
2344
2472
|
#
|
2345
2473
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::WindowCreateEvent} events.
|
2346
2474
|
# Event handler methods:
|
2475
|
+
#
|
2347
2476
|
# - {Wx::EvtHandler#evt_window_create}(meth = nil, &block): Process a {Wx::EVT_CREATE} event.
|
2348
2477
|
#
|
2349
2478
|
# ===
|
@@ -2357,7 +2486,7 @@ module Wx
|
|
2357
2486
|
|
2358
2487
|
# Constructor.
|
2359
2488
|
# @param win [Wx::Window]
|
2360
|
-
# @return [WindowCreateEvent]
|
2489
|
+
# @return [Wx::WindowCreateEvent]
|
2361
2490
|
def initialize(win=nil) end
|
2362
2491
|
|
2363
2492
|
# Return the window being created.
|
@@ -2382,7 +2511,7 @@ module Wx
|
|
2382
2511
|
|
2383
2512
|
# Constructor.
|
2384
2513
|
# @param win [Wx::Window]
|
2385
|
-
# @return [WindowDestroyEvent]
|
2514
|
+
# @return [Wx::WindowDestroyEvent]
|
2386
2515
|
def initialize(win=nil) end
|
2387
2516
|
|
2388
2517
|
# Return the window being destroyed.
|
@@ -2401,7 +2530,9 @@ module Wx
|
|
2401
2530
|
#
|
2402
2531
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::HelpEvent} events.
|
2403
2532
|
# Event handler methods:
|
2533
|
+
#
|
2404
2534
|
# - {Wx::EvtHandler#evt_help}(id, meth = nil, &block): Process a {Wx::EVT_HELP} event.
|
2535
|
+
#
|
2405
2536
|
# - {Wx::EvtHandler#evt_help_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_HELP} event for a range of ids.
|
2406
2537
|
#
|
2407
2538
|
# ===
|
@@ -2435,17 +2566,17 @@ module Wx
|
|
2435
2566
|
end # Origin
|
2436
2567
|
|
2437
2568
|
# Constructor.
|
2438
|
-
# @param type [
|
2569
|
+
# @param type [Wx::CommandLinkButton::EventType]
|
2439
2570
|
# @param winid [Integer]
|
2440
2571
|
# @param pt [Array(Integer, Integer), Wx::Point]
|
2441
|
-
# @param origin [Wx::
|
2442
|
-
# @return [HelpEvent]
|
2572
|
+
# @param origin [Wx::wxHelpEvent::Origin]
|
2573
|
+
# @return [Wx::HelpEvent]
|
2443
2574
|
def initialize(type=Wx::EVT_NULL, winid=0, pt=Wx::DEFAULT_POSITION, origin=Wx::HelpEvent::Origin::Origin_Unknown) end
|
2444
2575
|
|
2445
2576
|
# Returns the origin of the help event which is one of the {Wx::HelpEvent::Origin} values.
|
2446
2577
|
# The application may handle events generated using the keyboard or mouse differently, e.g. by using {get_mouse_position} for the mouse events.
|
2447
2578
|
# @see Wx::HelpEvent#set_origin
|
2448
|
-
# @return [Wx::
|
2579
|
+
# @return [Wx::wxHelpEvent::Origin]
|
2449
2580
|
def get_origin; end
|
2450
2581
|
alias_method :origin, :get_origin
|
2451
2582
|
|
@@ -2458,7 +2589,7 @@ module Wx
|
|
2458
2589
|
# Set the help event origin, only used internally by wxWidgets normally.
|
2459
2590
|
#
|
2460
2591
|
# @see Wx::HelpEvent#get_origin
|
2461
|
-
# @param origin [Wx::
|
2592
|
+
# @param origin [Wx::wxHelpEvent::Origin]
|
2462
2593
|
# @return [void]
|
2463
2594
|
def set_origin(origin) end
|
2464
2595
|
alias_method :origin=, :set_origin
|
@@ -2475,14 +2606,17 @@ module Wx
|
|
2475
2606
|
# There are three types of corresponding events {Wx::EVT_TEXT_COPY}, {Wx::EVT_TEXT_CUT} and {Wx::EVT_TEXT_PASTE}.
|
2476
2607
|
# 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.
|
2477
2608
|
# 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.
|
2478
|
-
# These events are currently only generated by {Wx::TextCtrl} in
|
2609
|
+
# These events are currently only generated by {Wx::TextCtrl} in wxGTK and wxOSX but are also generated by {Wx::ComboBox} without {Wx::CB_READONLY} style in wxMSW.
|
2479
2610
|
#
|
2480
2611
|
# === Events using this class
|
2481
2612
|
#
|
2482
2613
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ClipboardTextEvent} events.
|
2483
2614
|
# Event handler methods:
|
2615
|
+
#
|
2484
2616
|
# - {Wx::EvtHandler#evt_text_copy}(id, meth = nil, &block): Some or all of the controls content was copied to the clipboard.
|
2617
|
+
#
|
2485
2618
|
# - {Wx::EvtHandler#evt_text_cut}(id, meth = nil, &block): Some or all of the controls content was cut (i.e. copied and deleted).
|
2619
|
+
#
|
2486
2620
|
# - {Wx::EvtHandler#evt_text_paste}(id, meth = nil, &block): Clipboard content was pasted into the control.
|
2487
2621
|
#
|
2488
2622
|
# ===
|
@@ -2494,9 +2628,9 @@ module Wx
|
|
2494
2628
|
class ClipboardTextEvent < CommandEvent
|
2495
2629
|
|
2496
2630
|
# Constructor.
|
2497
|
-
# @param commandType [
|
2631
|
+
# @param commandType [Wx::CommandLinkButton::EventType]
|
2498
2632
|
# @param id [Integer]
|
2499
|
-
# @return [ClipboardTextEvent]
|
2633
|
+
# @return [Wx::ClipboardTextEvent]
|
2500
2634
|
def initialize(commandType=Wx::EVT_NULL, id=0) end
|
2501
2635
|
|
2502
2636
|
end # ClipboardTextEvent
|
@@ -2508,6 +2642,7 @@ module Wx
|
|
2508
2642
|
#
|
2509
2643
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ContextMenuEvent} events.
|
2510
2644
|
# Event handler methods:
|
2645
|
+
#
|
2511
2646
|
# - {Wx::EvtHandler#evt_context_menu}(meth = nil, &block): A right click (or other context menu command depending on platform) has been detected.
|
2512
2647
|
#
|
2513
2648
|
# ===
|
@@ -2520,10 +2655,10 @@ module Wx
|
|
2520
2655
|
class ContextMenuEvent < CommandEvent
|
2521
2656
|
|
2522
2657
|
# Constructor.
|
2523
|
-
# @param type [
|
2658
|
+
# @param type [Wx::CommandLinkButton::EventType]
|
2524
2659
|
# @param id [Integer]
|
2525
2660
|
# @param pos [Array(Integer, Integer), Wx::Point]
|
2526
|
-
# @return [ContextMenuEvent]
|
2661
|
+
# @return [Wx::ContextMenuEvent]
|
2527
2662
|
def initialize(type=Wx::EVT_NULL, id=0, pos=Wx::DEFAULT_POSITION) end
|
2528
2663
|
|
2529
2664
|
# Returns the position in screen coordinates at which the menu should be shown.
|
@@ -2548,6 +2683,7 @@ module Wx
|
|
2548
2683
|
#
|
2549
2684
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ChildFocusEvent} events.
|
2550
2685
|
# Event handler methods:
|
2686
|
+
#
|
2551
2687
|
# - {Wx::EvtHandler#evt_child_focus}(meth = nil, &block): Process a {Wx::EVT_CHILD_FOCUS} event.
|
2552
2688
|
#
|
2553
2689
|
# ===
|
@@ -2560,7 +2696,7 @@ module Wx
|
|
2560
2696
|
|
2561
2697
|
# Constructor.
|
2562
2698
|
# @param win [Wx::Window] The direct child which is (or which contains the window which is) receiving the focus.
|
2563
|
-
# @return [ChildFocusEvent]
|
2699
|
+
# @return [Wx::ChildFocusEvent]
|
2564
2700
|
def initialize(win=nil) end
|
2565
2701
|
|
2566
2702
|
# Returns the direct child which receives the focus, or a (grand-)parent of the control receiving the focus.
|