wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (740) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/INSTALL.md +35 -29
  4. data/README.md +24 -15
  5. data/ext/wxbase32u_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  7. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  19. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  20. data/lib/wx/aui/aui_tab_ctrl.rb +18 -0
  21. data/lib/wx/aui/auinotebook.rb +6 -2
  22. data/lib/wx/aui/require.rb +1 -0
  23. data/lib/wx/core/app.rb +2 -2
  24. data/lib/wx/core/bitmap_combobox.rb +17 -21
  25. data/lib/wx/core/collapsible_pane.rb +1 -1
  26. data/lib/wx/core/combobox.rb +13 -3
  27. data/lib/wx/core/controlwithitems.rb +40 -128
  28. data/lib/wx/core/enum.rb +17 -1
  29. data/lib/wx/core/event.rb +6 -1
  30. data/lib/wx/core/events/evt_list.rb +5 -4
  31. data/lib/wx/core/evthandler.rb +8 -2
  32. data/lib/wx/core/generic_validator.rb +312 -0
  33. data/lib/wx/core/listbox.rb +2 -2
  34. data/lib/wx/core/log.rb +1 -1
  35. data/lib/wx/core/menu.rb +10 -0
  36. data/lib/wx/core/notebook.rb +6 -2
  37. data/lib/wx/core/owner_drawn_combobox.rb +45 -0
  38. data/lib/wx/core/size.rb +4 -0
  39. data/lib/wx/core/sizer.rb +12 -2
  40. data/lib/wx/core/standard_paths.rb +22 -0
  41. data/lib/wx/core/task_bar_button.rb +19 -0
  42. data/lib/wx/core/text_entry.rb +4 -1
  43. data/lib/wx/core/textctrl.rb +11 -1
  44. data/lib/wx/core/{treectrl.rb → tree_ctrl.rb} +31 -12
  45. data/lib/wx/core/validator.rb +70 -5
  46. data/lib/wx/core/window.rb +13 -7
  47. data/lib/wx/doc/app.rb +48 -38
  48. data/lib/wx/doc/art_locator.rb +48 -43
  49. data/lib/wx/doc/aui/auimanager.rb +16 -8
  50. data/lib/wx/doc/aui/auinotebook.rb +20 -5
  51. data/lib/wx/doc/clipboard.rb +11 -7
  52. data/lib/wx/doc/colour_dialog.rb +14 -10
  53. data/lib/wx/doc/comboctrl.rb +18 -0
  54. data/lib/wx/doc/controlwithitems.rb +34 -8
  55. data/lib/wx/doc/data_object.rb +2 -2
  56. data/lib/wx/doc/date_picker_ctrl.rb +23 -0
  57. data/lib/wx/doc/editable_listbox.rb +44 -0
  58. data/lib/wx/doc/enum.rb +15 -0
  59. data/lib/wx/doc/event.rb +12 -0
  60. data/lib/wx/doc/evthandler.rb +113 -108
  61. data/lib/wx/doc/extra/12_client_data.md +89 -0
  62. data/lib/wx/doc/extra/13_validators.md +139 -0
  63. data/lib/wx/doc/font.rb +1 -0
  64. data/lib/wx/doc/gc_dc.rb +6 -1
  65. data/lib/wx/doc/gdi_common.rb +4 -0
  66. data/lib/wx/doc/gen/about_dialog_info.rb +26 -2
  67. data/lib/wx/doc/gen/accelerator.rb +19 -4
  68. data/lib/wx/doc/gen/accessible.rb +48 -47
  69. data/lib/wx/doc/gen/activity_indicator.rb +10 -4
  70. data/lib/wx/doc/gen/animation.rb +19 -3
  71. data/lib/wx/doc/gen/animation_ctrl.rb +16 -7
  72. data/lib/wx/doc/gen/any_button.rb +22 -1
  73. data/lib/wx/doc/gen/app.rb +41 -5
  74. data/lib/wx/doc/gen/app_traits.rb +65 -15
  75. data/lib/wx/doc/gen/art_provider.rb +33 -7
  76. data/lib/wx/doc/gen/aui/aui_dock_art.rb +18 -3
  77. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +2 -0
  78. data/lib/wx/doc/gen/aui/aui_manager.rb +35 -8
  79. data/lib/wx/doc/gen/aui/aui_manager_event.rb +11 -4
  80. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +4 -0
  81. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +3 -0
  82. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +8 -1
  83. data/lib/wx/doc/gen/aui/aui_notebook.rb +31 -7
  84. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +5 -4
  85. data/lib/wx/doc/gen/aui/aui_pane_info.rb +38 -2
  86. data/lib/wx/doc/gen/aui/aui_tab_art.rb +9 -3
  87. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +2 -1
  88. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +20 -6
  89. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +4 -2
  90. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +5 -7
  91. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +5 -1
  92. data/lib/wx/doc/gen/aui/event_list.rb +164 -160
  93. data/lib/wx/doc/gen/banner_window.rb +8 -1
  94. data/lib/wx/doc/gen/bitmap.rb +94 -16
  95. data/lib/wx/doc/gen/bitmap_button.rb +16 -8
  96. data/lib/wx/doc/gen/bitmap_combo_box.rb +20 -10
  97. data/lib/wx/doc/gen/book_ctrl_base.rb +31 -4
  98. data/lib/wx/doc/gen/book_ctrl_event.rb +9 -3
  99. data/lib/wx/doc/gen/box_sizer.rb +5 -1
  100. data/lib/wx/doc/gen/brush.rb +20 -2
  101. data/lib/wx/doc/gen/busy_info.rb +10 -2
  102. data/lib/wx/doc/gen/button.rb +31 -11
  103. data/lib/wx/doc/gen/calculate_layout_event.rb +5 -3
  104. data/lib/wx/doc/gen/calendar_ctrl.rb +38 -13
  105. data/lib/wx/doc/gen/calendar_date_attr.rb +2 -1
  106. data/lib/wx/doc/gen/calendar_event.rb +5 -2
  107. data/lib/wx/doc/gen/caret.rb +3 -1
  108. data/lib/wx/doc/gen/check_box.rb +17 -7
  109. data/lib/wx/doc/gen/check_list_box.rb +8 -6
  110. data/lib/wx/doc/gen/choice.rb +28 -9
  111. data/lib/wx/doc/gen/choicebook.rb +7 -7
  112. data/lib/wx/doc/gen/client_dc.rb +6 -2
  113. data/lib/wx/doc/gen/clipboard.rb +16 -3
  114. data/lib/wx/doc/gen/collapsible_pane.rb +9 -7
  115. data/lib/wx/doc/gen/collapsible_pane_event.rb +3 -3
  116. data/lib/wx/doc/gen/colour.rb +28 -4
  117. data/lib/wx/doc/gen/colour_dialog.rb +15 -7
  118. data/lib/wx/doc/gen/colour_picker_ctrl.rb +13 -10
  119. data/lib/wx/doc/gen/colour_picker_event.rb +5 -5
  120. data/lib/wx/doc/gen/combo_box.rb +36 -14
  121. data/lib/wx/doc/gen/combo_ctrl.rb +117 -295
  122. data/lib/wx/doc/gen/command_link_button.rb +12 -5
  123. data/lib/wx/doc/gen/context_help_button.rb +13 -3
  124. data/lib/wx/doc/gen/control.rb +22 -8
  125. data/lib/wx/doc/gen/control_with_items.rb +45 -10
  126. data/lib/wx/doc/gen/core.rb +4 -4
  127. data/lib/wx/doc/gen/cursor.rb +10 -8
  128. data/lib/wx/doc/gen/data_format.rb +7 -1
  129. data/lib/wx/doc/gen/data_object.rb +42 -18
  130. data/lib/wx/doc/gen/date_event.rb +3 -2
  131. data/lib/wx/doc/gen/date_picker_ctrl.rb +18 -8
  132. data/lib/wx/doc/gen/dc.rb +238 -36
  133. data/lib/wx/doc/gen/defs.rb +51 -51
  134. data/lib/wx/doc/gen/dial_up_event.rb +2 -1
  135. data/lib/wx/doc/gen/dial_up_manager.rb +25 -5
  136. data/lib/wx/doc/gen/dialog.rb +72 -13
  137. data/lib/wx/doc/gen/dir_dialog.rb +22 -5
  138. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +2 -0
  139. data/lib/wx/doc/gen/dir_picker_ctrl.rb +14 -10
  140. data/lib/wx/doc/gen/drag_drop.rb +28 -7
  141. data/lib/wx/doc/gen/drag_image.rb +13 -2
  142. data/lib/wx/doc/gen/editable_list_box.rb +7 -5
  143. data/lib/wx/doc/gen/event.rb +57 -26
  144. data/lib/wx/doc/gen/event_blocker.rb +2 -3
  145. data/lib/wx/doc/gen/event_filter.rb +3 -0
  146. data/lib/wx/doc/gen/event_list.rb +1656 -1652
  147. data/lib/wx/doc/gen/events.rb +305 -173
  148. data/lib/wx/doc/gen/evt_handler.rb +49 -3
  149. data/lib/wx/doc/gen/ext_help_controller.rb +10 -1
  150. data/lib/wx/doc/gen/file_ctrl.rb +28 -10
  151. data/lib/wx/doc/gen/file_ctrl_event.rb +7 -4
  152. data/lib/wx/doc/gen/file_dialog.rb +44 -14
  153. data/lib/wx/doc/gen/file_dialog_custom_control.rb +19 -0
  154. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +11 -3
  155. data/lib/wx/doc/gen/file_dir_picker_event.rb +4 -4
  156. data/lib/wx/doc/gen/file_picker_ctrl.rb +12 -9
  157. data/lib/wx/doc/gen/file_system.rb +54 -15
  158. data/lib/wx/doc/gen/find_dialog_event.rb +6 -4
  159. data/lib/wx/doc/gen/find_replace_data.rb +2 -1
  160. data/lib/wx/doc/gen/find_replace_dialog.rb +4 -1
  161. data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -1
  162. data/lib/wx/doc/gen/font.rb +103 -20
  163. data/lib/wx/doc/gen/font_data.rb +16 -3
  164. data/lib/wx/doc/gen/font_dialog.rb +6 -1
  165. data/lib/wx/doc/gen/font_picker_ctrl.rb +14 -7
  166. data/lib/wx/doc/gen/font_picker_event.rb +3 -3
  167. data/lib/wx/doc/gen/frame.rb +73 -15
  168. data/lib/wx/doc/gen/fs_file.rb +39 -10
  169. data/lib/wx/doc/gen/gauge.rb +19 -8
  170. data/lib/wx/doc/gen/gb_sizer_item.rb +5 -1
  171. data/lib/wx/doc/gen/gcdc.rb +3 -2
  172. data/lib/wx/doc/gen/gdi_common.rb +80 -11
  173. data/lib/wx/doc/gen/gdi_object.rb +1 -1
  174. data/lib/wx/doc/gen/generic_dir_ctrl.rb +13 -7
  175. data/lib/wx/doc/gen/graphics_context.rb +86 -10
  176. data/lib/wx/doc/gen/graphics_object.rb +35 -6
  177. data/lib/wx/doc/gen/grid/event_list.rb +168 -164
  178. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +3 -0
  179. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +16 -3
  180. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -1
  181. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +2 -1
  182. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -1
  183. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -1
  184. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -1
  185. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +2 -1
  186. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +2 -1
  187. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +2 -1
  188. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +10 -1
  189. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +2 -1
  190. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +2 -1
  191. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -1
  192. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -1
  193. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -1
  194. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -1
  195. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +7 -1
  196. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -1
  197. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -1
  198. data/lib/wx/doc/gen/grid/grid_ctrl.rb +256 -12
  199. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +6 -4
  200. data/lib/wx/doc/gen/grid/grid_event.rb +6 -4
  201. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +4 -4
  202. data/lib/wx/doc/gen/grid/grid_size_event.rb +4 -4
  203. data/lib/wx/doc/gen/grid/grid_string_table.rb +8 -0
  204. data/lib/wx/doc/gen/grid/grid_table_base.rb +28 -3
  205. data/lib/wx/doc/gen/grid/grid_table_message.rb +2 -0
  206. data/lib/wx/doc/gen/grid_bag_sizer.rb +21 -7
  207. data/lib/wx/doc/gen/grid_sizer.rb +11 -1
  208. data/lib/wx/doc/gen/gui_event_loop.rb +13 -3
  209. data/lib/wx/doc/gen/header_ctrl.rb +110 -11
  210. data/lib/wx/doc/gen/header_ctrl_event.rb +4 -2
  211. data/lib/wx/doc/gen/help_controller.rb +14 -3
  212. data/lib/wx/doc/gen/help_provider.rb +22 -4
  213. data/lib/wx/doc/gen/html/event_list.rb +41 -37
  214. data/lib/wx/doc/gen/html/html_cell.rb +48 -6
  215. data/lib/wx/doc/gen/html/html_cell_event.rb +5 -4
  216. data/lib/wx/doc/gen/html/html_easy_printing.rb +20 -3
  217. data/lib/wx/doc/gen/html/html_help_controller.rb +26 -2
  218. data/lib/wx/doc/gen/html/html_help_data.rb +8 -1
  219. data/lib/wx/doc/gen/html/html_help_window.rb +9 -1
  220. data/lib/wx/doc/gen/html/html_link_event.rb +3 -3
  221. data/lib/wx/doc/gen/html/html_list_box.rb +54 -16
  222. data/lib/wx/doc/gen/html/html_printout.rb +7 -1
  223. data/lib/wx/doc/gen/html/html_window.rb +43 -6
  224. data/lib/wx/doc/gen/hyperlink_ctrl.rb +9 -8
  225. data/lib/wx/doc/gen/hyperlink_event.rb +3 -3
  226. data/lib/wx/doc/gen/icon.rb +23 -29
  227. data/lib/wx/doc/gen/icon_location.rb +1 -1
  228. data/lib/wx/doc/gen/image.rb +143 -20
  229. data/lib/wx/doc/gen/image_list.rb +25 -6
  230. data/lib/wx/doc/gen/info_bar.rb +14 -2
  231. data/lib/wx/doc/gen/keyboard_state.rb +11 -1
  232. data/lib/wx/doc/gen/list_box.rb +46 -17
  233. data/lib/wx/doc/gen/list_ctrl.rb +165 -29
  234. data/lib/wx/doc/gen/list_event.rb +13 -4
  235. data/lib/wx/doc/gen/listbook.rb +7 -7
  236. data/lib/wx/doc/gen/locale.rb +68 -4
  237. data/lib/wx/doc/gen/log.rb +58 -12
  238. data/lib/wx/doc/gen/mdi_client_window.rb +11 -2
  239. data/lib/wx/doc/gen/mdi_frame.rb +51 -7
  240. data/lib/wx/doc/gen/media_ctrl.rb +43 -18
  241. data/lib/wx/doc/gen/media_event.rb +6 -4
  242. data/lib/wx/doc/gen/memory_dc.rb +16 -6
  243. data/lib/wx/doc/gen/menu.rb +81 -26
  244. data/lib/wx/doc/gen/menu_bar.rb +74 -15
  245. data/lib/wx/doc/gen/menu_item.rb +67 -19
  246. data/lib/wx/doc/gen/message_dialog.rb +17 -8
  247. data/lib/wx/doc/gen/mini_frame.rb +14 -5
  248. data/lib/wx/doc/gen/mirror_dc.rb +1 -2
  249. data/lib/wx/doc/gen/mouse_state.rb +1 -1
  250. data/lib/wx/doc/gen/multi_choice_dialog.rb +9 -4
  251. data/lib/wx/doc/gen/non_owned_window.rb +4 -1
  252. data/lib/wx/doc/gen/notebook.rb +27 -9
  253. data/lib/wx/doc/gen/num_validator.rb +37 -0
  254. data/lib/wx/doc/gen/number_entry_dialog.rb +5 -1
  255. data/lib/wx/doc/gen/object.rb +3 -1
  256. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
  257. data/lib/wx/doc/gen/paint_dc.rb +1 -1
  258. data/lib/wx/doc/gen/palette.rb +5 -1
  259. data/lib/wx/doc/gen/panel.rb +25 -8
  260. data/lib/wx/doc/gen/pen.rb +46 -8
  261. data/lib/wx/doc/gen/pg/event_list.rb +97 -93
  262. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +4 -1
  263. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +12 -1
  264. data/lib/wx/doc/gen/pg/pg_cell.rb +11 -3
  265. data/lib/wx/doc/gen/pg/pg_editor.rb +161 -16
  266. data/lib/wx/doc/gen/pg/pg_multi_button.rb +3 -2
  267. data/lib/wx/doc/gen/pg/pg_properties.rb +632 -83
  268. data/lib/wx/doc/gen/pg/pg_property.rb +381 -77
  269. data/lib/wx/doc/gen/pg/pg_validation_info.rb +11 -4
  270. data/lib/wx/doc/gen/pg/property_grid.rb +123 -20
  271. data/lib/wx/doc/gen/pg/property_grid_event.rb +41 -9
  272. data/lib/wx/doc/gen/pg/property_grid_interface.rb +273 -34
  273. data/lib/wx/doc/gen/pg/property_grid_manager.rb +62 -10
  274. data/lib/wx/doc/gen/pg/property_grid_page.rb +33 -8
  275. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +18 -4
  276. data/lib/wx/doc/gen/picker_base.rb +22 -5
  277. data/lib/wx/doc/gen/platform_info.rb +35 -9
  278. data/lib/wx/doc/gen/popup_window.rb +7 -5
  279. data/lib/wx/doc/gen/progress_dialog.rb +5 -0
  280. data/lib/wx/doc/gen/property_sheet_dialog.rb +20 -4
  281. data/lib/wx/doc/gen/prt/event_list.rb +8 -4
  282. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +3 -1
  283. data/lib/wx/doc/gen/prt/post_script_dc.rb +3 -2
  284. data/lib/wx/doc/gen/prt/preview_frame.rb +5 -1
  285. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +4 -0
  286. data/lib/wx/doc/gen/prt/print_data.rb +31 -3
  287. data/lib/wx/doc/gen/prt/print_dialog.rb +5 -1
  288. data/lib/wx/doc/gen/prt/printer.rb +87 -11
  289. data/lib/wx/doc/gen/prt/printer_dc.rb +3 -1
  290. data/lib/wx/doc/gen/query_layout_info_event.rb +10 -3
  291. data/lib/wx/doc/gen/radio_box.rb +28 -10
  292. data/lib/wx/doc/gen/radio_button.rb +22 -9
  293. data/lib/wx/doc/gen/rbn/event_list.rb +127 -123
  294. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +82 -3
  295. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +26 -4
  296. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +3 -2
  297. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +50 -12
  298. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +3 -2
  299. data/lib/wx/doc/gen/rbn/ribbon_control.rb +11 -1
  300. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +21 -11
  301. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -2
  302. data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -1
  303. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +16 -4
  304. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +3 -3
  305. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +27 -3
  306. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +3 -1
  307. data/lib/wx/doc/gen/rearrange_ctrl.rb +5 -2
  308. data/lib/wx/doc/gen/rearrange_list.rb +12 -4
  309. data/lib/wx/doc/gen/region.rb +104 -17
  310. data/lib/wx/doc/gen/region_iterator.rb +1 -1
  311. data/lib/wx/doc/gen/rtc/event_list.rb +116 -112
  312. data/lib/wx/doc/gen/rtc/rich_text_box.rb +27 -9
  313. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +45 -11
  314. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -1
  315. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -14
  316. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +84 -7
  317. data/lib/wx/doc/gen/rtc/rich_text_event.rb +8 -4
  318. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -2
  319. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +8 -3
  320. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +4 -2
  321. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +6 -3
  322. data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -2
  323. data/lib/wx/doc/gen/rtc/rich_text_object.rb +82 -17
  324. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +54 -11
  325. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +15 -2
  326. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +14 -9
  327. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +4 -1
  328. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +4 -3
  329. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +2 -2
  330. data/lib/wx/doc/gen/sash_event.rb +13 -4
  331. data/lib/wx/doc/gen/sash_layout_window.rb +21 -4
  332. data/lib/wx/doc/gen/sash_window.rb +6 -4
  333. data/lib/wx/doc/gen/screen_dc.rb +1 -1
  334. data/lib/wx/doc/gen/scroll_bar.rb +28 -10
  335. data/lib/wx/doc/gen/scrolled_canvas.rb +48 -10
  336. data/lib/wx/doc/gen/scrolled_control.rb +48 -10
  337. data/lib/wx/doc/gen/scrolled_window.rb +48 -10
  338. data/lib/wx/doc/gen/search_ctrl.rb +14 -9
  339. data/lib/wx/doc/gen/simplebook.rb +8 -1
  340. data/lib/wx/doc/gen/single_choice_dialog.rb +9 -4
  341. data/lib/wx/doc/gen/sizer.rb +91 -16
  342. data/lib/wx/doc/gen/sizer_item.rb +21 -4
  343. data/lib/wx/doc/gen/slider.rb +50 -17
  344. data/lib/wx/doc/gen/spin_button.rb +24 -10
  345. data/lib/wx/doc/gen/spin_ctrl.rb +35 -9
  346. data/lib/wx/doc/gen/spin_ctrl_double.rb +13 -7
  347. data/lib/wx/doc/gen/spin_double_event.rb +6 -4
  348. data/lib/wx/doc/gen/spin_event.rb +4 -3
  349. data/lib/wx/doc/gen/splash_screen.rb +3 -2
  350. data/lib/wx/doc/gen/splitter_event.rb +12 -4
  351. data/lib/wx/doc/gen/splitter_window.rb +100 -18
  352. data/lib/wx/doc/gen/static_bitmap.rb +109 -7
  353. data/lib/wx/doc/gen/static_box.rb +15 -7
  354. data/lib/wx/doc/gen/static_box_sizer.rb +3 -2
  355. data/lib/wx/doc/gen/static_line.rb +7 -4
  356. data/lib/wx/doc/gen/static_text.rb +10 -6
  357. data/lib/wx/doc/gen/status_bar.rb +32 -8
  358. data/lib/wx/doc/gen/stc/event_list.rb +212 -208
  359. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +207 -13
  360. data/lib/wx/doc/gen/stc/styled_text_event.rb +31 -6
  361. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -1
  362. data/lib/wx/doc/gen/svg_file_dc.rb +15 -7
  363. data/lib/wx/doc/gen/system_options.rb +14 -6
  364. data/lib/wx/doc/gen/system_settings.rb +9 -3
  365. data/lib/wx/doc/gen/task_bar_button.rb +324 -0
  366. data/lib/wx/doc/gen/task_bar_icon.rb +26 -8
  367. data/lib/wx/doc/gen/task_bar_icon_event.rb +5 -3
  368. data/lib/wx/doc/gen/text_attr.rb +47 -5
  369. data/lib/wx/doc/gen/text_ctrl.rb +114 -25
  370. data/lib/wx/doc/gen/text_entry.rb +69 -11
  371. data/lib/wx/doc/gen/text_entry_dialog.rb +14 -2
  372. data/lib/wx/doc/gen/text_validator.rb +58 -9
  373. data/lib/wx/doc/gen/time_picker_ctrl.rb +11 -6
  374. data/lib/wx/doc/gen/timer.rb +14 -2
  375. data/lib/wx/doc/gen/timer_event.rb +2 -2
  376. data/lib/wx/doc/gen/tip_provider.rb +6 -1
  377. data/lib/wx/doc/gen/toggle_button.rb +73 -6
  378. data/lib/wx/doc/gen/tool_bar.rb +141 -25
  379. data/lib/wx/doc/gen/tool_tip.rb +41 -5
  380. data/lib/wx/doc/gen/toolbook.rb +6 -4
  381. data/lib/wx/doc/gen/top_level_window.rb +100 -23
  382. data/lib/wx/doc/gen/tree_ctrl.rb +89 -16
  383. data/lib/wx/doc/gen/tree_event.rb +9 -4
  384. data/lib/wx/doc/gen/treebook.rb +16 -4
  385. data/lib/wx/doc/gen/ui_action_simulator.rb +10 -2
  386. data/lib/wx/doc/gen/utils.rb +94 -7
  387. data/lib/wx/doc/gen/v_list_box.rb +27 -2
  388. data/lib/wx/doc/gen/v_scrolled_window.rb +21 -4
  389. data/lib/wx/doc/gen/validator.rb +10 -14
  390. data/lib/wx/doc/gen/variant.rb +7 -0
  391. data/lib/wx/doc/gen/window.rb +415 -57
  392. data/lib/wx/doc/gen/window_dc.rb +2 -1
  393. data/lib/wx/doc/gen/window_disabler.rb +6 -2
  394. data/lib/wx/doc/gen/with_images.rb +13 -2
  395. data/lib/wx/doc/gen/wizard.rb +22 -4
  396. data/lib/wx/doc/gen/wizard_event.rb +5 -4
  397. data/lib/wx/doc/gen/wizard_page.rb +7 -2
  398. data/lib/wx/doc/gen/wizard_page_simple.rb +5 -1
  399. data/lib/wx/doc/gen/wrap_sizer.rb +5 -1
  400. data/lib/wx/doc/gen/xml_node.rb +33 -4
  401. data/lib/wx/doc/gen/xml_resource.rb +40 -5
  402. data/lib/wx/doc/generic_validator.rb +95 -0
  403. data/lib/wx/doc/graphics_context.rb +1 -0
  404. data/lib/wx/doc/grid/grid.rb +22 -1
  405. data/lib/wx/doc/help_controller.rb +11 -7
  406. data/lib/wx/doc/html/html_help_controller.rb +12 -4
  407. data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
  408. data/lib/wx/doc/list_ctrl.rb +33 -29
  409. data/lib/wx/doc/menu.rb +20 -0
  410. data/lib/wx/doc/notebook.rb +21 -0
  411. data/lib/wx/doc/num_validator.rb +387 -0
  412. data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
  413. data/lib/wx/doc/pg/events.rb +13 -9
  414. data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
  415. data/lib/wx/doc/pg/pg_property.rb +18 -0
  416. data/lib/wx/doc/progress_dialog.rb +36 -32
  417. data/lib/wx/doc/prt/page_setup_dialog.rb +20 -12
  418. data/lib/wx/doc/prt/print_data.rb +13 -5
  419. data/lib/wx/doc/prt/print_dialog.rb +31 -23
  420. data/lib/wx/doc/prt/printer.rb +20 -12
  421. data/lib/wx/doc/radio_box.rb +19 -15
  422. data/lib/wx/doc/rbn/ribbon_bar.rb +13 -5
  423. data/lib/wx/doc/rbn/ribbon_button_bar.rb +13 -5
  424. data/lib/wx/doc/rbn/ribbon_gallery.rb +13 -5
  425. data/lib/wx/doc/rbn/ribbon_tool_bar.rb +13 -5
  426. data/lib/wx/doc/region_iterator.rb +32 -28
  427. data/lib/wx/doc/rtc/rich_text_composite_object.rb +24 -0
  428. data/lib/wx/doc/rtc/rich_text_ctrl.rb +24 -0
  429. data/lib/wx/doc/rtc/rich_text_paragraph.rb +24 -0
  430. data/lib/wx/doc/rtc/richtext_buffer.rb +27 -19
  431. data/lib/wx/doc/rtc/richtext_printing.rb +17 -9
  432. data/lib/wx/doc/rtc/richtext_style_sheet.rb +17 -9
  433. data/lib/wx/doc/sizer.rb +20 -0
  434. data/lib/wx/doc/static_bitmap.rb +25 -0
  435. data/lib/wx/doc/stc/styled_text_ctrl.rb +24 -0
  436. data/lib/wx/doc/stream.rb +39 -35
  437. data/lib/wx/doc/system_settings.rb +30 -26
  438. data/lib/wx/doc/text_validator.rb +23 -9
  439. data/lib/wx/doc/textctrl.rb +16 -0
  440. data/lib/wx/doc/tree_ctrl.rb +95 -0
  441. data/lib/wx/doc/treebook.rb +9 -5
  442. data/lib/wx/doc/v_list_box.rb +9 -5
  443. data/lib/wx/doc/validator.rb +113 -0
  444. data/lib/wx/doc/variant.rb +164 -160
  445. data/lib/wx/doc/window.rb +87 -47
  446. data/lib/wx/doc/window_disabler.rb +10 -6
  447. data/lib/wx/grid/grid.rb +27 -4
  448. data/lib/wx/html/events/evt_list.rb +0 -10
  449. data/lib/wx/html/simple_html_listbox.rb +24 -91
  450. data/lib/wx/keyword_defs.rb +34 -2
  451. data/lib/wx/pg/pg_property.rb +22 -0
  452. data/lib/wx/rbn/ribbon_gallery.rb +0 -21
  453. data/lib/wx/rtc/require.rb +3 -0
  454. data/lib/wx/rtc/rich_text_composite_object.rb +25 -0
  455. data/lib/wx/rtc/rich_text_ctrl.rb +25 -0
  456. data/lib/wx/rtc/rich_text_paragraph.rb +25 -0
  457. data/lib/wx/stc/require.rb +1 -0
  458. data/lib/wx/stc/styled_text_ctrl.rb +25 -0
  459. data/lib/wx/version.rb +1 -1
  460. data/lib/wxruby_aui.so +0 -0
  461. data/lib/wxruby_core.so +0 -0
  462. data/lib/wxruby_grid.so +0 -0
  463. data/lib/wxruby_html.so +0 -0
  464. data/lib/wxruby_pg.so +0 -0
  465. data/lib/wxruby_prt.so +0 -0
  466. data/lib/wxruby_rbn.so +0 -0
  467. data/lib/wxruby_rtc.so +0 -0
  468. data/lib/wxruby_stc.so +0 -0
  469. data/rakelib/lib/config/linux.rb +0 -3
  470. data/rakelib/lib/config/macosx.rb +2 -2
  471. data/rakelib/lib/config/mingw.rb +13 -1
  472. data/rakelib/lib/config/unixish.rb +1 -1
  473. data/rakelib/lib/config.rb +14 -4
  474. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +74 -2
  475. data/rakelib/yard/templates/default/fulldoc/html/full_list.erb +38 -0
  476. data/rakelib/yard/templates/default/fulldoc/html/setup.rb +39 -0
  477. data/rakelib/yard/templates/default/tags/html/wxrb_require.erb +10 -0
  478. data/rakelib/yard/templates/default/tags/setup.rb +16 -0
  479. data/rakelib/yard/yard-custom-templates.rb +3 -0
  480. data/samples/aui/aui.rb +1237 -1233
  481. data/samples/calendar/calendar.rb +293 -289
  482. data/samples/controls/get_item_sample.rb +83 -79
  483. data/samples/controls/htlbox.rb +331 -327
  484. data/samples/dialogs/dialogs.rb +682 -694
  485. data/samples/dialogs/wizard.rb +52 -55
  486. data/samples/dragdrop/dragdrop.rb +146 -142
  487. data/samples/drawing/bitmap.rb +29 -26
  488. data/samples/drawing/bitmap_image.rb +84 -80
  489. data/samples/drawing/graphics_drawing.rb +209 -205
  490. data/samples/drawing/image_prt.rb +344 -340
  491. data/samples/drawing/maths_images.rb +18 -1
  492. data/samples/drawing/rmagic_bitmap_image.rb +88 -84
  493. data/samples/etc/caret.rb +306 -0
  494. data/samples/etc/miniframe.rb +65 -60
  495. data/samples/etc/sash.rb +109 -105
  496. data/samples/etc/scrollwin.rb +86 -80
  497. data/samples/etc/system_settings.rb +216 -209
  498. data/samples/event/activation.rb +72 -67
  499. data/samples/event/event.rb +160 -153
  500. data/samples/event/threaded.rb +8 -1
  501. data/samples/event/update_ui_event.rb +67 -60
  502. data/samples/grid/grid.rb +188 -181
  503. data/samples/grid/gridtablebase.rb +136 -129
  504. data/samples/html/html.rb +208 -204
  505. data/samples/mdi/mdi.rb +59 -54
  506. data/samples/minimal/minimal.rb +54 -51
  507. data/samples/minimal/nothing.rb +1 -0
  508. data/samples/printing/printing.rb +367 -377
  509. data/samples/printing/printing2.rb +203 -198
  510. data/samples/propgrid/propgrid.rb +2312 -2308
  511. data/samples/propgrid/propgrid_minimal.rb +57 -50
  512. data/samples/ribbon/ribbon.rb +780 -774
  513. data/samples/sampler/ext.rb +0 -33
  514. data/samples/sampler/sample.rb +4 -9
  515. data/samples/sampler.rb +1 -1
  516. data/samples/splash/splash.rb +118 -116
  517. data/samples/text/rich_textctrl.rb +207 -201
  518. data/samples/text/richtext.rb +1409 -1405
  519. data/samples/text/scintilla.rb +137 -128
  520. data/samples/text/textctrl.rb +89 -83
  521. data/samples/text/unicode.rb +175 -168
  522. data/samples/treectrl/treectrl.rb +1430 -1426
  523. data/samples/widgets/activityindicator.rb +95 -0
  524. data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
  525. data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
  526. data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
  527. data/samples/widgets/art/widgets/button.xpm +54 -0
  528. data/samples/widgets/art/widgets/checkbox.xpm +54 -0
  529. data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
  530. data/samples/widgets/art/widgets/choicebk.xpm +54 -0
  531. data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
  532. data/samples/widgets/art/widgets/combobox.xpm +54 -0
  533. data/samples/widgets/art/widgets/datepick.xpm +200 -0
  534. data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
  535. data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
  536. data/samples/widgets/art/widgets/filepicker.xpm +214 -0
  537. data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
  538. data/samples/widgets/art/widgets/gauge.xpm +54 -0
  539. data/samples/widgets/art/widgets/header.xpm +54 -0
  540. data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
  541. data/samples/widgets/art/widgets/listbook.xpm +54 -0
  542. data/samples/widgets/art/widgets/listbox.xpm +54 -0
  543. data/samples/widgets/art/widgets/native.xpm +81 -0
  544. data/samples/widgets/art/widgets/notebook.xpm +54 -0
  545. data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
  546. data/samples/widgets/art/widgets/radiobox.xpm +54 -0
  547. data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
  548. data/samples/widgets/art/widgets/slider.xpm +54 -0
  549. data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
  550. data/samples/widgets/art/widgets/statbmp.xpm +40 -0
  551. data/samples/widgets/art/widgets/statbox.xpm +54 -0
  552. data/samples/widgets/art/widgets/stattext.xpm +54 -0
  553. data/samples/widgets/art/widgets/text.xpm +54 -0
  554. data/samples/widgets/art/widgets/timepick.xpm +207 -0
  555. data/samples/widgets/art/widgets/toggle.xpm +54 -0
  556. data/samples/widgets/art/widgets/toucan.png +0 -0
  557. data/samples/widgets/bmpcombobox.rb +651 -0
  558. data/samples/widgets/button.rb +462 -0
  559. data/samples/widgets/checkbox.rb +211 -0
  560. data/samples/widgets/choice.rb +287 -0
  561. data/samples/widgets/clrpicker.rb +156 -0
  562. data/samples/widgets/combobox.rb +516 -0
  563. data/samples/widgets/datepick.rb +215 -0
  564. data/samples/widgets/dirctrl.rb +265 -0
  565. data/samples/widgets/dirpicker.rb +158 -0
  566. data/samples/widgets/editlbox.rb +122 -0
  567. data/samples/widgets/filectrl.rb +216 -0
  568. data/samples/widgets/filepicker.rb +214 -0
  569. data/samples/widgets/fontpicker.rb +135 -0
  570. data/samples/widgets/gauge.rb +311 -0
  571. data/samples/widgets/headerctrl.rb +236 -0
  572. data/samples/widgets/hyperlink.rb +203 -0
  573. data/samples/widgets/itemcontainer.rb +185 -0
  574. data/samples/widgets/listbox.rb +473 -0
  575. data/samples/widgets/notebook.rb +488 -0
  576. data/samples/widgets/odcombobox.rb +608 -0
  577. data/samples/widgets/radiobox.rb +328 -0
  578. data/samples/widgets/searchctrl.rb +159 -0
  579. data/samples/widgets/slider.rb +594 -0
  580. data/samples/widgets/spinbtn.rb +443 -0
  581. data/samples/widgets/statbmp.rb +130 -0
  582. data/samples/widgets/static.rb +436 -0
  583. data/samples/widgets/textctrl.rb +700 -0
  584. data/samples/widgets/timepick.rb +148 -0
  585. data/samples/widgets/tn_widgets.png +0 -0
  586. data/samples/widgets/toggle.rb +385 -0
  587. data/samples/widgets/widgets.rb +1233 -0
  588. data/samples/xrc/custom_xrc_sample.rb +47 -41
  589. data/samples/xrc/xrc_sample.rb +53 -47
  590. data/tests/media/beep_lo.wav +0 -0
  591. data/tests/test_event_handling.rb +52 -34
  592. data/tests/test_events.rb +7 -0
  593. data/tests/test_item_data.rb +24 -0
  594. data/tests/test_list_ctrl.rb +1 -1
  595. data/tests/test_media_ctrl.rb +38 -0
  596. data/tests/test_menu.rb +69 -0
  597. data/tests/test_pg.rb +27 -0
  598. data/tests/test_richtext.rb +45 -0
  599. data/tests/test_sizer.rb +59 -0
  600. data/tests/test_std_controls.rb +42 -1
  601. data/tests/test_styled_text_ctrl.rb +46 -0
  602. data/tests/test_tree_ctrl.rb +138 -0
  603. data/tests/test_validators.rb +805 -0
  604. data/tests/test_window.rb +12 -0
  605. data/tests/testapp_noframe.rb +1 -1
  606. metadata +113 -138
  607. data/lib/wx/core/choice.rb +0 -14
  608. data/lib/wx/core/combo_ctrl.rb +0 -110
  609. data/samples/bigdemo/About.rbw +0 -39
  610. data/samples/bigdemo/ColorPanel.rbw +0 -23
  611. data/samples/bigdemo/GridSimple.rbw +0 -78
  612. data/samples/bigdemo/MDIDemo.rbw +0 -57
  613. data/samples/bigdemo/PopupMenu.rbw +0 -146
  614. data/samples/bigdemo/ShapedWindow.rbw +0 -128
  615. data/samples/bigdemo/Sizers.rbw +0 -541
  616. data/samples/bigdemo/bigdemo.rb +0 -817
  617. data/samples/bigdemo/demoTemplate.rbw +0 -33
  618. data/samples/bigdemo/helpfile.htb +0 -0
  619. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  620. data/samples/bigdemo/icons/Test 015.png +0 -0
  621. data/samples/bigdemo/icons/choice.bmp +0 -0
  622. data/samples/bigdemo/icons/combo.bmp +0 -0
  623. data/samples/bigdemo/icons/combo.xpm +0 -27
  624. data/samples/bigdemo/icons/copy.xpm +0 -25
  625. data/samples/bigdemo/icons/cut.xpm +0 -24
  626. data/samples/bigdemo/icons/gauge.bmp +0 -0
  627. data/samples/bigdemo/icons/gauge.xpm +0 -27
  628. data/samples/bigdemo/icons/help.xpm +0 -25
  629. data/samples/bigdemo/icons/list.bmp +0 -0
  630. data/samples/bigdemo/icons/list.xpm +0 -27
  631. data/samples/bigdemo/icons/mondrian.ico +0 -0
  632. data/samples/bigdemo/icons/mondrian.xpm +0 -44
  633. data/samples/bigdemo/icons/new.xpm +0 -24
  634. data/samples/bigdemo/icons/ogl.ico +0 -0
  635. data/samples/bigdemo/icons/ogl.xpm +0 -45
  636. data/samples/bigdemo/icons/open.xpm +0 -26
  637. data/samples/bigdemo/icons/paste.bmp +0 -0
  638. data/samples/bigdemo/icons/paste.xpm +0 -38
  639. data/samples/bigdemo/icons/pointy.png +0 -0
  640. data/samples/bigdemo/icons/preview.xpm +0 -26
  641. data/samples/bigdemo/icons/print.xpm +0 -26
  642. data/samples/bigdemo/icons/radio.bmp +0 -0
  643. data/samples/bigdemo/icons/radio.xpm +0 -27
  644. data/samples/bigdemo/icons/robert.xpm +0 -415
  645. data/samples/bigdemo/icons/sashtest.ico +0 -0
  646. data/samples/bigdemo/icons/save.xpm +0 -25
  647. data/samples/bigdemo/icons/smiles.bmp +0 -0
  648. data/samples/bigdemo/icons/smiles.xpm +0 -39
  649. data/samples/bigdemo/icons/smiley.ico +0 -0
  650. data/samples/bigdemo/icons/smiley.xpm +0 -42
  651. data/samples/bigdemo/icons/stattext.xpm +0 -24
  652. data/samples/bigdemo/icons/test2.bmp +0 -0
  653. data/samples/bigdemo/icons/test2.png +0 -0
  654. data/samples/bigdemo/icons/test2.xpm +0 -79
  655. data/samples/bigdemo/icons/text.bmp +0 -0
  656. data/samples/bigdemo/icons/text.xpm +0 -27
  657. data/samples/bigdemo/icons/tog1.bmp +0 -0
  658. data/samples/bigdemo/icons/tog1.xpm +0 -38
  659. data/samples/bigdemo/icons/tog2.bmp +0 -0
  660. data/samples/bigdemo/icons/tog2.xpm +0 -38
  661. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  662. data/samples/bigdemo/icons/wxwin.ico +0 -0
  663. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  664. data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
  665. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  666. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  667. data/samples/bigdemo/run.rb +0 -98
  668. data/samples/bigdemo/tips.txt +0 -7
  669. data/samples/bigdemo/utils.rb +0 -20
  670. data/samples/bigdemo/wxArtProvider.rbw +0 -282
  671. data/samples/bigdemo/wxBitmapButton.rbw +0 -65
  672. data/samples/bigdemo/wxButton.rbw +0 -64
  673. data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
  674. data/samples/bigdemo/wxCheckBox.rbw +0 -50
  675. data/samples/bigdemo/wxCheckListBox.rbw +0 -65
  676. data/samples/bigdemo/wxChoice.rbw +0 -47
  677. data/samples/bigdemo/wxChoicebook.rbw +0 -78
  678. data/samples/bigdemo/wxColourDialog.rbw +0 -33
  679. data/samples/bigdemo/wxComboBox.rbw +0 -77
  680. data/samples/bigdemo/wxCursor.rbw +0 -136
  681. data/samples/bigdemo/wxDialog.rbw +0 -74
  682. data/samples/bigdemo/wxDirDialog.rbw +0 -29
  683. data/samples/bigdemo/wxDragImage.rbw +0 -70
  684. data/samples/bigdemo/wxFileDialog.rbw +0 -37
  685. data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
  686. data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
  687. data/samples/bigdemo/wxFontDialog.rbw +0 -200
  688. data/samples/bigdemo/wxFrame.rbw +0 -53
  689. data/samples/bigdemo/wxGauge.rbw +0 -65
  690. data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
  691. data/samples/bigdemo/wxGrid.rbw +0 -66
  692. data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
  693. data/samples/bigdemo/wxListBox.rbw +0 -140
  694. data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
  695. data/samples/bigdemo/wxMDIWindows.rbw +0 -50
  696. data/samples/bigdemo/wxMenu.rbw +0 -247
  697. data/samples/bigdemo/wxMessageDialog.rbw +0 -27
  698. data/samples/bigdemo/wxMiniFrame.rbw +0 -70
  699. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
  700. data/samples/bigdemo/wxNotebook.rbw +0 -136
  701. data/samples/bigdemo/wxProgressDialog.rbw +0 -43
  702. data/samples/bigdemo/wxRadioBox.rbw +0 -72
  703. data/samples/bigdemo/wxRadioButton.rbw +0 -125
  704. data/samples/bigdemo/wxSashWindow.rbw +0 -141
  705. data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
  706. data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
  707. data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
  708. data/samples/bigdemo/wxSlider.rbw +0 -42
  709. data/samples/bigdemo/wxSpinButton.rbw +0 -50
  710. data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
  711. data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
  712. data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
  713. data/samples/bigdemo/wxStaticText.rbw +0 -55
  714. data/samples/bigdemo/wxStatusBar.rbw +0 -126
  715. data/samples/bigdemo/wxTextCtrl.rbw +0 -149
  716. data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
  717. data/samples/bigdemo/wxToggleButton.rbw +0 -49
  718. data/samples/bigdemo/wxToolBar.rbw +0 -131
  719. data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
  720. data/samples/caret/caret.rb +0 -298
  721. data/samples/caret/mondrian.xpm +0 -44
  722. data/samples/controls/books.rb +0 -189
  723. data/samples/controls/choice.xpm +0 -27
  724. data/samples/controls/combo.xpm +0 -27
  725. data/samples/controls/controls.rb +0 -1099
  726. data/samples/controls/gauge.xpm +0 -27
  727. data/samples/controls/list.xpm +0 -27
  728. data/samples/controls/mondrian.ico +0 -0
  729. data/samples/controls/mondrian.xpm +0 -44
  730. data/samples/controls/radio.xpm +0 -27
  731. data/samples/controls/stattext.xpm +0 -24
  732. data/samples/controls/test2.bmp +0 -0
  733. data/samples/controls/text.xpm +0 -27
  734. data/samples/controls/tn_books.png +0 -0
  735. data/samples/controls/tn_controls.png +0 -0
  736. data/samples/etc/choice.rb +0 -87
  737. data/samples/etc/tn_choice.png +0 -0
  738. data/samples/text/mondrian.ico +0 -0
  739. data/samples/text/mondrian.xpm +0 -44
  740. /data/samples/{caret → etc}/tn_caret.png +0 -0
