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,720 +6,722 @@
6
6
 
7
7
  module Wx::PG
8
8
 
9
- # {Wx::PG::PropertyGrid} is a specialized grid for editing properties - in other words name = value pairs.
10
- #
11
- # List of ready-to-use property classes include strings, numbers, flag sets, fonts, colours and many others. It is possible, for example, to categorize properties, set up a complete tree-hierarchy, add more than two columns, and set arbitrary per-property attributes.
12
- # Please note that most member functions are inherited and as such not documented on this page. This means you will probably also want to read {Wx::PG::PropertyGridInterface} class reference.
13
- # See also wxPropertyGrid Overview.
14
- #
15
- # ## Window Styles
16
- #
17
- # See wxPropertyGrid Window Styles.
18
- #
19
- # ## Event Handling
20
- #
21
- # Please see {Wx::PG::PropertyGridEvent} for the documentation of all event types you can use with {Wx::PG::PropertyGrid}.
22
- #
23
- # <div class="wxrb-remark">
24
- # <b>Remark:</b>
25
- # <p>Use {Wx::PG::PropertyGrid#freeze} and {Wx::PG::PropertyGrid#thaw} respectively to disable and enable drawing. This will also delay sorting etc. miscellaneous calculations to the last possible moment.
26
- # </p>
27
- # </div>
28
- #
29
- # Category: {Wx::PG::PropertyGrid} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
30
- # </td><td> WXGTK Appearance
31
- # </td><td> WXOSX Appearance
32
- # </td></tr></table></div>
33
- #
34
- # @wxrb_require USE_PROPGRID
35
- class PropertyGrid < ScrolledControl
36
-
37
- include Wx::PG::PropertyGridInterface
38
-
39
- # Override in derived class to display error messages in custom manner (these message usually only result from validation failure).
40
- #
41
- # <div class="wxrb-remark">
42
- # <b>Remark:</b>
43
- # <p>If you implement this, then you also need to implement {Wx::PG::PropertyGrid#do_hide_property_error} - possibly to do nothing, if error does not need hiding (e.g. it was logged or shown in a message box).
44
- # </p>
45
- # </div>
46
- # @see Wx::PG::PropertyGrid#do_hide_property_error
47
- # @param property [Wx::PG::PGProperty]
48
- # @param msg [String]
49
- # @return [void]
50
- def do_show_property_error(property, msg) end
51
-
52
- # Override in derived class to hide an error displayed by {Wx::PG::PropertyGrid#do_show_property_error}.
53
- #
54
- #
55
- # @see Wx::PG::PropertyGrid#do_show_property_error
56
- # @param property [Wx::PG::PGProperty]
57
- # @return [void]
58
- def do_hide_property_error(property) end
59
-
60
- # Return {Wx::StatusBar} that is used by this {Wx::PG::PropertyGrid}.
61
- #
62
- # You can reimplement this member function in derived class to override the default behaviour of using the top-level {Wx::Frame}'s status bar, if any.
63
- # @return [Wx::StatusBar]
64
- def get_status_bar; end
65
- alias_method :status_bar, :get_status_bar
66
-
67
- # Override to customize property validation failure behaviour.
68
- #
69
- # Return true if user is allowed to change to another property even if current has invalid value.
70
- # @param property [Wx::PG::PGProperty] Property with entered an invalid value
71
- # @param invalidValue [Wx::Variant] Value which failed in validation.
72
- # @return [Boolean]
73
- def do_on_validation_failure(property, invalidValue) end
74
-
75
- # Override to customize resetting of property validation failure status.
76
- #
77
- # <div class="wxrb-remark">
78
- # <b>Remark:</b>
79
- # <p>Property is guaranteed to have flag {Wx::PG::PGPropertyFlags::PG_PROP_INVALID_VALUE} set.
80
- # </p>
81
- # </div>
82
- # @param property [Wx::PG::PGProperty]
83
- # @return [void]
84
- def do_on_validation_failure_reset(property) end
85
-
86
- # Call when editor widget's contents is modified.
87
- #
88
- # For example, this is called when changes text in {Wx::TextCtrl} (used in {Wx::PG::StringProperty} and {Wx::PG::IntProperty}).
89
- #
90
- # <div class="wxrb-remark">
91
- # <b>Remark:</b>
92
- # <p>This function should only be called by custom properties.
93
- # </p>
94
- # </div>
95
- # @see Wx::PG::PGProperty#on_event
96
- # @return [void]
97
- def editors_value_was_modified; end
98
-
99
- # Reverse of {Wx::PG::PropertyGrid#editors_value_was_modified}.
100
- #
101
- # <div class="wxrb-remark">
102
- # <b>Remark:</b>
103
- # <p>This function should only be called by custom properties.
104
- # </p>
105
- # </div>
106
- # @return [void]
107
- def editors_value_was_not_modified; end
108
-
109
- # Returns most up-to-date value of selected property.
110
- #
111
- # This will return value different from {Wx::PG::PropertyGrid#get_selected_property}->GetValue() only when text editor is activate and string edited by user represents valid, uncommitted property value.
112
- # @return [Wx::Variant]
113
- def get_uncommitted_property_value; end
114
- alias_method :uncommitted_property_value, :get_uncommitted_property_value
115
-
116
- # Returns true if editor's value was marked modified.
117
- # @return [Boolean]
118
- def is_editors_value_modified; end
119
- alias_method :editors_value_modified?, :is_editors_value_modified
120
-
121
- # Shows a brief error message that is related to a property.
122
- # @param id [String,Wx::PG::PGProperty]
123
- # @param msg [String]
124
- # @return [void]
125
- def show_property_error(id, msg) end
126
-
127
- # Call this from {Wx::PG::PGProperty#on_event} to cause property value to be changed after the function returns (with true as return value).
128
- #
129
- # {Wx::PG::PropertyGrid#value_change_in_event} must be used if you wish the application to be able to use {Wx::PG::EVT_PG_CHANGING} to potentially veto the given value.
130
- # @param variant [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
131
- # @return [void]
132
- def value_change_in_event(variant) end
133
-
134
- # You can use this member function, for instance, to detect in {Wx::PG::PGProperty#on_event} if {Wx::PG::PGProperty#set_value_in_event} was already called in {Wx::PG::PGEditor#on_event}.
135
- #
136
- # It really only detects if was value was changed using {Wx::PG::PGProperty#set_value_in_event}, which is usually used when a 'picker' dialog is displayed. If value was written by "normal means" in {Wx::PG::PGProperty#string_to_value} or IntToValue(), then this function will return false (on the other hand, {Wx::PG::PGProperty#on_event} is not even called in those cases).
137
- # @return [Boolean]
138
- def was_value_changed_in_event; end
139
-
140
- # @overload initialize()
141
- # Two step constructor.
142
- #
143
- # Call {Wx::PG::PropertyGrid#create} when this constructor is called to build up the {Wx::PG::PropertyGrid}
144
- # @return [Wx::PG::PropertyGrid]
145
- # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::PG::PG_DEFAULT_STYLE, name=Wx::PROPERTY_GRID_NAME_STR)
146
- # Constructor.
147
- #
148
- # The styles to be used are styles valid for the {Wx::Window}.
149
- # @see wxPropertyGrid Window Styles.
150
- # @param parent [Wx::Window]
151
- # @param id [Integer]
152
- # @param pos [Array(Integer, Integer), Wx::Point]
153
- # @param size [Array(Integer, Integer), Wx::Size]
154
- # @param style [Integer]
155
- # @param name [String]
156
- # @return [Wx::PG::PropertyGrid]
157
- def initialize(*args) end
158
-
159
- # Adds given key combination to trigger given action.
160
- #
161
- # Here is a sample code to make Enter key press move focus to the next property.
162
- #
163
- # ```ruby
164
- # propGrid.add_action_trigger(Wx::PG::PG_ACTION_NEXT_PROPERTY, Wx::K_RETURN)
165
- # propGrid.dedicate_key(Wx::K_RETURN)
166
- # ```
167
- # @param action [Integer] Which action to trigger. See wxPropertyGrid Action Identifiers.
168
- # @param keycode [Integer] Which keycode triggers the action.
169
- # @param modifiers [Integer] Which key event modifiers, in addition to keycode, are needed to trigger the action.
170
- # @return [void]
171
- def add_action_trigger(action, keycode, modifiers=0) end
172
-
173
- # Adds given property into selection.
174
- #
175
- # If {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_MULTIPLE_SELECTION} extra style is not used, then this has same effect as calling {Wx::PG::PropertyGrid#select_property}.
176
- #
177
- # <div class="wxrb-remark">
178
- # <b>Remark:</b>
179
- # <p>Multiple selection is not supported for categories. This means that if you have properties selected, you cannot add category to selection, and also if you have category selected, you cannot add other properties to selection. This member function will fail silently in these cases, even returning true.
180
- # </p>
181
- # </div>
182
- # @param id [String,Wx::PG::PGProperty]
183
- # @return [Boolean]
184
- def add_to_selection(id) end
185
-
186
- # Creates label editor {Wx::TextCtrl} for given column, for property that is currently selected.
187
- #
188
- # When multiple selection is enabled, this applies to whatever property {Wx::PG::PropertyGrid#get_selection} returns.
189
- # @see Wx::PG::PropertyGrid#end_label_edit
190
- # @see Wx::PG::PropertyGrid#make_column_editable
191
- # @param colIndex [Integer] Which column's label to edit. Note that you should not use value 1, which is reserved for property value column.
192
- # @return [void]
193
- def begin_label_edit(colIndex=0) end
194
-
195
- # Changes value of a property, as if from an editor.
196
- #
197
- # Use this instead of {Wx::PG::PropertyGrid#set_property_value} if you need the value to run through validation process, and also send {Wx::PG::EVT_PG_CHANGED}.
198
- #
199
- # <div class="wxrb-remark">
200
- # <b>Remark:</b>
201
- # <p>Since this function sends {Wx::PG::EVT_PG_CHANGED}, it should not be called from EVT_PG_CHANGED handler.
202
- # </p>
203
- # </div>
204
- #
205
- # Returns true if value was successfully changed.
206
- # @param id [String,Wx::PG::PGProperty]
207
- # @param newValue [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
208
- # @return [Boolean]
209
- def change_property_value(id, newValue) end
210
-
211
- # Centers the splitter.
212
- # @param enableAutoResizing [Boolean] If true, automatic column resizing is enabled (only applicable if window style {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} is used).
213
- # @return [void]
214
- def center_splitter(enableAutoResizing=false) end
215
-
216
- # Deletes all properties.
217
- # @return [void]
218
- def clear; end
219
-
220
- # Clears action triggers for given action.
221
- # @param action [Integer] Which action to trigger. wxPropertyGrid Action Identifiers.
222
- # @return [void]
223
- def clear_action_triggers(action) end
224
-
225
- # Forces updating the value of property from the editor control.
226
- #
227
- # Note that {Wx::PG::EVT_PG_CHANGING} and {Wx::PG::EVT_PG_CHANGED} are dispatched using ProcessEvent, meaning your event handlers will be called immediately.
228
- # Returns true if anything was changed.
229
- # @param flags [Integer]
230
- # @return [Boolean]
231
- def commit_changes_from_editor(flags=0) end
232
-
233
- # Two step creation.
234
- #
235
- # Whenever the control is created without any parameters, use Create to actually create it. Don't access the control's public methods before this is called
236
- # @see wxPropertyGrid Window Styles.
237
- # @param parent [Wx::Window]
238
- # @param id [Integer]
239
- # @param pos [Array(Integer, Integer), Wx::Point]
240
- # @param size [Array(Integer, Integer), Wx::Size]
241
- # @param style [Integer]
242
- # @param name [String]
243
- # @return [Boolean]
244
- def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::PG::PG_DEFAULT_STYLE, name=Wx::PROPERTY_GRID_NAME_STR) end
245
-
246
- # Dedicates a specific keycode to {Wx::PG::PropertyGrid}.
247
- #
248
- # This means that such key presses will not be redirected to editor controls.
249
- # Using this function allows, for example, navigation between properties using arrow keys even when the focus is in the editor control.
250
- # @param keycode [Integer]
251
- # @return [void]
252
- def dedicate_key(keycode) end
253
-
254
- # Enables or disables (shows/hides) categories according to parameter enable.
255
- #
256
- # <div class="wxrb-remark">
257
- # <b>Remark:</b>
258
- # <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.
259
- # </p>
260
- # </div>
261
- # @param enable [Boolean]
262
- # @return [Boolean]
263
- def enable_categories(enable) end
264
-
265
- # Destroys label editor {Wx::TextCtrl}, if any.
266
- #
267
- #
268
- # @see Wx::PG::PropertyGrid#begin_label_edit
269
- # @see Wx::PG::PropertyGrid#make_column_editable
270
- # @param commit [Boolean] Use true (default) to store edited label text in property cell data.
271
- # @return [void]
272
- def end_label_edit(commit=true) end
273
-
274
- # Scrolls and/or expands items to ensure that the given item is visible.
275
- #
276
- # Returns true if something was actually done.
277
- # @param id [String,Wx::PG::PGProperty]
278
- # @return [Boolean]
279
- def ensure_visible(id) end
280
-
281
- # Reduces column sizes to minimum possible, while still retaining fully visible grid contents (labels, images).
282
- #
283
- # Minimum size for the grid to still display everything.
284
- #
285
- # <div class="wxrb-remark">
286
- # <b>Remark:</b>
287
- # <p>Does not work well with {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} window style. This function only works properly if grid size prior to call was
288
- # already fairly large.
289
- #
290
- # Note that you can also get calculated column widths by calling
291
- # GetState->GetColumnWidth() immediately after this function
292
- # returns.
293
- #
294
- # </p>
295
- # </div>
296
- # @return [Wx::Size]
297
- def fit_columns; end
298
-
299
- # Returns currently active label editor, NULL if none.
300
- # @return [Wx::TextCtrl]
301
- def get_label_editor; end
302
- alias_method :label_editor, :get_label_editor
303
-
304
- # Returns {Wx::Window} that the properties are painted on, and which should be used as the parent for editor controls.
305
- # @return [Wx::Window]
306
- def get_panel; end
307
- alias_method :panel, :get_panel
308
-
309
- # Returns current category caption background colour.
310
- # @return [Wx::Colour]
311
- def get_caption_background_colour; end
312
- alias_method :caption_background_colour, :get_caption_background_colour
313
-
314
- # Returns current category caption font.
315
- # @return [Wx::Font]
316
- def get_caption_font; end
317
- alias_method :caption_font, :get_caption_font
318
-
319
- # Returns current category caption text colour.
320
- # @return [Wx::Colour]
321
- def get_caption_foreground_colour; end
322
- alias_method :caption_foreground_colour, :get_caption_foreground_colour
323
-
324
- # Returns current cell background colour.
325
- # @return [Wx::Colour]
326
- def get_cell_background_colour; end
327
- alias_method :cell_background_colour, :get_cell_background_colour
328
-
329
- # Returns current cell text colour when disabled.
330
- # @return [Wx::Colour]
331
- def get_cell_disabled_text_colour; end
332
- alias_method :cell_disabled_text_colour, :get_cell_disabled_text_colour
333
-
334
- # Returns current cell text colour.
335
- # @return [Wx::Colour]
336
- def get_cell_text_colour; end
337
- alias_method :cell_text_colour, :get_cell_text_colour
338
-
339
- # Returns number of columns currently on grid.
340
- # @return [Integer]
341
- def get_column_count; end
342
- alias_method :column_count, :get_column_count
343
-
344
- # Returns colour of empty space below properties.
345
- # @return [Wx::Colour]
346
- def get_empty_space_colour; end
347
- alias_method :empty_space_colour, :get_empty_space_colour
348
-
349
- # Returns height of highest characters of used font.
350
- # @return [Integer]
351
- def get_font_height; end
352
- alias_method :font_height, :get_font_height
353
-
354
- # Returns pointer to itself.
355
- #
356
- # Dummy function that enables same kind of code to use {Wx::PG::PropertyGrid} and {Wx::PG::PropertyGridManager}.
357
- # @return [Wx::PG::PropertyGrid]
358
- def get_grid; end
359
- alias_method :grid, :get_grid
360
-
361
- # Returns rectangle of custom paint image.
362
- # @param property [Wx::PG::PGProperty] Return image rectangle for this property.
363
- # @param item [Integer] Which choice of property to use (each choice may have different image).
364
- # @return [Wx::Rect]
365
- def get_image_rect(property, item) end
366
- alias_method :image_rect, :get_image_rect
367
-
368
- # Returns size of the custom paint image in front of property.
369
- # @param property [Wx::PG::PGProperty] Return image rectangle for this property. If this argument is NULL, then preferred size is returned.
370
- # @param item [Integer] Which choice of property to use (each choice may have different image).
371
- # @return [Wx::Size]
372
- def get_image_size(property=nil, item=-1) end
373
- alias_method :image_size, :get_image_size
374
-
375
- # Returns last item which could be iterated using given flags.
376
- # @param flags [Integer] See wxPropertyGridIterator Flags.
377
- # @return [Wx::PG::PGProperty]
378
- def get_last_item(flags=Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_DEFAULT) end
379
- alias_method :last_item, :get_last_item
380
-
381
- # Returns colour of lines between cells.
382
- # @return [Wx::Colour]
383
- def get_line_colour; end
384
- alias_method :line_colour, :get_line_colour
385
-
386
- # Returns background colour of margin.
387
- # @return [Wx::Colour]
388
- def get_margin_colour; end
389
- alias_method :margin_colour, :get_margin_colour
390
-
391
- # Returns margin width.
392
- # @return [Integer]
393
- def get_margin_width; end
394
- alias_method :margin_width, :get_margin_width
395
-
396
- # Returns "root property".
397
- #
398
- # It does not have name, etc. and it is not visible. It is only useful for accessing its children.
399
- # @return [Wx::PG::PGProperty]
400
- def get_root; end
401
- alias_method :root, :get_root
402
-
403
- # Returns height of a single grid row (in pixels).
404
- # @return [Integer]
405
- def get_row_height; end
406
- alias_method :row_height, :get_row_height
407
-
408
- # Returns currently selected property.
409
- # @return [Wx::PG::PGProperty]
410
- def get_selected_property; end
411
- alias_method :selected_property, :get_selected_property
412
-
413
- # Returns currently selected property.
414
- # @return [Wx::PG::PGProperty]
415
- def get_selection; end
416
- alias_method :selection, :get_selection
417
-
418
- # Returns current selection background colour.
419
- # @return [Wx::Colour]
420
- def get_selection_background_colour; end
421
- alias_method :selection_background_colour, :get_selection_background_colour
422
-
423
- # Returns current selection text colour.
424
- # @return [Wx::Colour]
425
- def get_selection_foreground_colour; end
426
- alias_method :selection_foreground_colour, :get_selection_foreground_colour
427
-
428
- # Returns current splitter x position.
429
- # @param splitterIndex [Integer]
430
- # @return [Integer]
431
- def get_splitter_position(splitterIndex=0) end
432
- alias_method :splitter_position, :get_splitter_position
433
-
434
- # Returns {Wx::TextCtrl} active in currently selected property, if any.
435
- #
436
- # Takes {Wx::OwnerDrawnComboBox} into account.
437
- # @return [Wx::TextCtrl]
438
- def get_editor_text_ctrl; end
439
- alias_method :editor_text_ctrl, :get_editor_text_ctrl
440
-
441
- # Returns current appearance of unspecified value cells.
442
- #
443
- #
444
- # @see Wx::PG::PropertyGrid#set_unspecified_value_appearance
445
- # @return [Wx::PG::PGCell]
446
- def get_unspecified_value_appearance; end
447
- alias_method :unspecified_value_appearance, :get_unspecified_value_appearance
448
-
449
- # Returns (visual) text representation of the unspecified property value.
450
- # @param argFlags [Integer] For internal use only.
451
- # @return [String]
452
- def get_unspecified_value_text(argFlags=0) end
453
- alias_method :unspecified_value_text, :get_unspecified_value_text
454
-
455
- # Returns current vertical spacing.
456
- # @return [Integer]
457
- def get_vertical_spacing; end
458
- alias_method :vertical_spacing, :get_vertical_spacing
459
-
460
- # Returns information about arbitrary position in the grid.
461
- # @param pt [Array(Integer, Integer), Wx::Point] Coordinates in the virtual grid space. You may need to use Wx::Scrolled<T>#calc_scrolled_position for translating {Wx::PG::PropertyGrid} client coordinates into something this member function can use.
462
- # @return [Wx::PG::PropertyGridHitTestResult]
463
- def hit_test(pt) end
464
-
465
- # Returns true if any property has been modified by the user.
466
- # @return [Boolean]
467
- def is_any_modified; end
468
- alias_method :any_modified?, :is_any_modified
469
-
470
- # Returns true if a property editor control has focus.
471
- # @return [Boolean]
472
- def is_editor_focused; end
473
- alias_method :editor_focused?, :is_editor_focused
474
-
475
- # Returns true if updating is frozen (i.e.
476
- #
477
- # {Wx::PG::PropertyGrid#freeze} called but not yet {Wx::PG::PropertyGrid#thaw} ).
478
- # @return [Boolean]
479
- def is_frozen; end
480
- alias_method :frozen?, :is_frozen
481
-
482
- # Makes given column editable by user.
483
- #
484
- # Note that column must not be equal to 1, as the second column is always editable and can be made read-only only on cell-by-cell basis using
485
- # ```ruby
486
- # # see Wx::PG::PGProperty#change_flag
487
- # property.change_flag(Wx::PG::PG_PROP_READONLY, true)
488
- # ```
489
- # @see Wx::PG::PropertyGrid#begin_label_edit
490
- # @see Wx::PG::PropertyGrid#end_label_edit
491
- # @param column [Integer] The index of the column to make editable.
492
- # @param editable [Boolean] Using false here will disable column from being editable.
493
- # @return [void]
494
- def make_column_editable(column, editable=true) end
495
-
496
- # It is recommended that you call this function any time your code causes {Wx::PG::PropertyGrid}'s top-level parent to change.
497
- #
498
- # {Wx::PG::PropertyGrid}'s OnIdle() handler should be able to detect most changes, but it is not perfect.
499
- #
500
- # <div class="wxrb-remark">
501
- # <b>Remark:</b>
502
- # <p>This function is automatically called from {Wx::PG::PropertyGrid}:: {Wx::PG::PropertyGrid#reparent} and {Wx::PG::PropertyGridManager#reparent}. You only need to use it if you reparent {Wx::PG::PropertyGrid} indirectly.
503
- # </p>
504
- # </div>
505
- # @param newTLP [Wx::Window] New top-level parent that is about to be set. Old top-level parent window should still exist as the current one.
506
- # @return [void]
507
- def on_tlp_changing(newTLP) end
508
-
509
- # Refreshes any active editor control.
510
- # @return [void]
511
- def refresh_editor; end
512
-
513
- # Redraws given property.
514
- # @param p [Wx::PG::PGProperty]
515
- # @return [void]
516
- def refresh_property(p) end
517
-
518
- # Resets all colours to the original system values.
519
- # @return [void]
520
- def reset_colours; end
521
-
522
- # Resets column sizes and splitter positions, based on proportions.
523
- #
524
- #
525
- # @see Wx::PG::PropertyGridInterface#set_column_proportion
526
- # @param enableAutoResizing [Boolean] If true, automatic column resizing is enabled (only applicable if window style {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} is used).
527
- # @return [void]
528
- def reset_column_sizes(enableAutoResizing=false) end
529
-
530
- # Removes given property from selection.
531
- #
532
- # If property is not selected, an assertion failure will occur.
533
- # @param id [String,Wx::PG::PGProperty]
534
- # @return [Boolean]
535
- def remove_from_selection(id) end
536
-
537
- # Selects a property.
9
+ module Wx::PG
10
+
11
+ # {Wx::PG::PropertyGrid} is a specialized grid for editing properties - in other words name = value pairs.
538
12
  #
