wxruby3 0.9.4-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (390) hide show
  1. checksums.yaml +4 -4
  2. data/.wxconfig +9 -8
  3. data/INSTALL.md +315 -78
  4. data/README.md +32 -21
  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/core/combo_ctrl.rb +171 -0
  21. data/lib/wx/core/ext.rb +22 -3
  22. data/lib/wx/doc/comboctrl.rb +128 -3
  23. data/lib/wx/doc/gen/about_dialog_info.rb +1 -1
  24. data/lib/wx/doc/gen/accelerator.rb +1 -1
  25. data/lib/wx/doc/gen/accessible.rb +1 -1
  26. data/lib/wx/doc/gen/activity_indicator.rb +1 -1
  27. data/lib/wx/doc/gen/animation.rb +1 -1
  28. data/lib/wx/doc/gen/animation_ctrl.rb +1 -1
  29. data/lib/wx/doc/gen/any_button.rb +1 -1
  30. data/lib/wx/doc/gen/app.rb +1 -1
  31. data/lib/wx/doc/gen/app_traits.rb +3 -55
  32. data/lib/wx/doc/gen/art_provider.rb +1 -3
  33. data/lib/wx/doc/gen/aui/aui_dock_art.rb +430 -426
  34. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +34 -30
  35. data/lib/wx/doc/gen/aui/aui_manager.rb +352 -349
  36. data/lib/wx/doc/gen/aui/aui_manager_event.rb +107 -103
  37. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +157 -153
  38. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +42 -37
  39. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +109 -105
  40. data/lib/wx/doc/gen/aui/aui_notebook.rb +438 -434
  41. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +145 -141
  42. data/lib/wx/doc/gen/aui/aui_pane_info.rb +689 -685
  43. data/lib/wx/doc/gen/aui/aui_tab_art.rb +369 -365
  44. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +100 -96
  45. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +445 -441
  46. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +268 -264
  47. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +179 -175
  48. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +219 -215
  49. data/lib/wx/doc/gen/banner_window.rb +1 -1
  50. data/lib/wx/doc/gen/bitmap.rb +1 -1
  51. data/lib/wx/doc/gen/bitmap_button.rb +1 -1
  52. data/lib/wx/doc/gen/bitmap_combo_box.rb +1 -1
  53. data/lib/wx/doc/gen/book_ctrl_base.rb +1 -1
  54. data/lib/wx/doc/gen/book_ctrl_event.rb +1 -1
  55. data/lib/wx/doc/gen/box_sizer.rb +1 -1
  56. data/lib/wx/doc/gen/brush.rb +1 -1
  57. data/lib/wx/doc/gen/busy_info.rb +1 -1
  58. data/lib/wx/doc/gen/button.rb +1 -1
  59. data/lib/wx/doc/gen/calculate_layout_event.rb +1 -1
  60. data/lib/wx/doc/gen/calendar_ctrl.rb +1 -1
  61. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -1
  62. data/lib/wx/doc/gen/calendar_event.rb +1 -1
  63. data/lib/wx/doc/gen/caret.rb +1 -1
  64. data/lib/wx/doc/gen/check_box.rb +1 -1
  65. data/lib/wx/doc/gen/check_list_box.rb +1 -1
  66. data/lib/wx/doc/gen/choice.rb +1 -1
  67. data/lib/wx/doc/gen/choicebook.rb +1 -1
  68. data/lib/wx/doc/gen/client_dc.rb +1 -1
  69. data/lib/wx/doc/gen/clipboard.rb +1 -1
  70. data/lib/wx/doc/gen/collapsible_pane.rb +1 -1
  71. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -1
  72. data/lib/wx/doc/gen/colour.rb +1 -2
  73. data/lib/wx/doc/gen/colour_dialog.rb +2 -2
  74. data/lib/wx/doc/gen/colour_picker_ctrl.rb +1 -1
  75. data/lib/wx/doc/gen/colour_picker_event.rb +1 -1
  76. data/lib/wx/doc/gen/combo_box.rb +4 -3
  77. data/lib/wx/doc/gen/combo_ctrl.rb +92 -228
  78. data/lib/wx/doc/gen/command_link_button.rb +1 -1
  79. data/lib/wx/doc/gen/config_base.rb +1 -1
  80. data/lib/wx/doc/gen/context_help_button.rb +1 -1
  81. data/lib/wx/doc/gen/control.rb +1 -1
  82. data/lib/wx/doc/gen/control_with_items.rb +1 -1
  83. data/lib/wx/doc/gen/core.rb +5 -5
  84. data/lib/wx/doc/gen/cursor.rb +1 -1
  85. data/lib/wx/doc/gen/data_format.rb +1 -1
  86. data/lib/wx/doc/gen/data_object.rb +1 -1
  87. data/lib/wx/doc/gen/data_object_simple_base.rb +1 -1
  88. data/lib/wx/doc/gen/date_event.rb +1 -1
  89. data/lib/wx/doc/gen/date_picker_ctrl.rb +1 -1
  90. data/lib/wx/doc/gen/dc.rb +1 -4
  91. data/lib/wx/doc/gen/defs.rb +1 -1
  92. data/lib/wx/doc/gen/dial_up_event.rb +1 -1
  93. data/lib/wx/doc/gen/dial_up_manager.rb +1 -1
  94. data/lib/wx/doc/gen/dialog.rb +1 -2
  95. data/lib/wx/doc/gen/dir_dialog.rb +1 -1
  96. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -1
  97. data/lib/wx/doc/gen/dir_picker_ctrl.rb +1 -1
  98. data/lib/wx/doc/gen/drag_drop.rb +1 -1
  99. data/lib/wx/doc/gen/drag_image.rb +1 -1
  100. data/lib/wx/doc/gen/editable_list_box.rb +1 -1
  101. data/lib/wx/doc/gen/event.rb +1 -1
  102. data/lib/wx/doc/gen/event_blocker.rb +1 -1
  103. data/lib/wx/doc/gen/event_filter.rb +1 -1
  104. data/lib/wx/doc/gen/events.rb +3 -25
  105. data/lib/wx/doc/gen/evt_handler.rb +1 -1
  106. data/lib/wx/doc/gen/ext_help_controller.rb +1 -1
  107. data/lib/wx/doc/gen/file_ctrl.rb +1 -1
  108. data/lib/wx/doc/gen/file_ctrl_event.rb +1 -1
  109. data/lib/wx/doc/gen/file_dialog.rb +1 -3
  110. data/lib/wx/doc/gen/file_dialog_custom_control.rb +1 -1
  111. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +54 -62
  112. data/lib/wx/doc/gen/file_dir_picker_event.rb +1 -1
  113. data/lib/wx/doc/gen/file_picker_ctrl.rb +1 -1
  114. data/lib/wx/doc/gen/file_system.rb +2 -59
  115. data/lib/wx/doc/gen/find_dialog_event.rb +1 -1
  116. data/lib/wx/doc/gen/find_replace_data.rb +1 -1
  117. data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
  118. data/lib/wx/doc/gen/flex_grid_sizer.rb +1 -1
  119. data/lib/wx/doc/gen/font.rb +1 -1
  120. data/lib/wx/doc/gen/font_data.rb +1 -1
  121. data/lib/wx/doc/gen/font_dialog.rb +1 -1
  122. data/lib/wx/doc/gen/font_picker_ctrl.rb +1 -1
  123. data/lib/wx/doc/gen/font_picker_event.rb +1 -1
  124. data/lib/wx/doc/gen/frame.rb +1 -2
  125. data/lib/wx/doc/gen/fs_file.rb +1 -1
  126. data/lib/wx/doc/gen/functions.rb +1 -1
  127. data/lib/wx/doc/gen/gauge.rb +1 -1
  128. data/lib/wx/doc/gen/gb_sizer_item.rb +1 -1
  129. data/lib/wx/doc/gen/gcdc.rb +1 -1
  130. data/lib/wx/doc/gen/gdi_common.rb +3 -3
  131. data/lib/wx/doc/gen/gdi_object.rb +1 -1
  132. data/lib/wx/doc/gen/generic_dir_ctrl.rb +1 -1
  133. data/lib/wx/doc/gen/graphics_context.rb +1 -1
  134. data/lib/wx/doc/gen/graphics_object.rb +1 -1
  135. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +28 -24
  136. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +251 -247
  137. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +25 -21
  138. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +27 -23
  139. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +38 -34
  140. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +25 -21
  141. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +35 -31
  142. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +28 -24
  143. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +34 -30
  144. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +30 -26
  145. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +183 -179
  146. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +29 -25
  147. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +33 -29
  148. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +34 -30
  149. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +67 -63
  150. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +34 -30
  151. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +25 -21
  152. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +93 -89
  153. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +25 -21
  154. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +38 -34
  155. data/lib/wx/doc/gen/grid/grid_ctrl.rb +2716 -2724
  156. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +82 -78
  157. data/lib/wx/doc/gen/grid/grid_event.rb +106 -102
  158. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +93 -89
  159. data/lib/wx/doc/gen/grid/grid_size_event.rb +70 -66
  160. data/lib/wx/doc/gen/grid/grid_string_table.rb +130 -126
  161. data/lib/wx/doc/gen/grid/grid_table_base.rb +303 -299
  162. data/lib/wx/doc/gen/grid/grid_table_message.rb +70 -66
  163. data/lib/wx/doc/gen/grid_bag_sizer.rb +1 -1
  164. data/lib/wx/doc/gen/grid_sizer.rb +1 -1
  165. data/lib/wx/doc/gen/gui_event_loop.rb +1 -1
  166. data/lib/wx/doc/gen/header_ctrl.rb +1 -2
  167. data/lib/wx/doc/gen/header_ctrl_event.rb +1 -1
  168. data/lib/wx/doc/gen/help_controller.rb +1 -1
  169. data/lib/wx/doc/gen/help_provider.rb +1 -1
  170. data/lib/wx/doc/gen/html/html_cell.rb +515 -511
  171. data/lib/wx/doc/gen/html/html_cell_event.rb +58 -54
  172. data/lib/wx/doc/gen/html/html_easy_printing.rb +171 -167
  173. data/lib/wx/doc/gen/html/html_help_controller.rb +292 -288
  174. data/lib/wx/doc/gen/html/html_help_data.rb +147 -143
  175. data/lib/wx/doc/gen/html/html_help_window.rb +232 -228
  176. data/lib/wx/doc/gen/html/html_link_event.rb +30 -26
  177. data/lib/wx/doc/gen/html/html_list_box.rb +301 -297
  178. data/lib/wx/doc/gen/html/html_printout.rb +94 -90
  179. data/lib/wx/doc/gen/html/html_window.rb +406 -402
  180. data/lib/wx/doc/gen/hyperlink_ctrl.rb +1 -1
  181. data/lib/wx/doc/gen/hyperlink_event.rb +1 -1
  182. data/lib/wx/doc/gen/icon.rb +1 -1
  183. data/lib/wx/doc/gen/icon_location.rb +1 -1
  184. data/lib/wx/doc/gen/image.rb +1 -3
  185. data/lib/wx/doc/gen/image_list.rb +1 -1
  186. data/lib/wx/doc/gen/info_bar.rb +1 -1
  187. data/lib/wx/doc/gen/keyboard_state.rb +1 -1
  188. data/lib/wx/doc/gen/list_box.rb +1 -1
  189. data/lib/wx/doc/gen/list_ctrl.rb +1 -2
  190. data/lib/wx/doc/gen/list_event.rb +1 -1
  191. data/lib/wx/doc/gen/listbook.rb +1 -1
  192. data/lib/wx/doc/gen/locale.rb +1 -1
  193. data/lib/wx/doc/gen/log.rb +1 -1
  194. data/lib/wx/doc/gen/mdi_client_window.rb +1 -1
  195. data/lib/wx/doc/gen/mdi_frame.rb +1 -1
  196. data/lib/wx/doc/gen/media_ctrl.rb +1 -7
  197. data/lib/wx/doc/gen/media_event.rb +1 -1
  198. data/lib/wx/doc/gen/memory_dc.rb +1 -1
  199. data/lib/wx/doc/gen/menu.rb +1 -3
  200. data/lib/wx/doc/gen/menu_bar.rb +1 -1
  201. data/lib/wx/doc/gen/menu_item.rb +1 -1
  202. data/lib/wx/doc/gen/message_dialog.rb +1 -1
  203. data/lib/wx/doc/gen/mini_frame.rb +1 -1
  204. data/lib/wx/doc/gen/mirror_dc.rb +1 -1
  205. data/lib/wx/doc/gen/mouse_state.rb +1 -1
  206. data/lib/wx/doc/gen/multi_choice_dialog.rb +1 -1
  207. data/lib/wx/doc/gen/non_owned_window.rb +1 -1
  208. data/lib/wx/doc/gen/notebook.rb +1 -2
  209. data/lib/wx/doc/gen/num_validator.rb +1 -1
  210. data/lib/wx/doc/gen/number_entry_dialog.rb +1 -1
  211. data/lib/wx/doc/gen/object.rb +1 -1
  212. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +1 -1
  213. data/lib/wx/doc/gen/paint_dc.rb +1 -1
  214. data/lib/wx/doc/gen/palette.rb +1 -1
  215. data/lib/wx/doc/gen/panel.rb +1 -1
  216. data/lib/wx/doc/gen/pen.rb +1 -1
  217. data/lib/wx/doc/gen/persistence_manager.rb +1 -1
  218. data/lib/wx/doc/gen/persistent_object.rb +1 -1
  219. data/lib/wx/doc/gen/persistent_window.rb +1 -1
  220. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +33 -29
  221. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +299 -295
  222. data/lib/wx/doc/gen/pg/pg_cell.rb +162 -158
  223. data/lib/wx/doc/gen/pg/pg_editor.rb +693 -689
  224. data/lib/wx/doc/gen/pg/pg_multi_button.rb +133 -129
  225. data/lib/wx/doc/gen/pg/pg_properties.rb +2662 -2658
  226. data/lib/wx/doc/gen/pg/pg_property.rb +1929 -1938
  227. data/lib/wx/doc/gen/pg/pg_validation_info.rb +275 -273
  228. data/lib/wx/doc/gen/pg/property_grid.rb +708 -706
  229. data/lib/wx/doc/gen/pg/property_grid_event.rb +168 -164
  230. data/lib/wx/doc/gen/pg/property_grid_interface.rb +1071 -1067
  231. data/lib/wx/doc/gen/pg/property_grid_manager.rb +386 -384
  232. data/lib/wx/doc/gen/pg/property_grid_page.rb +267 -265
  233. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +147 -144
  234. data/lib/wx/doc/gen/picker_base.rb +1 -1
  235. data/lib/wx/doc/gen/platform_info.rb +1 -1
  236. data/lib/wx/doc/gen/popup_window.rb +1 -1
  237. data/lib/wx/doc/gen/progress_dialog.rb +1 -1
  238. data/lib/wx/doc/gen/property_sheet_dialog.rb +1 -1
  239. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +32 -28
  240. data/lib/wx/doc/gen/prt/post_script_dc.rb +21 -18
  241. data/lib/wx/doc/gen/prt/preview_frame.rb +49 -45
  242. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +126 -122
  243. data/lib/wx/doc/gen/prt/print_data.rb +637 -633
  244. data/lib/wx/doc/gen/prt/print_dialog.rb +43 -39
  245. data/lib/wx/doc/gen/prt/printer.rb +484 -480
  246. data/lib/wx/doc/gen/prt/printer_dc.rb +26 -22
  247. data/lib/wx/doc/gen/query_layout_info_event.rb +1 -1
  248. data/lib/wx/doc/gen/radio_box.rb +1 -1
  249. data/lib/wx/doc/gen/radio_button.rb +1 -1
  250. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +1716 -1712
  251. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +239 -235
  252. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +34 -30
  253. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +439 -435
  254. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +52 -48
  255. data/lib/wx/doc/gen/rbn/ribbon_control.rb +116 -112
  256. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +205 -201
  257. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +44 -40
  258. data/lib/wx/doc/gen/rbn/ribbon_page.rb +129 -125
  259. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +229 -225
  260. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +34 -30
  261. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +329 -325
  262. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +31 -27
  263. data/lib/wx/doc/gen/rearrange_ctrl.rb +1 -1
  264. data/lib/wx/doc/gen/rearrange_list.rb +1 -1
  265. data/lib/wx/doc/gen/region.rb +1 -1
  266. data/lib/wx/doc/gen/region_iterator.rb +1 -1
  267. data/lib/wx/doc/gen/rtc/rich_text_box.rb +424 -420
  268. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +1148 -1144
  269. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +30 -26
  270. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +516 -512
  271. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +1991 -1987
  272. data/lib/wx/doc/gen/rtc/rich_text_event.rb +159 -155
  273. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +167 -163
  274. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +271 -267
  275. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +171 -167
  276. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +88 -85
  277. data/lib/wx/doc/gen/rtc/rich_text_image.rb +323 -319
  278. data/lib/wx/doc/gen/rtc/rich_text_object.rb +2819 -2815
  279. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1187 -1183
  280. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +242 -238
  281. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +286 -279
  282. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +181 -177
  283. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +47 -44
  284. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +145 -141
  285. data/lib/wx/doc/gen/sash_event.rb +1 -1
  286. data/lib/wx/doc/gen/sash_layout_window.rb +1 -1
  287. data/lib/wx/doc/gen/sash_window.rb +1 -1
  288. data/lib/wx/doc/gen/scaled_dc.rb +1 -1
  289. data/lib/wx/doc/gen/screen_dc.rb +1 -1
  290. data/lib/wx/doc/gen/scroll_bar.rb +1 -2
  291. data/lib/wx/doc/gen/scrolled_canvas.rb +1 -1
  292. data/lib/wx/doc/gen/scrolled_control.rb +1 -1
  293. data/lib/wx/doc/gen/scrolled_window.rb +1 -1
  294. data/lib/wx/doc/gen/search_ctrl.rb +1 -1
  295. data/lib/wx/doc/gen/simplebook.rb +1 -1
  296. data/lib/wx/doc/gen/single_choice_dialog.rb +1 -1
  297. data/lib/wx/doc/gen/sizer.rb +1 -2
  298. data/lib/wx/doc/gen/sizer_item.rb +1 -1
  299. data/lib/wx/doc/gen/slider.rb +1 -2
  300. data/lib/wx/doc/gen/spin_button.rb +1 -1
  301. data/lib/wx/doc/gen/spin_ctrl.rb +1 -1
  302. data/lib/wx/doc/gen/spin_ctrl_double.rb +1 -1
  303. data/lib/wx/doc/gen/spin_double_event.rb +1 -1
  304. data/lib/wx/doc/gen/spin_event.rb +1 -1
  305. data/lib/wx/doc/gen/splash_screen.rb +2 -2
  306. data/lib/wx/doc/gen/splitter_event.rb +1 -1
  307. data/lib/wx/doc/gen/splitter_window.rb +1 -1
  308. data/lib/wx/doc/gen/static_bitmap.rb +1 -1
  309. data/lib/wx/doc/gen/static_box.rb +1 -1
  310. data/lib/wx/doc/gen/static_box_sizer.rb +1 -1
  311. data/lib/wx/doc/gen/static_line.rb +1 -1
  312. data/lib/wx/doc/gen/static_text.rb +1 -1
  313. data/lib/wx/doc/gen/status_bar.rb +1 -1
  314. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4202 -4199
  315. data/lib/wx/doc/gen/stc/styled_text_event.rb +7511 -7508
  316. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +1 -1
  317. data/lib/wx/doc/gen/svg_file_dc.rb +1 -1
  318. data/lib/wx/doc/gen/system_options.rb +1 -1
  319. data/lib/wx/doc/gen/system_settings.rb +1 -1
  320. data/lib/wx/doc/gen/task_bar_button.rb +1 -1
  321. data/lib/wx/doc/gen/task_bar_icon.rb +1 -2
  322. data/lib/wx/doc/gen/task_bar_icon_event.rb +1 -1
  323. data/lib/wx/doc/gen/text_attr.rb +1 -1
  324. data/lib/wx/doc/gen/text_ctrl.rb +1 -6
  325. data/lib/wx/doc/gen/text_entry.rb +1 -1
  326. data/lib/wx/doc/gen/text_entry_dialog.rb +1 -1
  327. data/lib/wx/doc/gen/text_validator.rb +1 -1
  328. data/lib/wx/doc/gen/time_picker_ctrl.rb +1 -1
  329. data/lib/wx/doc/gen/timer.rb +1 -1
  330. data/lib/wx/doc/gen/timer_event.rb +1 -1
  331. data/lib/wx/doc/gen/tip_provider.rb +1 -1
  332. data/lib/wx/doc/gen/toggle_button.rb +1 -1
  333. data/lib/wx/doc/gen/tool_bar.rb +1 -1
  334. data/lib/wx/doc/gen/tool_tip.rb +1 -1
  335. data/lib/wx/doc/gen/toolbook.rb +1 -1
  336. data/lib/wx/doc/gen/top_level_window.rb +1 -1
  337. data/lib/wx/doc/gen/tree_ctrl.rb +1 -3
  338. data/lib/wx/doc/gen/tree_event.rb +1 -1
  339. data/lib/wx/doc/gen/treebook.rb +1 -1
  340. data/lib/wx/doc/gen/ui_action_simulator.rb +1 -1
  341. data/lib/wx/doc/gen/utils.rb +1 -1
  342. data/lib/wx/doc/gen/v_list_box.rb +1 -1
  343. data/lib/wx/doc/gen/v_scrolled_window.rb +1 -2
  344. data/lib/wx/doc/gen/validator.rb +1 -1
  345. data/lib/wx/doc/gen/variant.rb +1 -1
  346. data/lib/wx/doc/gen/window.rb +1 -1
  347. data/lib/wx/doc/gen/window_dc.rb +1 -1
  348. data/lib/wx/doc/gen/window_disabler.rb +1 -1
  349. data/lib/wx/doc/gen/with_images.rb +1 -1
  350. data/lib/wx/doc/gen/wizard.rb +1 -2
  351. data/lib/wx/doc/gen/wizard_event.rb +1 -1
  352. data/lib/wx/doc/gen/wizard_page.rb +1 -2
  353. data/lib/wx/doc/gen/wizard_page_simple.rb +1 -1
  354. data/lib/wx/doc/gen/wrap_sizer.rb +1 -1
  355. data/lib/wx/doc/gen/xml_node.rb +1 -1
  356. data/lib/wx/doc/gen/xml_resource.rb +1 -1
  357. data/lib/wx/doc/owner_drawn_combobox.rb +5 -1
  358. data/lib/wx/rtc/ext/rich_text_ctrl.rb +5 -5
  359. data/lib/wx/version.rb +1 -1
  360. data/lib/wx/wxruby/base.rb +6 -4
  361. data/lib/wx/wxruby/cmd/sampler.rb +39 -29
  362. data/lib/wx/wxruby/cmd/setup.rb +122 -0
  363. data/lib/wx/wxruby/cmd/test.rb +56 -6
  364. data/lib/wxruby_aui.so +0 -0
  365. data/lib/wxruby_core.so +0 -0
  366. data/lib/wxruby_grid.so +0 -0
  367. data/lib/wxruby_html.so +0 -0
  368. data/lib/wxruby_pg.so +0 -0
  369. data/lib/wxruby_prt.so +0 -0
  370. data/lib/wxruby_rbn.so +0 -0
  371. data/lib/wxruby_rtc.so +0 -0
  372. data/lib/wxruby_stc.so +0 -0
  373. data/rakelib/install.rb +2 -0
  374. data/rakelib/lib/config/linux.rb +24 -2
  375. data/rakelib/lib/config/macosx.rb +16 -0
  376. data/rakelib/lib/config/mingw.rb +133 -9
  377. data/rakelib/lib/config/pkgman/arch.rb +53 -0
  378. data/rakelib/lib/config/pkgman/base.rb +169 -0
  379. data/rakelib/lib/config/pkgman/debian.rb +66 -0
  380. data/rakelib/lib/config/pkgman/macosx.rb +183 -0
  381. data/rakelib/lib/config/pkgman/rhel.rb +54 -0
  382. data/rakelib/lib/config/pkgman/suse.rb +54 -0
  383. data/rakelib/lib/config/unixish.rb +36 -19
  384. data/rakelib/lib/config.rb +254 -61
  385. data/rakelib/prepost.rake +9 -4
  386. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +14 -0
  387. data/rakelib/yard/templates/default/fulldoc/html/setup.rb +5 -5
  388. data/rakelib/yard/yard/relative_markdown_links.rb +7 -1
  389. data/tests/test_combo_ctrl.rb +196 -0
  390. metadata +25 -4