@@ -7,11 +7,13 @@
7
7
  module Wx::PG
8
8
 
9
9
  # Basic property with boolean value.
10
+ #
10
11
  # <b>Supported special attributes:</b>
11
12
  #
12
13
  # - {Wx::PG::PG_BOOL_USE_CHECKBOX}: Set to true to use check box editor instead of combo box.
13
14
  # - {Wx::PG::PG_BOOL_USE_DOUBLE_CLICK_CYCLING}: Set to true to cycle combo box instead showing the list.
14
15
  #
16
+ # @wxrb_require USE_PROPGRID
15
17
  class BoolProperty < PGProperty
16
18
 
17
19
  # @param label [String]
@@ -21,16 +23,26 @@ module Wx::PG
21
23
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=false) end
22
24
 
23
25
  # Converts property value into a text representation.
24
- # Default implementation calls {Wx::PG::BoolProperty#generate_composed_value}.
26
+ #
27
+ # <div class="wxrb-remark">
28
+ # <b>Remark:</b>
29
+ # <p>Default implementation calls {Wx::PG::BoolProperty#generate_composed_value}.
30
+ # </p>
31
+ # </div>
25
32
  # @param value [Wx::Variant] Value to be converted.
26
33
  # @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
34
  # @return [String]
28
35
  def value_to_string(value, argFlags=0) end
