wxruby3 0.9.0.pre.rc.3-x64-mingw-ucrt → 0.9.1-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/README.md +1 -1
- 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/const.rb +83 -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 +7 -0
- data/lib/wx/core/events/evt_list.rb +100 -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 +16 -4
- data/lib/wx/core/imagelist.rb +8 -1
- data/lib/wx/core/listbox.rb +7 -0
- data/lib/wx/core/listctrl.rb +9 -0
- data/lib/wx/core/locale.rb +8 -0
- data/lib/wx/core/log.rb +24 -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 +12 -4
- 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 +73 -66
- 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 +6 -0
- data/lib/wx/doc/event_blocker.rb +6 -0
- data/lib/wx/doc/event_loop.rb +6 -0
- data/lib/wx/doc/events.rb +6 -0
- data/lib/wx/doc/evthandler.rb +8 -0
- data/lib/wx/doc/extra/01_packages.md +52 -51
- 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 +1 -1
- data/lib/wx/doc/extra/10_art.md +18 -12
- data/lib/wx/doc/extra/11_drawing_and_dc.md +4 -4
- data/lib/wx/doc/font.rb +6 -0
- data/lib/wx/doc/font_data.rb +16 -0
- data/lib/wx/doc/functions.rb +18 -10
- data/lib/wx/doc/gc_dc.rb +6 -0
- data/lib/wx/doc/gdi_common.rb +8 -1
- data/lib/wx/doc/gen/about_dialog_info.rb +9 -9
- data/lib/wx/doc/gen/accelerator.rb +4 -9
- data/lib/wx/doc/gen/accessible.rb +21 -21
- data/lib/wx/doc/gen/activity_indicator.rb +4 -4
- data/lib/wx/doc/gen/animation.rb +13 -13
- data/lib/wx/doc/gen/animation_ctrl.rb +9 -9
- data/lib/wx/doc/gen/any_button.rb +2 -2
- data/lib/wx/doc/gen/app.rb +16 -85
- data/lib/wx/doc/gen/app_traits.rb +381 -0
- data/lib/wx/doc/gen/art_provider.rb +4 -4
- data/lib/wx/doc/gen/aui/aui_manager.rb +12 -14
- data/lib/wx/doc/gen/aui/aui_manager_event.rb +5 -5
- data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +15 -16
- data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +1 -1
- data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +4 -4
- data/lib/wx/doc/gen/aui/aui_notebook.rb +102 -19
- data/lib/wx/doc/gen/aui/aui_notebook_event.rb +1 -1
- data/lib/wx/doc/gen/aui/aui_pane_info.rb +44 -44
- data/lib/wx/doc/gen/aui/aui_tab_art.rb +11 -11
- data/lib/wx/doc/gen/aui/aui_tool_bar.rb +28 -28
- data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -2
- data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +3 -3
- data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +7 -7
- 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 +26 -57
- data/lib/wx/doc/gen/bitmap_button.rb +5 -5
- data/lib/wx/doc/gen/bitmap_combo_box.rb +6 -6
- data/lib/wx/doc/gen/book_ctrl_base.rb +13 -13
- data/lib/wx/doc/gen/book_ctrl_event.rb +1 -1
- data/lib/wx/doc/gen/brush.rb +8 -8
- data/lib/wx/doc/gen/button.rb +6 -6
- data/lib/wx/doc/gen/calendar_ctrl.rb +12 -12
- data/lib/wx/doc/gen/calendar_date_attr.rb +11 -11
- data/lib/wx/doc/gen/calendar_event.rb +2 -8
- data/lib/wx/doc/gen/caret.rb +4 -4
- data/lib/wx/doc/gen/check_box.rb +11 -11
- data/lib/wx/doc/gen/check_list_box.rb +7 -7
- data/lib/wx/doc/gen/choice.rb +5 -5
- data/lib/wx/doc/gen/choicebook.rb +1 -1
- data/lib/wx/doc/gen/clipboard.rb +9 -9
- data/lib/wx/doc/gen/collapsible_pane.rb +6 -6
- data/lib/wx/doc/gen/collapsible_pane_event.rb +3 -3
- data/lib/wx/doc/gen/colour.rb +26 -26
- data/lib/wx/doc/gen/colour_dialog.rb +6 -6
- data/lib/wx/doc/gen/colour_picker_ctrl.rb +3 -3
- data/lib/wx/doc/gen/combo_box.rb +11 -11
- 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 +3 -3
- data/lib/wx/doc/gen/control.rb +5 -5
- data/lib/wx/doc/gen/control_with_items.rb +5 -5
- data/lib/wx/doc/gen/core.rb +6 -6
- data/lib/wx/doc/gen/cursor.rb +4 -9
- data/lib/wx/doc/gen/data_format.rb +3 -3
- data/lib/wx/doc/gen/data_object.rb +14 -14
- data/lib/wx/doc/gen/date_event.rb +1 -1
- data/lib/wx/doc/gen/date_picker_ctrl.rb +5 -5
- data/lib/wx/doc/gen/dc.rb +127 -64
- data/lib/wx/doc/gen/defs.rb +3 -3
- data/lib/wx/doc/gen/dial_up_event.rb +42 -0
- data/lib/wx/doc/gen/dial_up_manager.rb +129 -0
- data/lib/wx/doc/gen/dialog.rb +48 -19
- data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -1
- data/lib/wx/doc/gen/dir_picker_ctrl.rb +5 -5
- data/lib/wx/doc/gen/drag_drop.rb +18 -44
- data/lib/wx/doc/gen/drag_image.rb +7 -32
- data/lib/wx/doc/gen/editable_list_box.rb +4 -4
- data/lib/wx/doc/gen/event.rb +22 -24
- data/lib/wx/doc/gen/event_blocker.rb +1 -1
- data/lib/wx/doc/gen/event_list.rb +133 -7
- data/lib/wx/doc/gen/events.rb +162 -166
- data/lib/wx/doc/gen/evt_handler.rb +7 -7
- data/lib/wx/doc/gen/ext_help_controller.rb +8 -8
- data/lib/wx/doc/gen/file_ctrl.rb +200 -0
- data/lib/wx/doc/gen/file_ctrl_event.rb +80 -0
- data/lib/wx/doc/gen/file_dialog.rb +5 -3
- 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 +1 -1
- data/lib/wx/doc/gen/file_picker_ctrl.rb +5 -5
- data/lib/wx/doc/gen/file_system.rb +250 -0
- data/lib/wx/doc/gen/find_dialog_event.rb +1 -1
- data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
- data/lib/wx/doc/gen/flex_grid_sizer.rb +4 -4
- data/lib/wx/doc/gen/font.rb +61 -66
- data/lib/wx/doc/gen/font_data.rb +6 -6
- data/lib/wx/doc/gen/font_dialog.rb +2 -2
- data/lib/wx/doc/gen/font_picker_ctrl.rb +3 -3
- data/lib/wx/doc/gen/frame.rb +10 -24
- data/lib/wx/doc/gen/fs_file.rb +61 -21
- data/lib/wx/doc/gen/gauge.rb +5 -5
- data/lib/wx/doc/gen/gb_sizer_item.rb +12 -26
- data/lib/wx/doc/gen/gdi_common.rb +8 -8
- data/lib/wx/doc/gen/generic_dir_ctrl.rb +8 -8
- data/lib/wx/doc/gen/graphics_context.rb +291 -60
- data/lib/wx/doc/gen/graphics_object.rb +47 -101
- data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_attr.rb +36 -51
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +7 -12
- data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_editor.rb +6 -4
- data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_ctrl.rb +416 -173
- data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_event.rb +7 -7
- data/lib/wx/doc/gen/grid/grid_range_select_event.rb +9 -9
- data/lib/wx/doc/gen/grid/grid_size_event.rb +5 -5
- data/lib/wx/doc/gen/grid/grid_string_table.rb +6 -6
- data/lib/wx/doc/gen/grid/grid_table_base.rb +15 -15
- data/lib/wx/doc/gen/grid_bag_sizer.rb +10 -10
- data/lib/wx/doc/gen/gui_event_loop.rb +12 -12
- 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 +46 -7
- data/lib/wx/doc/gen/help_provider.rb +3 -3
- data/lib/wx/doc/gen/html/html_cell.rb +67 -44
- data/lib/wx/doc/gen/html/html_cell_event.rb +3 -3
- data/lib/wx/doc/gen/html/html_easy_printing.rb +6 -6
- data/lib/wx/doc/gen/html/html_help_controller.rb +79 -52
- data/lib/wx/doc/gen/html/html_help_data.rb +2 -2
- data/lib/wx/doc/gen/html/html_help_window.rb +21 -27
- data/lib/wx/doc/gen/html/html_list_box.rb +11 -11
- data/lib/wx/doc/gen/html/html_printout.rb +1 -1
- data/lib/wx/doc/gen/html/html_window.rb +36 -32
- data/lib/wx/doc/gen/hyperlink_ctrl.rb +5 -5
- data/lib/wx/doc/gen/icon.rb +10 -10
- data/lib/wx/doc/gen/icon_location.rb +1 -1
- data/lib/wx/doc/gen/image.rb +46 -51
- data/lib/wx/doc/gen/image_list.rb +14 -24
- data/lib/wx/doc/gen/info_bar.rb +152 -0
- data/lib/wx/doc/gen/keyboard_state.rb +17 -17
- data/lib/wx/doc/gen/list_box.rb +24 -24
- data/lib/wx/doc/gen/list_ctrl.rb +61 -96
- data/lib/wx/doc/gen/list_event.rb +2 -2
- data/lib/wx/doc/gen/listbook.rb +1 -1
- data/lib/wx/doc/gen/locale.rb +15 -39
- data/lib/wx/doc/gen/log.rb +17 -67
- data/lib/wx/doc/gen/mdi_client_window.rb +1 -1
- data/lib/wx/doc/gen/mdi_frame.rb +12 -12
- data/lib/wx/doc/gen/media_ctrl.rb +17 -17
- data/lib/wx/doc/gen/media_event.rb +1 -1
- data/lib/wx/doc/gen/memory_dc.rb +3 -6
- data/lib/wx/doc/gen/menu.rb +15 -16
- data/lib/wx/doc/gen/menu_bar.rb +9 -26
- data/lib/wx/doc/gen/menu_item.rb +88 -88
- data/lib/wx/doc/gen/message_dialog.rb +6 -6
- data/lib/wx/doc/gen/mini_frame.rb +4 -4
- data/lib/wx/doc/gen/mouse_state.rb +50 -10
- data/lib/wx/doc/gen/non_owned_window.rb +2 -2
- data/lib/wx/doc/gen/notebook.rb +9 -9
- data/lib/wx/doc/gen/number_entry_dialog.rb +1 -1
- data/lib/wx/doc/gen/object.rb +1 -12
- data/lib/wx/doc/gen/palette.rb +12 -14
- data/lib/wx/doc/gen/panel.rb +6 -6
- data/lib/wx/doc/gen/pen.rb +25 -25
- data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -2
- data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +14 -14
- data/lib/wx/doc/gen/pg/pg_cell.rb +3 -6
- data/lib/wx/doc/gen/pg/pg_editor.rb +19 -19
- data/lib/wx/doc/gen/pg/pg_multi_button.rb +61 -86
- data/lib/wx/doc/gen/pg/pg_properties.rb +210 -263
- data/lib/wx/doc/gen/pg/pg_property.rb +161 -257
- data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -2
- data/lib/wx/doc/gen/pg/property_grid.rb +32 -32
- data/lib/wx/doc/gen/pg/property_grid_event.rb +7 -7
- data/lib/wx/doc/gen/pg/property_grid_interface.rb +43 -49
- data/lib/wx/doc/gen/pg/property_grid_manager.rb +41 -44
- data/lib/wx/doc/gen/pg/property_grid_page.rb +11 -20
- data/lib/wx/doc/gen/pg/property_grid_page_state.rb +10 -19
- data/lib/wx/doc/gen/picker_base.rb +5 -5
- data/lib/wx/doc/gen/platform_info.rb +174 -14
- data/lib/wx/doc/gen/popup_window.rb +2 -2
- data/lib/wx/doc/gen/progress_dialog.rb +2 -2
- data/lib/wx/doc/gen/property_sheet_dialog.rb +3 -3
- data/lib/wx/doc/gen/prt/preview_frame.rb +14 -1
- data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -1
- data/lib/wx/doc/gen/prt/print_data.rb +44 -44
- data/lib/wx/doc/gen/prt/printer.rb +23 -28
- data/lib/wx/doc/gen/query_layout_info_event.rb +4 -4
- data/lib/wx/doc/gen/radio_box.rb +13 -13
- data/lib/wx/doc/gen/radio_button.rb +7 -7
- data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +28 -28
- data/lib/wx/doc/gen/rbn/ribbon_bar.rb +13 -13
- data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +1 -1
- data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +13 -13
- data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -2
- data/lib/wx/doc/gen/rbn/ribbon_control.rb +8 -8
- data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +8 -14
- data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +1 -1
- data/lib/wx/doc/gen/rbn/ribbon_page.rb +7 -7
- data/lib/wx/doc/gen/rbn/ribbon_panel.rb +12 -16
- data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +1 -1
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +13 -13
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -2
- 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 +26 -35
- data/lib/wx/doc/gen/region_iterator.rb +1 -1
- data/lib/wx/doc/gen/rtc/rich_text_box.rb +423 -0
- data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +608 -1520
- 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 +437 -474
- data/lib/wx/doc/gen/rtc/rich_text_event.rb +9 -9
- data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +13 -13
- 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 +14 -14
- data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +3 -16
- 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 +18 -18
- 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 -5
- data/lib/wx/doc/gen/sash_layout_window.rb +10 -10
- data/lib/wx/doc/gen/sash_window.rb +7 -7
- data/lib/wx/doc/gen/scroll_bar.rb +6 -6
- data/lib/wx/doc/gen/scrolled_canvas.rb +12 -18
- data/lib/wx/doc/gen/scrolled_control.rb +12 -18
- data/lib/wx/doc/gen/scrolled_window.rb +12 -18
- data/lib/wx/doc/gen/search_ctrl.rb +7 -7
- data/lib/wx/doc/gen/simplebook.rb +5 -5
- data/lib/wx/doc/gen/single_choice_dialog.rb +1 -2
- data/lib/wx/doc/gen/sizer.rb +40 -45
- data/lib/wx/doc/gen/sizer_item.rb +5 -5
- data/lib/wx/doc/gen/slider.rb +4 -4
- data/lib/wx/doc/gen/spin_button.rb +3 -3
- data/lib/wx/doc/gen/spin_ctrl.rb +3 -3
- 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 +1 -1
- data/lib/wx/doc/gen/splitter_event.rb +1 -1
- data/lib/wx/doc/gen/splitter_window.rb +18 -14
- data/lib/wx/doc/gen/static_bitmap.rb +6 -6
- data/lib/wx/doc/gen/static_box.rb +11 -11
- data/lib/wx/doc/gen/static_line.rb +5 -5
- data/lib/wx/doc/gen/static_text.rb +5 -5
- data/lib/wx/doc/gen/status_bar.rb +41 -7
- data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +148 -180
- data/lib/wx/doc/gen/stc/styled_text_event.rb +6 -6
- data/lib/wx/doc/gen/svg_file_dc.rb +5 -5
- data/lib/wx/doc/gen/system_options.rb +2 -2
- data/lib/wx/doc/gen/system_settings.rb +6 -6
- data/lib/wx/doc/gen/task_bar_icon.rb +7 -7
- data/lib/wx/doc/gen/task_bar_icon_event.rb +1 -1
- data/lib/wx/doc/gen/text_attr.rb +56 -54
- data/lib/wx/doc/gen/text_ctrl.rb +15 -39
- data/lib/wx/doc/gen/text_entry.rb +16 -16
- data/lib/wx/doc/gen/text_entry_dialog.rb +4 -4
- data/lib/wx/doc/gen/text_validator.rb +3 -8
- data/lib/wx/doc/gen/time_picker_ctrl.rb +5 -5
- data/lib/wx/doc/gen/timer.rb +5 -5
- data/lib/wx/doc/gen/tip_provider.rb +2 -2
- data/lib/wx/doc/gen/toggle_button.rb +6 -6
- data/lib/wx/doc/gen/tool_bar.rb +32 -39
- data/lib/wx/doc/gen/tool_tip.rb +1 -9
- data/lib/wx/doc/gen/toolbook.rb +6 -6
- data/lib/wx/doc/gen/top_level_window.rb +27 -97
- data/lib/wx/doc/gen/tree_ctrl.rb +22 -22
- data/lib/wx/doc/gen/tree_event.rb +2 -2
- data/lib/wx/doc/gen/treebook.rb +14 -14
- data/lib/wx/doc/gen/ui_action_simulator.rb +19 -18
- data/lib/wx/doc/gen/utils.rb +12 -12
- 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 +3 -3
- data/lib/wx/doc/gen/variant.rb +22 -22
- data/lib/wx/doc/gen/window.rb +162 -127
- data/lib/wx/doc/gen/with_images.rb +1 -1
- data/lib/wx/doc/gen/wizard.rb +4 -4
- data/lib/wx/doc/gen/wizard_event.rb +3 -3
- data/lib/wx/doc/gen/wizard_page.rb +2 -2
- data/lib/wx/doc/gen/wizard_page_simple.rb +1 -1
- data/lib/wx/doc/gen/wrap_sizer.rb +65 -0
- data/lib/wx/doc/gen/xml_node.rb +10 -10
- data/lib/wx/doc/gen/xml_resource.rb +12 -12
- 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 +12 -4
- data/lib/wx/doc/list_ctrl.rb +6 -0
- data/lib/wx/doc/log.rb +17 -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 +6 -0
- 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 +6 -0
- 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 +6 -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 +11 -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 +96 -7
- 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 +6 -3
- 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 +1794 -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_exit_exception.rb +36 -0
- data/tests/test_app_init_exception.rb +20 -0
- data/tests/test_app_traits.rb +33 -0
- data/tests/test_art.rb +22 -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_book_controls.rb +29 -0
- data/tests/test_box_sizer.rb +5 -2
- 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_exceptions.rb +41 -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 +7 -4
- data/tests/test_intl.rb +3 -0
- data/tests/test_item_data.rb +3 -0
- data/tests/test_list_ctrl.rb +4 -1
- data/tests/test_log.rb +63 -0
- data/tests/test_proof_check.rb +52 -0
- data/tests/test_richtext.rb +204 -0
- data/tests/test_sizer.rb +43 -0
- data/tests/test_std_controls.rb +81 -35
- data/tests/test_timer.rb +3 -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 +86 -3
- data/lib/wx/doc/gen/html/html_help_frame.rb +0 -112
data/lib/wx/doc/gen/events.rb
CHANGED
@@ -41,25 +41,25 @@ module Wx
|
|
41
41
|
# Returns true if the OnIdle function processing this event requested more processing time.
|
42
42
|
#
|
43
43
|
# @see Wx::IdleEvent#request_more
|
44
|
-
# @return [
|
44
|
+
# @return [Boolean]
|
45
45
|
def more_requested; end
|
46
46
|
|
47
47
|
# Tells wxWidgets that more processing is required.
|
48
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.
|
49
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.
|
50
50
|
# @see Wx::IdleEvent#more_requested
|
51
|
-
# @param needMore [
|
51
|
+
# @param needMore [Boolean]
|
52
52
|
# @return [void]
|
53
53
|
def request_more(needMore=true) end
|
54
54
|
|
55
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.
|
56
56
|
#
|
57
57
|
# @see Wx::IdleEvent.set_mode.
|
58
|
-
# @return [IdleMode]
|
58
|
+
# @return [Wx::IdleMode]
|
59
59
|
def self.get_mode; end
|
60
60
|
|
61
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.
|
62
|
-
# @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}.
|
63
63
|
# @return [void]
|
64
64
|
def self.set_mode(mode) end
|
65
65
|
|
@@ -76,7 +76,7 @@ module Wx
|
|
76
76
|
class NotifyEvent < CommandEvent
|
77
77
|
|
78
78
|
# Constructor (used internally by wxWidgets only).
|
79
|
-
# @param eventType [Wx::
|
79
|
+
# @param eventType [Wx::CommandLinkButton::EventType]
|
80
80
|
# @param id [Integer]
|
81
81
|
# @return [Wx::NotifyEvent]
|
82
82
|
def initialize(eventType=Wx::EVT_NULL, id=0) end
|
@@ -87,7 +87,7 @@ module Wx
|
|
87
87
|
def allow; end
|
88
88
|
|
89
89
|
# Returns true if the change is allowed ({Wx::NotifyEvent#veto} hasn't been called) or false otherwise (if it was).
|
90
|
-
# @return [
|
90
|
+
# @return [Boolean]
|
91
91
|
def is_allowed; end
|
92
92
|
alias_method :allowed?, :is_allowed
|
93
93
|
|
@@ -166,7 +166,7 @@ module Wx
|
|
166
166
|
class ScrollEvent < CommandEvent
|
167
167
|
|
168
168
|
# Constructor.
|
169
|
-
# @param commandType [Wx::
|
169
|
+
# @param commandType [Wx::CommandLinkButton::EventType]
|
170
170
|
# @param id [Integer]
|
171
171
|
# @param pos [Integer]
|
172
172
|
# @param orientation [Integer]
|
@@ -230,7 +230,7 @@ module Wx
|
|
230
230
|
class ScrollWinEvent < Event
|
231
231
|
|
232
232
|
# Constructor.
|
233
|
-
# @param commandType [Wx::
|
233
|
+
# @param commandType [Wx::CommandLinkButton::EventType]
|
234
234
|
# @param pos [Integer]
|
235
235
|
# @param orientation [Integer]
|
236
236
|
# @return [Wx::ScrollWinEvent]
|
@@ -261,7 +261,7 @@ module Wx
|
|
261
261
|
end # ScrollWinEvent
|
262
262
|
|
263
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.
|
264
|
-
# 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).
|
265
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.
|
266
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.
|
267
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.
|
@@ -363,78 +363,78 @@ module Wx
|
|
363
363
|
# - {Wx::EVT_MOUSEWHEEL}
|
364
364
|
#
|
365
365
|
# - {Wx::EVT_MAGNIFY}
|
366
|
-
# @param mouseEventType [Wx::
|
366
|
+
# @param mouseEventType [Wx::CommandLinkButton::EventType]
|
367
367
|
# @return [Wx::MouseEvent]
|
368
368
|
def initialize(mouseEventType=Wx::EVT_NULL) end
|
369
369
|
|
370
370
|
# Returns true if the event was a first extra button double click.
|
371
|
-
# @return [
|
371
|
+
# @return [Boolean]
|
372
372
|
def aux1d_click; end
|
373
373
|
|
374
374
|
# Returns true if the first extra button mouse button changed to down.
|
375
|
-
# @return [
|
375
|
+
# @return [Boolean]
|
376
376
|
def aux1down; end
|
377
377
|
|
378
378
|
# Returns true if the first extra button mouse button changed to up.
|
379
|
-
# @return [
|
379
|
+
# @return [Boolean]
|
380
380
|
def aux1up; end
|
381
381
|
|
382
382
|
# Returns true if the event was a second extra button double click.
|
383
|
-
# @return [
|
383
|
+
# @return [Boolean]
|
384
384
|
def aux2d_click; end
|
385
385
|
|
386
386
|
# Returns true if the second extra button mouse button changed to down.
|
387
|
-
# @return [
|
387
|
+
# @return [Boolean]
|
388
388
|
def aux2down; end
|
389
389
|
|
390
390
|
# Returns true if the second extra button mouse button changed to up.
|
391
|
-
# @return [
|
391
|
+
# @return [Boolean]
|
392
392
|
def aux2up; end
|
393
393
|
|
394
394
|
# Returns true if the event was generated by the specified button.
|
395
395
|
#
|
396
396
|
# @see wxMouseState::ButtoinIsDown()
|
397
|
-
# @param but [MouseButton]
|
398
|
-
# @return [
|
397
|
+
# @param but [Wx::MouseButton]
|
398
|
+
# @return [Boolean]
|
399
399
|
def button(but) end
|
400
400
|
|
401
401
|
# If the argument is omitted, this returns true if the event was a mouse double click event.
|
402
402
|
# Otherwise the argument specifies which double click event was generated (see {Wx::MouseEvent#button} for the possible values).
|
403
|
-
# @param but [MouseButton]
|
404
|
-
# @return [
|
405
|
-
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
|
406
406
|
|
407
407
|
# If the argument is omitted, this returns true if the event was a mouse button down event.
|
408
408
|
# Otherwise the argument specifies which button-down event was generated (see {Wx::MouseEvent#button} for the possible values).
|
409
|
-
# @param but [MouseButton]
|
410
|
-
# @return [
|
411
|
-
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
|
412
412
|
|
413
413
|
# If the argument is omitted, this returns true if the event was a mouse button up event.
|
414
414
|
# Otherwise the argument specifies which button-up event was generated (see {Wx::MouseEvent#button} for the possible values).
|
415
|
-
# @param but [MouseButton]
|
416
|
-
# @return [
|
417
|
-
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
|
418
418
|
|
419
419
|
# Returns true if this was a dragging event (motion while a button is depressed).
|
420
420
|
#
|
421
421
|
# @see Wx::MouseEvent#moving
|
422
|
-
# @return [
|
422
|
+
# @return [Boolean]
|
423
423
|
def dragging; end
|
424
424
|
|
425
425
|
# Returns true if the mouse was entering the window.
|
426
426
|
#
|
427
427
|
# @see Wx::MouseEvent#leaving
|
428
|
-
# @return [
|
428
|
+
# @return [Boolean]
|
429
429
|
def entering; end
|
430
430
|
|
431
|
-
# 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).
|
432
|
-
# 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.
|
433
433
|
# @return [Integer]
|
434
434
|
def get_button; end
|
435
435
|
|
436
436
|
# Returns the number of mouse clicks for this event: 1 for a simple click, 2 for a double-click, 3 for a triple-click and so on.
|
437
|
-
# Currently this function is implemented only in
|
437
|
+
# Currently this function is implemented only in wxMac and returns -1 for the other platforms (you can still distinguish simple clicks from double-clicks as they generate different kinds of events however).
|
438
438
|
# @return [Integer]
|
439
439
|
def get_click_count; end
|
440
440
|
alias_method :click_count, :get_click_count
|
@@ -475,7 +475,7 @@ module Wx
|
|
475
475
|
|
476
476
|
# On Mac, has the user selected "Natural" scrolling in their System Preferences? Currently false on all other OS's.
|
477
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.
|
478
|
-
# @return [
|
478
|
+
# @return [Boolean]
|
479
479
|
def is_wheel_inverted; end
|
480
480
|
alias_method :wheel_inverted?, :is_wheel_inverted
|
481
481
|
|
@@ -489,75 +489,75 @@ module Wx
|
|
489
489
|
# Gets the axis the wheel operation concerns.
|
490
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.
|
491
491
|
# Notice that before wxWidgets 2.9.4 this method returned int.
|
492
|
-
# @return [MouseWheelAxis]
|
492
|
+
# @return [Wx::MouseWheelAxis]
|
493
493
|
def get_wheel_axis; end
|
494
494
|
alias_method :wheel_axis, :get_wheel_axis
|
495
495
|
|
496
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}).
|
497
|
-
# @return [
|
497
|
+
# @return [Boolean]
|
498
498
|
def is_button; end
|
499
499
|
alias_method :button?, :is_button
|
500
500
|
|
501
501
|
# Returns true if the system has been setup to do page scrolling with the mouse wheel instead of line scrolling.
|
502
|
-
# @return [
|
502
|
+
# @return [Boolean]
|
503
503
|
def is_page_scroll; end
|
504
504
|
alias_method :page_scroll?, :is_page_scroll
|
505
505
|
|
506
506
|
# Returns true if the mouse was leaving the window.
|
507
507
|
#
|
508
508
|
# @see Wx::MouseEvent#entering.
|
509
|
-
# @return [
|
509
|
+
# @return [Boolean]
|
510
510
|
def leaving; end
|
511
511
|
|
512
512
|
# Returns true if the event was a left double click.
|
513
|
-
# @return [
|
513
|
+
# @return [Boolean]
|
514
514
|
def left_d_click; end
|
515
515
|
|
516
516
|
# Returns true if the left mouse button changed to down.
|
517
|
-
# @return [
|
517
|
+
# @return [Boolean]
|
518
518
|
def left_down; end
|
519
519
|
|
520
520
|
# Returns true if the left mouse button changed to up.
|
521
|
-
# @return [
|
521
|
+
# @return [Boolean]
|
522
522
|
def left_up; end
|
523
523
|
|
524
524
|
# Returns true if the event is a magnify (i.e. pinch to zoom) event.
|
525
525
|
# Such events are currently generated only under macOS.
|
526
526
|
# @see Wx::MouseEvent#get_magnification
|
527
|
-
# @return [
|
527
|
+
# @return [Boolean]
|
528
528
|
def magnify; end
|
529
529
|
|
530
530
|
# Returns true if the Meta key was down at the time of the event.
|
531
|
-
# @return [
|
531
|
+
# @return [Boolean]
|
532
532
|
def meta_down; end
|
533
533
|
|
534
534
|
# Returns true if the event was a middle double click.
|
535
|
-
# @return [
|
535
|
+
# @return [Boolean]
|
536
536
|
def middle_d_click; end
|
537
537
|
|
538
538
|
# Returns true if the middle mouse button changed to down.
|
539
|
-
# @return [
|
539
|
+
# @return [Boolean]
|
540
540
|
def middle_down; end
|
541
541
|
|
542
542
|
# Returns true if the middle mouse button changed to up.
|
543
|
-
# @return [
|
543
|
+
# @return [Boolean]
|
544
544
|
def middle_up; end
|
545
545
|
|
546
546
|
# Returns true if this was a motion event and no mouse buttons were pressed.
|
547
547
|
# If any mouse button is held pressed, then this method returns false and {Wx::MouseEvent#dragging} returns true.
|
548
|
-
# @return [
|
548
|
+
# @return [Boolean]
|
549
549
|
def moving; end
|
550
550
|
|
551
551
|
# Returns true if the event was a right double click.
|
552
|
-
# @return [
|
552
|
+
# @return [Boolean]
|
553
553
|
def right_d_click; end
|
554
554
|
|
555
555
|
# Returns true if the right mouse button changed to down.
|
556
|
-
# @return [
|
556
|
+
# @return [Boolean]
|
557
557
|
def right_down; end
|
558
558
|
|
559
559
|
# Returns true if the right mouse button changed to up.
|
560
|
-
# @return [
|
560
|
+
# @return [Boolean]
|
561
561
|
def right_up; end
|
562
562
|
|
563
563
|
# Returns the physical mouse position.
|
@@ -576,23 +576,23 @@ module Wx
|
|
576
576
|
alias_method :y, :get_y
|
577
577
|
|
578
578
|
# Returns true if the left mouse button is currently down.
|
579
|
-
# @return [
|
579
|
+
# @return [Boolean]
|
580
580
|
def left_is_down; end
|
581
581
|
|
582
582
|
# Returns true if the middle mouse button is currently down.
|
583
|
-
# @return [
|
583
|
+
# @return [Boolean]
|
584
584
|
def middle_is_down; end
|
585
585
|
|
586
586
|
# Returns true if the right mouse button is currently down.
|
587
|
-
# @return [
|
587
|
+
# @return [Boolean]
|
588
588
|
def right_is_down; end
|
589
589
|
|
590
590
|
# Returns true if the first extra button mouse button is currently down.
|
591
|
-
# @return [
|
591
|
+
# @return [Boolean]
|
592
592
|
def aux1is_down; end
|
593
593
|
|
594
594
|
# Returns true if the second extra button mouse button is currently down.
|
595
|
-
# @return [
|
595
|
+
# @return [Boolean]
|
596
596
|
def aux2is_down; end
|
597
597
|
|
598
598
|
# @param x [Integer]
|
@@ -610,27 +610,27 @@ module Wx
|
|
610
610
|
def set_position(pos) end
|
611
611
|
alias_method :position=, :set_position
|
612
612
|
|
613
|
-
# @param down [
|
613
|
+
# @param down [Boolean]
|
614
614
|
# @return [void]
|
615
615
|
def set_left_down(down) end
|
616
616
|
alias_method :left_down=, :set_left_down
|
617
617
|
|
618
|
-
# @param down [
|
618
|
+
# @param down [Boolean]
|
619
619
|
# @return [void]
|
620
620
|
def set_middle_down(down) end
|
621
621
|
alias_method :middle_down=, :set_middle_down
|
622
622
|
|
623
|
-
# @param down [
|
623
|
+
# @param down [Boolean]
|
624
624
|
# @return [void]
|
625
625
|
def set_right_down(down) end
|
626
626
|
alias_method :right_down=, :set_right_down
|
627
627
|
|
628
|
-
# @param down [
|
628
|
+
# @param down [Boolean]
|
629
629
|
# @return [void]
|
630
630
|
def set_aux1down(down) end
|
631
631
|
alias_method :aux1down=, :set_aux1down
|
632
632
|
|
633
|
-
# @param down [
|
633
|
+
# @param down [Boolean]
|
634
634
|
# @return [void]
|
635
635
|
def set_aux2down(down) end
|
636
636
|
alias_method :aux2down=, :set_aux2down
|
@@ -664,67 +664,67 @@ module Wx
|
|
664
664
|
# Returns true if any modifiers at all are pressed.
|
665
665
|
# This is equivalent to <code>Wx::MouseEvent#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
|
666
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.
|
667
|
-
# @return [
|
667
|
+
# @return [Boolean]
|
668
668
|
def has_any_modifiers; end
|
669
669
|
alias_method :has_any_modifiers?, :has_any_modifiers
|
670
670
|
|
671
671
|
# Returns true if Control or Alt are pressed.
|
672
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).
|
673
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.
|
674
|
-
# @return [
|
674
|
+
# @return [Boolean]
|
675
675
|
def has_modifiers; end
|
676
676
|
alias_method :has_modifiers?, :has_modifiers
|
677
677
|
|
678
678
|
# Returns true if the Control key or Apple/Command key under macOS is pressed.
|
679
679
|
# This function doesn't distinguish between right and left control keys.
|
680
680
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
681
|
-
# @return [
|
681
|
+
# @return [Boolean]
|
682
682
|
def control_down; end
|
683
683
|
|
684
684
|
# Returns true if the Control key (also under macOS).
|
685
685
|
# This function doesn't distinguish between right and left control keys.
|
686
686
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
687
|
-
# @return [
|
687
|
+
# @return [Boolean]
|
688
688
|
def raw_control_down; end
|
689
689
|
|
690
690
|
# Returns true if the Shift key is pressed.
|
691
691
|
# This function doesn't distinguish between right and left shift keys.
|
692
692
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
693
|
-
# @return [
|
693
|
+
# @return [Boolean]
|
694
694
|
def shift_down; end
|
695
695
|
|
696
696
|
# Returns true if the Alt key is pressed.
|
697
697
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
698
|
-
# @return [
|
698
|
+
# @return [Boolean]
|
699
699
|
def alt_down; end
|
700
700
|
|
701
701
|
# Returns true if the key used for command accelerators is pressed.
|
702
702
|
# Same as {Wx::MouseEvent#control_down}. Deprecated.
|
703
703
|
# Notice that {Wx::MouseEvent#get_modifiers} should usually be used instead of this one.
|
704
|
-
# @return [
|
704
|
+
# @return [Boolean]
|
705
705
|
def cmd_down; end
|
706
706
|
|
707
|
-
# @param down [
|
707
|
+
# @param down [Boolean]
|
708
708
|
# @return [void]
|
709
709
|
def set_control_down(down) end
|
710
710
|
alias_method :control_down=, :set_control_down
|
711
711
|
|
712
|
-
# @param down [
|
712
|
+
# @param down [Boolean]
|
713
713
|
# @return [void]
|
714
714
|
def set_raw_control_down(down) end
|
715
715
|
alias_method :raw_control_down=, :set_raw_control_down
|
716
716
|
|
717
|
-
# @param down [
|
717
|
+
# @param down [Boolean]
|
718
718
|
# @return [void]
|
719
719
|
def set_shift_down(down) end
|
720
720
|
alias_method :shift_down=, :set_shift_down
|
721
721
|
|
722
|
-
# @param down [
|
722
|
+
# @param down [Boolean]
|
723
723
|
# @return [void]
|
724
724
|
def set_alt_down(down) end
|
725
725
|
alias_method :alt_down=, :set_alt_down
|
726
726
|
|
727
|
-
# @param down [
|
727
|
+
# @param down [Boolean]
|
728
728
|
# @return [void]
|
729
729
|
def set_meta_down(down) end
|
730
730
|
alias_method :meta_down=, :set_meta_down
|
@@ -772,7 +772,7 @@ module Wx
|
|
772
772
|
|
773
773
|
# Returns true if the cursor specified by this event is a valid cursor.
|
774
774
|
# You cannot specify {Wx::NULL_CURSOR} with this event, as it is not considered a valid cursor.
|
775
|
-
# @return [
|
775
|
+
# @return [Boolean]
|
776
776
|
def has_cursor; end
|
777
777
|
alias_method :has_cursor?, :has_cursor
|
778
778
|
|
@@ -799,7 +799,7 @@ module Wx
|
|
799
799
|
|
800
800
|
# Constructor.
|
801
801
|
# @param winid [Integer]
|
802
|
-
# @param type [Wx::
|
802
|
+
# @param type [Wx::CommandLinkButton::EventType]
|
803
803
|
# @return [Wx::GestureEvent]
|
804
804
|
def initialize(winid=0, type=Wx::EVT_NULL) end
|
805
805
|
|
@@ -809,12 +809,12 @@ module Wx
|
|
809
809
|
alias_method :position, :get_position
|
810
810
|
|
811
811
|
# Returns true if the event was the first in a gesture sequence.
|
812
|
-
# @return [
|
812
|
+
# @return [Boolean]
|
813
813
|
def is_gesture_start; end
|
814
814
|
alias_method :gesture_start?, :is_gesture_start
|
815
815
|
|
816
816
|
# Returns true if the event was the last in a gesture sequence.
|
817
|
-
# @return [
|
817
|
+
# @return [Boolean]
|
818
818
|
def is_gesture_end; end
|
819
819
|
alias_method :gesture_end?, :is_gesture_end
|
820
820
|
|
@@ -825,13 +825,13 @@ module Wx
|
|
825
825
|
alias_method :position=, :set_position
|
826
826
|
|
827
827
|
# Sets the event to be the first in a gesture sequence.
|
828
|
-
# @param isStart [
|
828
|
+
# @param isStart [Boolean]
|
829
829
|
# @return [void]
|
830
830
|
def set_gesture_start(isStart=true) end
|
831
831
|
alias_method :gesture_start=, :set_gesture_start
|
832
832
|
|
833
833
|
# Sets the event to be the last in a gesture sequence.
|
834
|
-
# @param isEnd [
|
834
|
+
# @param isEnd [Boolean]
|
835
835
|
# @return [void]
|
836
836
|
def set_gesture_end(isEnd=true) end
|
837
837
|
alias_method :gesture_end=, :set_gesture_end
|
@@ -1006,7 +1006,7 @@ module Wx
|
|
1006
1006
|
end # PressAndTapEvent
|
1007
1007
|
|
1008
1008
|
# This event class contains information about key press and release events.
|
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.
|
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::KeyCode::K_START} constant. While {Wx::KeyEvent#get_key_code} also returns the character code for Latin-1 keys for compatibility, it doesn't work for Unicode characters in general and will return {Wx::KeyCode::K_NONE} for any non-Latin-1 ones. If both {Wx::KeyEvent#get_unicode_key} and {Wx::KeyEvent#get_key_code} return {Wx::KeyCode::K_NONE} then the key has no WXK_xxx mapping and {Wx::KeyEvent#get_raw_key_code} can be used to distinguish between keys, but raw key codes are platform specific. For these reasons, it is recommended to always use {Wx::KeyEvent#get_unicode_key} and only fall back to {Wx::KeyEvent#get_key_code} if {Wx::KeyEvent#get_unicode_key} returned {Wx::KeyCode::K_NONE}, meaning that the event corresponds to a non-printable special keys, then optionally check {Wx::KeyEvent#get_raw_key_code} if {Wx::KeyEvent#get_key_code} also returned {Wx::KeyCode::K_NONE} or simply ignore that key.
|
1010
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.
|
1011
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:
|
1012
1012
|
#
|
@@ -1014,13 +1014,13 @@ module Wx
|
|
1014
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
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.
|
1016
1016
|
#
|
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.
|
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::KeyCode::K_NONE} in this case.
|
1018
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.
|
1019
1019
|
# To summarize: you should handle {Wx::EVT_CHAR} if you need the translated key and {Wx::EVT_KEY_DOWN} if you only need the value of the key itself, independent of the current keyboard state.
|
1020
1020
|
# Not all key down events may be generated by the user. As an example, {Wx::EVT_KEY_DOWN} with <code>=</code> key code can be generated using the standard US keyboard layout but not using the German one because the <code>=</code> key corresponds to Shift-0 key combination in this layout and the key code for it is 0, not <code>=</code>. Because of this you should avoid requiring your users to type key events that might be impossible to enter on their keyboard.
|
1021
1021
|
#
|
1022
|
-
# Another difference between key and char events is that another kind of translation is done for the latter ones when the Control key is pressed: char events for ASCII letters in this case carry codes corresponding to the ASCII value of Ctrl-Latter, i.e. 1 for Ctrl-A, 2 for Ctrl-B and so on until 26 for Ctrl-Z. This is convenient for terminal-like applications and can be completely ignored by all the other ones (if you need to handle Ctrl-A it is probably a better idea to use the key event rather than the char one). Notice that currently no translation is done for the presses of <code></code>[, <code>\</code>, <code></code>], <code>^</code> and _ keys which might be mapped to ASCII values from 27 to 31. Since version 2.9.2, the enum values {Wx::K_CONTROL}_A - {Wx::K_CONTROL}_Z can be used instead of the non-descriptive constant values 1-26.
|
1023
|
-
# Finally, modifier keys only generate key events but no char events at all. The modifiers keys are {Wx::K_SHIFT}, {Wx::K_CONTROL}, {Wx::K_ALT} and various {Wx::K_WINDOWS}_XXX from {Wx::KeyCode} enum.
|
1022
|
+
# Another difference between key and char events is that another kind of translation is done for the latter ones when the Control key is pressed: char events for ASCII letters in this case carry codes corresponding to the ASCII value of Ctrl-Latter, i.e. 1 for Ctrl-A, 2 for Ctrl-B and so on until 26 for Ctrl-Z. This is convenient for terminal-like applications and can be completely ignored by all the other ones (if you need to handle Ctrl-A it is probably a better idea to use the key event rather than the char one). Notice that currently no translation is done for the presses of <code></code>[, <code>\</code>, <code></code>], <code>^</code> and _ keys which might be mapped to ASCII values from 27 to 31. Since version 2.9.2, the enum values {Wx::KeyCode::K_CONTROL}_A - {Wx::KeyCode::K_CONTROL}_Z can be used instead of the non-descriptive constant values 1-26.
|
1023
|
+
# Finally, modifier keys only generate key events but no char events at all. The modifiers keys are {Wx::KeyCode::K_SHIFT}, {Wx::KeyCode::K_CONTROL}, {Wx::KeyCode::K_ALT} and various {Wx::KeyCode::K_WINDOWS}_XXX from {Wx::KeyCode} enum.
|
1024
1024
|
# Modifier keys events are special in one additional aspect: usually the keyboard state associated with a key press is well defined, e.g. {Wx::KeyboardState#shift_down} returns true only if the Shift key was held pressed when the key that generated this event itself was pressed. There is an ambiguity for the key press events for Shift key itself however. By convention, it is considered to be already pressed when it is pressed and already released when it is released. In other words, {Wx::EVT_KEY_DOWN} event for the Shift key itself will have {Wx::KeyModifier::MOD_SHIFT} in {Wx::KeyEvent#get_modifiers} and {Wx::KeyEvent#shift_down} will return true while the {Wx::EVT_KEY_UP} event for Shift itself will not have {Wx::KeyModifier::MOD_SHIFT} in its modifiers and {Wx::KeyEvent#shift_down} will return false.
|
1025
1025
|
# <b>Tip:</b> You may discover the key codes and modifiers generated by all the keys on your system interactively by running the Key Event Sample wxWidgets sample and pressing some keys in it.
|
1026
1026
|
# If a key down (EVT_KEY_DOWN) event is caught and the event handler does not call <code>event.Skip()</code> then the corresponding char event (EVT_CHAR) will not happen. This is by design and enables the programs that handle both types of events to avoid processing the same key twice. As a consequence, if you do not want to suppress the {Wx::EVT_CHAR} events for the keys you handle, always call <code>event.Skip()</code> in your {Wx::EVT_KEY_DOWN} handler. Not doing may also prevent accelerators defined using this key from working.
|
@@ -1059,14 +1059,14 @@ module Wx
|
|
1059
1059
|
|
1060
1060
|
# Constructor.
|
1061
1061
|
# Currently, the only valid event types are {Wx::EVT_CHAR} and {Wx::EVT_CHAR_HOOK}.
|
1062
|
-
# @param keyEventType [Wx::
|
1062
|
+
# @param keyEventType [Wx::CommandLinkButton::EventType]
|
1063
1063
|
# @return [Wx::KeyEvent]
|
1064
1064
|
def initialize(keyEventType=Wx::EVT_NULL) end
|
1065
1065
|
|
1066
1066
|
# Returns the key code of the key that generated this event.
|
1067
|
-
# ASCII symbols return normal ASCII values, while events from special keys such as "left cursor arrow" ({Wx::K_LEFT}) return values outside of the ASCII range. See {Wx::KeyCode} for a full list of the virtual key codes.
|
1068
|
-
# Note that this method returns a meaningful value only for special non-alphanumeric keys or if the user entered a Latin-1 character (this includes ASCII and the accented letters found in Western European languages but not letters of other alphabets such as e.g. Cyrillic). Otherwise it simply method returns {Wx::K_NONE} and {Wx::KeyEvent#get_unicode_key} should be used to obtain the corresponding Unicode character.
|
1069
|
-
# Using {Wx::KeyEvent#get_unicode_key} is in general the right thing to do if you are interested in the characters typed by the user, {Wx::KeyEvent#get_key_code} should be only used for special keys (for which {Wx::KeyEvent#get_unicode_key} returns
|
1067
|
+
# ASCII symbols return normal ASCII values, while events from special keys such as "left cursor arrow" ({Wx::KeyCode::K_LEFT}) return values outside of the ASCII range. See {Wx::KeyCode} for a full list of the virtual key codes.
|
1068
|
+
# Note that this method returns a meaningful value only for special non-alphanumeric keys or if the user entered a Latin-1 character (this includes ASCII and the accented letters found in Western European languages but not letters of other alphabets such as e.g. Cyrillic). Otherwise it simply method returns {Wx::KeyCode::K_NONE} and {Wx::KeyEvent#get_unicode_key} should be used to obtain the corresponding Unicode character.
|
1069
|
+
# Using {Wx::KeyEvent#get_unicode_key} is in general the right thing to do if you are interested in the characters typed by the user, {Wx::KeyEvent#get_key_code} should be only used for special keys (for which {Wx::KeyEvent#get_unicode_key} returns {Wx::KeyCode::K_NONE}). To handle both kinds of keys you might write:
|
1070
1070
|
# ```ruby
|
1071
1071
|
# def on_char(event)
|
1072
1072
|
# uc = event.get_unicode_key
|
@@ -1098,12 +1098,12 @@ module Wx
|
|
1098
1098
|
|
1099
1099
|
# Returns true if the key is in the given key category.
|
1100
1100
|
# @param category [Integer] A bitwise combination of named {Wx::KeyCategoryFlags} constants.
|
1101
|
-
# @return [
|
1101
|
+
# @return [Boolean]
|
1102
1102
|
def is_key_in_category(category) end
|
1103
1103
|
alias_method :key_in_category?, :is_key_in_category
|
1104
1104
|
|
1105
1105
|
# Returns true if this event is an auto-repeat of the key, false if this is the initial key press.
|
1106
|
-
# @return [
|
1106
|
+
# @return [Boolean]
|
1107
1107
|
def is_auto_repeat; end
|
1108
1108
|
alias_method :auto_repeat?, :is_auto_repeat
|
1109
1109
|
|
@@ -1112,7 +1112,7 @@ module Wx
|
|
1112
1112
|
# Under MSW, the raw key code is the value of wParam parameter of the corresponding message.
|
1113
1113
|
# Under GTK, the raw key code is the keyval field of the corresponding GDK event.
|
1114
1114
|
# Under macOS, the raw key code is the keyCode field of the corresponding NSEvent.
|
1115
|
-
# Currently the raw key codes are not supported by all ports
|
1115
|
+
# Currently the raw key codes are not supported by all ports.
|
1116
1116
|
# @return [Integer]
|
1117
1117
|
def get_raw_key_code; end
|
1118
1118
|
alias_method :raw_key_code, :get_raw_key_code
|
@@ -1122,13 +1122,13 @@ module Wx
|
|
1122
1122
|
# Under MSW, the raw flags are just the value of lParam parameter of the corresponding message.
|
1123
1123
|
# Under GTK, the raw flags contain the hardware_keycode field of the corresponding GDK event.
|
1124
1124
|
# Under macOS, the raw flags contain the modifiers state.
|
1125
|
-
# Currently the raw key flags are not supported by all ports
|
1125
|
+
# Currently the raw key flags are not supported by all ports.
|
1126
1126
|
# @return [Integer]
|
1127
1127
|
def get_raw_key_flags; end
|
1128
1128
|
alias_method :raw_key_flags, :get_raw_key_flags
|
1129
1129
|
|
1130
1130
|
# Returns the Unicode character corresponding to this key event.
|
1131
|
-
# If the key pressed doesn't have any character value (e.g. a cursor key) this method will return
|
1131
|
+
# If the key pressed doesn't have any character value (e.g. a cursor key) this method will return {Wx::KeyCode::K_NONE}. In this case you should use {Wx::KeyEvent#get_key_code} to retrieve the value of the key.
|
1132
1132
|
# This function is only available in Unicode build, i.e. when {Wx::Setup::USE_UNICODE} is 1.
|
1133
1133
|
# @return [String]
|
1134
1134
|
def get_unicode_key; end
|
@@ -1156,7 +1156,7 @@ module Wx
|
|
1156
1156
|
|
1157
1157
|
# Returns true if {Wx::KeyEvent#do_allow_next_event} had been called, false by default.
|
1158
1158
|
# This method is used by wxWidgets itself to determine whether the normal key events should be generated after {Wx::EVT_CHAR_HOOK} processing.
|
1159
|
-
# @return [
|
1159
|
+
# @return [Boolean]
|
1160
1160
|
def is_next_event_allowed; end
|
1161
1161
|
alias_method :next_event_allowed?, :is_next_event_allowed
|
1162
1162
|
|
@@ -1184,73 +1184,73 @@ module Wx
|
|
1184
1184
|
# Returns true if any modifiers at all are pressed.
|
1185
1185
|
# This is equivalent to <code>Wx::KeyEvent#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
|
1186
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.
|
1187
|
-
# @return [
|
1187
|
+
# @return [Boolean]
|
1188
1188
|
def has_any_modifiers; end
|
1189
1189
|
alias_method :has_any_modifiers?, :has_any_modifiers
|
1190
1190
|
|
1191
1191
|
# Returns true if Control or Alt are pressed.
|
1192
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).
|
1193
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.
|
1194
|
-
# @return [
|
1194
|
+
# @return [Boolean]
|
1195
1195
|
def has_modifiers; end
|
1196
1196
|
alias_method :has_modifiers?, :has_modifiers
|
1197
1197
|
|
1198
1198
|
# Returns true if the Control key or Apple/Command key under macOS is pressed.
|
1199
1199
|
# This function doesn't distinguish between right and left control keys.
|
1200
1200
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1201
|
-
# @return [
|
1201
|
+
# @return [Boolean]
|
1202
1202
|
def control_down; end
|
1203
1203
|
|
1204
1204
|
# Returns true if the Control key (also under macOS).
|
1205
1205
|
# This function doesn't distinguish between right and left control keys.
|
1206
1206
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1207
|
-
# @return [
|
1207
|
+
# @return [Boolean]
|
1208
1208
|
def raw_control_down; end
|
1209
1209
|
|
1210
1210
|
# Returns true if the Shift key is pressed.
|
1211
1211
|
# This function doesn't distinguish between right and left shift keys.
|
1212
1212
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1213
|
-
# @return [
|
1213
|
+
# @return [Boolean]
|
1214
1214
|
def shift_down; end
|
1215
1215
|
|
1216
1216
|
# Returns true if the Meta/Windows/Apple key is pressed.
|
1217
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.
|
1218
1218
|
# @see Wx::KeyEvent#cmd_down
|
1219
|
-
# @return [
|
1219
|
+
# @return [Boolean]
|
1220
1220
|
def meta_down; end
|
1221
1221
|
|
1222
1222
|
# Returns true if the Alt key is pressed.
|
1223
1223
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1224
|
-
# @return [
|
1224
|
+
# @return [Boolean]
|
1225
1225
|
def alt_down; end
|
1226
1226
|
|
1227
1227
|
# Returns true if the key used for command accelerators is pressed.
|
1228
1228
|
# Same as {Wx::KeyEvent#control_down}. Deprecated.
|
1229
1229
|
# Notice that {Wx::KeyEvent#get_modifiers} should usually be used instead of this one.
|
1230
|
-
# @return [
|
1230
|
+
# @return [Boolean]
|
1231
1231
|
def cmd_down; end
|
1232
1232
|
|
1233
|
-
# @param down [
|
1233
|
+
# @param down [Boolean]
|
1234
1234
|
# @return [void]
|
1235
1235
|
def set_control_down(down) end
|
1236
1236
|
alias_method :control_down=, :set_control_down
|
1237
1237
|
|
1238
|
-
# @param down [
|
1238
|
+
# @param down [Boolean]
|
1239
1239
|
# @return [void]
|
1240
1240
|
def set_raw_control_down(down) end
|
1241
1241
|
alias_method :raw_control_down=, :set_raw_control_down
|
1242
1242
|
|
1243
|
-
# @param down [
|
1243
|
+
# @param down [Boolean]
|
1244
1244
|
# @return [void]
|
1245
1245
|
def set_shift_down(down) end
|
1246
1246
|
alias_method :shift_down=, :set_shift_down
|
1247
1247
|
|
1248
|
-
# @param down [
|
1248
|
+
# @param down [Boolean]
|
1249
1249
|
# @return [void]
|
1250
1250
|
def set_alt_down(down) end
|
1251
1251
|
alias_method :alt_down=, :set_alt_down
|
1252
1252
|
|
1253
|
-
# @param down [
|
1253
|
+
# @param down [Boolean]
|
1254
1254
|
# @return [void]
|
1255
1255
|
def set_meta_down(down) end
|
1256
1256
|
alias_method :meta_down=, :set_meta_down
|
@@ -1378,10 +1378,6 @@ module Wx
|
|
1378
1378
|
# vb_pt = get_view_start # Top left corner of client
|
1379
1379
|
#
|
1380
1380
|
# Wx::RegionIterator.for_region(get_update_region) do |region_it|
|
1381
|
-
#
|
1382
|
-
# int vX,vY,vW,vH
|
1383
|
-
# wxRegionIterator upd(GetUpdateRegion()) # get the update rect list
|
1384
|
-
#
|
1385
1381
|
# region_it.each do |rct|
|
1386
1382
|
# # rct == Dimensions of client area to repaint in pixels
|
1387
1383
|
#
|
@@ -1473,7 +1469,7 @@ module Wx
|
|
1473
1469
|
class FocusEvent < Event
|
1474
1470
|
|
1475
1471
|
# Constructor.
|
1476
|
-
# @param eventType [Wx::
|
1472
|
+
# @param eventType [Wx::CommandLinkButton::EventType]
|
1477
1473
|
# @param id [Integer]
|
1478
1474
|
# @return [Wx::FocusEvent]
|
1479
1475
|
def initialize(eventType=Wx::EVT_NULL, id=0) end
|
@@ -1531,22 +1527,22 @@ module Wx
|
|
1531
1527
|
end # Reason
|
1532
1528
|
|
1533
1529
|
# Constructor.
|
1534
|
-
# @param eventType [Wx::
|
1535
|
-
# @param active [
|
1530
|
+
# @param eventType [Wx::CommandLinkButton::EventType]
|
1531
|
+
# @param active [Boolean]
|
1536
1532
|
# @param id [Integer]
|
1537
|
-
# @param activationReason [Reason]
|
1533
|
+
# @param activationReason [Wx::wxActivateEvent::Reason]
|
1538
1534
|
# @return [Wx::ActivateEvent]
|
1539
1535
|
def initialize(eventType=Wx::EVT_NULL, active=true, id=0, activationReason=Wx::ActivateEvent::Reason::Reason_Unknown) end
|
1540
1536
|
|
1541
1537
|
# Returns true if the application or window is being activated, false otherwise.
|
1542
|
-
# @return [
|
1538
|
+
# @return [Boolean]
|
1543
1539
|
def get_active; end
|
1544
1540
|
alias_method :active, :get_active
|
1545
1541
|
|
1546
1542
|
# Allows checking if the window was activated by clicking it with the mouse or in some other way.
|
1547
1543
|
# 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).
|
1548
1544
|
# Under all the other platforms, Reason_Unknown is always returned.
|
1549
|
-
# @return [Reason]
|
1545
|
+
# @return [Wx::wxActivateEvent::Reason]
|
1550
1546
|
def get_activation_reason; end
|
1551
1547
|
alias_method :activation_reason, :get_activation_reason
|
1552
1548
|
|
@@ -1611,7 +1607,7 @@ module Wx
|
|
1611
1607
|
class MenuEvent < Event
|
1612
1608
|
|
1613
1609
|
# Constructor.
|
1614
|
-
# @param type [Wx::
|
1610
|
+
# @param type [Wx::CommandLinkButton::EventType]
|
1615
1611
|
# @param id [Integer]
|
1616
1612
|
# @param menu [Wx::Menu]
|
1617
1613
|
# @return [Wx::MenuEvent]
|
@@ -1632,7 +1628,7 @@ module Wx
|
|
1632
1628
|
|
1633
1629
|
# Returns true if the menu which is being opened or closed is a popup menu, false if it is a normal one.
|
1634
1630
|
# This method should only be used with the OPEN and CLOSE events.
|
1635
|
-
# @return [
|
1631
|
+
# @return [Boolean]
|
1636
1632
|
def is_popup; end
|
1637
1633
|
alias_method :popup?, :is_popup
|
1638
1634
|
|
@@ -1684,43 +1680,43 @@ module Wx
|
|
1684
1680
|
class CloseEvent < Event
|
1685
1681
|
|
1686
1682
|
# Constructor.
|
1687
|
-
# @param commandEventType [Wx::
|
1683
|
+
# @param commandEventType [Wx::CommandLinkButton::EventType]
|
1688
1684
|
# @param id [Integer]
|
1689
1685
|
# @return [Wx::CloseEvent]
|
1690
1686
|
def initialize(commandEventType=Wx::EVT_NULL, id=0) end
|
1691
1687
|
|
1692
1688
|
# Returns true if you can veto a system shutdown or a window close event.
|
1693
1689
|
# 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.
|
1694
|
-
# @return [
|
1690
|
+
# @return [Boolean]
|
1695
1691
|
def can_veto; end
|
1696
1692
|
alias_method :can_veto?, :can_veto
|
1697
1693
|
|
1698
1694
|
# Returns true if the user is just logging off or false if the system is shutting down.
|
1699
1695
|
# This method can only be called for end session and query end session events, it doesn't make sense for close window event.
|
1700
|
-
# @return [
|
1696
|
+
# @return [Boolean]
|
1701
1697
|
def get_logging_off; end
|
1702
1698
|
alias_method :logging_off, :get_logging_off
|
1703
1699
|
|
1704
1700
|
# Sets the 'can veto' flag.
|
1705
|
-
# @param canVeto [
|
1701
|
+
# @param canVeto [Boolean]
|
1706
1702
|
# @return [void]
|
1707
1703
|
def set_can_veto(canVeto) end
|
1708
1704
|
alias_method :can_veto=, :set_can_veto
|
1709
1705
|
|
1710
1706
|
# Sets the 'logging off' flag.
|
1711
|
-
# @param loggingOff [
|
1707
|
+
# @param loggingOff [Boolean]
|
1712
1708
|
# @return [void]
|
1713
1709
|
def set_logging_off(loggingOff) end
|
1714
1710
|
alias_method :logging_off=, :set_logging_off
|
1715
1711
|
|
1716
1712
|
# 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.
|
1717
1713
|
# You can only veto a shutdown if {Wx::CloseEvent#can_veto} returns true.
|
1718
|
-
# @param veto [
|
1714
|
+
# @param veto [Boolean]
|
1719
1715
|
# @return [void]
|
1720
1716
|
def veto(veto=true) end
|
1721
1717
|
|
1722
1718
|
# Returns whether the Veto flag was set.
|
1723
|
-
# @return [
|
1719
|
+
# @return [Boolean]
|
1724
1720
|
def get_veto; end
|
1725
1721
|
|
1726
1722
|
end # CloseEvent
|
@@ -1746,18 +1742,18 @@ module Wx
|
|
1746
1742
|
|
1747
1743
|
# Constructor.
|
1748
1744
|
# @param winid [Integer]
|
1749
|
-
# @param show [
|
1745
|
+
# @param show [Boolean]
|
1750
1746
|
# @return [Wx::ShowEvent]
|
1751
1747
|
def initialize(winid=0, show=false) end
|
1752
1748
|
|
1753
1749
|
# Set whether the windows was shown or hidden.
|
1754
|
-
# @param show [
|
1750
|
+
# @param show [Boolean]
|
1755
1751
|
# @return [void]
|
1756
1752
|
def set_show(show) end
|
1757
1753
|
alias_method :show=, :set_show
|
1758
1754
|
|
1759
1755
|
# Return true if the window has been shown, false if it has been hidden.
|
1760
|
-
# @return [
|
1756
|
+
# @return [Boolean]
|
1761
1757
|
def is_shown; end
|
1762
1758
|
alias_method :shown?, :is_shown
|
1763
1759
|
|
@@ -1783,12 +1779,12 @@ module Wx
|
|
1783
1779
|
|
1784
1780
|
# Constructor.
|
1785
1781
|
# @param id [Integer]
|
1786
|
-
# @param iconized [
|
1782
|
+
# @param iconized [Boolean]
|
1787
1783
|
# @return [Wx::IconizeEvent]
|
1788
1784
|
def initialize(id=0, iconized=true) end
|
1789
1785
|
|
1790
1786
|
# Returns true if the frame has been iconized, false if it has been restored.
|
1791
|
-
# @return [
|
1787
|
+
# @return [Boolean]
|
1792
1788
|
def is_iconized; end
|
1793
1789
|
alias_method :iconized?, :is_iconized
|
1794
1790
|
|
@@ -1843,12 +1839,12 @@ module Wx
|
|
1843
1839
|
|
1844
1840
|
# Constructor.
|
1845
1841
|
# @param id [Integer]
|
1846
|
-
# @param fullscreen [
|
1842
|
+
# @param fullscreen [Boolean]
|
1847
1843
|
# @return [Wx::FullScreenEvent]
|
1848
1844
|
def initialize(id=0, fullscreen=true) end
|
1849
1845
|
|
1850
1846
|
# Returns true if the frame entered full screen, false if exited full screen.
|
1851
|
-
# @return [
|
1847
|
+
# @return [Boolean]
|
1852
1848
|
def is_full_screen; end
|
1853
1849
|
alias_method :full_screen?, :is_full_screen
|
1854
1850
|
|
@@ -1879,7 +1875,7 @@ module Wx
|
|
1879
1875
|
class JoystickEvent < Event
|
1880
1876
|
|
1881
1877
|
# Constructor.
|
1882
|
-
# @param eventType [Wx::
|
1878
|
+
# @param eventType [Wx::CommandLinkButton::EventType]
|
1883
1879
|
# @param state [Integer]
|
1884
1880
|
# @param joystick [Integer]
|
1885
1881
|
# @param change [Integer]
|
@@ -1888,17 +1884,17 @@ module Wx
|
|
1888
1884
|
|
1889
1885
|
# Returns true if the event was a down event from the specified button (or any button).
|
1890
1886
|
# @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.
|
1891
|
-
# @return [
|
1887
|
+
# @return [Boolean]
|
1892
1888
|
def button_down(button=Wx::JOY_BUTTON_ANY) end
|
1893
1889
|
|
1894
1890
|
# Returns true if the specified button (or any button) was in a down state.
|
1895
1891
|
# @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.
|
1896
|
-
# @return [
|
1892
|
+
# @return [Boolean]
|
1897
1893
|
def button_is_down(button=Wx::JOY_BUTTON_ANY) end
|
1898
1894
|
|
1899
1895
|
# Returns true if the event was an up event from the specified button (or any button).
|
1900
1896
|
# @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.
|
1901
|
-
# @return [
|
1897
|
+
# @return [Boolean]
|
1902
1898
|
def button_up(button=Wx::JOY_BUTTON_ANY) end
|
1903
1899
|
|
1904
1900
|
# Returns the identifier of the button changing state.
|
@@ -1943,17 +1939,17 @@ module Wx
|
|
1943
1939
|
alias_method :z_position, :get_z_position
|
1944
1940
|
|
1945
1941
|
# Returns true if this was a button up or down event (not 'is any button down?').
|
1946
|
-
# @return [
|
1942
|
+
# @return [Boolean]
|
1947
1943
|
def is_button; end
|
1948
1944
|
alias_method :button?, :is_button
|
1949
1945
|
|
1950
1946
|
# Returns true if this was an x, y move event.
|
1951
|
-
# @return [
|
1947
|
+
# @return [Boolean]
|
1952
1948
|
def is_move; end
|
1953
1949
|
alias_method :move?, :is_move
|
1954
1950
|
|
1955
1951
|
# Returns true if this was a z move event.
|
1956
|
-
# @return [
|
1952
|
+
# @return [Boolean]
|
1957
1953
|
def is_z_move; end
|
1958
1954
|
alias_method :z_move?, :is_z_move
|
1959
1955
|
|
@@ -1981,7 +1977,7 @@ module Wx
|
|
1981
1977
|
class DropFilesEvent < Event
|
1982
1978
|
|
1983
1979
|
# Constructor.
|
1984
|
-
# @param id [Wx::
|
1980
|
+
# @param id [Wx::CommandLinkButton::EventType]
|
1985
1981
|
# @param noFiles [Integer]
|
1986
1982
|
# @param files [String]
|
1987
1983
|
# @return [Wx::DropFilesEvent]
|
@@ -2041,22 +2037,22 @@ module Wx
|
|
2041
2037
|
def initialize(commandId=0) end
|
2042
2038
|
|
2043
2039
|
# Check or uncheck the UI element.
|
2044
|
-
# @param check [
|
2040
|
+
# @param check [Boolean]
|
2045
2041
|
# @return [void]
|
2046
2042
|
def check(check) end
|
2047
2043
|
|
2048
2044
|
# Enable or disable the UI element.
|
2049
|
-
# @param enable [
|
2045
|
+
# @param enable [Boolean]
|
2050
2046
|
# @return [void]
|
2051
2047
|
def enable(enable) end
|
2052
2048
|
|
2053
2049
|
# Returns true if the UI element should be checked.
|
2054
|
-
# @return [
|
2050
|
+
# @return [Boolean]
|
2055
2051
|
def get_checked; end
|
2056
2052
|
alias_method :checked, :get_checked
|
2057
2053
|
|
2058
2054
|
# Returns true if the UI element should be enabled.
|
2059
|
-
# @return [
|
2055
|
+
# @return [Boolean]
|
2060
2056
|
def get_enabled; end
|
2061
2057
|
alias_method :enabled, :get_enabled
|
2062
2058
|
|
@@ -2069,35 +2065,35 @@ module Wx
|
|
2069
2065
|
# event.check(...some condition...)
|
2070
2066
|
# end
|
2071
2067
|
# ```
|
2072
|
-
# @return [
|
2068
|
+
# @return [Boolean]
|
2073
2069
|
def is_checkable; end
|
2074
2070
|
alias_method :checkable?, :is_checkable
|
2075
2071
|
|
2076
2072
|
# Returns true if the application has called {Wx::UpdateUIEvent#check}.
|
2077
2073
|
# For wxWidgets internal use only.
|
2078
|
-
# @return [
|
2074
|
+
# @return [Boolean]
|
2079
2075
|
def get_set_checked; end
|
2080
2076
|
alias_method :set_checked, :get_set_checked
|
2081
2077
|
|
2082
2078
|
# Returns true if the application has called {Wx::UpdateUIEvent#enable}.
|
2083
2079
|
# For wxWidgets internal use only.
|
2084
|
-
# @return [
|
2080
|
+
# @return [Boolean]
|
2085
2081
|
def get_set_enabled; end
|
2086
2082
|
alias_method :set_enabled, :get_set_enabled
|
2087
2083
|
|
2088
2084
|
# Returns true if the application has called {Wx::UpdateUIEvent#show}.
|
2089
2085
|
# For wxWidgets internal use only.
|
2090
|
-
# @return [
|
2086
|
+
# @return [Boolean]
|
2091
2087
|
def get_set_shown; end
|
2092
2088
|
alias_method :set_shown, :get_set_shown
|
2093
2089
|
|
2094
2090
|
# Returns true if the application has called {Wx::UpdateUIEvent#set_text}.
|
2095
2091
|
# For wxWidgets internal use only.
|
2096
|
-
# @return [
|
2092
|
+
# @return [Boolean]
|
2097
2093
|
def get_set_text; end
|
2098
2094
|
|
2099
2095
|
# Returns true if the UI element should be shown.
|
2100
|
-
# @return [
|
2096
|
+
# @return [Boolean]
|
2101
2097
|
def get_shown; end
|
2102
2098
|
alias_method :shown, :get_shown
|
2103
2099
|
|
@@ -2113,7 +2109,7 @@ module Wx
|
|
2113
2109
|
alias_method :text=, :set_text
|
2114
2110
|
|
2115
2111
|
# Show or hide the UI element.
|
2116
|
-
# @param show [
|
2112
|
+
# @param show [Boolean]
|
2117
2113
|
# @return [void]
|
2118
2114
|
def show(show) end
|
2119
2115
|
|
@@ -2123,13 +2119,13 @@ module Wx
|
|
2123
2119
|
# @see Wx::UpdateUIEvent.set_update_interval
|
2124
2120
|
# @see Wx::UpdateUIEvent.set_mode
|
2125
2121
|
# @param window [Wx::Window]
|
2126
|
-
# @return [
|
2122
|
+
# @return [Boolean]
|
2127
2123
|
def self.can_update(window) end
|
2128
2124
|
|
2129
2125
|
# Static function returning a value specifying how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events.
|
2130
2126
|
#
|
2131
2127
|
# @see Wx::UpdateUIEvent.set_mode
|
2132
|
-
# @return [UpdateUIMode]
|
2128
|
+
# @return [Wx::UpdateUIMode]
|
2133
2129
|
def self.get_mode; end
|
2134
2130
|
|
2135
2131
|
# Returns the current interval between updates in milliseconds.
|
@@ -2147,7 +2143,7 @@ module Wx
|
|
2147
2143
|
def self.reset_update_time; end
|
2148
2144
|
|
2149
2145
|
# Specify how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events.
|
2150
|
-
# @param mode [UpdateUIMode] this parameter may be one of the {Wx::UpdateUIMode} enumeration values. The default mode is {Wx::UpdateUIMode::UPDATE_UI_PROCESS_ALL}.
|
2146
|
+
# @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}.
|
2151
2147
|
# @return [void]
|
2152
2148
|
def self.set_mode(mode) end
|
2153
2149
|
|
@@ -2352,12 +2348,12 @@ module Wx
|
|
2352
2348
|
# @return [Wx::QueryNewPaletteEvent]
|
2353
2349
|
def initialize(winid=0) end
|
2354
2350
|
|
2355
|
-
# @param realized [
|
2351
|
+
# @param realized [Boolean]
|
2356
2352
|
# @return [void]
|
2357
2353
|
def set_palette_realized(realized) end
|
2358
2354
|
alias_method :palette_realized=, :set_palette_realized
|
2359
2355
|
|
2360
|
-
# @return [
|
2356
|
+
# @return [Boolean]
|
2361
2357
|
def get_palette_realized; end
|
2362
2358
|
alias_method :palette_realized, :get_palette_realized
|
2363
2359
|
|
@@ -2418,18 +2414,18 @@ module Wx
|
|
2418
2414
|
alias_method :current_focus, :get_current_focus
|
2419
2415
|
|
2420
2416
|
# Returns true if the navigation was in the forward direction.
|
2421
|
-
# @return [
|
2417
|
+
# @return [Boolean]
|
2422
2418
|
def get_direction; end
|
2423
2419
|
alias_method :direction, :get_direction
|
2424
2420
|
|
2425
2421
|
# Returns true if the navigation event was from a tab key.
|
2426
2422
|
# This is required for proper navigation over radio buttons.
|
2427
|
-
# @return [
|
2423
|
+
# @return [Boolean]
|
2428
2424
|
def is_from_tab; end
|
2429
2425
|
alias_method :from_tab?, :is_from_tab
|
2430
2426
|
|
2431
2427
|
# Returns true if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook).
|
2432
|
-
# @return [
|
2428
|
+
# @return [Boolean]
|
2433
2429
|
def is_window_change; end
|
2434
2430
|
alias_method :window_change?, :is_window_change
|
2435
2431
|
|
@@ -2440,7 +2436,7 @@ module Wx
|
|
2440
2436
|
alias_method :current_focus=, :set_current_focus
|
2441
2437
|
|
2442
2438
|
# Sets the direction to forward if direction is true, or backward if false.
|
2443
|
-
# @param direction [
|
2439
|
+
# @param direction [Boolean]
|
2444
2440
|
# @return [void]
|
2445
2441
|
def set_direction(direction) end
|
2446
2442
|
alias_method :direction=, :set_direction
|
@@ -2453,13 +2449,13 @@ module Wx
|
|
2453
2449
|
alias_method :flags=, :set_flags
|
2454
2450
|
|
2455
2451
|
# Marks the navigation event as from a tab key.
|
2456
|
-
# @param fromTab [
|
2452
|
+
# @param fromTab [Boolean]
|
2457
2453
|
# @return [void]
|
2458
2454
|
def set_from_tab(fromTab) end
|
2459
2455
|
alias_method :from_tab=, :set_from_tab
|
2460
2456
|
|
2461
2457
|
# Marks the event as a window change event.
|
2462
|
-
# @param windowChange [
|
2458
|
+
# @param windowChange [Boolean]
|
2463
2459
|
# @return [void]
|
2464
2460
|
def set_window_change(windowChange) end
|
2465
2461
|
alias_method :window_change=, :set_window_change
|
@@ -2566,17 +2562,17 @@ module Wx
|
|
2566
2562
|
end # Origin
|
2567
2563
|
|
2568
2564
|
# Constructor.
|
2569
|
-
# @param type [Wx::
|
2565
|
+
# @param type [Wx::CommandLinkButton::EventType]
|
2570
2566
|
# @param winid [Integer]
|
2571
2567
|
# @param pt [Array(Integer, Integer), Wx::Point]
|
2572
|
-
# @param origin [Wx::
|
2568
|
+
# @param origin [Wx::wxHelpEvent::Origin]
|
2573
2569
|
# @return [Wx::HelpEvent]
|
2574
2570
|
def initialize(type=Wx::EVT_NULL, winid=0, pt=Wx::DEFAULT_POSITION, origin=Wx::HelpEvent::Origin::Origin_Unknown) end
|
2575
2571
|
|
2576
2572
|
# Returns the origin of the help event which is one of the {Wx::HelpEvent::Origin} values.
|
2577
2573
|
# The application may handle events generated using the keyboard or mouse differently, e.g. by using {get_mouse_position} for the mouse events.
|
2578
2574
|
# @see Wx::HelpEvent#set_origin
|
2579
|
-
# @return [Wx::
|
2575
|
+
# @return [Wx::wxHelpEvent::Origin]
|
2580
2576
|
def get_origin; end
|
2581
2577
|
alias_method :origin, :get_origin
|
2582
2578
|
|
@@ -2589,7 +2585,7 @@ module Wx
|
|
2589
2585
|
# Set the help event origin, only used internally by wxWidgets normally.
|
2590
2586
|
#
|
2591
2587
|
# @see Wx::HelpEvent#get_origin
|
2592
|
-
# @param origin [Wx::
|
2588
|
+
# @param origin [Wx::wxHelpEvent::Origin]
|
2593
2589
|
# @return [void]
|
2594
2590
|
def set_origin(origin) end
|
2595
2591
|
alias_method :origin=, :set_origin
|
@@ -2628,7 +2624,7 @@ module Wx
|
|
2628
2624
|
class ClipboardTextEvent < CommandEvent
|
2629
2625
|
|
2630
2626
|
# Constructor.
|
2631
|
-
# @param commandType [Wx::
|
2627
|
+
# @param commandType [Wx::CommandLinkButton::EventType]
|
2632
2628
|
# @param id [Integer]
|
2633
2629
|
# @return [Wx::ClipboardTextEvent]
|
2634
2630
|
def initialize(commandType=Wx::EVT_NULL, id=0) end
|
@@ -2655,7 +2651,7 @@ module Wx
|
|
2655
2651
|
class ContextMenuEvent < CommandEvent
|
2656
2652
|
|
2657
2653
|
# Constructor.
|
2658
|
-
# @param type [Wx::
|
2654
|
+
# @param type [Wx::CommandLinkButton::EventType]
|
2659
2655
|
# @param id [Integer]
|
2660
2656
|
# @param pos [Array(Integer, Integer), Wx::Point]
|
2661
2657
|
# @return [Wx::ContextMenuEvent]
|