@@ -6,1091 +6,1095 @@
6
6
 
7
7
  module Wx::PG
8
8
 
9
- # Most of the shared property manipulation interface shared by {Wx::PG::PropertyGrid}, {Wx::PG::PropertyGridPage}, and {Wx::PG::PropertyGridManager} is defined in this class.
10
- #
11
- # <div class="wxrb-remark">
12
- # <b>Remark:</b>
13
- # <p>
14
- #
15
- # - In separate {Wx::PG::PropertyGrid} component this class was known as {Wx::PropertyContainerMethods}.
16
- # - {Wx::PG::PropertyGridInterface}'s property operation member functions all accept a special {Wx::PGPropArg} id argument, using which you can refer to properties either by their pointer (for performance) or by their name (for conveniency).
17
- #
18
- # </p>
19
- # </div>
20
- #
21
- # Category: {Wx::PG::PropertyGrid}
22
- #
23
- #
24
- # @note In wxRuby this is a mixin module instead of a (base) class.
25
- # @wxrb_require USE_PROPGRID
26
- module PropertyGridInterface
27
-
9
+ module Wx::PG
10
+
11
+ # Most of the shared property manipulation interface shared by {Wx::PG::PropertyGrid}, {Wx::PG::PropertyGridPage}, and {Wx::PG::PropertyGridManager} is defined in this class.
12
+ #
13
+ # <div class="wxrb-remark">
14
+ # <b>Remark:</b>
15
+ # <p>
16
+ #
17
+ # - In separate {Wx::PG::PropertyGrid} component this class was known as {Wx::PropertyContainerMethods}.
18
+ # - {Wx::PG::PropertyGridInterface}'s property operation member functions all accept a special {Wx::PGPropArg} id argument, using which you can refer to properties either by their pointer (for performance) or by their name (for conveniency).
19
+ #
20
+ # </p>
21
+ # </div>
28
22
  #
23
+ # Category: {Wx::PG::PropertyGrid}
29
24
  #
30
- # Flags for {Wx::PG::PropertyGridInterface#save_editable_state} and {Wx::PG::PropertyGridInterface#restore_editable_state}.
31
25
  #
26
+ # @note In wxRuby this is a mixin module instead of a (base) class.
32
27
  # @wxrb_require USE_PROPGRID
33
- class EditableStateFlags < Wx::Enum
28
+ module PropertyGridInterface
34
29
 
35
- # Include selected property.
36
30
  #
37
- SelectionState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(1)
31
+ #
32
+ # Flags for {Wx::PG::PropertyGridInterface#save_editable_state} and {Wx::PG::PropertyGridInterface#restore_editable_state}.
33
+ #
34
+ # @wxrb_require USE_PROPGRID
35
+ class EditableStateFlags < Wx::Enum
36
+
37
+ # Include selected property.
38
+ #
39
+ SelectionState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(1)
40
+
41
+ # Include expanded/collapsed property information.
42
+ #
43
+ ExpandedState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(2)
44
+
45
+ # Include scrolled position.
46
+ #
47
+ ScrollPosState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(4)
48
+
49
+ # Include selected page information.
50
+ #
51
+ PageState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(8)
52
+
53
+ # Include splitter position.
54
+ #
55
+ SplitterPosState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(16)
56
+
57
+ # Include description box size.
58
+ #
59
+ DescBoxState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(32)
60
+
61
+ # Include all supported user editable state information.
62
+ #
63
+ AllStates = Wx::PG::PropertyGridInterface::EditableStateFlags.new(63)
64
+
65
+ end # EditableStateFlags
38
66
 
39
- # Include expanded/collapsed property information.
67
+ # Appends property to the list.
40
68
  #
41
- ExpandedState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(2)
69
+ # {Wx::PG::PropertyGrid} assumes ownership of the object. Becomes child of most recently added category.
70
+ #
71
+ # <div class="wxrb-remark">
72
+ # <b>Remark:</b>
73
+ # <p>
74
+ #
75
+ # - {Wx::PG::PropertyGrid} takes the ownership of the property pointer.
76
+ # - If appending a category with name identical to a category already in the {Wx::PG::PropertyGrid}, then newly created category is deleted, and most recently added category (under which properties are appended) is set to the one with same name. This allows easier adding of items to same categories in multiple passes.
77
+ # - Does not automatically redraw the control, so you may need to call Refresh() when calling this function after control has been shown for the first time.
78
+ # - This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
79
+ #
80
+ # </p>
81
+ # </div>
82
+ # @param property [Wx::PG::PGProperty]
83
+ # @return [Wx::PG::PGProperty]
84
+ def append(property) end
85
+
86
+ # Same as {Wx::PG::PropertyGridInterface#append}, but appends under given parent property.
87
+ # @param id [String,Wx::PG::PGProperty] Name or pointer to parent property.
88
+ # @param newProperty [Wx::PG::PGProperty] Property to be added.
89
+ # @return [Wx::PG::PGProperty]
90
+ def append_in(id, newProperty) end
42
91
 
43
- # Include scrolled position.
92
+ # In order to add new items into a property with private children (for instance, {Wx::PG::FlagsProperty}), you need to call this method.
44
93
  #