29
36
 
30
37
  # Converts text into {Wx::Variant} value appropriate for this property.
38
+ #
31
39
  # Returns true if resulting {Wx::Variant} value was different.
32
40
  #
33
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
41
+ # <div class="wxrb-remark">
42
+ # <b>Remark:</b>
43
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
44
+ # </p>
45
+ # </div>
34
46
  #
35
47
  # 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
48
  # @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.
@@ -40,12 +52,20 @@ module Wx::PG
40
52
  def string_to_value(variant, text, argFlags=0) end
41
53
 
42
54
  # Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
55
+ #
43
56
  # Returns true if resulting {Wx::Variant} value was different.
44
57
  #
58
+ # <div class="wxrb-remark">
59
+ # <b>Remark:</b>
60
+ # <p>
61
+ #
45
62
  # - 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
63
  # - Default implementation simply assign given int to m_value.
47
64
  # - 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).
65
+ # - 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).
66
+ #
67
+ # </p>
68
+ # </div>
49
69
  # @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
70
  # @param number [Integer] Integer to be translated into variant.
51
71
  # @param argFlags [Integer] If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
@@ -53,9 +73,14 @@ module Wx::PG
53
73
  def int_to_value(variant, number, argFlags=0) end
54
74
 
55
75
  # Reimplement this member function to add special handling for attributes of this property.