539
- # Editor widget is automatically created, but not focused unless focus is true.
13
+ # List of ready-to-use property classes include strings, numbers, flag sets, fonts, colours and many others. It is possible, for example, to categorize properties, set up a complete tree-hierarchy, add more than two columns, and set arbitrary per-property attributes.
14
+ # Please note that most member functions are inherited and as such not documented on this page. This means you will probably also want to read {Wx::PG::PropertyGridInterface} class reference.
15
+ # See also wxPropertyGrid Overview.
540
16
  #
541
- # returns true if selection finished successfully. Usually only fails if current value in editor is not valid.
17
+ # ## Window Styles
18
+ # See wxPropertyGrid Window Styles.
542
19
  #
543
- # <div class="wxrb-remark">
544
- # <b>Remark:</b>
545
- # <p>In wxWidgets 2.9 and later, this function no longer sends {Wx::PG::EVT_PG_SELECTED}.
546
- # </p>
547
- # </div>
20
+ # ## Event Handling
21
+ # Please see {Wx::PG::PropertyGridEvent} for the documentation of all event types you can use with {Wx::PG::PropertyGrid}.
548
22
  #
549
23
  # <div class="wxrb-remark">
550
24
  # <b>Remark:</b>
551
- # <p>This clears any previous selection.
25
+ # <p>Use {Wx::PG::PropertyGrid#freeze} and {Wx::PG::PropertyGrid#thaw} respectively to disable and enable drawing. This will also delay sorting etc. miscellaneous calculations to the last possible moment.
552
26
  # </p>
