wxruby3 0.9.0-x64-mingw-ucrt → 0.9.2-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/.yardopts +1 -0
- 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/aui/aui_tab_ctrl.rb +18 -0
- data/lib/wx/aui/auinotebook.rb +6 -2
- data/lib/wx/aui/require.rb +1 -0
- data/lib/wx/core/app.rb +2 -2
- data/lib/wx/core/collapsible_pane.rb +1 -1
- data/lib/wx/core/const.rb +83 -0
- data/lib/wx/core/controlwithitems.rb +8 -6
- data/lib/wx/core/events/evt_list.rb +24 -0
- data/lib/wx/core/menu.rb +10 -0
- data/lib/wx/core/notebook.rb +6 -2
- data/lib/wx/core/sizer.rb +11 -0
- data/lib/wx/core/task_bar_button.rb +19 -0
- data/lib/wx/core/textctrl.rb +11 -1
- data/lib/wx/core/{treectrl.rb → tree_ctrl.rb} +31 -12
- data/lib/wx/core/window.rb +10 -0
- data/lib/wx/doc/app.rb +48 -38
- data/lib/wx/doc/art_locator.rb +47 -43
- data/lib/wx/doc/aui/auimanager.rb +16 -8
- data/lib/wx/doc/aui/auinotebook.rb +20 -5
- data/lib/wx/doc/clipboard.rb +11 -7
- data/lib/wx/doc/colour_dialog.rb +14 -10
- data/lib/wx/doc/const.rb +66 -66
- data/lib/wx/doc/controlwithitems.rb +17 -7
- data/lib/wx/doc/data_object.rb +2 -2
- data/lib/wx/doc/event.rb +0 -6
- data/lib/wx/doc/evthandler.rb +113 -108
- data/lib/wx/doc/font.rb +1 -0
- data/lib/wx/doc/functions.rb +9 -9
- data/lib/wx/doc/gc_dc.rb +6 -1
- data/lib/wx/doc/gen/about_dialog_info.rb +1 -2
- data/lib/wx/doc/gen/accelerator.rb +14 -5
- data/lib/wx/doc/gen/accessible.rb +35 -47
- data/lib/wx/doc/gen/activity_indicator.rb +6 -7
- data/lib/wx/doc/gen/animation.rb +7 -3
- data/lib/wx/doc/gen/animation_ctrl.rb +8 -9
- data/lib/wx/doc/gen/any_button.rb +6 -1
- data/lib/wx/doc/gen/app.rb +7 -5
- data/lib/wx/doc/gen/app_traits.rb +27 -10
- data/lib/wx/doc/gen/art_provider.rb +20 -8
- data/lib/wx/doc/gen/aui/aui_dock_art.rb +6 -3
- data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
- data/lib/wx/doc/gen/aui/aui_manager.rb +11 -7
- data/lib/wx/doc/gen/aui/aui_manager_event.rb +3 -4
- data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +3 -2
- data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +1 -0
- data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +8 -3
- data/lib/wx/doc/gen/aui/aui_notebook.rb +14 -8
- data/lib/wx/doc/gen/aui/aui_notebook_event.rb +4 -4
- data/lib/wx/doc/gen/aui/aui_pane_info.rb +9 -2
- data/lib/wx/doc/gen/aui/aui_tab_art.rb +3 -3
- data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +2 -2
- data/lib/wx/doc/gen/aui/aui_tool_bar.rb +9 -6
- data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -2
- data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +5 -8
- data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +1 -1
- data/lib/wx/doc/gen/aui/event_list.rb +164 -160
- data/lib/wx/doc/gen/banner_window.rb +3 -3
- data/lib/wx/doc/gen/bitmap.rb +34 -17
- data/lib/wx/doc/gen/bitmap_button.rb +13 -10
- data/lib/wx/doc/gen/bitmap_combo_box.rb +16 -12
- data/lib/wx/doc/gen/book_ctrl_base.rb +16 -4
- data/lib/wx/doc/gen/book_ctrl_event.rb +7 -3
- data/lib/wx/doc/gen/box_sizer.rb +0 -1
- data/lib/wx/doc/gen/brush.rb +5 -2
- data/lib/wx/doc/gen/busy_info.rb +2 -2
- data/lib/wx/doc/gen/button.rb +25 -13
- data/lib/wx/doc/gen/calculate_layout_event.rb +1 -3
- data/lib/wx/doc/gen/calendar_ctrl.rb +18 -15
- data/lib/wx/doc/gen/calendar_date_attr.rb +1 -1
- data/lib/wx/doc/gen/calendar_event.rb +4 -3
- data/lib/wx/doc/gen/caret.rb +0 -1
- data/lib/wx/doc/gen/check_box.rb +9 -9
- data/lib/wx/doc/gen/check_list_box.rb +8 -9
- data/lib/wx/doc/gen/choice.rb +18 -11
- data/lib/wx/doc/gen/choicebook.rb +6 -7
- data/lib/wx/doc/gen/client_dc.rb +5 -2
- data/lib/wx/doc/gen/clipboard.rb +7 -3
- data/lib/wx/doc/gen/collapsible_pane.rb +8 -9
- data/lib/wx/doc/gen/collapsible_pane_event.rb +2 -3
- data/lib/wx/doc/gen/colour.rb +8 -4
- data/lib/wx/doc/gen/colour_dialog.rb +6 -8
- data/lib/wx/doc/gen/colour_picker_ctrl.rb +11 -12
- data/lib/wx/doc/gen/colour_picker_event.rb +4 -5
- data/lib/wx/doc/gen/combo_box.rb +20 -17
- data/lib/wx/doc/gen/combo_ctrl.rb +100 -37
- data/lib/wx/doc/gen/command_link_button.rb +6 -7
- data/lib/wx/doc/gen/context_help_button.rb +7 -3
- data/lib/wx/doc/gen/control.rb +12 -10
- data/lib/wx/doc/gen/control_with_items.rb +0 -1
- data/lib/wx/doc/gen/core.rb +4 -4
- data/lib/wx/doc/gen/cursor.rb +6 -8
- data/lib/wx/doc/gen/data_format.rb +6 -1
- data/lib/wx/doc/gen/data_object.rb +16 -14
- data/lib/wx/doc/gen/date_event.rb +2 -2
- data/lib/wx/doc/gen/date_picker_ctrl.rb +14 -10
- data/lib/wx/doc/gen/dc.rb +155 -37
- data/lib/wx/doc/gen/defs.rb +54 -54
- data/lib/wx/doc/gen/dial_up_event.rb +41 -0
- data/lib/wx/doc/gen/dial_up_manager.rb +137 -0
- data/lib/wx/doc/gen/dialog.rb +35 -15
- data/lib/wx/doc/gen/dir_dialog.rb +17 -5
- data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
- data/lib/wx/doc/gen/dir_picker_ctrl.rb +11 -12
- data/lib/wx/doc/gen/drag_drop.rb +11 -10
- data/lib/wx/doc/gen/drag_image.rb +6 -2
- data/lib/wx/doc/gen/editable_list_box.rb +4 -4
- data/lib/wx/doc/gen/event.rb +42 -20
- data/lib/wx/doc/gen/event_blocker.rb +1 -3
- data/lib/wx/doc/gen/event_list.rb +1656 -1624
- data/lib/wx/doc/gen/events.rb +170 -181
- data/lib/wx/doc/gen/evt_handler.rb +11 -3
- data/lib/wx/doc/gen/ext_help_controller.rb +1 -1
- data/lib/wx/doc/gen/file_ctrl.rb +209 -0
- data/lib/wx/doc/gen/file_ctrl_event.rb +79 -0
- data/lib/wx/doc/gen/file_dialog.rb +32 -15
- data/lib/wx/doc/gen/file_dialog_custom_control.rb +7 -0
- data/lib/wx/doc/gen/file_dialog_customize_hook.rb +2 -3
- data/lib/wx/doc/gen/file_dir_picker_event.rb +3 -4
- data/lib/wx/doc/gen/file_picker_ctrl.rb +10 -11
- data/lib/wx/doc/gen/file_system.rb +38 -15
- data/lib/wx/doc/gen/find_dialog_event.rb +5 -4
- data/lib/wx/doc/gen/find_replace_data.rb +1 -1
- data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
- data/lib/wx/doc/gen/flex_grid_sizer.rb +0 -1
- data/lib/wx/doc/gen/font.rb +31 -20
- data/lib/wx/doc/gen/font_data.rb +3 -4
- data/lib/wx/doc/gen/font_dialog.rb +1 -2
- data/lib/wx/doc/gen/font_picker_ctrl.rb +8 -9
- data/lib/wx/doc/gen/font_picker_event.rb +2 -3
- data/lib/wx/doc/gen/frame.rb +60 -19
- data/lib/wx/doc/gen/fs_file.rb +17 -10
- data/lib/wx/doc/gen/gauge.rb +13 -10
- data/lib/wx/doc/gen/gb_sizer_item.rb +0 -1
- data/lib/wx/doc/gen/gcdc.rb +1 -2
- data/lib/wx/doc/gen/gdi_common.rb +30 -11
- data/lib/wx/doc/gen/gdi_object.rb +0 -1
- data/lib/wx/doc/gen/generic_dir_ctrl.rb +8 -9
- data/lib/wx/doc/gen/graphics_context.rb +59 -12
- data/lib/wx/doc/gen/graphics_object.rb +11 -6
- data/lib/wx/doc/gen/grid/event_list.rb +168 -164
- data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_cell_attr.rb +2 -1
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +2 -2
- data/lib/wx/doc/gen/grid/grid_cell_editor.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_ctrl.rb +29 -7
- data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +3 -4
- data/lib/wx/doc/gen/grid/grid_event.rb +3 -4
- data/lib/wx/doc/gen/grid/grid_range_select_event.rb +3 -4
- data/lib/wx/doc/gen/grid/grid_size_event.rb +3 -4
- data/lib/wx/doc/gen/grid/grid_string_table.rb +1 -0
- data/lib/wx/doc/gen/grid/grid_table_base.rb +1 -2
- data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
- data/lib/wx/doc/gen/grid_bag_sizer.rb +0 -6
- data/lib/wx/doc/gen/grid_sizer.rb +0 -1
- data/lib/wx/doc/gen/gui_event_loop.rb +2 -4
- data/lib/wx/doc/gen/header_ctrl.rb +7 -14
- data/lib/wx/doc/gen/header_ctrl_event.rb +1 -3
- data/lib/wx/doc/gen/help_controller.rb +42 -3
- data/lib/wx/doc/gen/help_provider.rb +12 -3
- data/lib/wx/doc/gen/html/event_list.rb +41 -37
- data/lib/wx/doc/gen/html/html_cell.rb +23 -6
- data/lib/wx/doc/gen/html/html_cell_event.rb +3 -4
- data/lib/wx/doc/gen/html/html_easy_printing.rb +8 -3
- data/lib/wx/doc/gen/html/html_help_controller.rb +47 -2
- data/lib/wx/doc/gen/html/html_help_data.rb +3 -1
- data/lib/wx/doc/gen/html/html_help_window.rb +1 -1
- data/lib/wx/doc/gen/html/html_link_event.rb +2 -3
- data/lib/wx/doc/gen/html/html_list_box.rb +10 -12
- data/lib/wx/doc/gen/html/html_printout.rb +1 -2
- data/lib/wx/doc/gen/html/html_window.rb +13 -7
- data/lib/wx/doc/gen/hyperlink_ctrl.rb +9 -9
- data/lib/wx/doc/gen/hyperlink_event.rb +2 -3
- data/lib/wx/doc/gen/icon.rb +5 -29
- data/lib/wx/doc/gen/icon_location.rb +0 -1
- data/lib/wx/doc/gen/image.rb +83 -17
- data/lib/wx/doc/gen/image_list.rb +15 -6
- data/lib/wx/doc/gen/info_bar.rb +2 -2
- data/lib/wx/doc/gen/keyboard_state.rb +0 -1
- data/lib/wx/doc/gen/list_box.rb +33 -21
- data/lib/wx/doc/gen/list_ctrl.rb +79 -32
- data/lib/wx/doc/gen/list_event.rb +3 -4
- data/lib/wx/doc/gen/listbook.rb +6 -7
- data/lib/wx/doc/gen/locale.rb +46 -4
- data/lib/wx/doc/gen/log.rb +16 -12
- data/lib/wx/doc/gen/mdi_client_window.rb +8 -2
- data/lib/wx/doc/gen/mdi_frame.rb +32 -11
- data/lib/wx/doc/gen/media_ctrl.rb +28 -20
- data/lib/wx/doc/gen/media_event.rb +5 -4
- data/lib/wx/doc/gen/memory_dc.rb +6 -6
- data/lib/wx/doc/gen/menu.rb +37 -23
- data/lib/wx/doc/gen/menu_bar.rb +52 -12
- data/lib/wx/doc/gen/menu_item.rb +117 -95
- data/lib/wx/doc/gen/message_dialog.rb +7 -8
- data/lib/wx/doc/gen/mini_frame.rb +13 -7
- data/lib/wx/doc/gen/mirror_dc.rb +0 -2
- data/lib/wx/doc/gen/mouse_state.rb +0 -1
- data/lib/wx/doc/gen/multi_choice_dialog.rb +7 -4
- data/lib/wx/doc/gen/non_owned_window.rb +1 -1
- data/lib/wx/doc/gen/notebook.rb +19 -11
- data/lib/wx/doc/gen/number_entry_dialog.rb +1 -1
- data/lib/wx/doc/gen/object.rb +0 -1
- data/lib/wx/doc/gen/paint_dc.rb +0 -1
- data/lib/wx/doc/gen/palette.rb +0 -1
- data/lib/wx/doc/gen/panel.rb +19 -10
- data/lib/wx/doc/gen/pen.rb +17 -8
- data/lib/wx/doc/gen/pg/event_list.rb +97 -93
- data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -0
- data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +9 -1
- data/lib/wx/doc/gen/pg/pg_cell.rb +8 -5
- data/lib/wx/doc/gen/pg/pg_editor.rb +115 -16
- data/lib/wx/doc/gen/pg/pg_multi_button.rb +1 -2
- data/lib/wx/doc/gen/pg/pg_properties.rb +515 -83
- data/lib/wx/doc/gen/pg/pg_property.rb +296 -69
- data/lib/wx/doc/gen/pg/pg_validation_info.rb +9 -4
- data/lib/wx/doc/gen/pg/property_grid.rb +83 -22
- data/lib/wx/doc/gen/pg/property_grid_event.rb +31 -9
- data/lib/wx/doc/gen/pg/property_grid_interface.rb +212 -34
- data/lib/wx/doc/gen/pg/property_grid_manager.rb +42 -12
- data/lib/wx/doc/gen/pg/property_grid_page.rb +26 -8
- data/lib/wx/doc/gen/pg/property_grid_page_state.rb +13 -4
- data/lib/wx/doc/gen/picker_base.rb +12 -5
- data/lib/wx/doc/gen/platform_info.rb +4 -9
- data/lib/wx/doc/gen/popup_window.rb +2 -5
- data/lib/wx/doc/gen/progress_dialog.rb +1 -0
- data/lib/wx/doc/gen/property_sheet_dialog.rb +15 -5
- data/lib/wx/doc/gen/prt/event_list.rb +8 -4
- data/lib/wx/doc/gen/prt/page_setup_dialog.rb +1 -1
- data/lib/wx/doc/gen/prt/post_script_dc.rb +2 -2
- data/lib/wx/doc/gen/prt/preview_frame.rb +2 -2
- data/lib/wx/doc/gen/prt/print_abort_dialog.rb +4 -1
- data/lib/wx/doc/gen/prt/print_data.rb +4 -3
- data/lib/wx/doc/gen/prt/print_dialog.rb +1 -1
- data/lib/wx/doc/gen/prt/printer.rb +50 -11
- data/lib/wx/doc/gen/prt/printer_dc.rb +1 -1
- data/lib/wx/doc/gen/query_layout_info_event.rb +1 -3
- data/lib/wx/doc/gen/radio_box.rb +13 -14
- data/lib/wx/doc/gen/radio_button.rb +15 -11
- data/lib/wx/doc/gen/rbn/event_list.rb +127 -123
- data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +19 -3
- data/lib/wx/doc/gen/rbn/ribbon_bar.rb +3 -4
- data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -2
- data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +18 -6
- data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -2
- data/lib/wx/doc/gen/rbn/ribbon_control.rb +2 -2
- data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +4 -4
- data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -3
- data/lib/wx/doc/gen/rbn/ribbon_page.rb +1 -2
- data/lib/wx/doc/gen/rbn/ribbon_panel.rb +5 -4
- data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -3
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +2 -3
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
- data/lib/wx/doc/gen/rearrange_ctrl.rb +3 -4
- data/lib/wx/doc/gen/rearrange_list.rb +5 -6
- data/lib/wx/doc/gen/region.rb +75 -17
- data/lib/wx/doc/gen/region_iterator.rb +0 -1
- data/lib/wx/doc/gen/rtc/event_list.rb +116 -112
- data/lib/wx/doc/gen/rtc/rich_text_box.rb +3 -2
- data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +6 -9
- data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -2
- data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +3 -6
- data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +12 -9
- data/lib/wx/doc/gen/rtc/rich_text_event.rb +3 -4
- data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +3 -5
- data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +4 -5
- data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +3 -2
- data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +2 -3
- data/lib/wx/doc/gen/rtc/rich_text_image.rb +2 -4
- data/lib/wx/doc/gen/rtc/rich_text_object.rb +28 -23
- data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +7 -11
- data/lib/wx/doc/gen/rtc/rich_text_printing.rb +3 -3
- data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +14 -14
- data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +3 -3
- data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +3 -4
- data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +3 -4
- data/lib/wx/doc/gen/sash_event.rb +12 -4
- data/lib/wx/doc/gen/sash_layout_window.rb +13 -6
- data/lib/wx/doc/gen/sash_window.rb +4 -5
- data/lib/wx/doc/gen/screen_dc.rb +0 -1
- data/lib/wx/doc/gen/scroll_bar.rb +21 -12
- data/lib/wx/doc/gen/scrolled_canvas.rb +34 -12
- data/lib/wx/doc/gen/scrolled_control.rb +34 -12
- data/lib/wx/doc/gen/scrolled_window.rb +34 -12
- data/lib/wx/doc/gen/search_ctrl.rb +10 -11
- data/lib/wx/doc/gen/simplebook.rb +1 -1
- data/lib/wx/doc/gen/single_choice_dialog.rb +7 -4
- data/lib/wx/doc/gen/sizer.rb +12 -7
- data/lib/wx/doc/gen/sizer_item.rb +5 -2
- data/lib/wx/doc/gen/slider.rb +29 -19
- data/lib/wx/doc/gen/spin_button.rb +16 -11
- data/lib/wx/doc/gen/spin_ctrl.rb +24 -9
- data/lib/wx/doc/gen/spin_ctrl_double.rb +6 -7
- data/lib/wx/doc/gen/spin_double_event.rb +3 -4
- data/lib/wx/doc/gen/spin_event.rb +3 -3
- data/lib/wx/doc/gen/splash_screen.rb +1 -2
- data/lib/wx/doc/gen/splitter_event.rb +3 -4
- data/lib/wx/doc/gen/splitter_window.rb +78 -20
- data/lib/wx/doc/gen/static_bitmap.rb +12 -7
- data/lib/wx/doc/gen/static_box.rb +13 -11
- data/lib/wx/doc/gen/static_box_sizer.rb +0 -2
- data/lib/wx/doc/gen/static_line.rb +5 -6
- data/lib/wx/doc/gen/static_text.rb +7 -8
- data/lib/wx/doc/gen/status_bar.rb +21 -11
- data/lib/wx/doc/gen/stc/event_list.rb +212 -208
- data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +41 -15
- data/lib/wx/doc/gen/stc/styled_text_event.rb +5 -6
- data/lib/wx/doc/gen/std_dialog_button_sizer.rb +0 -1
- data/lib/wx/doc/gen/svg_file_dc.rb +7 -8
- data/lib/wx/doc/gen/system_options.rb +6 -6
- data/lib/wx/doc/gen/system_settings.rb +2 -3
- data/lib/wx/doc/gen/task_bar_button.rb +312 -0
- data/lib/wx/doc/gen/task_bar_icon.rb +21 -8
- data/lib/wx/doc/gen/task_bar_icon_event.rb +4 -3
- data/lib/wx/doc/gen/text_attr.rb +20 -5
- data/lib/wx/doc/gen/text_ctrl.rb +92 -27
- data/lib/wx/doc/gen/text_entry.rb +31 -11
- data/lib/wx/doc/gen/text_entry_dialog.rb +2 -2
- data/lib/wx/doc/gen/text_validator.rb +43 -10
- data/lib/wx/doc/gen/time_picker_ctrl.rb +7 -8
- data/lib/wx/doc/gen/timer.rb +6 -2
- data/lib/wx/doc/gen/timer_event.rb +1 -2
- data/lib/wx/doc/gen/tip_provider.rb +1 -1
- data/lib/wx/doc/gen/toggle_button.rb +7 -8
- data/lib/wx/doc/gen/tool_bar.rb +99 -26
- data/lib/wx/doc/gen/tool_tip.rb +35 -5
- data/lib/wx/doc/gen/toolbook.rb +3 -4
- data/lib/wx/doc/gen/top_level_window.rb +71 -25
- data/lib/wx/doc/gen/tree_ctrl.rb +42 -18
- data/lib/wx/doc/gen/tree_event.rb +3 -4
- data/lib/wx/doc/gen/treebook.rb +7 -4
- data/lib/wx/doc/gen/ui_action_simulator.rb +6 -2
- data/lib/wx/doc/gen/utils.rb +39 -7
- data/lib/wx/doc/gen/v_list_box.rb +8 -4
- data/lib/wx/doc/gen/v_scrolled_window.rb +8 -6
- data/lib/wx/doc/gen/validator.rb +1 -1
- data/lib/wx/doc/gen/variant.rb +1 -0
- data/lib/wx/doc/gen/window.rb +200 -50
- data/lib/wx/doc/gen/window_dc.rb +0 -1
- data/lib/wx/doc/gen/window_disabler.rb +5 -2
- data/lib/wx/doc/gen/with_images.rb +6 -1
- data/lib/wx/doc/gen/wizard.rb +4 -4
- data/lib/wx/doc/gen/wizard_event.rb +3 -4
- data/lib/wx/doc/gen/wizard_page.rb +2 -2
- data/lib/wx/doc/gen/wizard_page_simple.rb +1 -1
- data/lib/wx/doc/gen/wrap_sizer.rb +0 -1
- data/lib/wx/doc/gen/xml_node.rb +19 -4
- data/lib/wx/doc/gen/xml_resource.rb +18 -5
- data/lib/wx/doc/graphics_context.rb +1 -0
- data/lib/wx/doc/grid/grid.rb +22 -1
- data/lib/wx/doc/help_controller.rb +11 -7
- data/lib/wx/doc/html/html_help_controller.rb +12 -4
- data/lib/wx/doc/list_ctrl.rb +33 -29
- data/lib/wx/doc/menu.rb +20 -0
- data/lib/wx/doc/notebook.rb +21 -0
- data/lib/wx/doc/pg/events.rb +13 -9
- data/lib/wx/doc/pg/pg_property.rb +18 -0
- data/lib/wx/doc/progress_dialog.rb +36 -32
- data/lib/wx/doc/prt/page_setup_dialog.rb +20 -12
- data/lib/wx/doc/prt/print_data.rb +13 -5
- data/lib/wx/doc/prt/print_dialog.rb +31 -23
- data/lib/wx/doc/prt/printer.rb +20 -12
- data/lib/wx/doc/radio_box.rb +19 -15
- data/lib/wx/doc/rbn/ribbon_bar.rb +13 -5
- data/lib/wx/doc/rbn/ribbon_button_bar.rb +13 -5
- data/lib/wx/doc/rbn/ribbon_gallery.rb +13 -5
- data/lib/wx/doc/rbn/ribbon_tool_bar.rb +13 -5
- data/lib/wx/doc/region_iterator.rb +32 -28
- data/lib/wx/doc/rtc/rich_text_composite_object.rb +24 -0
- data/lib/wx/doc/rtc/rich_text_ctrl.rb +24 -0
- data/lib/wx/doc/rtc/rich_text_paragraph.rb +24 -0
- data/lib/wx/doc/rtc/richtext_buffer.rb +27 -19
- data/lib/wx/doc/rtc/richtext_printing.rb +17 -9
- data/lib/wx/doc/rtc/richtext_style_sheet.rb +17 -9
- data/lib/wx/doc/sizer.rb +20 -0
- data/lib/wx/doc/stc/styled_text_ctrl.rb +24 -0
- data/lib/wx/doc/stream.rb +39 -35
- data/lib/wx/doc/system_settings.rb +30 -26
- data/lib/wx/doc/text_validator.rb +12 -8
- data/lib/wx/doc/textctrl.rb +16 -0
- data/lib/wx/doc/tree_ctrl.rb +95 -0
- data/lib/wx/doc/treebook.rb +9 -5
- data/lib/wx/doc/v_list_box.rb +9 -5
- data/lib/wx/doc/variant.rb +164 -160
- data/lib/wx/doc/window.rb +57 -42
- data/lib/wx/doc/window_disabler.rb +10 -6
- data/lib/wx/grid/grid.rb +27 -4
- data/lib/wx/keyword_defs.rb +43 -6
- data/lib/wx/pg/pg_property.rb +22 -0
- data/lib/wx/rtc/require.rb +3 -0
- data/lib/wx/rtc/rich_text_composite_object.rb +25 -0
- data/lib/wx/rtc/rich_text_ctrl.rb +25 -0
- data/lib/wx/rtc/rich_text_paragraph.rb +25 -0
- data/lib/wx/stc/require.rb +1 -0
- data/lib/wx/stc/styled_text_ctrl.rb +25 -0
- data/lib/wx/version.rb +1 -1
- data/lib/wxruby_aui.so +0 -0
- data/lib/wxruby_core.so +0 -0
- data/lib/wxruby_grid.so +0 -0
- data/lib/wxruby_html.so +0 -0
- data/lib/wxruby_pg.so +0 -0
- data/lib/wxruby_prt.so +0 -0
- data/lib/wxruby_rbn.so +0 -0
- data/lib/wxruby_rtc.so +0 -0
- data/lib/wxruby_stc.so +0 -0
- data/rakelib/lib/config/linux.rb +0 -3
- data/rakelib/lib/config/macosx.rb +1 -1
- data/rakelib/lib/config/mingw.rb +1 -1
- data/rakelib/lib/config/unixish.rb +1 -1
- data/rakelib/lib/config.rb +14 -4
- data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +74 -2
- data/rakelib/yard/templates/default/fulldoc/html/full_list.erb +38 -0
- data/rakelib/yard/templates/default/fulldoc/html/setup.rb +39 -0
- data/rakelib/yard/templates/default/tags/html/wxrb_require.erb +10 -0
- data/rakelib/yard/templates/default/tags/setup.rb +16 -0
- data/rakelib/yard/yard-custom-templates.rb +3 -0
- data/samples/text/richtext.rb +0 -30
- data/samples/treectrl/treectrl.rb +1 -1
- data/tests/media/beep_lo.wav +0 -0
- data/tests/test_app_exit_exception.rb +36 -0
- data/tests/test_app_init_exception.rb +20 -0
- data/tests/test_book_controls.rb +29 -0
- data/tests/test_exceptions.rb +41 -0
- data/tests/test_list_ctrl.rb +1 -1
- data/tests/test_media_ctrl.rb +38 -0
- data/tests/test_menu.rb +69 -0
- data/tests/test_pg.rb +27 -0
- data/tests/test_richtext.rb +45 -0
- data/tests/test_sizer.rb +59 -0
- data/tests/test_std_controls.rb +78 -1
- data/tests/test_styled_text_ctrl.rb +46 -0
- data/tests/test_tree_ctrl.rb +138 -0
- data/tests/test_window.rb +12 -0
- data/tests/testapp_noframe.rb +1 -1
- metadata +38 -3
@@ -46,16 +46,15 @@ module Wx::RTC
|
|
46
46
|
# end
|
47
47
|
# ```
|
48
48
|
#
|
49
|
-
# ===
|
50
|
-
#
|
51
49
|
# Category: Common Dialogs
|
52
50
|
#
|
51
|
+
# @wxrb_require USE_RICHTEXT
|
53
52
|
class SymbolPickerDialog < Dialog
|
54
53
|
|
55
54
|
# @overload initialize()
|
56
55
|
# Default ctor.
|
57
56
|
# @return [Wx::RTC::SymbolPickerDialog]
|
58
|
-
# @overload initialize(symbol, initialFont, normalTextFont, parent, id=Wx::StandardID::ID_ANY, title=(_.new("
|
57
|
+
# @overload initialize(symbol, initialFont, normalTextFont, parent, id=Wx::StandardID::ID_ANY, title=(_.new("SYMBOLS")), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DEFAULT_DIALOG_STYLE|Wx::RESIZE_BORDER|Wx::CLOSE_BOX))
|
59
58
|
# Constructor.
|
60
59
|
# @param symbol [String] The initial symbol to show. Specify a single character in a string, or an empty string.
|
61
60
|
# @param initialFont [String] The initial font to be displayed in the font list. If empty, the item normal text will be selected.
|
@@ -80,7 +79,7 @@ module Wx::RTC
|
|
80
79
|
# @param size [Array(Integer, Integer), Wx::Size]
|
81
80
|
# @param style [Integer]
|
82
81
|
# @return [Boolean]
|
83
|
-
def create(symbol, initialFont, normalTextFont, parent, id=Wx::StandardID::ID_ANY, caption=(Wx::GetTranslation.new("
|
82
|
+
def create(symbol, initialFont, normalTextFont, parent, id=Wx::StandardID::ID_ANY, caption=(Wx::GetTranslation.new("SYMBOLS")), pos=Wx::DEFAULT_POSITION, size=(Wx::Size.new(400, 300)), style=(Wx::DEFAULT_DIALOG_STYLE|Wx::RESIZE_BORDER|Wx::CLOSE_BOX)) end
|
84
83
|
|
85
84
|
# Returns the font name (the font reflected in the font list).
|
86
85
|
# @return [String]
|
@@ -25,6 +25,7 @@ module Wx
|
|
25
25
|
#
|
26
26
|
#
|
27
27
|
#
|
28
|
+
# @wxrb_require USE_SASH
|
28
29
|
class SashEdgePosition < Wx::Enum
|
29
30
|
|
30
31
|
#
|
@@ -53,6 +54,7 @@ module Wx
|
|
53
54
|
#
|
54
55
|
#
|
55
56
|
#
|
57
|
+
# @wxrb_require USE_SASH
|
56
58
|
class SashDragStatus < Wx::Enum
|
57
59
|
|
58
60
|
#
|
@@ -69,10 +71,17 @@ module Wx
|
|
69
71
|
#
|
70
72
|
EVT_SASH_DRAGGED = 10050
|
71
73
|
|
74
|
+
#
|
75
|
+
EVT_SASH_DRAGGED_RANGE = 10050
|
76
|
+
|
72
77
|
# A sash event is sent when the sash of a {Wx::SashWindow} has been dragged by the user.
|
73
|
-
#
|
78
|
+
# <div class="wxrb-remark">
|
79
|
+
# <b>Remark:</b>
|
80
|
+
# <p>When a sash belonging to a sash window is dragged by the user, and then released, this event is sent to the window, where it may be processed by an event table entry in a derived class, a plug-in event handler or an ancestor class. Note that the {Wx::SashWindow} doesn't change the window's size itself. It relies on the application's event handler to do that. This is because the application may have to handle other consequences of the resize, or it may wish to veto it altogether. The event handler should look at the drag rectangle: see {Wx::SashEvent#get_drag_rect} to see what the new size of the window would be if the resize were to be applied. It should also call {Wx::SashEvent#get_drag_status} to see whether the drag was OK or out of the current allowed range.
|
81
|
+
# </p>
|
82
|
+
# </div>>
|
74
83
|
#
|
75
|
-
#
|
84
|
+
# ### Events using this class
|
76
85
|
#
|
77
86
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::SashEvent} events.
|
78
87
|
# Event handler methods:
|
@@ -81,13 +90,12 @@ module Wx
|
|
81
90
|
#
|
82
91
|
# - {Wx::EvtHandler#evt_sash_dragged_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_SASH_DRAGGED_RANGE} event, when the user has finished dragging a sash. The event handler is called when windows with ids in the given range have their sashes dragged.
|
83
92
|
#
|
84
|
-
# ===
|
85
|
-
#
|
86
93
|
# Category: {Wx::Events}
|
87
94
|
# @see Wx::SashWindow
|
88
95
|
# @see Events and Event Handling
|
89
96
|
#
|
90
97
|
#
|
98
|
+
# @wxrb_require USE_SASH
|
91
99
|
class SashEvent < CommandEvent
|
92
100
|
|
93
101
|
# Constructor.
|
@@ -10,6 +10,7 @@ module Wx
|
|
10
10
|
#
|
11
11
|
#
|
12
12
|
#
|
13
|
+
# @wxrb_require USE_SASH
|
13
14
|
class LayoutOrientation < Wx::Enum
|
14
15
|
|
15
16
|
#
|
@@ -26,6 +27,7 @@ module Wx
|
|
26
27
|
#
|
27
28
|
#
|
28
29
|
#
|
30
|
+
# @wxrb_require USE_SASH
|
29
31
|
class LayoutAlignment < Wx::Enum
|
30
32
|
|
31
33
|
#
|
@@ -64,7 +66,6 @@ module Wx
|
|
64
66
|
# The documentation for {Wx::LayoutAlgorithm} explains the purpose of this class in more detail.
|
65
67
|
# For the window styles see {Wx::SashWindow}.
|
66
68
|
# This class handles the EVT_QUERY_LAYOUT_INFO and EVT_CALCULATE_LAYOUT events for you. However, if you use sashes, see {Wx::SashWindow} for relevant event information. See also {Wx::LayoutAlgorithm} for information about the layout events.
|
67
|
-
# ===
|
68
69
|
#
|
69
70
|
# Category: Miscellaneous Windows
|
70
71
|
# @see Wx::LayoutAlgorithm
|
@@ -72,12 +73,13 @@ module Wx
|
|
72
73
|
# @see Events and Event Handling
|
73
74
|
#
|
74
75
|
#
|
76
|
+
# @wxrb_require USE_SASH
|
75
77
|
class SashLayoutWindow < SashWindow
|
76
78
|
|
77
79
|
# @overload initialize()
|
78
80
|
# Default ctor.
|
79
81
|
# @return [Wx::SashLayoutWindow]
|
80
|
-
# @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CLIP_CHILDREN|wxSW_3D), name=("
|
82
|
+
# @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CLIP_CHILDREN|wxSW_3D), name=("LAYOUT_WINDOW"))
|
81
83
|
# Constructs a sash layout window, which can be a child of a frame, dialog or any other non-control window.
|
82
84
|
# @param parent [Wx::Window] Pointer to a parent window.
|
83
85
|
# @param id [Integer] Window identifier. If -1, will automatically create an identifier.
|
@@ -96,7 +98,7 @@ module Wx
|
|
96
98
|
# @param style [Integer] Window style. For window styles, please see {Wx::SashLayoutWindow}.
|
97
99
|
# @param name [String] Window name.
|
98
100
|
# @return [Boolean]
|
99
|
-
def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CLIP_CHILDREN|wxSW_3D), name=("
|
101
|
+
def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CLIP_CHILDREN|wxSW_3D), name=("LAYOUT_WINDOW")) end
|
100
102
|
|
101
103
|
# Returns the alignment of the window: one of {Wx::LayoutAlignment::LAYOUT_TOP}, {Wx::LayoutAlignment::LAYOUT_LEFT}, {Wx::LayoutAlignment::LAYOUT_RIGHT}, {Wx::LayoutAlignment::LAYOUT_BOTTOM}.
|
102
104
|
# @return [Wx::LayoutAlignment]
|
@@ -152,9 +154,14 @@ module Wx
|
|
152
154
|
# When a window receives an OnCalculateLayout event, it should call SetRect in the given event object, to be the old supplied rectangle minus whatever space the window takes up. It should also set its own size accordingly. {Wx::SashLayoutWindow#on_calculate_layout} generates an OnQueryLayoutInfo event which it sends to itself to determine the orientation, alignment and size of the window, which it gets from internal member variables set by the application.
|
153
155
|
# The algorithm works by starting off with a rectangle equal to the whole frame client area. It iterates through the frame children, generating {Wx::LayoutAlgorithm::OnCalculateLayout} events which subtract the window size and return the remaining rectangle for the next window to process. It is assumed (by {Wx::SashLayoutWindow#on_calculate_layout}) that a window stretches the full dimension of the frame client, according to the orientation it specifies. For example, a horizontal window will stretch the full width of the remaining portion of the frame client area. In the other orientation, the window will be fixed to whatever size was specified by {Wx::LayoutAlgorithm::OnQueryLayoutInfo}. An alignment setting will make the window 'stick' to the left, top, right or bottom of the remaining client area. This scheme implies that order of window creation is important. Say you wish to have an extra toolbar at the top of the frame, a project window to the left of the MDI client window, and an output window above the status bar. You should therefore create the windows in this order: toolbar, output window, project window. This ensures that the toolbar and output window take up space at the top and bottom, and then the remaining height in-between is used for the project window.
|
154
156
|
# {Wx::LayoutAlgorithm} is quite independent of the way in which {Wx::LayoutAlgorithm::OnCalculateLayout} chooses to interpret a window's size and alignment. Therefore you could implement a different window class with a new {Wx::LayoutAlgorithm::OnCalculateLayout} event handler, that has a more sophisticated way of laying out the windows. It might allow specification of whether stretching occurs in the specified orientation, for example, rather than always assuming stretching. (This could, and probably should, be added to the existing implementation).
|
155
|
-
# {Wx::LayoutAlgorithm} has nothing to do with {Wx::LayoutConstraints}. It is an alternative way of specifying layouts for which the normal constraint system is unsuitable.
|
156
157
|
#
|
157
|
-
#
|
158
|
+
# <div class="wxrb-note">
|
159
|
+
# <b>Note:</b>
|
160
|
+
# <p>{Wx::LayoutAlgorithm} has nothing to do with {Wx::LayoutConstraints}. It is an alternative way of specifying layouts for which the normal constraint system is unsuitable.
|
161
|
+
# </p>
|
162
|
+
# </div>
|
163
|
+
#
|
164
|
+
# ### Events emitted by this class
|
158
165
|
#
|
159
166
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::CalculateLayoutEvent} events.
|
160
167
|
# Event handler methods for events emitted by this class:
|
@@ -164,7 +171,6 @@ module Wx
|
|
164
171
|
# - {Wx::EvtHandler#evt_calculate_layout}(meth = nil, &block): Process a {Wx::EVT_CALCULATE_LAYOUT} event, which asks the window to take a 'bite' out of a rectangle provided by the algorithm. See {Wx::CalculateLayoutEvent}.
|
165
172
|
#
|
166
173
|
# Note that the algorithm object does not respond to events, but itself generates the previous events in order to calculate window sizes.
|
167
|
-
# ===
|
168
174
|
#
|
169
175
|
# Category: Window Layout
|
170
176
|
# @see Wx::SashEvent
|
@@ -172,6 +178,7 @@ module Wx
|
|
172
178
|
# @see Events and Event Handling
|
173
179
|
#
|
174
180
|
#
|
181
|
+
# @wxrb_require USE_SASH
|
175
182
|
class LayoutAlgorithm < Object
|
176
183
|
|
177
184
|
# Default constructor.
|
@@ -9,7 +9,7 @@ module Wx
|
|
9
9
|
# {Wx::SashWindow} allows any of its edges to have a sash which can be dragged to resize the window.
|
10
10
|
# The actual content window will be created by the application as a child of {Wx::SashWindow}.
|
11
11
|
# The window (or an ancestor) will be notified of a drag via a {Wx::SashEvent} notification.
|
12
|
-
#
|
12
|
+
# ### Styles
|
13
13
|
#
|
14
14
|
# This class supports the following styles:
|
15
15
|
#
|
@@ -21,7 +21,7 @@ module Wx
|
|
21
21
|
#
|
22
22
|
# - {Wx::SW_BORDER}: Draws a thin black border.
|
23
23
|
#
|
24
|
-
#
|
24
|
+
# ### Events emitted by this class
|
25
25
|
#
|
26
26
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::SashEvent} events.
|
27
27
|
# Event handler methods for events emitted by this class:
|
@@ -30,20 +30,19 @@ module Wx
|
|
30
30
|
#
|
31
31
|
# - {Wx::EvtHandler#evt_sash_dragged_range}(id1, id2, meth = nil, &block): Process a {Wx::EVT_SASH_DRAGGED_RANGE} event, when the user has finished dragging a sash. The event handler is called when windows with ids in the given range have their sashes dragged.
|
32
32
|
#
|
33
|
-
# ===
|
34
|
-
#
|
35
33
|
# Category: Miscellaneous Windows
|
36
34
|
# @see Wx::SashEvent
|
37
35
|
# @see Wx::SashLayoutWindow
|
38
36
|
# @see Events and Event Handling
|
39
37
|
#
|
40
38
|
#
|
39
|
+
# @wxrb_require USE_SASH
|
41
40
|
class SashWindow < Window
|
42
41
|
|
43
42
|
# @overload initialize()
|
44
43
|
# Default ctor.
|
45
44
|
# @return [Wx::SashWindow]
|
46
|
-
# @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CLIP_CHILDREN|wxSW_3D), name=("
|
45
|
+
# @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CLIP_CHILDREN|wxSW_3D), name=("SASH_WINDOW"))
|
47
46
|
# Constructs a sash window, which can be a child of a frame, dialog or any other non-control window.
|
48
47
|
# @param parent [Wx::Window] Pointer to a parent window.
|
49
48
|
# @param id [Integer] Window identifier. If -1, will automatically create an identifier.
|
data/lib/wx/doc/gen/screen_dc.rb
CHANGED
@@ -9,7 +9,6 @@ module Wx
|
|
9
9
|
# A {Wx::ScreenDC} can be used to paint on the screen.
|
10
10
|
# This should normally be constructed as a temporary stack object; don't store a {Wx::ScreenDC} object.
|
11
11
|
# When using multiple monitors, {Wx::ScreenDC} corresponds to the entire virtual screen composed of all of them. Notice that coordinates on {Wx::ScreenDC} can be negative in this case, see Wx::Display#get_geometry for more.
|
12
|
-
# ===
|
13
12
|
#
|
14
13
|
# Category: Device Contexts
|
15
14
|
# @see Wx::DC
|
@@ -8,9 +8,14 @@ module Wx
|
|
8
8
|
|
9
9
|
# A {Wx::ScrollBar} is a control that represents a horizontal or vertical scrollbar.
|
10
10
|
# It is distinct from the two scrollbars that some windows provide automatically, but the two types of scrollbar share the way events are received.
|
11
|
-
# A scrollbar has the following main attributes: range, thumb size, page size, and position. The range is the total number of units associated with the view represented by the scrollbar. For a table with 15 columns, the range would be 15. The thumb size is the number of units that are currently visible. For the table example, the window might be sized so that only 5 columns are currently visible, in which case the application would set the thumb size to 5. When the thumb size becomes the same as or greater than the range, the scrollbar will be automatically hidden on most platforms. The page size is the number of units that the scrollbar should scroll by, when 'paging' through the data. This value is normally the same as the thumb size length, because it is natural to assume that the visible window size defines a page. The scrollbar position is the current thumb position. Most applications will find it convenient to provide a function called AdjustScrollbars() which can be called initially, from an OnSize event handler, and whenever the application data changes in size. It will adjust the view, object and page size according to the size of the window and the size of the data.
|
12
11
|
#
|
13
|
-
#
|
12
|
+
# <div class="wxrb-remark">
|
13
|
+
# <b>Remark:</b>
|
14
|
+
# <p>A scrollbar has the following main attributes: range, thumb size, page size, and position. The range is the total number of units associated with the view represented by the scrollbar. For a table with 15 columns, the range would be 15. The thumb size is the number of units that are currently visible. For the table example, the window might be sized so that only 5 columns are currently visible, in which case the application would set the thumb size to 5. When the thumb size becomes the same as or greater than the range, the scrollbar will be automatically hidden on most platforms. The page size is the number of units that the scrollbar should scroll by, when 'paging' through the data. This value is normally the same as the thumb size length, because it is natural to assume that the visible window size defines a page. The scrollbar position is the current thumb position. Most applications will find it convenient to provide a function called AdjustScrollbars() which can be called initially, from an OnSize event handler, and whenever the application data changes in size. It will adjust the view, object and page size according to the size of the window and the size of the data.
|
15
|
+
# </p>
|
16
|
+
# </div>>
|
17
|
+
#
|
18
|
+
# ### Styles
|
14
19
|
#
|
15
20
|
# This class supports the following styles:
|
16
21
|
#
|
@@ -18,7 +23,7 @@ module Wx
|
|
18
23
|
#
|
19
24
|
# - {Wx::SB_VERTICAL}: Specifies a vertical scrollbar.
|
20
25
|
#
|
21
|
-
#
|
26
|
+
# ### Events emitted by this class
|
22
27
|
#
|
23
28
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollEvent} events.
|
24
29
|
# Event handler methods for events emitted by this class: except for this, the macros behave exactly the same.
|
@@ -63,28 +68,28 @@ module Wx
|
|
63
68
|
#
|
64
69
|
# - {Wx::EvtHandler#evt_command_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only).
|
65
70
|
#
|
66
|
-
#
|
71
|
+
# ## The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
|
67
72
|
#
|
68
73
|
# The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
|
69
74
|
# The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen).
|
70
75
|
# In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/moving has finished independently of the way it had started. Please see the Widgets Sample ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
|
71
|
-
# ===
|
72
76
|
#
|
73
|
-
# Category: {Wx::Controls} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td>
|
74
|
-
# </td><td>
|
75
|
-
# </td><td>
|
77
|
+
# Category: {Wx::Controls} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
|
78
|
+
# </td><td> WXGTK Appearance
|
79
|
+
# </td><td> WXOSX Appearance
|
76
80
|
# </td></tr></table></div>
|
77
81
|
# @see Scrolled Windows
|
78
82
|
# @see Events and Event Handling
|
79
83
|
# @see Wx::Scrolled
|
80
84
|
#
|
81
85
|
#
|
86
|
+
# @wxrb_require USE_SCROLLBAR
|
82
87
|
class ScrollBar < Control
|
83
88
|
|
84
89
|
# @overload initialize()
|
85
90
|
# Default constructor.
|
86
91
|
# @return [Wx::ScrollBar]
|
87
|
-
# @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::SB_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::
|
92
|
+
# @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::SB_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SCROLL_BAR_NAME_STR)
|
88
93
|
# Constructor, creating and showing a scrollbar.
|
89
94
|
#
|
90
95
|
# @see Wx::ScrollBar#create
|
@@ -109,7 +114,7 @@ module Wx
|
|
109
114
|
# @param validator [Wx::Validator]
|
110
115
|
# @param name [String]
|
111
116
|
# @return [Boolean]
|
112
|
-
def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::SB_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::
|
117
|
+
def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::SB_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SCROLL_BAR_NAME_STR) end
|
113
118
|
|
114
119
|
# Returns the page size of the scrollbar.
|
115
120
|
# This is the number of scroll units that will be scrolled when the user pages up or down. Often it is the same as the thumb size.
|
@@ -140,11 +145,15 @@ module Wx
|
|
140
145
|
alias_method :thumb_size, :get_thumb_size
|
141
146
|
|
142
147
|
# Sets the scrollbar properties.
|
143
|
-
#
|
148
|
+
# <div class="wxrb-remark">
|
149
|
+
# <b>Remark:</b>
|
150
|
+
# <p>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:
|
144
151
|
# ```ruby
|
145
152
|
# scrollbar.set_scrollbar(0, 16, 50, 15)
|
146
153
|
# ```
|
147
|
-
# The page size is 1 less than the thumb size so that the last line of the previous page will be visible on the next page, to help orient the user. 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 {Wx::ScrollBar#set_scrollbar} call into a function named AdjustScrollbars, which can be called initially and also from a {Wx::SizeEvent} event handler function.
|
154
|
+
# The page size is 1 less than the thumb size so that the last line of the previous page will be visible on the next page, to help orient the user. 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 {Wx::ScrollBar#set_scrollbar} call into a function named AdjustScrollbars, which can be called initially and also from a {Wx::SizeEvent} event handler function.
|
155
|
+
# </p>
|
156
|
+
# </div>>
|
148
157
|
# @param position [Integer] The position of the scrollbar in scroll units.
|
149
158
|
# @param thumbSize [Integer] The size of the thumb, or visible portion of the scrollbar, in scroll units.
|
150
159
|
# @param range [Integer] The maximum position of the scrollbar.
|
@@ -12,7 +12,11 @@ module Wx
|
|
12
12
|
# - {Wx::ScrolledWindow}, aka {Wx::Scrolled}<{Wx::Panel}>, is equivalent to {Wx::ScrolledWindow} from earlier versions. Derived from {Wx::Panel}, it shares {Wx::Panel}'s behaviour with regard to TAB traversal and focus handling. Use this if the scrolled window will have child controls.
|
13
13
|
# - {Wx::ScrolledCanvas}, aka {Wx::Scrolled}<{Wx::Window}>, derives from {Wx::Window} and so doesn't handle children specially. This is suitable e.g. for implementing scrollable controls such as tree or list controls.
|
14
14
|
#
|
15
|
-
#
|
15
|
+
# <div class="wxrb-note">
|
16
|
+
# <b>Note:</b>
|
17
|
+
# <p>See Wx::Scrolled#create if you want to use {Wx::Scrolled} with a custom class.
|
18
|
+
# </p>
|
19
|
+
# </div>
|
16
20
|
#
|
17
21
|
# Starting from version 2.4 of wxWidgets, there are several ways to use a {Wx::ScrolledWindow} (and now {Wx::Scrolled}). In particular, there are three ways to set the size of the scrolling area:
|
18
22
|
# One way is to set the scrollbars directly using a call to Wx::Scrolled#set_scrollbars. This is the way it used to be in any previous version of wxWidgets and it will be kept for backwards compatibility.
|
@@ -26,7 +30,7 @@ module Wx
|
|
26
30
|
# If you don't wish to calculate your own scrolling, you must call Wx::Scrolled#do_prepare_dc when not drawing from within Wx::Scrolled#on_draw, to set the device origin for the device context according to the current scroll position.
|
27
31
|
# A {Wx::Scrolled} will normally scroll itself and therefore its child windows as well. It might however be desired to scroll a different window than itself: e.g. when designing a spreadsheet, you will normally only have to scroll the (usually white) cell area, whereas the (usually grey) label area will scroll very differently. For this special purpose, you can call Wx::Scrolled#set_target_window which means that pressing the scrollbars will scroll a different window.
|
28
32
|
# Note that the underlying system knows nothing about scrolling coordinates, so that all system functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows are relative to the "physical" origin of the scrolled window. If the user insert a child window at position (10,10) and scrolls the window down 100 pixels (moving the child window out of the visible area), the child window will report a position of (10,-90).
|
29
|
-
#
|
33
|
+
# ### Styles
|
30
34
|
#
|
31
35
|
# This class supports the following styles:
|
32
36
|
#
|
@@ -38,7 +42,7 @@ module Wx
|
|
38
42
|
#
|
39
43
|
# - {Wx::RETAINED}: Uses a backing pixmap to speed refreshes. Motif only.
|
40
44
|
#
|
41
|
-
#
|
45
|
+
# ### Events emitted by this class
|
42
46
|
#
|
43
47
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
|
44
48
|
# Event handler methods for events emitted by this class:
|
@@ -61,11 +65,17 @@ module Wx
|
|
61
65
|
#
|
62
66
|
# - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events.
|
63
67
|
#
|
64
|
-
#
|
68
|
+
# <div class="wxrb-note">
|
69
|
+
# <b>Note:</b>
|
70
|
+
# <p>Don't confuse {Wx::ScrollWinEvents} generated by this class with {Wx::ScrollEvent} objects generated by {Wx::ScrollBar} and {Wx::Slider}.
|
71
|
+
# </p>
|
72
|
+
# </div>
|
65
73
|
#
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
74
|
+
# <div class="wxrb-remark">
|
75
|
+
# <b>Remark:</b>
|
76
|
+
# <p>Use {Wx::Scrolled} for applications where the user scrolls by a fixed amount, and where a 'page' can be interpreted to be the current visible portion of the window. For more sophisticated applications, use the {Wx::Scrolled} implementation as a guide to build your own scroll behaviour or use {Wx::VScrolledWindow} or its variants.
|
77
|
+
# </p>
|
78
|
+
# </div>>
|
69
79
|
#
|
70
80
|
# Category: Miscellaneous Windows
|
71
81
|
# @see Wx::ScrollBar
|
@@ -82,9 +92,13 @@ module Wx
|
|
82
92
|
# @overload initialize()
|
83
93
|
# Default constructor.
|
84
94
|
# @return [Wx::ScrolledCanvas]
|
85
|
-
# @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("
|
95
|
+
# @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("SCROLLED_WINDOW"))
|
86
96
|
# Constructor.
|
87
|
-
#
|
97
|
+
# <div class="wxrb-remark">
|
98
|
+
# <b>Remark:</b>
|
99
|
+
# <p>The window is initially created without visible scrollbars. Call Wx::Scrolled#set_scrollbars to specify how big the virtual window size should be.
|
100
|
+
# </p>
|
101
|
+
# </div>>
|
88
102
|
# @param parent [Wx::Window] Parent window.
|
89
103
|
# @param id [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
|
90
104
|
# @param pos [Array(Integer, Integer), Wx::Point] Window position. If a position of {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
|
@@ -128,7 +142,7 @@ module Wx
|
|
128
142
|
# @param style [Integer]
|
129
143
|
# @param name [String]
|
130
144
|
# @return [Boolean]
|
131
|
-
def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("
|
145
|
+
def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("SCROLLED_WINDOW")) end
|
132
146
|
|
133
147
|
# Disable use of keyboard keys for scrolling.
|
134
148
|
# By default cursor movement keys (including Home, End, Page Up and Down) are used to scroll the window appropriately. If the derived class uses these keys for something else, e.g. changing the currently selected item, this function can be used to disable this behaviour as it's not only not necessary then but can actually be actively harmful if another object forwards a keyboard event corresponding to one of the above keys to us using ProcessWindowEvent() because the event will always be processed which can be undesirable.
|
@@ -198,7 +212,11 @@ module Wx
|
|
198
212
|
alias_method :view_start, :get_view_start
|
199
213
|
|
200
214
|
# Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible).
|
201
|
-
#
|
215
|
+
# <div class="wxrb-remark">
|
216
|
+
# <b>Remark:</b>
|
217
|
+
# <p>Use {Wx::DC#device_to_logical_x} and {Wx::DC#device_to_logical_y} to translate these units to logical units.
|
218
|
+
# </p>
|
219
|
+
# </div>>
|
202
220
|
# @see Wx::Scrolled#set_scrollbars
|
203
221
|
# @see Wx::Scrolled#get_scroll_pixels_per_unit
|
204
222
|
# @return [Array(Integer,Integer)]
|
@@ -218,7 +236,11 @@ module Wx
|
|
218
236
|
|
219
237
|
# @overload scroll(x, y)
|
220
238
|
# Scrolls a window so the view start is at the given point.
|
221
|
-
#
|
239
|
+
# <div class="wxrb-remark">
|
240
|
+
# <b>Remark:</b>
|
241
|
+
# <p>The positions are in scroll units, not pixels, so to convert to pixels you will have to multiply by the number of pixels per scroll increment. If either parameter is {Wx::DEFAULT_COORD} (-1), that position will be ignored (no change in that direction).
|
242
|
+
# </p>
|
243
|
+
# </div>>
|
222
244
|
# @see Wx::Scrolled#set_scrollbars
|
223
245
|
# @see Wx::Scrolled#get_scroll_pixels_per_unit
|
224
246
|
# @param x [Integer] The x position to scroll to, in scroll units.
|
@@ -12,7 +12,11 @@ module Wx
|
|
12
12
|
# - {Wx::ScrolledWindow}, aka {Wx::Scrolled}<{Wx::Panel}>, is equivalent to {Wx::ScrolledWindow} from earlier versions. Derived from {Wx::Panel}, it shares {Wx::Panel}'s behaviour with regard to TAB traversal and focus handling. Use this if the scrolled window will have child controls.
|
13
13
|
# - {Wx::ScrolledCanvas}, aka {Wx::Scrolled}<{Wx::Window}>, derives from {Wx::Window} and so doesn't handle children specially. This is suitable e.g. for implementing scrollable controls such as tree or list controls.
|
14
14
|
#
|
15
|
-
#
|
15
|
+
# <div class="wxrb-note">
|
16
|
+
# <b>Note:</b>
|
17
|
+
# <p>See Wx::Scrolled#create if you want to use {Wx::Scrolled} with a custom class.
|
18
|
+
# </p>
|
19
|
+
# </div>
|
16
20
|
#
|
17
21
|
# Starting from version 2.4 of wxWidgets, there are several ways to use a {Wx::ScrolledWindow} (and now {Wx::Scrolled}). In particular, there are three ways to set the size of the scrolling area:
|
18
22
|
# One way is to set the scrollbars directly using a call to Wx::Scrolled#set_scrollbars. This is the way it used to be in any previous version of wxWidgets and it will be kept for backwards compatibility.
|
@@ -26,7 +30,7 @@ module Wx
|
|
26
30
|
# If you don't wish to calculate your own scrolling, you must call Wx::Scrolled#do_prepare_dc when not drawing from within Wx::Scrolled#on_draw, to set the device origin for the device context according to the current scroll position.
|
27
31
|
# A {Wx::Scrolled} will normally scroll itself and therefore its child windows as well. It might however be desired to scroll a different window than itself: e.g. when designing a spreadsheet, you will normally only have to scroll the (usually white) cell area, whereas the (usually grey) label area will scroll very differently. For this special purpose, you can call Wx::Scrolled#set_target_window which means that pressing the scrollbars will scroll a different window.
|
28
32
|
# Note that the underlying system knows nothing about scrolling coordinates, so that all system functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows are relative to the "physical" origin of the scrolled window. If the user insert a child window at position (10,10) and scrolls the window down 100 pixels (moving the child window out of the visible area), the child window will report a position of (10,-90).
|
29
|
-
#
|
33
|
+
# ### Styles
|
30
34
|
#
|
31
35
|
# This class supports the following styles:
|
32
36
|
#
|
@@ -38,7 +42,7 @@ module Wx
|
|
38
42
|
#
|
39
43
|
# - {Wx::RETAINED}: Uses a backing pixmap to speed refreshes. Motif only.
|
40
44
|
#
|
41
|
-
#
|
45
|
+
# ### Events emitted by this class
|
42
46
|
#
|
43
47
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
|
44
48
|
# Event handler methods for events emitted by this class:
|
@@ -61,11 +65,17 @@ module Wx
|
|
61
65
|
#
|
62
66
|
# - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events.
|
63
67
|
#
|
64
|
-
#
|
68
|
+
# <div class="wxrb-note">
|
69
|
+
# <b>Note:</b>
|
70
|
+
# <p>Don't confuse {Wx::ScrollWinEvents} generated by this class with {Wx::ScrollEvent} objects generated by {Wx::ScrollBar} and {Wx::Slider}.
|
71
|
+
# </p>
|
72
|
+
# </div>
|
65
73
|
#
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
74
|
+
# <div class="wxrb-remark">
|
75
|
+
# <b>Remark:</b>
|
76
|
+
# <p>Use {Wx::Scrolled} for applications where the user scrolls by a fixed amount, and where a 'page' can be interpreted to be the current visible portion of the window. For more sophisticated applications, use the {Wx::Scrolled} implementation as a guide to build your own scroll behaviour or use {Wx::VScrolledWindow} or its variants.
|
77
|
+
# </p>
|
78
|
+
# </div>>
|
69
79
|
#
|
70
80
|
# Category: Miscellaneous Windows
|
71
81
|
# @see Wx::ScrollBar
|
@@ -82,9 +92,13 @@ module Wx
|
|
82
92
|
# @overload initialize()
|
83
93
|
# Default constructor.
|
84
94
|
# @return [Wx::ScrolledControl]
|
85
|
-
# @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("
|
95
|
+
# @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("SCROLLED_WINDOW"))
|
86
96
|
# Constructor.
|
87
|
-
#
|
97
|
+
# <div class="wxrb-remark">
|
98
|
+
# <b>Remark:</b>
|
99
|
+
# <p>The window is initially created without visible scrollbars. Call Wx::Scrolled#set_scrollbars to specify how big the virtual window size should be.
|
100
|
+
# </p>
|
101
|
+
# </div>>
|
88
102
|
# @param parent [Wx::Window] Parent window.
|
89
103
|
# @param id [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
|
90
104
|
# @param pos [Array(Integer, Integer), Wx::Point] Window position. If a position of {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
|
@@ -128,7 +142,7 @@ module Wx
|
|
128
142
|
# @param style [Integer]
|
129
143
|
# @param name [String]
|
130
144
|
# @return [Boolean]
|
131
|
-
def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("
|
145
|
+
def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("SCROLLED_WINDOW")) end
|
132
146
|
|
133
147
|
# Disable use of keyboard keys for scrolling.
|
134
148
|
# By default cursor movement keys (including Home, End, Page Up and Down) are used to scroll the window appropriately. If the derived class uses these keys for something else, e.g. changing the currently selected item, this function can be used to disable this behaviour as it's not only not necessary then but can actually be actively harmful if another object forwards a keyboard event corresponding to one of the above keys to us using ProcessWindowEvent() because the event will always be processed which can be undesirable.
|
@@ -198,7 +212,11 @@ module Wx
|
|
198
212
|
alias_method :view_start, :get_view_start
|
199
213
|
|
200
214
|
# Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible).
|
201
|
-
#
|
215
|
+
# <div class="wxrb-remark">
|
216
|
+
# <b>Remark:</b>
|
217
|
+
# <p>Use {Wx::DC#device_to_logical_x} and {Wx::DC#device_to_logical_y} to translate these units to logical units.
|
218
|
+
# </p>
|
219
|
+
# </div>>
|
202
220
|
# @see Wx::Scrolled#set_scrollbars
|
203
221
|
# @see Wx::Scrolled#get_scroll_pixels_per_unit
|
204
222
|
# @return [Array(Integer,Integer)]
|
@@ -218,7 +236,11 @@ module Wx
|
|
218
236
|
|
219
237
|
# @overload scroll(x, y)
|
220
238
|
# Scrolls a window so the view start is at the given point.
|
221
|
-
#
|
239
|
+
# <div class="wxrb-remark">
|
240
|
+
# <b>Remark:</b>
|
241
|
+
# <p>The positions are in scroll units, not pixels, so to convert to pixels you will have to multiply by the number of pixels per scroll increment. If either parameter is {Wx::DEFAULT_COORD} (-1), that position will be ignored (no change in that direction).
|
242
|
+
# </p>
|
243
|
+
# </div>>
|
222
244
|
# @see Wx::Scrolled#set_scrollbars
|
223
245
|
# @see Wx::Scrolled#get_scroll_pixels_per_unit
|
224
246
|
# @param x [Integer] The x position to scroll to, in scroll units.
|
@@ -32,7 +32,11 @@ module Wx
|
|
32
32
|
# - {Wx::ScrolledWindow}, aka {Wx::Scrolled}<{Wx::Panel}>, is equivalent to {Wx::ScrolledWindow} from earlier versions. Derived from {Wx::Panel}, it shares {Wx::Panel}'s behaviour with regard to TAB traversal and focus handling. Use this if the scrolled window will have child controls.
|
33
33
|
# - {Wx::ScrolledCanvas}, aka {Wx::Scrolled}<{Wx::Window}>, derives from {Wx::Window} and so doesn't handle children specially. This is suitable e.g. for implementing scrollable controls such as tree or list controls.
|
34
34
|
#
|
35
|
-
#
|
35
|
+
# <div class="wxrb-note">
|
36
|
+
# <b>Note:</b>
|
37
|
+
# <p>See Wx::Scrolled#create if you want to use {Wx::Scrolled} with a custom class.
|
38
|
+
# </p>
|
39
|
+
# </div>
|
36
40
|
#
|
37
41
|
# Starting from version 2.4 of wxWidgets, there are several ways to use a {Wx::ScrolledWindow} (and now {Wx::Scrolled}). In particular, there are three ways to set the size of the scrolling area:
|
38
42
|
# One way is to set the scrollbars directly using a call to Wx::Scrolled#set_scrollbars. This is the way it used to be in any previous version of wxWidgets and it will be kept for backwards compatibility.
|
@@ -46,7 +50,7 @@ module Wx
|
|
46
50
|
# If you don't wish to calculate your own scrolling, you must call Wx::Scrolled#do_prepare_dc when not drawing from within Wx::Scrolled#on_draw, to set the device origin for the device context according to the current scroll position.
|
47
51
|
# A {Wx::Scrolled} will normally scroll itself and therefore its child windows as well. It might however be desired to scroll a different window than itself: e.g. when designing a spreadsheet, you will normally only have to scroll the (usually white) cell area, whereas the (usually grey) label area will scroll very differently. For this special purpose, you can call Wx::Scrolled#set_target_window which means that pressing the scrollbars will scroll a different window.
|
48
52
|
# Note that the underlying system knows nothing about scrolling coordinates, so that all system functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows are relative to the "physical" origin of the scrolled window. If the user insert a child window at position (10,10) and scrolls the window down 100 pixels (moving the child window out of the visible area), the child window will report a position of (10,-90).
|
49
|
-
#
|
53
|
+
# ### Styles
|
50
54
|
#
|
51
55
|
# This class supports the following styles:
|
52
56
|
#
|
@@ -58,7 +62,7 @@ module Wx
|
|
58
62
|
#
|
59
63
|
# - {Wx::RETAINED}: Uses a backing pixmap to speed refreshes. Motif only.
|
60
64
|
#
|
61
|
-
#
|
65
|
+
# ### Events emitted by this class
|
62
66
|
#
|
63
67
|
# The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
|
64
68
|
# Event handler methods for events emitted by this class:
|
@@ -81,11 +85,17 @@ module Wx
|
|
81
85
|
#
|
82
86
|
# - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events.
|
83
87
|
#
|
84
|
-
#
|
88
|
+
# <div class="wxrb-note">
|
89
|
+
# <b>Note:</b>
|
90
|
+
# <p>Don't confuse {Wx::ScrollWinEvents} generated by this class with {Wx::ScrollEvent} objects generated by {Wx::ScrollBar} and {Wx::Slider}.
|
91
|
+
# </p>
|
92
|
+
# </div>
|
85
93
|
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
94
|
+
# <div class="wxrb-remark">
|
95
|
+
# <b>Remark:</b>
|
96
|
+
# <p>Use {Wx::Scrolled} for applications where the user scrolls by a fixed amount, and where a 'page' can be interpreted to be the current visible portion of the window. For more sophisticated applications, use the {Wx::Scrolled} implementation as a guide to build your own scroll behaviour or use {Wx::VScrolledWindow} or its variants.
|
97
|
+
# </p>
|
98
|
+
# </div>>
|
89
99
|
#
|
90
100
|
# Category: Miscellaneous Windows
|
91
101
|
# @see Wx::ScrollBar
|
@@ -102,9 +112,13 @@ module Wx
|
|
102
112
|
# @overload initialize()
|
103
113
|
# Default constructor.
|
104
114
|
# @return [Wx::ScrolledWindow]
|
105
|
-
# @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("
|
115
|
+
# @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("SCROLLED_WINDOW"))
|
106
116
|
# Constructor.
|
107
|
-
#
|
117
|
+
# <div class="wxrb-remark">
|
118
|
+
# <b>Remark:</b>
|
119
|
+
# <p>The window is initially created without visible scrollbars. Call Wx::Scrolled#set_scrollbars to specify how big the virtual window size should be.
|
120
|
+
# </p>
|
121
|
+
# </div>>
|
108
122
|
# @param parent [Wx::Window] Parent window.
|
109
123
|
# @param id [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
|
110
124
|
# @param pos [Array(Integer, Integer), Wx::Point] Window position. If a position of {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
|
@@ -148,7 +162,7 @@ module Wx
|
|
148
162
|
# @param style [Integer]
|
149
163
|
# @param name [String]
|
150
164
|
# @return [Boolean]
|
151
|
-
def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("
|
165
|
+
def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("SCROLLED_WINDOW")) end
|
152
166
|
|
153
167
|
# Disable use of keyboard keys for scrolling.
|
154
168
|
# By default cursor movement keys (including Home, End, Page Up and Down) are used to scroll the window appropriately. If the derived class uses these keys for something else, e.g. changing the currently selected item, this function can be used to disable this behaviour as it's not only not necessary then but can actually be actively harmful if another object forwards a keyboard event corresponding to one of the above keys to us using ProcessWindowEvent() because the event will always be processed which can be undesirable.
|
@@ -218,7 +232,11 @@ module Wx
|
|
218
232
|
alias_method :view_start, :get_view_start
|
219
233
|
|
220
234
|
# Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible).
|
221
|
-
#
|
235
|
+
# <div class="wxrb-remark">
|
236
|
+
# <b>Remark:</b>
|
237
|
+
# <p>Use {Wx::DC#device_to_logical_x} and {Wx::DC#device_to_logical_y} to translate these units to logical units.
|
238
|
+
# </p>
|
239
|
+
# </div>>
|
222
240
|
# @see Wx::Scrolled#set_scrollbars
|
223
241
|
# @see Wx::Scrolled#get_scroll_pixels_per_unit
|
224
242
|
# @return [Array(Integer,Integer)]
|
@@ -238,7 +256,11 @@ module Wx
|
|
238
256
|
|
239
257
|
# @overload scroll(x, y)
|
240
258
|
# Scrolls a window so the view start is at the given point.
|
241
|
-
#
|
259
|
+
# <div class="wxrb-remark">
|
260
|
+
# <b>Remark:</b>
|
261
|
+
# <p>The positions are in scroll units, not pixels, so to convert to pixels you will have to multiply by the number of pixels per scroll increment. If either parameter is {Wx::DEFAULT_COORD} (-1), that position will be ignored (no change in that direction).
|
262
|
+
# </p>
|
263
|
+
# </div>>
|
242
264
|
# @see Wx::Scrolled#set_scrollbars
|
243
265
|
# @see Wx::Scrolled#get_scroll_pixels_per_unit
|
244
266
|
# @param x [Integer] The x position to scroll to, in scroll units.
|