76
+ #
56
77
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
57
78
  #
58
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
79
+ # <div class="wxrb-remark">
80
+ # <b>Remark:</b>
81
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
82
+ # </p>
83
+ # </div>
59
84
  # @param name [String]
60
85
  # @param value [Wx::Variant]
61
86
  # @return [Boolean]
@@ -72,11 +97,13 @@ module Wx::PG
72
97
  end # BoolProperty
73
98
 
74
99
  # Property representing {Wx::DateTime}.
100
+ #
75
101
  # <b>Supported special attributes:</b>
76
102
  #
77
103
  # - {Wx::PG::PG_DATE_FORMAT}: Determines displayed date format.
78
104
  # - {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
105
  #
106
+ # @wxrb_require USE_PROPGRID
80
107
  class DateProperty < PGProperty
81
108
 
82
109
  # @param label [String]
@@ -86,23 +113,41 @@ module Wx::PG
86
113
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=(Wx::DateTime.new())) end
87
114
 
88
115
  # This virtual function is called after m_value has been set.
116
+ #
117
+ # <div class="wxrb-remark">
118
+ # <b>Remark:</b>
119
+ # <p>
120
+ #
89
121
  # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::DateProperty#on_set_value} will not be called.
90
122
  # - 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.
123
+ # - Default implementation does nothing.
124
+ #
125
+ # </p>
126
+ # </div>
92
127
  # @return [void]
93
128
  def on_set_value; end
94
129
 
95
130
  # Converts property value into a text representation.
96
- # Default implementation calls {Wx::PG::DateProperty#generate_composed_value}.
131
+ #
132
+ # <div class="wxrb-remark">
133
+ # <b>Remark:</b>
134
+ # <p>Default implementation calls {Wx::PG::DateProperty#generate_composed_value}.
135
+ # </p>
136
+ # </div>
97
137
  # @param value [Wx::Variant] Value to be converted.
98
138
  # @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
139
  # @return [String]
100
140
  def value_to_string(value, argFlags=0) end
101
141
 
102
142
  # Converts text into {Wx::Variant} value appropriate for this property.
143
+ #
103
144
  # Returns true if resulting {Wx::Variant} value was different.
104
145
  #
105
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
146
+ # <div class="wxrb-remark">
147
+ # <b>Remark:</b>
148
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
149
+ # </p>
150
+ # </div>
106
151
  #
107
152
  # 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
153
  # @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.
@@ -112,9 +157,14 @@ module Wx::PG
112
157
  def string_to_value(variant, text, argFlags=0) end
113
158
 
114
159
  # Reimplement this member function to add special handling for attributes of this property.
160
+ #
115
161
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
116
162
  #
117
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
163
+ # <div class="wxrb-remark">
164
+ # <b>Remark:</b>
165
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
166
+ # </p>
167
+ # </div>
118
168
  # @param name [String]
119
169
  # @param value [Wx::Variant]
120
170
  # @return [Boolean]
@@ -177,8 +227,10 @@ module Wx::PG
177
227
  end # DateProperty
178
228
 
179
229
  # Represents a bit set that fits in a long integer.
230
+ #
180
231
  # {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
232
  #
233
+ # @wxrb_require USE_PROPGRID
182
234
  class FlagsProperty < PGProperty
183
235
 
184
236
  # @overload initialize(label, name, choices, value=0)
@@ -197,23 +249,41 @@ module Wx::PG
197
249
  def initialize(*args) end
198
250
 
199
251
  # This virtual function is called after m_value has been set.
252
+ #
253
+ # <div class="wxrb-remark">
254
+ # <b>Remark:</b>
255
+ # <p>
256
+ #
200
257
  # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::FlagsProperty#on_set_value} will not be called.
201
258
  # - 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.
259
+ # - Default implementation does nothing.
260
+ #
261
+ # </p>
262
+ # </div>
203
263
  # @return [void]
204
264
  def on_set_value; end
205
265
 
206
266
  # Converts property value into a text representation.
207
- # Default implementation calls {Wx::PG::FlagsProperty#generate_composed_value}.
267
+ #
268
+ # <div class="wxrb-remark">
269
+ # <b>Remark:</b>
270
+ # <p>Default implementation calls {Wx::PG::FlagsProperty#generate_composed_value}.
271
+ # </p>
272
+ # </div>
208
273
  # @param value [Wx::Variant] Value to be converted.
209
274
  # @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
275
  # @return [String]
211
276
  def value_to_string(value, argFlags=0) end
212
277
 
213
278
  # Converts text into {Wx::Variant} value appropriate for this property.
279
+ #
214
280
  # Returns true if resulting {Wx::Variant} value was different.
215
281
  #
216
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
282
+ # <div class="wxrb-remark">
283
+ # <b>Remark:</b>
284
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
285
+ # </p>
286
+ # </div>
217
287
  #
218
288
  # 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
289
  # @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.
@@ -223,6 +293,7 @@ module Wx::PG
223
293
  def string_to_value(variant, text, argFlags) end
224
294
 
225
295
  # Called after value of a child property has been altered.
296
+ #
226
297
  # Must return new value of the whole property (after any alterations warranted by child's new value).
227
298
  # 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.
228
299
  # Sample pseudo-code implementation:
@@ -255,20 +326,27 @@ module Wx::PG
255
326
  def child_changed(thisValue, childIndex, childValue) end
256
327
 
257
328
  # Refresh values of child properties.
329
+ #
258
330
  # Automatically called after value is set.
259
331
  # @return [void]
260
332
  def refresh_children; end
261
333
 
262
334
  # Reimplement this member function to add special handling for attributes of this property.
335
+ #
263
336
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
264
337
  #
265
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
338
+ # <div class="wxrb-remark">
339
+ # <b>Remark:</b>
340
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
341
+ # </p>
342
+ # </div>
266
343
  # @param name [String]
267
344
  # @param value [Wx::Variant]
268
345
  # @return [Boolean]
269
346
  def do_set_attribute(name, value) end
270
347
 
271
348
  # Returns which choice is currently selected.
349
+ #
272
350
  # Only applies to properties which have choices.
273
351
  # Needs to reimplemented in derived class if property value does not map directly to a choice. Integer as index, bool, and string usually do.
274
352
  # @return [Integer]
@@ -295,12 +373,21 @@ module Wx::PG
295
373
  end # FlagsProperty
296
374
 
297
375
  # Basic property with string value.
376
+ #
298
377
  # <b>Supported special attributes:</b>
299
378
  #
300
379
  # - {Wx::PG::PG_STRING_PASSWORD}: set to true in order to enable {Wx::TE_PASSWORD} on the editor.
301
380
  #
302
- # - If value "<composed>" is set, then actual value is formed (or composed) from values of child properties.
381
+ # <div class="wxrb-remark">
382
+ # <b>Remark:</b>
383
+ # <p>
303
384
  #
385
+ # - If value "<composed>" is set, then actual value is formed (or composed) from values of child properties.
386
+ #
387
+ # </p>
388
+ # </div>
389
+ #
390
+ # @wxrb_require USE_PROPGRID
304
391
  class StringProperty < PGProperty
305
392
 
306
393
  # @param label [String]
@@ -310,16 +397,26 @@ module Wx::PG
310
397
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
311
398
 
312
399
  # Converts property value into a text representation.
313
- # Default implementation calls {Wx::PG::StringProperty#generate_composed_value}.
400
+ #
401
+ # <div class="wxrb-remark">
402
+ # <b>Remark:</b>
403
+ # <p>Default implementation calls {Wx::PG::StringProperty#generate_composed_value}.
404
+ # </p>
405
+ # </div>
314
406
  # @param value [Wx::Variant] Value to be converted.
315
407
  # @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
408
  # @return [String]
317
409
  def value_to_string(value, argFlags=0) end
318
410
 
319
411
  # Converts text into {Wx::Variant} value appropriate for this property.
412
+ #
320
413
  # Returns true if resulting {Wx::Variant} value was different.
321
414
  #
322
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
415
+ # <div class="wxrb-remark">
416
+ # <b>Remark:</b>
417
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
418
+ # </p>
419
+ # </div>
323
420
  #
324
421
  # 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
422
  # @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.
@@ -329,9 +426,14 @@ module Wx::PG
329
426
  def string_to_value(variant, text, argFlags=0) end
330
427
 
331
428
  # Reimplement this member function to add special handling for attributes of this property.