553
27
  # </div>
554
- # @see Wx::PG::PropertyGridInterface#clear_selection
555
- # @param id [String,Wx::PG::PGProperty] Property to select (name or pointer).
556
- # @param focus [Boolean] If true, move keyboard focus to the created editor right away.
557
- # @return [Boolean]
558
- def select_property(id, focus=false) end
559
-
560
- # Sets category caption background colour.
561
- # @param col [Wx::Colour,String,Symbol]
562
- # @return [void]
563
- def set_caption_background_colour(col) end
564
- alias_method :caption_background_colour=, :set_caption_background_colour
565
-
566
- # Sets category caption text colour.
567
- # @param col [Wx::Colour,String,Symbol]
568
- # @return [void]
569
- def set_caption_text_colour(col) end
570
- alias_method :caption_text_colour=, :set_caption_text_colour
571
-
572
- # Sets default cell background colour - applies to property cells.
573
- #
574
- # Note that appearance of editor widgets may not be affected.
575
- # @param col [Wx::Colour,String,Symbol]
576
- # @return [void]
577
- def set_cell_background_colour(col) end
578
- alias_method :cell_background_colour=, :set_cell_background_colour
579
-
580
- # Sets cell text colour for disabled properties.
581
- # @param col [Wx::Colour,String,Symbol]
582
- # @return [void]
583
- def set_cell_disabled_text_colour(col) end
584
- alias_method :cell_disabled_text_colour=, :set_cell_disabled_text_colour
585
-
586
- # Sets default cell text colour - applies to property name and value text.
587
28
  #