45
- ScrollPosState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(4)
94
+ # After populating has been finished, you need to call {Wx::PG::PropertyGridInterface#end_add_children}.
95
+ # @see Wx::PG::PropertyGridInterface#end_add_children
96
+ # @param id [String,Wx::PG::PGProperty]
97
+ # @return [void]
98
+ def begin_add_children(id) end
46
99
 
47
- # Include selected page information.
100
+ # Deletes all properties.
48
101
  #
49
- PageState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(8)
102
+ # <div class="wxrb-remark">
103
+ # <b>Remark:</b>
104
+ # <p>This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
105
+ # </p>
106
+ # </div>
107
+ # @return [void]
108
+ def clear; end
50
109
 
51
- # Include splitter position.
110
+ # Clears current selection, if any.
52
111
  #
53
- SplitterPosState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(16)
112
+ # Returns true if successful or if there was no selection. May fail if validation was enabled and active editor had invalid value.
113
+ #
114
+ # <div class="wxrb-remark">
115
+ # <b>Remark:</b>
116
+ # <p>In wxWidgets 2.9 and later, this function no longer sends {Wx::PG_EVT_SELECTED}.
117
+ # </p>
118
+ # </div>
119
+ # @see Wx::PG::PropertyGrid#select_property
120
+ # @param validation [Boolean] If set to false, deselecting the property will always work, even if its editor had invalid value in it.
121
+ # @return [Boolean]
122
+ def clear_selection(validation=false) end
123
+
124
+ # Resets modified status of all properties.
125
+ # @return [void]
126
+ def clear_modified_status; end
54
127
 
55
- # Include description box size.
128
+ # Collapses given category or property with children.
56
129
  #
57
- DescBoxState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(32)
130
+ # Returns true if actually collapsed.
131
+ #
132
+ # <div class="wxrb-remark">
133
+ # <b>Remark:</b>
134
+ # <p>This function may deselect selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
135
+ # </p>
136
+ # </div>
137
+ # @param id [String,Wx::PG::PGProperty]
138
+ # @return [Boolean]
139
+ def collapse(id) end
58
140
 
59
- # Include all supported user editable state information.
141
+ # Collapses all items that can be collapsed.
142
+ #
143
+ # Return false if failed (may fail if editor value cannot be validated).
60
144
  #
61
- AllStates = Wx::PG::PropertyGridInterface::EditableStateFlags.new(63)
145
+ # <div class="wxrb-remark">
146
+ # <b>Remark:</b>
147
+ # <p>This functions clears selection. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
148
+ # </p>
149
+ # </div>
150
+ # @return [Boolean]
151
+ def collapse_all; end
62
152
 