429
+ #
332
430
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
333
431
  #
334
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
432
+ # <div class="wxrb-remark">
433
+ # <b>Remark:</b>
434
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
435
+ # </p>
436
+ # </div>
335
437
  # @param name [String]
336
438
  # @param value [Wx::Variant]
337
439
  # @return [Boolean]
@@ -354,6 +456,8 @@ module Wx::PG
354
456
  # Category (caption) property.
355
457
  #
356
458
  #
459
+ #
460
+ # @wxrb_require USE_PROPGRID
357
461
  class PropertyCategory < PGProperty
358
462
 
359
463
  # @overload initialize()
@@ -372,14 +476,24 @@ module Wx::PG
372
476
  alias_method :text_extent, :get_text_extent
373
477
 
374
478
  # Converts property value into a text representation.
375
- # Default implementation calls {Wx::PG::PropertyCategory#generate_composed_value}.
479
+ #
480
+ # <div class="wxrb-remark">
481
+ # <b>Remark:</b>
482
+ # <p>Default implementation calls {Wx::PG::PropertyCategory#generate_composed_value}.
483
+ # </p>
484
+ # </div>
376
485
  # @param value [Wx::Variant] Value to be converted.
377
486
  # @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
487
  # @return [String]
379
488
  def value_to_string(value, argFlags) end
380
489
 
381
490
  # Returns text representation of property's value.
382
- # 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.
491
+ #
492
+ # <div class="wxrb-remark">
493
+ # <b>Remark:</b>
494
+ # <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.
495
+ # </p>
496
+ # </div>
383
497
  # @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
498
  # @return [String]
385
499
  def get_value_as_string(argFlags=0) end
@@ -396,23 +510,31 @@ module Wx::PG
396
510
  end # PropertyCategory
397
511
 
398
512
  # This is an abstract class which serves as a base class for the properties having a button triggering an editor dialog, like e.g.
513
+ #
399
514
  # {Wx::PG::LongStringProperty}, {Wx::PG::DirProperty}, {Wx::PG::FileProperty}.
400
515
  # <b>Supported special attributes:</b>
401
516
  #
402
517
  # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the editor dialog.
403
518
  #
519
+ # @wxrb_require USE_PROPGRID
404
520
  class EditorDialogProperty < PGProperty
405
521
 
406
522
  # Returns instance of a new {Wx::PG::PGEditorDialogAdapter} instance, which is used when user presses the (optional) button next to the editor control;.
523
+ #
407
524
  # Default implementation returns NULL (i.e. no action is generated when button is pressed).
408
525
  # @return [Wx::PG::PGEditorDialogAdapter]
409
526
  def get_editor_dialog; end
410
527
  alias_method :editor_dialog, :get_editor_dialog
411
528
 
412
529
  # Reimplement this member function to add special handling for attributes of this property.
530
+ #
413
531
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
414
532
  #
415
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
533
+ # <div class="wxrb-remark">
534
+ # <b>Remark:</b>
535
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
536
+ # </p>
537
+ # </div>
416
538
  # @param name [String]
417
539
  # @param value [Wx::Variant]
418
540
  # @return [Boolean]
@@ -460,6 +582,7 @@ module Wx::PG
460
582
  def initialize(label, name) end
461
583
 
462
584
  # Shows editor dialog.
585
+ #
463
586
  # Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and true should be returned.
464
587
  #
465
588
  # Returns true if editor dialog was not cancelled and value was updated.
@@ -471,17 +594,20 @@ module Wx::PG
471
594
  end # EditorDialogProperty
472
595
 
473
596
  # Property that manages a list of strings.
597
+ #
474
598
  # <b>Supported special attributes:</b>
475
599
  #
476
600
  # - {Wx::PG::PG_ARRAY_DELIMITER}: Sets string delimiter character.
477
601
  # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the editor dialog (since 3.1.3).
478
602
  #
603
+ # @wxrb_require USE_PROPGRID
479
604
  class ArrayStringProperty < EditorDialogProperty
480
605
 
481
606
  #
482
607
  #
483
608
  #
484
609
  #
610
+ # @wxrb_require USE_PROPGRID
485
611
  class ConversionFlags < Wx::Enum
486
612
 
487
613
  #
@@ -501,23 +627,41 @@ module Wx::PG
501
627
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=(Wx::ArrayString.new())) end
502
628
 
503
629
  # This virtual function is called after m_value has been set.
630
+ #
631
+ # <div class="wxrb-remark">
632
+ # <b>Remark:</b>
633
+ # <p>
634
+ #
504
635
  # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::ArrayStringProperty#on_set_value} will not be called.
505
636
  # - 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.
637
+ # - Default implementation does nothing.
638
+ #
639
+ # </p>
640
+ # </div>
507
641
  # @return [void]
508
642
  def on_set_value; end
509
643
 
510
644
  # Converts property value into a text representation.
511
- # Default implementation calls {Wx::PG::ArrayStringProperty#generate_composed_value}.
645
+ #
646
+ # <div class="wxrb-remark">
647
+ # <b>Remark:</b>
648
+ # <p>Default implementation calls {Wx::PG::ArrayStringProperty#generate_composed_value}.
649
+ # </p>
650
+ # </div>
512
651
  # @param value [Wx::Variant] Value to be converted.
513
652
  # @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
653
  # @return [String]
515
654
  def value_to_string(value, argFlags=0) end
516
655
 
517
656
  # Converts text into {Wx::Variant} value appropriate for this property.
657
+ #
518
658
  # Returns true if resulting {Wx::Variant} value was different.
519
659
  #
520
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
660
+ # <div class="wxrb-remark">
661
+ # <b>Remark:</b>
662
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
663
+ # </p>
664
+ # </div>
521
665
  #
522
666
  # 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
667
  # @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.
@@ -527,9 +671,14 @@ module Wx::PG
527
671
  def string_to_value(variant, text, argFlags=0) end
528
672
 
529
673
  # Reimplement this member function to add special handling for attributes of this property.
674
+ #
530
675
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
531
676
  #
532
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
677
+ # <div class="wxrb-remark">
678
+ # <b>Remark:</b>
679
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
680
+ # </p>
681
+ # </div>
533
682
  # @param name [String]
534
683
  # @param value [Wx::Variant]
535
684
  # @return [Boolean]
@@ -542,6 +691,7 @@ module Wx::PG
542
691
  def convert_array_to_string(arr, delimiter) end
543
692
 
544
693
  # Shows string editor dialog to edit the individual item.
694
+ #
545
695
  # Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and true should be returned if that was the case.
546
696
  # @param parent [Wx::Window]
547
697
  # @return [String]
@@ -606,6 +756,7 @@ module Wx::PG
606
756
  protected
607
757
 
608
758
  # Shows editor dialog.
759
+ #
609
760
  # Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and true should be returned.
610
761
  #
611
762
  # Returns true if editor dialog was not cancelled and value was updated.
@@ -617,10 +768,12 @@ module Wx::PG
617
768
  end # ArrayStringProperty
618
769
 
619
770
  # Like {Wx::PG::LongStringProperty}, but the button triggers directory selector instead.
771
+ #
620
772
  # <b>Supported special attributes:</b>
621
773
  #
622
774
  # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the file dialog (since 3.1.3).
623
775
  #
776
+ # @wxrb_require USE_PROPGRID
624
777
  class DirProperty < EditorDialogProperty
625
778
 
626
779
  # @param label [String]
@@ -630,16 +783,26 @@ module Wx::PG
630
783
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
631
784
 
632
785
  # Converts property value into a text representation.
633
- # Default implementation calls {Wx::PG::DirProperty#generate_composed_value}.
786
+ #
787
+ # <div class="wxrb-remark">
788
+ # <b>Remark:</b>
789
+ # <p>Default implementation calls {Wx::PG::DirProperty#generate_composed_value}.
790
+ # </p>
791
+ # </div>
634
792
  # @param value [Wx::Variant] Value to be converted.
635
793
  # @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
794
  # @return [String]
637
795
  def value_to_string(value, argFlags=0) end
638
796
 
639
797
  # Converts text into {Wx::Variant} value appropriate for this property.
798
+ #
640
799
  # Returns true if resulting {Wx::Variant} value was different.
641
800
  #
642
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
801
+ # <div class="wxrb-remark">
802
+ # <b>Remark:</b>
803
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
804
+ # </p>
805
+ # </div>
643
806
  #
644
807
  # 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
808
  # @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 +812,8 @@ module Wx::PG
649
812
  def string_to_value(variant, text, argFlags=0) end
650
813
 
651
814
  # 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 #set_property_validator will override this.
815
+ #
816
+ # Setting validator explicitly via \#set_property_validator will override this.
653
817
  # In most situations, code like this should work well:
654
818
  #
655
819
  # ```ruby
@@ -672,7 +836,11 @@ module Wx::PG
672
836
  # end
673
837
  # ```
674
838
  #
675
- # You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
839
+ # <div class="wxrb-remark">
840
+ # <b>Remark:</b>
841
+ # <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
842
+ # </p>
843
+ # </div>
676
844
  # @return [Wx::Validator]
677
845
  def do_get_validator; end
678
846
 
@@ -688,6 +856,7 @@ module Wx::PG
688
856
  protected
689
857
 
690
858
  # Shows editor dialog.
859
+ #
691
860
  # Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and true should be returned.
692
861
  #
693
862
  # Returns true if editor dialog was not cancelled and value was updated.
@@ -699,6 +868,7 @@ module Wx::PG
699
868
  end # DirProperty
700
869
 
701
870
  # Like {Wx::PG::LongStringProperty}, but the button triggers file selector instead.
871
+ #
702
872
  # <b>Supported special attributes:</b>
703
873
  #
704
874
  # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the file dialog (since 3.1.3).
@@ -708,6 +878,7 @@ module Wx::PG
708
878
  # - {Wx::PG::PG_FILE_SHOW_RELATIVE_PATH}: If set, then the filename is shown relative to the given path string.
709
879
  # - {Wx::PG::PG_FILE_INITIAL_PATH}: Sets the initial path of where to look for files.
710
880
  #
881
+ # @wxrb_require USE_PROPGRID
711
882
  class FileProperty < EditorDialogProperty
712
883
 
713
884
  # @param label [String]
@@ -717,23 +888,41 @@ module Wx::PG
717
888
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
718
889
 
719
890
  # This virtual function is called after m_value has been set.
891
+ #
892
+ # <div class="wxrb-remark">
893
+ # <b>Remark:</b>
894
+ # <p>
895
+ #
720
896
  # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::FileProperty#on_set_value} will not be called.
721
897
  # - 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.
898
+ # - Default implementation does nothing.
899
+ #
900
+ # </p>
901
+ # </div>
723
902
  # @return [void]
724
903
  def on_set_value; end
725
904
 
726
905
  # Converts property value into a text representation.
727
- # Default implementation calls {Wx::PG::FileProperty#generate_composed_value}.
906
+ #
907
+ # <div class="wxrb-remark">
908
+ # <b>Remark:</b>
909
+ # <p>Default implementation calls {Wx::PG::FileProperty#generate_composed_value}.
910
+ # </p>
911
+ # </div>
728
912
  # @param value [Wx::Variant] Value to be converted.
729
913
  # @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
914
  # @return [String]
731
915
  def value_to_string(value, argFlags=0) end
732
916
 
733
917
  # Converts text into {Wx::Variant} value appropriate for this property.
918
+ #
734
919
  # Returns true if resulting {Wx::Variant} value was different.
735
920
  #
736
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
921
+ # <div class="wxrb-remark">
922
+ # <b>Remark:</b>
923
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
924
+ # </p>
925
+ # </div>
737
926
  #
738
927
  # 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
928
  # @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.
@@ -743,16 +932,22 @@ module Wx::PG
743
932
  def string_to_value(variant, text, argFlags=0) end
744
933
 
745
934
  # Reimplement this member function to add special handling for attributes of this property.
935
+ #
746
936
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
747
937
  #
748
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
938
+ # <div class="wxrb-remark">
939
+ # <b>Remark:</b>
940
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
941
+ # </p>
942
+ # </div>
749
943
  # @param name [String]
750
944
  # @param value [Wx::Variant]
751
945
  # @return [Boolean]
752
946
  def do_set_attribute(name, value) end
753
947
 
754
948
  # 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 #set_property_validator will override this.
949
+ #
950
+ # Setting validator explicitly via \#set_property_validator will override this.
756
951
  # In most situations, code like this should work well:
757
952
  #
758
953
  # ```ruby
@@ -775,7 +970,11 @@ module Wx::PG
775
970
  # end
776
971
  # ```
777
972
  #
778
- # You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
973
+ # <div class="wxrb-remark">
974
+ # <b>Remark:</b>
975
+ # <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
976
+ # </p>
977
+ # </div>
779
978
  # @return [Wx::Validator]
780
979
  def do_get_validator; end
781
980
 
@@ -847,6 +1046,7 @@ module Wx::PG
847
1046
  protected
848
1047
 
849
1048
  # Shows editor dialog.
1049
+ #
850
1050
  # Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and true should be returned.
851
1051
  #
852
1052
  # Returns true if editor dialog was not cancelled and value was updated.
@@ -858,6 +1058,7 @@ module Wx::PG
858
1058
  end # FileProperty
859
1059
 
860
1060
  # Property representing image file(name).
1061
+ #
861
1062
  # <b>Supported special attributes:</b>
862
1063
  #
863
1064
  # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the file dialog (since 3.1.3).
@@ -868,6 +1069,7 @@ module Wx::PG
868
1069
  # - {Wx::PG::PG_FILE_SHOW_RELATIVE_PATH}: If set, then the filename is shown relative to the given path string.
869
1070
  # - {Wx::PG::PG_FILE_INITIAL_PATH}: Sets the initial path of where to look for files.
870
1071
  #
1072
+ # @wxrb_require USE_PROPGRID
871
1073
  class ImageFileProperty < FileProperty
872
1074
 
873
1075
  # @param label [String]
@@ -877,30 +1079,54 @@ module Wx::PG
877
1079
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
878
1080
 
879
1081
  # This virtual function is called after m_value has been set.
1082
+ #
1083
+ # <div class="wxrb-remark">
1084
+ # <b>Remark:</b>
1085
+ # <p>
1086
+ #
880
1087
  # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::ImageFileProperty#on_set_value} will not be called.