588
- # Note that appearance of editor widgets may not be affected.
589
- # @param col [Wx::Colour,String,Symbol]
590
- # @return [void]
591
- def set_cell_text_colour(col) end
592
- alias_method :cell_text_colour=, :set_cell_text_colour
593
-
594
- # Set number of columns (2 or more).
595
- # @param colCount [Integer]
596
- # @return [void]
597
- def set_column_count(colCount) end
598
- alias_method :column_count=, :set_column_count
599
-
600
- # Sets the 'current' category - Append will add non-category properties under it.
601
- # @param id [String,Wx::PG::PGProperty]
602
- # @return [void]
603
- def set_current_category(id) end
604
- alias_method :current_category=, :set_current_category
605
-
606
- # Sets colour of empty space below properties.
607
- # @param col [Wx::Colour,String,Symbol]
608
- # @return [void]
609
- def set_empty_space_colour(col) end
610
- alias_method :empty_space_colour=, :set_empty_space_colour
611
-
612
- # Sets colour of lines between cells.
613
- # @param col [Wx::Colour,String,Symbol]
614
- # @return [void]
615
- def set_line_colour(col) end
616
- alias_method :line_colour=, :set_line_colour
617
-
618
- # Sets background colour of margin.
619
- # @param col [Wx::Colour,String,Symbol]
620
- # @return [void]
621
- def set_margin_colour(col) end
622
- alias_method :margin_colour=, :set_margin_colour
29
+ # Category: {Wx::PG::PropertyGrid} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
30
+ # </td><td> WXGTK Appearance
31
+ # </td><td> WXOSX Appearance
32
+ # </td></tr></table></div>
33
+ #
34
+ # @wxrb_require USE_PROPGRID
35
+ class PropertyGrid < ScrolledControl
36
+
37
+ include Wx::PG::PropertyGridInterface
38
+
39
+ # Override in derived class to display error messages in custom manner (these message usually only result from validation failure).
40
+ #
41
+ # <div class="wxrb-remark">
42
+ # <b>Remark:</b>
43
+ # <p>If you implement this, then you also need to implement {Wx::PG::PropertyGrid#do_hide_property_error} - possibly to do nothing, if error does not need hiding (e.g. it was logged or shown in a message box).
44
+ # </p>
45
+ # </div>
46
+ # @see Wx::PG::PropertyGrid#do_hide_property_error
47
+ # @param property [Wx::PG::PGProperty]
48
+ # @param msg [String]
49
+ # @return [void]
50
+ def do_show_property_error(property, msg) end
51
+
52
+ # Override in derived class to hide an error displayed by {Wx::PG::PropertyGrid#do_show_property_error}.
53
+ #
54
+ #
55
+ # @see Wx::PG::PropertyGrid#do_show_property_error
56
+ # @param property [Wx::PG::PGProperty]
57
+ # @return [void]
58
+ def do_hide_property_error(property) end
59
+
60
+ # Return {Wx::StatusBar} that is used by this {Wx::PG::PropertyGrid}.
61
+ #
62
+ # You can reimplement this member function in derived class to override the default behaviour of using the top-level {Wx::Frame}'s status bar, if any.
63
+ # @return [Wx::StatusBar]
64
+ def get_status_bar; end
65
+ alias_method :status_bar, :get_status_bar
66
+
67
+ # Override to customize property validation failure behaviour.
68
+ #
69
+ # Return true if user is allowed to change to another property even if current has invalid value.
70
+ # @param property [Wx::PG::PGProperty] Property with entered an invalid value
71
+ # @param invalidValue [Wx::Variant] Value which failed in validation.
72
+ # @return [Boolean]
73
+ def do_on_validation_failure(property, invalidValue) end
74
+
75
+ # Override to customize resetting of property validation failure status.
76
+ #
77
+ # <div class="wxrb-remark">
78
+ # <b>Remark:</b>
79
+ # <p>Property is guaranteed to have flag {Wx::PG::PGPropertyFlags::PG_PROP_INVALID_VALUE} set.
80
+ # </p>
81
+ # </div>
82
+ # @param property [Wx::PG::PGProperty]
83
+ # @return [void]
84
+ def do_on_validation_failure_reset(property) end
85
+
86
+ # Call when editor widget's contents is modified.
87
+ #
88
+ # For example, this is called when changes text in {Wx::TextCtrl} (used in {Wx::PG::StringProperty} and {Wx::PG::IntProperty}).
89
+ #
90
+ # <div class="wxrb-remark">
91
+ # <b>Remark:</b>
92
+ # <p>This function should only be called by custom properties.
93
+ # </p>
94
+ # </div>
95
+ # @see Wx::PG::PGProperty#on_event
96
+ # @return [void]
97
+ def editors_value_was_modified; end
98
+
99
+ # Reverse of {Wx::PG::PropertyGrid#editors_value_was_modified}.
100
+ #
101
+ # <div class="wxrb-remark">
102
+ # <b>Remark:</b>
103
+ # <p>This function should only be called by custom properties.
104
+ # </p>
105
+ # </div>
106
+ # @return [void]
107
+ def editors_value_was_not_modified; end
108
+
109
+ # Returns most up-to-date value of selected property.
110
+ #
111
+ # This will return value different from {Wx::PG::PropertyGrid#get_selected_property}->GetValue() only when text editor is activate and string edited by user represents valid, uncommitted property value.
112
+ # @return [Wx::Variant]
113
+ def get_uncommitted_property_value; end
114
+ alias_method :uncommitted_property_value, :get_uncommitted_property_value
115
+
116
+ # Returns true if editor's value was marked modified.
117
+ # @return [Boolean]
118
+ def is_editors_value_modified; end
119
+ alias_method :editors_value_modified?, :is_editors_value_modified
120
+
121
+ # Shows a brief error message that is related to a property.
122
+ # @param id [String,Wx::PG::PGProperty]
123
+ # @param msg [String]
124
+ # @return [void]
125
+ def show_property_error(id, msg) end
126
+
127
+ # Call this from {Wx::PG::PGProperty#on_event} to cause property value to be changed after the function returns (with true as return value).
128
+ #
129
+ # {Wx::PG::PropertyGrid#value_change_in_event} must be used if you wish the application to be able to use {Wx::PG::EVT_PG_CHANGING} to potentially veto the given value.
130
+ # @param variant [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
131
+ # @return [void]
132
+ def value_change_in_event(variant) end
133
+
134
+ # You can use this member function, for instance, to detect in {Wx::PG::PGProperty#on_event} if {Wx::PG::PGProperty#set_value_in_event} was already called in {Wx::PG::PGEditor#on_event}.
135
+ #
136
+ # It really only detects if was value was changed using {Wx::PG::PGProperty#set_value_in_event}, which is usually used when a 'picker' dialog is displayed. If value was written by "normal means" in {Wx::PG::PGProperty#string_to_value} or IntToValue(), then this function will return false (on the other hand, {Wx::PG::PGProperty#on_event} is not even called in those cases).
137
+ # @return [Boolean]
138
+ def was_value_changed_in_event; end
139
+
140
+ # @overload initialize()
141
+ # Two step constructor.
142
+ #
143
+ # Call {Wx::PG::PropertyGrid#create} when this constructor is called to build up the {Wx::PG::PropertyGrid}
144
+ # @return [Wx::PG::PropertyGrid]
145
+ # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::PG::PG_DEFAULT_STYLE, name=Wx::PROPERTY_GRID_NAME_STR)
146
+ # Constructor.
147
+ #
148
+ # The styles to be used are styles valid for the {Wx::Window}.
149
+ # @see wxPropertyGrid Window Styles.
150
+ # @param parent [Wx::Window]
151
+ # @param id [Integer]
152
+ # @param pos [Array(Integer, Integer), Wx::Point]
153
+ # @param size [Array(Integer, Integer), Wx::Size]
154
+ # @param style [Integer]
155
+ # @param name [String]
156
+ # @return [Wx::PG::PropertyGrid]
157
+ def initialize(*args) end
158
+
159
+ # Adds given key combination to trigger given action.
160
+ #
161
+ # Here is a sample code to make Enter key press move focus to the next property.
162
+ #
163
+ # ```ruby
164
+ # propGrid.add_action_trigger(Wx::PG::PG_ACTION_NEXT_PROPERTY, Wx::K_RETURN)
165
+ # propGrid.dedicate_key(Wx::K_RETURN)
166
+ # ```
167
+ # @param action [Integer] Which action to trigger. See wxPropertyGrid Action Identifiers.
168
+ # @param keycode [Integer] Which keycode triggers the action.
169
+ # @param modifiers [Integer] Which key event modifiers, in addition to keycode, are needed to trigger the action.
170
+ # @return [void]
171
+ def add_action_trigger(action, keycode, modifiers=0) end
172
+
173
+ # Adds given property into selection.
174
+ #
175
+ # If {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_MULTIPLE_SELECTION} extra style is not used, then this has same effect as calling {Wx::PG::PropertyGrid#select_property}.
176
+ #
177
+ # <div class="wxrb-remark">
178
+ # <b>Remark:</b>
179
+ # <p>Multiple selection is not supported for categories. This means that if you have properties selected, you cannot add category to selection, and also if you have category selected, you cannot add other properties to selection. This member function will fail silently in these cases, even returning true.
180
+ # </p>
181
+ # </div>
182
+ # @param id [String,Wx::PG::PGProperty]
183
+ # @return [Boolean]
184
+ def add_to_selection(id) end
185
+
186
+ # Creates label editor {Wx::TextCtrl} for given column, for property that is currently selected.
187
+ #
188
+ # When multiple selection is enabled, this applies to whatever property {Wx::PG::PropertyGrid#get_selection} returns.
189
+ # @see Wx::PG::PropertyGrid#end_label_edit
190
+ # @see Wx::PG::PropertyGrid#make_column_editable
191
+ # @param colIndex [Integer] Which column's label to edit. Note that you should not use value 1, which is reserved for property value column.
192
+ # @return [void]
193
+ def begin_label_edit(colIndex=0) end
194
+
195
+ # Changes value of a property, as if from an editor.
196
+ #
197
+ # Use this instead of {Wx::PG::PropertyGrid#set_property_value} if you need the value to run through validation process, and also send {Wx::PG::EVT_PG_CHANGED}.
198
+ #
199
+ # <div class="wxrb-remark">
200
+ # <b>Remark:</b>
201
+ # <p>Since this function sends {Wx::PG::EVT_PG_CHANGED}, it should not be called from EVT_PG_CHANGED handler.
202
+ # </p>
203
+ # </div>
204
+ #
205
+ # Returns true if value was successfully changed.
206
+ # @param id [String,Wx::PG::PGProperty]
207
+ # @param newValue [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
208
+ # @return [Boolean]
209
+ def change_property_value(id, newValue) end
210
+
211
+ # Centers the splitter.
212
+ # @param enableAutoResizing [Boolean] If true, automatic column resizing is enabled (only applicable if window style {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} is used).
213
+ # @return [void]
214
+ def center_splitter(enableAutoResizing=false) end
215
+
216
+ # Deletes all properties.
217
+ # @return [void]
218
+ def clear; end
219
+
220
+ # Clears action triggers for given action.
221
+ # @param action [Integer] Which action to trigger. wxPropertyGrid Action Identifiers.
222
+ # @return [void]
223
+ def clear_action_triggers(action) end
224
+
225
+ # Forces updating the value of property from the editor control.
226
+ #
227
+ # Note that {Wx::PG::EVT_PG_CHANGING} and {Wx::PG::EVT_PG_CHANGED} are dispatched using ProcessEvent, meaning your event handlers will be called immediately.
228
+ # Returns true if anything was changed.
229
+ # @param flags [Integer]
230
+ # @return [Boolean]
231
+ def commit_changes_from_editor(flags=0) end
232
+
233
+ # Two step creation.
234
+ #
235
+ # Whenever the control is created without any parameters, use Create to actually create it. Don't access the control's public methods before this is called
236
+ # @see wxPropertyGrid Window Styles.
237
+ # @param parent [Wx::Window]
238
+ # @param id [Integer]
239
+ # @param pos [Array(Integer, Integer), Wx::Point]
240
+ # @param size [Array(Integer, Integer), Wx::Size]
241
+ # @param style [Integer]
242
+ # @param name [String]
243
+ # @return [Boolean]
244
+ def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::PG::PG_DEFAULT_STYLE, name=Wx::PROPERTY_GRID_NAME_STR) end
245
+
246
+ # Dedicates a specific keycode to {Wx::PG::PropertyGrid}.
247
+ #
248
+ # This means that such key presses will not be redirected to editor controls.
249
+ # Using this function allows, for example, navigation between properties using arrow keys even when the focus is in the editor control.
250
+ # @param keycode [Integer]
251
+ # @return [void]
252
+ def dedicate_key(keycode) end
253
+
254
+ # Enables or disables (shows/hides) categories according to parameter enable.
255
+ #
256
+ # <div class="wxrb-remark">
257
+ # <b>Remark:</b>
258
+ # <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.
259
+ # </p>
260
+ # </div>
261
+ # @param enable [Boolean]
262
+ # @return [Boolean]
263
+ def enable_categories(enable) end
264
+
265
+ # Destroys label editor {Wx::TextCtrl}, if any.
266
+ #
267
+ #
268
+ # @see Wx::PG::PropertyGrid#begin_label_edit
269
+ # @see Wx::PG::PropertyGrid#make_column_editable
270
+ # @param commit [Boolean] Use true (default) to store edited label text in property cell data.
271
+ # @return [void]
272
+ def end_label_edit(commit=true) end
273
+
274
+ # Scrolls and/or expands items to ensure that the given item is visible.
275
+ #
276
+ # Returns true if something was actually done.
277
+ # @param id [String,Wx::PG::PGProperty]
278
+ # @return [Boolean]
279
+ def ensure_visible(id) end
280
+
281
+ # Reduces column sizes to minimum possible, while still retaining fully visible grid contents (labels, images).
282
+ #
283
+ # Minimum size for the grid to still display everything.
284
+ #
285
+ # <div class="wxrb-remark">
286
+ # <b>Remark:</b>
287
+ # <p>Does not work well with {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} window style. This function only works properly if grid size prior to call was
288
+ # already fairly large.
289
+ #
290
+ # Note that you can also get calculated column widths by calling
291
+ # GetState->GetColumnWidth() immediately after this function
292
+ # returns.
293
+ #
294
+ # </p>
295
+ # </div>
296
+ # @return [Wx::Size]
297
+ def fit_columns; end
298
+
299
+ # Returns currently active label editor, NULL if none.
300
+ # @return [Wx::TextCtrl]
301
+ def get_label_editor; end
302
+ alias_method :label_editor, :get_label_editor
303
+
304
+ # Returns {Wx::Window} that the properties are painted on, and which should be used as the parent for editor controls.
305
+ # @return [Wx::Window]
306
+ def get_panel; end
307
+ alias_method :panel, :get_panel
308
+
309
+ # Returns current category caption background colour.
310
+ # @return [Wx::Colour]
311
+ def get_caption_background_colour; end
312
+ alias_method :caption_background_colour, :get_caption_background_colour
313
+
314
+ # Returns current category caption font.
315
+ # @return [Wx::Font]
316
+ def get_caption_font; end
317
+ alias_method :caption_font, :get_caption_font
318
+
319
+ # Returns current category caption text colour.
320
+ # @return [Wx::Colour]
321
+ def get_caption_foreground_colour; end
322
+ alias_method :caption_foreground_colour, :get_caption_foreground_colour
323
+
324
+ # Returns current cell background colour.
325
+ # @return [Wx::Colour]
326
+ def get_cell_background_colour; end
327
+ alias_method :cell_background_colour, :get_cell_background_colour
328
+
329
+ # Returns current cell text colour when disabled.
330
+ # @return [Wx::Colour]
331
+ def get_cell_disabled_text_colour; end
332
+ alias_method :cell_disabled_text_colour, :get_cell_disabled_text_colour
333
+
334
+ # Returns current cell text colour.
335
+ # @return [Wx::Colour]
336
+ def get_cell_text_colour; end
337
+ alias_method :cell_text_colour, :get_cell_text_colour
338
+
339
+ # Returns number of columns currently on grid.
340
+ # @return [Integer]
341
+ def get_column_count; end
342
+ alias_method :column_count, :get_column_count
343
+
344
+ # Returns colour of empty space below properties.
345
+ # @return [Wx::Colour]
346
+ def get_empty_space_colour; end
347
+ alias_method :empty_space_colour, :get_empty_space_colour
348
+
349
+ # Returns height of highest characters of used font.
350
+ # @return [Integer]
351
+ def get_font_height; end
352
+ alias_method :font_height, :get_font_height
353
+
354
+ # Returns pointer to itself.
355
+ #
356
+ # Dummy function that enables same kind of code to use {Wx::PG::PropertyGrid} and {Wx::PG::PropertyGridManager}.
357
+ # @return [Wx::PG::PropertyGrid]
358
+ def get_grid; end
359
+ alias_method :grid, :get_grid
360
+
361
+ # Returns rectangle of custom paint image.
362
+ # @param property [Wx::PG::PGProperty] Return image rectangle for this property.
363
+ # @param item [Integer] Which choice of property to use (each choice may have different image).
364
+ # @return [Wx::Rect]
365
+ def get_image_rect(property, item) end
366
+ alias_method :image_rect, :get_image_rect
367
+
368
+ # Returns size of the custom paint image in front of property.
369
+ # @param property [Wx::PG::PGProperty] Return image rectangle for this property. If this argument is NULL, then preferred size is returned.
370
+ # @param item [Integer] Which choice of property to use (each choice may have different image).
371
+ # @return [Wx::Size]
372
+ def get_image_size(property=nil, item=-1) end
373
+ alias_method :image_size, :get_image_size
374
+
375
+ # Returns last item which could be iterated using given flags.
376
+ # @param flags [Integer] See wxPropertyGridIterator Flags.
377
+ # @return [Wx::PG::PGProperty]
378
+ def get_last_item(flags=Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_DEFAULT) end
379
+ alias_method :last_item, :get_last_item
380
+
381
+ # Returns colour of lines between cells.
382
+ # @return [Wx::Colour]
383
+ def get_line_colour; end
384
+ alias_method :line_colour, :get_line_colour
385
+
386
+ # Returns background colour of margin.
387
+ # @return [Wx::Colour]
388
+ def get_margin_colour; end
389
+ alias_method :margin_colour, :get_margin_colour
390
+
391
+ # Returns margin width.
392
+ # @return [Integer]
393
+ def get_margin_width; end
394
+ alias_method :margin_width, :get_margin_width
395
+
396
+ # Returns "root property".
397
+ #
398
+ # It does not have name, etc. and it is not visible. It is only useful for accessing its children.
399
+ # @return [Wx::PG::PGProperty]
400
+ def get_root; end
401
+ alias_method :root, :get_root
402
+
403
+ # Returns height of a single grid row (in pixels).
404
+ # @return [Integer]
405
+ def get_row_height; end
406
+ alias_method :row_height, :get_row_height
407
+
408
+ # Returns currently selected property.
409
+ # @return [Wx::PG::PGProperty]
410
+ def get_selected_property; end
411
+ alias_method :selected_property, :get_selected_property
412
+
413
+ # Returns currently selected property.
414
+ # @return [Wx::PG::PGProperty]
415
+ def get_selection; end
416
+ alias_method :selection, :get_selection
417
+
418
+ # Returns current selection background colour.
419
+ # @return [Wx::Colour]
420
+ def get_selection_background_colour; end
421
+ alias_method :selection_background_colour, :get_selection_background_colour
422
+
423
+ # Returns current selection text colour.
424
+ # @return [Wx::Colour]
425
+ def get_selection_foreground_colour; end
426
+ alias_method :selection_foreground_colour, :get_selection_foreground_colour
427
+
428
+ # Returns current splitter x position.
429
+ # @param splitterIndex [Integer]
430
+ # @return [Integer]
431
+ def get_splitter_position(splitterIndex=0) end
432
+ alias_method :splitter_position, :get_splitter_position
433
+
434
+ # Returns {Wx::TextCtrl} active in currently selected property, if any.
435
+ #
436
+ # Takes {Wx::OwnerDrawnComboBox} into account.
437
+ # @return [Wx::TextCtrl]
438
+ def get_editor_text_ctrl; end
439
+ alias_method :editor_text_ctrl, :get_editor_text_ctrl
440
+
441
+ # Returns current appearance of unspecified value cells.
442
+ #
443
+ #
444
+ # @see Wx::PG::PropertyGrid#set_unspecified_value_appearance
445
+ # @return [Wx::PG::PGCell]
446
+ def get_unspecified_value_appearance; end
447
+ alias_method :unspecified_value_appearance, :get_unspecified_value_appearance
448
+
449
+ # Returns (visual) text representation of the unspecified property value.
450
+ # @param argFlags [Integer] For internal use only.
451
+ # @return [String]
452
+ def get_unspecified_value_text(argFlags=0) end
453
+ alias_method :unspecified_value_text, :get_unspecified_value_text
454
+
455
+ # Returns current vertical spacing.
456
+ # @return [Integer]
457
+ def get_vertical_spacing; end
458
+ alias_method :vertical_spacing, :get_vertical_spacing
459
+
460
+ # Returns information about arbitrary position in the grid.
461
+ # @param pt [Array(Integer, Integer), Wx::Point] Coordinates in the virtual grid space. You may need to use Wx::Scrolled<T>#calc_scrolled_position for translating {Wx::PG::PropertyGrid} client coordinates into something this member function can use.
462
+ # @return [Wx::PG::PropertyGridHitTestResult]
463
+ def hit_test(pt) end
464
+
465
+ # Returns true if any property has been modified by the user.
466
+ # @return [Boolean]
467
+ def is_any_modified; end
468
+ alias_method :any_modified?, :is_any_modified
469
+
470
+ # Returns true if a property editor control has focus.
471
+ # @return [Boolean]
472
+ def is_editor_focused; end
473
+ alias_method :editor_focused?, :is_editor_focused
474
+
475
+ # Returns true if updating is frozen (i.e.
476
+ #
477
+ # {Wx::PG::PropertyGrid#freeze} called but not yet {Wx::PG::PropertyGrid#thaw} ).
478
+ # @return [Boolean]
479
+ def is_frozen; end
480
+ alias_method :frozen?, :is_frozen
481
+
482
+ # Makes given column editable by user.
483
+ #
484
+ # Note that column must not be equal to 1, as the second column is always editable and can be made read-only only on cell-by-cell basis using
485
+ # ```ruby
486
+ # # see Wx::PG::PGProperty#change_flag
487
+ # property.change_flag(Wx::PG::PG_PROP_READONLY, true)
488
+ # ```
489
+ # @see Wx::PG::PropertyGrid#begin_label_edit
490
+ # @see Wx::PG::PropertyGrid#end_label_edit
491
+ # @param column [Integer] The index of the column to make editable.
492
+ # @param editable [Boolean] Using false here will disable column from being editable.
493
+ # @return [void]
494
+ def make_column_editable(column, editable=true) end
495
+
496
+ # It is recommended that you call this function any time your code causes {Wx::PG::PropertyGrid}'s top-level parent to change.
497
+ #
498
+ # {Wx::PG::PropertyGrid}'s OnIdle() handler should be able to detect most changes, but it is not perfect.
499
+ #
500
+ # <div class="wxrb-remark">
501
+ # <b>Remark:</b>
502
+ # <p>This function is automatically called from {Wx::PG::PropertyGrid}:: {Wx::PG::PropertyGrid#reparent} and {Wx::PG::PropertyGridManager#reparent}. You only need to use it if you reparent {Wx::PG::PropertyGrid} indirectly.
503
+ # </p>
504
+ # </div>
505
+ # @param newTLP [Wx::Window] New top-level parent that is about to be set. Old top-level parent window should still exist as the current one.
506
+ # @return [void]
507
+ def on_tlp_changing(newTLP) end
508
+
509
+ # Refreshes any active editor control.
510
+ # @return [void]
511
+ def refresh_editor; end
512
+
513
+ # Redraws given property.
514
+ # @param p [Wx::PG::PGProperty]
515
+ # @return [void]
516
+ def refresh_property(p) end
517
+
518
+ # Resets all colours to the original system values.
519
+ # @return [void]
520
+ def reset_colours; end
521
+
522
+ # Resets column sizes and splitter positions, based on proportions.
523
+ #
524
+ #
525
+ # @see Wx::PG::PropertyGridInterface#set_column_proportion
526
+ # @param enableAutoResizing [Boolean] If true, automatic column resizing is enabled (only applicable if window style {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} is used).
527
+ # @return [void]
528
+ def reset_column_sizes(enableAutoResizing=false) end
529
+
530
+ # Removes given property from selection.
531
+ #
532
+ # If property is not selected, an assertion failure will occur.
533
+ # @param id [String,Wx::PG::PGProperty]
534
+ # @return [Boolean]
535
+ def remove_from_selection(id) end
536
+
537
+ # Selects a property.
538
+ #
539
+ # Editor widget is automatically created, but not focused unless focus is true.
540
+ #
541
+ # returns true if selection finished successfully. Usually only fails if current value in editor is not valid.
542
+ #
543
+ # <div class="wxrb-remark">
544
+ # <b>Remark:</b>
545
+ # <p>In wxWidgets 2.9 and later, this function no longer sends {Wx::PG::EVT_PG_SELECTED}.
546
+ # </p>
547
+ # </div>
548
+ #
549
+ # <div class="wxrb-remark">
550
+ # <b>Remark:</b>
551
+ # <p>This clears any previous selection.
552
+ # </p>
553
+ # </div>
554
+ # @see Wx::PG::PropertyGridInterface#clear_selection
555
+ # @param id [String,Wx::PG::PGProperty] Property to select (name or pointer).
556
+ # @param focus [Boolean] If true, move keyboard focus to the created editor right away.
557
+ # @return [Boolean]
558
+ def select_property(id, focus=false) end
559
+
560
+ # Sets category caption background colour.
561
+ # @param col [Wx::Colour,String,Symbol]
562
+ # @return [void]
563
+ def set_caption_background_colour(col) end
564
+ alias_method :caption_background_colour=, :set_caption_background_colour
565
+
566
+ # Sets category caption text colour.
567
+ # @param col [Wx::Colour,String,Symbol]
568
+ # @return [void]
569
+ def set_caption_text_colour(col) end
570
+ alias_method :caption_text_colour=, :set_caption_text_colour
571
+
572
+ # Sets default cell background colour - applies to property cells.
573
+ #
574
+ # Note that appearance of editor widgets may not be affected.
575
+ # @param col [Wx::Colour,String,Symbol]
576
+ # @return [void]
577
+ def set_cell_background_colour(col) end
578
+ alias_method :cell_background_colour=, :set_cell_background_colour
579
+
580
+ # Sets cell text colour for disabled properties.
581
+ # @param col [Wx::Colour,String,Symbol]
582
+ # @return [void]
583
+ def set_cell_disabled_text_colour(col) end
584
+ alias_method :cell_disabled_text_colour=, :set_cell_disabled_text_colour
585
+
586
+ # Sets default cell text colour - applies to property name and value text.
587
+ #
588
+ # Note that appearance of editor widgets may not be affected.
589
+ # @param col [Wx::Colour,String,Symbol]
590
+ # @return [void]
591
+ def set_cell_text_colour(col) end
592
+ alias_method :cell_text_colour=, :set_cell_text_colour
593
+
594
+ # Set number of columns (2 or more).
595
+ # @param colCount [Integer]
596
+ # @return [void]
597
+ def set_column_count(colCount) end
598
+ alias_method :column_count=, :set_column_count
599
+
600
+ # Sets the 'current' category - Append will add non-category properties under it.
601
+ # @param id [String,Wx::PG::PGProperty]
602
+ # @return [void]
603
+ def set_current_category(id) end
604
+ alias_method :current_category=, :set_current_category
605
+
606
+ # Sets colour of empty space below properties.
607
+ # @param col [Wx::Colour,String,Symbol]
608
+ # @return [void]
609
+ def set_empty_space_colour(col) end
610
+ alias_method :empty_space_colour=, :set_empty_space_colour
611
+
612
+ # Sets colour of lines between cells.
613
+ # @param col [Wx::Colour,String,Symbol]
614
+ # @return [void]
615
+ def set_line_colour(col) end
616
+ alias_method :line_colour=, :set_line_colour
617
+
618
+ # Sets background colour of margin.
619
+ # @param col [Wx::Colour,String,Symbol]
620
+ # @return [void]
621
+ def set_margin_colour(col) end
622
+ alias_method :margin_colour=, :set_margin_colour
623
+
624
+ # Set entire new selection from given list of properties.
625
+ # @param newSelection [Array<Wx::PG::PGProperty>]
626
+ # @return [void]
627
+ def set_selection(newSelection) end
628
+ alias_method :selection=, :set_selection
629
+
630
+ # Sets selection background colour - applies to selected property name background.
631
+ # @param col [Wx::Colour,String,Symbol]
632
+ # @return [void]
633
+ def set_selection_background_colour(col) end
634
+ alias_method :selection_background_colour=, :set_selection_background_colour
635
+
636
+ # Sets selection foreground colour - applies to selected property name text.
637
+ # @param col [Wx::Colour,String,Symbol]
638
+ # @return [void]
639
+ def set_selection_text_colour(col) end
640
+ alias_method :selection_text_colour=, :set_selection_text_colour
641
+
642
+ # Sets x coordinate of the splitter.
643
+ #
644
+ # <div class="wxrb-remark">
645
+ # <b>Remark:</b>
646
+ # <p>Splitter position cannot exceed grid size, and therefore setting it during form creation may fail as initial grid size is often smaller than desired splitter position, especially when sizers are being used.
647
+ # </p>
648
+ # </div>
649
+ # @param newxpos [Integer]
650
+ # @param col [Integer]
651
+ # @return [void]
652
+ def set_splitter_position(newxpos, col=0) end
653
+ alias_method :splitter_position=, :set_splitter_position
654
+
655
+ # Moves splitter as left as possible, while still allowing all labels to be shown in full.
656
+ # @param privateChildrenToo [Boolean] If false, will still allow private children to be cropped.
657
+ # @return [void]
658
+ def set_splitter_left(privateChildrenToo=false) end
659
+ alias_method :splitter_left=, :set_splitter_left
660
+
661
+ # Sets appearance of value cells representing an unspecified property value.
662
+ #
663
+ # Default appearance is blank.
664
+ #
665
+ # <div class="wxrb-remark">
666
+ # <b>Remark:</b>
667
+ # <p>If you set the unspecified value to have any textual representation, then that will override "InlineHelp" attribute.
668
+ # </p>
669
+ # </div>
670
+ # @see Wx::PG::PGProperty#set_value_to_unspecified
671
+ # @see Wx::PG::PGProperty#is_value_unspecified
672
+ # @param cell [Wx::PG::PGCell]
673
+ # @return [void]
674
+ def set_unspecified_value_appearance(cell) end
675
+ alias_method :unspecified_value_appearance=, :set_unspecified_value_appearance
676
+
677
+ # Sets vertical spacing.
678
+ #
679
+ # Can be 1, 2, or 3 - a value relative to font height. Value of 2 should be default on most platforms.
680
+ # @param vspacing [Integer]
681
+ # @return [void]
682
+ def set_vertical_spacing(vspacing) end
683
+ alias_method :vertical_spacing=, :set_vertical_spacing
684
+
685
+ # Set virtual width for this particular page.
686
+ #
687
+ # Width -1 indicates that the virtual width should be disabled.
688
+ # @param width [Integer]
689
+ # @return [void]
690
+ def set_virtual_width(width) end
691
+ alias_method :virtual_width=, :set_virtual_width
692
+
693
+ # Must be called in {Wx::PG::PGEditor#create_controls} if primary editor window is {Wx::TextCtrl}, just before textctrl is created.
694
+ # @param text [String] Initial text value of created {Wx::TextCtrl}.
695
+ # @return [void]
696
+ def setup_text_ctrl_value(text) end
697
+
698
+ # Unfocuses or closes editor if one was open, but does not deselect property.
699
+ # @return [Boolean]
700
+ def unfocus_editor; end
701
+
702
+ # Draws item, children, and consecutive parents as long as category is not met.
703
+ # @param p [Wx::PG::PGProperty]
704
+ # @return [void]
705
+ def draw_item_and_value_related(p) end
706
+
707
+ # This static function enables or disables automatic use of {get_translation} for following strings: {Wx::PG::EnumProperty} list labels, {Wx::PG::FlagsProperty} child property labels.
708
+ #
709
+ # Default is false.
710
+ # @param enable [Boolean]
711
+ # @return [void]
712
+ def self.auto_get_translation(enable) end
713
+
714
+ # Registers a new editor class.
715
+ #
716
+ # Returns pointer to the editor class instance that should be used.
717
+ # @param editor [Wx::PG::PGEditor]
718
+ # @param name [String]
719
+ # @return [Wx::PG::PGEditor]
720
+ def self.do_register_editor_class(editor, name) end
721
+
722
+ end # PropertyGrid
623
723
 