63
- end # EditableStateFlags
64
-
65
- # Appends property to the list.
66
- #
67
- # {Wx::PG::PropertyGrid} assumes ownership of the object. Becomes child of most recently added category.
68
- #
69
- # <div class="wxrb-remark">
70
- # <b>Remark:</b>
71
- # <p>
72
- #
73
- # - {Wx::PG::PropertyGrid} takes the ownership of the property pointer.
74
- # - If appending a category with name identical to a category already in the {Wx::PG::PropertyGrid}, then newly created category is deleted, and most recently added category (under which properties are appended) is set to the one with same name. This allows easier adding of items to same categories in multiple passes.
75
- # - Does not automatically redraw the control, so you may need to call Refresh() when calling this function after control has been shown for the first time.
76
- # - This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
77
- #
78
- # </p>
79
- # </div>
80
- # @param property [Wx::PG::PGProperty]
81
- # @return [Wx::PG::PGProperty]
82
- def append(property) end
83
-
84
- # Same as {Wx::PG::PropertyGridInterface#append}, but appends under given parent property.
85
- # @param id [String,Wx::PG::PGProperty] Name or pointer to parent property.
86
- # @param newProperty [Wx::PG::PGProperty] Property to be added.
87
- # @return [Wx::PG::PGProperty]
88
- def append_in(id, newProperty) end
89
-
90
- # In order to add new items into a property with private children (for instance, {Wx::PG::FlagsProperty}), you need to call this method.
91
- #
92
- # After populating has been finished, you need to call {Wx::PG::PropertyGridInterface#end_add_children}.
93
- # @see Wx::PG::PropertyGridInterface#end_add_children
94
- # @param id [String,Wx::PG::PGProperty]
95
- # @return [void]
96
- def begin_add_children(id) end
97
-
98
- # Deletes all properties.
99
- #
100
- # <div class="wxrb-remark">
101
- # <b>Remark:</b>
102
- # <p>This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
103
- # </p>
104
- # </div>
105
- # @return [void]
106
- def clear; end
107
-
108
- # Clears current selection, if any.
109
- #
110
- # Returns true if successful or if there was no selection. May fail if validation was enabled and active editor had invalid value.
111
- #
112
- # <div class="wxrb-remark">
113
- # <b>Remark:</b>
114
- # <p>In wxWidgets 2.9 and later, this function no longer sends {Wx::PG_EVT_SELECTED}.
115
- # </p>
116
- # </div>
117
- # @see Wx::PG::PropertyGrid#select_property
118
- # @param validation [Boolean] If set to false, deselecting the property will always work, even if its editor had invalid value in it.
119
- # @return [Boolean]
120
- def clear_selection(validation=false) end
121
-
122
- # Resets modified status of all properties.
123
- # @return [void]
124
- def clear_modified_status; end
125
-
126
- # Collapses given category or property with children.
127
- #
128
- # Returns true if actually collapsed.
129
- #
130
- # <div class="wxrb-remark">
131
- # <b>Remark:</b>
132
- # <p>This function may deselect selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
133
- # </p>
134
- # </div>
135
- # @param id [String,Wx::PG::PGProperty]
136
- # @return [Boolean]
137
- def collapse(id) end
138
-
139
- # Collapses all items that can be collapsed.
140
- #
141
- # Return false if failed (may fail if editor value cannot be validated).
142
- #
143
- # <div class="wxrb-remark">
144
- # <b>Remark:</b>
145
- # <p>This functions clears selection. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
146
- # </p>
147
- # </div>
148
- # @return [Boolean]
149
- def collapse_all; end
150
-
151
- # Changes value of a property, as if by user.
152
- #
153
- # Use this instead of {Wx::PG::PropertyGridInterface#set_property_value} if you need the value to run through validation process, and also send {Wx::PG::EVT_PG_CHANGED}.
154
- #
155
- # <div class="wxrb-remark">
156
- # <b>Remark:</b>
157
- # <p>Since this function sends {Wx::PG::EVT_PG_CHANGED}, it should not be called from EVT_PG_CHANGED handler.
158
- # </p>
159
- # </div>
160
- #
161
- # Returns true if value was successfully changed.
162
- # @param id [String,Wx::PG::PGProperty]
163
- # @param newValue [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
164
- # @return [Boolean]
165
- def change_property_value(id, newValue) end
166
-
167
- # Removes and deletes a property and any children.
168
- #
169
- # <div class="wxrb-remark">
170
- # <b>Remark:</b>
171
- # <p>If you delete a property in a {Wx::PG::PropertyGrid} event handler, the actual deletion is postponed until the next idle event.
172
- # </p>
173
- # </div>
174
- #
175
- # This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
176
- # @param id [String,Wx::PG::PGProperty] Pointer or name of a property.
177
- # @return [void]
178
- def delete_property(id) end
179
-
180
- # Disables a property.
181
- #
182
- # <div class="wxrb-remark">
183
- # <b>Remark:</b>
184
- # <p>Property is refreshed with new settings.
185
- # </p>
186
- # </div>
187
- # @see Wx::PG::PropertyGridInterface#enable_property
188
- # @see Wx::PG::PGProperty#enable
189
- # @param id [String,Wx::PG::PGProperty]
190
- # @return [Boolean]
191
- def disable_property(id) end
192
-
193
- # Returns true if all property grid data changes have been committed.
194
- #
195
- # Usually only returns false if value in active editor has been invalidated by a {Wx::Validator}.
196
- # @return [Boolean]
197
- def editor_validate; end
198
-
199
- # Enables or disables property.
200
- #
201
- # Disabled property usually appears as having grey text.
202
- #
203
- # <div class="wxrb-remark">
204
- # <b>Remark:</b>
205
- # <p>Property is refreshed with new settings.
206
- # </p>
207
- # </div>
208
- # @see Wx::PG::PGProperty#enable
209
- # @param id [String,Wx::PG::PGProperty] Name or pointer to a property.
210
- # @param enable [Boolean] If false, property is disabled instead.
211
- # @return [Boolean]
212
- def enable_property(id, enable=true) end
213
-
214
- # Called after population of property with fixed children has finished.
215
- #
216
- #
217
- # @see Wx::PG::PropertyGridInterface#begin_add_children
218
- # @param id [String,Wx::PG::PGProperty]
219
- # @return [void]
220
- def end_add_children(id) end
221
-
222
- # Expands given category or property with children.
223
- #
224
- # Returns true if actually expanded.
225
- #
226
- # <div class="wxrb-remark">
227
- # <b>Remark:</b>
228
- # <p>This function may deselect selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
229
- # </p>
230
- # </div>
231
- # @param id [String,Wx::PG::PGProperty]
232
- # @return [Boolean]
233
- def expand(id) end
234
-
235
- # Expands all items that can be expanded.
236
- #
237
- # <div class="wxrb-remark">
238
- # <b>Remark:</b>
239
- # <p>This functions clears selection. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
240
- # </p>
241
- # </div>
242
- # @param expand [Boolean]
243
- # @return [Boolean]
244
- def expand_all(expand=true) end
245
-
246
- # Returns auto-resize proportion of the given column.
247
- #
248
- #
249
- # @see Wx::PG::PropertyGridInterface#set_column_proportion
250
- # @param column [Integer]
251
- # @return [Integer]
252
- def get_column_proportion(column) end
253
- alias_method :column_proportion, :get_column_proportion
254
-
255
- # Returns id of first child of given property.
256
- #
257
- # <div class="wxrb-remark">
258
- # <b>Remark:</b>
259
- # <p>Does not return private children!
260
- # </p>
261
- # </div>
262
- # @param id [String,Wx::PG::PGProperty]
263
- # @return [Wx::PG::PGProperty]
264
- def get_first_child(id) end
265
- alias_method :first_child, :get_first_child
266
-
267
- # @param flags [Integer]
268
- # @return [Wx::PG::PGProperty]
269
- def get_first(flags=Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_ALL) end
270
- alias_method :first, :get_first
271
-
272
- # Returns pointer to a property with given name (case-sensitive).
273
- #
274
- # If there is no property with such name, NULL pointer is returned.
275
- #
276
- # <div class="wxrb-remark">
277
- # <b>Remark:</b>
278
- # <p>Properties which have non-category, non-root parent cannot be accessed globally by their name. Instead, use "<property>.<subproperty>" instead of "<subproperty>".
279
- # </p>
280
- # </div>
281
- # @param name [String]
282
- # @return [Wx::PG::PGProperty]
283
- def get_property(name) end
284
- alias_method :property, :get_property
285
-
286
- # Adds to targetArr pointers to properties that have given flags set.
287
- #
288
- # However, if inverse is set to true, then only properties without given flags are stored.
289
- # @param flags [Integer] Property flags to use.
290
- # @param inverse [Boolean] If false, properties that have given flags are stored, otherwise there are stored only properties without given flags.
291
- # @param iterFlags [Integer] Iterator flags to use. Default is everything expect private children. See wxPropertyGridIterator Flags.
292
- # @return [Array<Wx::PG::PGProperty>]
293
- def get_properties_with_flag(flags, inverse=false, iterFlags=((Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_PROPERTIES|Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_HIDDEN|Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_CATEGORIES))) end
294
- alias_method :properties_with_flag, :get_properties_with_flag
295
-
296
- # Returns value of given attribute.
297
- #
298
- # If none found, returns {Wx::NullVariant}.
299
- # @param id [String,Wx::PG::PGProperty]
300
- # @param attrName [String]
301
- # @return [Wx::Variant]
302
- def get_property_attribute(id, attrName) end
303
- alias_method :property_attribute, :get_property_attribute
304
-
305
- # Returns background colour of first cell of a property.
306
- # @param id [String,Wx::PG::PGProperty]
307
- # @return [Wx::Colour]
308
- def get_property_background_colour(id) end
309
- alias_method :property_background_colour, :get_property_background_colour
310
-
311
- # Returns pointer of property's nearest parent category.
312
- #
313
- # If no category found, returns NULL.
314
- # @param id [String,Wx::PG::PGProperty]
315
- # @return [Wx::PG::PropertyCategory]
316
- def get_property_category(id) end
317
- alias_method :property_category, :get_property_category
318
-
319
- # Returns client data (void*) of a property.
320
- # @param id [String,Wx::PG::PGProperty]
321
- # @return [Object]
322
- def get_property_client_data(id) end
323
- alias_method :property_client_data, :get_property_client_data
324
-
325
- # Returns first property which label matches given string.
326
- #
327
- # NULL if none found. Note that this operation is very slow when compared to {Wx::PG::PropertyGridInterface#get_property_by_name}.
328
- # @param label [String]
329
- # @return [Wx::PG::PGProperty]
330
- def get_property_by_label(label) end
331
- alias_method :property_by_label, :get_property_by_label
332
-
333
- # @overload get_property_by_name(name)
334
- # Returns pointer to a property with given name (case-sensitive).
335
- #
336
- # If there is no property with such name, NULL pointer is returned.
337
- #
338
- # <div class="wxrb-remark">
339
- # <b>Remark:</b>
340
- # <p>Properties which have non-category, non-root parent cannot be accessed globally by their name. Instead, use "<property>.<subproperty>" instead of "<subproperty>".
341
- # </p>
342
- # </div>
343
- # @param name [String]
344
- # @return [Wx::PG::PGProperty]
345
- # @overload get_property_by_name(name, subname)
346
- # Returns child property subname of property name.
347
- #
348
- # Same as calling GetPropertyByName("name.subname"), albeit slightly faster.
349
- # @param name [String]
350
- # @param subname [String]
351
- # @return [Wx::PG::PGProperty]
352
- def get_property_by_name(*args) end
353
- alias_method :property_by_name, :get_property_by_name
354
-
355
- # Returns property's editor.
356
- # @param id [String,Wx::PG::PGProperty]
357
- # @return [Wx::PG::PGEditor]
358
- def get_property_editor(id) end
359
- alias_method :property_editor, :get_property_editor
360
-
361
- # Returns help string associated with a property.
362
- # @param id [String,Wx::PG::PGProperty]
363
- # @return [String]
364
- def get_property_help_string(id) end
365
- alias_method :property_help_string, :get_property_help_string
366
-
367
- # Returns property's custom value image (NULL of none).
368
- # @param id [String,Wx::PG::PGProperty]
369
- # @return [Wx::Bitmap]
370
- def get_property_image(id) end
371
- alias_method :property_image, :get_property_image
372
-
373
- # Returns label of a property.
374
- # @param id [String,Wx::PG::PGProperty]
375
- # @return [Wx::String]
376
- def get_property_label(id) end
377
- alias_method :property_label, :get_property_label
378
-
379
- # Returns property's name, by which it is globally accessible.
380
- # @param property [Wx::PG::PGProperty]
381
- # @return [String]
382
- def get_property_name(property) end
383
- alias_method :property_name, :get_property_name
384
-
385
- # Returns parent item of a property.
386
- # @param id [String,Wx::PG::PGProperty]
387
- # @return [Wx::PG::PGProperty]
388
- def get_property_parent(id) end
389
- alias_method :property_parent, :get_property_parent
390
-
391
- # Returns text colour of first cell of a property.
392
- # @param id [String,Wx::PG::PGProperty]
393
- # @return [Wx::Colour]
394
- def get_property_text_colour(id) end
395
- alias_method :property_text_colour, :get_property_text_colour
396
-
397
- # Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator.
398
- # @param id [String,Wx::PG::PGProperty]
399
- # @return [Wx::Validator]
400
- # @wxrb_require USE_VALIDATORS
401
- def get_property_validator(id) end
402
- alias_method :property_validator, :get_property_validator
403
-
404
- # Returns property's value as {Wx::Variant}.
405
- #
406
- # If property value is unspecified, {Wx::NullVariant} is returned.
407
- # @param id [String,Wx::PG::PGProperty]
408
- # @return [Wx::Variant]
409
- def get_property_value(id) end
410
- alias_method :property_value, :get_property_value
411
-
412
- # Return's property's value as {Wx::ArrayInt}.
413
- # @param id [String,Wx::PG::PGProperty]
414
- # @return [Array<Integer>]
415
- def get_property_value_as_array_int(id) end
416
- alias_method :property_value_as_array_int, :get_property_value_as_array_int
417
-
418
- # Returns property's value as {Wx::ArrayString}.
419
- # @param id [String,Wx::PG::PGProperty]
420
- # @return [Array<String>]
421
- def get_property_value_as_array_string(id) end
422
- alias_method :property_value_as_array_string, :get_property_value_as_array_string
423
-
424
- # Returns property's value as bool.
425
- # @param id [String,Wx::PG::PGProperty]
426
- # @return [Boolean]
427
- def get_property_value_as_bool(id) end
428
- alias_method :property_value_as_bool, :get_property_value_as_bool
429
-
430
- # Return's property's value as {Wx::DateTime}.
431
- # @param id [String,Wx::PG::PGProperty]
432
- # @return [Time,Date,DateTime]
433
- # @wxrb_require USE_DATETIME
434
- def get_property_value_as_date_time(id) end
435
- alias_method :property_value_as_date_time, :get_property_value_as_date_time
436
-
437
- # Returns property's value as double-precision floating point number.
438
- # @param id [String,Wx::PG::PGProperty]
439
- # @return [Float]
440
- def get_property_value_as_double(id) end
441
- alias_method :property_value_as_double, :get_property_value_as_double
442
-
443
- # Returns property's value as integer.
444
- # @param id [String,Wx::PG::PGProperty]
445
- # @return [Integer]
446
- def get_property_value_as_int(id) end
447
- alias_method :property_value_as_int, :get_property_value_as_int
448
-
449
- # Returns property's value as integer.
450
- # @param id [String,Wx::PG::PGProperty]
451
- # @return [Integer]
452
- def get_property_value_as_long(id) end
453
- alias_method :property_value_as_long, :get_property_value_as_long
454
-
455
- # Returns property's value as native signed 64-bit integer.
456
- # @param id [String,Wx::PG::PGProperty]
457
- # @return [Integer]
458
- # @wxrb_require USE_LONGLONG
459
- def get_property_value_as_long_long(id) end
460
- alias_method :property_value_as_long_long, :get_property_value_as_long_long
461
-
462
- # Returns property's value as {Wx::String}.
463
- #
464
- # If property does not use string value type, then its value is converted using {Wx::PG::PGProperty#get_value_as_string}.
465
- # @param id [String,Wx::PG::PGProperty]
466
- # @return [String]
467
- def get_property_value_as_string(id) end
468
- alias_method :property_value_as_string, :get_property_value_as_string
469
-
470
- # Returns property's value as unsigned integer.
471
- # @param id [String,Wx::PG::PGProperty]
472
- # @return [Integer]
473
- def get_property_value_as_u_long(id) end
474
- alias_method :property_value_as_u_long, :get_property_value_as_u_long
475
-
476
- # Returns property's value as native unsigned 64-bit integer.
477
- # @param id [String,Wx::PG::PGProperty]
478
- # @return [Integer]
479
- # @wxrb_require USE_LONGLONG
480
- def get_property_value_as_u_long_long(id) end
481
- alias_method :property_value_as_u_long_long, :get_property_value_as_u_long_long
482
-
483
- # Returns a {Wx::Variant} list containing {Wx::Variant} versions of all property values.
484
- #
485
- # Order is not guaranteed.
486
- # @param listname [String] Name of the returned {Wx::Variant} list.
487
- # @param baseparent [Wx::PG::PGProperty] The base property which children properties will be queried for values.
488
- # @param flags [Integer] Use {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_KEEP_STRUCTURE} to retain category structure; each sub category will be its own {Wx::VariantList} of {Wx::Variant}. Use {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_INC_ATTRIBUTES} to include property attributes as well. Each attribute will be stored as list variant named "@<propname>@attr."
489
- # @return [Wx::Variant]
490
- def get_property_values(listname=(''), baseparent=nil, flags=0) end
491
- alias_method :property_values, :get_property_values
492
-
493
- # Returns list of currently selected properties.
494
- #
495
- # <div class="wxrb-remark">
496
- # <b>Remark:</b>
497
- # <p>{Wx::ArrayPGProperty} should be compatible with std::vector API.
498
- # </p>
499
- # </div>
500
- # @return [Array<Wx::PG::PGProperty>]
501
- def get_selected_properties; end
502
- alias_method :selected_properties, :get_selected_properties
503
-
504
- # Returns currently selected property.
505
- #
506
- # NULL if none.
507
- #
508
- # <div class="wxrb-remark">
509
- # <b>Remark:</b>
510
- # <p>When {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_MULTIPLE_SELECTION} extra style is used, this member function returns the focused property, that is the one which can have active editor.
511
- # </p>
512
- # </div>
513
- # @return [Wx::PG::PGProperty]
514
- def get_selection; end
515
- alias_method :selection, :get_selection
516
-
517
- # Hides or reveals a property.
518
- # @param id [String,Wx::PG::PGProperty] Name or pointer to a property.
519
- # @param hide [Boolean] If true, hides property, otherwise reveals it.
520
- # @param flags [Integer] By default changes are applied recursively. Set this parameter {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE} to prevent this.
521
- # @return [Boolean]
522
- def hide_property(id, hide=true, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
523
-
524
- # @overload insert(priorThis, newProperty)
525
- # Inserts property to the property container.
526
- #
527
- # Returns newProperty.
528
- #
529
- # <div class="wxrb-remark">
530
- # <b>Remark:</b>
531
- # <p>
532
- # </p>
533
- # </div>
534
- #
535
- # - {Wx::PG::PropertyGrid} takes the ownership of the property pointer.
536
- # - While Append may be faster way to add items, make note that when both types of data storage (categoric and non-categoric) are active, Insert becomes even more slow. This is especially true if current mode is non-categoric.
537
- # - This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
538
- #
539
- # Example of use:
540
- #
541
- # ```ruby
542
- # # append category
543
- # my_cat_id = propertygrid.append(Wx::PG::PropertyCategory.new("My Category"))
544
- #
545
- # ...
546
- #
547
- # # insert into category - using second overload
548
- # my_item_id_1 = propertygrid.insert(my_cat_id, 0, Wx::PG::StringProperty.new("My String 1"))
549
- #
550
- # # insert before to first item - using first overload
551
- # my_item_id_2 = propertygrid.insert(my_item_id, Wx::PG::StringProperty.new("My String 2"))
552
- # ```
553
- # @param priorThis [String,Wx::PG::PGProperty] New property is inserted just prior to this. Available only in the first variant. There are two versions of this function to allow this parameter to be either an id or name to a property.
554
- # @param newProperty [Wx::PG::PGProperty] Pointer to the inserted property. {Wx::PG::PropertyGrid} will take ownership of this object.
555
- # @return [Wx::PG::PGProperty]
556
- # @overload insert(parent, index, newProperty)
557
- # Inserts property to the property container.
558
- #
559
- # See the other overload for more details.
560
- #
561
- # Returns newProperty.
562
- # @param parent [String,Wx::PG::PGProperty] New property is inserted under this category. Available only in the second variant. There are two versions of this function to allow this parameter to be either an id or name to a property.
563
- # @param index [Integer] Index under category. Available only in the second variant. If index is < 0, property is appended in category.
564
- # @param newProperty [Wx::PG::PGProperty] Pointer to the inserted property. {Wx::PG::PropertyGrid} will take ownership of this object.
565
- # @return [Wx::PG::PGProperty]
566
- def insert(*args) end
567
-
568
- # Returns true if property is a category.
569
- # @param id [String,Wx::PG::PGProperty]
570
- # @return [Boolean]
571
- def is_property_category(id) end
572
- alias_method :property_category?, :is_property_category
573
-
574
- # Returns true if property is enabled.
575
- # @param id [String,Wx::PG::PGProperty]
576
- # @return [Boolean]
577
- def is_property_enabled(id) end
578
- alias_method :property_enabled?, :is_property_enabled
579
-
580
- # Returns true if given property is expanded.
581
- #
582
- # Naturally, always returns false for properties that cannot be expanded.
583
- # @param id [String,Wx::PG::PGProperty]
584
- # @return [Boolean]
585
- def is_property_expanded(id) end
586
- alias_method :property_expanded?, :is_property_expanded
587
-
588
- # Returns true if property has been modified after value set or modify flag clear by software.
589
- # @param id [String,Wx::PG::PGProperty]
590
- # @return [Boolean]
591
- def is_property_modified(id) end
592
- alias_method :property_modified?, :is_property_modified
593
-
594
- # Returns true if property is selected.
595
- # @param id [String,Wx::PG::PGProperty]
596
- # @return [Boolean]
597
- def is_property_selected(id) end
598
- alias_method :property_selected?, :is_property_selected
599
-
600
- # Returns true if property is shown (i.e.
601
- #
602
- # {Wx::PG::PropertyGridInterface#hide_property} with true not called for it).
603
- # @param id [String,Wx::PG::PGProperty]
604
- # @return [Boolean]
605
- def is_property_shown(id) end
606
- alias_method :property_shown?, :is_property_shown
607
-
608
- # Returns true if property value is set to unspecified.
609
- # @param id [String,Wx::PG::PGProperty]
610
- # @return [Boolean]
611
- def is_property_value_unspecified(id) end
612
- alias_method :property_value_unspecified?, :is_property_value_unspecified
613
-
614
- # Disables (limit = true) or enables (limit = false) {Wx::TextCtrl} editor of a property, if it is not the sole mean to edit the value.
615
- #
616
- # <div class="wxrb-remark">
617
- # <b>Remark:</b>
618
- # <p>Property is refreshed with new settings.
619
- # </p>
620
- # </div>
621
- # @param id [String,Wx::PG::PGProperty]
622
- # @param limit [Boolean]
623
- # @return [void]
624
- def limit_property_editing(id, limit=true) end
625
-
626
- # If state is shown in its grid, refresh it now.
627
- # @param state [Wx::PG::PropertyGridPage,Wx::PG::PropertyGridPageState]
628
- # @return [void]
629
- def refresh_grid(state=nil) end
630
-
631
- # Replaces property with id with newly created one.
632
- #
633
- # For example, this code replaces existing property named "Flags" with one that will have different set of items:
634
- #
635
- # ```ruby
636
- # pg.replace_property("Flags", Wx::PG::FlagsProperty.new("Flags", Wx::PG::PG_LABEL, newItems))
637
- # ```
638
- # @see Wx::PG::PropertyGridInterface#insert
639
- # @param id [String,Wx::PG::PGProperty]
640
- # @param property [Wx::PG::PGProperty]
641
- # @return [Wx::PG::PGProperty]
642
- def replace_property(id, property) end
643
-
644
- # Restores user-editable state.
645
- #
646
- # See also {Wx::PG::PropertyGridInterface#save_editable_state}.
647
- #
648
- # Returns false if there was problem reading the string.
649
- #
650
- # <div class="wxrb-remark">
651
- # <b>Remark:</b>
652
- # <p>If some parts of state (such as scrolled or splitter position) fail to restore correctly, please make sure that you call this function after {Wx::PG::PropertyGrid} size has been set (this may sometimes be tricky when sizers are used).
653
- # </p>
654
- # </div>
655
- # @param src [String] String generated by SaveEditableState.
656
- # @param restoreStates [Integer] Which parts to restore from source string. See list of editable state flags.
657
- # @return [Boolean]
658
- def restore_editable_state(src, restoreStates=Wx::PG::PropertyGrid::EditableStateFlags::AllStates) end
659
-
660
- # Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions).
661
- # @param includedStates [Integer] Which parts of state to include. See list of editable state flags.
662
- # @return [String]
663
- def save_editable_state(includedStates=Wx::PG::PropertyGrid::EditableStateFlags::AllStates) end
664
-
665
- # Set proportion of an auto-stretchable column.
666
- #
667
- # {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} window style needs to be used to indicate that columns are auto- resizable.
668
- # Returns false on failure.
669
- #
670
- # <div class="wxrb-remark">
671
- # <b>Remark:</b>
672
- # <p>You should call this for individual pages of {Wx::PG::PropertyGridManager} (if used).
673
- # </p>
674
- # </div>
675
- # @see Wx::PG::PropertyGridInterface#get_column_proportion
676
- # @param column [Integer]
677
- # @param proportion [Integer]
678
- # @return [Boolean]
679
- def set_column_proportion(column, proportion) end
680
-
681
- # Sets an attribute for this property.
682
- #
683
- # <div class="wxrb-remark">
684
- # <b>Remark:</b>
685
- # <p>
686
- #
687
- # - Setting attribute's value to {Wx::NullVariant} will simply remove it from property's set of attributes.
688
- # - Property is refreshed with new settings.
689
- #
690
- # </p>
691
- # </div>
692
- # @param id [String,Wx::PG::PGProperty] Name or pointer to a property.
693
- # @param attrName [String] Text identifier of attribute. See wxPropertyGrid Property Attribute Identifiers.
694
- # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] Value of attribute.
695
- # @param argFlags [Integer] Optional. Use {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE} to set the attribute to child properties recursively.
696
- # @return [void]
697
- def set_property_attribute(id, attrName, value, argFlags=0) end
698
-
699
- # Sets property attribute for all applicable properties.
700
- #
701
- # Be sure to use this method only after all properties have been added to the grid.
702
- #
703
- # <div class="wxrb-remark">
704
- # <b>Remark:</b>
705
- # <p>Properties are refreshed with new settings.
706
- # </p>
707
- # </div>
708
- # @param attrName [String]
709
- # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
710
- # @return [void]
711
- def set_property_attribute_all(attrName, value) end
712
-
713
- # Sets background colour of given property.
714
- #
715
- # <div class="wxrb-remark">
716
- # <b>Remark:</b>
717
- # <p>
718
- #
719
- # - If category is tried to set recursively, only its children are affected.
720
- # - Property is redrawn with new colour.
721
- #
722
- # </p>
723
- # </div>
724
- # @param id [String,Wx::PG::PGProperty] Property name or pointer.
725
- # @param colour [Wx::Colour,String,Symbol] New background colour.
726
- # @param flags [Integer] Default is {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE} which causes colour to be set recursively. Omit this flag to only set colour for the property in question and not any of its children.
727
- # @return [void]
728
- def set_property_background_colour(id, colour, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
729
-
730
- # Sets text, bitmap, and colours for given column's cell.
731
- #
732
- # <div class="wxrb-remark">
733
- # <b>Remark:</b>
734
- # <p>
735
- #
736
- # - You can set label cell by using column 0.
737
- # - You can use {Wx::PG::PG_LABEL} as text to use default text for column.
738
- #
739
- # </p>
740
- # </div>
741
- # @param id [String,Wx::PG::PGProperty]
742
- # @param column [Integer]
743
- # @param text [String]
744
- # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
745
- # @param fgCol [Wx::Colour,String,Symbol]
746
- # @param bgCol [Wx::Colour,String,Symbol]
747
- # @return [void]
748
- def set_property_cell(id, column, text=(''), bitmap=(Wx::BitmapBundle.new()), fgCol=Wx::NULL_COLOUR, bgCol=Wx::NULL_COLOUR) end
749
-
750
- # Sets client data (void*) of a property.
751
- #
752
- # <div class="wxrb-remark">
753
- # <b>Remark:</b>
754
- # <p>This untyped client data has to be deleted manually.
755
- # </p>
756
- # </div>
757
- # @param id [String,Wx::PG::PGProperty]
758
- # @param clientData [Object]
759
- # @return [void]
760
- def set_property_client_data(id, clientData) end
761
-
762
- # Resets text and background colours of given property.
763
- #
764
- # <div class="wxrb-remark">
765
- # <b>Remark:</b>
766
- # <p>
767
- #
768
- # - If category is tried to set recursively, only its children are affected.
769
- # - Property is redrawn with new colours.
770
- #
771
- # </p>
772
- # </div>
773
- # @param id [String,Wx::PG::PGProperty] Property name or pointer.
774
- # @param flags [Integer] Default is {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE} which causes colour to be reset only for the property in question (for backward compatibility).
775
- # @return [void]
776
- def set_property_colours_to_default(id, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE) end
777
- alias_method :property_colours_to_default=, :set_property_colours_to_default
778
-
779
- # @overload set_property_editor(id, editor)
780
- # Sets editor for a property.
781
- #
782
- # For custom editors, use pointer you received from {Wx::PG::PropertyGrid.register_editor_class}.
783
- # @param id [String,Wx::PG::PGProperty] Property name or pointer to a property.
784
- # @param editor [Wx::PG::PGEditor] For builtin editors, use {Wx::PGEditor_X}, where X is builtin editor's name (TextCtrl, Choice, etc. see {Wx::PG::PGEditor} documentation for full list).
785
- # @return [void]
786
- # @overload set_property_editor(id, editorName)
787
- # Sets editor control of a property.
788
- #
789
- # As editor argument, use editor name string, such as "TextCtrl" or "Choice".
790
- # @param id [String,Wx::PG::PGProperty]
791
- # @param editorName [String]
792
- # @return [void]
793
- def set_property_editor(*args) end
794
-
795
- # Sets label of a property.
796
- #
797
- # <div class="wxrb-remark">
798
- # <b>Remark:</b>
799
- # <p>
800
- #
801
- # - Properties under same parent may have same labels. However, property names must still remain unique.
802
- #
803
- # </p>
804
- # </div>
805
- # @param id [String,Wx::PG::PGProperty]
806
- # @param newproplabel [String]
807
- # @return [void]
808
- def set_property_label(id, newproplabel) end
809
-
810
- # Sets name of a property.
811
- # @param id [String,Wx::PG::PGProperty] Name or pointer of property which name to change.
812
- # @param newName [String] New name for property.
813
- # @return [void]
814
- def set_property_name(id, newName) end
815
-
816
- # Sets property (and, recursively, its children) to have read-only value.
817
- #
818
- # In other words, user cannot change the value in the editor, but they can still copy it.
819
- #
820
- # <div class="wxrb-remark">
821
- # <b>Remark:</b>
822
- # <p>
823
- #
824
- # - This is mainly for use with textctrl editor. Only some other editors fully support it.
825
- # - Property is refreshed with new settings.
826
- #
827
- # </p>
828
- # </div>
829
- # @param id [String,Wx::PG::PGProperty] Property name or pointer.
830
- # @param set [Boolean] Use true to enable read-only, false to disable it.
831
- # @param flags [Integer] By default changes are applied recursively. Set this parameter to {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE} to prevent this.
832
- # @return [void]
833
- def set_property_read_only(id, set=true, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
834
- alias_method :property_read_only=, :set_property_read_only
835
-
836
- # Sets property's value to unspecified.
837
- #
838
- # If it has children (it may be category), then the same thing is done to them.
839
- # @param id [String,Wx::PG::PGProperty]
840
- # @return [void]
841
- def set_property_value_unspecified(id) end
842
- alias_method :property_value_unspecified=, :set_property_value_unspecified
843
-
844
- # @overload set_property_values(list, defaultCategory=Wx::PG::NullProperty)
845
- # Sets property values from a list of {Wx::Variants}.
846
- # @param list [Wx::VariantList]
847
- # @param defaultCategory [String,Wx::PG::PGProperty]
848
- # @return [void]
849
- # @overload set_property_values(list, defaultCategory=Wx::PG::NullProperty)
850
- # Sets property values from a list of {Wx::Variants}.
851
- # @param list [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
852
- # @param defaultCategory [String,Wx::PG::PGProperty]
853
- # @return [void]
854
- def set_property_values(*args) end
855
- alias_method :property_values=, :set_property_values
856
-
857
- # Associates the help string with property.
858
- #
859
- # <div class="wxrb-remark">
860
- # <b>Remark:</b>
861
- # <p>By default, text is shown either in the manager's "description" text box or in the status bar. If extra window style {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_HELP_AS_TOOLTIPS} is used, then the text will appear as a tooltip.
862
- # </p>
863
- # </div>
864
- # @param id [String,Wx::PG::PGProperty]
865
- # @param helpString [String]
866
- # @return [void]
867
- def set_property_help_string(id, helpString) end
868
-
869
- # Set {Wx::Bitmap} taken from {Wx::BitmapBundle} in front of the value.
870
- #
871
- # <div class="wxrb-remark">
872
- # <b>Remark:</b>
873
- # <p>Bitmap will be scaled to a size returned by {Wx::PG::PropertyGrid#get_image_size};
874
- # </p>
875
- # </div>
876
- # @param id [String,Wx::PG::PGProperty]
877
- # @param bmp [Wx::BitmapBundle]
878
- # @return [void]
879
- def set_property_image(id, bmp) end
880
-
881
- # Sets maximum length of text in property text editor.
882
- #
883
- # Returns true if maximum length was set.
884
- # @see Wx::PG::PGProperty#set_max_length.
885
- # @param id [String,Wx::PG::PGProperty] Property name or pointer.
886
- # @param maxLen [Integer] Maximum number of characters of the text the user can enter in the text editor. If it is 0, the length is not limited and the text can be as long as it is supported by the underlying native text control widget.
887
- # @return [Boolean]
888
- def set_property_max_length(id, maxLen) end
889
-
890
- # Sets text colour of given property.
891
- #
892
- # <div class="wxrb-remark">
893
- # <b>Remark:</b>
894
- # <p>
895
- #
896
- # - If category is tried to set recursively, only its children are affected.
897
- # - Property is redrawn with new colour.
898
- #
899
- # </p>
900
- # </div>
901
- # @param id [String,Wx::PG::PGProperty] Property name or pointer.
902
- # @param colour [Wx::Colour,String,Symbol] New text colour.
903
- # @param flags [Integer] Default is {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE} which causes colour to be set recursively. Omit this flag to only set colour for the property in question and not any of its children.
904
- # @return [void]
905
- def set_property_text_colour(id, colour, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
906
-
907
- # Sets validator of a property.
908
- # @param id [String,Wx::PG::PGProperty]
909
- # @param validator [Wx::Validator]
910
- # @return [void]
911
- def set_property_validator(id, validator) end
912
-
913
- # @overload set_property_value(id, value)
914
- # Sets value (long integer) of a property.
915
- # @param id [String,Wx::PG::PGProperty]
916
- # @param value [Integer]
917
- # @return [void]
918
- # @overload set_property_value(id, value)
919
- # Sets value (integer) of a property.
920
- # @param id [String,Wx::PG::PGProperty]
921
- # @param value [Integer]
922
- # @return [void]
923
- # @overload set_property_value(id, value)
924
- # Sets value (floating point) of a property.
925
- # @param id [String,Wx::PG::PGProperty]
926
- # @param value [Float]
927
- # @return [void]
928
- # @overload set_property_value(id, value)
929
- # Sets value (bool) of a property.
930
- # @param id [String,Wx::PG::PGProperty]
931
- # @param value [Boolean]
932
- # @return [void]
933
- # @overload set_property_value(id, value)
934
- # Sets value (wchar_t*) of a property.
935
- # @param id [String,Wx::PG::PGProperty]
936
- # @param value [String]
937
- # @return [void]
938
- # @overload set_property_value(id, value)
939
- # Sets value (char*) of a property.
940
- # @param id [String,Wx::PG::PGProperty]
941
- # @param value [String]
942
- # @return [void]
943
- # @overload set_property_value(id, value)
944
- # Sets value (string) of a property.
945
- # @param id [String,Wx::PG::PGProperty]
946
- # @param value [String]
947
- # @return [void]
948
- # @overload set_property_value(id, value)
949
- # Sets value ({Wx::ArrayString}) of a property.
950
- # @param id [String,Wx::PG::PGProperty]
951
- # @param value [Array<String>]
952
- # @return [void]
953
- # @overload set_property_value(id, value)
954
- # Sets value ({Wx::DateTime}) of a property.
955
- # @param id [String,Wx::PG::PGProperty]
956
- # @param value [Time,Date,DateTime]
957
- # @return [void]
958
- # @overload set_property_value(id, value)
959
- # Sets value ({Wx::Object}*) of a property.
960
- # @param id [String,Wx::PG::PGProperty]
961
- # @param value [Wx::Object]
962
- # @return [void]
963
- # @overload set_property_value(id, value)
964
- # Sets value ({Wx::Object}&) of a property.
965
- # @param id [String,Wx::PG::PGProperty]
966
- # @param value [Wx::Object]
967
- # @return [void]
968
- # @overload set_property_value(id, value)
969
- # Sets value (native 64-bit int) of a property.
970
- # @param id [String,Wx::PG::PGProperty]
971
- # @param value [Integer]
972
- # @return [void]
973
- # @overload set_property_value(id, value)
974
- # Sets value ({Wx::LongLong}) of a property.
975
- # @param id [String,Wx::PG::PGProperty]
976
- # @param value [Wx::LongLong]
977
- # @return [void]
978
- # @overload set_property_value(id, value)
979
- # Sets value (native 64-bit unsigned int) of a property.
980
- # @param id [String,Wx::PG::PGProperty]
981
- # @param value [Integer]
982
- # @return [void]
983
- # @overload set_property_value(id, value)
984
- # Sets value ({Wx::ULongLong}) of a property.
985
- # @param id [String,Wx::PG::PGProperty]
986
- # @param value [Wx::ULongLong]
987
- # @return [void]
988
- # @overload set_property_value(id, value)
989
- # Sets value ({Wx::ArrayInt}&) of a property.
990
- # @param id [String,Wx::PG::PGProperty]
991
- # @param value [Array<Integer>]
992
- # @return [void]
993
- # @overload set_property_value(id, value)
994
- # Sets value ({Wx::Variant}) of a property.
995
- #
996
- # <div class="wxrb-remark">
997
- # <b>Remark:</b>
998
- # <p>Use {Wx::PG::PropertyGridInterface#change_property_value} instead if you need to run through validation process and send property change event.
999
- # </p>
1000
- # </div>
1001
- # @param id [String,Wx::PG::PGProperty]
1002
- # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
1003
- # @return [void]
1004
- def set_property_value(*args) end
1005
-
1006
- # Sets value ({Wx::String}) of a property.
1007
- #
1008
- # <div class="wxrb-remark">
1009
- # <b>Remark:</b>
1010
- # <p>This method uses {Wx::PG::PGProperty#set_value_from_string}, which all properties should implement. This means that there should not be a type error, and instead the string is converted to property's actual value type.
1011
- # </p>
1012
- # </div>
1013
- # @param id [String,Wx::PG::PGProperty]
1014
- # @param value [String]
1015
- # @return [void]
1016
- def set_property_value_string(id, value) end
1017
-
1018
- # Sets value ({Wx::Variant}&) of a property.
1019
- #
1020
- # Same as SetPropertyValue, but accepts reference.
1021
- # @param id [String,Wx::PG::PGProperty]
1022
- # @param value [Wx::Variant]
1023
- # @return [void]
1024
- def set_prop_val(id, value) end
1025
-
1026
- # Adjusts how {Wx::PG::PropertyGrid} behaves when invalid value is entered in a property.
1027
- # @param vfbFlags [Integer] See wxPropertyGrid Validation Failure behaviour Flags for possible values.
1028
- # @return [void]
1029
- def set_validation_failure_behavior(vfbFlags) end
1030
- alias_method :validation_failure_behavior=, :set_validation_failure_behavior
1031
-
1032
- # Sorts all properties recursively.
1033
- #
1034
- #
1035
- # @see Wx::PG::PropertyGridInterface#sort_children
1036
- # @see Wx::PG::PropertyGrid#set_sort_function
1037
- # @param flags [Integer] This can contain any of the following options: {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_SORT_TOP_LEVEL_ONLY}: Only sort categories and their immediate children. Sorting done by {Wx::PG::PG_WINDOW_STYLES::PG_AUTO_SORT} option uses this.
1038
- # @return [void]
1039
- def sort(flags=0) end
1040
-
1041
- # Sorts children of a property.
1042
- #
1043
- #
1044
- # @see Wx::PG::PropertyGridInterface#sort
1045
- # @see Wx::PG::PropertyGrid#set_sort_function
1046
- # @param id [String,Wx::PG::PGProperty] Name or pointer to a property.
1047
- # @param flags [Integer] This can contain any of the following options: {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE}: Sorts recursively.
1048
- # @return [void]
1049
- def sort_children(id, flags=0) end
1050
-
1051
- # {Wx::PG::PropertyGridInterface#get_property_by_name} with assertion error message.
1052
- # @param name [String]
1053
- # @return [Wx::PG::PGProperty]
1054
- def get_property_by_name_a(name) end
1055
- alias_method :property_by_name_a, :get_property_by_name_a
1056
-
1057
- #
1058
- #
1059
- # <div class="wxrb-remark">
1060
- # <b>Remark:</b>
1061
- # <p>This function reselects the property and may cause excess flicker, so to just call Refresh() on a rect of single property, call DrawItem() instead.
1062
- # </p>
1063
- # </div>
1064
- # @param p [Wx::PG::PGProperty]
1065
- # @return [void]
1066
- def refresh_property(p) end
1067
-
1068
- # Initializes all property types.
1069
- #
1070
- # Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library.
1071
- # @return [void]
1072
- def self.init_all_type_handlers; end
1073
-
1074
- # Initializes additional property editors (SpinCtrl etc.).
1075
- #
1076
- # Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library.
1077
- # @return [void]
1078
- def self.register_additional_editors; end
1079
-
1080
- # Sets strings listed in the choice dropdown of a {Wx::PG::BoolProperty}.
1081
- #
1082
- # Defaults are "True" and "False", so changing them to, say, "Yes" and "No" may be useful in some less technical applications.
1083
- # @param trueChoice [String]
1084
- # @param falseChoice [String]
1085
- # @return [void]
1086
- def self.set_bool_choices(trueChoice, falseChoice) end
1087
-
1088
- # Returns editor pointer of editor with given name.
1089
- # @param editorName [String]
1090
- # @return [Wx::PG::PGEditor]
1091
- def self.get_editor_by_name(editorName) end
153
+ # Changes value of a property, as if by user.
154
+ #
155
+ # Use this instead of {Wx::PG::PropertyGridInterface#set_property_value} if you need the value to run through validation process, and also send {Wx::PG::EVT_PG_CHANGED}.
156
+ #
157
+ # <div class="wxrb-remark">
158
+ # <b>Remark:</b>
159
+ # <p>Since this function sends {Wx::PG::EVT_PG_CHANGED}, it should not be called from EVT_PG_CHANGED handler.
160
+ # </p>
161
+ # </div>
162
+ #
163
+ # Returns true if value was successfully changed.
164
+ # @param id [String,Wx::PG::PGProperty]
165
+ # @param newValue [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
166
+ # @return [Boolean]
167
+ def change_property_value(id, newValue) end
168
+
169
+ # Removes and deletes a property and any children.
170
+ #
171
+ # <div class="wxrb-remark">
172
+ # <b>Remark:</b>
173
+ # <p>If you delete a property in a {Wx::PG::PropertyGrid} event handler, the actual deletion is postponed until the next idle event.
174
+ # </p>
175
+ # </div>
176
+ #
177
+ # This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
178
+ # @param id [String,Wx::PG::PGProperty] Pointer or name of a property.
179
+ # @return [void]
180
+ def delete_property(id) end
181
+
182
+ # Disables a property.
183
+ #
184
+ # <div class="wxrb-remark">
185
+ # <b>Remark:</b>
186
+ # <p>Property is refreshed with new settings.
187
+ # </p>
188
+ # </div>
189
+ # @see Wx::PG::PropertyGridInterface#enable_property
190
+ # @see Wx::PG::PGProperty#enable
191
+ # @param id [String,Wx::PG::PGProperty]
192
+ # @return [Boolean]
193
+ def disable_property(id) end
194
+
195
+ # Returns true if all property grid data changes have been committed.
196
+ #
197
+ # Usually only returns false if value in active editor has been invalidated by a {Wx::Validator}.
198
+ # @return [Boolean]
199
+ def editor_validate; end
200
+
201
+ # Enables or disables property.
202
+ #
203
+ # Disabled property usually appears as having grey text.
204
+ #
205
+ # <div class="wxrb-remark">
206
+ # <b>Remark:</b>
207
+ # <p>Property is refreshed with new settings.
208
+ # </p>
209
+ # </div>
210
+ # @see Wx::PG::PGProperty#enable
211
+ # @param id [String,Wx::PG::PGProperty] Name or pointer to a property.
212
+ # @param enable [Boolean] If false, property is disabled instead.
213
+ # @return [Boolean]
214
+ def enable_property(id, enable=true) end
215
+
216
+ # Called after population of property with fixed children has finished.
217
+ #
218
+ #
219
+ # @see Wx::PG::PropertyGridInterface#begin_add_children
220
+ # @param id [String,Wx::PG::PGProperty]
221
+ # @return [void]
222
+ def end_add_children(id) end
223
+
224
+ # Expands given category or property with children.
225
+ #
226
+ # Returns true if actually expanded.
227
+ #
228
+ # <div class="wxrb-remark">
229
+ # <b>Remark:</b>
230
+ # <p>This function may deselect selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
231
+ # </p>
232
+ # </div>
233
+ # @param id [String,Wx::PG::PGProperty]
234
+ # @return [Boolean]
235
+ def expand(id) end
236
+
237
+ # Expands all items that can be expanded.
238
+ #
239
+ # <div class="wxrb-remark">
240
+ # <b>Remark:</b>
241
+ # <p>This functions clears selection. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
242
+ # </p>
243
+ # </div>
244
+ # @param expand [Boolean]
245
+ # @return [Boolean]
246
+ def expand_all(expand=true) end
247
+
248
+ # Returns auto-resize proportion of the given column.
249
+ #
250
+ #
251
+ # @see Wx::PG::PropertyGridInterface#set_column_proportion
252
+ # @param column [Integer]
253
+ # @return [Integer]
254
+ def get_column_proportion(column) end
255
+ alias_method :column_proportion, :get_column_proportion
256
+
257
+ # Returns id of first child of given property.
258
+ #
259
+ # <div class="wxrb-remark">
260
+ # <b>Remark:</b>
261
+ # <p>Does not return private children!
262
+ # </p>
263
+ # </div>
264
+ # @param id [String,Wx::PG::PGProperty]
265
+ # @return [Wx::PG::PGProperty]
266
+ def get_first_child(id) end
267
+ alias_method :first_child, :get_first_child
268
+
269
+ # @param flags [Integer]
270
+ # @return [Wx::PG::PGProperty]
271
+ def get_first(flags=Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_ALL) end
272
+ alias_method :first, :get_first
273
+
274
+ # Returns pointer to a property with given name (case-sensitive).
275
+ #
276
+ # If there is no property with such name, NULL pointer is returned.
277
+ #
278
+ # <div class="wxrb-remark">
279
+ # <b>Remark:</b>
280
+ # <p>Properties which have non-category, non-root parent cannot be accessed globally by their name. Instead, use "<property>.<subproperty>" instead of "<subproperty>".
281
+ # </p>
282
+ # </div>
283
+ # @param name [String]
284
+ # @return [Wx::PG::PGProperty]
285
+ def get_property(name) end
286
+ alias_method :property, :get_property
287
+
288
+ # Adds to targetArr pointers to properties that have given flags set.
289
+ #
290
+ # However, if inverse is set to true, then only properties without given flags are stored.
291
+ # @param flags [Integer] Property flags to use.
292
+ # @param inverse [Boolean] If false, properties that have given flags are stored, otherwise there are stored only properties without given flags.
293
+ # @param iterFlags [Integer] Iterator flags to use. Default is everything expect private children. See wxPropertyGridIterator Flags.
294
+ # @return [Array<Wx::PG::PGProperty>]
295
+ def get_properties_with_flag(flags, inverse=false, iterFlags=((Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_PROPERTIES|Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_HIDDEN|Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_CATEGORIES))) end
296
+ alias_method :properties_with_flag, :get_properties_with_flag
297
+
298
+ # Returns value of given attribute.
299
+ #
300
+ # If none found, returns {Wx::NullVariant}.
301
+ # @param id [String,Wx::PG::PGProperty]
302
+ # @param attrName [String]
303
+ # @return [Wx::Variant]
304
+ def get_property_attribute(id, attrName) end
305
+ alias_method :property_attribute, :get_property_attribute
306
+
307
+ # Returns background colour of first cell of a property.
308
+ # @param id [String,Wx::PG::PGProperty]
309
+ # @return [Wx::Colour]
310
+ def get_property_background_colour(id) end
311
+ alias_method :property_background_colour, :get_property_background_colour
312
+
313
+ # Returns pointer of property's nearest parent category.
314
+ #
315
+ # If no category found, returns NULL.
316
+ # @param id [String,Wx::PG::PGProperty]
317
+ # @return [Wx::PG::PropertyCategory]
318
+ def get_property_category(id) end
319
+ alias_method :property_category, :get_property_category
320
+
321
+ # Returns client data (void*) of a property.
322
+ # @param id [String,Wx::PG::PGProperty]
323
+ # @return [Object]
324
+ def get_property_client_data(id) end
325
+ alias_method :property_client_data, :get_property_client_data
326
+
327
+ # Returns first property which label matches given string.
328
+ #
329
+ # NULL if none found. Note that this operation is very slow when compared to {Wx::PG::PropertyGridInterface#get_property_by_name}.
330
+ # @param label [String]
331
+ # @return [Wx::PG::PGProperty]
332
+ def get_property_by_label(label) end
333
+ alias_method :property_by_label, :get_property_by_label
334
+
335
+ # @overload get_property_by_name(name)
336
+ # Returns pointer to a property with given name (case-sensitive).
337
+ #
338
+ # If there is no property with such name, NULL pointer is returned.
339
+ #
340
+ # <div class="wxrb-remark">
341
+ # <b>Remark:</b>
342
+ # <p>Properties which have non-category, non-root parent cannot be accessed globally by their name. Instead, use "<property>.<subproperty>" instead of "<subproperty>".
343
+ # </p>
344
+ # </div>
345
+ # @param name [String]
346
+ # @return [Wx::PG::PGProperty]
347
+ # @overload get_property_by_name(name, subname)
348
+ # Returns child property subname of property name.
349
+ #
350
+ # Same as calling GetPropertyByName("name.subname"), albeit slightly faster.
351
+ # @param name [String]
352
+ # @param subname [String]
353
+ # @return [Wx::PG::PGProperty]
354
+ def get_property_by_name(*args) end
355
+ alias_method :property_by_name, :get_property_by_name
356
+
357
+ # Returns property's editor.
358
+ # @param id [String,Wx::PG::PGProperty]
359
+ # @return [Wx::PG::PGEditor]
360
+ def get_property_editor(id) end
361
+ alias_method :property_editor, :get_property_editor
362
+
363
+ # Returns help string associated with a property.
364
+ # @param id [String,Wx::PG::PGProperty]
365
+ # @return [String]
366
+ def get_property_help_string(id) end
367
+ alias_method :property_help_string, :get_property_help_string
368
+
369
+ # Returns property's custom value image (NULL of none).
370
+ # @param id [String,Wx::PG::PGProperty]
371
+ # @return [Wx::Bitmap]
372
+ def get_property_image(id) end
373
+ alias_method :property_image, :get_property_image
374
+
375
+ # Returns label of a property.
376
+ # @param id [String,Wx::PG::PGProperty]
377
+ # @return [Wx::String]
378
+ def get_property_label(id) end
379
+ alias_method :property_label, :get_property_label
380
+
381
+ # Returns property's name, by which it is globally accessible.
382
+ # @param property [Wx::PG::PGProperty]
383
+ # @return [String]
384
+ def get_property_name(property) end
385
+ alias_method :property_name, :get_property_name
386
+
387
+ # Returns parent item of a property.
388
+ # @param id [String,Wx::PG::PGProperty]
389
+ # @return [Wx::PG::PGProperty]
390
+ def get_property_parent(id) end
391
+ alias_method :property_parent, :get_property_parent
392
+
393
+ # Returns text colour of first cell of a property.
394
+ # @param id [String,Wx::PG::PGProperty]
395
+ # @return [Wx::Colour]
396
+ def get_property_text_colour(id) end
397
+ alias_method :property_text_colour, :get_property_text_colour
398
+
399
+ # Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator.
400
+ # @param id [String,Wx::PG::PGProperty]
401
+ # @return [Wx::Validator]
402
+ # @wxrb_require USE_VALIDATORS
403
+ def get_property_validator(id) end
404
+ alias_method :property_validator, :get_property_validator
405
+
406
+ # Returns property's value as {Wx::Variant}.
407
+ #
408
+ # If property value is unspecified, {Wx::NullVariant} is returned.
409
+ # @param id [String,Wx::PG::PGProperty]
410
+ # @return [Wx::Variant]
411
+ def get_property_value(id) end
412
+ alias_method :property_value, :get_property_value
413
+
414
+ # Return's property's value as {Wx::ArrayInt}.
415
+ # @param id [String,Wx::PG::PGProperty]
416
+ # @return [Array<Integer>]
417
+ def get_property_value_as_array_int(id) end
418
+ alias_method :property_value_as_array_int, :get_property_value_as_array_int
419
+
420
+ # Returns property's value as {Wx::ArrayString}.
421
+ # @param id [String,Wx::PG::PGProperty]
422
+ # @return [Array<String>]
423
+ def get_property_value_as_array_string(id) end
424
+ alias_method :property_value_as_array_string, :get_property_value_as_array_string
425
+
426
+ # Returns property's value as bool.
427
+ # @param id [String,Wx::PG::PGProperty]
428
+ # @return [Boolean]
429
+ def get_property_value_as_bool(id) end
430
+ alias_method :property_value_as_bool, :get_property_value_as_bool
431
+
432
+ # Return's property's value as {Wx::DateTime}.
433
+ # @param id [String,Wx::PG::PGProperty]
434
+ # @return [Time,Date,DateTime]
435
+ # @wxrb_require USE_DATETIME
436
+ def get_property_value_as_date_time(id) end
437
+ alias_method :property_value_as_date_time, :get_property_value_as_date_time
438
+
439
+ # Returns property's value as double-precision floating point number.
440
+ # @param id [String,Wx::PG::PGProperty]
441
+ # @return [Float]
442
+ def get_property_value_as_double(id) end
443
+ alias_method :property_value_as_double, :get_property_value_as_double
444
+
445
+ # Returns property's value as integer.
446
+ # @param id [String,Wx::PG::PGProperty]
447
+ # @return [Integer]
448
+ def get_property_value_as_int(id) end
449
+ alias_method :property_value_as_int, :get_property_value_as_int
450
+
451
+ # Returns property's value as integer.
452
+ # @param id [String,Wx::PG::PGProperty]
453
+ # @return [Integer]
454
+ def get_property_value_as_long(id) end
455
+ alias_method :property_value_as_long, :get_property_value_as_long
456
+
457
+ # Returns property's value as native signed 64-bit integer.
458
+ # @param id [String,Wx::PG::PGProperty]
459
+ # @return [Integer]
460
+ # @wxrb_require USE_LONGLONG
461
+ def get_property_value_as_long_long(id) end
462
+ alias_method :property_value_as_long_long, :get_property_value_as_long_long
463
+
464
+ # Returns property's value as {Wx::String}.
465
+ #
466
+ # If property does not use string value type, then its value is converted using {Wx::PG::PGProperty#get_value_as_string}.
467
+ # @param id [String,Wx::PG::PGProperty]
468
+ # @return [String]
469
+ def get_property_value_as_string(id) end
470
+ alias_method :property_value_as_string, :get_property_value_as_string
471
+
472
+ # Returns property's value as unsigned integer.
473
+ # @param id [String,Wx::PG::PGProperty]
474
+ # @return [Integer]
475
+ def get_property_value_as_u_long(id) end
476
+ alias_method :property_value_as_u_long, :get_property_value_as_u_long
477
+
478
+ # Returns property's value as native unsigned 64-bit integer.
479
+ # @param id [String,Wx::PG::PGProperty]
480
+ # @return [Integer]
481
+ # @wxrb_require USE_LONGLONG
482
+ def get_property_value_as_u_long_long(id) end
483
+ alias_method :property_value_as_u_long_long, :get_property_value_as_u_long_long
484
+
485
+ # Returns a {Wx::Variant} list containing {Wx::Variant} versions of all property values.
486
+ #
487
+ # Order is not guaranteed.
488
+ # @param listname [String] Name of the returned {Wx::Variant} list.
489
+ # @param baseparent [Wx::PG::PGProperty] The base property which children properties will be queried for values.
490
+ # @param flags [Integer] Use {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_KEEP_STRUCTURE} to retain category structure; each sub category will be its own {Wx::VariantList} of {Wx::Variant}. Use {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_INC_ATTRIBUTES} to include property attributes as well. Each attribute will be stored as list variant named "@<propname>@attr."
491
+ # @return [Wx::Variant]
492
+ def get_property_values(listname=(''), baseparent=nil, flags=0) end
493
+ alias_method :property_values, :get_property_values
494
+
495
+ # Returns list of currently selected properties.
496
+ #
497
+ # <div class="wxrb-remark">
498
+ # <b>Remark:</b>
499
+ # <p>{Wx::ArrayPGProperty} should be compatible with std::vector API.
500
+ # </p>
501
+ # </div>
502
+ # @return [Array<Wx::PG::PGProperty>]
503
+ def get_selected_properties; end
504
+ alias_method :selected_properties, :get_selected_properties
505
+
506
+ # Returns currently selected property.
507
+ #
508
+ # NULL if none.
509
+ #
510
+ # <div class="wxrb-remark">
511
+ # <b>Remark:</b>
512
+ # <p>When {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_MULTIPLE_SELECTION} extra style is used, this member function returns the focused property, that is the one which can have active editor.
513
+ # </p>
514
+ # </div>
515
+ # @return [Wx::PG::PGProperty]
516
+ def get_selection; end
517
+ alias_method :selection, :get_selection
518
+
519
+ # Hides or reveals a property.
520
+ # @param id [String,Wx::PG::PGProperty] Name or pointer to a property.
521
+ # @param hide [Boolean] If true, hides property, otherwise reveals it.
522
+ # @param flags [Integer] By default changes are applied recursively. Set this parameter {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE} to prevent this.
523
+ # @return [Boolean]
524
+ def hide_property(id, hide=true, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
525
+
526
+ # @overload insert(priorThis, newProperty)
527
+ # Inserts property to the property container.
528
+ #
529
+ # Returns newProperty.
530
+ #
531
+ # <div class="wxrb-remark">
532
+ # <b>Remark:</b>
533
+ # <p>
534
+ # </p>
535
+ # </div>
536
+ #
537
+ # - {Wx::PG::PropertyGrid} takes the ownership of the property pointer.
538
+ # - While Append may be faster way to add items, make note that when both types of data storage (categoric and non-categoric) are active, Insert becomes even more slow. This is especially true if current mode is non-categoric.
539
+ # - This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
540
+ #
541
+ # Example of use:
542
+ #
543
+ # ```ruby
544
+ # # append category
545
+ # my_cat_id = propertygrid.append(Wx::PG::PropertyCategory.new("My Category"))
546
+ #
547
+ # ...
548
+ #
549
+ # # insert into category - using second overload
550
+ # my_item_id_1 = propertygrid.insert(my_cat_id, 0, Wx::PG::StringProperty.new("My String 1"))
551
+ #
552
+ # # insert before to first item - using first overload
553
+ # my_item_id_2 = propertygrid.insert(my_item_id, Wx::PG::StringProperty.new("My String 2"))
554
+ # ```
555
+ # @param priorThis [String,Wx::PG::PGProperty] New property is inserted just prior to this. Available only in the first variant. There are two versions of this function to allow this parameter to be either an id or name to a property.
556
+ # @param newProperty [Wx::PG::PGProperty] Pointer to the inserted property. {Wx::PG::PropertyGrid} will take ownership of this object.
557
+ # @return [Wx::PG::PGProperty]
558
+ # @overload insert(parent, index, newProperty)
559
+ # Inserts property to the property container.
560
+ #
561
+ # See the other overload for more details.
562
+ #
563
+ # Returns newProperty.
564
+ # @param parent [String,Wx::PG::PGProperty] New property is inserted under this category. Available only in the second variant. There are two versions of this function to allow this parameter to be either an id or name to a property.
565
+ # @param index [Integer] Index under category. Available only in the second variant. If index is < 0, property is appended in category.
566
+ # @param newProperty [Wx::PG::PGProperty] Pointer to the inserted property. {Wx::PG::PropertyGrid} will take ownership of this object.
567
+ # @return [Wx::PG::PGProperty]
568
+ def insert(*args) end
569
+
570
+ # Returns true if property is a category.
571
+ # @param id [String,Wx::PG::PGProperty]
572
+ # @return [Boolean]
573
+ def is_property_category(id) end
574
+ alias_method :property_category?, :is_property_category
575
+
576
+ # Returns true if property is enabled.
577
+ # @param id [String,Wx::PG::PGProperty]
578
+ # @return [Boolean]
579
+ def is_property_enabled(id) end
580
+ alias_method :property_enabled?, :is_property_enabled
581
+
582
+ # Returns true if given property is expanded.
583
+ #
584
+ # Naturally, always returns false for properties that cannot be expanded.
585
+ # @param id [String,Wx::PG::PGProperty]
586
+ # @return [Boolean]
587
+ def is_property_expanded(id) end
588
+ alias_method :property_expanded?, :is_property_expanded
589
+
590
+ # Returns true if property has been modified after value set or modify flag clear by software.
591
+ # @param id [String,Wx::PG::PGProperty]
592
+ # @return [Boolean]
593
+ def is_property_modified(id) end
594
+ alias_method :property_modified?, :is_property_modified
595
+
596
+ # Returns true if property is selected.
597
+ # @param id [String,Wx::PG::PGProperty]
598
+ # @return [Boolean]
599
+ def is_property_selected(id) end
600
+ alias_method :property_selected?, :is_property_selected
601
+
602
+ # Returns true if property is shown (i.e.
603
+ #
604
+ # {Wx::PG::PropertyGridInterface#hide_property} with true not called for it).
605
+ # @param id [String,Wx::PG::PGProperty]
606
+ # @return [Boolean]
607
+ def is_property_shown(id) end
608
+ alias_method :property_shown?, :is_property_shown
609
+
610
+ # Returns true if property value is set to unspecified.
611
+ # @param id [String,Wx::PG::PGProperty]
612
+ # @return [Boolean]
613
+ def is_property_value_unspecified(id) end
614
+ alias_method :property_value_unspecified?, :is_property_value_unspecified
615
+
616
+ # Disables (limit = true) or enables (limit = false) {Wx::TextCtrl} editor of a property, if it is not the sole mean to edit the value.
617
+ #
618
+ # <div class="wxrb-remark">
619
+ # <b>Remark:</b>
620
+ # <p>Property is refreshed with new settings.
621
+ # </p>
622
+ # </div>
623
+ # @param id [String,Wx::PG::PGProperty]
624
+ # @param limit [Boolean]
625
+ # @return [void]
626
+ def limit_property_editing(id, limit=true) end
627
+
628
+ # If state is shown in its grid, refresh it now.
629
+ # @param state [Wx::PG::PropertyGridPage,Wx::PG::PropertyGridPageState]
630
+ # @return [void]
631
+ def refresh_grid(state=nil) end
632
+
633
+ # Replaces property with id with newly created one.
634
+ #
635
+ # For example, this code replaces existing property named "Flags" with one that will have different set of items:
636
+ #
637
+ # ```ruby
638
+ # pg.replace_property("Flags", Wx::PG::FlagsProperty.new("Flags", Wx::PG::PG_LABEL, newItems))
639
+ # ```
640
+ # @see Wx::PG::PropertyGridInterface#insert
641
+ # @param id [String,Wx::PG::PGProperty]
642
+ # @param property [Wx::PG::PGProperty]
643
+ # @return [Wx::PG::PGProperty]
644
+ def replace_property(id, property) end
645
+
646
+ # Restores user-editable state.
647
+ #
648
+ # See also {Wx::PG::PropertyGridInterface#save_editable_state}.
649
+ #
650
+ # Returns false if there was problem reading the string.
651
+ #
652
+ # <div class="wxrb-remark">
653
+ # <b>Remark:</b>
654
+ # <p>If some parts of state (such as scrolled or splitter position) fail to restore correctly, please make sure that you call this function after {Wx::PG::PropertyGrid} size has been set (this may sometimes be tricky when sizers are used).
655
+ # </p>
656
+ # </div>
657
+ # @param src [String] String generated by SaveEditableState.
658
+ # @param restoreStates [Integer] Which parts to restore from source string. See list of editable state flags.
659
+ # @return [Boolean]
660
+ def restore_editable_state(src, restoreStates=Wx::PG::PropertyGridPage::EditableStateFlags::AllStates) end
661
+
662
+ # Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions).
663
+ # @param includedStates [Integer] Which parts of state to include. See list of editable state flags.
664
+ # @return [String]
665
+ def save_editable_state(includedStates=Wx::PG::PropertyGridPage::EditableStateFlags::AllStates) end
666
+
667
+ # Set proportion of an auto-stretchable column.
668
+ #
669
+ # {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} window style needs to be used to indicate that columns are auto- resizable.
670
+ # Returns false on failure.
671
+ #
672
+ # <div class="wxrb-remark">
673
+ # <b>Remark:</b>
674
+ # <p>You should call this for individual pages of {Wx::PG::PropertyGridManager} (if used).
675
+ # </p>
676
+ # </div>
677
+ # @see Wx::PG::PropertyGridInterface#get_column_proportion
678
+ # @param column [Integer]
679
+ # @param proportion [Integer]
680
+ # @return [Boolean]
681
+ def set_column_proportion(column, proportion) end
682
+
683
+ # Sets an attribute for this property.
684
+ #
685
+ # <div class="wxrb-remark">
686
+ # <b>Remark:</b>
687
+ # <p>
688
+ #
689
+ # - Setting attribute's value to {Wx::NullVariant} will simply remove it from property's set of attributes.
690
+ # - Property is refreshed with new settings.
691
+ #
692
+ # </p>
693
+ # </div>
694
+ # @param id [String,Wx::PG::PGProperty] Name or pointer to a property.
695
+ # @param attrName [String] Text identifier of attribute. See wxPropertyGrid Property Attribute Identifiers.
696
+ # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] Value of attribute.
697
+ # @param argFlags [Integer] Optional. Use {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE} to set the attribute to child properties recursively.
698
+ # @return [void]
699
+ def set_property_attribute(id, attrName, value, argFlags=0) end
700
+
701
+ # Sets property attribute for all applicable properties.
702
+ #
703
+ # Be sure to use this method only after all properties have been added to the grid.
704
+ #
705
+ # <div class="wxrb-remark">
706
+ # <b>Remark:</b>
707
+ # <p>Properties are refreshed with new settings.
708
+ # </p>
709
+ # </div>
710
+ # @param attrName [String]
711
+ # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
712
+ # @return [void]
713
+ def set_property_attribute_all(attrName, value) end
714
+
715
+ # Sets background colour of given property.
716
+ #
717
+ # <div class="wxrb-remark">
718
+ # <b>Remark:</b>
719
+ # <p>
720
+ #
721
+ # - If category is tried to set recursively, only its children are affected.
722
+ # - Property is redrawn with new colour.
723
+ #
724
+ # </p>
725
+ # </div>
726
+ # @param id [String,Wx::PG::PGProperty] Property name or pointer.
727
+ # @param colour [Wx::Colour,String,Symbol] New background colour.
728
+ # @param flags [Integer] Default is {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE} which causes colour to be set recursively. Omit this flag to only set colour for the property in question and not any of its children.
729
+ # @return [void]
730
+ def set_property_background_colour(id, colour, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
731
+
732
+ # Sets text, bitmap, and colours for given column's cell.
733
+ #
734
+ # <div class="wxrb-remark">
735
+ # <b>Remark:</b>
736
+ # <p>
737
+ #
738
+ # - You can set label cell by using column 0.
739
+ # - You can use {Wx::PG::PG_LABEL} as text to use default text for column.
740
+ #
741
+ # </p>
742
+ # </div>
743
+ # @param id [String,Wx::PG::PGProperty]
744
+ # @param column [Integer]
745
+ # @param text [String]
746
+ # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
747
+ # @param fgCol [Wx::Colour,String,Symbol]
748
+ # @param bgCol [Wx::Colour,String,Symbol]
749
+ # @return [void]
750
+ def set_property_cell(id, column, text=(''), bitmap=(Wx::BitmapBundle.new()), fgCol=Wx::NULL_COLOUR, bgCol=Wx::NULL_COLOUR) end
751
+
752
+ # Sets client data (void*) of a property.
753
+ #
754
+ # <div class="wxrb-remark">
755
+ # <b>Remark:</b>
756
+ # <p>This untyped client data has to be deleted manually.
757
+ # </p>
758
+ # </div>
759
+ # @param id [String,Wx::PG::PGProperty]
760
+ # @param clientData [Object]
761
+ # @return [void]
762
+ def set_property_client_data(id, clientData) end
763
+
764
+ # Resets text and background colours of given property.
765
+ #
766
+ # <div class="wxrb-remark">
767
+ # <b>Remark:</b>
768
+ # <p>
769
+ #
770
+ # - If category is tried to set recursively, only its children are affected.
771
+ # - Property is redrawn with new colours.
772
+ #
773
+ # </p>
774
+ # </div>
775
+ # @param id [String,Wx::PG::PGProperty] Property name or pointer.
776
+ # @param flags [Integer] Default is {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE} which causes colour to be reset only for the property in question (for backward compatibility).
777
+ # @return [void]
778
+ def set_property_colours_to_default(id, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE) end
779
+ alias_method :property_colours_to_default=, :set_property_colours_to_default
780
+
781
+ # @overload set_property_editor(id, editor)
782
+ # Sets editor for a property.
783
+ #
784
+ # For custom editors, use pointer you received from {Wx::PG::PropertyGrid.register_editor_class}.
785
+ # @param id [String,Wx::PG::PGProperty] Property name or pointer to a property.
786
+ # @param editor [Wx::PG::PGEditor] For builtin editors, use {Wx::PGEditor_X}, where X is builtin editor's name (TextCtrl, Choice, etc. see {Wx::PG::PGEditor} documentation for full list).
787
+ # @return [void]
788
+ # @overload set_property_editor(id, editorName)
789
+ # Sets editor control of a property.
790
+ #
791
+ # As editor argument, use editor name string, such as "TextCtrl" or "Choice".
792
+ # @param id [String,Wx::PG::PGProperty]
793
+ # @param editorName [String]
794
+ # @return [void]
795
+ def set_property_editor(*args) end
796
+
797
+ # Sets label of a property.
798
+ #
799
+ # <div class="wxrb-remark">
800
+ # <b>Remark:</b>
801
+ # <p>
802
+ #
803
+ # - Properties under same parent may have same labels. However, property names must still remain unique.
804
+ #
805
+ # </p>
806
+ # </div>
807
+ # @param id [String,Wx::PG::PGProperty]
808
+ # @param newproplabel [String]
809
+ # @return [void]
810
+ def set_property_label(id, newproplabel) end
811
+
812
+ # Sets name of a property.
813
+ # @param id [String,Wx::PG::PGProperty] Name or pointer of property which name to change.
814
+ # @param newName [String] New name for property.
815
+ # @return [void]
816
+ def set_property_name(id, newName) end
817
+
818
+ # Sets property (and, recursively, its children) to have read-only value.
819
+ #
820
+ # In other words, user cannot change the value in the editor, but they can still copy it.
821
+ #
822
+ # <div class="wxrb-remark">
823
+ # <b>Remark:</b>
824
+ # <p>
825
+ #
826
+ # - This is mainly for use with textctrl editor. Only some other editors fully support it.
827
+ # - Property is refreshed with new settings.
828
+ #
829
+ # </p>
830
+ # </div>
831
+ # @param id [String,Wx::PG::PGProperty] Property name or pointer.
832
+ # @param set [Boolean] Use true to enable read-only, false to disable it.
833
+ # @param flags [Integer] By default changes are applied recursively. Set this parameter to {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE} to prevent this.
834
+ # @return [void]
835
+ def set_property_read_only(id, set=true, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
836
+ alias_method :property_read_only=, :set_property_read_only
837
+
838
+ # Sets property's value to unspecified.
839
+ #
840
+ # If it has children (it may be category), then the same thing is done to them.
841
+ # @param id [String,Wx::PG::PGProperty]
842
+ # @return [void]
843
+ def set_property_value_unspecified(id) end
844
+ alias_method :property_value_unspecified=, :set_property_value_unspecified
845
+
846
+ # @overload set_property_values(list, defaultCategory=Wx::PG::NullProperty)
847
+ # Sets property values from a list of {Wx::Variants}.
848
+ # @param list [Wx::VariantList]
849
+ # @param defaultCategory [String,Wx::PG::PGProperty]
850
+ # @return [void]
851
+ # @overload set_property_values(list, defaultCategory=Wx::PG::NullProperty)
852
+ # Sets property values from a list of {Wx::Variants}.
853
+ # @param list [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
854
+ # @param defaultCategory [String,Wx::PG::PGProperty]
855
+ # @return [void]
856
+ def set_property_values(*args) end
857
+ alias_method :property_values=, :set_property_values
858
+
859
+ # Associates the help string with property.
860
+ #
861
+ # <div class="wxrb-remark">
862
+ # <b>Remark:</b>
863
+ # <p>By default, text is shown either in the manager's "description" text box or in the status bar. If extra window style {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_HELP_AS_TOOLTIPS} is used, then the text will appear as a tooltip.
864
+ # </p>
865
+ # </div>
866
+ # @param id [String,Wx::PG::PGProperty]
867
+ # @param helpString [String]
868
+ # @return [void]
869
+ def set_property_help_string(id, helpString) end
870
+
871
+ # Set {Wx::Bitmap} taken from {Wx::BitmapBundle} in front of the value.
872
+ #
873
+ # <div class="wxrb-remark">
874
+ # <b>Remark:</b>
875
+ # <p>Bitmap will be scaled to a size returned by {Wx::PG::PropertyGrid#get_image_size};
876
+ # </p>
877
+ # </div>
878
+ # @param id [String,Wx::PG::PGProperty]
879
+ # @param bmp [Wx::BitmapBundle]
880
+ # @return [void]
881
+ def set_property_image(id, bmp) end
882
+
883
+ # Sets maximum length of text in property text editor.
884
+ #
885
+ # Returns true if maximum length was set.
886
+ # @see Wx::PG::PGProperty#set_max_length.
887
+ # @param id [String,Wx::PG::PGProperty] Property name or pointer.
888
+ # @param maxLen [Integer] Maximum number of characters of the text the user can enter in the text editor. If it is 0, the length is not limited and the text can be as long as it is supported by the underlying native text control widget.
889
+ # @return [Boolean]
890
+ def set_property_max_length(id, maxLen) end
891
+
892
+ # Sets text colour of given property.
893
+ #
894
+ # <div class="wxrb-remark">
895
+ # <b>Remark:</b>
896
+ # <p>
897
+ #
898
+ # - If category is tried to set recursively, only its children are affected.
899
+ # - Property is redrawn with new colour.
900
+ #
901
+ # </p>
902
+ # </div>
903
+ # @param id [String,Wx::PG::PGProperty] Property name or pointer.
904
+ # @param colour [Wx::Colour,String,Symbol] New text colour.
905
+ # @param flags [Integer] Default is {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE} which causes colour to be set recursively. Omit this flag to only set colour for the property in question and not any of its children.
906
+ # @return [void]
907
+ def set_property_text_colour(id, colour, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
908
+
909
+ # Sets validator of a property.
910
+ # @param id [String,Wx::PG::PGProperty]
911
+ # @param validator [Wx::Validator]
912
+ # @return [void]
913
+ def set_property_validator(id, validator) end
914
+
915
+ # @overload set_property_value(id, value)
916
+ # Sets value (long integer) of a property.
917
+ # @param id [String,Wx::PG::PGProperty]
918
+ # @param value [Integer]
919
+ # @return [void]
920
+ # @overload set_property_value(id, value)
921
+ # Sets value (integer) of a property.
922
+ # @param id [String,Wx::PG::PGProperty]
923
+ # @param value [Integer]
924
+ # @return [void]
925
+ # @overload set_property_value(id, value)
926
+ # Sets value (floating point) of a property.
927
+ # @param id [String,Wx::PG::PGProperty]
928
+ # @param value [Float]
929
+ # @return [void]
930
+ # @overload set_property_value(id, value)
931
+ # Sets value (bool) of a property.
932
+ # @param id [String,Wx::PG::PGProperty]
933
+ # @param value [Boolean]
934
+ # @return [void]
935
+ # @overload set_property_value(id, value)
936
+ # Sets value (wchar_t*) of a property.
937
+ # @param id [String,Wx::PG::PGProperty]
938
+ # @param value [String]
939
+ # @return [void]
940
+ # @overload set_property_value(id, value)
941
+ # Sets value (char*) of a property.
942
+ # @param id [String,Wx::PG::PGProperty]
943
+ # @param value [String]
944
+ # @return [void]
945
+ # @overload set_property_value(id, value)
946
+ # Sets value (string) of a property.
947
+ # @param id [String,Wx::PG::PGProperty]
948
+ # @param value [String]
949
+ # @return [void]
950
+ # @overload set_property_value(id, value)
951
+ # Sets value ({Wx::ArrayString}) of a property.
952
+ # @param id [String,Wx::PG::PGProperty]
953
+ # @param value [Array<String>]
954
+ # @return [void]
955
+ # @overload set_property_value(id, value)
956
+ # Sets value ({Wx::DateTime}) of a property.
957
+ # @param id [String,Wx::PG::PGProperty]
958
+ # @param value [Time,Date,DateTime]
959
+ # @return [void]
960
+ # @overload set_property_value(id, value)
961
+ # Sets value ({Wx::Object}*) of a property.
962
+ # @param id [String,Wx::PG::PGProperty]
963
+ # @param value [Wx::Object]
964
+ # @return [void]
965
+ # @overload set_property_value(id, value)
966
+ # Sets value ({Wx::Object}&) of a property.
967
+ # @param id [String,Wx::PG::PGProperty]
968
+ # @param value [Wx::Object]
969
+ # @return [void]
970
+ # @overload set_property_value(id, value)
971
+ # Sets value (native 64-bit int) of a property.
972
+ # @param id [String,Wx::PG::PGProperty]
973
+ # @param value [Integer]
974
+ # @return [void]
975
+ # @overload set_property_value(id, value)
976
+ # Sets value ({Wx::LongLong}) of a property.
977
+ # @param id [String,Wx::PG::PGProperty]
978
+ # @param value [Wx::LongLong]
979
+ # @return [void]
980
+ # @overload set_property_value(id, value)
981
+ # Sets value (native 64-bit unsigned int) of a property.
982
+ # @param id [String,Wx::PG::PGProperty]
983
+ # @param value [Integer]
984
+ # @return [void]
985
+ # @overload set_property_value(id, value)
986
+ # Sets value ({Wx::ULongLong}) of a property.
987
+ # @param id [String,Wx::PG::PGProperty]
988
+ # @param value [Wx::ULongLong]
989
+ # @return [void]
990
+ # @overload set_property_value(id, value)
991
+ # Sets value ({Wx::ArrayInt}&) of a property.
992
+ # @param id [String,Wx::PG::PGProperty]
993
+ # @param value [Array<Integer>]
994
+ # @return [void]
995
+ # @overload set_property_value(id, value)
996
+ # Sets value ({Wx::Variant}) of a property.
997
+ #
998
+ # <div class="wxrb-remark">
999
+ # <b>Remark:</b>
1000
+ # <p>Use {Wx::PG::PropertyGridInterface#change_property_value} instead if you need to run through validation process and send property change event.
1001
+ # </p>
1002
+ # </div>
1003
+ # @param id [String,Wx::PG::PGProperty]
1004
+ # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
1005
+ # @return [void]
1006
+ def set_property_value(*args) end
1007
+
1008
+ # Sets value ({Wx::String}) of a property.
1009
+ #
1010
+ # <div class="wxrb-remark">
1011
+ # <b>Remark:</b>
1012
+ # <p>This method uses {Wx::PG::PGProperty#set_value_from_string}, which all properties should implement. This means that there should not be a type error, and instead the string is converted to property's actual value type.
1013
+ # </p>
1014
+ # </div>
1015
+ # @param id [String,Wx::PG::PGProperty]
1016
+ # @param value [String]
1017
+ # @return [void]
1018
+ def set_property_value_string(id, value) end
1019
+
1020
+ # Sets value ({Wx::Variant}&) of a property.
1021
+ #
1022
+ # Same as SetPropertyValue, but accepts reference.
1023
+ # @param id [String,Wx::PG::PGProperty]
1024
+ # @param value [Wx::Variant]
1025
+ # @return [void]
1026
+ def set_prop_val(id, value) end
1027
+
1028
+ # Adjusts how {Wx::PG::PropertyGrid} behaves when invalid value is entered in a property.
1029
+ # @param vfbFlags [Integer] See wxPropertyGrid Validation Failure behaviour Flags for possible values.
1030
+ # @return [void]
1031
+ def set_validation_failure_behavior(vfbFlags) end
1032
+ alias_method :validation_failure_behavior=, :set_validation_failure_behavior
1033
+
1034
+ # Sorts all properties recursively.
1035
+ #
1036
+ #
1037
+ # @see Wx::PG::PropertyGridInterface#sort_children
1038
+ # @see Wx::PG::PropertyGrid#set_sort_function
1039
+ # @param flags [Integer] This can contain any of the following options: {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_SORT_TOP_LEVEL_ONLY}: Only sort categories and their immediate children. Sorting done by {Wx::PG::PG_WINDOW_STYLES::PG_AUTO_SORT} option uses this.
1040
+ # @return [void]
1041
+ def sort(flags=0) end
1042
+
1043
+ # Sorts children of a property.
1044
+ #
1045
+ #
1046
+ # @see Wx::PG::PropertyGridInterface#sort
1047
+ # @see Wx::PG::PropertyGrid#set_sort_function
1048
+ # @param id [String,Wx::PG::PGProperty] Name or pointer to a property.
1049
+ # @param flags [Integer] This can contain any of the following options: {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE}: Sorts recursively.
1050
+ # @return [void]
1051
+ def sort_children(id, flags=0) end
1052
+
1053
+ # {Wx::PG::PropertyGridInterface#get_property_by_name} with assertion error message.
1054
+ # @param name [String]
1055
+ # @return [Wx::PG::PGProperty]
1056
+ def get_property_by_name_a(name) end
1057
+ alias_method :property_by_name_a, :get_property_by_name_a
1058
+
1059
+ #
1060
+ #
1061
+ # <div class="wxrb-remark">
1062
+ # <b>Remark:</b>
1063
+ # <p>This function reselects the property and may cause excess flicker, so to just call Refresh() on a rect of single property, call DrawItem() instead.
1064
+ # </p>
1065
+ # </div>
1066
+ # @param p [Wx::PG::PGProperty]
1067
+ # @return [void]
1068
+ def refresh_property(p) end
1069
+
1070
+ # Initializes all property types.
1071
+ #
1072
+ # Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library.
1073
+ # @return [void]
1074
+ def self.init_all_type_handlers; end
1075
+
1076
+ # Initializes additional property editors (SpinCtrl etc.).
1077
+ #
1078
+ # Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library.
1079
+ # @return [void]
1080
+ def self.register_additional_editors; end
1081
+
1082
+ # Sets strings listed in the choice dropdown of a {Wx::PG::BoolProperty}.
1083
+ #
1084
+ # Defaults are "True" and "False", so changing them to, say, "Yes" and "No" may be useful in some less technical applications.
1085
+ # @param trueChoice [String]
1086
+ # @param falseChoice [String]
1087
+ # @return [void]
1088
+ def self.set_bool_choices(trueChoice, falseChoice) end
1089
+
1090
+ # Returns editor pointer of editor with given name.
1091
+ # @param editorName [String]
1092
+ # @return [Wx::PG::PGEditor]
1093
+ def self.get_editor_by_name(editorName) end
1094
+
1095
+ end # PropertyGridInterface
1092
1096
 
1093
- end # PropertyGridInterface
1094
-
1095
1097
 
1096
- end
1098
+ end
1099
+
1100
+ end