881
1088
  # - 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.
1089
+ # - Default implementation does nothing.
1090
+ #
1091
+ # </p>
1092
+ # </div>
883
1093
  # @return [void]
884
1094
  def on_set_value; end
885
1095
 
886
1096
  # Returns size of the custom painted image in front of property.
1097
+ #
887
1098
  # This method must be overridden to return non-default value if OnCustomPaint is to be called.
888
1099
  #
1100
+ # <div class="wxrb-remark">
1101
+ # <b>Remark:</b>
1102
+ # <p>
1103
+ #
889
1104
  # - Default behaviour is to return {size(0,0)}, which means no image.
890
1105
  # - 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}.
1106
+ # - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
1107
+ #
1108
+ # </p>
1109
+ # </div>
892
1110
  # @param item [Integer] Normally -1, but can be an index to the property's list of items.
893
1111
  # @return [Wx::Size]
894
1112
  def on_measure_image(item) end
895
1113
 
896
1114
  # Override to paint an image in front of the property value text or drop-down list item (but only if {Wx::PG::PGProperty#on_measure_image} is overridden as well).
1115
+ #
897
1116
  # 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
1117
  # 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
1118
  #
1119
+ # <div class="wxrb-remark">
1120
+ # <b>Remark:</b>
1121
+ # <p>
1122
+ #
900
1123
  # - 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
1124
  # - Due to technical reasons, rect's height will be default even if custom height was reported during measure call.
902
1125
  # - 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
1126
  # - 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.
1127
+ #
1128
+ # </p>
1129
+ # </div>
904
1130
  # @see Wx::PG::ImageFileProperty#value_to_string
905
1131
  # @param dc [Wx::DC] {Wx::DC} to paint on.
906
1132
  # @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).
@@ -919,10 +1145,12 @@ module Wx::PG
919
1145
  end # ImageFileProperty
920
1146
 
921
1147
  # Property representing {Wx::Font}.
1148
+ #
922
1149
  # <b>Supported special attributes:</b>
923
1150
  #
924
1151
  # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the font dialog (since 3.1.3).
925
1152
  #
1153
+ # @wxrb_require USE_PROPGRID
926
1154
  class FontProperty < EditorDialogProperty
927
1155
 
928
1156
  # @param label [String]
@@ -932,20 +1160,34 @@ module Wx::PG
932
1160
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=(Wx::Font.new())) end
933
1161
 
934
1162
  # This virtual function is called after m_value has been set.
1163
+ #
1164
+ # <div class="wxrb-remark">
1165
+ # <b>Remark:</b>
1166
+ # <p>
1167
+ #
935
1168
  # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::FontProperty#on_set_value} will not be called.
936
1169
  # - 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.
1170
+ # - Default implementation does nothing.
1171
+ #
1172
+ # </p>
1173
+ # </div>
938
1174
  # @return [void]
939
1175
  def on_set_value; end
940
1176
 
941
1177
  # Converts property value into a text representation.
942
- # Default implementation calls {Wx::PG::FontProperty#generate_composed_value}.
1178
+ #
1179
+ # <div class="wxrb-remark">
1180
+ # <b>Remark:</b>
1181
+ # <p>Default implementation calls {Wx::PG::FontProperty#generate_composed_value}.
1182
+ # </p>
1183
+ # </div>
943
1184
  # @param value [Wx::Variant] Value to be converted.
944
1185
  # @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
1186
  # @return [String]
946
1187
  def value_to_string(value, argFlags=0) end
947
1188
 
948
1189
  # Called after value of a child property has been altered.
1190
+ #
949
1191
  # Must return new value of the whole property (after any alterations warranted by child's new value).
950
1192
  # 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.
951
1193
  # Sample pseudo-code implementation:
@@ -984,6 +1226,7 @@ module Wx::PG
984
1226
  def child_changed(thisValue, childIndex, childValue) end
985
1227
 
986
1228
  # Refresh values of child properties.
1229
+ #
987
1230
  # Automatically called after value is set.
988
1231
  # @return [void]
989
1232
  def refresh_children; end
@@ -1000,6 +1243,7 @@ module Wx::PG
1000
1243
  protected
1001
1244
 
1002
1245
  # Shows editor dialog.
1246
+ #
1003
1247
  # Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and true should be returned.
1004
1248
  #
1005
1249
  # Returns true if editor dialog was not cancelled and value was updated.
@@ -1011,10 +1255,12 @@ module Wx::PG
1011
1255
  end # FontProperty
1012
1256
 
1013
1257
  # Like {Wx::PG::StringProperty}, but has a button that triggers a small text editor dialog.
1258
+ #
1014
1259
  # <b>Supported special attributes:</b>
1015
1260
  #
1016
1261
  # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the text editor dialog (since 3.1.3).
1017
1262
  #
1263
+ # @wxrb_require USE_PROPGRID
1018
1264
  class LongStringProperty < EditorDialogProperty
1019
1265
 
1020
1266
  # @param label [String]
@@ -1024,16 +1270,26 @@ module Wx::PG
1024
1270
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end
1025
1271
 
1026
1272
  # Converts property value into a text representation.
1027
- # Default implementation calls {Wx::PG::LongStringProperty#generate_composed_value}.
1273
+ #
1274
+ # <div class="wxrb-remark">
1275
+ # <b>Remark:</b>
1276
+ # <p>Default implementation calls {Wx::PG::LongStringProperty#generate_composed_value}.
1277
+ # </p>
1278
+ # </div>
1028
1279
  # @param value [Wx::Variant] Value to be converted.
1029
1280
  # @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
1281
  # @return [String]
1031
1282
  def value_to_string(value, argFlags=0) end
1032
1283
 
1033
1284
  # Converts text into {Wx::Variant} value appropriate for this property.
1285
+ #
1034
1286
  # Returns true if resulting {Wx::Variant} value was different.
1035
1287
  #
1036
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
1288
+ # <div class="wxrb-remark">
1289
+ # <b>Remark:</b>
1290
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
1291
+ # </p>
1292
+ # </div>
1037
1293
  #
1038
1294
  # 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
1295
  # @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.
@@ -1054,6 +1310,7 @@ module Wx::PG
1054
1310
  protected
1055
1311
 
1056
1312
  # Shows editor dialog.
1313
+ #
1057
1314
  # Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and true should be returned.
1058
1315
  #
1059
1316
  # Returns true if editor dialog was not cancelled and value was updated.
@@ -1065,12 +1322,14 @@ module Wx::PG
1065
1322
  end # LongStringProperty
1066
1323
 
1067
1324
  # Property that manages a value resulting from {Wx::MultiChoiceDialog}.
1325
+ #
1068
1326
  # Value is array of strings. You can get value as array of choice values/indices by calling {Wx::PG::MultiChoiceProperty#get_value_as_array_int}.
1069
1327
  # <b>Supported special attributes:</b>
1070
1328
  #
1071
1329
  # - {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
1330
  # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the editor dialog (since 3.1.3).
1073
1331
  #
1332
+ # @wxrb_require USE_PROPGRID
1074
1333
  class MultiChoiceProperty < EditorDialogProperty
1075
1334
 
1076
1335
  # @overload initialize(label, name, strings, value)
@@ -1093,23 +1352,41 @@ module Wx::PG
1093
1352
  def initialize(*args) end
1094
1353
 
1095
1354
  # This virtual function is called after m_value has been set.
1355
+ #
1356
+ # <div class="wxrb-remark">
1357
+ # <b>Remark:</b>
1358
+ # <p>
1359
+ #
1096
1360
  # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::MultiChoiceProperty#on_set_value} will not be called.
1097
1361
  # - 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.
1362
+ # - Default implementation does nothing.
1363
+ #
1364
+ # </p>
1365
+ # </div>
1099
1366
  # @return [void]
1100
1367
  def on_set_value; end
1101
1368
 
1102
1369
  # Converts property value into a text representation.
1103
- # Default implementation calls {Wx::PG::MultiChoiceProperty#generate_composed_value}.
1370
+ #
1371
+ # <div class="wxrb-remark">
1372
+ # <b>Remark:</b>
1373
+ # <p>Default implementation calls {Wx::PG::MultiChoiceProperty#generate_composed_value}.
1374
+ # </p>
1375
+ # </div>
1104
1376
  # @param value [Wx::Variant] Value to be converted.
1105
1377
  # @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
1378
  # @return [String]
1107
1379
  def value_to_string(value, argFlags=0) end
1108
1380
 
1109
1381
  # Converts text into {Wx::Variant} value appropriate for this property.
1382
+ #
1110
1383
  # Returns true if resulting {Wx::Variant} value was different.
1111
1384
  #
1112
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
1385
+ # <div class="wxrb-remark">
1386
+ # <b>Remark:</b>
1387
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
1388
+ # </p>
1389
+ # </div>
1113
1390
  #
1114
1391
  # 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
1392
  # @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.
@@ -1166,6 +1443,7 @@ module Wx::PG
1166
1443
  protected
1167
1444
 
1168
1445
  # Shows editor dialog.
1446
+ #
1169
1447
  # Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and true should be returned.
1170
1448
  #
1171
1449
  # Returns true if editor dialog was not cancelled and value was updated.
@@ -1177,6 +1455,7 @@ module Wx::PG
1177
1455
  end # MultiChoiceProperty
1178
1456
 
1179
1457
  # This is an abstract class which serves as a base class for numeric properties, like {Wx::PG::IntProperty}, {Wx::PG::UIntProperty}, {Wx::PG::FloatProperty}.
1458
+ #
1180
1459
  # <b>Supported special attributes:</b>
1181
1460
  #
1182
1461
  # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}: Specify acceptable value range.
@@ -1184,23 +1463,34 @@ module Wx::PG
1184
1463
  # - {Wx::PG::PG_ATTR_SPINCTRL_WRAP}: Specify if value modified with SpinCtrl editor wraps at Min/Max.
1185
1464
  # - {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
1465
  #
1466
+ # @wxrb_require USE_PROPGRID
1187
1467
  class NumericProperty < PGProperty
1188
1468
 
1189
1469
  # Reimplement this member function to add special handling for attributes of this property.
1470
+ #
1190
1471
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
1191
1472
  #
1192
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
1473
+ # <div class="wxrb-remark">
1474
+ # <b>Remark:</b>
1475
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
1476
+ # </p>
1477
+ # </div>
1193
1478
  # @param name [String]
1194
1479
  # @param value [Wx::Variant]
1195
1480
  # @return [Boolean]
1196
1481
  def do_set_attribute(name, value) end
1197
1482
 
1198
1483
  # Returns what would be the new value of the property after adding SpinCtrl editor step to the current value.
1484
+ #
1199
1485
  # Current value range and wrapping (if enabled) are taken into account. This member has to be implemented in derived properties.
1200
1486
  #
1201
1487
  # Value which property would have after adding SpinCtrl editor step.
1202
1488
  #
1203
- # Current property value is not changed.
1489
+ # <div class="wxrb-remark">
1490
+ # <b>Remark:</b>
1491
+ # <p>Current property value is not changed.
1492
+ # </p>
1493
+ # </div>
1204
1494
  # @param stepScale [Integer] SpinCtrl editor step is first multiplied by this factor and next added to the current value.
1205
1495
  # @return [Wx::Variant]
1206
1496
  def add_spin_step_value(stepScale) end
@@ -1289,9 +1579,11 @@ module Wx::PG
1289
1579
  end # NumericProperty
1290
1580
 
1291
1581
  # Basic property with integer value.
1582
+ #
1292
1583
  # <b>Supported special attributes:</b>
1293
1584
  # - {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
1585
  #
1586
+ # @wxrb_require USE_PROPGRID
1295
1587
  class IntProperty < NumericProperty
1296
1588
 
1297
1589
  # @overload initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=0)
@@ -1307,16 +1599,26 @@ module Wx::PG
1307
1599
  def initialize(*args) end
1308
1600
 
1309
1601
  # Converts property value into a text representation.
1310
- # Default implementation calls {Wx::PG::IntProperty#generate_composed_value}.
1602
+ #
1603
+ # <div class="wxrb-remark">
1604
+ # <b>Remark:</b>
1605
+ # <p>Default implementation calls {Wx::PG::IntProperty#generate_composed_value}.
1606
+ # </p>
1607
+ # </div>
1311
1608
  # @param value [Wx::Variant] Value to be converted.
1312
1609
  # @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
1610
  # @return [String]
1314
1611
  def value_to_string(value, argFlags=0) end
1315
1612
 
1316
1613
  # Converts text into {Wx::Variant} value appropriate for this property.
1614
+ #
1317
1615
  # Returns true if resulting {Wx::Variant} value was different.
1318
1616
  #
1319
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
1617
+ # <div class="wxrb-remark">
1618
+ # <b>Remark:</b>
1619
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
1620
+ # </p>
1621
+ # </div>
1320
1622
  #
1321
1623
  # 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
1624
  # @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.
@@ -1326,21 +1628,37 @@ module Wx::PG
1326
1628
  def string_to_value(variant, text, argFlags=0) end
1327
1629
 
1328
1630
  # Implement this function in derived class to check the value.
1631
+ #
1329
1632
  # Return true if it is ok. Returning false prevents property change events from occurring.
1330
1633
  #
1331
- # - Default implementation always returns true.
1634
+ # <div class="wxrb-remark">
1635
+ # <b>Remark:</b>
1636
+ # <p>
1637
+ #
1638
+ # - Default implementation always returns true.
1639
+ #
1640
+ # </p>
1641
+ # </div>
1332
1642
  # @param value [Wx::Variant]
1333
1643
  # @param validationInfo [Wx::PG::PGValidationInfo]
1334
1644
  # @return [Boolean]
1335
1645
  def validate_value(value, validationInfo) end
1336
1646
 
1337
1647
  # Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
1648
+ #
1338
1649
  # Returns true if resulting {Wx::Variant} value was different.
1339
1650
  #
1651
+ # <div class="wxrb-remark">
1652
+ # <b>Remark:</b>
1653
+ # <p>
1654
+ #
1340
1655
  # - 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
1656
  # - Default implementation simply assign given int to m_value.
1342
1657
  # - 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).
1658
+ # - 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).
1659
+ #
1660
+ # </p>
1661
+ # </div>
1344
1662
  # @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