624
- # Set entire new selection from given list of properties.
625
- # @param newSelection [Array<Wx::PG::PGProperty>]
626
- # @return [void]
627
- def set_selection(newSelection) end
628
- alias_method :selection=, :set_selection
629
-
630
- # Sets selection background colour - applies to selected property name background.
631
- # @param col [Wx::Colour,String,Symbol]
632
- # @return [void]
633
- def set_selection_background_colour(col) end
634
- alias_method :selection_background_colour=, :set_selection_background_colour
635
-
636
- # Sets selection foreground colour - applies to selected property name text.
637
- # @param col [Wx::Colour,String,Symbol]
638
- # @return [void]
639
- def set_selection_text_colour(col) end
640
- alias_method :selection_text_colour=, :set_selection_text_colour
641
-
642
- # Sets x coordinate of the splitter.
643
- #
644
- # <div class="wxrb-remark">
645
- # <b>Remark:</b>
646
- # <p>Splitter position cannot exceed grid size, and therefore setting it during form creation may fail as initial grid size is often smaller than desired splitter position, especially when sizers are being used.
647
- # </p>
648
- # </div>
649
- # @param newxpos [Integer]
650
- # @param col [Integer]
651
- # @return [void]
652
- def set_splitter_position(newxpos, col=0) end
653
- alias_method :splitter_position=, :set_splitter_position
654
-
655
- # Moves splitter as left as possible, while still allowing all labels to be shown in full.
656
- # @param privateChildrenToo [Boolean] If false, will still allow private children to be cropped.
657
- # @return [void]
658
- def set_splitter_left(privateChildrenToo=false) end
659
- alias_method :splitter_left=, :set_splitter_left
660
-
661
- # Sets appearance of value cells representing an unspecified property value.
662
- #
663
- # Default appearance is blank.
664
- #
665
- # <div class="wxrb-remark">
666
- # <b>Remark:</b>
667
- # <p>If you set the unspecified value to have any textual representation, then that will override "InlineHelp" attribute.
668
- # </p>
669
- # </div>
670
- # @see Wx::PG::PGProperty#set_value_to_unspecified
671
- # @see Wx::PG::PGProperty#is_value_unspecified
672
- # @param cell [Wx::PG::PGCell]
673
- # @return [void]
674
- def set_unspecified_value_appearance(cell) end
675
- alias_method :unspecified_value_appearance=, :set_unspecified_value_appearance
676
-
677
- # Sets vertical spacing.
678
- #
679
- # Can be 1, 2, or 3 - a value relative to font height. Value of 2 should be default on most platforms.
680
- # @param vspacing [Integer]
681
- # @return [void]
682
- def set_vertical_spacing(vspacing) end
683
- alias_method :vertical_spacing=, :set_vertical_spacing
684
-
685
- # Set virtual width for this particular page.
686
- #
687
- # Width -1 indicates that the virtual width should be disabled.
688
- # @param width [Integer]
689
- # @return [void]
690
- def set_virtual_width(width) end
691
- alias_method :virtual_width=, :set_virtual_width
692
-
693
- # Must be called in {Wx::PG::PGEditor#create_controls} if primary editor window is {Wx::TextCtrl}, just before textctrl is created.
694
- # @param text [String] Initial text value of created {Wx::TextCtrl}.
695
- # @return [void]
696
- def setup_text_ctrl_value(text) end
697
-
698
- # Unfocuses or closes editor if one was open, but does not deselect property.
699
- # @return [Boolean]
700
- def unfocus_editor; end
701
-
702
- # Draws item, children, and consecutive parents as long as category is not met.
703
- # @param p [Wx::PG::PGProperty]
704
- # @return [void]
705
- def draw_item_and_value_related(p) end
706
-
707
- # This static function enables or disables automatic use of {get_translation} for following strings: {Wx::PG::EnumProperty} list labels, {Wx::PG::FlagsProperty} child property labels.
708
- #
709
- # Default is false.
710
- # @param enable [Boolean]
711
- # @return [void]
712
- def self.auto_get_translation(enable) end
713
-
714
- # Registers a new editor class.
715
- #
716
- # Returns pointer to the editor class instance that should be used.
717
- # @param editor [Wx::PG::PGEditor]
718
- # @param name [String]
719
- # @return [Wx::PG::PGEditor]
720
- def self.do_register_editor_class(editor, name) end
721
-
722
- end # PropertyGrid
723
-
724
724
 
725
- end
725
+ end
726
+
727
+ end