wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/INSTALL.md +30 -8
- data/README.md +3 -3
- data/ext/mkrf_conf_bingem.rb +4 -1
- data/ext/wxbase32u_gcc_custom.dll +0 -0
- data/ext/wxbase32u_net_gcc_custom.dll +0 -0
- data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
- data/lib/wx/accessors.rb +10 -2
- data/lib/wx/aui/auifloatframe.rb +20 -0
- data/lib/wx/aui/auimanager.rb +3 -0
- data/lib/wx/aui/auinotebook.rb +17 -0
- data/lib/wx/aui/events/evt_list.rb +7 -7
- data/lib/wx/aui/require.rb +5 -1
- data/lib/wx/aui.rb +4 -1
- data/lib/wx/core/acceleratortable.rb +8 -0
- data/lib/wx/core/animation.rb +8 -0
- data/lib/wx/core/app.rb +8 -0
- data/lib/wx/core/array_ext.rb +7 -0
- data/lib/wx/core/art_locator.rb +7 -0
- data/lib/wx/core/artprovider.rb +9 -0
- data/lib/wx/core/bitmap.rb +16 -4
- data/lib/wx/core/bitmap_combobox.rb +7 -0
- data/lib/wx/core/brush.rb +7 -0
- data/lib/wx/core/busycursor.rb +9 -0
- data/lib/wx/core/choice.rb +7 -0
- data/lib/wx/core/choicedlg.rb +7 -0
- data/lib/wx/core/clientdc.rb +9 -0
- data/lib/wx/core/clipboard.rb +8 -0
- data/lib/wx/core/collapsible_pane.rb +8 -1
- data/lib/wx/core/colour.rb +8 -0
- data/lib/wx/core/combo_ctrl.rb +110 -0
- data/lib/wx/core/combobox.rb +7 -0
- data/lib/wx/core/config.rb +303 -0
- data/lib/wx/core/controlwithitems.rb +12 -1
- data/lib/wx/core/cursor.rb +14 -4
- data/lib/wx/core/data_object.rb +7 -0
- data/lib/wx/core/dataformat.rb +9 -0
- data/lib/wx/core/datetime.rb +14 -0
- data/lib/wx/core/dc.rb +7 -0
- data/lib/wx/core/dialog.rb +18 -1
- data/lib/wx/core/enum.rb +7 -0
- data/lib/wx/core/event.rb +7 -0
- data/lib/wx/core/event_blocker.rb +7 -0
- data/lib/wx/core/event_loop.rb +14 -0
- data/lib/wx/core/events/evt_list.rb +76 -0
- data/lib/wx/core/evthandler.rb +8 -0
- data/lib/wx/core/ext.rb +7 -0
- data/lib/wx/core/file_dialog.rb +23 -0
- data/lib/wx/core/find_replace_dialog.rb +7 -0
- data/lib/wx/core/functions.rb +8 -0
- data/lib/wx/core/gauge.rb +10 -1
- data/lib/wx/core/genericdirctrl.rb +9 -0
- data/lib/wx/core/hboxsizer.rb +16 -0
- data/lib/wx/core/helpcontroller.rb +8 -0
- data/lib/wx/core/helpcontrollerhelpprovider.rb +9 -0
- data/lib/wx/core/helpprovider.rb +10 -1
- data/lib/wx/core/icon.rb +17 -6
- data/lib/wx/core/id_helper.rb +7 -0
- data/lib/wx/core/image.rb +49 -4
- data/lib/wx/core/imagelist.rb +8 -1
- data/lib/wx/core/listbox.rb +7 -0
- data/lib/wx/core/listctrl.rb +26 -13
- data/lib/wx/core/locale.rb +8 -0
- data/lib/wx/core/log.rb +114 -0
- data/lib/wx/core/menu.rb +9 -0
- data/lib/wx/core/menu_bar.rb +7 -0
- data/lib/wx/core/menuitem.rb +9 -0
- data/lib/wx/core/notebook.rb +9 -0
- data/lib/wx/core/object.rb +9 -0
- data/lib/wx/core/paintdc.rb +7 -0
- data/lib/wx/core/pen.rb +7 -0
- data/lib/wx/core/pen_info.rb +7 -0
- data/lib/wx/core/platform_info.rb +7 -0
- data/lib/wx/core/point.rb +8 -0
- data/lib/wx/core/real_point.rb +8 -0
- data/lib/wx/core/rect.rb +9 -0
- data/lib/wx/core/region_iterator.rb +7 -0
- data/lib/wx/core/simplehelpprovider.rb +9 -0
- data/lib/wx/core/size.rb +8 -0
- data/lib/wx/core/sizer.rb +9 -0
- data/lib/wx/core/splash_screen.rb +22 -2
- data/lib/wx/core/text_entry.rb +7 -0
- data/lib/wx/core/textctrl.rb +86 -5
- data/lib/wx/core/timer.rb +9 -0
- data/lib/wx/core/toolbar.rb +9 -0
- data/lib/wx/core/toolbartool.rb +8 -0
- data/lib/wx/core/treectrl.rb +9 -0
- data/lib/wx/core/v_list_box.rb +7 -0
- data/lib/wx/core/validator.rb +7 -0
- data/lib/wx/core/variant.rb +7 -0
- data/lib/wx/core/vboxsizer.rb +16 -0
- data/lib/wx/core/window.rb +8 -0
- data/lib/wx/core/window_update_locker.rb +9 -0
- data/lib/wx/core/xmlresource.rb +8 -0
- data/lib/wx/core.rb +4 -1
- data/lib/wx/doc/app.rb +7 -1
- data/lib/wx/doc/array_ext.rb +6 -0
- data/lib/wx/doc/art_locator.rb +7 -0
- data/lib/wx/doc/aui/auimanager.rb +6 -0
- data/lib/wx/doc/aui/auinotebook.rb +6 -0
- data/lib/wx/doc/bitmap.rb +19 -15
- data/lib/wx/doc/brush.rb +6 -0
- data/lib/wx/doc/busy_info.rb +6 -0
- data/lib/wx/doc/client_dc.rb +6 -0
- data/lib/wx/doc/clipboard.rb +6 -0
- data/lib/wx/doc/colour_dialog.rb +6 -0
- data/lib/wx/doc/config.rb +190 -0
- data/lib/wx/doc/const.rb +7 -0
- data/lib/wx/doc/controlwithitems.rb +6 -0
- data/lib/wx/doc/core.rb +6 -0
- data/lib/wx/doc/cursor.rb +13 -5
- data/lib/wx/doc/data_object.rb +6 -0
- data/lib/wx/doc/datetime.rb +16 -0
- data/lib/wx/doc/dc.rb +6 -0
- data/lib/wx/doc/enum.rb +8 -1
- data/lib/wx/doc/event.rb +12 -0
- data/lib/wx/doc/event_blocker.rb +6 -0
- data/lib/wx/doc/event_loop.rb +13 -0
- data/lib/wx/doc/events.rb +6 -0
- data/lib/wx/doc/evthandler.rb +8 -0
- data/lib/wx/doc/extra/00_starting.md +6 -6
- data/lib/wx/doc/extra/01_packages.md +52 -51
- data/lib/wx/doc/extra/02_lifecycles.md +9 -8
- data/lib/wx/doc/extra/05_event-handling.md +37 -12
- data/lib/wx/doc/extra/06_geometry.md +5 -5
- data/lib/wx/doc/extra/07_colour_and_font.md +2 -2
- data/lib/wx/doc/extra/09_exceptions.md +2 -2
- data/lib/wx/doc/extra/10_art.md +18 -12
- data/lib/wx/doc/extra/11_drawing_and_dc.md +8 -8
- data/lib/wx/doc/font.rb +7 -1
- data/lib/wx/doc/font_data.rb +16 -0
- data/lib/wx/doc/functions.rb +60 -24
- data/lib/wx/doc/gc_dc.rb +7 -1
- data/lib/wx/doc/gdi_common.rb +8 -1
- data/lib/wx/doc/gen/about_dialog_info.rb +10 -10
- data/lib/wx/doc/gen/accelerator.rb +8 -13
- data/lib/wx/doc/gen/accessible.rb +27 -23
- data/lib/wx/doc/gen/activity_indicator.rb +7 -7
- data/lib/wx/doc/gen/animation.rb +20 -20
- data/lib/wx/doc/gen/animation_ctrl.rb +14 -13
- data/lib/wx/doc/gen/any_button.rb +3 -3
- data/lib/wx/doc/gen/app.rb +25 -88
- data/lib/wx/doc/gen/app_traits.rb +381 -0
- data/lib/wx/doc/gen/art_provider.rb +64 -4
- data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -12
- data/lib/wx/doc/gen/aui/aui_floating_frame.rb +6 -6
- data/lib/wx/doc/gen/aui/aui_manager.rb +57 -41
- data/lib/wx/doc/gen/aui/aui_manager_event.rb +16 -10
- data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +19 -20
- data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +7 -7
- data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +12 -12
- data/lib/wx/doc/gen/aui/aui_notebook.rb +136 -26
- data/lib/wx/doc/gen/aui/aui_notebook_event.rb +17 -2
- data/lib/wx/doc/gen/aui/aui_pane_info.rb +95 -95
- data/lib/wx/doc/gen/aui/aui_tab_art.rb +17 -17
- data/lib/wx/doc/gen/aui/aui_tool_bar.rb +61 -46
- data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +18 -18
- data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +6 -6
- data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +11 -11
- data/lib/wx/doc/gen/aui/event_list.rb +7 -0
- data/lib/wx/doc/gen/banner_window.rb +98 -0
- data/lib/wx/doc/gen/bitmap.rb +56 -81
- data/lib/wx/doc/gen/bitmap_button.rb +13 -9
- data/lib/wx/doc/gen/bitmap_combo_box.rb +14 -9
- data/lib/wx/doc/gen/book_ctrl_base.rb +20 -16
- data/lib/wx/doc/gen/book_ctrl_event.rb +2 -2
- data/lib/wx/doc/gen/box_sizer.rb +1 -1
- data/lib/wx/doc/gen/brush.rb +24 -12
- data/lib/wx/doc/gen/busy_info.rb +1 -1
- data/lib/wx/doc/gen/button.rb +23 -11
- data/lib/wx/doc/gen/calculate_layout_event.rb +2 -1
- data/lib/wx/doc/gen/calendar_ctrl.rb +34 -22
- data/lib/wx/doc/gen/calendar_date_attr.rb +13 -13
- data/lib/wx/doc/gen/calendar_event.rb +4 -10
- data/lib/wx/doc/gen/caret.rb +6 -6
- data/lib/wx/doc/gen/check_box.rb +19 -15
- data/lib/wx/doc/gen/check_list_box.rb +10 -9
- data/lib/wx/doc/gen/choice.rb +10 -9
- data/lib/wx/doc/gen/choicebook.rb +13 -7
- data/lib/wx/doc/gen/client_dc.rb +1 -1
- data/lib/wx/doc/gen/clipboard.rb +10 -10
- data/lib/wx/doc/gen/collapsible_pane.rb +13 -10
- data/lib/wx/doc/gen/collapsible_pane_event.rb +5 -4
- data/lib/wx/doc/gen/colour.rb +42 -32
- data/lib/wx/doc/gen/colour_dialog.rb +12 -12
- data/lib/wx/doc/gen/colour_picker_ctrl.rb +16 -10
- data/lib/wx/doc/gen/colour_picker_event.rb +7 -4
- data/lib/wx/doc/gen/combo_box.rb +29 -20
- data/lib/wx/doc/gen/combo_ctrl.rb +960 -0
- data/lib/wx/doc/gen/command_link_button.rb +110 -0
- data/lib/wx/doc/gen/config_base.rb +10 -0
- data/lib/wx/doc/gen/context_help_button.rb +7 -6
- data/lib/wx/doc/gen/control.rb +12 -9
- data/lib/wx/doc/gen/control_with_items.rb +5 -5
- data/lib/wx/doc/gen/core.rb +8 -5
- data/lib/wx/doc/gen/cursor.rb +18 -18
- data/lib/wx/doc/gen/data_format.rb +5 -5
- data/lib/wx/doc/gen/data_object.rb +32 -25
- data/lib/wx/doc/gen/date_event.rb +3 -3
- data/lib/wx/doc/gen/date_picker_ctrl.rb +16 -11
- data/lib/wx/doc/gen/dc.rb +162 -74
- data/lib/wx/doc/gen/defs.rb +16 -16
- data/lib/wx/doc/gen/dialog.rb +65 -22
- data/lib/wx/doc/gen/dir_dialog.rb +6 -2
- data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +3 -3
- data/lib/wx/doc/gen/dir_picker_ctrl.rb +17 -12
- data/lib/wx/doc/gen/drag_drop.rb +26 -52
- data/lib/wx/doc/gen/drag_image.rb +13 -38
- data/lib/wx/doc/gen/editable_list_box.rb +9 -5
- data/lib/wx/doc/gen/event.rb +55 -32
- data/lib/wx/doc/gen/event_blocker.rb +1 -1
- data/lib/wx/doc/gen/event_filter.rb +5 -2
- data/lib/wx/doc/gen/event_list.rb +117 -19
- data/lib/wx/doc/gen/events.rb +351 -215
- data/lib/wx/doc/gen/evt_handler.rb +8 -8
- data/lib/wx/doc/gen/ext_help_controller.rb +9 -9
- data/lib/wx/doc/gen/file_dialog.rb +20 -9
- data/lib/wx/doc/gen/file_dialog_custom_control.rb +146 -0
- data/lib/wx/doc/gen/file_dialog_customize_hook.rb +159 -0
- data/lib/wx/doc/gen/file_dir_picker_event.rb +5 -3
- data/lib/wx/doc/gen/file_picker_ctrl.rb +19 -11
- data/lib/wx/doc/gen/file_system.rb +250 -0
- data/lib/wx/doc/gen/find_dialog_event.rb +7 -2
- data/lib/wx/doc/gen/find_replace_data.rb +1 -1
- data/lib/wx/doc/gen/find_replace_dialog.rb +2 -2
- data/lib/wx/doc/gen/flex_grid_sizer.rb +16 -10
- data/lib/wx/doc/gen/font.rb +90 -94
- data/lib/wx/doc/gen/font_data.rb +15 -11
- data/lib/wx/doc/gen/font_dialog.rb +5 -5
- data/lib/wx/doc/gen/font_picker_ctrl.rb +11 -7
- data/lib/wx/doc/gen/font_picker_event.rb +2 -1
- data/lib/wx/doc/gen/frame.rb +36 -27
- data/lib/wx/doc/gen/fs_file.rb +65 -38
- data/lib/wx/doc/gen/gauge.rb +14 -10
- data/lib/wx/doc/gen/gb_sizer_item.rb +12 -26
- data/lib/wx/doc/gen/gcdc.rb +5 -1
- data/lib/wx/doc/gen/gdi_common.rb +43 -41
- data/lib/wx/doc/gen/gdi_object.rb +1 -1
- data/lib/wx/doc/gen/generic_dir_ctrl.rb +19 -13
- data/lib/wx/doc/gen/graphics_context.rb +320 -88
- data/lib/wx/doc/gen/graphics_object.rb +48 -102
- data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +4 -2
- data/lib/wx/doc/gen/grid/grid_cell_attr.rb +41 -56
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +4 -2
- data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +7 -12
- data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_editor.rb +19 -14
- data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +15 -13
- data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +3 -1
- data/lib/wx/doc/gen/grid/grid_ctrl.rb +446 -189
- data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +5 -3
- data/lib/wx/doc/gen/grid/grid_event.rb +26 -9
- data/lib/wx/doc/gen/grid/grid_range_select_event.rb +15 -11
- data/lib/wx/doc/gen/grid/grid_size_event.rb +13 -7
- data/lib/wx/doc/gen/grid/grid_string_table.rb +8 -8
- data/lib/wx/doc/gen/grid/grid_table_base.rb +21 -21
- data/lib/wx/doc/gen/grid/grid_table_message.rb +5 -5
- data/lib/wx/doc/gen/grid_bag_sizer.rb +15 -15
- data/lib/wx/doc/gen/grid_sizer.rb +4 -4
- data/lib/wx/doc/gen/gui_event_loop.rb +132 -0
- data/lib/wx/doc/gen/header_ctrl.rb +755 -0
- data/lib/wx/doc/gen/header_ctrl_event.rb +131 -0
- data/lib/wx/doc/gen/help_controller.rb +25 -19
- data/lib/wx/doc/gen/help_provider.rb +3 -3
- data/lib/wx/doc/gen/html/html_cell.rb +100 -59
- data/lib/wx/doc/gen/html/html_cell_event.rb +7 -5
- data/lib/wx/doc/gen/html/html_easy_printing.rb +14 -9
- data/lib/wx/doc/gen/html/html_help_controller.rb +60 -46
- data/lib/wx/doc/gen/html/html_help_data.rb +5 -5
- data/lib/wx/doc/gen/html/html_help_window.rb +33 -35
- data/lib/wx/doc/gen/html/html_link_event.rb +4 -3
- data/lib/wx/doc/gen/html/html_list_box.rb +21 -13
- data/lib/wx/doc/gen/html/html_printout.rb +16 -6
- data/lib/wx/doc/gen/html/html_window.rb +54 -39
- data/lib/wx/doc/gen/hyperlink_ctrl.rb +15 -10
- data/lib/wx/doc/gen/hyperlink_event.rb +2 -1
- data/lib/wx/doc/gen/icon.rb +24 -24
- data/lib/wx/doc/gen/icon_location.rb +1 -1
- data/lib/wx/doc/gen/image.rb +164 -114
- data/lib/wx/doc/gen/image_list.rb +24 -30
- data/lib/wx/doc/gen/info_bar.rb +152 -0
- data/lib/wx/doc/gen/keyboard_state.rb +24 -24
- data/lib/wx/doc/gen/list_box.rb +40 -31
- data/lib/wx/doc/gen/list_ctrl.rb +223 -167
- data/lib/wx/doc/gen/list_event.rb +25 -3
- data/lib/wx/doc/gen/listbook.rb +13 -7
- data/lib/wx/doc/gen/locale.rb +22 -71
- data/lib/wx/doc/gen/log.rb +133 -106
- data/lib/wx/doc/gen/mdi_client_window.rb +3 -3
- data/lib/wx/doc/gen/mdi_frame.rb +23 -17
- data/lib/wx/doc/gen/media_ctrl.rb +22 -19
- data/lib/wx/doc/gen/media_event.rb +8 -2
- data/lib/wx/doc/gen/memory_dc.rb +26 -33
- data/lib/wx/doc/gen/menu.rb +24 -25
- data/lib/wx/doc/gen/menu_bar.rb +11 -28
- data/lib/wx/doc/gen/menu_item.rb +127 -46
- data/lib/wx/doc/gen/message_dialog.rb +54 -36
- data/lib/wx/doc/gen/mini_frame.rb +14 -5
- data/lib/wx/doc/gen/mouse_state.rb +51 -11
- data/lib/wx/doc/gen/multi_choice_dialog.rb +4 -2
- data/lib/wx/doc/gen/non_owned_window.rb +8 -9
- data/lib/wx/doc/gen/notebook.rb +27 -22
- data/lib/wx/doc/gen/number_entry_dialog.rb +3 -3
- data/lib/wx/doc/gen/object.rb +3 -14
- data/lib/wx/doc/gen/palette.rb +15 -17
- data/lib/wx/doc/gen/panel.rb +8 -7
- data/lib/wx/doc/gen/pen.rb +50 -37
- data/lib/wx/doc/gen/pg/numeric_property_validator.rb +3 -3
- data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +17 -17
- data/lib/wx/doc/gen/pg/pg_cell.rb +13 -16
- data/lib/wx/doc/gen/pg/pg_editor.rb +95 -93
- data/lib/wx/doc/gen/pg/pg_multi_button.rb +64 -89
- data/lib/wx/doc/gen/pg/pg_properties.rb +379 -349
- data/lib/wx/doc/gen/pg/pg_property.rb +260 -307
- data/lib/wx/doc/gen/pg/pg_validation_info.rb +3 -3
- data/lib/wx/doc/gen/pg/property_grid.rb +49 -49
- data/lib/wx/doc/gen/pg/property_grid_event.rb +24 -11
- data/lib/wx/doc/gen/pg/property_grid_interface.rb +75 -69
- data/lib/wx/doc/gen/pg/property_grid_manager.rb +51 -54
- data/lib/wx/doc/gen/pg/property_grid_page.rb +22 -30
- data/lib/wx/doc/gen/pg/property_grid_page_state.rb +17 -26
- data/lib/wx/doc/gen/picker_base.rb +17 -16
- data/lib/wx/doc/gen/platform_info.rb +180 -20
- data/lib/wx/doc/gen/popup_window.rb +8 -8
- data/lib/wx/doc/gen/progress_dialog.rb +3 -3
- data/lib/wx/doc/gen/property_sheet_dialog.rb +20 -18
- data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -2
- data/lib/wx/doc/gen/prt/preview_frame.rb +18 -2
- data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -1
- data/lib/wx/doc/gen/prt/print_data.rb +68 -62
- data/lib/wx/doc/gen/prt/print_dialog.rb +4 -4
- data/lib/wx/doc/gen/prt/printer.rb +44 -49
- data/lib/wx/doc/gen/query_layout_info_event.rb +6 -5
- data/lib/wx/doc/gen/radio_box.rb +21 -19
- data/lib/wx/doc/gen/radio_button.rb +13 -11
- data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +67 -67
- data/lib/wx/doc/gen/rbn/ribbon_bar.rb +38 -20
- data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +5 -5
- data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +22 -15
- data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +6 -6
- data/lib/wx/doc/gen/rbn/ribbon_control.rb +11 -11
- data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +14 -16
- data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +5 -5
- data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -12
- data/lib/wx/doc/gen/rbn/ribbon_panel.rb +24 -22
- data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +5 -5
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +17 -15
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +6 -6
- data/lib/wx/doc/gen/rearrange_ctrl.rb +60 -0
- data/lib/wx/doc/gen/rearrange_list.rb +99 -0
- data/lib/wx/doc/gen/region.rb +35 -43
- data/lib/wx/doc/gen/region_iterator.rb +3 -3
- data/lib/wx/doc/gen/rtc/rich_text_box.rb +423 -0
- data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +626 -1538
- data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +37 -0
- data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +525 -0
- data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +488 -503
- data/lib/wx/doc/gen/rtc/rich_text_event.rb +31 -12
- data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +18 -18
- data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +282 -0
- data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +23 -19
- data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +9 -18
- data/lib/wx/doc/gen/rtc/rich_text_image.rb +328 -0
- data/lib/wx/doc/gen/rtc/rich_text_object.rb +2849 -0
- data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1174 -0
- data/lib/wx/doc/gen/rtc/rich_text_printing.rb +29 -29
- data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +305 -0
- data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +183 -0
- data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +3 -3
- data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +34 -37
- data/lib/wx/doc/gen/sash_event.rb +8 -6
- data/lib/wx/doc/gen/sash_layout_window.rb +13 -11
- data/lib/wx/doc/gen/sash_window.rb +14 -9
- data/lib/wx/doc/gen/scroll_bar.rb +33 -12
- data/lib/wx/doc/gen/scrolled_canvas.rb +49 -37
- data/lib/wx/doc/gen/scrolled_control.rb +49 -37
- data/lib/wx/doc/gen/scrolled_window.rb +49 -37
- data/lib/wx/doc/gen/search_ctrl.rb +20 -13
- data/lib/wx/doc/gen/simplebook.rb +7 -7
- data/lib/wx/doc/gen/single_choice_dialog.rb +5 -4
- data/lib/wx/doc/gen/sizer.rb +69 -73
- data/lib/wx/doc/gen/sizer_item.rb +5 -5
- data/lib/wx/doc/gen/slider.rb +51 -18
- data/lib/wx/doc/gen/spin_button.rb +17 -11
- data/lib/wx/doc/gen/spin_ctrl.rb +15 -9
- data/lib/wx/doc/gen/spin_ctrl_double.rb +146 -0
- data/lib/wx/doc/gen/spin_double_event.rb +53 -0
- data/lib/wx/doc/gen/spin_event.rb +5 -2
- data/lib/wx/doc/gen/splash_screen.rb +16 -12
- data/lib/wx/doc/gen/splitter_event.rb +6 -2
- data/lib/wx/doc/gen/splitter_window.rb +36 -16
- data/lib/wx/doc/gen/static_bitmap.rb +9 -9
- data/lib/wx/doc/gen/static_box.rb +41 -37
- data/lib/wx/doc/gen/static_box_sizer.rb +13 -10
- data/lib/wx/doc/gen/static_line.rb +8 -7
- data/lib/wx/doc/gen/static_text.rb +15 -9
- data/lib/wx/doc/gen/status_bar.rb +53 -10
- data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +200 -184
- data/lib/wx/doc/gen/stc/styled_text_event.rb +229 -54
- data/lib/wx/doc/gen/std_dialog_button_sizer.rb +11 -2
- data/lib/wx/doc/gen/svg_file_dc.rb +8 -8
- data/lib/wx/doc/gen/system_options.rb +13 -3
- data/lib/wx/doc/gen/system_settings.rb +9 -9
- data/lib/wx/doc/gen/task_bar_icon.rb +17 -9
- data/lib/wx/doc/gen/task_bar_icon_event.rb +3 -3
- data/lib/wx/doc/gen/text_attr.rb +67 -61
- data/lib/wx/doc/gen/text_ctrl.rb +58 -113
- data/lib/wx/doc/gen/text_entry.rb +44 -56
- data/lib/wx/doc/gen/text_entry_dialog.rb +23 -23
- data/lib/wx/doc/gen/text_validator.rb +3 -19
- data/lib/wx/doc/gen/time_picker_ctrl.rb +11 -10
- data/lib/wx/doc/gen/timer.rb +13 -9
- data/lib/wx/doc/gen/timer_event.rb +19 -26
- data/lib/wx/doc/gen/tip_provider.rb +3 -3
- data/lib/wx/doc/gen/toggle_button.rb +10 -9
- data/lib/wx/doc/gen/tool_bar.rb +71 -61
- data/lib/wx/doc/gen/tool_tip.rb +2 -10
- data/lib/wx/doc/gen/toolbook.rb +12 -9
- data/lib/wx/doc/gen/top_level_window.rb +53 -113
- data/lib/wx/doc/gen/tree_ctrl.rb +83 -33
- data/lib/wx/doc/gen/tree_event.rb +24 -3
- data/lib/wx/doc/gen/treebook.rb +20 -16
- data/lib/wx/doc/gen/ui_action_simulator.rb +20 -19
- data/lib/wx/doc/gen/utils.rb +20 -14
- data/lib/wx/doc/gen/v_list_box.rb +11 -11
- data/lib/wx/doc/gen/v_scrolled_window.rb +9 -9
- data/lib/wx/doc/gen/validator.rb +10 -8
- data/lib/wx/doc/gen/variant.rb +56 -119
- data/lib/wx/doc/gen/window.rb +314 -224
- data/lib/wx/doc/gen/window_dc.rb +1 -1
- data/lib/wx/doc/gen/with_images.rb +2 -2
- data/lib/wx/doc/gen/wizard.rb +21 -8
- data/lib/wx/doc/gen/wizard_event.rb +11 -4
- data/lib/wx/doc/gen/wizard_page.rb +3 -3
- data/lib/wx/doc/gen/wizard_page_simple.rb +8 -8
- data/lib/wx/doc/gen/wrap_sizer.rb +65 -0
- data/lib/wx/doc/gen/xml_node.rb +13 -13
- data/lib/wx/doc/gen/xml_resource.rb +24 -21
- data/lib/wx/doc/graphics_context.rb +59 -39
- data/lib/wx/doc/grid/grid.rb +16 -1
- data/lib/wx/doc/hboxsizer.rb +33 -0
- data/lib/wx/doc/help_controller.rb +6 -0
- data/lib/wx/doc/html/html_help_controller.rb +6 -0
- data/lib/wx/doc/icon.rb +13 -5
- data/lib/wx/doc/id_helper.rb +6 -0
- data/lib/wx/doc/image.rb +50 -12
- data/lib/wx/doc/list_ctrl.rb +38 -0
- data/lib/wx/doc/log.rb +45 -0
- data/lib/wx/doc/memory_dc.rb +6 -0
- data/lib/wx/doc/mirror_dc.rb +6 -0
- data/lib/wx/doc/pen.rb +6 -0
- data/lib/wx/doc/pg/events.rb +6 -0
- data/lib/wx/doc/pg/pg_property.rb +17 -0
- data/lib/wx/doc/pg/pgeditor.rb +6 -0
- data/lib/wx/doc/pg/property_grid.rb +6 -0
- data/lib/wx/doc/pg/property_grid_interface.rb +6 -0
- data/lib/wx/doc/progress_dialog.rb +6 -0
- data/lib/wx/doc/prt/page_setup_dialog.rb +6 -0
- data/lib/wx/doc/prt/print_data.rb +6 -0
- data/lib/wx/doc/prt/print_dialog.rb +6 -0
- data/lib/wx/doc/prt/printer.rb +6 -0
- data/lib/wx/doc/prt/printer_dc.rb +8 -2
- data/lib/wx/doc/radio_box.rb +6 -0
- data/lib/wx/doc/rbn/ribbon_bar.rb +6 -0
- data/lib/wx/doc/rbn/ribbon_button_bar.rb +6 -0
- data/lib/wx/doc/rbn/ribbon_gallery.rb +6 -0
- data/lib/wx/doc/rbn/ribbon_tool_bar.rb +6 -0
- data/lib/wx/doc/region_iterator.rb +6 -0
- data/lib/wx/doc/rtc/richtext_buffer.rb +28 -0
- data/lib/wx/doc/rtc/richtext_formatting_dialog.rb +68 -0
- data/lib/wx/doc/rtc/richtext_printing.rb +6 -0
- data/lib/wx/doc/rtc/richtext_style_sheet.rb +20 -0
- data/lib/wx/doc/scaled_dc.rb +7 -1
- data/lib/wx/doc/screen_dc.rb +6 -0
- data/lib/wx/doc/stock_objects.rb +6 -0
- data/lib/wx/doc/stream.rb +6 -0
- data/lib/wx/doc/svg_file_dc.rb +6 -0
- data/lib/wx/doc/system_settings.rb +6 -0
- data/lib/wx/doc/text_validator.rb +18 -0
- data/lib/wx/doc/textctrl.rb +89 -0
- data/lib/wx/doc/tree_event.rb +20 -0
- data/lib/wx/doc/treebook.rb +6 -0
- data/lib/wx/doc/v_list_box.rb +6 -0
- data/lib/wx/doc/variant.rb +6 -0
- data/lib/wx/doc/vboxsizer.rb +33 -0
- data/lib/wx/doc/window.rb +6 -0
- data/lib/wx/doc/window_disabler.rb +6 -0
- data/lib/wx/doc/xml_resource.rb +8 -0
- data/lib/wx/global_const.rb +4 -1
- data/lib/wx/grid/grid.rb +23 -3
- data/lib/wx/grid/keyword_defs.rb +8 -1
- data/lib/wx/grid/require.rb +4 -1
- data/lib/wx/grid.rb +4 -1
- data/lib/wx/helpers.rb +8 -1
- data/lib/wx/html/htmlhelpcontroller.rb +29 -3
- data/lib/wx/html/htmlwindow.rb +23 -12
- data/lib/wx/html/keyword_defs.rb +8 -1
- data/lib/wx/html/require.rb +4 -1
- data/lib/wx/html/simple_html_listbox.rb +3 -0
- data/lib/wx/html.rb +4 -1
- data/lib/wx/keyword_ctors.rb +22 -3
- data/lib/wx/keyword_defs.rb +55 -3
- data/lib/wx/pg/events.rb +4 -1
- data/lib/wx/pg/keyword_defs.rb +8 -1
- data/lib/wx/pg/pg_editor.rb +3 -0
- data/lib/wx/pg/pg_properties.rb +4 -1
- data/lib/wx/pg/pg_property.rb +18 -5
- data/lib/wx/pg/property_grid.rb +4 -1
- data/lib/wx/pg/property_grid_interface.rb +3 -0
- data/lib/wx/pg/require.rb +4 -1
- data/lib/wx/pg.rb +4 -1
- data/lib/wx/prt/keyword_defs.rb +8 -1
- data/lib/wx/prt/page_setup_dialog.rb +3 -0
- data/lib/wx/prt/previewframe.rb +5 -0
- data/lib/wx/prt/require.rb +4 -1
- data/lib/wx/prt.rb +4 -1
- data/lib/wx/rbn/events.rb +4 -1
- data/lib/wx/rbn/keyword_defs.rb +8 -1
- data/lib/wx/rbn/require.rb +5 -1
- data/lib/wx/rbn/ribbon_art_provider.rb +3 -1
- data/lib/wx/rbn/ribbon_bar.rb +3 -0
- data/lib/wx/rbn/ribbon_button_bar.rb +3 -0
- data/lib/wx/rbn/ribbon_control.rb +3 -0
- data/lib/wx/rbn/ribbon_gallery.rb +10 -0
- data/lib/wx/rbn/ribbon_page.rb +3 -0
- data/lib/wx/rbn/ribbon_panel.rb +3 -0
- data/lib/wx/rbn/ribbon_tool_bar.rb +3 -0
- data/lib/wx/rbn.rb +4 -1
- data/lib/wx/rtc/ext.rb +4 -1
- data/lib/wx/rtc/keyword_defs.rb +18 -7
- data/lib/wx/rtc/require.rb +8 -1
- data/lib/wx/rtc/richtext_buffer.rb +36 -0
- data/lib/wx/rtc/richtext_formatting_dialog.rb +88 -0
- data/lib/wx/rtc/richtext_style_organiser_dialog.rb +46 -0
- data/lib/wx/rtc/symbol_picker_dialog.rb +47 -0
- data/lib/wx/rtc.rb +5 -1
- data/lib/wx/stc/keyword_defs.rb +8 -1
- data/lib/wx/stc/require.rb +4 -1
- data/lib/wx/stc.rb +4 -1
- data/lib/wx/version.rb +5 -1
- data/lib/wx/wxruby/base.rb +4 -1
- data/lib/wx/wxruby/cmd/sampler.rb +4 -1
- data/lib/wx/wxruby/cmd/test.rb +4 -1
- data/lib/wx.rb +4 -1
- data/lib/wxruby_aui.so +0 -0
- data/lib/wxruby_core.so +0 -0
- data/lib/wxruby_grid.so +0 -0
- data/lib/wxruby_html.so +0 -0
- data/lib/wxruby_pg.so +0 -0
- data/lib/wxruby_prt.so +0 -0
- data/lib/wxruby_rbn.so +0 -0
- data/lib/wxruby_rtc.so +0 -0
- data/lib/wxruby_stc.so +0 -0
- data/rakelib/install.rb +4 -1
- data/rakelib/lib/config/cygwin.rb +4 -1
- data/rakelib/lib/config/linux.rb +4 -1
- data/rakelib/lib/config/macosx.rb +5 -2
- data/rakelib/lib/config/mingw.rb +4 -1
- data/rakelib/lib/config/netbsd.rb +4 -1
- data/rakelib/lib/config/unixish.rb +10 -7
- data/rakelib/lib/config.rb +7 -2
- data/rakelib/lib/ext/enum_chain.rb +4 -1
- data/rakelib/prepost.rake +4 -1
- data/rakelib/prepost.rb +4 -1
- data/samples/aui/aui.rb +8 -3
- data/samples/bigdemo/bigdemo.rb +9 -2
- data/samples/bigdemo/run.rb +9 -2
- data/samples/bigdemo/utils.rb +9 -1
- data/samples/calendar/calendar.rb +9 -4
- data/samples/caret/caret.rb +8 -3
- data/samples/controls/books.rb +8 -2
- data/samples/controls/controls.rb +33 -77
- data/samples/controls/get_item_sample.rb +8 -2
- data/samples/controls/htlbox.rb +10 -3
- data/samples/dialogs/dialogs.rb +9 -4
- data/samples/dialogs/wizard.rb +8 -3
- data/samples/dragdrop/dragdrop.rb +8 -3
- data/samples/drawing/bitmap.rb +8 -3
- data/samples/drawing/bitmap_image.rb +8 -3
- data/samples/drawing/graphics_drawing.rb +44 -33
- data/samples/drawing/image_prt.rb +8 -2
- data/samples/drawing/maths_images.rb +8 -3
- data/samples/drawing/rmagic_bitmap_image.rb +8 -3
- data/samples/etc/choice.rb +8 -3
- data/samples/etc/miniframe.rb +8 -3
- data/samples/etc/sash.rb +8 -3
- data/samples/etc/scrollwin.rb +8 -3
- data/samples/etc/system_settings.rb +8 -3
- data/samples/event/activation.rb +8 -3
- data/samples/event/event.rb +8 -3
- data/samples/event/threaded.rb +8 -3
- data/samples/event/update_ui_event.rb +8 -3
- data/samples/grid/grid.rb +9 -3
- data/samples/grid/gridtablebase.rb +8 -3
- data/samples/html/html.rb +8 -3
- data/samples/mdi/mdi.rb +8 -3
- data/samples/minimal/minimal.rb +8 -3
- data/samples/minimal/nothing.rb +8 -3
- data/samples/printing/printing.rb +8 -3
- data/samples/printing/printing2.rb +8 -2
- data/samples/propgrid/propgrid.rb +4 -1
- data/samples/propgrid/propgrid_minimal.rb +4 -2
- data/samples/propgrid/sample_props.rb +4 -1
- data/samples/ribbon/ribbon.rb +4 -1
- data/samples/sampler/editor.rb +4 -1
- data/samples/sampler/ext.rb +4 -1
- data/samples/sampler/sample.rb +13 -4
- data/samples/sampler/stc_editor.rb +4 -1
- data/samples/sampler/txt_editor.rb +4 -1
- data/samples/sampler.rb +11 -3
- data/samples/splash/splash.rb +4 -2
- data/samples/text/art/richtext/alignleft.xpm +24 -0
- data/samples/text/art/richtext/alignright.xpm +24 -0
- data/samples/text/art/richtext/bold.xpm +24 -0
- data/samples/text/art/richtext/centre.xpm +24 -0
- data/samples/text/art/richtext/copy.xpm +45 -0
- data/samples/text/art/richtext/cut.xpm +47 -0
- data/samples/text/art/richtext/font.xpm +25 -0
- data/samples/text/art/richtext/idea.xpm +47 -0
- data/samples/text/art/richtext/indentless.xpm +25 -0
- data/samples/text/art/richtext/indentmore.xpm +25 -0
- data/samples/text/art/richtext/italic.xpm +25 -0
- data/samples/text/art/richtext/open.xpm +58 -0
- data/samples/text/art/richtext/paste.xpm +47 -0
- data/samples/text/art/richtext/redo.xpm +59 -0
- data/samples/text/art/richtext/save.xpm +43 -0
- data/samples/text/art/richtext/smiley.xpm +42 -0
- data/samples/text/art/richtext/underline.xpm +25 -0
- data/samples/text/art/richtext/undo.xpm +59 -0
- data/samples/text/art/richtext/zebra.xpm +409 -0
- data/samples/text/rich_textctrl.rb +8 -3
- data/samples/text/richtext.rb +1824 -0
- data/samples/text/scintilla.rb +8 -3
- data/samples/text/textctrl.rb +21 -4
- data/samples/text/tn_richtext.png +0 -0
- data/samples/text/unicode.rb +9 -4
- data/samples/treectrl/treectrl.rb +10 -5
- data/samples/xrc/custom_xrc_sample.rb +8 -3
- data/samples/xrc/xrc_sample.rb +8 -3
- data/tests/art/test_art/bitmap/wxruby-128x128.png +0 -0
- data/tests/art/test_art/bitmap/wxruby-256x256.png +0 -0
- data/tests/art/test_art/bitmap/wxruby-64x64.png +0 -0
- data/tests/lib/item_container_tests.rb +3 -0
- data/tests/lib/text_entry_tests.rb +3 -0
- data/tests/lib/wxapp_runner.rb +3 -0
- data/tests/lib/wxframe_runner.rb +81 -3
- data/tests/test_app_event_filter.rb +3 -0
- data/tests/test_app_traits.rb +33 -0
- data/tests/test_art.rb +31 -0
- data/tests/test_art_provider.rb +3 -0
- data/tests/test_aui.rb +65 -0
- data/tests/test_basic.rb +5 -1
- data/tests/test_box_sizer.rb +164 -0
- data/tests/test_clipboard.rb +3 -0
- data/tests/test_config.rb +150 -0
- data/tests/test_dc.rb +3 -0
- data/tests/test_dialog.rb +3 -0
- data/tests/test_event_handling.rb +3 -0
- data/tests/test_events.rb +3 -0
- data/tests/test_ext_controls.rb +286 -3
- data/tests/test_file_dialog.rb +55 -0
- data/tests/test_font.rb +8 -5
- data/tests/test_gdi_object.rb +3 -0
- data/tests/test_geometry.rb +4 -0
- data/tests/test_grid_sizer.rb +151 -0
- data/tests/test_intl.rb +3 -0
- data/tests/test_item_data.rb +3 -0
- data/tests/test_list_ctrl.rb +56 -0
- data/tests/test_log.rb +226 -0
- data/tests/test_proof_check.rb +52 -0
- data/tests/test_richtext.rb +204 -0
- data/tests/test_std_controls.rb +99 -31
- data/tests/test_timer.rb +98 -0
- data/tests/test_variant.rb +3 -0
- data/tests/test_window.rb +10 -8
- data/tests/testapp.rb +4 -0
- data/tests/testapp_noframe.rb +4 -0
- metadata +87 -3
- data/lib/wx/doc/gen/html/html_help_frame.rb +0 -112
data/lib/wx/doc/gen/window.rb
CHANGED
@@ -154,62 +154,105 @@ module Wx
|
|
154
154
|
# === Styles
|
155
155
|
#
|
156
156
|
# This class supports the following styles:
|
157
|
-
#
|
157
|
+
#
|
158
158
|
# - {Wx::Border::BORDER_DEFAULT}: The window class will decide the kind of border to show, if any.
|
159
|
+
#
|
159
160
|
# - {Wx::Border::BORDER_SIMPLE}: Displays a thin border around the window. {Wx::SIMPLE_BORDER} is the old name for this style.
|
161
|
+
#
|
160
162
|
# - {Wx::Border::BORDER_SUNKEN}: Displays a sunken border. {Wx::SUNKEN_BORDER} is the old name for this style.
|
163
|
+
#
|
161
164
|
# - {Wx::Border::BORDER_RAISED}: Displays a raised border. {Wx::RAISED_BORDER} is the old name for this style.
|
165
|
+
#
|
162
166
|
# - {Wx::Border::BORDER_STATIC}: Displays a border suitable for a static control. {Wx::STATIC_BORDER} is the old name for this style. Windows only.
|
167
|
+
#
|
163
168
|
# - {Wx::Border::BORDER_THEME}: Displays a native border suitable for a control, on the current platform. On Windows, this will be a themed border; on most other platforms a sunken border will be used. For more information for themed borders on Windows, please see Themed borders on Windows.
|
169
|
+
#
|
164
170
|
# - {Wx::Border::BORDER_NONE}: Displays no border, overriding the default border style for the window. {Wx::NO_BORDER} is the old name for this style.
|
171
|
+
#
|
165
172
|
# - {Wx::Border::BORDER_DOUBLE}: This style is obsolete and should not be used.
|
173
|
+
#
|
166
174
|
# - {Wx::TRANSPARENT_WINDOW}: The window is transparent, that is, it will not receive paint events. Windows only.
|
175
|
+
#
|
167
176
|
# - {Wx::TAB_TRAVERSAL}: This style is used by wxWidgets for the windows supporting TAB navigation among their children, such as {Wx::Dialog} and {Wx::Panel}. It should almost never be used in the application code.
|
177
|
+
#
|
168
178
|
# - {Wx::WANTS_CHARS}: Use this to indicate that the window wants to get all char/key events for all keys - even for keys like TAB or ENTER which are usually used for dialog navigation and which wouldn't be generated without this style. If you need to use this style in order to get the arrows or etc., but would still like to have normal keyboard navigation take place, you should call Navigate in response to the key events for Tab and Shift-Tab.
|
179
|
+
#
|
169
180
|
# - {Wx::NO_FULL_REPAINT_ON_RESIZE}: On Windows, this style used to disable repainting the window completely when its size is changed. Since this behaviour is now the default, the style is now obsolete and no longer has an effect.
|
181
|
+
#
|
170
182
|
# - {Wx::VSCROLL}: Use this style to enable a vertical scrollbar. Notice that this style cannot be used with native controls which don't support scrollbars nor with top-level windows in most ports.
|
183
|
+
#
|
171
184
|
# - {Wx::HSCROLL}: Use this style to enable a horizontal scrollbar. The same limitations as for {Wx::VSCROLL} apply to this style.
|
172
|
-
#
|
185
|
+
#
|
186
|
+
# - {Wx::ALWAYS_SHOW_SB}: If a window has scrollbars, disable them instead of hiding them when they are not needed (i.e. when the size of the window is big enough to not require the scrollbars to navigate it). This style is currently implemented for wxMSW, wxGTK and {Wx::Universal} and does nothing on the other platforms.
|
187
|
+
#
|
173
188
|
# - {Wx::CLIP_CHILDREN}: Use this style to eliminate flicker caused by the background being repainted, then children being painted over them. Windows only.
|
189
|
+
#
|
174
190
|
# - {Wx::FULL_REPAINT_ON_RESIZE}: Use this style to force a complete redraw of the window whenever it is resized instead of redrawing just the part of the window affected by resizing. Note that this was the behaviour by default before 2.5.1 release and that if you experience redraw problems with code which previously used to work you may want to try this. Currently this style applies on GTK+ 2 and Windows only, and full repainting is always done on other platforms.
|
175
191
|
#
|
176
192
|
# === Extra Styles
|
177
193
|
#
|
178
194
|
# This class supports the following extra styles:
|
179
|
-
#
|
195
|
+
#
|
180
196
|
# - {Wx::WS_EX_BLOCK_EVENTS}: {Wx::CommandEvents} and the objects of the derived classes are forwarded to the parent window and so on recursively by default. Using this flag for the given window allows blocking this propagation at this window, i.e. prevent the events from being propagated further upwards. Dialogs have this flag on by default for the reasons explained in the Events and Event Handling.
|
197
|
+
#
|
181
198
|
# - {Wx::WS_EX_TRANSIENT}: Don't use this window as an implicit parent for the other windows: this must be used with transient windows as otherwise there is the risk of creating a dialog/frame with this window as a parent, which would lead to a crash if the parent were destroyed before the child.
|
199
|
+
#
|
182
200
|
# - {Wx::WS_EX_CONTEXTHELP}: Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a {Wx::EVT_HELP} event if the user clicked on an application window. This style cannot be used (because of the underlying native behaviour) together with {Wx::MAXIMIZE_BOX} or {Wx::MINIMIZE_BOX}, so these two styles are automatically turned off if this one is used.
|
201
|
+
#
|
183
202
|
# - {Wx::WS_EX_PROCESS_IDLE}: This window should always process idle events, even if the mode set by {Wx::IdleEvent.set_mode} is {Wx::IdleMode::IDLE_PROCESS_SPECIFIED}.
|
203
|
+
#
|
184
204
|
# - {Wx::WS_EX_PROCESS_UI_UPDATES}: This window should always process UI update events, even if the mode set by {Wx::UpdateUIEvent.set_mode} is {Wx::UpdateUIMode::UPDATE_UI_PROCESS_SPECIFIED}.
|
185
205
|
#
|
186
206
|
# === Events emitted by this class
|
187
207
|
#
|
188
208
|
# Event handler methods for events emitted by this class:
|
189
|
-
#
|
209
|
+
#
|
190
210
|
# - {Wx::EvtHandler#EVT_ACTIVATE}(meth = nil, &block): Process a {Wx::EVT_ACTIVATE} event. See {Wx::ActivateEvent}.
|
211
|
+
#
|
191
212
|
# - {Wx::EvtHandler#evt_child_focus}(meth = nil, &block): Process a {Wx::EVT_CHILD_FOCUS} event. See {Wx::ChildFocusEvent}.
|
213
|
+
#
|
192
214
|
# - {Wx::EvtHandler#evt_context_menu}(meth = nil, &block): A right click (or other context menu command depending on platform) has been detected. See {Wx::ContextMenuEvent}.
|
215
|
+
#
|
193
216
|
# - {Wx::EvtHandler#evt_help}(id, meth = nil, &block): Process a {Wx::EVT_HELP} event. See {Wx::HelpEvent}.
|
217
|
+
#
|
194
218
|
# - {Wx::EvtHandler#evt_help_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_HELP} event for a range of ids. See {Wx::HelpEvent}.
|
219
|
+
#
|
195
220
|
# - {Wx::EvtHandler#evt_drop_files}(meth = nil, &block): Process a {Wx::EVT_DROP_FILES} event. See {Wx::DropFilesEvent}.
|
221
|
+
#
|
196
222
|
# - {Wx::EvtHandler#evt_erase_background}(meth = nil, &block): Process a {Wx::EVT_ERASE_BACKGROUND} event. See {Wx::EraseEvent}.
|
223
|
+
#
|
197
224
|
# - {Wx::EvtHandler#evt_set_focus}(meth = nil, &block): Process a {Wx::EVT_SET_FOCUS} event. See {Wx::FocusEvent}.
|
225
|
+
#
|
198
226
|
# - {Wx::EvtHandler#evt_kill_focus}(meth = nil, &block): Process a {Wx::EVT_KILL_FOCUS} event. See {Wx::FocusEvent}.
|
227
|
+
#
|
199
228
|
# - {Wx::EvtHandler#evt_idle}(meth = nil, &block): Process a {Wx::EVT_IDLE} event. See {Wx::IdleEvent}.
|
229
|
+
#
|
200
230
|
# - {Wx::EvtHandler}evt_joy_*(meth = nil, &block): Processes joystick events. See {Wx::JoystickEvent}.
|
231
|
+
#
|
201
232
|
# - {Wx::EvtHandler#evt_key_down}(meth = nil, &block): Process a {Wx::EVT_KEY_DOWN} event (any key has been pressed). See {Wx::KeyEvent}.
|
233
|
+
#
|
202
234
|
# - {Wx::EvtHandler#evt_key_up}(meth = nil, &block): Process a {Wx::EVT_KEY_UP} event (any key has been released). See {Wx::KeyEvent}.
|
235
|
+
#
|
203
236
|
# - {Wx::EvtHandler#evt_char}(meth = nil, &block): Process a {Wx::EVT_CHAR} event. See {Wx::KeyEvent}.
|
237
|
+
#
|
204
238
|
# - {Wx::EvtHandler#evt_char_hook}(meth = nil, &block): Process a {Wx::EVT_CHAR_HOOK} event. See {Wx::KeyEvent}.
|
239
|
+
#
|
205
240
|
# - {Wx::EvtHandler#evt_mouse_capture_lost}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_LOST} event. See {Wx::MouseCaptureLostEvent}.
|
241
|
+
#
|
206
242
|
# - {Wx::EvtHandler#evt_mouse_capture_changed}(meth = nil, &block): Process a {Wx::EVT_MOUSE_CAPTURE_CHANGED} event. See {Wx::MouseCaptureChangedEvent}.
|
243
|
+
#
|
207
244
|
# - {Wx::EvtHandler}evt_mouse_*(meth = nil, &block): See {Wx::MouseEvent}.
|
245
|
+
#
|
208
246
|
# - {Wx::EvtHandler#evt_paint}(meth = nil, &block): Process a {Wx::EVT_PAINT} event. See {Wx::PaintEvent}.
|
247
|
+
#
|
209
248
|
# - {Wx::EvtHandler}evt_power_*(meth = nil, &block): The system power state changed. See {Wx::PowerEvent}.
|
249
|
+
#
|
210
250
|
# - {Wx::EvtHandler}evt_scrollwin_*(meth = nil, &block): Process scroll events. See {Wx::ScrollWinEvent}.
|
251
|
+
#
|
211
252
|
# - {Wx::EvtHandler#evt_set_cursor}(meth = nil, &block): Process a {Wx::EVT_SET_CURSOR} event. See {Wx::SetCursorEvent}.
|
253
|
+
#
|
212
254
|
# - {Wx::EvtHandler#evt_size}(meth = nil, &block): Process a {Wx::EVT_SIZE} event. See {Wx::SizeEvent}.
|
255
|
+
#
|
213
256
|
# - {Wx::EvtHandler#evt_sys_colour_changed}(meth = nil, &block): Process a {Wx::EVT_SYS_COLOUR_CHANGED} event. See {Wx::SysColourChangedEvent}.
|
214
257
|
#
|
215
258
|
# ===
|
@@ -224,16 +267,16 @@ module Wx
|
|
224
267
|
# This method may be overridden in the derived classes to return false to indicate that this control doesn't accept input at all (i.e. behaves like e.g. {Wx::StaticText}) and so doesn't need focus.
|
225
268
|
#
|
226
269
|
# @see Wx::Window#accepts_focus_from_keyboard
|
227
|
-
# @return [
|
270
|
+
# @return [Boolean]
|
228
271
|
def accepts_focus; end
|
229
272
|
|
230
273
|
# This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn't be included in the TAB traversal chain when using the keyboard.
|
231
|
-
# @return [
|
274
|
+
# @return [Boolean]
|
232
275
|
def accepts_focus_from_keyboard; end
|
233
276
|
|
234
277
|
# Overridden to indicate whether this window or one of its children accepts focus.
|
235
278
|
# Usually it's the same as {Wx::Window#accepts_focus} but is overridden for container windows.
|
236
|
-
# @return [
|
279
|
+
# @return [Boolean]
|
237
280
|
def accepts_focus_recursively; end
|
238
281
|
|
239
282
|
# Disable giving focus to this window using the keyboard navigation keys.
|
@@ -242,25 +285,25 @@ module Wx
|
|
242
285
|
def disable_focus_from_keyboard; end
|
243
286
|
|
244
287
|
# Can this window itself have focus?
|
245
|
-
# @return [
|
288
|
+
# @return [Boolean]
|
246
289
|
def is_focusable; end
|
247
290
|
alias_method :focusable?, :is_focusable
|
248
291
|
|
249
292
|
# Can this window have focus right now?
|
250
293
|
# If this method returns true, it means that calling {Wx::Window#set_focus} will put focus either to this window or one of its children, if you need to know whether this window accepts focus itself, use {Wx::Window#is_focusable}
|
251
|
-
# @return [
|
294
|
+
# @return [Boolean]
|
252
295
|
def can_accept_focus; end
|
253
296
|
alias_method :can_accept_focus?, :can_accept_focus
|
254
297
|
|
255
298
|
# Can this window be assigned focus from keyboard right now?
|
256
|
-
# @return [
|
299
|
+
# @return [Boolean]
|
257
300
|
def can_accept_focus_from_keyboard; end
|
258
301
|
alias_method :can_accept_focus_from_keyboard?, :can_accept_focus_from_keyboard
|
259
302
|
|
260
303
|
# Returns true if the window (or in case of composite controls, its main child window) has focus.
|
261
304
|
#
|
262
305
|
# @see Wx::Window.find_focus
|
263
|
-
# @return [
|
306
|
+
# @return [Boolean]
|
264
307
|
def has_focus; end
|
265
308
|
alias_method :has_focus?, :has_focus
|
266
309
|
|
@@ -269,7 +312,7 @@ module Wx
|
|
269
312
|
# @see Wx::FocusEvent
|
270
313
|
# @see Wx::Panel#set_focus
|
271
314
|
# @see Wx::Panel#set_focus_ignoring_children
|
272
|
-
# @param canFocus [
|
315
|
+
# @param canFocus [Boolean]
|
273
316
|
# @return [void]
|
274
317
|
def set_can_focus(canFocus) end
|
275
318
|
alias_method :can_focus=, :set_can_focus
|
@@ -277,7 +320,7 @@ module Wx
|
|
277
320
|
# Enables or disables visible indication of keyboard focus.
|
278
321
|
# By default, controls behave in platform-appropriate way and show focus in the same way native applications do. In some very rare circumstances it may be desirable to change the default (notably multiline text controls don't normally have a focus indicator on Mac), which this method allows. It should only be used if you have a good understanding of the native platform's guidelines and user expectations.
|
279
322
|
# This method is only implemented on Mac.
|
280
|
-
# @param enable [
|
323
|
+
# @param enable [Boolean]
|
281
324
|
# @return [void]
|
282
325
|
def enable_visible_focus(enable) end
|
283
326
|
|
@@ -303,18 +346,13 @@ module Wx
|
|
303
346
|
|
304
347
|
# Destroys all children of a window.
|
305
348
|
# Called automatically by the destructor.
|
306
|
-
# @return [
|
349
|
+
# @return [Boolean]
|
307
350
|
def destroy_children; end
|
308
351
|
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
|
313
|
-
# @overload get_children()
|
314
|
-
# Returns a const reference to the list of the window's children.
|
315
|
-
# {Wx::WindowList} is a type-safe {Wx::List}-like class whose elements are of type <code>wxWindow*</code>.
|
316
|
-
# @return [Wx::WindowList]
|
317
|
-
def get_children(*args) end
|
352
|
+
# Returns a const reference to the list of the window's children.
|
353
|
+
# {Wx::WindowList} is a type-safe {Wx::List}-like class whose elements are of type <code>wxWindow*</code>.
|
354
|
+
# @return [Wx::WindowList]
|
355
|
+
def get_children; end
|
318
356
|
alias_method :children, :get_children
|
319
357
|
|
320
358
|
# Removes a child window.
|
@@ -351,7 +389,7 @@ module Wx
|
|
351
389
|
# Returns true if the window is a descendant (i.e. a child or grand-child or grand-grand-child or ...) of this one.
|
352
390
|
# Notice that a window can never be a descendant of another one if they are in different top level windows, i.e. a child of a {Wx::Dialog} is not considered to be a descendant of dialogs parent {Wx::Frame}.
|
353
391
|
# @param win [Wx::Window] Any window, possible NULL (false is always returned then).
|
354
|
-
# @return [
|
392
|
+
# @return [Boolean]
|
355
393
|
def is_descendant(win) end
|
356
394
|
alias_method :descendant?, :is_descendant
|
357
395
|
|
@@ -359,13 +397,13 @@ module Wx
|
|
359
397
|
# a non-standard toolbar in a {Wx::Frame}) and then re-inserted into another.
|
360
398
|
# Notice that currently you need to explicitly call {Wx::Notebook#remove_page} before reparenting a notebook page.
|
361
399
|
# @param newParent [Wx::Window] New parent.
|
362
|
-
# @return [
|
400
|
+
# @return [Boolean]
|
363
401
|
def reparent(newParent) end
|
364
402
|
|
365
403
|
# Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.
|
366
404
|
# This function is currently not implemented.
|
367
|
-
# @param hflag [
|
368
|
-
# @param vflag [
|
405
|
+
# @param hflag [Boolean] Whether the horizontal scroll bar should always be visible.
|
406
|
+
# @param vflag [Boolean] Whether the vertical scroll bar should always be visible.
|
369
407
|
# @return [void]
|
370
408
|
def always_show_scrollbars(hflag=true, vflag=true) end
|
371
409
|
|
@@ -395,14 +433,14 @@ module Wx
|
|
395
433
|
|
396
434
|
# Returns true if this window can have a scroll bar in this orientation.
|
397
435
|
# @param orient [Integer] Orientation to check, either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
|
398
|
-
# @return [
|
436
|
+
# @return [Boolean]
|
399
437
|
def can_scroll(orient) end
|
400
438
|
alias_method :can_scroll?, :can_scroll
|
401
439
|
|
402
440
|
# Returns true if this window currently has a scroll bar for this orientation.
|
403
441
|
# This method may return false even when {Wx::Window#can_scroll} for the same orientation returns true, but if {Wx::Window#can_scroll} returns false, i.e. scrolling in this direction is not enabled at all, {Wx::Window#has_scrollbar} always returns false as well.
|
404
442
|
# @param orient [Integer] Orientation to check, either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
|
405
|
-
# @return [
|
443
|
+
# @return [Boolean]
|
406
444
|
def has_scrollbar(orient) end
|
407
445
|
alias_method :has_scrollbar?, :has_scrollbar
|
408
446
|
|
@@ -410,50 +448,50 @@ module Wx
|
|
410
448
|
#
|
411
449
|
# @see Wx::Window#always_show_scrollbars
|
412
450
|
# @param orient [Integer] Orientation to check, either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
|
413
|
-
# @return [
|
451
|
+
# @return [Boolean]
|
414
452
|
def is_scrollbar_always_shown(orient) end
|
415
453
|
alias_method :scrollbar_always_shown?, :is_scrollbar_always_shown
|
416
454
|
|
417
455
|
# Scrolls the window by the given number of lines down (if lines is positive) or up.
|
418
456
|
# Returns true if the window was scrolled, false if it was already on top/bottom and nothing was done.
|
419
457
|
#
|
420
|
-
# This function is currently only implemented under MSW and {Wx::TextCtrl} under
|
458
|
+
# This function is currently only implemented under MSW and {Wx::TextCtrl} under wxGTK (it also works for {Wx::Scrolled} classes under all platforms).
|
421
459
|
# @see Wx::Window#scroll_pages
|
422
460
|
# @param lines [Integer]
|
423
|
-
# @return [
|
461
|
+
# @return [Boolean]
|
424
462
|
def scroll_lines(lines) end
|
425
463
|
|
426
464
|
# Scrolls the window by the given number of pages down (if pages is positive) or up.
|
427
465
|
# Returns true if the window was scrolled, false if it was already on top/bottom and nothing was done.
|
428
466
|
#
|
429
|
-
# This function is currently only implemented under MSW and
|
467
|
+
# This function is currently only implemented under MSW and wxGTK.
|
430
468
|
# @see Wx::Window#scroll_lines
|
431
469
|
# @param pages [Integer]
|
432
|
-
# @return [
|
470
|
+
# @return [Boolean]
|
433
471
|
def scroll_pages(pages) end
|
434
472
|
|
435
473
|
# Physically scrolls the pixels in the window and move child windows accordingly.
|
436
474
|
# Note that you can often use {Wx::Scrolled} instead of using this function directly.
|
437
475
|
# @param dx [Integer] Amount to scroll horizontally.
|
438
476
|
# @param dy [Integer] Amount to scroll vertically.
|
439
|
-
# @param rect [Wx::Rect] Rectangle to scroll, if it is NULL, the whole window is scrolled (this is always the case under
|
477
|
+
# @param rect [Wx::Rect] Rectangle to scroll, if it is NULL, the whole window is scrolled (this is always the case under wxGTK which doesn't support this parameter)
|
440
478
|
# @return [void]
|
441
479
|
def scroll_window(dx, dy, rect=nil) end
|
442
480
|
|
443
481
|
# Same as {Wx::Window#scroll_lines} (-1).
|
444
|
-
# @return [
|
482
|
+
# @return [Boolean]
|
445
483
|
def line_up; end
|
446
484
|
|
447
485
|
# Same as {Wx::Window#scroll_lines} (1).
|
448
|
-
# @return [
|
486
|
+
# @return [Boolean]
|
449
487
|
def line_down; end
|
450
488
|
|
451
489
|
# Same as {Wx::Window#scroll_pages} (-1).
|
452
|
-
# @return [
|
490
|
+
# @return [Boolean]
|
453
491
|
def page_up; end
|
454
492
|
|
455
493
|
# Same as {Wx::Window#scroll_pages} (1).
|
456
|
-
# @return [
|
494
|
+
# @return [Boolean]
|
457
495
|
def page_down; end
|
458
496
|
|
459
497
|
# Sets the position of one of the built-in scrollbars.
|
@@ -465,14 +503,14 @@ module Wx
|
|
465
503
|
# @see Wx::Scrolled
|
466
504
|
# @param orientation [Integer] Determines the scrollbar whose position is to be set. May be {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
|
467
505
|
# @param pos [Integer] Position in scroll units.
|
468
|
-
# @param refresh [
|
506
|
+
# @param refresh [Boolean] true to redraw the scrollbar, false otherwise.
|
469
507
|
# @return [void]
|
470
508
|
def set_scroll_pos(orientation, pos, refresh=true) end
|
471
509
|
|
472
510
|
# Sets the scrollbar properties of a built-in scrollbar.
|
473
511
|
# Let's say you wish to display 50 lines of text, using the same font. The window is sized so that you can only see 16 lines at a time. You would use:
|
474
|
-
# ```
|
475
|
-
#
|
512
|
+
# ```ruby
|
513
|
+
# set_scrollbar(Wx::VERTICAL, 0, 16, 50)
|
476
514
|
# ```
|
477
515
|
# Note that with the window at this size, the thumb position can never go above 50 minus 16, or 34. You can determine how many lines are currently visible by dividing the current view size by the character height in pixels. When defining your own scrollbar behaviour, you will always need to recalculate the scrollbar settings when the window size changes. You could therefore put your scrollbar calculations and SetScrollbar call into a function named AdjustScrollbars, which can be called initially and also from your {Wx::SizeEvent} handler function.
|
478
516
|
# @see Scrolled Windows
|
@@ -482,15 +520,15 @@ module Wx
|
|
482
520
|
# @param orientation [Integer] Determines the scrollbar whose page size is to be set. May be {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
|
483
521
|
# @param position [Integer] The position of the scrollbar in scroll units.
|
484
522
|
# @param thumbSize [Integer] The size of the thumb, or visible portion of the scrollbar, in scroll units.
|
485
|
-
# @param range [Integer] The maximum position of the scrollbar. Value of -1 can be used to ask for the scrollbar to be shown but in the disabled state: this can be used to avoid removing the scrollbar even when it is not needed (currently this is only implemented in
|
486
|
-
# @param refresh [
|
523
|
+
# @param range [Integer] The maximum position of the scrollbar. Value of -1 can be used to ask for the scrollbar to be shown but in the disabled state: this can be used to avoid removing the scrollbar even when it is not needed (currently this is only implemented in wxMSW port).
|
524
|
+
# @param refresh [Boolean] true to redraw the scrollbar, false otherwise.
|
487
525
|
# @return [void]
|
488
526
|
def set_scrollbar(orientation, position, thumbSize, range, refresh=true) end
|
489
527
|
|
490
528
|
# Prepare for changing positions of multiple child windows.
|
491
529
|
# This method should be called before changing positions of multiple child windows to reduce flicker and, in MSW case, even avoid display corruption in some cases. It is used internally by wxWidgets and called automatically when the window size changes but it can also be useful to call it from outside of the library if a repositioning involving multiple children is done without changing the window size.
|
492
530
|
# If this method returns true, then {Wx::Window#end_repositioning_children} must be called after setting all children positions. Use {Wx::ChildrenRepositioningGuard} class to ensure that this requirement is satisfied.
|
493
|
-
# @return [
|
531
|
+
# @return [Boolean]
|
494
532
|
def begin_repositioning_children; end
|
495
533
|
|
496
534
|
# Fix child window positions after setting all of them at once.
|
@@ -535,8 +573,8 @@ module Wx
|
|
535
573
|
# @overload from_dip(sz)
|
536
574
|
# Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.
|
537
575
|
# A DPI-independent pixel is just a pixel at the standard 96 DPI resolution. To keep the same physical size at higher resolution, the physical pixel value must be scaled by {Wx::Window#get_dpi_scale_factor} but this scaling may be already done by the underlying toolkit (GTK+, Cocoa, ...) automatically. This method performs the conversion only if it is not already done by the lower level toolkit and so by using it with pixel values you can guarantee that the physical size of the corresponding elements will remain the same in all resolutions under all platforms. For example, instead of creating a bitmap of the hard coded size of 32 pixels you should use
|
538
|
-
# ```
|
539
|
-
#
|
576
|
+
# ```ruby
|
577
|
+
# bmp = Wx::Bitmap.new(from_dip(Wx::Size.new(32, 32)))
|
540
578
|
# ```
|
541
579
|
# to avoid using tiny bitmaps on high DPI screens.
|
542
580
|
# Notice that this function is only needed when using hard coded pixel values. It is not necessary if the sizes are already based on the DPI-independent units such as dialog units or if you are relying on the controls automatic best size determination and using sizers to lay out them.
|
@@ -577,9 +615,9 @@ module Wx
|
|
577
615
|
# @overload to_dip(sz)
|
578
616
|
# Convert pixel values of the current toolkit to DPI-independent pixel values.
|
579
617
|
# A DPI-independent pixel is just a pixel at the standard 96 DPI resolution. To keep the same physical size at higher resolution, the physical pixel value must be scaled by {Wx::Window#get_dpi_scale_factor} but this scaling may be already done by the underlying toolkit (GTK+, Cocoa, ...) automatically. This method performs the conversion only if it is not already done by the lower level toolkit, For example, you may want to use this to store window sizes and positions so that they can be re-used regardless of the display DPI:
|
580
|
-
# ```
|
581
|
-
#
|
582
|
-
#
|
618
|
+
# ```ruby
|
619
|
+
# pt = Wx::Point.new(to_dip(get_position))
|
620
|
+
# size = Wx::Size.new(to_dip(get_size))
|
583
621
|
# ```
|
584
622
|
#
|
585
623
|
# Also note that if either component of sz has the special value of -1, it is returned unchanged independently of the current DPI, to preserve the special value of -1 in wxWidgets API (it is often used to mean "unspecified").
|
@@ -809,7 +847,7 @@ module Wx
|
|
809
847
|
# Returns the factor mapping logical pixels of this window to physical pixels.
|
810
848
|
# This function can be used to portably determine the number of physical pixels in a window of the given size, by multiplying the window size by the value returned from it. I.e. it returns the factor converting window coordinates to "content view" coordinates, where the view can be just a simple window displaying a {Wx::Bitmap} or {Wx::GLCanvas} or any other kind of window rendering arbitrary "content" on screen.
|
811
849
|
# For the platforms not doing any pixel mapping, i.e. where logical and physical pixels are one and the same, this function always returns 1.0 and so using it is, in principle, unnecessary and could be avoided by using preprocessor check for {Wx::HAS_DPI_INDEPENDENT_PIXELS} not being defined, however using this function unconditionally under all platforms is usually simpler and so preferable.
|
812
|
-
# Current behaviour of this function is compatible with wxWidgets 3.0, but different from its behaviour in versions 3.1.0 to 3.1.3, where it returned the same value as {Wx::Window#get_dpi_scale_factor}. Please use the other function if you need to use a scaling factor greater than 1.0 even for the platforms without {Wx::HAS_DPI_INDEPENDENT_PIXELS}, such as
|
850
|
+
# Current behaviour of this function is compatible with wxWidgets 3.0, but different from its behaviour in versions 3.1.0 to 3.1.3, where it returned the same value as {Wx::Window#get_dpi_scale_factor}. Please use the other function if you need to use a scaling factor greater than 1.0 even for the platforms without {Wx::HAS_DPI_INDEPENDENT_PIXELS}, such as wxMSW.
|
813
851
|
# @return [Float]
|
814
852
|
def get_content_scale_factor; end
|
815
853
|
alias_method :content_scale_factor, :get_content_scale_factor
|
@@ -834,7 +872,7 @@ module Wx
|
|
834
872
|
# @param direction [Integer]
|
835
873
|
# @param size [Integer]
|
836
874
|
# @param availableOtherDir [Integer]
|
837
|
-
# @return [
|
875
|
+
# @return [Boolean]
|
838
876
|
def inform_first_direction(direction, size, availableOtherDir) end
|
839
877
|
|
840
878
|
# Resets the cached best size value so it will be recalculated the next time it is needed.
|
@@ -907,8 +945,8 @@ module Wx
|
|
907
945
|
|
908
946
|
# Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.
|
909
947
|
# Note that this method is just a shortcut for:
|
910
|
-
# ```
|
911
|
-
#
|
948
|
+
# ```ruby
|
949
|
+
# set_max_size(client_to_window_size(size))
|
912
950
|
# ```
|
913
951
|
# @see Wx::Window#set_max_size
|
914
952
|
# @see Window Sizing Overview
|
@@ -930,8 +968,8 @@ module Wx
|
|
930
968
|
# You may need to call this if you change the window size after construction and before adding to its parent sizer.
|
931
969
|
# Note, that just as with {Wx::Window#set_min_size}, calling this method doesn't prevent the program from explicitly making the window smaller than the specified size.
|
932
970
|
# Note that this method is just a shortcut for:
|
933
|
-
# ```
|
934
|
-
#
|
971
|
+
# ```ruby
|
972
|
+
# set_min_size(client_to_window_size(size))
|
935
973
|
# ```
|
936
974
|
# @see Wx::Window#set_min_size
|
937
975
|
# @see Window Sizing Overview
|
@@ -960,7 +998,13 @@ module Wx
|
|
960
998
|
# @param width [Integer] Required width in pixels, or {Wx::DEFAULT_COORD} to indicate that the existing value should be used.
|
961
999
|
# @param height [Integer] Required height position in pixels, or {Wx::DEFAULT_COORD} to indicate that the existing value should be used.
|
962
1000
|
# @param sizeFlags [Integer] Indicates the interpretation of other parameters. It is a bit list of the following:
|
963
|
-
#
|
1001
|
+
#
|
1002
|
+
# - {Wx::SIZE_AUTO_WIDTH}: a {Wx::DEFAULT_COORD} width value is taken to indicate a wxWidgets-supplied default width.
|
1003
|
+
# - {Wx::SIZE_AUTO_HEIGHT}: a {Wx::DEFAULT_COORD} height value is taken to indicate a wxWidgets-supplied default height.
|
1004
|
+
# - {Wx::SIZE_AUTO}: {Wx::DEFAULT_COORD} size values are taken to indicate a wxWidgets-supplied default size.
|
1005
|
+
# - {Wx::SIZE_USE_EXISTING}: existing dimensions should be used if {Wx::DEFAULT_COORD} values are supplied.
|
1006
|
+
# - {Wx::SIZE_ALLOW_MINUS_ONE}: allow negative dimensions (i.e. value of {Wx::DEFAULT_COORD}) to be interpreted as real dimensions, not default values.
|
1007
|
+
# - {Wx::SIZE_FORCE}: normally, if the position and the size of the window are already the same as the parameters of this function, nothing is done. but with this flag a window resize may be forced even in this case (supported in wx 2.6.2 and later and only implemented for MSW and ignored elsewhere currently).
|
964
1008
|
# @return [void]
|
965
1009
|
# @overload set_size(rect)
|
966
1010
|
# Sets the size of the window in pixels.
|
@@ -1079,8 +1123,8 @@ module Wx
|
|
1079
1123
|
# @overload move(x, y, flags=Wx::SIZE_USE_EXISTING)
|
1080
1124
|
# Moves the window to the given position.
|
1081
1125
|
# Implementations of SetSize can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call:
|
1082
|
-
# ```
|
1083
|
-
#
|
1126
|
+
# ```ruby
|
1127
|
+
# set_size(x, y, Wx::DEFAULT_COORD, Wx::DEFAULT_COORD, Wx::SIZE_USE_EXISTING)
|
1084
1128
|
# ```
|
1085
1129
|
# @see Wx::Window#set_size
|
1086
1130
|
# @param x [Integer] Required x position.
|
@@ -1090,8 +1134,8 @@ module Wx
|
|
1090
1134
|
# @overload move(pt, flags=Wx::SIZE_USE_EXISTING)
|
1091
1135
|
# Moves the window to the given position.
|
1092
1136
|
# Implementations of {Wx::Window#set_size} can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call:
|
1093
|
-
# ```
|
1094
|
-
#
|
1137
|
+
# ```ruby
|
1138
|
+
# set_size(x, y, Wx::DEFAULT_COORD, Wx::DEFAULT_COORD, Wx::SIZE_USE_EXISTING)
|
1095
1139
|
# ```
|
1096
1140
|
# @see Wx::Window#set_size
|
1097
1141
|
# @param pt [Array(Integer, Integer), Wx::Point] {Wx::Point} object representing the position.
|
@@ -1114,10 +1158,7 @@ module Wx
|
|
1114
1158
|
# @overload convert_dialog_to_pixels(pt)
|
1115
1159
|
# Converts a point or size from dialog units to pixels.
|
1116
1160
|
# For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
|
1117
|
-
# Dialog units are used for maintaining a dialog's proportions even if the font changes. You can also use these functions programmatically.
|
1118
|
-
# ```
|
1119
|
-
# #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
|
1120
|
-
# ```
|
1161
|
+
# Dialog units are used for maintaining a dialog's proportions even if the font changes. You can also use these functions programmatically.
|
1121
1162
|
# @see Wx::Window#convert_pixels_to_dialog
|
1122
1163
|
# @param pt [Array(Integer, Integer), Wx::Point]
|
1123
1164
|
# @return [Wx::Point]
|
@@ -1154,7 +1195,7 @@ module Wx
|
|
1154
1195
|
# Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.
|
1155
1196
|
# {Wx::Window#thaw} must be called to re-enable window redrawing. Calls to these two functions may be nested but to ensure that the window is properly repainted again, you must thaw it exactly as many times as you froze it.
|
1156
1197
|
# If the window has any children, they are recursively frozen too.
|
1157
|
-
# This method is useful for visual appearance optimization (for example, it is a good idea to use it before doing many large text insertions in a row into a {Wx::TextCtrl} under
|
1198
|
+
# This method is useful for visual appearance optimization (for example, it is a good idea to use it before doing many large text insertions in a row into a {Wx::TextCtrl} under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWidgets and not a mandatory directive.
|
1158
1199
|
# @see Wx::WindowUpdateLocker
|
1159
1200
|
# @see Wx::Window#thaw
|
1160
1201
|
# @see Wx::Window#is_frozen
|
@@ -1174,7 +1215,7 @@ module Wx
|
|
1174
1215
|
#
|
1175
1216
|
# @see Wx::Window#freeze
|
1176
1217
|
# @see Wx::Window#thaw
|
1177
|
-
# @return [
|
1218
|
+
# @return [Boolean]
|
1178
1219
|
def is_frozen; end
|
1179
1220
|
alias_method :frozen?, :is_frozen
|
1180
1221
|
|
@@ -1193,7 +1234,7 @@ module Wx
|
|
1193
1234
|
# @see Wx::Window#get_foreground_colour
|
1194
1235
|
# @see Wx::Window#set_background_style
|
1195
1236
|
# @see Wx::Window#set_transparent
|
1196
|
-
# @return [BackgroundStyle]
|
1237
|
+
# @return [Wx::BackgroundStyle]
|
1197
1238
|
def get_background_style; end
|
1198
1239
|
alias_method :background_style, :get_background_style
|
1199
1240
|
|
@@ -1260,14 +1301,14 @@ module Wx
|
|
1260
1301
|
|
1261
1302
|
# Returns true if this window background is transparent (as, for example, for {Wx::StaticText}) and should show the parent window background.
|
1262
1303
|
# This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your {Wx::Window}-derived class to ensure that background is painted correctly.
|
1263
|
-
# @return [
|
1304
|
+
# @return [Boolean]
|
1264
1305
|
def has_transparent_background; end
|
1265
1306
|
alias_method :has_transparent_background?, :has_transparent_background
|
1266
1307
|
|
1267
1308
|
# Causes this window, and all of its children recursively, to be repainted.
|
1268
1309
|
# Note that repainting doesn't happen immediately but only during the next event loop iteration, if you need to update the window immediately you should use {Wx::Window#update} instead.
|
1269
1310
|
# @see Wx::Window#refresh_rect
|
1270
|
-
# @param eraseBackground [
|
1311
|
+
# @param eraseBackground [Boolean] If true, the background will be erased too. Note that in non-MSW ports background is always erased.
|
1271
1312
|
# @param rect [Wx::Rect] If non-NULL, only the given rectangle will be treated as damaged.
|
1272
1313
|
# @return [void]
|
1273
1314
|
def refresh(eraseBackground=true, rect=nil) end
|
@@ -1275,7 +1316,7 @@ module Wx
|
|
1275
1316
|
# Redraws the contents of the given rectangle: only the area inside it will be repainted.
|
1276
1317
|
# This is the same as {Wx::Window#refresh} but has a nicer syntax as it can be called with a temporary {Wx::Rect} object as argument like this <code>RefreshRect(wxRect(x, y, w, h))</code>.
|
1277
1318
|
# @param rect [Wx::Rect]
|
1278
|
-
# @param eraseBackground [
|
1319
|
+
# @param eraseBackground [Boolean]
|
1279
1320
|
# @return [void]
|
1280
1321
|
def refresh_rect(rect, eraseBackground=true) end
|
1281
1322
|
|
@@ -1299,36 +1340,33 @@ module Wx
|
|
1299
1340
|
# @see Wx::EraseEvent
|
1300
1341
|
# @see Wx::SystemSettings
|
1301
1342
|
# @param colour [Wx::Colour,String,Symbol] The colour to be used as the background colour; pass {Wx::NULL_COLOUR} to reset to the default colour. Note that you may want to use {Wx::SystemSettings.get_colour} to retrieve a suitable colour to use rather than setting a hard-coded one.
|
1302
|
-
# @return [
|
1343
|
+
# @return [Boolean]
|
1303
1344
|
def set_background_colour(colour) end
|
1304
1345
|
alias_method :background_colour=, :set_background_colour
|
1305
1346
|
|
1306
1347
|
# Sets the background style of the window.
|
1307
1348
|
# The default background style is {Wx::BackgroundStyle::BG_STYLE_ERASE} which indicates that the window background may be erased in EVT_ERASE_BACKGROUND handler. This is a safe, compatibility default; however you may want to change it to {Wx::BackgroundStyle::BG_STYLE_SYSTEM} if you don't define any erase background event handlers at all, to avoid unnecessary generation of erase background events and always let system erase the background. And you should change the background style to {Wx::BackgroundStyle::BG_STYLE_PAINT} if you define an EVT_PAINT handler which completely overwrites the window background as in this case erasing it previously, either in EVT_ERASE_BACKGROUND handler or in the system default handler, would result in flicker as the background pixels will be repainted twice every time the window is redrawn. Do ensure that the background is entirely erased by your EVT_PAINT handler in this case however as otherwise garbage may be left on screen.
|
1308
1349
|
# Notice that in previous versions of wxWidgets a common way to work around the above mentioned flickering problem was to define an empty EVT_ERASE_BACKGROUND handler. Setting background style to {Wx::BackgroundStyle::BG_STYLE_PAINT} is a simpler and more efficient solution to the same problem.
|
1309
|
-
# Under
|
1350
|
+
# Under wxGTK and wxOSX, you can use {Wx::BackgroundStyle::BG_STYLE_TRANSPARENT} to obtain full transparency of the window background. Note that wxGTK supports this only since GTK 2.12 with a compositing manager enabled, call {Wx::Window#is_transparent_background_supported} to check whether this is the case, see the example of doing it in the shapedsample".
|
1310
1351
|
# Also, in order for <code>SetBackgroundStyle(wxBG_STYLE_TRANSPARENT)</code> to work, it must be called before {Wx::Window#create}. If you're using your own {Wx::Window}-derived class you should write your code in the following way:
|
1311
|
-
# ```
|
1312
|
-
# class MyWidget
|
1313
|
-
#
|
1314
|
-
#
|
1315
|
-
#
|
1316
|
-
#
|
1317
|
-
#
|
1318
|
-
#
|
1319
|
-
#
|
1320
|
-
#
|
1321
|
-
#
|
1322
|
-
# Create(parent, ...);
|
1323
|
-
# }
|
1324
|
-
# };
|
1352
|
+
# ```ruby
|
1353
|
+
# class MyWidget < Wx::Window
|
1354
|
+
# def initialize(parent, ...)
|
1355
|
+
# super() # Use default ctor here!
|
1356
|
+
# # Do this first:
|
1357
|
+
# set_background_style(Wx::BG_STYLE_TRANSPARENT)
|
1358
|
+
#
|
1359
|
+
# # And really create the window afterwards:
|
1360
|
+
# create(parent, ...)
|
1361
|
+
# end
|
1362
|
+
# end
|
1325
1363
|
# ```
|
1326
1364
|
# @see Wx::Window#set_background_colour
|
1327
1365
|
# @see Wx::Window#get_foreground_colour
|
1328
1366
|
# @see Wx::Window#set_transparent
|
1329
1367
|
# @see Wx::Window#is_transparent_background_supported
|
1330
|
-
# @param style [BackgroundStyle]
|
1331
|
-
# @return [
|
1368
|
+
# @param style [Wx::BackgroundStyle]
|
1369
|
+
# @return [Boolean]
|
1332
1370
|
def set_background_style(style) end
|
1333
1371
|
alias_method :background_style=, :set_background_style
|
1334
1372
|
|
@@ -1338,7 +1376,7 @@ module Wx
|
|
1338
1376
|
#
|
1339
1377
|
# true if background transparency is supported.
|
1340
1378
|
# @param reason [String] If not NULL, a reason message is provided if transparency is not supported.
|
1341
|
-
# @return [
|
1379
|
+
# @return [Boolean]
|
1342
1380
|
def is_transparent_background_supported(reason=nil) end
|
1343
1381
|
alias_method :transparent_background_supported?, :is_transparent_background_supported
|
1344
1382
|
|
@@ -1350,7 +1388,7 @@ module Wx
|
|
1350
1388
|
# @see Wx::Window#get_font
|
1351
1389
|
# @see Wx::Window#inherit_attributes
|
1352
1390
|
# @param font [Wx::Font,Wx::FontInfo] Font to associate with this window, pass {Wx::NULL_FONT} to reset to the default font.
|
1353
|
-
# @return [
|
1391
|
+
# @return [Boolean]
|
1354
1392
|
def set_font(font) end
|
1355
1393
|
alias_method :font=, :set_font
|
1356
1394
|
|
@@ -1364,7 +1402,7 @@ module Wx
|
|
1364
1402
|
# @see Wx::Window#get_background_colour
|
1365
1403
|
# @see Wx::Window#should_inherit_colours
|
1366
1404
|
# @param colour [Wx::Colour,String,Symbol] The colour to be used as the foreground colour; pass {Wx::NULL_COLOUR} to reset to the default colour.
|
1367
|
-
# @return [
|
1405
|
+
# @return [Boolean]
|
1368
1406
|
def set_foreground_colour(colour) end
|
1369
1407
|
alias_method :foreground_colour=, :set_foreground_colour
|
1370
1408
|
|
@@ -1381,16 +1419,16 @@ module Wx
|
|
1381
1419
|
#
|
1382
1420
|
# @see Wx::Window#set_own_background_colour
|
1383
1421
|
# @see Wx::Window#inherit_attributes
|
1384
|
-
# @return [
|
1422
|
+
# @return [Boolean]
|
1385
1423
|
def inherits_background_colour; end
|
1386
1424
|
|
1387
1425
|
# Return true if a background colour has been set for this window.
|
1388
|
-
# @return [
|
1426
|
+
# @return [Boolean]
|
1389
1427
|
def use_bg_col; end
|
1390
1428
|
|
1391
1429
|
# Return true if a background colour has been set for this window.
|
1392
1430
|
# Same as {Wx::Window#use_bg_col}
|
1393
|
-
# @return [
|
1431
|
+
# @return [Boolean]
|
1394
1432
|
def use_background_colour; end
|
1395
1433
|
|
1396
1434
|
# Sets the font of the window but prevents it from being inherited by the children of this window.
|
@@ -1412,27 +1450,27 @@ module Wx
|
|
1412
1450
|
alias_method :own_foreground_colour=, :set_own_foreground_colour
|
1413
1451
|
|
1414
1452
|
# Return true if a foreground colour has been set for this window.
|
1415
|
-
# @return [
|
1453
|
+
# @return [Boolean]
|
1416
1454
|
def use_foreground_colour; end
|
1417
1455
|
|
1418
1456
|
# Return true if this window inherits the foreground colour from its parent.
|
1419
1457
|
#
|
1420
1458
|
# @see Wx::Window#set_own_foreground_colour
|
1421
1459
|
# @see Wx::Window#inherit_attributes
|
1422
|
-
# @return [
|
1460
|
+
# @return [Boolean]
|
1423
1461
|
def inherits_foreground_colour; end
|
1424
1462
|
|
1425
1463
|
# Return true from here to allow the colours of this window to be changed by {Wx::Window#inherit_attributes}.
|
1426
1464
|
# Returning false forbids inheriting them from the parent window.
|
1427
1465
|
# The base class version returns false, but this method is overridden in {Wx::Control} where it returns true.
|
1428
|
-
# @return [
|
1466
|
+
# @return [Boolean]
|
1429
1467
|
def should_inherit_colours; end
|
1430
1468
|
|
1431
1469
|
# This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.
|
1432
1470
|
# This does not always have any effect since the underlying platform obviously needs to support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme.
|
1433
1471
|
# Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.
|
1434
1472
|
# @see Wx::Window#get_theme_enabled
|
1435
|
-
# @param enable [
|
1473
|
+
# @param enable [Boolean]
|
1436
1474
|
# @return [void]
|
1437
1475
|
def set_theme_enabled(enable) end
|
1438
1476
|
alias_method :theme_enabled=, :set_theme_enabled
|
@@ -1440,13 +1478,13 @@ module Wx
|
|
1440
1478
|
# Returns true if the window uses the system theme for drawing its background.
|
1441
1479
|
#
|
1442
1480
|
# @see Wx::Window#set_theme_enabled
|
1443
|
-
# @return [
|
1481
|
+
# @return [Boolean]
|
1444
1482
|
def get_theme_enabled; end
|
1445
1483
|
alias_method :theme_enabled, :get_theme_enabled
|
1446
1484
|
|
1447
1485
|
# Returns true if the system supports transparent windows and calling {Wx::Window#set_transparent} may succeed.
|
1448
1486
|
# If this function returns false, transparent windows are definitely not supported by the current system.
|
1449
|
-
# @return [
|
1487
|
+
# @return [Boolean]
|
1450
1488
|
def can_set_transparent; end
|
1451
1489
|
alias_method :can_set_transparent?, :can_set_transparent
|
1452
1490
|
|
@@ -1454,7 +1492,7 @@ module Wx
|
|
1454
1492
|
# If the system supports transparent windows, returns true, otherwise returns false and the window remains fully opaque. See also {Wx::Window#can_set_transparent}.
|
1455
1493
|
# The parameter alpha is in the range 0..255 where 0 corresponds to a fully transparent window and 255 to the fully opaque one. The constants {Wx::IMAGE_ALPHA_TRANSPARENT} and {Wx::IMAGE_ALPHA_OPAQUE} can be used.
|
1456
1494
|
# @param alpha [Integer]
|
1457
|
-
# @return [
|
1495
|
+
# @return [Boolean]
|
1458
1496
|
def set_transparent(alpha) end
|
1459
1497
|
alias_method :transparent=, :set_transparent
|
1460
1498
|
|
@@ -1473,41 +1511,41 @@ module Wx
|
|
1473
1511
|
# Returns true if the key pressed was for navigation and was handled, false otherwise.
|
1474
1512
|
# @see Wx::Window#navigate
|
1475
1513
|
# @param event [Wx::KeyEvent]
|
1476
|
-
# @return [
|
1514
|
+
# @return [Boolean]
|
1477
1515
|
def handle_as_navigation_key(event) end
|
1478
1516
|
|
1479
1517
|
# Shorthand for:
|
1480
|
-
# ```
|
1481
|
-
#
|
1518
|
+
# ```ruby
|
1519
|
+
# get_event_handler.safely_process_event(event)
|
1482
1520
|
# ```
|
1483
1521
|
# @see Wx::Window#process_window_event
|
1484
1522
|
# @param event [Wx::Event]
|
1485
|
-
# @return [
|
1523
|
+
# @return [Boolean]
|
1486
1524
|
def handle_window_event(event) end
|
1487
1525
|
|
1488
1526
|
# Convenient wrapper for {Wx::Window#process_event}.
|
1489
1527
|
# This is the same as writing
|
1490
|
-
# ```
|
1491
|
-
#
|
1528
|
+
# ```ruby
|
1529
|
+
# get_event_handler.process_event(event)
|
1492
1530
|
# ```
|
1493
1531
|
# but more convenient. Notice that {Wx::Window#process_event} itself can't be called for {Wx::Window} objects as it ignores the event handlers associated with the window; use this function instead.
|
1494
1532
|
# @param event [Wx::Event]
|
1495
|
-
# @return [
|
1533
|
+
# @return [Boolean]
|
1496
1534
|
def process_window_event(event) end
|
1497
1535
|
|
1498
1536
|
# Wrapper for {Wx::EvtHandler#process_event_locally}.
|
1499
1537
|
# This method is similar to {Wx::Window#process_window_event} but can be used to search for the event handler only in this window and any event handlers pushed on top of it. Unlike {Wx::Window#process_window_event} it won't propagate the event upwards. But it will use the validator and event handlers associated with this window, if any.
|
1500
1538
|
# @param event [Wx::Event]
|
1501
|
-
# @return [
|
1539
|
+
# @return [Boolean]
|
1502
1540
|
def process_window_event_locally(event) end
|
1503
1541
|
|
1504
1542
|
# Pushes this event handler onto the event stack for the window.
|
1505
1543
|
# An event handler is an object that is capable of processing the events sent to a window. By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.
|
1506
1544
|
# {Wx::Window#push_event_handler} allows an application to set up a stack of event handlers, where an event not handled by one event handler is handed to the next one in the chain.
|
1507
1545
|
# E.g. if you have two event handlers A and B and a {Wx::Window} instance W and you call:
|
1508
|
-
# ```
|
1509
|
-
# W
|
1510
|
-
# W
|
1546
|
+
# ```ruby
|
1547
|
+
# W.push_event_handler(A)
|
1548
|
+
# W.push_event_handler(B)
|
1511
1549
|
# ```
|
1512
1550
|
# you will end up with the following situation:
|
1513
1551
|
#
|
@@ -1524,7 +1562,7 @@ module Wx
|
|
1524
1562
|
# @see Wx::Window#push_event_handler
|
1525
1563
|
# @see Wx::Window#pop_event_handler
|
1526
1564
|
# @param handler [Wx::EvtHandler] The event handler to remove, must be non-NULL and must be present in this windows event handlers stack.
|
1527
|
-
# @return [
|
1565
|
+
# @return [Boolean]
|
1528
1566
|
def remove_event_handler(handler) end
|
1529
1567
|
|
1530
1568
|
# Sets the event handler for this window.
|
@@ -1569,13 +1607,13 @@ module Wx
|
|
1569
1607
|
#
|
1570
1608
|
# @see Wx::Window#set_extra_style
|
1571
1609
|
# @param exFlag [Integer]
|
1572
|
-
# @return [
|
1610
|
+
# @return [Boolean]
|
1573
1611
|
def has_extra_style(exFlag) end
|
1574
1612
|
alias_method :has_extra_style?, :has_extra_style
|
1575
1613
|
|
1576
1614
|
# Returns true if the window has the given flag bit set.
|
1577
1615
|
# @param flag [Integer]
|
1578
|
-
# @return [
|
1616
|
+
# @return [Boolean]
|
1579
1617
|
def has_flag(flag) end
|
1580
1618
|
alias_method :has_flag?, :has_flag
|
1581
1619
|
|
@@ -1608,7 +1646,7 @@ module Wx
|
|
1608
1646
|
# @see Wx::Window#set_window_style_flag
|
1609
1647
|
# @see Wx::Window#has_flag
|
1610
1648
|
# @param flag [Integer]
|
1611
|
-
# @return [
|
1649
|
+
# @return [Boolean]
|
1612
1650
|
def toggle_window_style(flag) end
|
1613
1651
|
|
1614
1652
|
# Moves this window in the tab navigation order after the specified win.
|
@@ -1630,13 +1668,13 @@ module Wx
|
|
1630
1668
|
#
|
1631
1669
|
# You may wish to call this from a text control custom keypress handler to do the default navigation behaviour for the tab key, since the standard default behaviour for a multiline text control with the {Wx::TE_PROCESS_TAB} style is to insert a tab and not navigate to the next control. See also {Wx::NavigationKeyEvent} and HandleAsNavigationKey.
|
1632
1670
|
# @param flags [Integer] A combination of {Wx::NavigationKeyEvent::IsForward} and {Wx::NavigationKeyEvent::WinChange}.
|
1633
|
-
# @return [
|
1671
|
+
# @return [Boolean]
|
1634
1672
|
def navigate(flags=Wx::NavigationKeyEvent::IsForward) end
|
1635
1673
|
|
1636
1674
|
# Performs a keyboard navigation action inside this window.
|
1637
1675
|
# See {Wx::Window#navigate} for more information.
|
1638
1676
|
# @param flags [Integer]
|
1639
|
-
# @return [
|
1677
|
+
# @return [Boolean]
|
1640
1678
|
def navigate_in(flags=Wx::NavigationKeyEvent::IsForward) end
|
1641
1679
|
|
1642
1680
|
# Lowers the window to the bottom of the window hierarchy (Z-order).
|
@@ -1653,20 +1691,20 @@ module Wx
|
|
1653
1691
|
def raise; end
|
1654
1692
|
|
1655
1693
|
# Equivalent to calling {Wx::Window#show}(false).
|
1656
|
-
# @return [
|
1694
|
+
# @return [Boolean]
|
1657
1695
|
def hide; end
|
1658
1696
|
|
1659
1697
|
# This function hides a window, like {Wx::Window#hide}, but using a special visual effect if possible.
|
1660
1698
|
# The parameters of this function are the same as for {Wx::Window#show_with_effect}, please see their description there.
|
1661
|
-
# @param effect [ShowEffect]
|
1699
|
+
# @param effect [Wx::ShowEffect]
|
1662
1700
|
# @param timeout [Integer]
|
1663
|
-
# @return [
|
1701
|
+
# @return [Boolean]
|
1664
1702
|
def hide_with_effect(effect, timeout=0) end
|
1665
1703
|
|
1666
1704
|
# Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.
|
1667
1705
|
# Notice that this method can return false even if this window itself hadn't been explicitly disabled when one of its parent windows is disabled. To get the intrinsic status of this window, use {Wx::Window#is_this_enabled}
|
1668
1706
|
# @see Wx::Window#enable
|
1669
|
-
# @return [
|
1707
|
+
# @return [Boolean]
|
1670
1708
|
def is_enabled; end
|
1671
1709
|
alias_method :enabled?, :is_enabled
|
1672
1710
|
|
@@ -1675,60 +1713,60 @@ module Wx
|
|
1675
1713
|
# Call this in a paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
|
1676
1714
|
# @param x [Integer]
|
1677
1715
|
# @param y [Integer]
|
1678
|
-
# @return [
|
1716
|
+
# @return [Boolean]
|
1679
1717
|
# @overload is_exposed(pt)
|
1680
1718
|
# This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
1681
1719
|
# @param pt [Array(Integer, Integer), Wx::Point]
|
1682
|
-
# @return [
|
1720
|
+
# @return [Boolean]
|
1683
1721
|
# @overload is_exposed(x, y, w, h)
|
1684
1722
|
# This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
1685
1723
|
# @param x [Integer]
|
1686
1724
|
# @param y [Integer]
|
1687
1725
|
# @param w [Integer]
|
1688
1726
|
# @param h [Integer]
|
1689
|
-
# @return [
|
1727
|
+
# @return [Boolean]
|
1690
1728
|
# @overload is_exposed(rect)
|
1691
1729
|
# This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
1692
1730
|
# @param rect [Wx::Rect]
|
1693
|
-
# @return [
|
1731
|
+
# @return [Boolean]
|
1694
1732
|
def is_exposed(*args) end
|
1695
1733
|
alias_method :exposed?, :is_exposed
|
1696
1734
|
|
1697
1735
|
# Returns true if the window is shown, false if it has been hidden.
|
1698
1736
|
#
|
1699
1737
|
# @see Wx::Window#is_shown_on_screen
|
1700
|
-
# @return [
|
1738
|
+
# @return [Boolean]
|
1701
1739
|
def is_shown; end
|
1702
1740
|
alias_method :shown?, :is_shown
|
1703
1741
|
|
1704
1742
|
# Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well.
|
1705
1743
|
#
|
1706
1744
|
# @see Wx::Window#is_shown
|
1707
|
-
# @return [
|
1745
|
+
# @return [Boolean]
|
1708
1746
|
def is_shown_on_screen; end
|
1709
1747
|
alias_method :shown_on_screen?, :is_shown_on_screen
|
1710
1748
|
|
1711
1749
|
# Disables the window.
|
1712
1750
|
# Same as {Wx::Window#enable} Enable(false).
|
1713
1751
|
# Returns true if the window has been disabled, false if it had been already disabled before the call to this function.
|
1714
|
-
# @return [
|
1752
|
+
# @return [Boolean]
|
1715
1753
|
def disable; end
|
1716
1754
|
|
1717
1755
|
# Enable or disable the window for user input.
|
1718
1756
|
# Note that when a parent window is disabled, all of its children are disabled as well and they are re-enabled again when the parent is.
|
1719
1757
|
# A window can be created initially disabled by calling this method on it before calling {Wx::Window#create} to create the actual underlying window, e.g.
|
1720
|
-
# ```
|
1721
|
-
#
|
1722
|
-
# w
|
1723
|
-
# w
|
1758
|
+
# ```ruby
|
1759
|
+
# w = MyWindow.new # Note: default ctor is used here.
|
1760
|
+
# w.enable(false)
|
1761
|
+
# w.create(parent, ... all the usual non-default ctor arguments ...)
|
1724
1762
|
# ```
|
1725
1763
|
#
|
1726
1764
|
# Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.
|
1727
1765
|
# @see Wx::Window#is_enabled
|
1728
1766
|
# @see Wx::Window#disable
|
1729
1767
|
# @see Wx::RadioBox#enable
|
1730
|
-
# @param enable [
|
1731
|
-
# @return [
|
1768
|
+
# @param enable [Boolean] If true, enables the window for input. If false, disables the window.
|
1769
|
+
# @return [Boolean]
|
1732
1770
|
def enable(enable=true) end
|
1733
1771
|
|
1734
1772
|
# Shows or hides the window.
|
@@ -1740,16 +1778,16 @@ module Wx
|
|
1740
1778
|
# @see Wx::Window#hide
|
1741
1779
|
# @see Wx::RadioBox#show
|
1742
1780
|
# @see Wx::ShowEvent.
|
1743
|
-
# @param show [
|
1744
|
-
# @return [
|
1781
|
+
# @param show [Boolean] If true displays the window. Otherwise, hides it.
|
1782
|
+
# @return [Boolean]
|
1745
1783
|
def show(show=true) end
|
1746
1784
|
|
1747
1785
|
# This function shows a window, like {Wx::Window#show}, but using a special visual effect if possible.
|
1748
|
-
# Currently this function is only implemented in
|
1786
|
+
# Currently this function is only implemented in wxMSW and wxOSX and does the same thing as {Wx::Window#show} in the other ports.
|
1749
1787
|
# @see Wx::Window#hide_with_effect
|
1750
|
-
# @param effect [ShowEffect] The effect to use.
|
1788
|
+
# @param effect [Wx::ShowEffect] The effect to use.
|
1751
1789
|
# @param timeout [Integer] The timeout parameter specifies the time of the animation, in milliseconds. If the default value of 0 is used, the default animation time for the current platform is used.
|
1752
|
-
# @return [
|
1790
|
+
# @return [Boolean]
|
1753
1791
|
def show_with_effect(effect, timeout=0) end
|
1754
1792
|
|
1755
1793
|
# Gets the help text to be used as context-sensitive help for this window.
|
@@ -1773,7 +1811,7 @@ module Wx
|
|
1773
1811
|
# Gets the help text to be used as context-sensitive help for this window.
|
1774
1812
|
# This method should be overridden if the help message depends on the position inside the window, otherwise {Wx::Window#get_help_text} can be used.
|
1775
1813
|
# @param point [Array(Integer, Integer), Wx::Point] Coordinates of the mouse at the moment of help event emission.
|
1776
|
-
# @param origin [Wx::
|
1814
|
+
# @param origin [Wx::wxHelpEvent::Origin] Help event origin, see also {Wx::HelpEvent#get_origin}.
|
1777
1815
|
# @return [String]
|
1778
1816
|
def get_help_text_at_point(point, origin) end
|
1779
1817
|
alias_method :help_text_at_point, :get_help_text_at_point
|
@@ -1813,7 +1851,7 @@ module Wx
|
|
1813
1851
|
# This function shows a popup menu at the given position in this window and returns the selected id.
|
1814
1852
|
# It can be more convenient than the general purpose {Wx::Window#popup_menu} function for simple menus proposing a choice in a list of strings to the user.
|
1815
1853
|
# Notice that to avoid unexpected conflicts between the (usually consecutive range of) ids used by the menu passed to this function and the existing EVT_UPDATE_UI() handlers, this function temporarily disables UI updates for the window, so you need to manually disable (or toggle or ...) any items which should be disabled in the menu before showing it.
|
1816
|
-
# The parameter menu is the menu to show. The parameter pos (or the parameters x and y) is the position at which to show the menu in client coordinates. It is recommended to not explicitly specify coordinates when calling this method in response to mouse click, because some of the ports (namely,
|
1854
|
+
# The parameter menu is the menu to show. The parameter pos (or the parameters x and y) is the position at which to show the menu in client coordinates. It is recommended to not explicitly specify coordinates when calling this method in response to mouse click, because some of the ports (namely, wxGTK) can do a better job of positioning the menu in that case.
|
1817
1855
|
# The selected menu item id or {Wx::StandardID::ID_NONE} if none selected or an error occurred.
|
1818
1856
|
# @param menu [Wx::Menu]
|
1819
1857
|
# @param pos [Array(Integer, Integer), Wx::Point]
|
@@ -1833,17 +1871,17 @@ module Wx
|
|
1833
1871
|
# menu is the menu to pop up.
|
1834
1872
|
# The position where the menu will appear can be specified either as a {Wx::Point} pos or by two integers (x and y).
|
1835
1873
|
# Note that this function switches focus to this window before showing the menu.
|
1836
|
-
# Just before the menu is popped up, {Wx::Menu::UpdateUI} is called to ensure that the menu items are in the correct state. The menu does not get deleted by the window. It is recommended to not explicitly specify coordinates when calling PopupMenu in response to mouse click, because some of the ports (namely,
|
1874
|
+
# Just before the menu is popped up, {Wx::Menu::UpdateUI} is called to ensure that the menu items are in the correct state. The menu does not get deleted by the window. It is recommended to not explicitly specify coordinates when calling PopupMenu in response to mouse click, because some of the ports (namely, wxGTK) can do a better job of positioning the menu in that case.
|
1837
1875
|
# @see Wx::Menu
|
1838
1876
|
# @param menu [Wx::Menu]
|
1839
1877
|
# @param pos [Array(Integer, Integer), Wx::Point]
|
1840
|
-
# @return [
|
1878
|
+
# @return [Boolean]
|
1841
1879
|
# @overload popup_menu(menu, x, y)
|
1842
1880
|
# This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
1843
1881
|
# @param menu [Wx::Menu]
|
1844
1882
|
# @param x [Integer]
|
1845
1883
|
# @param y [Integer]
|
1846
|
-
# @return [
|
1884
|
+
# @return [Boolean]
|
1847
1885
|
def popup_menu(*args) end
|
1848
1886
|
|
1849
1887
|
# Validator functions.
|
@@ -1864,7 +1902,7 @@ module Wx
|
|
1864
1902
|
# @see Wx::Window#transfer_data_from_window
|
1865
1903
|
# @see Wx::Window#transfer_data_to_window
|
1866
1904
|
# @see Wx::Validator
|
1867
|
-
# @return [
|
1905
|
+
# @return [Boolean]
|
1868
1906
|
def validate; end
|
1869
1907
|
|
1870
1908
|
# Returns the identifier of the window.
|
@@ -1882,7 +1920,7 @@ module Wx
|
|
1882
1920
|
alias_method :label, :get_label
|
1883
1921
|
|
1884
1922
|
# Returns the layout direction for this window, Note that {Wx::LayoutDirection::Layout_Default} is returned if layout direction is not supported.
|
1885
|
-
# @return [LayoutDirection]
|
1923
|
+
# @return [Wx::LayoutDirection]
|
1886
1924
|
def get_layout_direction; end
|
1887
1925
|
alias_method :layout_direction, :get_layout_direction
|
1888
1926
|
|
@@ -1901,7 +1939,7 @@ module Wx
|
|
1901
1939
|
alias_method :name, :get_name
|
1902
1940
|
|
1903
1941
|
# Returns the value previously passed to {Wx::Window#set_window_variant}.
|
1904
|
-
# @return [WindowVariant]
|
1942
|
+
# @return [Wx::WindowVariant]
|
1905
1943
|
def get_window_variant; end
|
1906
1944
|
alias_method :window_variant, :get_window_variant
|
1907
1945
|
|
@@ -1924,7 +1962,7 @@ module Wx
|
|
1924
1962
|
|
1925
1963
|
# Sets the layout direction for this window.
|
1926
1964
|
# This function is only supported under MSW and GTK platforms, but not under Mac currently.
|
1927
|
-
# @param dir [LayoutDirection]
|
1965
|
+
# @param dir [Wx::LayoutDirection]
|
1928
1966
|
# @return [void]
|
1929
1967
|
def set_layout_direction(dir) end
|
1930
1968
|
alias_method :layout_direction=, :set_layout_direction
|
@@ -1940,7 +1978,7 @@ module Wx
|
|
1940
1978
|
# Chooses a different variant of the window display to use.
|
1941
1979
|
# Window variants currently just differ in size, as can be seen from {Wx::WindowVariant} documentation. Under all platforms but macOS, this function does nothing more than change the font used by the window. However under macOS it is implemented natively and selects the appropriate variant of the native widget, which has better appearance than just scaled down or up version of the normal variant, so it should be preferred to directly tweaking the font size.
|
1942
1980
|
# By default the controls naturally use the normal variant.
|
1943
|
-
# @param variant [WindowVariant]
|
1981
|
+
# @param variant [Wx::WindowVariant]
|
1944
1982
|
# @return [void]
|
1945
1983
|
def set_window_variant(variant) end
|
1946
1984
|
alias_method :window_variant=, :set_window_variant
|
@@ -1974,20 +2012,20 @@ module Wx
|
|
1974
2012
|
# @see Window Deletion Overview
|
1975
2013
|
# @see Wx::Window#destroy
|
1976
2014
|
# @see Wx::CloseEvent
|
1977
|
-
# @param force [
|
1978
|
-
# @return [
|
2015
|
+
# @param force [Boolean] false if the window's close handler should be able to veto the destruction of this window, true if it cannot.
|
2016
|
+
# @return [Boolean]
|
1979
2017
|
def close(force=false) end
|
1980
2018
|
|
1981
2019
|
# Destroys the window safely.
|
1982
2020
|
# Use this function instead of the delete operator, since different window classes can be destroyed differently. Frames and dialogs are not destroyed immediately when this function is called they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows.
|
1983
2021
|
# true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
|
1984
|
-
# @return [
|
2022
|
+
# @return [Boolean]
|
1985
2023
|
def destroy; end
|
1986
2024
|
|
1987
2025
|
# Returns true if this window is in process of being destroyed.
|
1988
2026
|
# Top level windows are not deleted immediately but are rather scheduled for later destruction to give them time to process any pending messages; see {Wx::Window#destroy} description.
|
1989
2027
|
# This function returns true if this window, or one of its parent windows, is scheduled for destruction and can be useful to avoid manipulating it as it's usually useless to do something with a window which is at the point of disappearing anyhow.
|
1990
|
-
# @return [
|
2028
|
+
# @return [Boolean]
|
1991
2029
|
def is_being_deleted; end
|
1992
2030
|
alias_method :being_deleted?, :is_being_deleted
|
1993
2031
|
|
@@ -2011,7 +2049,7 @@ module Wx
|
|
2011
2049
|
# Enables or disables eligibility for drop file events (OnDropFiles).
|
2012
2050
|
# Windows only until version 2.8.9, available on all platforms since 2.8.10. Cannot be used together with {Wx::Window#set_drop_target} on non-Windows platforms.
|
2013
2051
|
# @see Wx::Window#set_drop_target
|
2014
|
-
# @param accept [
|
2052
|
+
# @param accept [Boolean] If true, the window is eligible for drop file events. If false, the window will not accept drop file events.
|
2015
2053
|
# @return [void]
|
2016
2054
|
def drag_accept_files(accept) end
|
2017
2055
|
|
@@ -2042,32 +2080,27 @@ module Wx
|
|
2042
2080
|
def set_sizer_and_fit(sizer) end
|
2043
2081
|
alias_method :sizer_and_fit=, :set_sizer_and_fit
|
2044
2082
|
|
2045
|
-
# Returns a pointer to the window's layout constraints, or NULL if there are none.
|
2046
|
-
# @return [Wx::LayoutConstraints]
|
2047
|
-
def get_constraints; end
|
2048
|
-
alias_method :constraints, :get_constraints
|
2049
|
-
|
2050
2083
|
# Lays out the children of this window using the associated sizer.
|
2051
2084
|
# If a sizer hadn't been associated with this window (see {Wx::Window#set_sizer}), this function doesn't do anything, unless this is a top level window (see {Wx::TopLevelWindow#layout}).
|
2052
2085
|
# Note that this method is called automatically when the window size changes if it has the associated sizer (or if {Wx::Window#set_auto_layout} with true argument had been explicitly called), ensuring that it is always laid out correctly.
|
2053
2086
|
#
|
2054
2087
|
# Always returns true, the return value is not useful.
|
2055
2088
|
# @see Window Sizing Overview
|
2056
|
-
# @return [
|
2089
|
+
# @return [Boolean]
|
2057
2090
|
def layout; end
|
2058
2091
|
|
2059
2092
|
# Determines whether the {Wx::Window#layout} function will be called automatically when the window is resized.
|
2060
2093
|
# This method is called implicitly by {Wx::Window#set_sizer} but if you use {Wx::Window#set_constraints} you should call it manually or otherwise the window layout won't be correctly updated when its size changes.
|
2061
2094
|
# @see Wx::Window#set_sizer
|
2062
2095
|
# @see Wx::Window#set_constraints
|
2063
|
-
# @param autoLayout [
|
2096
|
+
# @param autoLayout [Boolean] Set this to true if you wish the {Wx::Window#layout} function to be called automatically when the window is resized.
|
2064
2097
|
# @return [void]
|
2065
2098
|
def set_auto_layout(autoLayout) end
|
2066
2099
|
alias_method :auto_layout=, :set_auto_layout
|
2067
2100
|
|
2068
2101
|
# Returns true if {Wx::Window#layout} is called automatically when the window is resized.
|
2069
2102
|
# This function is mostly useful for wxWidgets itself and is rarely needed in the application code.
|
2070
|
-
# @return [
|
2103
|
+
# @return [Boolean]
|
2071
2104
|
def get_auto_layout; end
|
2072
2105
|
alias_method :auto_layout, :get_auto_layout
|
2073
2106
|
|
@@ -2098,7 +2131,7 @@ module Wx
|
|
2098
2131
|
# @see Wx::Window#release_mouse
|
2099
2132
|
# @see Wx::MouseCaptureLostEvent
|
2100
2133
|
# @see Wx::MouseCaptureChangedEvent
|
2101
|
-
# @return [
|
2134
|
+
# @return [Boolean]
|
2102
2135
|
def has_capture; end
|
2103
2136
|
alias_method :has_capture?, :has_capture
|
2104
2137
|
|
@@ -2124,7 +2157,7 @@ module Wx
|
|
2124
2157
|
# @see Wx::SetCursor
|
2125
2158
|
# @see Wx::Cursor
|
2126
2159
|
# @param cursor [Wx::Cursor] Specifies the cursor that the window should normally display.
|
2127
|
-
# @return [
|
2160
|
+
# @return [Boolean]
|
2128
2161
|
def set_cursor(cursor) end
|
2129
2162
|
alias_method :cursor=, :set_cursor
|
2130
2163
|
|
@@ -2137,14 +2170,14 @@ module Wx
|
|
2137
2170
|
|
2138
2171
|
# Request generation of touch events for this window.
|
2139
2172
|
# Each call to this function supersedes the previous ones, i.e. if you want to receive events for both zoom and rotate gestures, you need to call
|
2140
|
-
# ```
|
2141
|
-
#
|
2173
|
+
# ```ruby
|
2174
|
+
# enable_touch_events(Wx::TOUCH_ZOOM_GESTURE | Wx::TOUCH_ROTATE_GESTURE)
|
2142
2175
|
# ```
|
2143
2176
|
# instead of calling it twice in a row as the second call would disable the first gesture.
|
2144
2177
|
#
|
2145
2178
|
# true if the specified events were enabled or false if the current platform doesn't support touch events.
|
2146
2179
|
# @param eventsMask [Integer] Either {Wx::TOUCH_NONE} or {Wx::TOUCH_ALL_GESTURES} to disable or enable gesture events for this window.
|
2147
|
-
# @return [
|
2180
|
+
# @return [Boolean]
|
2148
2181
|
def enable_touch_events(eventsMask) end
|
2149
2182
|
|
2150
2183
|
# @overload hit_test(x, y)
|
@@ -2153,39 +2186,39 @@ module Wx
|
|
2153
2186
|
# The point coordinates are specified in client window coordinates.
|
2154
2187
|
# @param x [Integer]
|
2155
2188
|
# @param y [Integer]
|
2156
|
-
# @return [HitTest]
|
2189
|
+
# @return [Wx::HitTest]
|
2157
2190
|
# @overload hit_test(pt)
|
2158
2191
|
# This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
2159
2192
|
# @param pt [Array(Integer, Integer), Wx::Point]
|
2160
|
-
# @return [HitTest]
|
2193
|
+
# @return [Wx::HitTest]
|
2161
2194
|
def hit_test(*args) end
|
2162
2195
|
|
2163
2196
|
# @overload get_border(flags)
|
2164
2197
|
# Get the window border style from the given flags: this is different from simply doing flags & {Wx::Border::BORDER_MASK} because it uses GetDefaultBorder() to translate {Wx::Border::BORDER_DEFAULT} to something reasonable.
|
2165
2198
|
# @param flags [Integer]
|
2166
|
-
# @return [Border]
|
2199
|
+
# @return [Wx::Border]
|
2167
2200
|
# @overload get_border()
|
2168
2201
|
# Get border for the flags of this window.
|
2169
|
-
# @return [Border]
|
2202
|
+
# @return [Wx::Border]
|
2170
2203
|
def get_border(*args) end
|
2171
2204
|
alias_method :border, :get_border
|
2172
2205
|
|
2173
2206
|
# Does the window-specific updating after processing the update event.
|
2174
2207
|
# This function is called by {Wx::Window#update_window_ui} in order to check return values in the {Wx::UpdateUIEvent} and act appropriately. For example, to allow frame and dialog title updating, wxWidgets implements this function as follows:
|
2175
2208
|
#
|
2176
|
-
# ```
|
2177
|
-
#
|
2178
|
-
#
|
2179
|
-
#
|
2180
|
-
#
|
2181
|
-
#
|
2209
|
+
# ```ruby
|
2210
|
+
# # do the window-specific processing after processing the update event
|
2211
|
+
# def Wx::TopLevelWindow.do_update_window_ui(event)
|
2212
|
+
# if event.get_set_enabled
|
2213
|
+
# enable(event.get_enabled)
|
2214
|
+
# end
|
2182
2215
|
#
|
2183
|
-
#
|
2184
|
-
#
|
2185
|
-
#
|
2186
|
-
#
|
2187
|
-
#
|
2188
|
-
#
|
2216
|
+
# if event.get_set_text
|
2217
|
+
# if event.get_text != get_title
|
2218
|
+
# set_title(event.get_text)
|
2219
|
+
# end
|
2220
|
+
# end
|
2221
|
+
# end
|
2189
2222
|
# ```
|
2190
2223
|
# @param event [Wx::UpdateUIEvent]
|
2191
2224
|
# @return [void]
|
@@ -2193,7 +2226,7 @@ module Wx
|
|
2193
2226
|
|
2194
2227
|
# This method should be overridden to return true if this window has multiple pages.
|
2195
2228
|
# All standard class with multiple pages such as {Wx::Notebook}, {Wx::Listbook} and {Wx::Treebook} already override it to return true and user-defined classes with similar behaviour should also do so, to allow the library to handle such windows appropriately.
|
2196
|
-
# @return [
|
2229
|
+
# @return [Boolean]
|
2197
2230
|
def has_multiple_pages; end
|
2198
2231
|
alias_method :has_multiple_pages?, :has_multiple_pages
|
2199
2232
|
|
@@ -2210,31 +2243,31 @@ module Wx
|
|
2210
2243
|
# Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later.
|
2211
2244
|
#
|
2212
2245
|
# @see Wx::BufferedDC
|
2213
|
-
# @return [
|
2246
|
+
# @return [Boolean]
|
2214
2247
|
def is_double_buffered; end
|
2215
2248
|
alias_method :double_buffered?, :is_double_buffered
|
2216
2249
|
|
2217
2250
|
# Turn on or off double buffering of the window if the system supports it.
|
2218
|
-
# @param on [
|
2251
|
+
# @param on [Boolean]
|
2219
2252
|
# @return [void]
|
2220
2253
|
def set_double_buffered(on) end
|
2221
2254
|
alias_method :double_buffered=, :set_double_buffered
|
2222
2255
|
|
2223
2256
|
# Returns true if the window is retained, false otherwise.
|
2224
2257
|
# Retained windows are only available on X platforms.
|
2225
|
-
# @return [
|
2258
|
+
# @return [Boolean]
|
2226
2259
|
def is_retained; end
|
2227
2260
|
alias_method :retained?, :is_retained
|
2228
2261
|
|
2229
2262
|
# Returns true if this window is intrinsically enabled, false otherwise, i.e. if {Wx::Window#enable} Enable(false) had been called.
|
2230
2263
|
# This method is mostly used for wxWidgets itself, user code should normally use {Wx::Window#is_enabled} instead.
|
2231
|
-
# @return [
|
2264
|
+
# @return [Boolean]
|
2232
2265
|
def is_this_enabled; end
|
2233
2266
|
alias_method :this_enabled?, :is_this_enabled
|
2234
2267
|
|
2235
2268
|
# Returns true if the given window is a top-level one.
|
2236
2269
|
# Currently all frames and dialogs are considered to be top-level windows (even if they have a parent window).
|
2237
|
-
# @return [
|
2270
|
+
# @return [Boolean]
|
2238
2271
|
def is_top_level; end
|
2239
2272
|
alias_method :top_level?, :is_top_level
|
2240
2273
|
|
@@ -2254,7 +2287,7 @@ module Wx
|
|
2254
2287
|
# @param hotkeyId [Integer] Numeric identifier of the hotkey. For applications this must be between 0 and 0xBFFF. If this function is called from a shared DLL, it must be a system wide unique identifier between 0xC000 and 0xFFFF. This is a MSW specific detail.
|
2255
2288
|
# @param modifiers [Integer] A bitwise combination of {Wx::KeyModifier::MOD_SHIFT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_ALT} or {Wx::KeyModifier::MOD_WIN} specifying the modifier keys that have to be pressed along with the key.
|
2256
2289
|
# @param virtualKeyCode [Integer] The key code of the hotkey, e.g. an ASCII character such as <code>'K'</code> or one of elements of {Wx::KeyCode} enum.
|
2257
|
-
# @return [
|
2290
|
+
# @return [Boolean]
|
2258
2291
|
def register_hot_key(hotkeyId, modifiers, virtualKeyCode) end
|
2259
2292
|
|
2260
2293
|
# Unregisters a system wide hotkey.
|
@@ -2263,7 +2296,7 @@ module Wx
|
|
2263
2296
|
# This function is currently only implemented under MSW.
|
2264
2297
|
# @see Wx::Window#register_hot_key
|
2265
2298
|
# @param hotkeyId [Integer] Numeric identifier of the hotkey. Must be the same id that was passed to {Wx::Window#register_hot_key}.
|
2266
|
-
# @return [
|
2299
|
+
# @return [Boolean]
|
2267
2300
|
def unregister_hot_key(hotkeyId) end
|
2268
2301
|
|
2269
2302
|
# This function sends one or more {Wx::UpdateUIEvent} to the window.
|
@@ -2271,12 +2304,14 @@ module Wx
|
|
2271
2304
|
# You can call this function from your application to ensure that your UI is up-to-date at this point (as far as your {Wx::UpdateUIEvent} handlers are concerned). This may be necessary if you have called {Wx::UpdateUIEvent.set_mode} or {Wx::UpdateUIEvent.set_update_interval} to limit the overhead that wxWidgets incurs by sending update UI events in idle time. flags should be a bitlist of one or more of the {Wx::UpdateUI} enumeration.
|
2272
2305
|
# If you are calling this function from an OnInternalIdle or OnIdle function, make sure you pass the {Wx::UpdateUI::UPDATE_UI_FROMIDLE} flag, since this tells the window to only update the UI elements that need to be updated in idle time. Some windows update their elements only when necessary, for example when a menu is about to be shown. The following is an example of how to call UpdateWindowUI from an idle function.
|
2273
2306
|
#
|
2274
|
-
# ```
|
2275
|
-
#
|
2276
|
-
#
|
2277
|
-
#
|
2278
|
-
#
|
2279
|
-
#
|
2307
|
+
# ```ruby
|
2308
|
+
# class MyWindow
|
2309
|
+
# ...
|
2310
|
+
# def on_internal_idle
|
2311
|
+
# update_window_ui(Wx::UPDATE_UI_FROMIDLE) if Wx::UpdateUIEvent.can_update(self)
|
2312
|
+
# end
|
2313
|
+
# ...
|
2314
|
+
# end
|
2280
2315
|
# ```
|
2281
2316
|
# @see Wx::UpdateUIEvent
|
2282
2317
|
# @see Wx::Window#do_update_window_ui
|
@@ -2291,7 +2326,7 @@ module Wx
|
|
2291
2326
|
# This static method is "overridden" in many derived classes and so calling, for example, {Wx::Button#get_class_default_attributes} will typically return the values appropriate for a button which will be normally different from those returned by, say, {Wx::ListCtrl#get_class_default_attributes}.
|
2292
2327
|
# The {Wx::VisualAttributes} structure has at least the fields font, colFg and colBg. All of them may be invalid if it was not possible to determine the default control appearance or, especially for the background colour, if the field doesn't make sense as is the case for colBg for the controls with themed background.
|
2293
2328
|
# @see Wx::Window#inherit_attributes
|
2294
|
-
# @param variant [WindowVariant]
|
2329
|
+
# @param variant [Wx::WindowVariant]
|
2295
2330
|
# @return [Wx::VisualAttributes]
|
2296
2331
|
def self.get_class_default_attributes(variant=Wx::WindowVariant::WINDOW_VARIANT_NORMAL) end
|
2297
2332
|
|
@@ -2367,7 +2402,7 @@ module Wx
|
|
2367
2402
|
|
2368
2403
|
# @overload initialize()
|
2369
2404
|
# Default constructor.
|
2370
|
-
# @return [Window]
|
2405
|
+
# @return [Wx::Window]
|
2371
2406
|
# @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PanelNameStr)
|
2372
2407
|
# Constructs a window, which can be a child of a frame, dialog or any other non-control window.
|
2373
2408
|
# @param parent [Wx::Window] Pointer to a parent window.
|
@@ -2376,41 +2411,51 @@ module Wx
|
|
2376
2411
|
# @param size [Array(Integer, Integer), Wx::Size] Window size. {Wx::DEFAULT_SIZE} indicates that wxWidgets should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized.
|
2377
2412
|
# @param style [Integer] Window style. For generic window styles, please see {Wx::Window}.
|
2378
2413
|
# @param name [String] Window name.
|
2379
|
-
# @return [Window]
|
2414
|
+
# @return [Wx::Window]
|
2380
2415
|
def initialize(*args) end
|
2381
2416
|
|
2382
2417
|
# Construct the actual window object after creating the C++ object.
|
2383
2418
|
# The non-default constructor of {Wx::Window} class does two things: it initializes the C++ object and it also creates the window object in the underlying graphical toolkit. The {Wx::Window#create} method can be used to perform the second part later, while the default constructor can be used to perform the first part only.
|
2384
2419
|
# Please note that the underlying window must be created exactly once, i.e. if you use the default constructor, which doesn't do this, you must call {Wx::Window#create} before using the window and if you use the non-default constructor, you can not call {Wx::Window#create}, as the underlying window is already created.
|
2385
2420
|
# Note that it is possible and, in fact, useful, to call some methods on the object between creating the C++ object itself and calling {Wx::Window#create} on it, e.g. a common pattern to avoid showing the contents of a window before it is fully initialized is:
|
2386
|
-
# ```
|
2387
|
-
#
|
2388
|
-
# panel
|
2389
|
-
# panel
|
2421
|
+
# ```ruby
|
2422
|
+
# panel = Wx::Panel.new # Note: default constructor used.
|
2423
|
+
# panel.hide # Can be called before actually creating it.
|
2424
|
+
# panel.create(parent, Wx::ID_ANY, ...) # Won't be shown yet.
|
2390
2425
|
# ... create all the panel children ...
|
2391
|
-
# panel
|
2426
|
+
# panel.show # Now everything will be shown at once.
|
2392
2427
|
# ```
|
2393
2428
|
#
|
2394
2429
|
# Also note that it is possible to create an object of a derived type and then call {Wx::Window#create} on it:
|
2395
|
-
# ```
|
2396
|
-
#
|
2397
|
-
#
|
2398
|
-
#
|
2399
|
-
#
|
2400
|
-
#
|
2430
|
+
# ```ruby
|
2431
|
+
# # Suppose we have this function (which would typically be in a
|
2432
|
+
# # different file from the rest of the code).
|
2433
|
+
# def my_create_window_object_function
|
2434
|
+
# MyCustomClassDerivingFromWindow.new
|
2435
|
+
# end
|
2401
2436
|
#
|
2402
|
-
#
|
2403
|
-
#
|
2404
|
-
#
|
2437
|
+
# # Then we can create a window of MyCustomClassDerivingFromWindow
|
2438
|
+
# # class without really knowing about this type, as we would have
|
2439
|
+
# # to do if we wanted to use the non-default constructor, like this:
|
2405
2440
|
#
|
2406
|
-
#
|
2407
|
-
#
|
2441
|
+
# # First create the C++ object using the factory function.
|
2442
|
+
# window = my_create_window_object_function
|
2408
2443
|
#
|
2409
|
-
#
|
2410
|
-
#
|
2411
|
-
#
|
2412
|
-
#
|
2413
|
-
#
|
2444
|
+
# # And now create the underlying window.
|
2445
|
+
# #
|
2446
|
+
# # This should call the base Wx::Window#create.
|
2447
|
+
# # In C++ (wxWidgets) this method is not virtual and cannot be overloaded
|
2448
|
+
# # so the derived class can't customize this part.
|
2449
|
+
# # In wxRuby however this method can be overloaded as long as the following
|
2450
|
+
# # is kept in mind:
|
2451
|
+
# # 1. the overloaded version will **NOT** be called when using a non-default
|
2452
|
+
# # constructor (Create will than be called from C++ which will always be
|
2453
|
+
# # the base Wx::Window version);
|
2454
|
+
# # 2. when calling the overloaded version from Ruby understand that the window
|
2455
|
+
# # will not actually be created until after the `super` version has been called.
|
2456
|
+
# # In general it's best not to overload this method but to define a different method
|
2457
|
+
# # if a custom initializer is needed.
|
2458
|
+
# window.create(parent, Wx::ID_ANY, ...)
|
2414
2459
|
# ```
|
2415
2460
|
# This is notably used by XML Based Resource System (XRC).
|
2416
2461
|
# The parameters of this method have exactly the same meaning as the non-default constructor parameters, please refer to them for their description.
|
@@ -2421,10 +2466,55 @@ module Wx
|
|
2421
2466
|
# @param size [Array(Integer, Integer), Wx::Size]
|
2422
2467
|
# @param style [Integer]
|
2423
2468
|
# @param name [String]
|
2424
|
-
# @return [
|
2469
|
+
# @return [Boolean]
|
2425
2470
|
def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PanelNameStr) end
|
2426
2471
|
|
2427
2472
|
end # Window
|
2428
2473
|
|
2474
|
+
# Struct containing all the visual attributes of a control.
|
2475
|
+
#
|
2476
|
+
#
|
2477
|
+
#
|
2478
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
2479
|
+
class VisualAttributes < ::Object
|
2480
|
+
|
2481
|
+
# The font used for control label/text inside it.
|
2482
|
+
#
|
2483
|
+
#
|
2484
|
+
# @return [Wx::Font]
|
2485
|
+
def font; end
|
2486
|
+
# The font used for control label/text inside it.
|
2487
|
+
#
|
2488
|
+
#
|
2489
|
+
# @param val [Wx::Font]
|
2490
|
+
# @return [void]
|
2491
|
+
def font=(val); end
|
2492
|
+
|
2493
|
+
# The foreground colour.
|
2494
|
+
#
|
2495
|
+
#
|
2496
|
+
# @return [Wx::Colour]
|
2497
|
+
def col_fg; end
|
2498
|
+
# The foreground colour.
|
2499
|
+
#
|
2500
|
+
#
|
2501
|
+
# @param val [Wx::Colour]
|
2502
|
+
# @return [void]
|
2503
|
+
def col_fg=(val); end
|
2504
|
+
|
2505
|
+
# The background colour.
|
2506
|
+
# May be {Wx::NULL_COLOUR} if the controls background colour is not solid.
|
2507
|
+
#
|
2508
|
+
# @return [Wx::Colour]
|
2509
|
+
def col_bg; end
|
2510
|
+
# The background colour.
|
2511
|
+
# May be {Wx::NULL_COLOUR} if the controls background colour is not solid.
|
2512
|
+
#
|
2513
|
+
# @param val [Wx::Colour]
|
2514
|
+
# @return [void]
|
2515
|
+
def col_bg=(val); end
|
2516
|
+
|
2517
|
+
end # VisualAttributes
|
2518
|
+
|
2429
2519
|
|
2430
2520
|
end
|