1663
  # @param number [Integer] Integer to be translated into variant.
1346
1664
  # @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 +1666,8 @@ module Wx::PG
1348
1666
  def int_to_value(variant, number, argFlags=0) end
1349
1667
 
1350
1668
  # 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 #set_property_validator will override this.
1669
+ #
1670
+ # Setting validator explicitly via \#set_property_validator will override this.
1352
1671
  # In most situations, code like this should work well:
1353
1672
  #
1354
1673
  # ```ruby
@@ -1371,16 +1690,25 @@ module Wx::PG
1371
1690
  # end
1372
1691
  # ```
1373
1692
  #
1374
- # You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
1693
+ # <div class="wxrb-remark">
1694
+ # <b>Remark:</b>
1695
+ # <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
1696
+ # </p>
1697
+ # </div>
1375
1698
  # @return [Wx::Validator]
1376
1699
  def do_get_validator; end
1377
1700
 
1378
1701
  # Returns what would be the new value of the property after adding SpinCtrl editor step to the current value.
1702
+ #
1379
1703
  # Current value range and wrapping (if enabled) are taken into account. This member has to be implemented in derived properties.
1380
1704
  #
1381
1705
  # Value which property would have after adding SpinCtrl editor step.
1382
1706
  #
1383
- # Current property value is not changed.
1707
+ # <div class="wxrb-remark">
1708
+ # <b>Remark:</b>
1709
+ # <p>Current property value is not changed.
1710
+ # </p>
1711
+ # </div>
1384
1712
  # @param stepScale [Integer] SpinCtrl editor step is first multiplied by this factor and next added to the current value.
1385
1713
  # @return [Wx::Variant]
1386
1714
  def add_spin_step_value(stepScale) end
@@ -1439,11 +1767,13 @@ module Wx::PG
1439
1767
  end # IntProperty
1440
1768
 
1441
1769
  # Basic property with double-precision floating point value.
1770
+ #
1442
1771
  # <b>Supported special attributes:</b>
1443
1772
  #
1444
1773
  # - {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
1774
  # - {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
1775
  #
1776
+ # @wxrb_require USE_PROPGRID
1447
1777
  class FloatProperty < NumericProperty
1448
1778
 
1449
1779
  # @param label [String]
@@ -1453,16 +1783,26 @@ module Wx::PG
1453
1783
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=0.0) end
1454
1784
 
1455
1785
  # Converts property value into a text representation.
1456
- # Default implementation calls {Wx::PG::FloatProperty#generate_composed_value}.
1786
+ #
1787
+ # <div class="wxrb-remark">
1788
+ # <b>Remark:</b>
1789
+ # <p>Default implementation calls {Wx::PG::FloatProperty#generate_composed_value}.
1790
+ # </p>
1791
+ # </div>
1457
1792
  # @param value [Wx::Variant] Value to be converted.
1458
1793
  # @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
1794
  # @return [String]
1460
1795
  def value_to_string(value, argFlags=0) end
1461
1796
 
1462
1797
  # Converts text into {Wx::Variant} value appropriate for this property.
1798
+ #
1463
1799
  # Returns true if resulting {Wx::Variant} value was different.
1464
1800
  #
1465
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
1801
+ # <div class="wxrb-remark">
1802
+ # <b>Remark:</b>
1803
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
1804
+ # </p>
1805
+ # </div>
1466
1806
  #
1467
1807
  # 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
1808
  # @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.
@@ -1472,25 +1812,39 @@ module Wx::PG
1472
1812
  def string_to_value(variant, text, argFlags=0) end
1473
1813
 
1474
1814
  # Reimplement this member function to add special handling for attributes of this property.
1815
+ #
1475
1816
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
1476
1817
  #
1477
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
1818
+ # <div class="wxrb-remark">
1819
+ # <b>Remark:</b>
1820
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
1821
+ # </p>
1822
+ # </div>
1478
1823
  # @param name [String]
1479
1824
  # @param value [Wx::Variant]
1480
1825
  # @return [Boolean]
1481
1826
  def do_set_attribute(name, value) end
1482
1827
 
1483
1828
  # Implement this function in derived class to check the value.
1829
+ #
1484
1830
  # Return true if it is ok. Returning false prevents property change events from occurring.
1485
1831
  #
1486
- # - Default implementation always returns true.
1832
+ # <div class="wxrb-remark">
1833
+ # <b>Remark:</b>
1834
+ # <p>
1835
+ #
1836
+ # - Default implementation always returns true.
1837
+ #
1838
+ # </p>
1839
+ # </div>
1487
1840
  # @param value [Wx::Variant]
1488
1841
  # @param validationInfo [Wx::PG::PGValidationInfo]
1489
1842
  # @return [Boolean]
1490
1843
  def validate_value(value, validationInfo) end
1491
1844
 
1492
1845
  # 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 #set_property_validator will override this.
1846
+ #
1847
+ # Setting validator explicitly via \#set_property_validator will override this.
1494
1848
  # In most situations, code like this should work well:
1495
1849
  #
1496
1850
  # ```ruby
@@ -1513,16 +1867,25 @@ module Wx::PG
1513
1867
  # end
1514
1868
  # ```
1515
1869
  #
1516
- # You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
1870
+ # <div class="wxrb-remark">
1871
+ # <b>Remark:</b>
1872
+ # <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
1873
+ # </p>
1874
+ # </div>
1517
1875
  # @return [Wx::Validator]
1518
1876
  def do_get_validator; end
1519
1877
 
1520
1878
  # Returns what would be the new value of the property after adding SpinCtrl editor step to the current value.
1879
+ #
1521
1880
  # Current value range and wrapping (if enabled) are taken into account. This member has to be implemented in derived properties.
1522
1881
  #
1523
1882
  # Value which property would have after adding SpinCtrl editor step.
1524
1883
  #
1525
- # Current property value is not changed.
1884
+ # <div class="wxrb-remark">
1885
+ # <b>Remark:</b>
1886
+ # <p>Current property value is not changed.
1887
+ # </p>
1888
+ # </div>
1526
1889
  # @param stepScale [Integer] SpinCtrl editor step is first multiplied by this factor and next added to the current value.
1527
1890
  # @return [Wx::Variant]
1528
1891
  def add_spin_step_value(stepScale) end
@@ -1593,6 +1956,7 @@ module Wx::PG
1593
1956
  end # FloatProperty
1594
1957
 
1595
1958
  # Basic property with unsigned integer value.
1959
+ #
1596
1960
  # Seamlessly supports 64-bit integer ({Wx::ULongLong}) on overflow.
1597
1961
  # <b>Supported special attributes:</b>
1598
1962
  #
@@ -1600,8 +1964,16 @@ module Wx::PG
1600
1964
  # - {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
1965
  # - {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
1966
  #
1603
- # - For example how to use seamless 64-bit integer support, see {Wx::PG::IntProperty} documentation (just use {Wx::ULongLong} instead of {Wx::LongLong}).
1967
+ # <div class="wxrb-remark">
1968
+ # <b>Remark:</b>
1969
+ # <p>
1970
+ #
1971
+ # - For example how to use seamless 64-bit integer support, see {Wx::PG::IntProperty} documentation (just use {Wx::ULongLong} instead of {Wx::LongLong}).
1972
+ #
1973
+ # </p>
1974
+ # </div>
1604
1975
  #
1976
+ # @wxrb_require USE_PROPGRID
1605
1977
  class UIntProperty < NumericProperty
1606
1978
 
1607
1979
  # @overload initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=0)
@@ -1617,16 +1989,26 @@ module Wx::PG
1617
1989
  def initialize(*args) end
1618
1990
 
1619
1991
  # Converts property value into a text representation.
1620
- # Default implementation calls {Wx::PG::UIntProperty#generate_composed_value}.
1992
+ #
1993
+ # <div class="wxrb-remark">
1994
+ # <b>Remark:</b>
1995
+ # <p>Default implementation calls {Wx::PG::UIntProperty#generate_composed_value}.
1996
+ # </p>
1997
+ # </div>
1621
1998
  # @param value [Wx::Variant] Value to be converted.
1622
1999
  # @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
2000
  # @return [String]
1624
2001
  def value_to_string(value, argFlags=0) end
1625
2002
 
1626
2003
  # Converts text into {Wx::Variant} value appropriate for this property.
2004
+ #
1627
2005
  # Returns true if resulting {Wx::Variant} value was different.
1628
2006
  #
1629
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
2007
+ # <div class="wxrb-remark">
2008
+ # <b>Remark:</b>
2009
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
2010
+ # </p>
2011
+ # </div>
1630
2012
  #
1631
2013
  # 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
2014
  # @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.
@@ -1636,25 +2018,39 @@ module Wx::PG
1636
2018
  def string_to_value(variant, text, argFlags=0) end
1637
2019
 
1638
2020
  # Reimplement this member function to add special handling for attributes of this property.
2021
+ #
1639
2022
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
1640
2023
  #
1641
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
2024
+ # <div class="wxrb-remark">
2025
+ # <b>Remark:</b>
2026
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
2027
+ # </p>
2028
+ # </div>
1642
2029
  # @param name [String]
1643
2030
  # @param value [Wx::Variant]
1644
2031
  # @return [Boolean]
1645
2032
  def do_set_attribute(name, value) end
1646
2033
 
1647
2034
  # Implement this function in derived class to check the value.
2035
+ #
1648
2036
  # Return true if it is ok. Returning false prevents property change events from occurring.
1649
2037
  #
1650
- # - Default implementation always returns true.
2038
+ # <div class="wxrb-remark">
2039
+ # <b>Remark:</b>
2040
+ # <p>
2041
+ #
2042
+ # - Default implementation always returns true.
2043
+ #
2044
+ # </p>
2045
+ # </div>
1651
2046
  # @param value [Wx::Variant]
1652
2047
  # @param validationInfo [Wx::PG::PGValidationInfo]
1653
2048
  # @return [Boolean]
1654
2049
  def validate_value(value, validationInfo) end
1655
2050
 
1656
2051
  # 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 #set_property_validator will override this.
2052
+ #
2053
+ # Setting validator explicitly via \#set_property_validator will override this.
1658
2054
  # In most situations, code like this should work well:
1659
2055
  #
1660
2056
  # ```ruby
@@ -1677,17 +2073,29 @@ module Wx::PG
1677
2073
  # end
1678
2074
  # ```
1679
2075
  #
1680
- # You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
2076
+ # <div class="wxrb-remark">
2077
+ # <b>Remark:</b>
2078
+ # <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
2079
+ # </p>
2080
+ # </div>
1681
2081
  # @return [Wx::Validator]
1682
2082
  def do_get_validator; end
1683
2083
 
1684
2084
  # Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
2085
+ #
1685
2086
  # Returns true if resulting {Wx::Variant} value was different.
1686
2087
  #
2088
+ # <div class="wxrb-remark">
2089
+ # <b>Remark:</b>
2090
+ # <p>
2091
+ #
1687
2092
  # - 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
2093
  # - Default implementation simply assign given int to m_value.
1689
2094
  # - 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).
2095
+ # - 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).
2096
+ #
2097
+ # </p>
2098
+ # </div>
1691
2099
  # @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
2100
  # @param number [Integer] Integer to be translated into variant.
1693
2101
  # @param argFlags [Integer] If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
@@ -1695,11 +2103,16 @@ module Wx::PG
1695
2103
  def int_to_value(variant, number, argFlags=0) end
1696
2104
 
1697
2105
  # Returns what would be the new value of the property after adding SpinCtrl editor step to the current value.
2106
+ #
1698
2107
  # Current value range and wrapping (if enabled) are taken into account. This member has to be implemented in derived properties.
1699
2108
  #
1700
2109
  # Value which property would have after adding SpinCtrl editor step.
1701
2110
  #
1702
- # Current property value is not changed.
2111
+ # <div class="wxrb-remark">
2112
+ # <b>Remark:</b>
2113
+ # <p>Current property value is not changed.
2114
+ # </p>
2115
+ # </div>
1703
2116
  # @param stepScale [Integer] SpinCtrl editor step is first multiplied by this factor and next added to the current value.
1704
2117
  # @return [Wx::Variant]
1705
2118
  def add_spin_step_value(stepScale) end
@@ -1791,10 +2204,19 @@ module Wx::PG
1791
2204
  end # UIntProperty
1792
2205
 
1793
2206
  # You can derive custom properties with choices from this class.
2207
+ #
1794
2208
  # See {Wx::BaseEnumProperty} for remarks.
1795
2209
  #
1796
- # - 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.
2210
+ # <div class="wxrb-remark">
2211
+ # <b>Remark:</b>
2212
+ # <p>
2213
+ #
2214
+ # - 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.
2215
+ #
2216
+ # </p>
2217
+ # </div>
1797
2218
  #
2219
+ # @wxrb_require USE_PROPGRID
1798
2220
  class EnumProperty < PGProperty
1799
2221
 
1800
2222
  # @overload initialize(label, name, choices, value=0)
@@ -1817,23 +2239,41 @@ module Wx::PG
1817
2239
  alias_method :item_count, :get_item_count
1818
2240
 
1819
2241
  # This virtual function is called after m_value has been set.
2242
+ #
2243
+ # <div class="wxrb-remark">
2244
+ # <b>Remark:</b>
2245
+ # <p>
2246
+ #
1820
2247
  # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::EnumProperty#on_set_value} will not be called.
1821
2248
  # - 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.
2249
+ # - Default implementation does nothing.
2250
+ #
2251
+ # </p>
2252
+ # </div>
1823
2253
  # @return [void]
1824
2254
  def on_set_value; end
1825
2255
 
1826
2256
  # Converts property value into a text representation.
1827
- # Default implementation calls {Wx::PG::EnumProperty#generate_composed_value}.
2257
+ #
2258
+ # <div class="wxrb-remark">
2259
+ # <b>Remark:</b>
2260
+ # <p>Default implementation calls {Wx::PG::EnumProperty#generate_composed_value}.
2261
+ # </p>
2262
+ # </div>
1828
2263
  # @param value [Wx::Variant] Value to be converted.
1829
2264
  # @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
2265
  # @return [String]
1831
2266
  def value_to_string(value, argFlags=0) end
1832
2267
 
1833
2268
  # Converts text into {Wx::Variant} value appropriate for this property.
2269
+ #
1834
2270
  # Returns true if resulting {Wx::Variant} value was different.
