wxruby3 0.9.0.pre.beta.14-x64-mingw-ucrt → 0.9.0.pre.rc.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/INSTALL.md +51 -22
- data/README.md +81 -6
- data/assets/hello_button-macos.png +0 -0
- data/assets/hello_button-msw.png +0 -0
- data/assets/hello_button.png +0 -0
- data/assets/hello_button_clicked-macos.png +0 -0
- data/assets/hello_button_clicked-msw.png +0 -0
- data/assets/hello_button_clicked.png +0 -0
- data/assets/hello_button_clicked_combi.png +0 -0
- data/assets/hello_world-macos.png +0 -0
- data/assets/hello_world-msw.png +0 -0
- data/assets/hello_world.png +0 -0
- data/assets/hello_world_combi.png +0 -0
- data/assets/repo-social-preview.png +0 -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/core/art_locator.rb +2 -2
- data/lib/wx/core/artprovider.rb +2 -2
- data/lib/wx/core/bitmap.rb +6 -5
- data/lib/wx/core/bitmap_combobox.rb +34 -0
- data/lib/wx/core/brush.rb +6 -0
- data/lib/wx/core/controlwithitems.rb +52 -14
- data/lib/wx/core/cursor.rb +1 -1
- data/lib/wx/core/dc.rb +0 -20
- data/lib/wx/core/event_blocker.rb +14 -0
- data/lib/wx/core/events/evt_list.rb +19 -0
- data/lib/wx/core/evthandler.rb +48 -2
- data/lib/wx/core/find_replace_dialog.rb +24 -0
- data/lib/wx/core/font.rb +22 -14
- data/lib/wx/core/helpprovider.rb +2 -2
- data/lib/wx/core/icon.rb +1 -1
- data/lib/wx/core/image.rb +1 -1
- data/lib/wx/core/menu.rb +5 -0
- data/lib/wx/core/paintdc.rb +8 -0
- data/lib/wx/core/pen.rb +6 -0
- data/lib/wx/core/text_entry.rb +15 -0
- data/lib/wx/core/v_list_box.rb +13 -0
- data/lib/wx/core/window.rb +29 -2
- data/lib/wx/doc/app.rb +40 -0
- data/lib/wx/doc/brush.rb +17 -0
- data/lib/wx/doc/busy_info.rb +21 -0
- data/lib/wx/doc/client_dc.rb +28 -0
- data/lib/wx/doc/controlwithitems.rb +11 -0
- data/lib/wx/doc/dc.rb +0 -14
- data/lib/wx/doc/event_blocker.rb +27 -0
- data/lib/wx/doc/evthandler.rb +4 -0
- data/lib/wx/doc/extra/02_lifecycles.md +49 -0
- data/lib/wx/doc/extra/10_art.md +1 -1
- data/lib/wx/doc/extra/11_drawing_and_dc.md +62 -0
- data/lib/wx/doc/font.rb +27 -0
- data/lib/wx/doc/gen/about_dialog_info.rb +27 -24
- data/lib/wx/doc/gen/accelerator.rb +11 -12
- data/lib/wx/doc/gen/activity_indicator.rb +65 -0
- data/lib/wx/doc/gen/app.rb +6 -3
- data/lib/wx/doc/gen/art_provider.rb +53 -29
- data/lib/wx/doc/gen/aui/aui_manager.rb +4 -0
- data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +1 -1
- data/lib/wx/doc/gen/aui/aui_pane_info.rb +2 -0
- data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +2 -0
- data/lib/wx/doc/gen/aui/aui_tool_bar.rb +2 -2
- data/lib/wx/doc/gen/bitmap.rb +25 -25
- data/lib/wx/doc/gen/bitmap_combo_box.rb +157 -0
- data/lib/wx/doc/gen/box_sizer.rb +6 -8
- data/lib/wx/doc/gen/brush.rb +2 -0
- data/lib/wx/doc/gen/busy_info.rb +52 -46
- data/lib/wx/doc/gen/caret.rb +0 -4
- data/lib/wx/doc/gen/check_list_box.rb +0 -2
- data/lib/wx/doc/gen/choice.rb +1 -5
- data/lib/wx/doc/gen/client_dc.rb +13 -18
- data/lib/wx/doc/gen/clipboard.rb +30 -27
- data/lib/wx/doc/gen/collapsible_pane.rb +11 -9
- data/lib/wx/doc/gen/colour.rb +6 -3
- data/lib/wx/doc/gen/colour_dialog.rb +111 -23
- data/lib/wx/doc/gen/combo_box.rb +2 -4
- data/lib/wx/doc/gen/context_help_button.rb +48 -0
- data/lib/wx/doc/gen/control.rb +20 -18
- data/lib/wx/doc/gen/core.rb +2 -2
- data/lib/wx/doc/gen/cursor.rb +18 -50
- data/lib/wx/doc/gen/data_format.rb +0 -2
- data/lib/wx/doc/gen/data_object.rb +37 -44
- data/lib/wx/doc/gen/dc.rb +16 -24
- data/lib/wx/doc/gen/defs.rb +3 -40
- data/lib/wx/doc/gen/dialog.rb +21 -17
- data/lib/wx/doc/gen/dir_dialog.rb +10 -8
- data/lib/wx/doc/gen/event.rb +2 -2
- data/lib/wx/doc/gen/event_blocker.rb +51 -0
- data/lib/wx/doc/gen/event_filter.rb +88 -0
- data/lib/wx/doc/gen/event_list.rb +23 -2
- data/lib/wx/doc/gen/events.rb +103 -112
- data/lib/wx/doc/gen/evt_handler.rb +28 -52
- data/lib/wx/doc/gen/file_dialog.rb +53 -50
- data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
- data/lib/wx/doc/gen/font.rb +19 -2
- data/lib/wx/doc/gen/font_data.rb +2 -0
- data/lib/wx/doc/gen/font_dialog.rb +1 -1
- data/lib/wx/doc/gen/frame.rb +4 -3
- data/lib/wx/doc/gen/fs_file.rb +8 -0
- data/lib/wx/doc/gen/gcdc.rb +2 -22
- data/lib/wx/doc/gen/gdi_common.rb +18 -2
- data/lib/wx/doc/gen/gdi_object.rb +2 -0
- data/lib/wx/doc/gen/graphics_context.rb +4 -43
- data/lib/wx/doc/gen/graphics_object.rb +2 -0
- data/lib/wx/doc/gen/grid/grid_cell_attr.rb +2 -1
- data/lib/wx/doc/gen/grid/grid_ctrl.rb +4 -2
- data/lib/wx/doc/gen/grid/grid_table_message.rb +2 -0
- data/lib/wx/doc/gen/grid_bag_sizer.rb +4 -0
- data/lib/wx/doc/gen/help_controller.rb +4 -1
- data/lib/wx/doc/gen/html/html_cell.rb +4 -1
- data/lib/wx/doc/gen/html/html_help_controller.rb +4 -1
- data/lib/wx/doc/gen/html/html_help_data.rb +4 -0
- data/lib/wx/doc/gen/html/html_help_window.rb +2 -1
- data/lib/wx/doc/gen/html/html_list_box.rb +138 -11
- data/lib/wx/doc/gen/html/html_window.rb +9 -3
- data/lib/wx/doc/gen/hyperlink_ctrl.rb +147 -0
- data/lib/wx/doc/gen/hyperlink_event.rb +43 -0
- data/lib/wx/doc/gen/icon.rb +7 -1
- data/lib/wx/doc/gen/icon_location.rb +2 -0
- data/lib/wx/doc/gen/image.rb +15 -8
- data/lib/wx/doc/gen/keyboard_state.rb +6 -0
- data/lib/wx/doc/gen/list_box.rb +0 -11
- data/lib/wx/doc/gen/list_ctrl.rb +10 -13
- data/lib/wx/doc/gen/locale.rb +7 -3
- data/lib/wx/doc/gen/log.rb +6 -2
- data/lib/wx/doc/gen/mdi_frame.rb +2 -0
- data/lib/wx/doc/gen/media_ctrl.rb +2 -0
- data/lib/wx/doc/gen/memory_dc.rb +105 -18
- data/lib/wx/doc/gen/menu.rb +4 -2
- data/lib/wx/doc/gen/menu_bar.rb +0 -8
- data/lib/wx/doc/gen/menu_item.rb +9 -3
- data/lib/wx/doc/gen/message_dialog.rb +6 -3
- data/lib/wx/doc/gen/mirror_dc.rb +2 -8
- data/lib/wx/doc/gen/mouse_state.rb +2 -0
- data/lib/wx/doc/gen/multi_choice_dialog.rb +0 -2
- data/lib/wx/doc/gen/non_owned_window.rb +2 -1
- data/lib/wx/doc/gen/notebook.rb +4 -2
- data/lib/wx/doc/gen/paint_dc.rb +2 -6
- data/lib/wx/doc/gen/palette.rb +3 -3
- data/lib/wx/doc/gen/pen.rb +6 -1
- data/lib/wx/doc/gen/pg/pg_editor.rb +2 -1
- data/lib/wx/doc/gen/pg/pg_multi_button.rb +4 -0
- data/lib/wx/doc/gen/pg/pg_properties.rb +30 -3
- data/lib/wx/doc/gen/pg/pg_property.rb +30 -4
- data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
- data/lib/wx/doc/gen/pg/property_grid.rb +5 -2
- data/lib/wx/doc/gen/pg/property_grid_interface.rb +6 -2
- data/lib/wx/doc/gen/pg/property_grid_manager.rb +2 -0
- data/lib/wx/doc/gen/pg/property_grid_page_state.rb +2 -0
- data/lib/wx/doc/gen/picker_base.rb +2 -1
- data/lib/wx/doc/gen/platform_info.rb +4 -1
- data/lib/wx/doc/gen/property_sheet_dialog.rb +2 -0
- data/lib/wx/doc/gen/prt/post_script_dc.rb +2 -8
- data/lib/wx/doc/gen/prt/print_data.rb +6 -0
- data/lib/wx/doc/gen/prt/printer.rb +0 -3
- data/lib/wx/doc/gen/prt/printer_dc.rb +2 -6
- data/lib/wx/doc/gen/radio_box.rb +2 -10
- data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +6 -0
- data/lib/wx/doc/gen/rbn/ribbon_panel.rb +1 -1
- data/lib/wx/doc/gen/region.rb +2 -0
- data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +6 -0
- data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +0 -4
- data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +2 -0
- data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +2 -1
- data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +2 -0
- data/lib/wx/doc/gen/screen_dc.rb +2 -0
- data/lib/wx/doc/gen/scroll_bar.rb +2 -1
- data/lib/wx/doc/gen/scrolled_canvas.rb +4 -8
- data/lib/wx/doc/gen/scrolled_control.rb +4 -8
- data/lib/wx/doc/gen/scrolled_window.rb +4 -8
- data/lib/wx/doc/gen/search_ctrl.rb +131 -0
- data/lib/wx/doc/gen/single_choice_dialog.rb +0 -2
- data/lib/wx/doc/gen/sizer.rb +14 -3
- data/lib/wx/doc/gen/splash_screen.rb +2 -0
- data/lib/wx/doc/gen/static_box.rb +6 -3
- data/lib/wx/doc/gen/static_box_sizer.rb +2 -1
- data/lib/wx/doc/gen/status_bar.rb +0 -5
- data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4 -5
- data/lib/wx/doc/gen/svg_file_dc.rb +10 -11
- data/lib/wx/doc/gen/text_ctrl.rb +10 -3
- data/lib/wx/doc/gen/text_entry.rb +8 -3
- data/lib/wx/doc/gen/text_entry_dialog.rb +4 -2
- data/lib/wx/doc/gen/timer_event.rb +2 -0
- data/lib/wx/doc/gen/tool_bar.rb +8 -4
- data/lib/wx/doc/gen/top_level_window.rb +5 -2
- data/lib/wx/doc/gen/tree_ctrl.rb +0 -6
- data/lib/wx/doc/gen/ui_action_simulator.rb +100 -0
- data/lib/wx/doc/gen/utils.rb +1 -1
- data/lib/wx/doc/gen/v_list_box.rb +36 -26
- data/lib/wx/doc/gen/validator.rb +2 -1
- data/lib/wx/doc/gen/variant.rb +10 -0
- data/lib/wx/doc/gen/window.rb +38 -17
- data/lib/wx/doc/gen/window_dc.rb +2 -0
- data/lib/wx/doc/gen/window_disabler.rb +2 -0
- data/lib/wx/doc/gen/wizard_page_simple.rb +2 -0
- data/lib/wx/doc/gen/xml_node.rb +6 -0
- data/lib/wx/doc/gen/xml_resource.rb +4 -1
- data/lib/wx/doc/memory_dc.rb +75 -0
- data/lib/wx/doc/mirror_dc.rb +16 -0
- data/lib/wx/doc/pen.rb +17 -0
- data/lib/wx/doc/prt/printer_dc.rb +26 -0
- data/lib/wx/doc/radio_box.rb +20 -0
- data/lib/wx/doc/screen_dc.rb +10 -6
- data/lib/wx/doc/svg_file_dc.rb +20 -0
- data/lib/wx/doc/v_list_box.rb +9 -0
- data/lib/wx/doc/window.rb +27 -0
- data/lib/wx/doc/window_disabler.rb +10 -0
- data/lib/wx/html/keyword_defs.rb +6 -7
- data/lib/wx/html/require.rb +1 -0
- data/lib/wx/html/simple_html_listbox.rb +105 -0
- data/lib/wx/keyword_defs.rb +83 -75
- data/lib/wx/prt/keyword_defs.rb +5 -1
- data/lib/wx/version.rb +1 -1
- data/lib/wx/wxruby/cmd/test.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/install.rb +20 -7
- data/rakelib/lib/config/linux.rb +4 -2
- data/rakelib/lib/config/macosx.rb +120 -1
- data/rakelib/lib/config/mingw.rb +6 -1
- data/rakelib/lib/config/unixish.rb +26 -11
- data/rakelib/lib/config.rb +15 -6
- data/rakelib/yard/yard/relative_markdown_links.rb +5 -1
- data/samples/aui/aui.rb +432 -363
- data/samples/bigdemo/wxArtProvider.rbw +5 -4
- data/samples/controls/controls.rb +2 -2
- data/samples/controls/htlbox.rb +411 -0
- data/samples/controls/tn_htlbox.png +0 -0
- data/samples/drawing/graphics_drawing.rb +1 -2
- data/samples/drawing/{svgtest.rb → image_prt.rb} +49 -18
- data/samples/drawing/tn_image_prt.png +0 -0
- data/samples/propgrid/propgrid.rb +26 -21
- data/samples/ribbon/ribbon.rb +47 -46
- data/samples/sampler/editor.rb +33 -25
- data/samples/sampler/sample.rb +2 -2
- data/samples/sampler/stc_editor.rb +4 -2
- data/tests/lib/item_container_tests.rb +82 -0
- data/tests/lib/text_entry_tests.rb +80 -0
- data/tests/lib/wxapp_runner.rb +15 -3
- data/tests/lib/wxframe_runner.rb +144 -0
- data/tests/test_app_event_filter.rb +74 -0
- data/tests/test_art_provider.rb +52 -0
- data/tests/test_clipboard.rb +2 -1
- data/tests/test_event_handling.rb +199 -16
- data/tests/test_events.rb +4 -11
- data/tests/test_ext_controls.rb +28 -0
- data/tests/test_font.rb +239 -0
- data/tests/test_gdi_object.rb +161 -0
- data/tests/test_intl.rb +16 -15
- data/tests/test_item_data.rb +33 -1
- data/tests/test_std_controls.rb +373 -0
- data/tests/test_window.rb +340 -0
- metadata +61 -8
- data/lib/wx/doc/gen/auto_buffered_paint_dc.rb +0 -47
- data/lib/wx/doc/gen/buffered_dc.rb +0 -95
- data/lib/wx/doc/gen/buffered_paint_dc.rb +0 -55
- data/lib/wx/doc/gen/colour_data.rb +0 -96
- data/samples/drawing/tn_svgtest.png +0 -0
data/lib/wx/doc/gen/paint_dc.rb
CHANGED
@@ -20,14 +20,10 @@ module Wx
|
|
20
20
|
# @see Wx::ScreenDC
|
21
21
|
#
|
22
22
|
#
|
23
|
+
#
|
24
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
23
25
|
class PaintDC < ClientDC
|
24
26
|
|
25
|
-
# Constructor.
|
26
|
-
# Pass a pointer to the window on which you wish to paint.
|
27
|
-
# @param window [Wx::Window]
|
28
|
-
# @return [PaintDC]
|
29
|
-
def initialize(window) end
|
30
|
-
|
31
27
|
end # PaintDC
|
32
28
|
|
33
29
|
|
data/lib/wx/doc/gen/palette.rb
CHANGED
@@ -21,6 +21,8 @@ module Wx
|
|
21
21
|
# @see Wx::Bitmap
|
22
22
|
#
|
23
23
|
#
|
24
|
+
#
|
25
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
24
26
|
class Palette < GDIObject
|
25
27
|
|
26
28
|
# @overload initialize()
|
@@ -32,7 +34,7 @@ module Wx
|
|
32
34
|
# @return [Palette]
|
33
35
|
# @overload initialize(n, red, green, blue)
|
34
36
|
# Creates a palette from arrays of size n, one for each red, blue or green component.
|
35
|
-
#
|
37
|
+
#
|
36
38
|
# @see Wx::Palette#create
|
37
39
|
# @param n [Integer] The number of indices in the palette.
|
38
40
|
# @param red [unsigned char] An array of red values.
|
@@ -68,8 +70,6 @@ module Wx
|
|
68
70
|
|
69
71
|
# Returns RGB values for a given palette index.
|
70
72
|
# true if the operation was successful.
|
71
|
-
#
|
72
|
-
# <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes only the pixel parameter and returns a 3-element list (or the empty list upon failure).
|
73
73
|
# @see Wx::Palette#get_pixel
|
74
74
|
# @param pixel [Integer] The palette index.
|
75
75
|
# @param red [unsigned char] Receives the red value.
|
data/lib/wx/doc/gen/pen.rb
CHANGED
@@ -193,6 +193,8 @@ module Wx
|
|
193
193
|
# @see Wx::DC#set_pen
|
194
194
|
#
|
195
195
|
#
|
196
|
+
#
|
197
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
196
198
|
class Pen < GDIObject
|
197
199
|
|
198
200
|
# @overload set_colour(colour)
|
@@ -387,9 +389,12 @@ module Wx
|
|
387
389
|
|
388
390
|
# This class is a helper used for {Wx::Pen} creation using named parameter idiom: it allows specifying various {Wx::Pen} attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to {Wx::Pen} constructors.
|
389
391
|
# For instance, to create a dotted blue pen with the given join style you could do
|
390
|
-
#
|
392
|
+
# ```
|
391
393
|
# wxPen pen(wxPenInfo(*wxBLUE).Style(wxPENSTYLE_DOT).Join(wxJOIN_BEVEL));
|
394
|
+
# ```
|
395
|
+
#
|
392
396
|
#
|
397
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
393
398
|
class PenInfo < ::Object
|
394
399
|
|
395
400
|
# @param colour [Wx::Colour,String,Symbol]
|
@@ -23,8 +23,9 @@ module Wx::PG
|
|
23
23
|
|
24
24
|
# Base class for custom {Wx::PG::PropertyGrid} editors.
|
25
25
|
# - Names of built-in property editors are: TextCtrl, Choice, ComboBox, CheckBox, TextCtrlAndButton, and ChoiceAndButton. Additional editors include SpinCtrl and DatePickerCtrl, but using them requires calling {Wx::PG::PropertyGrid#register_additional_editors} prior use.- Pointer to built-in editor is available as {Wx::PGEditor_EditorName} (e.g. {Wx::PG_EDITOR_TEXT_CTRL}).- Before you start using new editor you just created, you need to register it using static function {Wx::PG::PropertyGrid.register_editor_class}, with code like this:
|
26
|
-
#
|
26
|
+
# ```
|
27
27
|
# wxPGEditor* editorPointer = wxPropertyGrid::RegisterEditorClass(new MyEditorClass(), "MyEditor");
|
28
|
+
# ```
|
28
29
|
# After that, {Wx::PG::PropertyGrid} will take ownership of the given object, but you should still store editorPointer somewhere, so you can pass it to {Wx::PG::PGProperty#set_editor}, or return it from {Wx::PG::PGEditor#do_get_editor_class}.
|
29
30
|
#
|
30
31
|
# ===
|
@@ -10,6 +10,7 @@ module Wx::PG
|
|
10
10
|
# You will need to create a new property editor class, override CreateControls, and have it return {Wx::PG::PGMultiButton} instance in Wx::PGWindowList#set_secondary.
|
11
11
|
# For instance, here we add three buttons to a TextCtrl editor:
|
12
12
|
#
|
13
|
+
# ```
|
13
14
|
# #include <wx/propgrid/editors.h>
|
14
15
|
#
|
15
16
|
# class wxSampleMultiButtonEditor : public wxPGTextCtrlEditor
|
@@ -89,9 +90,11 @@ module Wx::PG
|
|
89
90
|
# }
|
90
91
|
# return wxPGTextCtrlEditor::OnEvent(propGrid, property, ctrl, event);
|
91
92
|
# }
|
93
|
+
# ```
|
92
94
|
#
|
93
95
|
# Further to use this editor, code like this can be used:
|
94
96
|
#
|
97
|
+
# ```
|
95
98
|
# // Register editor class - needs only to be called once
|
96
99
|
# wxPGEditor* multiButtonEditor = new wxSampleMultiButtonEditor();
|
97
100
|
# wxPropertyGrid::RegisterEditorClass( multiButtonEditor );
|
@@ -101,6 +104,7 @@ module Wx::PG
|
|
101
104
|
#
|
102
105
|
# // Change property to use editor created in the previous code segment
|
103
106
|
# propGrid->SetPropertyEditor( "MultipleButtons", multiButtonEditor );
|
107
|
+
# ```
|
104
108
|
#
|
105
109
|
# ===
|
106
110
|
#
|
@@ -216,6 +216,7 @@ module Wx::PG
|
|
216
216
|
# Note that this function is usually called at the time that value of this property, or given child property, is still pending for change, and as such, result of {Wx::PG::FlagsProperty#get_value} or m_value should not be relied on.
|
217
217
|
# Sample pseudo-code implementation:
|
218
218
|
#
|
219
|
+
# ```
|
219
220
|
# wxVariant MyProperty::ChildChanged( wxVariant& thisValue,
|
220
221
|
# int childIndex,
|
221
222
|
# wxVariant& childValue ) const
|
@@ -240,6 +241,7 @@ module Wx::PG
|
|
240
241
|
# // Return altered data
|
241
242
|
# return data;
|
242
243
|
# }
|
244
|
+
# ```
|
243
245
|
#
|
244
246
|
# Modified value of the whole property.
|
245
247
|
# @param thisValue [Wx::Variant] Value of this property. Changed value should be returned (in previous versions of {Wx::PG::PropertyGrid} it was only necessary to write value back to this argument).
|
@@ -639,6 +641,7 @@ module Wx::PG
|
|
639
641
|
# Setting validator explicitly via SetPropertyValidator will override this.
|
640
642
|
# In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):
|
641
643
|
#
|
644
|
+
# ```
|
642
645
|
# wxValidator* wxMyPropertyClass::DoGetValidator () const
|
643
646
|
# {
|
644
647
|
# WX_PG_DOGETVALIDATOR_ENTRY()
|
@@ -649,6 +652,7 @@ module Wx::PG
|
|
649
652
|
#
|
650
653
|
# WX_PG_DOGETVALIDATOR_EXIT(validator)
|
651
654
|
# }
|
655
|
+
# ```
|
652
656
|
#
|
653
657
|
# You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
654
658
|
# @return [Wx::Validator]
|
@@ -725,6 +729,7 @@ module Wx::PG
|
|
725
729
|
# Setting validator explicitly via SetPropertyValidator will override this.
|
726
730
|
# In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):
|
727
731
|
#
|
732
|
+
# ```
|
728
733
|
# wxValidator* wxMyPropertyClass::DoGetValidator () const
|
729
734
|
# {
|
730
735
|
# WX_PG_DOGETVALIDATOR_ENTRY()
|
@@ -735,6 +740,7 @@ module Wx::PG
|
|
735
740
|
#
|
736
741
|
# WX_PG_DOGETVALIDATOR_EXIT(validator)
|
737
742
|
# }
|
743
|
+
# ```
|
738
744
|
#
|
739
745
|
# You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
740
746
|
# @return [Wx::Validator]
|
@@ -853,7 +859,7 @@ module Wx::PG
|
|
853
859
|
# @param dc [Wx::DC] {Wx::DC} to paint on.
|
854
860
|
# @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).
|
855
861
|
# @param paintdata [Wx::PGPaintData] {Wx::PG::PGPaintData} structure with much useful data about painted item.
|
856
|
-
#
|
862
|
+
# ```
|
857
863
|
# struct wxPGPaintData
|
858
864
|
# {
|
859
865
|
# // wxPropertyGrid.
|
@@ -868,6 +874,7 @@ module Wx::PG
|
|
868
874
|
# // In a measure item call, set this to the height of item at m_choiceItem index
|
869
875
|
# int m_drawnHeight;
|
870
876
|
# };
|
877
|
+
# ```
|
871
878
|
# @return [void]
|
872
879
|
def on_custom_paint(dc, rect, paintdata) end
|
873
880
|
|
@@ -910,6 +917,7 @@ module Wx::PG
|
|
910
917
|
# Note that this function is usually called at the time that value of this property, or given child property, is still pending for change, and as such, result of {Wx::PG::FontProperty#get_value} or m_value should not be relied on.
|
911
918
|
# Sample pseudo-code implementation:
|
912
919
|
#
|
920
|
+
# ```
|
913
921
|
# wxVariant MyProperty::ChildChanged( wxVariant& thisValue,
|
914
922
|
# int childIndex,
|
915
923
|
# wxVariant& childValue ) const
|
@@ -934,6 +942,7 @@ module Wx::PG
|
|
934
942
|
# // Return altered data
|
935
943
|
# return data;
|
936
944
|
# }
|
945
|
+
# ```
|
937
946
|
#
|
938
947
|
# Modified value of the whole property.
|
939
948
|
# @param thisValue [Wx::Variant] Value of this property. Changed value should be returned (in previous versions of {Wx::PG::PropertyGrid} it was only necessary to write value back to this argument).
|
@@ -1243,24 +1252,32 @@ module Wx::PG
|
|
1243
1252
|
# <b>Example how to use seamless 64-bit integer support</b>
|
1244
1253
|
# Getting value:
|
1245
1254
|
#
|
1255
|
+
# ```
|
1246
1256
|
# wxLongLong_t value = pg->GetPropertyValueAsLongLong();
|
1257
|
+
# ```
|
1247
1258
|
#
|
1248
1259
|
# or
|
1249
1260
|
#
|
1261
|
+
# ```
|
1250
1262
|
# wxLongLong_t value;
|
1251
1263
|
# wxVariant variant = property->GetValue();
|
1252
1264
|
# if ( variant.GetType() == "wxLongLong" )
|
1253
1265
|
# value = wxLongLongFromVariant(variant);
|
1254
1266
|
# else
|
1255
1267
|
# value = variant.GetLong();
|
1268
|
+
# ```
|
1256
1269
|
#
|
1257
1270
|
# Setting value:
|
1258
1271
|
#
|
1272
|
+
# ```
|
1259
1273
|
# pg->SetPropertyValue(longLongVal);
|
1274
|
+
# ```
|
1260
1275
|
#
|
1261
1276
|
# or
|
1262
1277
|
#
|
1278
|
+
# ```
|
1263
1279
|
# property->SetValue(WXVARIANT(longLongVal));
|
1280
|
+
# ```
|
1264
1281
|
#
|
1265
1282
|
# <b>Supported special attributes:</b>
|
1266
1283
|
# - {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}.
|
@@ -1321,6 +1338,7 @@ module Wx::PG
|
|
1321
1338
|
# Setting validator explicitly via SetPropertyValidator will override this.
|
1322
1339
|
# In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):
|
1323
1340
|
#
|
1341
|
+
# ```
|
1324
1342
|
# wxValidator* wxMyPropertyClass::DoGetValidator () const
|
1325
1343
|
# {
|
1326
1344
|
# WX_PG_DOGETVALIDATOR_ENTRY()
|
@@ -1331,6 +1349,7 @@ module Wx::PG
|
|
1331
1349
|
#
|
1332
1350
|
# WX_PG_DOGETVALIDATOR_EXIT(validator)
|
1333
1351
|
# }
|
1352
|
+
# ```
|
1334
1353
|
#
|
1335
1354
|
# You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
1336
1355
|
# @return [Wx::Validator]
|
@@ -1452,6 +1471,7 @@ module Wx::PG
|
|
1452
1471
|
# Setting validator explicitly via SetPropertyValidator will override this.
|
1453
1472
|
# In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):
|
1454
1473
|
#
|
1474
|
+
# ```
|
1455
1475
|
# wxValidator* wxMyPropertyClass::DoGetValidator () const
|
1456
1476
|
# {
|
1457
1477
|
# WX_PG_DOGETVALIDATOR_ENTRY()
|
@@ -1462,6 +1482,7 @@ module Wx::PG
|
|
1462
1482
|
#
|
1463
1483
|
# WX_PG_DOGETVALIDATOR_EXIT(validator)
|
1464
1484
|
# }
|
1485
|
+
# ```
|
1465
1486
|
#
|
1466
1487
|
# You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
1467
1488
|
# @return [Wx::Validator]
|
@@ -1604,6 +1625,7 @@ module Wx::PG
|
|
1604
1625
|
# Setting validator explicitly via SetPropertyValidator will override this.
|
1605
1626
|
# In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):
|
1606
1627
|
#
|
1628
|
+
# ```
|
1607
1629
|
# wxValidator* wxMyPropertyClass::DoGetValidator () const
|
1608
1630
|
# {
|
1609
1631
|
# WX_PG_DOGETVALIDATOR_ENTRY()
|
@@ -1614,6 +1636,7 @@ module Wx::PG
|
|
1614
1636
|
#
|
1615
1637
|
# WX_PG_DOGETVALIDATOR_EXIT(validator)
|
1616
1638
|
# }
|
1639
|
+
# ```
|
1617
1640
|
#
|
1618
1641
|
# You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
1619
1642
|
# @return [Wx::Validator]
|
@@ -1865,7 +1888,7 @@ module Wx::PG
|
|
1865
1888
|
# @param dc [Wx::DC] {Wx::DC} to paint on.
|
1866
1889
|
# @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).
|
1867
1890
|
# @param paintdata [Wx::PGPaintData] {Wx::PG::PGPaintData} structure with much useful data about painted item.
|
1868
|
-
#
|
1891
|
+
# ```
|
1869
1892
|
# struct wxPGPaintData
|
1870
1893
|
# {
|
1871
1894
|
# // wxPropertyGrid.
|
@@ -1880,6 +1903,7 @@ module Wx::PG
|
|
1880
1903
|
# // In a measure item call, set this to the height of item at m_choiceItem index
|
1881
1904
|
# int m_drawnHeight;
|
1882
1905
|
# };
|
1906
|
+
# ```
|
1883
1907
|
# @return [void]
|
1884
1908
|
def on_custom_paint(dc, rect, paintdata) end
|
1885
1909
|
|
@@ -2023,7 +2047,7 @@ module Wx::PG
|
|
2023
2047
|
# @param dc [Wx::DC] {Wx::DC} to paint on.
|
2024
2048
|
# @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).
|
2025
2049
|
# @param paintdata [Wx::PGPaintData] {Wx::PG::PGPaintData} structure with much useful data about painted item.
|
2026
|
-
#
|
2050
|
+
# ```
|
2027
2051
|
# struct wxPGPaintData
|
2028
2052
|
# {
|
2029
2053
|
# // wxPropertyGrid.
|
@@ -2038,6 +2062,7 @@ module Wx::PG
|
|
2038
2062
|
# // In a measure item call, set this to the height of item at m_choiceItem index
|
2039
2063
|
# int m_drawnHeight;
|
2040
2064
|
# };
|
2065
|
+
# ```
|
2041
2066
|
# @return [void]
|
2042
2067
|
def on_custom_paint(dc, rect, paintdata) end
|
2043
2068
|
|
@@ -2129,6 +2154,8 @@ module Wx::PG
|
|
2129
2154
|
# Because text, background and other colours tend to differ between platforms, {Wx::PG::SystemColourProperty} must be able to select between system colour and, when necessary, to pick a custom one.
|
2130
2155
|
# {Wx::PG::SystemColourProperty} value makes this possible.
|
2131
2156
|
#
|
2157
|
+
#
|
2158
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
2132
2159
|
class ColourPropertyValue < Object
|
2133
2160
|
|
2134
2161
|
# An integer value relating to the colour, and which exact meaning depends on the property with which it is used.
|
@@ -354,14 +354,16 @@ module Wx::PG
|
|
354
354
|
#
|
355
355
|
# It derives from {Wx::PG::NumericProperty} and displays value as a signed long integer. {Wx::PG::IntProperty} seamlessly supports 64-bit integers (i.e. {Wx::LongLong}) on overflow. To safely convert variant to integer, use code like this:
|
356
356
|
#
|
357
|
+
# ```
|
357
358
|
# wxLongLong ll;
|
358
359
|
# ll << property->GetValue();
|
359
360
|
#
|
360
361
|
# // or
|
361
362
|
# wxLongLong ll = propertyGrid->GetPropertyValueAsLong(property);
|
363
|
+
# ```
|
362
364
|
#
|
363
365
|
# Getting 64-bit value:
|
364
|
-
#
|
366
|
+
# ```
|
365
367
|
# wxLongLong_t value = pg->GetPropertyValueAsLongLong();
|
366
368
|
#
|
367
369
|
# // or
|
@@ -372,14 +374,16 @@ module Wx::PG
|
|
372
374
|
# value = variant.GetLongLong();
|
373
375
|
# else
|
374
376
|
# value = variant.GetLong();
|
377
|
+
# ```
|
375
378
|
#
|
376
379
|
# Setting 64-bit value:
|
377
|
-
#
|
380
|
+
# ```
|
378
381
|
# pg->SetPropertyValue(longLongVal);
|
379
382
|
#
|
380
383
|
# // or
|
381
384
|
#
|
382
385
|
# property->SetValue(WXVARIANT(longLongVal));
|
386
|
+
# ```
|
383
387
|
#
|
384
388
|
# Supported special attributes:
|
385
389
|
# - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX} to specify acceptable value range.- {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters.
|
@@ -558,6 +562,7 @@ module Wx::PG
|
|
558
562
|
#
|
559
563
|
# Represents {Wx::Colour} and a system colour index. {Wx::Choice} is used to edit the value. Drop-down list has color images. Note that value type is {Wx::PG::ColourPropertyValue} instead of {Wx::Colour} (which {Wx::PG::ColourProperty} uses).
|
560
564
|
#
|
565
|
+
# ```
|
561
566
|
# class wxColourPropertyValue : public wxObject
|
562
567
|
# {
|
563
568
|
# public:
|
@@ -572,9 +577,11 @@ module Wx::PG
|
|
572
577
|
# // Resulting colour. Should be correct regardless of type.
|
573
578
|
# wxColour m_colour;
|
574
579
|
# };
|
580
|
+
# ```
|
575
581
|
#
|
576
582
|
# In {Wx::PG::SystemColourProperty}, and its derived class {Wx::PG::ColourProperty}, there are various sub-classing features. To set a basic list of colour names, call {Wx::PG::PGProperty#set_choices}.
|
577
583
|
#
|
584
|
+
# ```
|
578
585
|
# // Override in derived class to customize how colours are translated
|
579
586
|
# // to strings.
|
580
587
|
# virtual wxString ColourToString( const wxColour& col, int index ) const;
|
@@ -589,6 +596,7 @@ module Wx::PG
|
|
589
596
|
# // Returns colour for given choice.
|
590
597
|
# // Default function returns wxSystemSettings::GetColour(index).
|
591
598
|
# virtual wxColour GetColour( int index ) const;
|
599
|
+
# ```
|
592
600
|
#
|
593
601
|
# == wxCursorProperty
|
594
602
|
#
|
@@ -599,6 +607,7 @@ module Wx::PG
|
|
599
607
|
# New properties can be created by subclassing {Wx::PG::PGProperty} or one of the provided property classes, and (re)implementing necessary member functions. Below, each virtual member function has ample documentation about its purpose and any odd details which to keep in mind.
|
600
608
|
# Here is a very simple 'template' code:
|
601
609
|
#
|
610
|
+
# ```
|
602
611
|
# class MyProperty : public wxPGProperty
|
603
612
|
# {
|
604
613
|
# public:
|
@@ -641,10 +650,12 @@ module Wx::PG
|
|
641
650
|
#
|
642
651
|
# protected:
|
643
652
|
# };
|
653
|
+
# ```
|
644
654
|
#
|
645
655
|
# Since {Wx::PG::PGProperty} derives from {Wx::Object}, you can use standard {Wx::DECLARE_DYNAMIC_CLASS} and {Wx::IMPLEMENT_DYNAMIC_CLASS} macros. From the above example they were omitted for sake of simplicity, and besides, they are only really needed if you need to use {Wx::RTTI} with your property class.
|
646
656
|
# You can change the 'value type' of a property by simply assigning different type of variant with SetValue. <b>It is mandatory to implement {Wx::VariantData} class for all data types used as property values.</b> You can use macros declared in {Wx::PG::PropertyGrid} headers. For instance:
|
647
657
|
#
|
658
|
+
# ```
|
648
659
|
# // In header file:
|
649
660
|
# // (If you need to have export declaration, use version of macros
|
650
661
|
# // with _EXPORTED postfix)
|
@@ -655,6 +666,7 @@ module Wx::PG
|
|
655
666
|
#
|
656
667
|
# // Or, if you don't have valid == operator:
|
657
668
|
# WX_PG_IMPLEMENT_VARIANT_DATA_DUMMY_EQ(MyDataClass)
|
669
|
+
# ```
|
658
670
|
#
|
659
671
|
# ===
|
660
672
|
#
|
@@ -772,6 +784,7 @@ module Wx::PG
|
|
772
784
|
# Note that this function is usually called at the time that value of this property, or given child property, is still pending for change, and as such, result of {Wx::PG::PGProperty#get_value} or m_value should not be relied on.
|
773
785
|
# Sample pseudo-code implementation:
|
774
786
|
#
|
787
|
+
# ```
|
775
788
|
# wxVariant MyProperty::ChildChanged( wxVariant& thisValue,
|
776
789
|
# int childIndex,
|
777
790
|
# wxVariant& childValue ) const
|
@@ -796,6 +809,7 @@ module Wx::PG
|
|
796
809
|
# // Return altered data
|
797
810
|
# return data;
|
798
811
|
# }
|
812
|
+
# ```
|
799
813
|
#
|
800
814
|
# Modified value of the whole property.
|
801
815
|
# @param thisValue [Wx::Variant] Value of this property. Changed value should be returned (in previous versions of {Wx::PG::PropertyGrid} it was only necessary to write value back to this argument).
|
@@ -812,6 +826,7 @@ module Wx::PG
|
|
812
826
|
# Setting validator explicitly via SetPropertyValidator will override this.
|
813
827
|
# In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):
|
814
828
|
#
|
829
|
+
# ```
|
815
830
|
# wxValidator* wxMyPropertyClass::DoGetValidator () const
|
816
831
|
# {
|
817
832
|
# WX_PG_DOGETVALIDATOR_ENTRY()
|
@@ -822,6 +837,7 @@ module Wx::PG
|
|
822
837
|
#
|
823
838
|
# WX_PG_DOGETVALIDATOR_EXIT(validator)
|
824
839
|
# }
|
840
|
+
# ```
|
825
841
|
#
|
826
842
|
# You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
|
827
843
|
# @return [Wx::Validator]
|
@@ -836,7 +852,7 @@ module Wx::PG
|
|
836
852
|
# @param dc [Wx::DC] {Wx::DC} to paint on.
|
837
853
|
# @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).
|
838
854
|
# @param paintdata [Wx::PGPaintData] {Wx::PG::PGPaintData} structure with much useful data about painted item.
|
839
|
-
#
|
855
|
+
# ```
|
840
856
|
# struct wxPGPaintData
|
841
857
|
# {
|
842
858
|
# // wxPropertyGrid.
|
@@ -851,6 +867,7 @@ module Wx::PG
|
|
851
867
|
# // In a measure item call, set this to the height of item at m_choiceItem index
|
852
868
|
# int m_drawnHeight;
|
853
869
|
# };
|
870
|
+
# ```
|
854
871
|
# @return [void]
|
855
872
|
def on_custom_paint(dc, rect, paintdata) end
|
856
873
|
|
@@ -936,8 +953,9 @@ module Wx::PG
|
|
936
953
|
# Sets or clears given property flag.
|
937
954
|
# Mainly for internal use.
|
938
955
|
# Setting a property flag never has any side-effect, and is intended almost exclusively for internal use. So, for example, if you want to disable a property, call
|
939
|
-
#
|
956
|
+
# ```
|
940
957
|
# Enable(false)
|
958
|
+
# ```
|
941
959
|
# instead of setting {Wx::PG::PGPropertyFlags::PG_PROP_DISABLED} flag.
|
942
960
|
# @see Wx::PG::PGProperty#has_flag
|
943
961
|
# @see GetFlags()
|
@@ -1409,7 +1427,9 @@ module Wx::PG
|
|
1409
1427
|
# Set default value of a property.
|
1410
1428
|
# Synonymous to
|
1411
1429
|
#
|
1430
|
+
# ```
|
1412
1431
|
# SetAttribute("DefaultValue", value);
|
1432
|
+
# ```
|
1413
1433
|
# @param value [Wx::Variant]
|
1414
1434
|
# @return [void]
|
1415
1435
|
def set_default_value(value) end
|
@@ -1594,6 +1614,7 @@ module Wx::PG
|
|
1594
1614
|
# Constructor.
|
1595
1615
|
# It is protected because {Wx::PG::PGProperty} is only a base class for other property classes. Non-abstract property classes should have constructor of this style:
|
1596
1616
|
#
|
1617
|
+
# ```
|
1597
1618
|
# MyProperty( const wxString& label, const wxString& name, const T& value )
|
1598
1619
|
# : wxPGProperty(label, name)
|
1599
1620
|
# {
|
@@ -1609,6 +1630,7 @@ module Wx::PG
|
|
1609
1630
|
# // wxPG_LABEL,
|
1610
1631
|
# // value.GetSubProp1()));
|
1611
1632
|
# }
|
1633
|
+
# ```
|
1612
1634
|
# @param label [String]
|
1613
1635
|
# @param name [String]
|
1614
1636
|
# @return [PGProperty]
|
@@ -1625,6 +1647,8 @@ module Wx::PG
|
|
1625
1647
|
#
|
1626
1648
|
# Category: {Wx::PG::PropertyGrid}
|
1627
1649
|
#
|
1650
|
+
#
|
1651
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
1628
1652
|
class PGChoices < ::Object
|
1629
1653
|
|
1630
1654
|
# @overload initialize()
|
@@ -1796,6 +1820,8 @@ module Wx::PG
|
|
1796
1820
|
# Contains information related to property's OnCustomPaint.
|
1797
1821
|
#
|
1798
1822
|
#
|
1823
|
+
#
|
1824
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
1799
1825
|
class PGPaintData < ::Object
|
1800
1826
|
|
1801
1827
|
# {Wx::PG::PropertyGrid}
|
@@ -291,6 +291,8 @@ module Wx::PG
|
|
291
291
|
# Used to convey validation information to and from functions that actually perform validation.
|
292
292
|
# Mostly used in custom property classes.
|
293
293
|
#
|
294
|
+
#
|
295
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
294
296
|
class PGValidationInfo < ::Object
|
295
297
|
|
296
298
|
#
|
@@ -125,9 +125,11 @@ module Wx::PG
|
|
125
125
|
# Adds given key combination to trigger given action.
|
126
126
|
# Here is a sample code to make Enter key press move focus to the next property.
|
127
127
|
#
|
128
|
+
# ```
|
128
129
|
# propGrid->AddActionTrigger(wxPG_ACTION_NEXT_PROPERTY,
|
129
130
|
# WXK_RETURN);
|
130
131
|
# propGrid->DedicateKey(WXK_RETURN);
|
132
|
+
# ```
|
131
133
|
# @param action [Integer] Which action to trigger. See wxPropertyGrid Action Identifiers.
|
132
134
|
# @param keycode [Integer] Which keycode triggers the action.
|
133
135
|
# @param modifiers [Integer] Which key event modifiers, in addition to keycode, are needed to trigger the action.
|
@@ -411,8 +413,9 @@ module Wx::PG
|
|
411
413
|
|
412
414
|
# Makes given column editable by user.
|
413
415
|
# Note that column must not be equal to 1, as the second column is always editable and can be made read-only only on cell-by-cell basis using
|
414
|
-
#
|
415
|
-
# wxPGProperty::ChangeFlag(wxPG_PROP_READONLY, true)
|
416
|
+
# ```
|
417
|
+
# wxPGProperty::ChangeFlag(wxPG_PROP_READONLY, true)
|
418
|
+
# ```
|
416
419
|
# @see Wx::PG::PropertyGrid#begin_label_edit
|
417
420
|
# @see Wx::PG::PropertyGrid#end_label_edit
|
418
421
|
# @param column [Integer] The index of the column to make editable.
|
@@ -419,6 +419,7 @@ module Wx::PG
|
|
419
419
|
#
|
420
420
|
# Example of use:
|
421
421
|
#
|
422
|
+
# ```
|
422
423
|
# // append category
|
423
424
|
# wxPGProperty* my_cat_id = propertygrid->Append( new wxPropertyCategory("My Category") );
|
424
425
|
#
|
@@ -429,6 +430,7 @@ module Wx::PG
|
|
429
430
|
#
|
430
431
|
# // insert before to first item - using first variant
|
431
432
|
# wxPGProperty* my_item_id_2 = propertygrid->Insert( my_item_id, new wxStringProperty("My String 2") );
|
433
|
+
# ```
|
432
434
|
# @param priorThis [String,Wx::PG::PGProperty] New property is inserted just prior to this. Available only in the first variant. There are two versions of this function to allow this parameter to be either an id or name to a property.
|
433
435
|
# @param newProperty [Wx::PGProperty] Pointer to the inserted property. {Wx::PG::PropertyGrid} will take ownership of this object.
|
434
436
|
# @return [Wx::PG::PGProperty]
|
@@ -502,8 +504,10 @@ module Wx::PG
|
|
502
504
|
# Replaces property with id with newly created one.
|
503
505
|
# For example, this code replaces existing property named "Flags" with one that will have different set of items:
|
504
506
|
#
|
507
|
+
# ```
|
505
508
|
# pg->ReplaceProperty("Flags",
|
506
509
|
# wxFlagsProperty("Flags", wxPG_LABEL, newItems))
|
510
|
+
# ```
|
507
511
|
# @see Wx::PG::PropertyGridInterface#insert
|
508
512
|
# @param id [String,Wx::PG::PGProperty]
|
509
513
|
# @param property [Wx::PGProperty]
|
@@ -519,12 +523,12 @@ module Wx::PG
|
|
519
523
|
# @param src [String] String generated by SaveEditableState.
|
520
524
|
# @param restoreStates [Integer] Which parts to restore from source string. See list of editable state flags.
|
521
525
|
# @return [true,false]
|
522
|
-
def restore_editable_state(src, restoreStates=Wx::PG::
|
526
|
+
def restore_editable_state(src, restoreStates=Wx::PG::PropertyGridPage::EditableStateFlags::AllStates) end
|
523
527
|
|
524
528
|
# Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions).
|
525
529
|
# @param includedStates [Integer] Which parts of state to include. See list of editable state flags.
|
526
530
|
# @return [String]
|
527
|
-
def save_editable_state(includedStates=Wx::PG::
|
531
|
+
def save_editable_state(includedStates=Wx::PG::PropertyGridPage::EditableStateFlags::AllStates) end
|
528
532
|
|
529
533
|
# Set proportion of an auto-stretchable column.
|
530
534
|
# {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} window style needs to be used to indicate that columns are auto- resizable.
|
@@ -14,6 +14,7 @@ module Wx::PG
|
|
14
14
|
# {Wx::PG::PropertyGridManager} constructor has exact same format as {Wx::PG::PropertyGrid} constructor, and basically accepts same extra window style flags (albeit also has some extra ones).
|
15
15
|
# Here's some example code for creating and populating a {Wx::PG::PropertyGridManager}:
|
16
16
|
#
|
17
|
+
# ```
|
17
18
|
# wxPropertyGridManager* pgMan = new wxPropertyGridManager(this, PGID,
|
18
19
|
# wxDefaultPosition, wxDefaultSize,
|
19
20
|
# // These and other similar styles are automatically
|
@@ -47,6 +48,7 @@ module Wx::PG
|
|
47
48
|
#
|
48
49
|
# // Display a header above the grid
|
49
50
|
# pgMan->ShowHeader();
|
51
|
+
# ```
|
50
52
|
#
|
51
53
|
# == Window Styles
|
52
54
|
#
|
@@ -122,6 +122,8 @@ module Wx::PG
|
|
122
122
|
#
|
123
123
|
# A return value from {Wx::PG::PropertyGrid#hit_test}, contains all you need to know about an arbitrary location on the grid.
|
124
124
|
#
|
125
|
+
#
|
126
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
125
127
|
class PropertyGridHitTestResult < ::Object
|
126
128
|
|
127
129
|
# @return [PropertyGridHitTestResult]
|
@@ -51,7 +51,7 @@ module Wx
|
|
51
51
|
|
52
52
|
# Returns the native implementation of the real picker control.
|
53
53
|
# The returned control in the generic implementation of {Wx::FilePickerCtrl}, {Wx::DirPickerCtrl}, {Wx::FontPickerCtrl} and {Wx::ColourPickerCtrl} is a specialized {Wx::Button} class so that you can change its label doing, e.g.:
|
54
|
-
#
|
54
|
+
# ```
|
55
55
|
# #ifdef __WXMSW__
|
56
56
|
# // wxMSW is one of the platforms where the generic implementation
|
57
57
|
# // of wxFilePickerCtrl is used...
|
@@ -60,6 +60,7 @@ module Wx
|
|
60
60
|
# if (pButt)
|
61
61
|
# pButt->SetLabel("Custom browse string");
|
62
62
|
# #endif
|
63
|
+
# ```
|
63
64
|
# @return [Wx::Control]
|
64
65
|
def get_picker_ctrl; end
|
65
66
|
alias_method :picker_ctrl, :get_picker_ctrl
|
@@ -183,9 +183,10 @@ module Wx
|
|
183
183
|
# This class holds information about the operating system, the toolkit and the basic architecture bitness of the machine where the application is currently running.
|
184
184
|
# This class does not only have getters for the information above, it also has setters. This allows you to e.g. save the current platform information in a data file (maybe in string form) so that when you later load it, you can easily retrieve (see the static getters for string->enum conversion functions) and store inside a {Wx::PlatformInfo} instance (using its setters) the signature of the system which generated it.
|
185
185
|
# In general however you only need to use the static {Wx::PlatformInfo.get} function and then access the various information for the current platform:
|
186
|
-
#
|
186
|
+
# ```
|
187
187
|
# wxLogMessage("This application is running under %s.",
|
188
188
|
# wxPlatformInfo::Get().GetOperatingSystemIdName());
|
189
|
+
# ```
|
189
190
|
#
|
190
191
|
# ===
|
191
192
|
#
|
@@ -198,6 +199,8 @@ module Wx
|
|
198
199
|
# @see User and OS
|
199
200
|
#
|
200
201
|
#
|
202
|
+
#
|
203
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
201
204
|
class PlatformInfo < ::Object
|
202
205
|
|
203
206
|
# Returns the architecture bitness ID of this {Wx::PlatformInfo} instance.
|
@@ -51,6 +51,7 @@ module Wx
|
|
51
51
|
# To use this class, call {Wx::PropertySheetDialog#create} from your own Create function. Then call {Wx::PropertySheetDialog#create_buttons}, and create pages, adding them to the book control. Finally call {Wx::PropertySheetDialog#layout_dialog}.
|
52
52
|
# For example:
|
53
53
|
#
|
54
|
+
# ```
|
54
55
|
# bool MyPropertySheetDialog::Create(...)
|
55
56
|
# {
|
56
57
|
# if (!wxPropertySheetDialog::Create(...))
|
@@ -65,6 +66,7 @@ module Wx
|
|
65
66
|
# LayoutDialog();
|
66
67
|
# return true;
|
67
68
|
# }
|
69
|
+
# ```
|
68
70
|
#
|
69
71
|
# If necessary, override {Wx::PropertySheetDialog#create_book_ctrl} and {Wx::PropertySheetDialog#add_book_ctrl} to create and add a different kind of book control. You will then need to use two-step construction for the dialog or change the style of the book control by calling {Wx::PropertySheetDialog#set_sheet_style} before calling {Wx::PropertySheetDialog#create}.
|
70
72
|
# The Dialogs Sample shows this class being used with notebook and toolbook controllers (for Windows-style and Mac-style settings dialogs).
|