wxruby3 0.9.1-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/controlwithitems.rb +8 -6
- 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/controlwithitems.rb +17 -7
- data/lib/wx/doc/data_object.rb +2 -2
- data/lib/wx/doc/evthandler.rb +113 -108
- data/lib/wx/doc/font.rb +1 -0
- 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 +4 -5
- data/lib/wx/doc/gen/animation.rb +7 -3
- data/lib/wx/doc/gen/animation_ctrl.rb +6 -7
- 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 +19 -7
- 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 +1 -0
- data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +1 -0
- data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +6 -1
- 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 +1 -1
- data/lib/wx/doc/gen/bitmap.rb +33 -16
- data/lib/wx/doc/gen/bitmap_button.rb +11 -8
- data/lib/wx/doc/gen/bitmap_combo_box.rb +12 -8
- 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 +23 -11
- data/lib/wx/doc/gen/calculate_layout_event.rb +1 -3
- data/lib/wx/doc/gen/calendar_ctrl.rb +16 -13
- 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 +7 -7
- data/lib/wx/doc/gen/check_list_box.rb +5 -6
- data/lib/wx/doc/gen/choice.rb +16 -9
- 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 +6 -7
- 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 +9 -10
- data/lib/wx/doc/gen/colour_picker_event.rb +4 -5
- data/lib/wx/doc/gen/combo_box.rb +16 -13
- data/lib/wx/doc/gen/combo_ctrl.rb +95 -32
- data/lib/wx/doc/gen/command_link_button.rb +4 -5
- data/lib/wx/doc/gen/context_help_button.rb +7 -3
- data/lib/wx/doc/gen/control.rb +10 -8
- 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 +15 -13
- data/lib/wx/doc/gen/date_event.rb +2 -2
- data/lib/wx/doc/gen/date_picker_ctrl.rb +12 -8
- data/lib/wx/doc/gen/dc.rb +155 -37
- data/lib/wx/doc/gen/defs.rb +51 -51
- data/lib/wx/doc/gen/dial_up_event.rb +1 -2
- data/lib/wx/doc/gen/dial_up_manager.rb +13 -5
- data/lib/wx/doc/gen/dialog.rb +33 -13
- 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 +9 -10
- 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 +2 -2
- data/lib/wx/doc/gen/event.rb +35 -19
- data/lib/wx/doc/gen/event_blocker.rb +1 -3
- data/lib/wx/doc/gen/event_list.rb +1656 -1652
- data/lib/wx/doc/gen/events.rb +162 -169
- 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 +19 -10
- data/lib/wx/doc/gen/file_ctrl_event.rb +3 -4
- data/lib/wx/doc/gen/file_dialog.rb +31 -14
- 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 +8 -9
- 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 +6 -7
- data/lib/wx/doc/gen/font_picker_event.rb +2 -3
- data/lib/wx/doc/gen/frame.rb +56 -15
- data/lib/wx/doc/gen/fs_file.rb +17 -10
- data/lib/wx/doc/gen/gauge.rb +11 -8
- 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 +6 -7
- data/lib/wx/doc/gen/graphics_context.rb +58 -11
- 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 +1 -1
- 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 +27 -5
- 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 +4 -11
- data/lib/wx/doc/gen/header_ctrl_event.rb +1 -3
- data/lib/wx/doc/gen/help_controller.rb +3 -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 +7 -2
- data/lib/wx/doc/gen/html/html_help_controller.rb +8 -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 +5 -7
- data/lib/wx/doc/gen/html/html_printout.rb +1 -2
- data/lib/wx/doc/gen/html/html_window.rb +12 -6
- data/lib/wx/doc/gen/hyperlink_ctrl.rb +7 -7
- 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 +29 -17
- data/lib/wx/doc/gen/list_ctrl.rb +76 -29
- 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 +28 -7
- data/lib/wx/doc/gen/media_ctrl.rb +26 -18
- 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 +41 -19
- data/lib/wx/doc/gen/message_dialog.rb +7 -8
- data/lib/wx/doc/gen/mini_frame.rb +11 -5
- 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 +17 -9
- 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 +17 -8
- 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 +81 -20
- data/lib/wx/doc/gen/pg/property_grid_event.rb +31 -9
- data/lib/wx/doc/gen/pg/property_grid_interface.rb +214 -36
- data/lib/wx/doc/gen/pg/property_grid_manager.rb +40 -10
- 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 +13 -3
- 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 +1 -1
- data/lib/wx/doc/gen/prt/print_abort_dialog.rb +3 -0
- 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 +9 -10
- data/lib/wx/doc/gen/radio_button.rb +13 -9
- 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 +1 -1
- 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 +1 -2
- data/lib/wx/doc/gen/rearrange_list.rb +3 -4
- 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 +10 -7
- data/lib/wx/doc/gen/rtc/rich_text_event.rb +3 -4
- data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +2 -4
- data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +2 -3
- 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 +2 -2
- data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +5 -5
- data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +1 -1
- data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +2 -3
- data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +1 -2
- data/lib/wx/doc/gen/sash_event.rb +9 -4
- data/lib/wx/doc/gen/sash_layout_window.rb +11 -4
- data/lib/wx/doc/gen/sash_window.rb +3 -4
- data/lib/wx/doc/gen/screen_dc.rb +0 -1
- data/lib/wx/doc/gen/scroll_bar.rb +19 -10
- data/lib/wx/doc/gen/scrolled_canvas.rb +32 -10
- data/lib/wx/doc/gen/scrolled_control.rb +32 -10
- data/lib/wx/doc/gen/scrolled_window.rb +32 -10
- data/lib/wx/doc/gen/search_ctrl.rb +8 -9
- 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 +27 -17
- data/lib/wx/doc/gen/spin_button.rb +15 -10
- 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 +76 -18
- data/lib/wx/doc/gen/static_bitmap.rb +10 -5
- data/lib/wx/doc/gen/static_box.rb +9 -7
- data/lib/wx/doc/gen/static_box_sizer.rb +0 -2
- data/lib/wx/doc/gen/static_line.rb +3 -4
- data/lib/wx/doc/gen/static_text.rb +5 -6
- data/lib/wx/doc/gen/status_bar.rb +19 -9
- data/lib/wx/doc/gen/stc/event_list.rb +212 -208
- data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +39 -13
- 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 +90 -25
- 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 +5 -6
- 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 +5 -6
- data/lib/wx/doc/gen/tool_bar.rb +98 -25
- 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 +69 -23
- data/lib/wx/doc/gen/tree_ctrl.rb +40 -16
- 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 +6 -2
- data/lib/wx/doc/gen/v_scrolled_window.rb +6 -4
- 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 +195 -45
- 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 -47
- data/lib/wx/doc/window_disabler.rb +10 -6
- data/lib/wx/grid/grid.rb +27 -4
- 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 +2 -2
- 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/treectrl/treectrl.rb +1 -1
- data/tests/media/beep_lo.wav +0 -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 +16 -0
- data/tests/test_std_controls.rb +42 -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 +28 -3
@@ -12,6 +12,7 @@ module Wx::PG
|
|
12
12
|
# - {Wx::PG::PG_BOOL_USE_CHECKBOX}: Set to true to use check box editor instead of combo box.
|
13
13
|
# - {Wx::PG::PG_BOOL_USE_DOUBLE_CLICK_CYCLING}: Set to true to cycle combo box instead showing the list.
|
14
14
|
#
|
15
|
+
# @wxrb_require USE_PROPGRID
|
15
16
|
class BoolProperty < PGProperty
|
16
17
|
|
17
18
|
# @param label [String]
|
@@ -21,7 +22,11 @@ module Wx::PG
|
|
21
22
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=false) end
|
22
23
|
|
23
24
|
# Converts property value into a text representation.
|
24
|
-
#
|
25
|
+
# <div class="wxrb-remark">
|
26
|
+
# <b>Remark:</b>
|
27
|
+
# <p>Default implementation calls {Wx::PG::BoolProperty#generate_composed_value}.
|
28
|
+
# </p>
|
29
|
+
# </div>>
|
25
30
|
# @param value [Wx::Variant] Value to be converted.
|
26
31
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
27
32
|
# @return [String]
|
@@ -30,7 +35,11 @@ module Wx::PG
|
|
30
35
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
31
36
|
# Returns true if resulting {Wx::Variant} value was different.
|
32
37
|
#
|
33
|
-
#
|
38
|
+
# <div class="wxrb-remark">
|
39
|
+
# <b>Remark:</b>
|
40
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
41
|
+
# </p>
|
42
|
+
# </div>>
|
34
43
|
#
|
35
44
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
36
45
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -42,10 +51,17 @@ module Wx::PG
|
|
42
51
|
# Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
|
43
52
|
# Returns true if resulting {Wx::Variant} value was different.
|
44
53
|
#
|
54
|
+
# <div class="wxrb-remark">
|
55
|
+
# <b>Remark:</b>
|
56
|
+
# <p>
|
57
|
+
#
|
45
58
|
# - If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.
|
46
59
|
# - Default implementation simply assign given int to m_value.
|
47
60
|
# - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
|
48
|
-
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
61
|
+
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
62
|
+
#
|
63
|
+
# </p>
|
64
|
+
# </div>>
|
49
65
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
50
66
|
# @param number [Integer] Integer to be translated into variant.
|
51
67
|
# @param argFlags [Integer] If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
|
@@ -55,7 +71,11 @@ module Wx::PG
|
|
55
71
|
# Reimplement this member function to add special handling for attributes of this property.
|
56
72
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
57
73
|
#
|
58
|
-
#
|
74
|
+
# <div class="wxrb-remark">
|
75
|
+
# <b>Remark:</b>
|
76
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
77
|
+
# </p>
|
78
|
+
# </div>>
|
59
79
|
# @param name [String]
|
60
80
|
# @param value [Wx::Variant]
|
61
81
|
# @return [Boolean]
|
@@ -77,6 +97,7 @@ module Wx::PG
|
|
77
97
|
# - {Wx::PG::PG_DATE_FORMAT}: Determines displayed date format.
|
78
98
|
# - {Wx::PG::PG_DATE_PICKER_STYLE}: Determines window style used with {Wx::DatePickerCtrl}. Default is {Wx::DP_DEFAULT} | {Wx::DP_SHOWCENTURY}. Using {Wx::DP_ALLOWNONE} enables additional support for unspecified property value.
|
79
99
|
#
|
100
|
+
# @wxrb_require USE_PROPGRID
|
80
101
|
class DateProperty < PGProperty
|
81
102
|
|
82
103
|
# @param label [String]
|
@@ -86,14 +107,25 @@ module Wx::PG
|
|
86
107
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=(Wx::DateTime.new())) end
|
87
108
|
|
88
109
|
# This virtual function is called after m_value has been set.
|
110
|
+
# <div class="wxrb-remark">
|
111
|
+
# <b>Remark:</b>
|
112
|
+
# <p>
|
113
|
+
#
|
89
114
|
# - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::DateProperty#on_set_value} will not be called.
|
90
115
|
# - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::DateProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
|
91
|
-
# - Default implementation does nothing.
|
116
|
+
# - Default implementation does nothing.
|
117
|
+
#
|
118
|
+
# </p>
|
119
|
+
# </div>>
|
92
120
|
# @return [void]
|
93
121
|
def on_set_value; end
|
94
122
|
|
95
123
|
# Converts property value into a text representation.
|
96
|
-
#
|
124
|
+
# <div class="wxrb-remark">
|
125
|
+
# <b>Remark:</b>
|
126
|
+
# <p>Default implementation calls {Wx::PG::DateProperty#generate_composed_value}.
|
127
|
+
# </p>
|
128
|
+
# </div>>
|
97
129
|
# @param value [Wx::Variant] Value to be converted.
|
98
130
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
99
131
|
# @return [String]
|
@@ -102,7 +134,11 @@ module Wx::PG
|
|
102
134
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
103
135
|
# Returns true if resulting {Wx::Variant} value was different.
|
104
136
|
#
|
105
|
-
#
|
137
|
+
# <div class="wxrb-remark">
|
138
|
+
# <b>Remark:</b>
|
139
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
140
|
+
# </p>
|
141
|
+
# </div>>
|
106
142
|
#
|
107
143
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
108
144
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -114,7 +150,11 @@ module Wx::PG
|
|
114
150
|
# Reimplement this member function to add special handling for attributes of this property.
|
115
151
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
116
152
|
#
|
117
|
-
#
|
153
|
+
# <div class="wxrb-remark">
|
154
|
+
# <b>Remark:</b>
|
155
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
156
|
+
# </p>
|
157
|
+
# </div>>
|
118
158
|
# @param name [String]
|
119
159
|
# @param value [Wx::Variant]
|
120
160
|
# @return [Boolean]
|
@@ -179,6 +219,7 @@ module Wx::PG
|
|
179
219
|
# Represents a bit set that fits in a long integer.
|
180
220
|
# {Wx::PG::BoolProperty} sub-properties are created for editing individual bits. Textctrl is created to manually edit the flags as a text; a continuous sequence of spaces, commas and semicolons is considered as a flag id separator. <b>Note:</b> When changing "choices" (ie. flag labels) of {Wx::PG::FlagsProperty}, you will need to use SetPropertyChoices - otherwise they will not get updated properly.
|
181
221
|
#
|
222
|
+
# @wxrb_require USE_PROPGRID
|
182
223
|
class FlagsProperty < PGProperty
|
183
224
|
|
184
225
|
# @overload initialize(label, name, choices, value=0)
|
@@ -197,14 +238,25 @@ module Wx::PG
|
|
197
238
|
def initialize(*args) end
|
198
239
|
|
199
240
|
# This virtual function is called after m_value has been set.
|
241
|
+
# <div class="wxrb-remark">
|
242
|
+
# <b>Remark:</b>
|
243
|
+
# <p>
|
244
|
+
#
|
200
245
|
# - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::FlagsProperty#on_set_value} will not be called.
|
201
246
|
# - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::FlagsProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
|
202
|
-
# - Default implementation does nothing.
|
247
|
+
# - Default implementation does nothing.
|
248
|
+
#
|
249
|
+
# </p>
|
250
|
+
# </div>>
|
203
251
|
# @return [void]
|
204
252
|
def on_set_value; end
|
205
253
|
|
206
254
|
# Converts property value into a text representation.
|
207
|
-
#
|
255
|
+
# <div class="wxrb-remark">
|
256
|
+
# <b>Remark:</b>
|
257
|
+
# <p>Default implementation calls {Wx::PG::FlagsProperty#generate_composed_value}.
|
258
|
+
# </p>
|
259
|
+
# </div>>
|
208
260
|
# @param value [Wx::Variant] Value to be converted.
|
209
261
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
210
262
|
# @return [String]
|
@@ -213,7 +265,11 @@ module Wx::PG
|
|
213
265
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
214
266
|
# Returns true if resulting {Wx::Variant} value was different.
|
215
267
|
#
|
216
|
-
#
|
268
|
+
# <div class="wxrb-remark">
|
269
|
+
# <b>Remark:</b>
|
270
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
271
|
+
# </p>
|
272
|
+
# </div>>
|
217
273
|
#
|
218
274
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
219
275
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -262,7 +318,11 @@ module Wx::PG
|
|
262
318
|
# Reimplement this member function to add special handling for attributes of this property.
|
263
319
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
264
320
|
#
|
265
|
-
#
|
321
|
+
# <div class="wxrb-remark">
|
322
|
+
# <b>Remark:</b>
|
323
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
324
|
+
# </p>
|
325
|
+
# </div>>
|
266
326
|
# @param name [String]
|
267
327
|
# @param value [Wx::Variant]
|
268
328
|
# @return [Boolean]
|
@@ -299,8 +359,16 @@ module Wx::PG
|
|
299
359
|
#
|
300
360
|
# - {Wx::PG::PG_STRING_PASSWORD}: set to true in order to enable {Wx::TE_PASSWORD} on the editor.
|
301
361
|
#
|
302
|
-
#
|
362
|
+
# <div class="wxrb-remark">
|
363
|
+
# <b>Remark:</b>
|
364
|
+
# <p>
|
365
|
+
#
|
366
|
+
# - If value "<composed>" is set, then actual value is formed (or composed) from values of child properties.
|
367
|
+
#
|
368
|
+
# </p>
|
369
|
+
# </div>>
|
303
370
|
#
|
371
|
+
# @wxrb_require USE_PROPGRID
|
304
372
|
class StringProperty < PGProperty
|
305
373
|
|
306
374
|
# @param label [String]
|
@@ -310,7 +378,11 @@ module Wx::PG
|
|
310
378
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
|
311
379
|
|
312
380
|
# Converts property value into a text representation.
|
313
|
-
#
|
381
|
+
# <div class="wxrb-remark">
|
382
|
+
# <b>Remark:</b>
|
383
|
+
# <p>Default implementation calls {Wx::PG::StringProperty#generate_composed_value}.
|
384
|
+
# </p>
|
385
|
+
# </div>>
|
314
386
|
# @param value [Wx::Variant] Value to be converted.
|
315
387
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
316
388
|
# @return [String]
|
@@ -319,7 +391,11 @@ module Wx::PG
|
|
319
391
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
320
392
|
# Returns true if resulting {Wx::Variant} value was different.
|
321
393
|
#
|
322
|
-
#
|
394
|
+
# <div class="wxrb-remark">
|
395
|
+
# <b>Remark:</b>
|
396
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
397
|
+
# </p>
|
398
|
+
# </div>>
|
323
399
|
#
|
324
400
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
325
401
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -331,7 +407,11 @@ module Wx::PG
|
|
331
407
|
# Reimplement this member function to add special handling for attributes of this property.
|
332
408
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
333
409
|
#
|
334
|
-
#
|
410
|
+
# <div class="wxrb-remark">
|
411
|
+
# <b>Remark:</b>
|
412
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
413
|
+
# </p>
|
414
|
+
# </div>>
|
335
415
|
# @param name [String]
|
336
416
|
# @param value [Wx::Variant]
|
337
417
|
# @return [Boolean]
|
@@ -354,6 +434,7 @@ module Wx::PG
|
|
354
434
|
# Category (caption) property.
|
355
435
|
#
|
356
436
|
#
|
437
|
+
# @wxrb_require USE_PROPGRID
|
357
438
|
class PropertyCategory < PGProperty
|
358
439
|
|
359
440
|
# @overload initialize()
|
@@ -372,14 +453,22 @@ module Wx::PG
|
|
372
453
|
alias_method :text_extent, :get_text_extent
|
373
454
|
|
374
455
|
# Converts property value into a text representation.
|
375
|
-
#
|
456
|
+
# <div class="wxrb-remark">
|
457
|
+
# <b>Remark:</b>
|
458
|
+
# <p>Default implementation calls {Wx::PG::PropertyCategory#generate_composed_value}.
|
459
|
+
# </p>
|
460
|
+
# </div>>
|
376
461
|
# @param value [Wx::Variant] Value to be converted.
|
377
462
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
378
463
|
# @return [String]
|
379
464
|
def value_to_string(value, argFlags) end
|
380
465
|
|
381
466
|
# Returns text representation of property's value.
|
382
|
-
#
|
467
|
+
# <div class="wxrb-remark">
|
468
|
+
# <b>Remark:</b>
|
469
|
+
# <p>In older versions, this function used to be overridden to convert property's value into a string representation. This function is now handled by {Wx::PG::PropertyCategory#value_to_string}, and overriding this function now will result in run-time assertion failure.
|
470
|
+
# </p>
|
471
|
+
# </div>>
|
383
472
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
384
473
|
# @return [String]
|
385
474
|
def get_value_as_string(argFlags=0) end
|
@@ -401,6 +490,7 @@ module Wx::PG
|
|
401
490
|
#
|
402
491
|
# - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the editor dialog.
|
403
492
|
#
|
493
|
+
# @wxrb_require USE_PROPGRID
|
404
494
|
class EditorDialogProperty < PGProperty
|
405
495
|
|
406
496
|
# Returns instance of a new {Wx::PG::PGEditorDialogAdapter} instance, which is used when user presses the (optional) button next to the editor control;.
|
@@ -412,7 +502,11 @@ module Wx::PG
|
|
412
502
|
# Reimplement this member function to add special handling for attributes of this property.
|
413
503
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
414
504
|
#
|
415
|
-
#
|
505
|
+
# <div class="wxrb-remark">
|
506
|
+
# <b>Remark:</b>
|
507
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
508
|
+
# </p>
|
509
|
+
# </div>>
|
416
510
|
# @param name [String]
|
417
511
|
# @param value [Wx::Variant]
|
418
512
|
# @return [Boolean]
|
@@ -476,12 +570,14 @@ module Wx::PG
|
|
476
570
|
# - {Wx::PG::PG_ARRAY_DELIMITER}: Sets string delimiter character.
|
477
571
|
# - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the editor dialog (since 3.1.3).
|
478
572
|
#
|
573
|
+
# @wxrb_require USE_PROPGRID
|
479
574
|
class ArrayStringProperty < EditorDialogProperty
|
480
575
|
|
481
576
|
#
|
482
577
|
#
|
483
578
|
#
|
484
579
|
#
|
580
|
+
# @wxrb_require USE_PROPGRID
|
485
581
|
class ConversionFlags < Wx::Enum
|
486
582
|
|
487
583
|
#
|
@@ -501,14 +597,25 @@ module Wx::PG
|
|
501
597
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=(Wx::ArrayString.new())) end
|
502
598
|
|
503
599
|
# This virtual function is called after m_value has been set.
|
600
|
+
# <div class="wxrb-remark">
|
601
|
+
# <b>Remark:</b>
|
602
|
+
# <p>
|
603
|
+
#
|
504
604
|
# - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::ArrayStringProperty#on_set_value} will not be called.
|
505
605
|
# - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::ArrayStringProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
|
506
|
-
# - Default implementation does nothing.
|
606
|
+
# - Default implementation does nothing.
|
607
|
+
#
|
608
|
+
# </p>
|
609
|
+
# </div>>
|
507
610
|
# @return [void]
|
508
611
|
def on_set_value; end
|
509
612
|
|
510
613
|
# Converts property value into a text representation.
|
511
|
-
#
|
614
|
+
# <div class="wxrb-remark">
|
615
|
+
# <b>Remark:</b>
|
616
|
+
# <p>Default implementation calls {Wx::PG::ArrayStringProperty#generate_composed_value}.
|
617
|
+
# </p>
|
618
|
+
# </div>>
|
512
619
|
# @param value [Wx::Variant] Value to be converted.
|
513
620
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
514
621
|
# @return [String]
|
@@ -517,7 +624,11 @@ module Wx::PG
|
|
517
624
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
518
625
|
# Returns true if resulting {Wx::Variant} value was different.
|
519
626
|
#
|
520
|
-
#
|
627
|
+
# <div class="wxrb-remark">
|
628
|
+
# <b>Remark:</b>
|
629
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
630
|
+
# </p>
|
631
|
+
# </div>>
|
521
632
|
#
|
522
633
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
523
634
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -529,7 +640,11 @@ module Wx::PG
|
|
529
640
|
# Reimplement this member function to add special handling for attributes of this property.
|
530
641
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
531
642
|
#
|
532
|
-
#
|
643
|
+
# <div class="wxrb-remark">
|
644
|
+
# <b>Remark:</b>
|
645
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
646
|
+
# </p>
|
647
|
+
# </div>>
|
533
648
|
# @param name [String]
|
534
649
|
# @param value [Wx::Variant]
|
535
650
|
# @return [Boolean]
|
@@ -621,6 +736,7 @@ module Wx::PG
|
|
621
736
|
#
|
622
737
|
# - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the file dialog (since 3.1.3).
|
623
738
|
#
|
739
|
+
# @wxrb_require USE_PROPGRID
|
624
740
|
class DirProperty < EditorDialogProperty
|
625
741
|
|
626
742
|
# @param label [String]
|
@@ -630,7 +746,11 @@ module Wx::PG
|
|
630
746
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
|
631
747
|
|
632
748
|
# Converts property value into a text representation.
|
633
|
-
#
|
749
|
+
# <div class="wxrb-remark">
|
750
|
+
# <b>Remark:</b>
|
751
|
+
# <p>Default implementation calls {Wx::PG::DirProperty#generate_composed_value}.
|
752
|
+
# </p>
|
753
|
+
# </div>>
|
634
754
|
# @param value [Wx::Variant] Value to be converted.
|
635
755
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
636
756
|
# @return [String]
|
@@ -639,7 +759,11 @@ module Wx::PG
|
|
639
759
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
640
760
|
# Returns true if resulting {Wx::Variant} value was different.
|
641
761
|
#
|
642
|
-
#
|
762
|
+
# <div class="wxrb-remark">
|
763
|
+
# <b>Remark:</b>
|
764
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
765
|
+
# </p>
|
766
|
+
# </div>>
|
643
767
|
#
|
644
768
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
645
769
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -649,7 +773,7 @@ module Wx::PG
|
|
649
773
|
def string_to_value(variant, text, argFlags=0) end
|
650
774
|
|
651
775
|
# Returns pointer to the {Wx::Validator} that should be used with the editor of this property (NULL for no validator).
|
652
|
-
# Setting validator explicitly via
|
776
|
+
# Setting validator explicitly via \#set_property_validator will override this.
|
653
777
|
# In most situations, code like this should work well:
|
654
778
|
#
|
655
779
|
# ```ruby
|
@@ -672,7 +796,11 @@ module Wx::PG
|
|
672
796
|
# end
|
673
797
|
# ```
|
674
798
|
#
|
675
|
-
#
|
799
|
+
# <div class="wxrb-remark">
|
800
|
+
# <b>Remark:</b>
|
801
|
+
# <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
802
|
+
# </p>
|
803
|
+
# </div>>
|
676
804
|
# @return [Wx::Validator]
|
677
805
|
def do_get_validator; end
|
678
806
|
|
@@ -708,6 +836,7 @@ module Wx::PG
|
|
708
836
|
# - {Wx::PG::PG_FILE_SHOW_RELATIVE_PATH}: If set, then the filename is shown relative to the given path string.
|
709
837
|
# - {Wx::PG::PG_FILE_INITIAL_PATH}: Sets the initial path of where to look for files.
|
710
838
|
#
|
839
|
+
# @wxrb_require USE_PROPGRID
|
711
840
|
class FileProperty < EditorDialogProperty
|
712
841
|
|
713
842
|
# @param label [String]
|
@@ -717,14 +846,25 @@ module Wx::PG
|
|
717
846
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
|
718
847
|
|
719
848
|
# This virtual function is called after m_value has been set.
|
849
|
+
# <div class="wxrb-remark">
|
850
|
+
# <b>Remark:</b>
|
851
|
+
# <p>
|
852
|
+
#
|
720
853
|
# - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::FileProperty#on_set_value} will not be called.
|
721
854
|
# - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::FileProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
|
722
|
-
# - Default implementation does nothing.
|
855
|
+
# - Default implementation does nothing.
|
856
|
+
#
|
857
|
+
# </p>
|
858
|
+
# </div>>
|
723
859
|
# @return [void]
|
724
860
|
def on_set_value; end
|
725
861
|
|
726
862
|
# Converts property value into a text representation.
|
727
|
-
#
|
863
|
+
# <div class="wxrb-remark">
|
864
|
+
# <b>Remark:</b>
|
865
|
+
# <p>Default implementation calls {Wx::PG::FileProperty#generate_composed_value}.
|
866
|
+
# </p>
|
867
|
+
# </div>>
|
728
868
|
# @param value [Wx::Variant] Value to be converted.
|
729
869
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
730
870
|
# @return [String]
|
@@ -733,7 +873,11 @@ module Wx::PG
|
|
733
873
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
734
874
|
# Returns true if resulting {Wx::Variant} value was different.
|
735
875
|
#
|
736
|
-
#
|
876
|
+
# <div class="wxrb-remark">
|
877
|
+
# <b>Remark:</b>
|
878
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
879
|
+
# </p>
|
880
|
+
# </div>>
|
737
881
|
#
|
738
882
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
739
883
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -745,14 +889,18 @@ module Wx::PG
|
|
745
889
|
# Reimplement this member function to add special handling for attributes of this property.
|
746
890
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
747
891
|
#
|
748
|
-
#
|
892
|
+
# <div class="wxrb-remark">
|
893
|
+
# <b>Remark:</b>
|
894
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
895
|
+
# </p>
|
896
|
+
# </div>>
|
749
897
|
# @param name [String]
|
750
898
|
# @param value [Wx::Variant]
|
751
899
|
# @return [Boolean]
|
752
900
|
def do_set_attribute(name, value) end
|
753
901
|
|
754
902
|
# Returns pointer to the {Wx::Validator} that should be used with the editor of this property (NULL for no validator).
|
755
|
-
# Setting validator explicitly via
|
903
|
+
# Setting validator explicitly via \#set_property_validator will override this.
|
756
904
|
# In most situations, code like this should work well:
|
757
905
|
#
|
758
906
|
# ```ruby
|
@@ -775,7 +923,11 @@ module Wx::PG
|
|
775
923
|
# end
|
776
924
|
# ```
|
777
925
|
#
|
778
|
-
#
|
926
|
+
# <div class="wxrb-remark">
|
927
|
+
# <b>Remark:</b>
|
928
|
+
# <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
929
|
+
# </p>
|
930
|
+
# </div>>
|
779
931
|
# @return [Wx::Validator]
|
780
932
|
def do_get_validator; end
|
781
933
|
|
@@ -868,6 +1020,7 @@ module Wx::PG
|
|
868
1020
|
# - {Wx::PG::PG_FILE_SHOW_RELATIVE_PATH}: If set, then the filename is shown relative to the given path string.
|
869
1021
|
# - {Wx::PG::PG_FILE_INITIAL_PATH}: Sets the initial path of where to look for files.
|
870
1022
|
#
|
1023
|
+
# @wxrb_require USE_PROPGRID
|
871
1024
|
class ImageFileProperty < FileProperty
|
872
1025
|
|
873
1026
|
# @param label [String]
|
@@ -877,18 +1030,32 @@ module Wx::PG
|
|
877
1030
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
|
878
1031
|
|
879
1032
|
# This virtual function is called after m_value has been set.
|
1033
|
+
# <div class="wxrb-remark">
|
1034
|
+
# <b>Remark:</b>
|
1035
|
+
# <p>
|
1036
|
+
#
|
880
1037
|
# - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::ImageFileProperty#on_set_value} will not be called.
|
881
1038
|
# - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::ImageFileProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
|
882
|
-
# - Default implementation does nothing.
|
1039
|
+
# - Default implementation does nothing.
|
1040
|
+
#
|
1041
|
+
# </p>
|
1042
|
+
# </div>>
|
883
1043
|
# @return [void]
|
884
1044
|
def on_set_value; end
|
885
1045
|
|
886
1046
|
# Returns size of the custom painted image in front of property.
|
887
1047
|
# This method must be overridden to return non-default value if OnCustomPaint is to be called.
|
888
1048
|
#
|
1049
|
+
# <div class="wxrb-remark">
|
1050
|
+
# <b>Remark:</b>
|
1051
|
+
# <p>
|
1052
|
+
#
|
889
1053
|
# - Default behaviour is to return {size(0,0)}, which means no image.
|
890
1054
|
# - Default image width or height is indicated with dimension -1.
|
891
|
-
# - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
|
1055
|
+
# - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
|
1056
|
+
#
|
1057
|
+
# </p>
|
1058
|
+
# </div>>
|
892
1059
|
# @param item [Integer] Normally -1, but can be an index to the property's list of items.
|
893
1060
|
# @return [Wx::Size]
|
894
1061
|
def on_measure_image(item) end
|
@@ -897,10 +1064,17 @@ module Wx::PG
|
|
897
1064
|
# If property's {Wx::PG::ImageFileProperty#on_measure_image} returns size that has height != 0 but less than row height ( < 0 has special meanings), {Wx::PG::PropertyGrid} calls this method to draw a custom image in a limited area in front of the editor control or value text/graphics, and if control has drop-down list, then the image is drawn there as well (even in the case {Wx::PG::ImageFileProperty#on_measure_image} returned higher height than row height).
|
898
1065
|
# NOTE: Following applies when {Wx::PG::ImageFileProperty#on_measure_image} returns a "flexible" height ( using <code>wxPG_FLEXIBLE_SIZE(W,H)</code> macro), which implies variable height items: If (rect.x+rect.width) is < 0, then this is a measure item call, which means that dc is invalid and only thing that should be done is to set paintdata.m_drawnHeight to the height of the image of item at index paintdata.m_choiceItem. This call may be done even as often as once every drop-down popup show.
|
899
1066
|
#
|
1067
|
+
# <div class="wxrb-remark">
|
1068
|
+
# <b>Remark:</b>
|
1069
|
+
# <p>
|
1070
|
+
#
|
900
1071
|
# - You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth must be set to the full width drawn in pixels.
|
901
1072
|
# - Due to technical reasons, rect's height will be default even if custom height was reported during measure call.
|
902
1073
|
# - Brush is guaranteed to be default background colour. It has been already used to clear the background of area being painted. It can be modified.
|
903
1074
|
# - Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for drawing framing rectangle. It can be changed as well.
|
1075
|
+
#
|
1076
|
+
# </p>
|
1077
|
+
# </div>>
|
904
1078
|
# @see Wx::PG::ImageFileProperty#value_to_string
|
905
1079
|
# @param dc [Wx::DC] {Wx::DC} to paint on.
|
906
1080
|
# @param rect [Wx::Rect] Box reserved for custom graphics. Includes surrounding rectangle, if any. If x+width is < 0, then this is a measure item call (see above).
|
@@ -923,6 +1097,7 @@ module Wx::PG
|
|
923
1097
|
#
|
924
1098
|
# - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the font dialog (since 3.1.3).
|
925
1099
|
#
|
1100
|
+
# @wxrb_require USE_PROPGRID
|
926
1101
|
class FontProperty < EditorDialogProperty
|
927
1102
|
|
928
1103
|
# @param label [String]
|
@@ -932,14 +1107,25 @@ module Wx::PG
|
|
932
1107
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=(Wx::Font.new())) end
|
933
1108
|
|
934
1109
|
# This virtual function is called after m_value has been set.
|
1110
|
+
# <div class="wxrb-remark">
|
1111
|
+
# <b>Remark:</b>
|
1112
|
+
# <p>
|
1113
|
+
#
|
935
1114
|
# - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::FontProperty#on_set_value} will not be called.
|
936
1115
|
# - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::FontProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
|
937
|
-
# - Default implementation does nothing.
|
1116
|
+
# - Default implementation does nothing.
|
1117
|
+
#
|
1118
|
+
# </p>
|
1119
|
+
# </div>>
|
938
1120
|
# @return [void]
|
939
1121
|
def on_set_value; end
|
940
1122
|
|
941
1123
|
# Converts property value into a text representation.
|
942
|
-
#
|
1124
|
+
# <div class="wxrb-remark">
|
1125
|
+
# <b>Remark:</b>
|
1126
|
+
# <p>Default implementation calls {Wx::PG::FontProperty#generate_composed_value}.
|
1127
|
+
# </p>
|
1128
|
+
# </div>>
|
943
1129
|
# @param value [Wx::Variant] Value to be converted.
|
944
1130
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
945
1131
|
# @return [String]
|
@@ -1015,6 +1201,7 @@ module Wx::PG
|
|
1015
1201
|
#
|
1016
1202
|
# - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the text editor dialog (since 3.1.3).
|
1017
1203
|
#
|
1204
|
+
# @wxrb_require USE_PROPGRID
|
1018
1205
|
class LongStringProperty < EditorDialogProperty
|
1019
1206
|
|
1020
1207
|
# @param label [String]
|
@@ -1024,7 +1211,11 @@ module Wx::PG
|
|
1024
1211
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
|
1025
1212
|
|
1026
1213
|
# Converts property value into a text representation.
|
1027
|
-
#
|
1214
|
+
# <div class="wxrb-remark">
|
1215
|
+
# <b>Remark:</b>
|
1216
|
+
# <p>Default implementation calls {Wx::PG::LongStringProperty#generate_composed_value}.
|
1217
|
+
# </p>
|
1218
|
+
# </div>>
|
1028
1219
|
# @param value [Wx::Variant] Value to be converted.
|
1029
1220
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
1030
1221
|
# @return [String]
|
@@ -1033,7 +1224,11 @@ module Wx::PG
|
|
1033
1224
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
1034
1225
|
# Returns true if resulting {Wx::Variant} value was different.
|
1035
1226
|
#
|
1036
|
-
#
|
1227
|
+
# <div class="wxrb-remark">
|
1228
|
+
# <b>Remark:</b>
|
1229
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
1230
|
+
# </p>
|
1231
|
+
# </div>>
|
1037
1232
|
#
|
1038
1233
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
1039
1234
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -1071,6 +1266,7 @@ module Wx::PG
|
|
1071
1266
|
# - {Wx::PG::PG_ATTR_MULTICHOICE_USERSTRINGMODE}: If > 0, allow user to manually enter strings that are not in the list of choices. If this value is 1, user strings are preferably placed in front of valid choices. If value is 2, then those strings will placed behind valid choices.
|
1072
1267
|
# - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the editor dialog (since 3.1.3).
|
1073
1268
|
#
|
1269
|
+
# @wxrb_require USE_PROPGRID
|
1074
1270
|
class MultiChoiceProperty < EditorDialogProperty
|
1075
1271
|
|
1076
1272
|
# @overload initialize(label, name, strings, value)
|
@@ -1093,14 +1289,25 @@ module Wx::PG
|
|
1093
1289
|
def initialize(*args) end
|
1094
1290
|
|
1095
1291
|
# This virtual function is called after m_value has been set.
|
1292
|
+
# <div class="wxrb-remark">
|
1293
|
+
# <b>Remark:</b>
|
1294
|
+
# <p>
|
1295
|
+
#
|
1096
1296
|
# - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::MultiChoiceProperty#on_set_value} will not be called.
|
1097
1297
|
# - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::MultiChoiceProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
|
1098
|
-
# - Default implementation does nothing.
|
1298
|
+
# - Default implementation does nothing.
|
1299
|
+
#
|
1300
|
+
# </p>
|
1301
|
+
# </div>>
|
1099
1302
|
# @return [void]
|
1100
1303
|
def on_set_value; end
|
1101
1304
|
|
1102
1305
|
# Converts property value into a text representation.
|
1103
|
-
#
|
1306
|
+
# <div class="wxrb-remark">
|
1307
|
+
# <b>Remark:</b>
|
1308
|
+
# <p>Default implementation calls {Wx::PG::MultiChoiceProperty#generate_composed_value}.
|
1309
|
+
# </p>
|
1310
|
+
# </div>>
|
1104
1311
|
# @param value [Wx::Variant] Value to be converted.
|
1105
1312
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
1106
1313
|
# @return [String]
|
@@ -1109,7 +1316,11 @@ module Wx::PG
|
|
1109
1316
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
1110
1317
|
# Returns true if resulting {Wx::Variant} value was different.
|
1111
1318
|
#
|
1112
|
-
#
|
1319
|
+
# <div class="wxrb-remark">
|
1320
|
+
# <b>Remark:</b>
|
1321
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
1322
|
+
# </p>
|
1323
|
+
# </div>>
|
1113
1324
|
#
|
1114
1325
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
1115
1326
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -1184,12 +1395,17 @@ module Wx::PG
|
|
1184
1395
|
# - {Wx::PG::PG_ATTR_SPINCTRL_WRAP}: Specify if value modified with SpinCtrl editor wraps at Min/Max.
|
1185
1396
|
# - {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Specify if value can also by changed with SpinCtrl editor by moving mouse when left mouse button is being pressed.
|
1186
1397
|
#
|
1398
|
+
# @wxrb_require USE_PROPGRID
|
1187
1399
|
class NumericProperty < PGProperty
|
1188
1400
|
|
1189
1401
|
# Reimplement this member function to add special handling for attributes of this property.
|
1190
1402
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
1191
1403
|
#
|
1192
|
-
#
|
1404
|
+
# <div class="wxrb-remark">
|
1405
|
+
# <b>Remark:</b>
|
1406
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
1407
|
+
# </p>
|
1408
|
+
# </div>>
|
1193
1409
|
# @param name [String]
|
1194
1410
|
# @param value [Wx::Variant]
|
1195
1411
|
# @return [Boolean]
|
@@ -1200,7 +1416,11 @@ module Wx::PG
|
|
1200
1416
|
#
|
1201
1417
|
# Value which property would have after adding SpinCtrl editor step.
|
1202
1418
|
#
|
1203
|
-
#
|
1419
|
+
# <div class="wxrb-remark">
|
1420
|
+
# <b>Remark:</b>
|
1421
|
+
# <p>Current property value is not changed.
|
1422
|
+
# </p>
|
1423
|
+
# </div>>
|
1204
1424
|
# @param stepScale [Integer] SpinCtrl editor step is first multiplied by this factor and next added to the current value.
|
1205
1425
|
# @return [Wx::Variant]
|
1206
1426
|
def add_spin_step_value(stepScale) end
|
@@ -1292,6 +1512,7 @@ module Wx::PG
|
|
1292
1512
|
# <b>Supported special attributes:</b>
|
1293
1513
|
# - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}, {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: like in {Wx::PG::NumericProperty}.
|
1294
1514
|
#
|
1515
|
+
# @wxrb_require USE_PROPGRID
|
1295
1516
|
class IntProperty < NumericProperty
|
1296
1517
|
|
1297
1518
|
# @overload initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=0)
|
@@ -1307,7 +1528,11 @@ module Wx::PG
|
|
1307
1528
|
def initialize(*args) end
|
1308
1529
|
|
1309
1530
|
# Converts property value into a text representation.
|
1310
|
-
#
|
1531
|
+
# <div class="wxrb-remark">
|
1532
|
+
# <b>Remark:</b>
|
1533
|
+
# <p>Default implementation calls {Wx::PG::IntProperty#generate_composed_value}.
|
1534
|
+
# </p>
|
1535
|
+
# </div>>
|
1311
1536
|
# @param value [Wx::Variant] Value to be converted.
|
1312
1537
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
1313
1538
|
# @return [String]
|
@@ -1316,7 +1541,11 @@ module Wx::PG
|
|
1316
1541
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
1317
1542
|
# Returns true if resulting {Wx::Variant} value was different.
|
1318
1543
|
#
|
1319
|
-
#
|
1544
|
+
# <div class="wxrb-remark">
|
1545
|
+
# <b>Remark:</b>
|
1546
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
1547
|
+
# </p>
|
1548
|
+
# </div>>
|
1320
1549
|
#
|
1321
1550
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
1322
1551
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -1328,7 +1557,14 @@ module Wx::PG
|
|
1328
1557
|
# Implement this function in derived class to check the value.
|
1329
1558
|
# Return true if it is ok. Returning false prevents property change events from occurring.
|
1330
1559
|
#
|
1331
|
-
# -
|
1560
|
+
# <div class="wxrb-remark">
|
1561
|
+
# <b>Remark:</b>
|
1562
|
+
# <p>
|
1563
|
+
#
|
1564
|
+
# - Default implementation always returns true.
|
1565
|
+
#
|
1566
|
+
# </p>
|
1567
|
+
# </div>>
|
1332
1568
|
# @param value [Wx::Variant]
|
1333
1569
|
# @param validationInfo [Wx::PG::PGValidationInfo]
|
1334
1570
|
# @return [Boolean]
|
@@ -1337,10 +1573,17 @@ module Wx::PG
|
|
1337
1573
|
# Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
|
1338
1574
|
# Returns true if resulting {Wx::Variant} value was different.
|
1339
1575
|
#
|
1576
|
+
# <div class="wxrb-remark">
|
1577
|
+
# <b>Remark:</b>
|
1578
|
+
# <p>
|
1579
|
+
#
|
1340
1580
|
# - If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.
|
1341
1581
|
# - Default implementation simply assign given int to m_value.
|
1342
1582
|
# - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
|
1343
|
-
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
1583
|
+
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
1584
|
+
#
|
1585
|
+
# </p>
|
1586
|
+
# </div>>
|
1344
1587
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
1345
1588
|
# @param number [Integer] Integer to be translated into variant.
|
1346
1589
|
# @param argFlags [Integer] If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
|
@@ -1348,7 +1591,7 @@ module Wx::PG
|
|
1348
1591
|
def int_to_value(variant, number, argFlags=0) end
|
1349
1592
|
|
1350
1593
|
# Returns pointer to the {Wx::Validator} that should be used with the editor of this property (NULL for no validator).
|
1351
|
-
# Setting validator explicitly via
|
1594
|
+
# Setting validator explicitly via \#set_property_validator will override this.
|
1352
1595
|
# In most situations, code like this should work well:
|
1353
1596
|
#
|
1354
1597
|
# ```ruby
|
@@ -1371,7 +1614,11 @@ module Wx::PG
|
|
1371
1614
|
# end
|
1372
1615
|
# ```
|
1373
1616
|
#
|
1374
|
-
#
|
1617
|
+
# <div class="wxrb-remark">
|
1618
|
+
# <b>Remark:</b>
|
1619
|
+
# <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
1620
|
+
# </p>
|
1621
|
+
# </div>>
|
1375
1622
|
# @return [Wx::Validator]
|
1376
1623
|
def do_get_validator; end
|
1377
1624
|
|
@@ -1380,7 +1627,11 @@ module Wx::PG
|
|
1380
1627
|
#
|
1381
1628
|
# Value which property would have after adding SpinCtrl editor step.
|
1382
1629
|
#
|
1383
|
-
#
|
1630
|
+
# <div class="wxrb-remark">
|
1631
|
+
# <b>Remark:</b>
|
1632
|
+
# <p>Current property value is not changed.
|
1633
|
+
# </p>
|
1634
|
+
# </div>>
|
1384
1635
|
# @param stepScale [Integer] SpinCtrl editor step is first multiplied by this factor and next added to the current value.
|
1385
1636
|
# @return [Wx::Variant]
|
1386
1637
|
def add_spin_step_value(stepScale) end
|
@@ -1444,6 +1695,7 @@ module Wx::PG
|
|
1444
1695
|
# - {Wx::PG::PG_FLOAT_PRECISION}: Sets the (max) precision used when floating point value is rendered as text. The default -1 means infinite precision.
|
1445
1696
|
# - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}, {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: like in {Wx::PG::NumericProperty}.
|
1446
1697
|
#
|
1698
|
+
# @wxrb_require USE_PROPGRID
|
1447
1699
|
class FloatProperty < NumericProperty
|
1448
1700
|
|
1449
1701
|
# @param label [String]
|
@@ -1453,7 +1705,11 @@ module Wx::PG
|
|
1453
1705
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=0.0) end
|
1454
1706
|
|
1455
1707
|
# Converts property value into a text representation.
|
1456
|
-
#
|
1708
|
+
# <div class="wxrb-remark">
|
1709
|
+
# <b>Remark:</b>
|
1710
|
+
# <p>Default implementation calls {Wx::PG::FloatProperty#generate_composed_value}.
|
1711
|
+
# </p>
|
1712
|
+
# </div>>
|
1457
1713
|
# @param value [Wx::Variant] Value to be converted.
|
1458
1714
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
1459
1715
|
# @return [String]
|
@@ -1462,7 +1718,11 @@ module Wx::PG
|
|
1462
1718
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
1463
1719
|
# Returns true if resulting {Wx::Variant} value was different.
|
1464
1720
|
#
|
1465
|
-
#
|
1721
|
+
# <div class="wxrb-remark">
|
1722
|
+
# <b>Remark:</b>
|
1723
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
1724
|
+
# </p>
|
1725
|
+
# </div>>
|
1466
1726
|
#
|
1467
1727
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
1468
1728
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -1474,7 +1734,11 @@ module Wx::PG
|
|
1474
1734
|
# Reimplement this member function to add special handling for attributes of this property.
|
1475
1735
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
1476
1736
|
#
|
1477
|
-
#
|
1737
|
+
# <div class="wxrb-remark">
|
1738
|
+
# <b>Remark:</b>
|
1739
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
1740
|
+
# </p>
|
1741
|
+
# </div>>
|
1478
1742
|
# @param name [String]
|
1479
1743
|
# @param value [Wx::Variant]
|
1480
1744
|
# @return [Boolean]
|
@@ -1483,14 +1747,21 @@ module Wx::PG
|
|
1483
1747
|
# Implement this function in derived class to check the value.
|
1484
1748
|
# Return true if it is ok. Returning false prevents property change events from occurring.
|
1485
1749
|
#
|
1486
|
-
# -
|
1750
|
+
# <div class="wxrb-remark">
|
1751
|
+
# <b>Remark:</b>
|
1752
|
+
# <p>
|
1753
|
+
#
|
1754
|
+
# - Default implementation always returns true.
|
1755
|
+
#
|
1756
|
+
# </p>
|
1757
|
+
# </div>>
|
1487
1758
|
# @param value [Wx::Variant]
|
1488
1759
|
# @param validationInfo [Wx::PG::PGValidationInfo]
|
1489
1760
|
# @return [Boolean]
|
1490
1761
|
def validate_value(value, validationInfo) end
|
1491
1762
|
|
1492
1763
|
# Returns pointer to the {Wx::Validator} that should be used with the editor of this property (NULL for no validator).
|
1493
|
-
# Setting validator explicitly via
|
1764
|
+
# Setting validator explicitly via \#set_property_validator will override this.
|
1494
1765
|
# In most situations, code like this should work well:
|
1495
1766
|
#
|
1496
1767
|
# ```ruby
|
@@ -1513,7 +1784,11 @@ module Wx::PG
|
|
1513
1784
|
# end
|
1514
1785
|
# ```
|
1515
1786
|
#
|
1516
|
-
#
|
1787
|
+
# <div class="wxrb-remark">
|
1788
|
+
# <b>Remark:</b>
|
1789
|
+
# <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
1790
|
+
# </p>
|
1791
|
+
# </div>>
|
1517
1792
|
# @return [Wx::Validator]
|
1518
1793
|
def do_get_validator; end
|
1519
1794
|
|
@@ -1522,7 +1797,11 @@ module Wx::PG
|
|
1522
1797
|
#
|
1523
1798
|
# Value which property would have after adding SpinCtrl editor step.
|
1524
1799
|
#
|
1525
|
-
#
|
1800
|
+
# <div class="wxrb-remark">
|
1801
|
+
# <b>Remark:</b>
|
1802
|
+
# <p>Current property value is not changed.
|
1803
|
+
# </p>
|
1804
|
+
# </div>>
|
1526
1805
|
# @param stepScale [Integer] SpinCtrl editor step is first multiplied by this factor and next added to the current value.
|
1527
1806
|
# @return [Wx::Variant]
|
1528
1807
|
def add_spin_step_value(stepScale) end
|
@@ -1600,8 +1879,16 @@ module Wx::PG
|
|
1600
1879
|
# - {Wx::PG::PG_UINT_PREFIX}: Possible values are {Wx::PG::PG_PREFIX_NONE}, {Wx::PG::PG_PREFIX_0x}, and {Wx::PG::PG_PREFIX_DOLLAR_SIGN}. Only {Wx::PG::PG_PREFIX_NONE} works with Decimal and Octal numbers.
|
1601
1880
|
# - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}, {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: like in {Wx::PG::NumericProperty}.
|
1602
1881
|
#
|
1603
|
-
#
|
1882
|
+
# <div class="wxrb-remark">
|
1883
|
+
# <b>Remark:</b>
|
1884
|
+
# <p>
|
1885
|
+
#
|
1886
|
+
# - For example how to use seamless 64-bit integer support, see {Wx::PG::IntProperty} documentation (just use {Wx::ULongLong} instead of {Wx::LongLong}).
|
1604
1887
|
#
|
1888
|
+
# </p>
|
1889
|
+
# </div>>
|
1890
|
+
#
|
1891
|
+
# @wxrb_require USE_PROPGRID
|
1605
1892
|
class UIntProperty < NumericProperty
|
1606
1893
|
|
1607
1894
|
# @overload initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=0)
|
@@ -1617,7 +1904,11 @@ module Wx::PG
|
|
1617
1904
|
def initialize(*args) end
|
1618
1905
|
|
1619
1906
|
# Converts property value into a text representation.
|
1620
|
-
#
|
1907
|
+
# <div class="wxrb-remark">
|
1908
|
+
# <b>Remark:</b>
|
1909
|
+
# <p>Default implementation calls {Wx::PG::UIntProperty#generate_composed_value}.
|
1910
|
+
# </p>
|
1911
|
+
# </div>>
|
1621
1912
|
# @param value [Wx::Variant] Value to be converted.
|
1622
1913
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
1623
1914
|
# @return [String]
|
@@ -1626,7 +1917,11 @@ module Wx::PG
|
|
1626
1917
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
1627
1918
|
# Returns true if resulting {Wx::Variant} value was different.
|
1628
1919
|
#
|
1629
|
-
#
|
1920
|
+
# <div class="wxrb-remark">
|
1921
|
+
# <b>Remark:</b>
|
1922
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
1923
|
+
# </p>
|
1924
|
+
# </div>>
|
1630
1925
|
#
|
1631
1926
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
1632
1927
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -1638,7 +1933,11 @@ module Wx::PG
|
|
1638
1933
|
# Reimplement this member function to add special handling for attributes of this property.
|
1639
1934
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
1640
1935
|
#
|
1641
|
-
#
|
1936
|
+
# <div class="wxrb-remark">
|
1937
|
+
# <b>Remark:</b>
|
1938
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
1939
|
+
# </p>
|
1940
|
+
# </div>>
|
1642
1941
|
# @param name [String]
|
1643
1942
|
# @param value [Wx::Variant]
|
1644
1943
|
# @return [Boolean]
|
@@ -1647,14 +1946,21 @@ module Wx::PG
|
|
1647
1946
|
# Implement this function in derived class to check the value.
|
1648
1947
|
# Return true if it is ok. Returning false prevents property change events from occurring.
|
1649
1948
|
#
|
1650
|
-
# -
|
1949
|
+
# <div class="wxrb-remark">
|
1950
|
+
# <b>Remark:</b>
|
1951
|
+
# <p>
|
1952
|
+
#
|
1953
|
+
# - Default implementation always returns true.
|
1954
|
+
#
|
1955
|
+
# </p>
|
1956
|
+
# </div>>
|
1651
1957
|
# @param value [Wx::Variant]
|
1652
1958
|
# @param validationInfo [Wx::PG::PGValidationInfo]
|
1653
1959
|
# @return [Boolean]
|
1654
1960
|
def validate_value(value, validationInfo) end
|
1655
1961
|
|
1656
1962
|
# Returns pointer to the {Wx::Validator} that should be used with the editor of this property (NULL for no validator).
|
1657
|
-
# Setting validator explicitly via
|
1963
|
+
# Setting validator explicitly via \#set_property_validator will override this.
|
1658
1964
|
# In most situations, code like this should work well:
|
1659
1965
|
#
|
1660
1966
|
# ```ruby
|
@@ -1677,17 +1983,28 @@ module Wx::PG
|
|
1677
1983
|
# end
|
1678
1984
|
# ```
|
1679
1985
|
#
|
1680
|
-
#
|
1986
|
+
# <div class="wxrb-remark">
|
1987
|
+
# <b>Remark:</b>
|
1988
|
+
# <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
1989
|
+
# </p>
|
1990
|
+
# </div>>
|
1681
1991
|
# @return [Wx::Validator]
|
1682
1992
|
def do_get_validator; end
|
1683
1993
|
|
1684
1994
|
# Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
|
1685
1995
|
# Returns true if resulting {Wx::Variant} value was different.
|
1686
1996
|
#
|
1997
|
+
# <div class="wxrb-remark">
|
1998
|
+
# <b>Remark:</b>
|
1999
|
+
# <p>
|
2000
|
+
#
|
1687
2001
|
# - If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.
|
1688
2002
|
# - Default implementation simply assign given int to m_value.
|
1689
2003
|
# - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
|
1690
|
-
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
2004
|
+
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
2005
|
+
#
|
2006
|
+
# </p>
|
2007
|
+
# </div>>
|
1691
2008
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
1692
2009
|
# @param number [Integer] Integer to be translated into variant.
|
1693
2010
|
# @param argFlags [Integer] If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
|
@@ -1699,7 +2016,11 @@ module Wx::PG
|
|
1699
2016
|
#
|
1700
2017
|
# Value which property would have after adding SpinCtrl editor step.
|
1701
2018
|
#
|
1702
|
-
#
|
2019
|
+
# <div class="wxrb-remark">
|
2020
|
+
# <b>Remark:</b>
|
2021
|
+
# <p>Current property value is not changed.
|
2022
|
+
# </p>
|
2023
|
+
# </div>>
|
1703
2024
|
# @param stepScale [Integer] SpinCtrl editor step is first multiplied by this factor and next added to the current value.
|
1704
2025
|
# @return [Wx::Variant]
|
1705
2026
|
def add_spin_step_value(stepScale) end
|
@@ -1793,8 +2114,16 @@ module Wx::PG
|
|
1793
2114
|
# You can derive custom properties with choices from this class.
|
1794
2115
|
# See {Wx::BaseEnumProperty} for remarks.
|
1795
2116
|
#
|
1796
|
-
#
|
2117
|
+
# <div class="wxrb-remark">
|
2118
|
+
# <b>Remark:</b>
|
2119
|
+
# <p>
|
2120
|
+
#
|
2121
|
+
# - Updating private index is important. You can do this either by calling {Wx::PG::EnumProperty#set_index} in IntToValue, and then letting Wx::BaseEnumProperty::OnSetValue be called (by not implementing it, or by calling super class function in it) -OR- you can just call SetIndex in OnSetValue.
|
2122
|
+
#
|
2123
|
+
# </p>
|
2124
|
+
# </div>>
|
1797
2125
|
#
|
2126
|
+
# @wxrb_require USE_PROPGRID
|
1798
2127
|
class EnumProperty < PGProperty
|
1799
2128
|
|
1800
2129
|
# @overload initialize(label, name, choices, value=0)
|
@@ -1817,14 +2146,25 @@ module Wx::PG
|
|
1817
2146
|
alias_method :item_count, :get_item_count
|
1818
2147
|
|
1819
2148
|
# This virtual function is called after m_value has been set.
|
2149
|
+
# <div class="wxrb-remark">
|
2150
|
+
# <b>Remark:</b>
|
2151
|
+
# <p>
|
2152
|
+
#
|
1820
2153
|
# - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::EnumProperty#on_set_value} will not be called.
|
1821
2154
|
# - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::EnumProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
|
1822
|
-
# - Default implementation does nothing.
|
2155
|
+
# - Default implementation does nothing.
|
2156
|
+
#
|
2157
|
+
# </p>
|
2158
|
+
# </div>>
|
1823
2159
|
# @return [void]
|
1824
2160
|
def on_set_value; end
|
1825
2161
|
|
1826
2162
|
# Converts property value into a text representation.
|
1827
|
-
#
|
2163
|
+
# <div class="wxrb-remark">
|
2164
|
+
# <b>Remark:</b>
|
2165
|
+
# <p>Default implementation calls {Wx::PG::EnumProperty#generate_composed_value}.
|
2166
|
+
# </p>
|
2167
|
+
# </div>>
|
1828
2168
|
# @param value [Wx::Variant] Value to be converted.
|
1829
2169
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
1830
2170
|
# @return [String]
|
@@ -1833,7 +2173,11 @@ module Wx::PG
|
|
1833
2173
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
1834
2174
|
# Returns true if resulting {Wx::Variant} value was different.
|
1835
2175
|
#
|
1836
|
-
#
|
2176
|
+
# <div class="wxrb-remark">
|
2177
|
+
# <b>Remark:</b>
|
2178
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
2179
|
+
# </p>
|
2180
|
+
# </div>>
|
1837
2181
|
#
|
1838
2182
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
1839
2183
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -1845,7 +2189,14 @@ module Wx::PG
|
|
1845
2189
|
# Implement this function in derived class to check the value.
|
1846
2190
|
# Return true if it is ok. Returning false prevents property change events from occurring.
|
1847
2191
|
#
|
1848
|
-
# -
|
2192
|
+
# <div class="wxrb-remark">
|
2193
|
+
# <b>Remark:</b>
|
2194
|
+
# <p>
|
2195
|
+
#
|
2196
|
+
# - Default implementation always returns true.
|
2197
|
+
#
|
2198
|
+
# </p>
|
2199
|
+
# </div>>
|
1849
2200
|
# @param value [Wx::Variant]
|
1850
2201
|
# @param validationInfo [Wx::PG::PGValidationInfo]
|
1851
2202
|
# @return [Boolean]
|
@@ -1854,10 +2205,17 @@ module Wx::PG
|
|
1854
2205
|
# Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
|
1855
2206
|
# Returns true if resulting {Wx::Variant} value was different.
|
1856
2207
|
#
|
2208
|
+
# <div class="wxrb-remark">
|
2209
|
+
# <b>Remark:</b>
|
2210
|
+
# <p>
|
2211
|
+
#
|
1857
2212
|
# - If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.
|
1858
2213
|
# - Default implementation simply assign given int to m_value.
|
1859
2214
|
# - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
|
1860
|
-
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
2215
|
+
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
2216
|
+
#
|
2217
|
+
# </p>
|
2218
|
+
# </div>>
|
1861
2219
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
1862
2220
|
# @param number [Integer] Integer to be translated into variant.
|
1863
2221
|
# @param argFlags [Integer] If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
|
@@ -1910,6 +2268,7 @@ module Wx::PG
|
|
1910
2268
|
# Property representing {Wx::Cursor}.
|
1911
2269
|
#
|
1912
2270
|
#
|
2271
|
+
# @wxrb_require USE_PROPGRID
|
1913
2272
|
class CursorProperty < EnumProperty
|
1914
2273
|
|
1915
2274
|
# @param label [String]
|
@@ -1921,9 +2280,16 @@ module Wx::PG
|
|
1921
2280
|
# Returns size of the custom painted image in front of property.
|
1922
2281
|
# This method must be overridden to return non-default value if OnCustomPaint is to be called.
|
1923
2282
|
#
|
2283
|
+
# <div class="wxrb-remark">
|
2284
|
+
# <b>Remark:</b>
|
2285
|
+
# <p>
|
2286
|
+
#
|
1924
2287
|
# - Default behaviour is to return {size(0,0)}, which means no image.
|
1925
2288
|
# - Default image width or height is indicated with dimension -1.
|
1926
|
-
# - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
|
2289
|
+
# - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
|
2290
|
+
#
|
2291
|
+
# </p>
|
2292
|
+
# </div>>
|
1927
2293
|
# @param item [Integer] Normally -1, but can be an index to the property's list of items.
|
1928
2294
|
# @return [Wx::Size]
|
1929
2295
|
def on_measure_image(item) end
|
@@ -1932,10 +2298,17 @@ module Wx::PG
|
|
1932
2298
|
# If property's {Wx::PG::CursorProperty#on_measure_image} returns size that has height != 0 but less than row height ( < 0 has special meanings), {Wx::PG::PropertyGrid} calls this method to draw a custom image in a limited area in front of the editor control or value text/graphics, and if control has drop-down list, then the image is drawn there as well (even in the case {Wx::PG::CursorProperty#on_measure_image} returned higher height than row height).
|
1933
2299
|
# NOTE: Following applies when {Wx::PG::CursorProperty#on_measure_image} returns a "flexible" height ( using <code>wxPG_FLEXIBLE_SIZE(W,H)</code> macro), which implies variable height items: If (rect.x+rect.width) is < 0, then this is a measure item call, which means that dc is invalid and only thing that should be done is to set paintdata.m_drawnHeight to the height of the image of item at index paintdata.m_choiceItem. This call may be done even as often as once every drop-down popup show.
|
1934
2300
|
#
|
2301
|
+
# <div class="wxrb-remark">
|
2302
|
+
# <b>Remark:</b>
|
2303
|
+
# <p>
|
2304
|
+
#
|
1935
2305
|
# - You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth must be set to the full width drawn in pixels.
|
1936
2306
|
# - Due to technical reasons, rect's height will be default even if custom height was reported during measure call.
|
1937
2307
|
# - Brush is guaranteed to be default background colour. It has been already used to clear the background of area being painted. It can be modified.
|
1938
2308
|
# - Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for drawing framing rectangle. It can be changed as well.
|
2309
|
+
#
|
2310
|
+
# </p>
|
2311
|
+
# </div>>
|
1939
2312
|
# @see Wx::PG::CursorProperty#value_to_string
|
1940
2313
|
# @param dc [Wx::DC] {Wx::DC} to paint on.
|
1941
2314
|
# @param rect [Wx::Rect] Box reserved for custom graphics. Includes surrounding rectangle, if any. If x+width is < 0, then this is a measure item call (see above).
|
@@ -1954,8 +2327,13 @@ module Wx::PG
|
|
1954
2327
|
end # CursorProperty
|
1955
2328
|
|
1956
2329
|
# {Wx::PG::EnumProperty} with {Wx::String} value and writable combo box editor.
|
1957
|
-
#
|
2330
|
+
# <div class="wxrb-remark">
|
2331
|
+
# <b>Remark:</b>
|
2332
|
+
# <p>Uses int value, similar to {Wx::PG::EnumProperty}, unless text entered by user is not in choices (in which case string value is used).
|
2333
|
+
# </p>
|
2334
|
+
# </div>>
|
1958
2335
|
#
|
2336
|
+
# @wxrb_require USE_PROPGRID
|
1959
2337
|
class EditEnumProperty < EnumProperty
|
1960
2338
|
|
1961
2339
|
# @overload initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, labels=(Wx::ArrayString.new()), values=(Wx::ArrayInt.new()), value=(''))
|
@@ -1987,6 +2365,7 @@ module Wx::PG
|
|
1987
2365
|
# Value used is of {Wx::PG::ColourPropertyValue} type.
|
1988
2366
|
# <b>Supported special attributes:</b> {Wx::PG::PG_COLOUR_ALLOW_CUSTOM}, {Wx::PG::PG_COLOUR_HAS_ALPHA}
|
1989
2367
|
#
|
2368
|
+
# @wxrb_require USE_PROPGRID
|
1990
2369
|
class SystemColourProperty < EnumProperty
|
1991
2370
|
|
1992
2371
|
# @param label [String]
|
@@ -1996,19 +2375,33 @@ module Wx::PG
|
|
1996
2375
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=(Wx::ColourPropertyValue.new())) end
|
1997
2376
|
|
1998
2377
|
# This virtual function is called after m_value has been set.
|
2378
|
+
# <div class="wxrb-remark">
|
2379
|
+
# <b>Remark:</b>
|
2380
|
+
# <p>
|
2381
|
+
#
|
1999
2382
|
# - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::SystemColourProperty#on_set_value} will not be called.
|
2000
2383
|
# - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::SystemColourProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
|
2001
|
-
# - Default implementation does nothing.
|
2384
|
+
# - Default implementation does nothing.
|
2385
|
+
#
|
2386
|
+
# </p>
|
2387
|
+
# </div>>
|
2002
2388
|
# @return [void]
|
2003
2389
|
def on_set_value; end
|
2004
2390
|
|
2005
2391
|
# Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
|
2006
2392
|
# Returns true if resulting {Wx::Variant} value was different.
|
2007
2393
|
#
|
2394
|
+
# <div class="wxrb-remark">
|
2395
|
+
# <b>Remark:</b>
|
2396
|
+
# <p>
|
2397
|
+
#
|
2008
2398
|
# - If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.
|
2009
2399
|
# - Default implementation simply assign given int to m_value.
|
2010
2400
|
# - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
|
2011
|
-
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
2401
|
+
# - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
2402
|
+
#
|
2403
|
+
# </p>
|
2404
|
+
# </div>>
|
2012
2405
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
2013
2406
|
# @param number [Integer] Integer to be translated into variant.
|
2014
2407
|
# @param argFlags [Integer] If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
|
@@ -2028,7 +2421,11 @@ module Wx::PG
|
|
2028
2421
|
alias_method :custom_colour_index, :get_custom_colour_index
|
2029
2422
|
|
2030
2423
|
# Converts property value into a text representation.
|
2031
|
-
#
|
2424
|
+
# <div class="wxrb-remark">
|
2425
|
+
# <b>Remark:</b>
|
2426
|
+
# <p>Default implementation calls {Wx::PG::SystemColourProperty#generate_composed_value}.
|
2427
|
+
# </p>
|
2428
|
+
# </div>>
|
2032
2429
|
# @param value [Wx::Variant] Value to be converted.
|
2033
2430
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
2034
2431
|
# @return [String]
|
@@ -2037,7 +2434,11 @@ module Wx::PG
|
|
2037
2434
|
# Converts text into {Wx::Variant} value appropriate for this property.
|
2038
2435
|
# Returns true if resulting {Wx::Variant} value was different.
|
2039
2436
|
#
|
2040
|
-
#
|
2437
|
+
# <div class="wxrb-remark">
|
2438
|
+
# <b>Remark:</b>
|
2439
|
+
# <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
|
2440
|
+
# </p>
|
2441
|
+
# </div>>
|
2041
2442
|
#
|
2042
2443
|
# You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
|
2043
2444
|
# @param variant [Wx::Variant] On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
|
@@ -2055,7 +2456,14 @@ module Wx::PG
|
|
2055
2456
|
#
|
2056
2457
|
# return true if any changes in value should be reported.
|
2057
2458
|
#
|
2058
|
-
# -
|
2459
|
+
# <div class="wxrb-remark">
|
2460
|
+
# <b>Remark:</b>
|
2461
|
+
# <p>
|
2462
|
+
#
|
2463
|
+
# - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
|
2464
|
+
#
|
2465
|
+
# </p>
|
2466
|
+
# </div>>
|
2059
2467
|
# @param propgrid [Wx::PG::PropertyGrid]
|
2060
2468
|
# @param wnd_primary [Wx::Window]
|
2061
2469
|
# @param event [Wx::Event]
|
@@ -2065,7 +2473,11 @@ module Wx::PG
|
|
2065
2473
|
# Reimplement this member function to add special handling for attributes of this property.
|
2066
2474
|
# Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
|
2067
2475
|
#
|
2068
|
-
#
|
2476
|
+
# <div class="wxrb-remark">
|
2477
|
+
# <b>Remark:</b>
|
2478
|
+
# <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
|
2479
|
+
# </p>
|
2480
|
+
# </div>>
|
2069
2481
|
# @param name [String]
|
2070
2482
|
# @param value [Wx::Variant]
|
2071
2483
|
# @return [Boolean]
|
@@ -2074,9 +2486,16 @@ module Wx::PG
|
|
2074
2486
|
# Returns size of the custom painted image in front of property.
|
2075
2487
|
# This method must be overridden to return non-default value if OnCustomPaint is to be called.
|
2076
2488
|
#
|
2489
|
+
# <div class="wxrb-remark">
|
2490
|
+
# <b>Remark:</b>
|
2491
|
+
# <p>
|
2492
|
+
#
|
2077
2493
|
# - Default behaviour is to return {size(0,0)}, which means no image.
|
2078
2494
|
# - Default image width or height is indicated with dimension -1.
|
2079
|
-
# - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
|
2495
|
+
# - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
|
2496
|
+
#
|
2497
|
+
# </p>
|
2498
|
+
# </div>>
|
2080
2499
|
# @param item [Integer] Normally -1, but can be an index to the property's list of items.
|
2081
2500
|
# @return [Wx::Size]
|
2082
2501
|
def on_measure_image(item) end
|
@@ -2085,10 +2504,17 @@ module Wx::PG
|
|
2085
2504
|
# If property's {Wx::PG::SystemColourProperty#on_measure_image} returns size that has height != 0 but less than row height ( < 0 has special meanings), {Wx::PG::PropertyGrid} calls this method to draw a custom image in a limited area in front of the editor control or value text/graphics, and if control has drop-down list, then the image is drawn there as well (even in the case {Wx::PG::SystemColourProperty#on_measure_image} returned higher height than row height).
|
2086
2505
|
# NOTE: Following applies when {Wx::PG::SystemColourProperty#on_measure_image} returns a "flexible" height ( using <code>wxPG_FLEXIBLE_SIZE(W,H)</code> macro), which implies variable height items: If (rect.x+rect.width) is < 0, then this is a measure item call, which means that dc is invalid and only thing that should be done is to set paintdata.m_drawnHeight to the height of the image of item at index paintdata.m_choiceItem. This call may be done even as often as once every drop-down popup show.
|
2087
2506
|
#
|
2507
|
+
# <div class="wxrb-remark">
|
2508
|
+
# <b>Remark:</b>
|
2509
|
+
# <p>
|
2510
|
+
#
|
2088
2511
|
# - You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth must be set to the full width drawn in pixels.
|
2089
2512
|
# - Due to technical reasons, rect's height will be default even if custom height was reported during measure call.
|
2090
2513
|
# - Brush is guaranteed to be default background colour. It has been already used to clear the background of area being painted. It can be modified.
|
2091
2514
|
# - Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for drawing framing rectangle. It can be changed as well.
|
2515
|
+
#
|
2516
|
+
# </p>
|
2517
|
+
# </div>>
|
2092
2518
|
# @see Wx::PG::SystemColourProperty#value_to_string
|
2093
2519
|
# @param dc [Wx::DC] {Wx::DC} to paint on.
|
2094
2520
|
# @param rect [Wx::Rect] Box reserved for custom graphics. Includes surrounding rectangle, if any. If x+width is < 0, then this is a measure item call (see above).
|
@@ -2142,6 +2568,7 @@ module Wx::PG
|
|
2142
2568
|
# Value used is of {Wx::PG::ColourPropertyValue} type.
|
2143
2569
|
# <b>Supported special attributes:</b> {Wx::PG::PG_COLOUR_ALLOW_CUSTOM}, {Wx::PG::PG_COLOUR_HAS_ALPHA}
|
2144
2570
|
#
|
2571
|
+
# @wxrb_require USE_PROPGRID
|
2145
2572
|
class ColourProperty < SystemColourProperty
|
2146
2573
|
|
2147
2574
|
# @param label [String]
|
@@ -2151,7 +2578,11 @@ module Wx::PG
|
|
2151
2578
|
def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=Wx::WHITE) end
|
2152
2579
|
|
2153
2580
|
# Converts property value into a text representation.
|
2154
|
-
#
|
2581
|
+
# <div class="wxrb-remark">
|
2582
|
+
# <b>Remark:</b>
|
2583
|
+
# <p>Default implementation calls {Wx::PG::ColourProperty#generate_composed_value}.
|
2584
|
+
# </p>
|
2585
|
+
# </div>>
|
2155
2586
|
# @param value [Wx::Variant] Value to be converted.
|
2156
2587
|
# @param argFlags [Integer] If 0 (default value), then displayed string is returned. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE} is set, returns string value that must be editable in textctrl. If {Wx::PG::PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT} is set, returns text that is appropriate to display as a part of string property's composite text representation.
|
2157
2588
|
# @return [String]
|
@@ -2186,6 +2617,7 @@ module Wx::PG
|
|
2186
2617
|
#
|
2187
2618
|
#
|
2188
2619
|
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
2620
|
+
# @wxrb_require USE_PROPGRID
|
2189
2621
|
class ColourPropertyValue < Object
|
2190
2622
|
|
2191
2623
|
# An integer value relating to the colour, and which exact meaning depends on the property with which it is used.
|