1835
2271
  #
1836
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
2272
+ # <div class="wxrb-remark">
2273
+ # <b>Remark:</b>
2274
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
2275
+ # </p>
2276
+ # </div>
1837
2277
  #
1838
2278
  # 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
2279
  # @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.
@@ -1843,21 +2283,37 @@ module Wx::PG
1843
2283
  def string_to_value(variant, text, argFlags=0) end
1844
2284
 
1845
2285
  # Implement this function in derived class to check the value.
2286
+ #
1846
2287
  # Return true if it is ok. Returning false prevents property change events from occurring.
1847
2288
  #
1848
- # - Default implementation always returns true.
2289
+ # <div class="wxrb-remark">
2290
+ # <b>Remark:</b>
2291
+ # <p>
2292
+ #
2293
+ # - Default implementation always returns true.
2294
+ #
2295
+ # </p>
2296
+ # </div>
1849
2297
  # @param value [Wx::Variant]
1850
2298
  # @param validationInfo [Wx::PG::PGValidationInfo]
1851
2299
  # @return [Boolean]
1852
2300
  def validate_value(value, validationInfo) end
1853
2301
 
1854
2302
  # Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
2303
+ #
1855
2304
  # Returns true if resulting {Wx::Variant} value was different.
1856
2305
  #
2306
+ # <div class="wxrb-remark">
2307
+ # <b>Remark:</b>
2308
+ # <p>
2309
+ #
1857
2310
  # - 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
2311
  # - Default implementation simply assign given int to m_value.
1859
2312
  # - 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).
2313
+ # - 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).
2314
+ #
2315
+ # </p>
2316
+ # </div>
1861
2317
  # @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
2318
  # @param number [Integer] Integer to be translated into variant.
1863
2319
  # @param argFlags [Integer] If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
@@ -1870,6 +2326,7 @@ module Wx::PG
1870
2326
  alias_method :index_for_value, :get_index_for_value
1871
2327
 
1872
2328
  # Returns which choice is currently selected.
2329
+ #
1873
2330
  # Only applies to properties which have choices.
1874
2331
  # Needs to reimplemented in derived class if property value does not map directly to a choice. Integer as index, bool, and string usually do.
1875
2332
  # @return [Integer]
@@ -1910,6 +2367,8 @@ module Wx::PG
1910
2367
  # Property representing {Wx::Cursor}.
1911
2368
  #
1912
2369
  #
2370
+ #
2371
+ # @wxrb_require USE_PROPGRID
1913
2372
  class CursorProperty < EnumProperty
1914
2373
 
1915
2374
  # @param label [String]
@@ -1919,23 +2378,39 @@ module Wx::PG
1919
2378
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=0) end
1920
2379
 
1921
2380
  # Returns size of the custom painted image in front of property.
2381
+ #
1922
2382
  # This method must be overridden to return non-default value if OnCustomPaint is to be called.
1923
2383
  #
2384
+ # <div class="wxrb-remark">
2385
+ # <b>Remark:</b>
2386
+ # <p>
2387
+ #
1924
2388
  # - Default behaviour is to return {size(0,0)}, which means no image.
1925
2389
  # - 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}.
2390
+ # - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
2391
+ #
2392
+ # </p>
2393
+ # </div>
1927
2394
  # @param item [Integer] Normally -1, but can be an index to the property's list of items.
1928
2395
  # @return [Wx::Size]
1929
2396
  def on_measure_image(item) end
1930
2397
 
1931
2398
  # Override to paint an image in front of the property value text or drop-down list item (but only if {Wx::PG::PGProperty#on_measure_image} is overridden as well).
2399
+ #
1932
2400
  # 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
2401
  # 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
2402
  #
2403
+ # <div class="wxrb-remark">
2404
+ # <b>Remark:</b>
2405
+ # <p>
2406
+ #
1935
2407
  # - 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
2408
  # - Due to technical reasons, rect's height will be default even if custom height was reported during measure call.
1937
2409
  # - 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
2410
  # - 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.
2411
+ #
2412
+ # </p>
2413
+ # </div>
1939
2414
  # @see Wx::PG::CursorProperty#value_to_string
1940
2415
  # @param dc [Wx::DC] {Wx::DC} to paint on.
1941
2416
  # @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 +2429,14 @@ module Wx::PG
1954
2429
  end # CursorProperty
1955
2430
 
1956
2431
  # {Wx::PG::EnumProperty} with {Wx::String} value and writable combo box editor.
1957
- # Uses int value, similar to {Wx::PG::EnumProperty}, unless text entered by user is not in choices (in which case string value is used).
1958
2432
  #
2433
+ # <div class="wxrb-remark">
2434
+ # <b>Remark:</b>
2435
+ # <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).
2436
+ # </p>
2437
+ # </div>
2438
+ #
2439
+ # @wxrb_require USE_PROPGRID
1959
2440
  class EditEnumProperty < EnumProperty
1960
2441
 
1961
2442
  # @overload initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, labels=(Wx::ArrayString.new()), values=(Wx::ArrayInt.new()), value=(''))
@@ -1984,9 +2465,11 @@ module Wx::PG
1984
2465
  end # EditEnumProperty
1985
2466
 
1986
2467
  # Has dropdown list of wxWidgets system colours.
2468
+ #
1987
2469
  # Value used is of {Wx::PG::ColourPropertyValue} type.
1988
2470
  # <b>Supported special attributes:</b> {Wx::PG::PG_COLOUR_ALLOW_CUSTOM}, {Wx::PG::PG_COLOUR_HAS_ALPHA}
1989
2471
  #
2472
+ # @wxrb_require USE_PROPGRID
1990
2473
  class SystemColourProperty < EnumProperty
1991
2474
 
1992
2475
  # @param label [String]
@@ -1996,19 +2479,35 @@ module Wx::PG
1996
2479
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=(Wx::ColourPropertyValue.new())) end
1997
2480
 
1998
2481
  # This virtual function is called after m_value has been set.
2482
+ #
2483
+ # <div class="wxrb-remark">
2484
+ # <b>Remark:</b>
2485
+ # <p>
2486
+ #
1999
2487
  # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::SystemColourProperty#on_set_value} will not be called.
2000
2488
  # - 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.
2489
+ # - Default implementation does nothing.
2490
+ #
2491
+ # </p>
2492
+ # </div>
2002
2493
  # @return [void]
2003
2494
  def on_set_value; end
2004
2495
 
2005
2496
  # Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
2497
+ #
2006
2498
  # Returns true if resulting {Wx::Variant} value was different.
2007
2499
  #
2500
+ # <div class="wxrb-remark">
2501
+ # <b>Remark:</b>
2502
+ # <p>
2503
+ #
2008
2504
  # - 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
2505
  # - Default implementation simply assign given int to m_value.
2010
2506
  # - 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).
2507
+ # - 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).
2508
+ #
2509
+ # </p>
2510
+ # </div>
2012
2511
  # @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
2512
  # @param number [Integer] Integer to be translated into variant.
2014
2513
  # @param argFlags [Integer] If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
@@ -2028,16 +2527,26 @@ module Wx::PG
2028
2527
  alias_method :custom_colour_index, :get_custom_colour_index
2029
2528
 
2030
2529
  # Converts property value into a text representation.
2031
- # Default implementation calls {Wx::PG::SystemColourProperty#generate_composed_value}.
2530
+ #
2531
+ # <div class="wxrb-remark">
2532
+ # <b>Remark:</b>
2533
+ # <p>Default implementation calls {Wx::PG::SystemColourProperty#generate_composed_value}.
2534
+ # </p>
2535
+ # </div>
2032
2536
  # @param value [Wx::Variant] Value to be converted.
2033
2537
  # @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
2538
  # @return [String]
2035
2539
  def value_to_string(value, argFlags=0) end
2036
2540
 
2037
2541
  # Converts text into {Wx::Variant} value appropriate for this property.
2542
+ #
2038
2543
  # Returns true if resulting {Wx::Variant} value was different.
2039
2544
  #
2040
- # Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
2545
+ # <div class="wxrb-remark">
2546
+ # <b>Remark:</b>
2547
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
2548
+ # </p>
2549
+ # </div>
2041
2550
  #
2042
2551
  # 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
2552
  # @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.
@@ -2047,6 +2556,7 @@ module Wx::PG
2047
2556
  def string_to_value(variant, text, argFlags=0) end
2048
2557
 
2049
2558
  # Events received by editor widgets are processed here.
2559
+ #
2050
2560
  # Note that editor class usually processes most events. Some, such as button press events of TextCtrlAndButton class, can be handled here. Also, if custom handling for regular events is desired, then that can also be done (for example, {Wx::PG::SystemColourProperty} custom handles {Wx::EVT_CHOICE} to display colour picker dialog when 'custom' selection is made).
2051
2561
  # If the event causes value to be changed, {Wx::PG::SystemColourProperty#set_value_in_event} should be called to set the new value.
2052
2562
  # The parameter event is the associated {Wx::Event}.
@@ -2055,7 +2565,14 @@ module Wx::PG
2055
2565
  #
2056
2566
  # return true if any changes in value should be reported.
2057
2567
  #
2058
- # - 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.
2568
+ # <div class="wxrb-remark">
2569
+ # <b>Remark:</b>
2570
+ # <p>
2571
+ #
2572
+ # - 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.
2573
+ #
2574
+ # </p>
2575
+ # </div>
2059
2576
  # @param propgrid [Wx::PG::PropertyGrid]
2060
2577
  # @param wnd_primary [Wx::Window]
2061
2578
  # @param event [Wx::Event]
@@ -2063,32 +2580,53 @@ module Wx::PG
2063
2580
  def on_event(propgrid, wnd_primary, event) end
2064
2581
 
2065
2582
  # Reimplement this member function to add special handling for attributes of this property.
2583
+ #
2066
2584
  # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
2067
2585
  #
2068
- # To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
2586
+ # <div class="wxrb-remark">
2587
+ # <b>Remark:</b>
2588
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
2589
+ # </p>
2590
+ # </div>
2069
2591
  # @param name [String]
2070
2592
  # @param value [Wx::Variant]
2071
2593
  # @return [Boolean]
2072
2594
  def do_set_attribute(name, value) end
2073
2595
 
2074
2596
  # Returns size of the custom painted image in front of property.
2597
+ #
2075
2598
  # This method must be overridden to return non-default value if OnCustomPaint is to be called.
2076
2599
  #
2600
+ # <div class="wxrb-remark">
2601
+ # <b>Remark:</b>
2602
+ # <p>
2603
+ #
2077
2604
  # - Default behaviour is to return {size(0,0)}, which means no image.
2078
2605
  # - 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}.
2606
+ # - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
2607
+ #
2608
+ # </p>
2609
+ # </div>
2080
2610
  # @param item [Integer] Normally -1, but can be an index to the property's list of items.
2081
2611
  # @return [Wx::Size]
2082
2612
  def on_measure_image(item) end
2083
2613
 
2084
2614
  # Override to paint an image in front of the property value text or drop-down list item (but only if {Wx::PG::PGProperty#on_measure_image} is overridden as well).
2615
+ #
2085
2616
  # 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
2617
  # 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
2618
  #
2619
+ # <div class="wxrb-remark">
2620
+ # <b>Remark:</b>
2621
+ # <p>
2622
+ #
2088
2623
  # - 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
2624
  # - Due to technical reasons, rect's height will be default even if custom height was reported during measure call.
2090
2625
  # - 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
2626
  # - 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.
2627
+ #
2628
+ # </p>
2629
+ # </div>
2092
2630
  # @see Wx::PG::SystemColourProperty#value_to_string
2093
2631
  # @param dc [Wx::DC] {Wx::DC} to paint on.
2094
2632
  # @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).
@@ -2101,6 +2639,7 @@ module Wx::PG
2101
2639
  def query_colour_from_user(variant) end
2102
2640
 
2103
2641
  # Default is to use {Wx::SystemSettings.get_colour(index)}.
2642
+ #
2104
2643
  # Override to use custom colour tables etc.
2105
2644
  # @param index [Integer]
2106
2645
  # @return [Wx::Colour]
@@ -2139,9 +2678,11 @@ module Wx::PG
2139
2678
  end # SystemColourProperty
2140
2679
 
2141
2680
  # Allows to select a colour from the list or with colour dialog.
2681
+ #
2142
2682
  # Value used is of {Wx::PG::ColourPropertyValue} type.
2143
2683
  # <b>Supported special attributes:</b> {Wx::PG::PG_COLOUR_ALLOW_CUSTOM}, {Wx::PG::PG_COLOUR_HAS_ALPHA}
2144
2684
  #
2685
+ # @wxrb_require USE_PROPGRID
2145
2686
  class ColourProperty < SystemColourProperty
2146
2687
 
2147
2688
  # @param label [String]
@@ -2151,13 +2692,19 @@ module Wx::PG
2151
2692
  def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=Wx::WHITE) end
2152
2693
 
2153
2694
  # Converts property value into a text representation.
2154
- # Default implementation calls {Wx::PG::ColourProperty#generate_composed_value}.
2695
+ #
2696
+ # <div class="wxrb-remark">
2697
+ # <b>Remark:</b>
2698
+ # <p>Default implementation calls {Wx::PG::ColourProperty#generate_composed_value}.
2699
+ # </p>
2700
+ # </div>
2155
2701
  # @param value [Wx::Variant] Value to be converted.
2156
2702
  # @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
2703
  # @return [String]
2158
2704
  def value_to_string(value, argFlags=0) end
2159
2705
 
2160
2706
  # Default is to use {Wx::SystemSettings.get_colour(index)}.
2707
+ #
2161
2708
  # Override to use custom colour tables etc.
2162
2709
  # @param index [Integer]
2163
2710
  # @return [Wx::Colour]
@@ -2182,10 +2729,12 @@ module Wx::PG
2182
2729
  end # ColourProperty
2183
2730
 
2184
2731
  # 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.
2732
+ #
2185
2733
  # {Wx::PG::SystemColourProperty} value makes this possible.
2186
2734
  #
2187
2735
  #
2188
2736
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2737
+ # @wxrb_require USE_PROPGRID
2189
2738
  class ColourPropertyValue < Object
2190
2739
 
2191
2740
  # An integer value relating to the colour, and which exact meaning depends on the property with which it is used.