wxruby3 1.6.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (541) hide show
  1. checksums.yaml +4 -4
  2. data/CREDITS.md +32 -25
  3. data/INSTALL.md +21 -6
  4. data/README.md +5 -5
  5. data/assets/repo-social-preview.odg +0 -0
  6. data/assets/repo-social-preview.xcf +0 -0
  7. data/ext/wxruby3/include/wxRubyApp.h +58 -45
  8. data/ext/wxruby3/include/wxruby-runtime.h +78 -1
  9. data/ext/wxruby3/swig/common.i +2 -2
  10. data/ext/wxruby3/swig/custom/director.swg +2 -2
  11. data/ext/wxruby3/swig/custom/rubyprimtypes.swg +59 -15
  12. data/ext/wxruby3/swig/custom/rubyrun.swg +4 -0
  13. data/ext/wxruby3/swig/custom/rubytracking.swg +4 -0
  14. data/ext/wxruby3/swig/custom/swiglabels.swg +129 -0
  15. data/ext/wxruby3/swig/custom/swigrun.swg +15 -0
  16. data/ext/wxruby3/swig/custom/typemaps/swigtypemaps.swg +20 -0
  17. data/ext/wxruby3/swig/mark_free_impl.i +154 -88
  18. data/ext/wxruby3/swig/memory_management.i +1 -0
  19. data/ext/wxruby3/swig/wx.i +73 -44
  20. data/lib/wx/aui/events/evt_list.rb +148 -0
  21. data/lib/wx/aui/require.rb +0 -1
  22. data/lib/wx/core/calendar_ctrl.rb +15 -0
  23. data/lib/wx/core/clipboard.rb +9 -13
  24. data/lib/wx/core/config.rb +1 -1
  25. data/lib/wx/core/events/evt_list.rb +1458 -0
  26. data/lib/wx/core/font/encoding.rb +113 -0
  27. data/lib/wx/core/generic_validator.rb +83 -31
  28. data/lib/wx/core/tipwindow.rb +16 -0
  29. data/lib/wx/core/variant.rb +6 -0
  30. data/lib/wx/doc/aui/auitabctrl.rb +35 -0
  31. data/lib/wx/doc/config.rb +2 -2
  32. data/lib/wx/doc/functions.rb +1 -1
  33. data/lib/wx/doc/gen/about_dialog_info.rb +330 -0
  34. data/lib/wx/doc/gen/accelerator.rb +178 -0
  35. data/lib/wx/doc/gen/activity_indicator.rb +83 -0
  36. data/lib/wx/doc/gen/affine_matrix2d.rb +284 -0
  37. data/lib/wx/doc/gen/animation.rb +275 -0
  38. data/lib/wx/doc/gen/animation_ctrl.rb +300 -0
  39. data/lib/wx/doc/gen/any_button.rb +191 -0
  40. data/lib/wx/doc/gen/app.rb +463 -0
  41. data/lib/wx/doc/gen/app_traits.rb +396 -0
  42. data/lib/wx/doc/gen/art_provider.rb +605 -0
  43. data/lib/wx/doc/gen/aui/aui_dock_art.rb +455 -0
  44. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +54 -0
  45. data/lib/wx/doc/gen/aui/aui_manager.rb +847 -0
  46. data/lib/wx/doc/gen/aui/aui_manager_event.rb +131 -0
  47. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +180 -0
  48. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +59 -0
  49. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +130 -0
  50. data/lib/wx/doc/gen/aui/aui_notebook.rb +631 -0
  51. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +233 -0
  52. data/lib/wx/doc/gen/aui/aui_pane_info.rb +769 -0
  53. data/lib/wx/doc/gen/aui/aui_tab_art.rb +352 -0
  54. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +14 -0
  55. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +510 -0
  56. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +340 -0
  57. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +244 -0
  58. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +257 -0
  59. data/lib/wx/doc/gen/aui/event_list.rb +179 -0
  60. data/lib/wx/doc/gen/banner_window.rb +124 -0
  61. data/lib/wx/doc/gen/bitmap.rb +731 -0
  62. data/lib/wx/doc/gen/bitmap_button.rb +123 -0
  63. data/lib/wx/doc/gen/bitmap_combo_box.rb +221 -0
  64. data/lib/wx/doc/gen/book_ctrl_base.rb +273 -0
  65. data/lib/wx/doc/gen/book_ctrl_event.rb +66 -0
  66. data/lib/wx/doc/gen/box_sizer.rb +85 -0
  67. data/lib/wx/doc/gen/brush.rb +251 -0
  68. data/lib/wx/doc/gen/busy_info.rb +157 -0
  69. data/lib/wx/doc/gen/button.rb +182 -0
  70. data/lib/wx/doc/gen/calculate_layout_event.rb +62 -0
  71. data/lib/wx/doc/gen/calendar_ctrl.rb +505 -0
  72. data/lib/wx/doc/gen/calendar_date_attr.rb +138 -0
  73. data/lib/wx/doc/gen/calendar_event.rb +147 -0
  74. data/lib/wx/doc/gen/caret.rb +97 -0
  75. data/lib/wx/doc/gen/check_box.rb +175 -0
  76. data/lib/wx/doc/gen/check_list_box.rb +121 -0
  77. data/lib/wx/doc/gen/choice.rb +175 -0
  78. data/lib/wx/doc/gen/choicebook.rb +116 -0
  79. data/lib/wx/doc/gen/client_dc.rb +43 -0
  80. data/lib/wx/doc/gen/clipboard.rb +144 -0
  81. data/lib/wx/doc/gen/collapsible_pane.rb +138 -0
  82. data/lib/wx/doc/gen/collapsible_pane_event.rb +46 -0
  83. data/lib/wx/doc/gen/colour.rb +333 -0
  84. data/lib/wx/doc/gen/colour_dialog.rb +190 -0
  85. data/lib/wx/doc/gen/colour_picker_ctrl.rb +110 -0
  86. data/lib/wx/doc/gen/colour_picker_event.rb +77 -0
  87. data/lib/wx/doc/gen/combo_box.rb +292 -0
  88. data/lib/wx/doc/gen/combo_ctrl.rb +662 -0
  89. data/lib/wx/doc/gen/command_link_button.rb +134 -0
  90. data/lib/wx/doc/gen/config_base.rb +10 -0
  91. data/lib/wx/doc/gen/context_help_button.rb +109 -0
  92. data/lib/wx/doc/gen/control.rb +277 -0
  93. data/lib/wx/doc/gen/control_with_items.rb +253 -0
  94. data/lib/wx/doc/gen/core.rb +45 -0
  95. data/lib/wx/doc/gen/credential_entry_dialog.rb +137 -0
  96. data/lib/wx/doc/gen/cursor.rb +193 -0
  97. data/lib/wx/doc/gen/data_format.rb +85 -0
  98. data/lib/wx/doc/gen/data_object.rb +436 -0
  99. data/lib/wx/doc/gen/data_object_simple_base.rb +10 -0
  100. data/lib/wx/doc/gen/date_event.rb +49 -0
  101. data/lib/wx/doc/gen/date_picker_ctrl.rb +161 -0
  102. data/lib/wx/doc/gen/dc.rb +1631 -0
  103. data/lib/wx/doc/gen/dc_overlay.rb +102 -0
  104. data/lib/wx/doc/gen/defs.rb +2802 -0
  105. data/lib/wx/doc/gen/dial_up_event.rb +45 -0
  106. data/lib/wx/doc/gen/dial_up_manager.rb +149 -0
  107. data/lib/wx/doc/gen/dialog.rb +541 -0
  108. data/lib/wx/doc/gen/dir_dialog.rb +164 -0
  109. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +90 -0
  110. data/lib/wx/doc/gen/dir_picker_ctrl.rb +125 -0
  111. data/lib/wx/doc/gen/display.rb +238 -0
  112. data/lib/wx/doc/gen/drag_drop.rb +299 -0
  113. data/lib/wx/doc/gen/drag_image.rb +116 -0
  114. data/lib/wx/doc/gen/editable_list_box.rb +109 -0
  115. data/lib/wx/doc/gen/event.rb +990 -0
  116. data/lib/wx/doc/gen/event_blocker.rb +50 -0
  117. data/lib/wx/doc/gen/event_filter.rb +92 -0
  118. data/lib/wx/doc/gen/event_list.rb +1644 -0
  119. data/lib/wx/doc/gen/events.rb +2809 -0
  120. data/lib/wx/doc/gen/evt_handler.rb +229 -0
  121. data/lib/wx/doc/gen/ext_help_controller.rb +109 -0
  122. data/lib/wx/doc/gen/file_ctrl.rb +231 -0
  123. data/lib/wx/doc/gen/file_ctrl_event.rb +83 -0
  124. data/lib/wx/doc/gen/file_dialog.rb +353 -0
  125. data/lib/wx/doc/gen/file_dialog_custom_control.rb +165 -0
  126. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +158 -0
  127. data/lib/wx/doc/gen/file_dir_picker_event.rb +100 -0
  128. data/lib/wx/doc/gen/file_picker_ctrl.rb +132 -0
  129. data/lib/wx/doc/gen/file_system.rb +232 -0
  130. data/lib/wx/doc/gen/find_dialog_event.rb +126 -0
  131. data/lib/wx/doc/gen/find_replace_data.rb +60 -0
  132. data/lib/wx/doc/gen/find_replace_dialog.rb +58 -0
  133. data/lib/wx/doc/gen/flex_grid_sizer.rb +199 -0
  134. data/lib/wx/doc/gen/font.rb +1379 -0
  135. data/lib/wx/doc/gen/font_data.rb +151 -0
  136. data/lib/wx/doc/gen/font_dialog.rb +88 -0
  137. data/lib/wx/doc/gen/font_picker_ctrl.rb +143 -0
  138. data/lib/wx/doc/gen/font_picker_event.rb +65 -0
  139. data/lib/wx/doc/gen/frame.rb +352 -0
  140. data/lib/wx/doc/gen/fs_file.rb +337 -0
  141. data/lib/wx/doc/gen/functions.rb +10 -0
  142. data/lib/wx/doc/gen/gauge.rb +157 -0
  143. data/lib/wx/doc/gen/gb_sizer_item.rb +68 -0
  144. data/lib/wx/doc/gen/gcdc.rb +46 -0
  145. data/lib/wx/doc/gen/gdi_common.rb +1271 -0
  146. data/lib/wx/doc/gen/gdi_object.rb +31 -0
  147. data/lib/wx/doc/gen/generic_about_dialog.rb +140 -0
  148. data/lib/wx/doc/gen/generic_dir_ctrl.rb +223 -0
  149. data/lib/wx/doc/gen/geometry.rb +661 -0
  150. data/lib/wx/doc/gen/graphics_context.rb +1184 -0
  151. data/lib/wx/doc/gen/graphics_object.rb +750 -0
  152. data/lib/wx/doc/gen/grid/event_list.rb +191 -0
  153. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +40 -0
  154. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +280 -0
  155. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +35 -0
  156. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +37 -0
  157. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +49 -0
  158. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +35 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +46 -0
  160. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +38 -0
  161. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +45 -0
  162. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +40 -0
  163. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +197 -0
  164. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +39 -0
  165. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +44 -0
  166. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +45 -0
  167. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +79 -0
  168. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +46 -0
  169. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +35 -0
  170. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +108 -0
  171. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +35 -0
  172. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +49 -0
  173. data/lib/wx/doc/gen/grid/grid_ctrl.rb +3002 -0
  174. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +95 -0
  175. data/lib/wx/doc/gen/grid/grid_event.rb +129 -0
  176. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +104 -0
  177. data/lib/wx/doc/gen/grid/grid_size_event.rb +85 -0
  178. data/lib/wx/doc/gen/grid/grid_string_table.rb +142 -0
  179. data/lib/wx/doc/gen/grid/grid_table_base.rb +317 -0
  180. data/lib/wx/doc/gen/grid/grid_table_message.rb +81 -0
  181. data/lib/wx/doc/gen/grid_bag_sizer.rb +323 -0
  182. data/lib/wx/doc/gen/grid_sizer.rb +195 -0
  183. data/lib/wx/doc/gen/gui_event_loop.rb +159 -0
  184. data/lib/wx/doc/gen/h_scrolled_window.rb +562 -0
  185. data/lib/wx/doc/gen/header_ctrl.rb +880 -0
  186. data/lib/wx/doc/gen/header_ctrl_event.rb +133 -0
  187. data/lib/wx/doc/gen/help_controller.rb +195 -0
  188. data/lib/wx/doc/gen/help_provider.rb +98 -0
  189. data/lib/wx/doc/gen/html/event_list.rb +38 -0
  190. data/lib/wx/doc/gen/html/html_cell.rb +536 -0
  191. data/lib/wx/doc/gen/html/html_cell_event.rb +69 -0
  192. data/lib/wx/doc/gen/html/html_data_object.rb +42 -0
  193. data/lib/wx/doc/gen/html/html_easy_printing.rb +203 -0
  194. data/lib/wx/doc/gen/html/html_help_controller.rb +340 -0
  195. data/lib/wx/doc/gen/html/html_help_data.rb +159 -0
  196. data/lib/wx/doc/gen/html/html_help_window.rb +258 -0
  197. data/lib/wx/doc/gen/html/html_link_event.rb +41 -0
  198. data/lib/wx/doc/gen/html/html_list_box.rb +346 -0
  199. data/lib/wx/doc/gen/html/html_printout.rb +109 -0
  200. data/lib/wx/doc/gen/html/html_window.rb +461 -0
  201. data/lib/wx/doc/gen/hyperlink_ctrl.rb +311 -0
  202. data/lib/wx/doc/gen/hyperlink_event.rb +44 -0
  203. data/lib/wx/doc/gen/icon.rb +267 -0
  204. data/lib/wx/doc/gen/icon_location.rb +40 -0
  205. data/lib/wx/doc/gen/image.rb +1371 -0
  206. data/lib/wx/doc/gen/image_list.rb +168 -0
  207. data/lib/wx/doc/gen/info_bar.rb +195 -0
  208. data/lib/wx/doc/gen/keyboard_state.rb +140 -0
  209. data/lib/wx/doc/gen/list_box.rb +304 -0
  210. data/lib/wx/doc/gen/list_ctrl.rb +1774 -0
  211. data/lib/wx/doc/gen/list_event.rb +208 -0
  212. data/lib/wx/doc/gen/listbook.rb +116 -0
  213. data/lib/wx/doc/gen/locale.rb +4293 -0
  214. data/lib/wx/doc/gen/log.rb +603 -0
  215. data/lib/wx/doc/gen/mdi_client_window.rb +47 -0
  216. data/lib/wx/doc/gen/mdi_frame.rb +324 -0
  217. data/lib/wx/doc/gen/media_ctrl.rb +269 -0
  218. data/lib/wx/doc/gen/media_event.rb +117 -0
  219. data/lib/wx/doc/gen/memory_dc.rb +174 -0
  220. data/lib/wx/doc/gen/menu.rb +509 -0
  221. data/lib/wx/doc/gen/menu_bar.rb +287 -0
  222. data/lib/wx/doc/gen/menu_item.rb +362 -0
  223. data/lib/wx/doc/gen/message_dialog.rb +238 -0
  224. data/lib/wx/doc/gen/mini_frame.rb +108 -0
  225. data/lib/wx/doc/gen/mirror_dc.rb +22 -0
  226. data/lib/wx/doc/gen/mouse_state.rb +150 -0
  227. data/lib/wx/doc/gen/multi_choice_dialog.rb +80 -0
  228. data/lib/wx/doc/gen/non_owned_window.rb +49 -0
  229. data/lib/wx/doc/gen/notebook.rb +278 -0
  230. data/lib/wx/doc/gen/num_validator.rb +37 -0
  231. data/lib/wx/doc/gen/number_entry_dialog.rb +93 -0
  232. data/lib/wx/doc/gen/object.rb +59 -0
  233. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +395 -0
  234. data/lib/wx/doc/gen/paint_dc.rb +27 -0
  235. data/lib/wx/doc/gen/palette.rb +92 -0
  236. data/lib/wx/doc/gen/panel.rb +127 -0
  237. data/lib/wx/doc/gen/pen.rb +511 -0
  238. data/lib/wx/doc/gen/persistence_manager.rb +135 -0
  239. data/lib/wx/doc/gen/persistent_object.rb +52 -0
  240. data/lib/wx/doc/gen/persistent_window.rb +241 -0
  241. data/lib/wx/doc/gen/pg/event_list.rb +106 -0
  242. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +54 -0
  243. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +292 -0
  244. data/lib/wx/doc/gen/pg/pg_cell.rb +177 -0
  245. data/lib/wx/doc/gen/pg/pg_editor.rb +721 -0
  246. data/lib/wx/doc/gen/pg/pg_multi_button.rb +152 -0
  247. data/lib/wx/doc/gen/pg/pg_properties.rb +2829 -0
  248. data/lib/wx/doc/gen/pg/pg_property.rb +2078 -0
  249. data/lib/wx/doc/gen/pg/pg_validation_info.rb +344 -0
  250. data/lib/wx/doc/gen/pg/property_grid.rb +740 -0
  251. data/lib/wx/doc/gen/pg/property_grid_event.rb +184 -0
  252. data/lib/wx/doc/gen/pg/property_grid_interface.rb +1098 -0
  253. data/lib/wx/doc/gen/pg/property_grid_manager.rb +415 -0
  254. data/lib/wx/doc/gen/pg/property_grid_page.rb +354 -0
  255. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +165 -0
  256. data/lib/wx/doc/gen/picker_base.rb +152 -0
  257. data/lib/wx/doc/gen/platform_info.rb +622 -0
  258. data/lib/wx/doc/gen/popup_window.rb +107 -0
  259. data/lib/wx/doc/gen/progress_dialog.rb +100 -0
  260. data/lib/wx/doc/gen/property_sheet_dialog.rb +216 -0
  261. data/lib/wx/doc/gen/prt/event_list.rb +17 -0
  262. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +44 -0
  263. data/lib/wx/doc/gen/prt/post_script_dc.rb +30 -0
  264. data/lib/wx/doc/gen/prt/preview_frame.rb +78 -0
  265. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +151 -0
  266. data/lib/wx/doc/gen/prt/print_data.rb +804 -0
  267. data/lib/wx/doc/gen/prt/print_dialog.rb +55 -0
  268. data/lib/wx/doc/gen/prt/printer.rb +518 -0
  269. data/lib/wx/doc/gen/prt/printer_dc.rb +37 -0
  270. data/lib/wx/doc/gen/query_layout_info_event.rb +106 -0
  271. data/lib/wx/doc/gen/radio_box.rb +306 -0
  272. data/lib/wx/doc/gen/radio_button.rb +159 -0
  273. data/lib/wx/doc/gen/rbn/event_list.rb +136 -0
  274. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +1132 -0
  275. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +308 -0
  276. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +45 -0
  277. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +458 -0
  278. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +63 -0
  279. data/lib/wx/doc/gen/rbn/ribbon_control.rb +143 -0
  280. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +229 -0
  281. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +55 -0
  282. data/lib/wx/doc/gen/rbn/ribbon_page.rb +174 -0
  283. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +270 -0
  284. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +45 -0
  285. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +360 -0
  286. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +42 -0
  287. data/lib/wx/doc/gen/rearrange_ctrl.rb +78 -0
  288. data/lib/wx/doc/gen/rearrange_list.rb +123 -0
  289. data/lib/wx/doc/gen/region.rb +380 -0
  290. data/lib/wx/doc/gen/region_iterator.rb +76 -0
  291. data/lib/wx/doc/gen/rich_tool_tip.rb +154 -0
  292. data/lib/wx/doc/gen/rtc/event_list.rb +125 -0
  293. data/lib/wx/doc/gen/rtc/rich_text_box.rb +445 -0
  294. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +1188 -0
  295. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +41 -0
  296. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +538 -0
  297. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +2103 -0
  298. data/lib/wx/doc/gen/rtc/rich_text_event.rb +173 -0
  299. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +181 -0
  300. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +319 -0
  301. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +193 -0
  302. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +102 -0
  303. data/lib/wx/doc/gen/rtc/rich_text_image.rb +337 -0
  304. data/lib/wx/doc/gen/rtc/rich_text_object.rb +2922 -0
  305. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1240 -0
  306. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +258 -0
  307. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +344 -0
  308. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +227 -0
  309. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +59 -0
  310. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +169 -0
  311. data/lib/wx/doc/gen/sash_event.rb +147 -0
  312. data/lib/wx/doc/gen/sash_layout_window.rb +232 -0
  313. data/lib/wx/doc/gen/sash_window.rb +171 -0
  314. data/lib/wx/doc/gen/scaled_dc.rb +10 -0
  315. data/lib/wx/doc/gen/screen_dc.rb +30 -0
  316. data/lib/wx/doc/gen/scroll_bar.rb +204 -0
  317. data/lib/wx/doc/gen/scrolled_canvas.rb +410 -0
  318. data/lib/wx/doc/gen/scrolled_control.rb +410 -0
  319. data/lib/wx/doc/gen/scrolled_window.rb +430 -0
  320. data/lib/wx/doc/gen/search_ctrl.rb +159 -0
  321. data/lib/wx/doc/gen/secret_store.rb +116 -0
  322. data/lib/wx/doc/gen/simplebook.rb +110 -0
  323. data/lib/wx/doc/gen/single_choice_dialog.rb +89 -0
  324. data/lib/wx/doc/gen/sizer.rb +945 -0
  325. data/lib/wx/doc/gen/sizer_item.rb +244 -0
  326. data/lib/wx/doc/gen/slider.rb +342 -0
  327. data/lib/wx/doc/gen/spin_button.rb +157 -0
  328. data/lib/wx/doc/gen/spin_ctrl.rb +231 -0
  329. data/lib/wx/doc/gen/spin_ctrl_double.rb +192 -0
  330. data/lib/wx/doc/gen/spin_double_event.rb +55 -0
  331. data/lib/wx/doc/gen/spin_event.rb +51 -0
  332. data/lib/wx/doc/gen/splash_screen.rb +113 -0
  333. data/lib/wx/doc/gen/splitter_event.rb +99 -0
  334. data/lib/wx/doc/gen/splitter_window.rb +498 -0
  335. data/lib/wx/doc/gen/static_bitmap.rb +256 -0
  336. data/lib/wx/doc/gen/static_box.rb +180 -0
  337. data/lib/wx/doc/gen/static_box_sizer.rb +85 -0
  338. data/lib/wx/doc/gen/static_line.rb +83 -0
  339. data/lib/wx/doc/gen/static_text.rb +127 -0
  340. data/lib/wx/doc/gen/status_bar.rb +290 -0
  341. data/lib/wx/doc/gen/stc/event_list.rb +221 -0
  342. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4474 -0
  343. data/lib/wx/doc/gen/stc/styled_text_event.rb +8762 -0
  344. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +129 -0
  345. data/lib/wx/doc/gen/svg_file_dc.rb +164 -0
  346. data/lib/wx/doc/gen/system_options.rb +129 -0
  347. data/lib/wx/doc/gen/system_settings.rb +507 -0
  348. data/lib/wx/doc/gen/task_bar_icon.rb +127 -0
  349. data/lib/wx/doc/gen/task_bar_icon_event.rb +88 -0
  350. data/lib/wx/doc/gen/text_attr.rb +756 -0
  351. data/lib/wx/doc/gen/text_ctrl.rb +1033 -0
  352. data/lib/wx/doc/gen/text_entry.rb +441 -0
  353. data/lib/wx/doc/gen/text_entry_dialog.rb +220 -0
  354. data/lib/wx/doc/gen/text_validator.rb +245 -0
  355. data/lib/wx/doc/gen/time_picker_ctrl.rb +128 -0
  356. data/lib/wx/doc/gen/timer.rb +119 -0
  357. data/lib/wx/doc/gen/timer_event.rb +68 -0
  358. data/lib/wx/doc/gen/tip_provider.rb +63 -0
  359. data/lib/wx/doc/gen/tip_window.rb +51 -0
  360. data/lib/wx/doc/gen/toggle_button.rb +182 -0
  361. data/lib/wx/doc/gen/tool_bar.rb +890 -0
  362. data/lib/wx/doc/gen/tool_tip.rb +86 -0
  363. data/lib/wx/doc/gen/toolbook.rb +118 -0
  364. data/lib/wx/doc/gen/top_level_window.rb +497 -0
  365. data/lib/wx/doc/gen/tree_ctrl.rb +1052 -0
  366. data/lib/wx/doc/gen/tree_event.rb +127 -0
  367. data/lib/wx/doc/gen/treebook.rb +180 -0
  368. data/lib/wx/doc/gen/ui_action_simulator.rb +109 -0
  369. data/lib/wx/doc/gen/utils.rb +273 -0
  370. data/lib/wx/doc/gen/v_list_box.rb +272 -0
  371. data/lib/wx/doc/gen/v_scrolled_canvas.rb +195 -0
  372. data/lib/wx/doc/gen/v_scrolled_window.rb +191 -0
  373. data/lib/wx/doc/gen/validator.rb +68 -0
  374. data/lib/wx/doc/gen/variant.rb +294 -0
  375. data/lib/wx/doc/gen/window.rb +2917 -0
  376. data/lib/wx/doc/gen/window_dc.rb +38 -0
  377. data/lib/wx/doc/gen/window_disabler.rb +30 -0
  378. data/lib/wx/doc/gen/with_images.rb +84 -0
  379. data/lib/wx/doc/gen/wizard.rb +257 -0
  380. data/lib/wx/doc/gen/wizard_event.rb +113 -0
  381. data/lib/wx/doc/gen/wizard_page.rb +65 -0
  382. data/lib/wx/doc/gen/wizard_page_simple.rb +88 -0
  383. data/lib/wx/doc/gen/wrap_sizer.rb +79 -0
  384. data/lib/wx/doc/gen/xml_node.rb +316 -0
  385. data/lib/wx/doc/gen/xml_resource.rb +320 -0
  386. data/lib/wx/doc/generic_validator.rb +5 -0
  387. data/lib/wx/doc/pg/pg_property.rb +5 -0
  388. data/lib/wx/doc/tip_window.rb +18 -6
  389. data/lib/wx/doc/variant.rb +30 -0
  390. data/lib/wx/grid/events/evt_list.rb +166 -0
  391. data/lib/wx/html/events/evt_list.rb +27 -0
  392. data/lib/wx/html/simple_html_listbox.rb +46 -33
  393. data/lib/wx/keyword_defs.rb +9 -0
  394. data/lib/wx/pg/events/evt_list.rb +73 -0
  395. data/lib/wx/pg/pg_property.rb +85 -52
  396. data/lib/wx/pg/property_grid_interface.rb +12 -2
  397. data/lib/wx/rbn/events/evt_list.rb +102 -0
  398. data/lib/wx/rtc/events/evt_list.rb +98 -0
  399. data/lib/wx/rtc/ext/rich_text_ctrl.rb +24 -0
  400. data/lib/wx/stc/events/evt_list.rb +178 -0
  401. data/lib/wx/version.rb +1 -1
  402. data/lib/wx/wxruby/cmd/setup.rb +6 -0
  403. data/rakelib/configure.rb +9 -0
  404. data/rakelib/gem.rake +84 -66
  405. data/rakelib/gem.rb +4 -20
  406. data/rakelib/lib/config/linux.rb +1 -1
  407. data/rakelib/lib/config/macosx.rb +15 -1
  408. data/rakelib/lib/config/pkgman/linux.rb +7 -2
  409. data/rakelib/lib/config/unixish.rb +3 -3
  410. data/rakelib/lib/config.rb +19 -8
  411. data/rakelib/lib/core/include/swigdirector.inc +3 -3
  412. data/rakelib/lib/core/include/swigrubyerrors.inc +4 -8
  413. data/rakelib/lib/core/include/swigrubyrun.inc +20 -4
  414. data/rakelib/lib/core/include/swigrun.inc +189 -0
  415. data/rakelib/lib/core/package.rb +3 -1
  416. data/rakelib/lib/core/spec.rb +1 -1
  417. data/rakelib/lib/director/accelerator.rb +1 -1
  418. data/rakelib/lib/director/animation.rb +1 -0
  419. data/rakelib/lib/director/app_traits.rb +1 -1
  420. data/rakelib/lib/director/aui_manager.rb +21 -14
  421. data/rakelib/lib/director/aui_mdi_child_frame.rb +2 -0
  422. data/rakelib/lib/director/aui_mdi_parent_frame.rb +4 -0
  423. data/rakelib/lib/director/aui_notebook.rb +20 -3
  424. data/rakelib/lib/director/aui_tab_ctrl.rb +64 -106
  425. data/rakelib/lib/director/bitmap_combobox.rb +4 -2
  426. data/rakelib/lib/director/calendar_ctrl.rb +72 -14
  427. data/rakelib/lib/director/clipboard.rb +2 -0
  428. data/rakelib/lib/director/data_object.rb +15 -7
  429. data/rakelib/lib/director/date_picker_ctrl.rb +4 -1
  430. data/rakelib/lib/director/display.rb +81 -0
  431. data/rakelib/lib/director/event.rb +33 -16
  432. data/rakelib/lib/director/event_handler.rb +27 -2
  433. data/rakelib/lib/director/functions.rb +9 -0
  434. data/rakelib/lib/director/geometry.rb +5 -0
  435. data/rakelib/lib/director/grid_ctrl.rb +123 -28
  436. data/rakelib/lib/director/help_provider.rb +1 -1
  437. data/rakelib/lib/director/html_listbox.rb +30 -4
  438. data/rakelib/lib/director/hvscrolled.rb +154 -0
  439. data/rakelib/lib/director/image_list.rb +1 -0
  440. data/rakelib/lib/director/mdi_frame.rb +4 -0
  441. data/rakelib/lib/director/menu.rb +56 -15
  442. data/rakelib/lib/director/menu_bar.rb +62 -0
  443. data/rakelib/lib/director/menu_item.rb +7 -1
  444. data/rakelib/lib/director/num_validator.rb +27 -0
  445. data/rakelib/lib/director/numeric_property_validator.rb +9 -0
  446. data/rakelib/lib/director/persistent_window.rb +16 -0
  447. data/rakelib/lib/director/pgproperty.rb +3 -2
  448. data/rakelib/lib/director/popup_window.rb +2 -0
  449. data/rakelib/lib/director/preview_frame.rb +29 -6
  450. data/rakelib/lib/director/printer.rb +59 -5
  451. data/rakelib/lib/director/property_grid.rb +37 -18
  452. data/rakelib/lib/director/property_grid_interface.rb +10 -8
  453. data/rakelib/lib/director/property_grid_manager.rb +99 -39
  454. data/rakelib/lib/director/property_grid_page.rb +60 -0
  455. data/rakelib/lib/director/rich_tooltip.rb +22 -0
  456. data/rakelib/lib/director/richtext_ctrl.rb +5 -0
  457. data/rakelib/lib/director/richtext_object.rb +13 -4
  458. data/rakelib/lib/director/richtext_style_listbox.rb +11 -2
  459. data/rakelib/lib/director/scrolled_t.rb +3 -0
  460. data/rakelib/lib/director/searchctrl.rb +1 -0
  461. data/rakelib/lib/director/task_bar_icon.rb +14 -8
  462. data/rakelib/lib/director/text_validator.rb +9 -0
  463. data/rakelib/lib/director/tip_window.rb +117 -6
  464. data/rakelib/lib/director/tool_bar.rb +6 -0
  465. data/rakelib/lib/director/top_level_window.rb +0 -1
  466. data/rakelib/lib/director/utils.rb +3 -1
  467. data/rakelib/lib/director/validator.rb +12 -0
  468. data/rakelib/lib/director/variant.rb +64 -20
  469. data/rakelib/lib/director/vlistbox.rb +29 -22
  470. data/rakelib/lib/director/window.rb +12 -2
  471. data/rakelib/lib/director/xml_resource.rb +6 -0
  472. data/rakelib/lib/generate/doc/aui_manager.yaml +1 -1
  473. data/rakelib/lib/generate/doc/rich_tool_tip.yaml +26 -0
  474. data/rakelib/lib/generate/doc.rb +12 -7
  475. data/rakelib/lib/generate/interface.rb +16 -1
  476. data/rakelib/lib/specs/interfaces.rb +6 -2
  477. data/rakelib/lib/swig_runner.rb +12 -12
  478. data/rakelib/lib/typemap/aui_tabctrl.rb +46 -0
  479. data/rakelib/lib/typemap/common.rb +3 -3
  480. data/rakelib/lib/typemap/print_page_range.rb +32 -8
  481. data/samples/art/wxruby-512x512.png +0 -0
  482. data/samples/calendar/calendar.rb +64 -1
  483. data/samples/dialogs/dialogs.rb +172 -0
  484. data/samples/dialogs/tip.xpm +157 -0
  485. data/samples/drawing/maths_images.rb +1 -1
  486. data/samples/event/event.rb +1 -1
  487. data/samples/printing/printing2.rb +1 -1
  488. data/samples/sampler.rb +26 -8
  489. data/samples/text/textctrl.rb +2 -2
  490. data/samples/treectrl/treectrl.rb +2 -2
  491. data/tests/lib/leaked_process_event_exception_test.rb +1 -1
  492. data/tests/lib/leaked_queued_event_exception_test.rb +1 -1
  493. data/tests/lib/wxapp_runner.rb +31 -41
  494. data/tests/lib/wxframe_runner.rb +23 -11
  495. data/tests/lib/wxrb_test.rb +58 -0
  496. data/tests/test_app_event_filter.rb +1 -1
  497. data/tests/test_app_exit_exception.rb +3 -3
  498. data/tests/test_app_init_exception.rb +3 -3
  499. data/tests/test_app_traits.rb +24 -21
  500. data/tests/test_art.rb +7 -7
  501. data/tests/test_art_provider.rb +1 -1
  502. data/tests/test_basic.rb +2 -2
  503. data/tests/test_book_controls.rb +1 -1
  504. data/tests/test_box_sizer.rb +1 -1
  505. data/tests/test_clipboard.rb +5 -5
  506. data/tests/test_combo_ctrl.rb +2 -2
  507. data/tests/test_config.rb +11 -1
  508. data/tests/test_dc.rb +1 -1
  509. data/tests/test_dialog.rb +1 -1
  510. data/tests/test_event_handling.rb +1 -1
  511. data/tests/test_events.rb +1 -1
  512. data/tests/test_exceptions.rb +2 -2
  513. data/tests/test_ext_controls.rb +10 -10
  514. data/tests/test_file_dialog.rb +1 -1
  515. data/tests/test_font.rb +1 -1
  516. data/tests/test_gdi_object.rb +1 -1
  517. data/tests/test_geometry.rb +2 -2
  518. data/tests/test_grid_sizer.rb +2 -2
  519. data/tests/test_intl.rb +1 -1
  520. data/tests/test_item_data.rb +12 -12
  521. data/tests/test_list_ctrl.rb +1 -1
  522. data/tests/test_log.rb +2 -2
  523. data/tests/test_media_ctrl.rb +1 -1
  524. data/tests/test_menu.rb +114 -43
  525. data/tests/test_proof_check.rb +1 -1
  526. data/tests/test_propgrid.rb +857 -0
  527. data/tests/test_richtext.rb +10 -24
  528. data/tests/test_secret_store.rb +1 -1
  529. data/tests/test_sizer.rb +1 -1
  530. data/tests/test_std_controls.rb +8 -8
  531. data/tests/test_styled_text_ctrl.rb +1 -1
  532. data/tests/test_timer.rb +1 -1
  533. data/tests/test_tree_ctrl.rb +1 -1
  534. data/tests/test_validators.rb +79 -36
  535. data/tests/test_variant.rb +1 -1
  536. data/tests/test_window.rb +11 -11
  537. data/tests/testapp.rb +2 -2
  538. data/tests/testapp_noframe.rb +2 -2
  539. metadata +402 -12
  540. data/lib/wx/aui/aui_tab_ctrl.rb +0 -18
  541. data/rakelib/lib/director/hvscrolled_window.rb +0 -140
@@ -0,0 +1,2078 @@
1
+ # :stopdoc:
2
+ # This file is automatically generated by the WXRuby3 documentation
3
+ # generator. Do not alter this file.
4
+ # :startdoc:
5
+
6
+
7
+ module Wx
8
+
9
+ module PG
10
+
11
+ #
12
+ #
13
+ #
14
+ #
15
+ # @wxrb_require USE_PROPGRID
16
+ class PGPropertyValuesFlags < Wx::Enum
17
+
18
+ # Flag for {Wx::PG::PropertyGridInterface::SetProperty}* functions, {Wx::PG::PropertyGridInterface#hide_property}, etc.
19
+ #
20
+ DontRecurse = Wx::PG::PGPropertyValuesFlags.new(0)
21
+
22
+ # Flag for {Wx::PG::PropertyGridInterface#get_property_values}.
23
+ #
24
+ KeepStructure = Wx::PG::PGPropertyValuesFlags.new(16)
25
+
26
+ # Flag for {Wx::PG::PropertyGridInterface::SetProperty}* functions, {Wx::PG::PropertyGridInterface#hide_property}, etc.
27
+ #
28
+ Recurse = Wx::PG::PGPropertyValuesFlags.new(32)
29
+
30
+ # Flag for {Wx::PG::PropertyGridInterface#get_property_values}.
31
+ #
32
+ IncAttributes = Wx::PG::PGPropertyValuesFlags.new(64)
33
+
34
+ # Used when first starting recursion.
35
+ #
36
+ RecurseStarts = Wx::PG::PGPropertyValuesFlags.new(128)
37
+
38
+ # Force value change.
39
+ #
40
+ Force = Wx::PG::PGPropertyValuesFlags.new(256)
41
+
42
+ # Only sort categories and their immediate children.
43
+ #
44
+ SortTopLevelOnly = Wx::PG::PGPropertyValuesFlags.new(512)
45
+
46
+ end # PGPropertyValuesFlags
47
+
48
+ # Miscellaneous property value format flags.
49
+ #
50
+ #
51
+ #
52
+ # @wxrb_require USE_PROPGRID
53
+ class PGPropValFormatFlags < Wx::Enum
54
+
55
+ # No flags.
56
+ #
57
+ Null = Wx::PG::PGPropValFormatFlags.new(0)
58
+
59
+ # Get/Store full value instead of displayed value.
60
+ #
61
+ FullValue = Wx::PG::PGPropValFormatFlags.new(1)
62
+
63
+ # Perform special action in case of unsuccessful conversion.
64
+ #
65
+ ReportError = Wx::PG::PGPropValFormatFlags.new(2)
66
+
67
+ #
68
+ #
69
+ PropertySpecific = Wx::PG::PGPropValFormatFlags.new(4)
70
+
71
+ # Get/Store editable value instead of displayed one (should only be different in the case of common values).
72
+ #
73
+ EditableValue = Wx::PG::PGPropValFormatFlags.new(8)
74
+
75
+ # Used when dealing with fragments of composite string value.
76
+ #
77
+ CompositeFragment = Wx::PG::PGPropValFormatFlags.new(16)
78
+
79
+ # Means property for which final string value is for cannot really be edited.
80
+ #
81
+ UneditableCompositeFragment = Wx::PG::PGPropValFormatFlags.new(32)
82
+
83
+ # {Wx::PG::PGProperty#value_to_string} called from {Wx::PG::PGProperty#get_value_as_string} (guarantees that input {Wx::Variant} value is current own value)
84
+ #
85
+ ValueIsCurrent = Wx::PG::PGPropValFormatFlags.new(64)
86
+
87
+ # Value is being set programmatically (i.e.
88
+ #
89
+ ProgrammaticValue = Wx::PG::PGPropValFormatFlags.new(128)
90
+
91
+ end # PGPropValFormatFlags
92
+
93
+ # {Wx::PG::PGProperty#set_value} flags
94
+ #
95
+ #
96
+ #
97
+ # @wxrb_require USE_PROPGRID
98
+ class PGSetValueFlags < Wx::Enum
99
+
100
+ #
101
+ #
102
+ RefreshEditor = Wx::PG::PGSetValueFlags.new(1)
103
+
104
+ #
105
+ #
106
+ Aggregated = Wx::PG::PGSetValueFlags.new(2)
107
+
108
+ #
109
+ #
110
+ FromParent = Wx::PG::PGSetValueFlags.new(4)
111
+
112
+ # Set if value changed by user.
113
+ #
114
+ ByUser = Wx::PG::PGSetValueFlags.new(8)
115
+
116
+ end # PGSetValueFlags
117
+
118
+ # Used to indicate {Wx::PG::PGChoices#add} etc that the value is actually not given by the caller.
119
+ #
120
+ PG_INVALID_VALUE = 2147483647
121
+
122
+ # Constant for {Wx::PG::PG_UINT_BASE} attribute.
123
+ #
124
+ PG_BASE_OCT = 8
125
+
126
+ # Constant for {Wx::PG::PG_UINT_BASE} attribute.
127
+ #
128
+ PG_BASE_DEC = 10
129
+
130
+ # Constant for {Wx::PG::PG_UINT_BASE} attribute.
131
+ #
132
+ PG_BASE_HEX = 16
133
+
134
+ # Constant for {Wx::PG::PG_UINT_BASE} attribute.
135
+ #
136
+ PG_BASE_HEXL = 32
137
+
138
+ # Constant for {Wx::PG::PG_UINT_PREFIX} attribute.
139
+ #
140
+ PG_PREFIX_NONE = 0
141
+
142
+ # Constant for {Wx::PG::PG_UINT_PREFIX} attribute.
143
+ #
144
+ PG_PREFIX_0X = 1
145
+
146
+ # Constant for {Wx::PG::PG_UINT_PREFIX} attribute.
147
+ #
148
+ PG_PREFIX_DOLLAR_SIGN = 2
149
+
150
+ #
151
+ PG_ATTR_DEFAULT_VALUE = "DefaultValue"
152
+
153
+ #
154
+ PG_ATTR_MIN = "Min"
155
+
156
+ #
157
+ PG_ATTR_MAX = "Max"
158
+
159
+ #
160
+ PG_ATTR_UNITS = "Units"
161
+
162
+ #
163
+ PG_ATTR_HINT = "Hint"
164
+
165
+ #
166
+ PG_ATTR_AUTOCOMPLETE = "AutoComplete"
167
+
168
+ #
169
+ PG_BOOL_USE_CHECKBOX = "UseCheckbox"
170
+
171
+ #
172
+ PG_BOOL_USE_DOUBLE_CLICK_CYCLING = "UseDClickCycling"
173
+
174
+ #
175
+ PG_FLOAT_PRECISION = "Precision"
176
+
177
+ #
178
+ PG_STRING_PASSWORD = "Password"
179
+
180
+ #
181
+ PG_UINT_BASE = "Base"
182
+
183
+ #
184
+ PG_UINT_PREFIX = "Prefix"
185
+
186
+ #
187
+ PG_DIALOG_TITLE = "DialogTitle"
188
+
189
+ #
190
+ PG_FILE_WILDCARD = "Wildcard"
191
+
192
+ #
193
+ PG_FILE_SHOW_FULL_PATH = "ShowFullPath"
194
+
195
+ #
196
+ PG_FILE_SHOW_RELATIVE_PATH = "ShowRelativePath"
197
+
198
+ #
199
+ PG_FILE_INITIAL_PATH = "InitialPath"
200
+
201
+ #
202
+ PG_FILE_DIALOG_STYLE = "DialogStyle"
203
+
204
+ #
205
+ PG_ARRAY_DELIMITER = "Delimiter"
206
+
207
+ #
208
+ PG_DATE_FORMAT = "DateFormat"
209
+
210
+ #
211
+ PG_DATE_PICKER_STYLE = "PickerStyle"
212
+
213
+ #
214
+ PG_ATTR_SPINCTRL_STEP = "Step"
215
+
216
+ #
217
+ PG_ATTR_SPINCTRL_WRAP = "Wrap"
218
+
219
+ #
220
+ PG_ATTR_SPINCTRL_MOTION = "MotionSpin"
221
+
222
+ #
223
+ PG_ATTR_MULTICHOICE_USERSTRINGMODE = "UserStringMode"
224
+
225
+ #
226
+ PG_COLOUR_ALLOW_CUSTOM = "AllowCustom"
227
+
228
+ #
229
+ PG_COLOUR_HAS_ALPHA = "HasAlpha"
230
+
231
+ # Strongly typed enums containing properties flags.
232
+ #
233
+ # ## wxPGProperty Flags
234
+ # Note that this replaces {Wx::PG::PGPropertyFlags} enum used in previous wxWidgets versions which defined the same flags using {Wx::PG_PROP_XXX} naming convention.
235
+ #
236
+ # @wxrb_require USE_PROPGRID
237
+ class PGFlags < Wx::Enum
238
+
239
+ # No flags.
240
+ #
241
+ Null = Wx::PG::PGFlags.new(0)
242
+
243
+ # Indicates bold font.
244
+ #
245
+ Modified = Wx::PG::PGFlags.new(1)
246
+
247
+ # Disables ('greyed' text and editor does not activate) property.
248
+ #
249
+ Disabled = Wx::PG::PGFlags.new(2)
250
+
251
+ # Hider button will hide this property.
252
+ #
253
+ Hidden = Wx::PG::PGFlags.new(4)
254
+
255
+ # This property has custom paint image just in front of its value.
256
+ #
257
+ CustomImage = Wx::PG::PGFlags.new(8)
258
+
259
+ # Do not create text based editor for this property (but button-triggered dialog and choice are ok).
260
+ #
261
+ NoEditor = Wx::PG::PGFlags.new(16)
262
+
263
+ # Property is collapsed, ie.
264
+ #
265
+ Collapsed = Wx::PG::PGFlags.new(32)
266
+
267
+ # If property is selected, then indicates that validation failed for pending value.
268
+ #
269
+ InvalidValue = Wx::PG::PGFlags.new(64)
270
+
271
+ # Switched via SetWasModified().
272
+ #
273
+ WasModified = Wx::PG::PGFlags.new(512)
274
+
275
+ # If set, then child properties (if any) are private, and should be "invisible" to the application.
276
+ #
277
+ Aggregate = Wx::PG::PGFlags.new(1024)
278
+
279
+ # If set, then child properties (if any) are copies and should not be deleted in dtor.
280
+ #
281
+ ChildrenAreCopies = Wx::PG::PGFlags.new(2048)
282
+
283
+ # Classifies this item as a non-category.
284
+ #
285
+ Property = Wx::PG::PGFlags.new(4096)
286
+
287
+ # Classifies this item as a category.
288
+ #
289
+ Category = Wx::PG::PGFlags.new(8192)
290
+
291
+ # Classifies this item as a property that has children, but is not aggregate (i.e.
292
+ #
293
+ MiscParent = Wx::PG::PGFlags.new(16384)
294
+
295
+ # Property is read-only.
296
+ #
297
+ ReadOnly = Wx::PG::PGFlags.new(32768)
298
+
299
+ # Property's value is composed from values of child properties.
300
+ #
301
+ ComposedValue = Wx::PG::PGFlags.new(65536)
302
+
303
+ # Common value of property is selectable in editor.
304
+ #
305
+ UsesCommonValue = Wx::PG::PGFlags.new(131072)
306
+
307
+ # Property can be set to unspecified value via editor.
308
+ #
309
+ BeingDeleted = Wx::PG::PGFlags.new(524288)
310
+
311
+ # If set, full path is shown in {Wx::PG::FileProperty}.
312
+ #
313
+ ShowFullFileName = Wx::PG::PGFlags.new(1048576)
314
+
315
+ # Topmost flag.
316
+ #
317
+ Max = Wx::PG::PGFlags.new(1048576)
318
+
319
+ # Property with children must have one of these set, otherwise iterators will not work correctly.
320
+ #
321
+ ParentalFlags = Wx::PG::PGFlags.new(25600)
322
+
323
+ # Combination of flags that can be stored by GetFlagsAsString().
324
+ #
325
+ StringStoredFlags = Wx::PG::PGFlags.new(54)
326
+
327
+ end # PGFlags
328
+
329
+ # {Wx::PG::PGProperty} is base class for all {Wx::PG::PropertyGrid} properties and as such it is not intended to be instantiated directly.
330
+ #
331
+ # In sections below we cover few related topics.
332
+ #
333
+ # - Supplied Ready-to-use Property Classes
334
+ #
335
+ # - Creating Custom Properties
336
+ #
337
+ # ## Supplied Ready-to-use Property Classes
338
+ # Here is a list and short description of supplied fully-functional property classes. They are located in either {Wx::props.h} or {Wx::advprops.h}.
339
+ #
340
+ # - {Wx::PG::ArrayStringProperty}
341
+ #
342
+ # - {Wx::PG::BoolProperty}
343
+ #
344
+ # - {Wx::PG::ColourProperty}
345
+ #
346
+ # - {Wx::PG::CursorProperty}
347
+ #
348
+ # - {Wx::PG::DateProperty}
349
+ #
350
+ # - {Wx::PG::DirProperty}
351
+ #
352
+ # - {Wx::PG::EditEnumProperty}
353
+ #
354
+ # - {Wx::PG::EnumProperty}
355
+ #
356
+ # - {Wx::PG::FileProperty}
357
+ #
358
+ # - {Wx::PG::FlagsProperty}
359
+ #
360
+ # - {Wx::PG::FloatProperty}
361
+ #
362
+ # - {Wx::PG::FontProperty}
363
+ #
364
+ # - {Wx::PG::ImageFileProperty}
365
+ #
366
+ # - {Wx::PG::IntProperty}
367
+ #
368
+ # - {Wx::PG::LongStringProperty}
369
+ #
370
+ # - {Wx::PG::MultiChoiceProperty}
371
+ #
372
+ # - {Wx::PG::PropertyCategory}
373
+ #
374
+ # - {Wx::PG::StringProperty}
375
+ #
376
+ # - {Wx::PG::SystemColourProperty}
377
+ #
378
+ # - {Wx::PG::UIntProperty}
379
+ #
380
+ # ## wxPropertyCategory
381
+ # Not an actual property per se, but a header for a group of properties. Regardless inherits from {Wx::PG::PGProperty}, and supports displaying 'labels' for columns other than the first one. Easiest way to set category's label for second column is to call {Wx::PG::PGProperty#set_value} with string argument.
382
+ #
383
+ # ## wxStringProperty
384
+ # Simple string property.
385
+ # Supported special attributes:
386
+ #
387
+ # - {Wx::PG::PG_STRING_PASSWORD}: Set to true in order to echo value as asterisks and to use {Wx::TE_PASSWORD} on the editor ({Wx::TextCtrl}).
388
+ # - {Wx::PG::PG_ATTR_AUTOCOMPLETE}: Set to true to enable auto-completion (use a {Wx::ArrayString} value), and is also supported by any property that happens to use a {Wx::TextCtrl}-based editor.
389
+ #
390
+ # <div class="wxrb-remark">
391
+ # <b>Remark:</b>
392
+ # <p>{Wx::PG::StringProperty} has a special trait: if it has value of "<composed>", and also has child properties, then its displayed value becomes composition of child property values, similar as with {Wx::PG::FontProperty}, for instance.
393
+ # </p>
394
+ # </div>
395
+ #
396
+ # ## Wx::PG::IntProperty
397
+ #
398
+ # It derives from {Wx::PG::NumericProperty} and displays value as a signed long integer.
399
+ # Supported special attributes:
400
+ #
401
+ # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX} to specify acceptable value range.
402
+ # - {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters.
403
+ #
404
+ # ## Wx::PG::UIntProperty
405
+ #
406
+ # Like {Wx::PG::IntProperty}, but displays value as unsigned int. To set the prefix used globally, manipulate {Wx::PG::PG_UINT_PREFIX} string attribute. To set the globally used base, manipulate {Wx::PG::PG_UINT_BASE} int attribute. Regardless of current prefix, understands (hex) values starting with both "0x" and "$" (apart from edit mode). Like {Wx::PG::IntProperty}, {Wx::PG::UIntProperty} seamlessly supports 64-bit unsigned integers (i.e. {Wx::ULongLong}). Same {Wx::Variant} safety rules apply.
407
+ # Supported special attributes:
408
+ #
409
+ # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}: Specifies acceptable value range.
410
+ # - {Wx::PG::PG_UINT_BASE}: Defines base. Valid constants are {Wx::PG::PG_BASE_OCT}, {Wx::PG::PG_BASE_DEC}, {Wx::PG::PG_BASE_HEX} and {Wx::PG::PG_BASE_HEXL} (lowercase characters). Arbitrary bases are <b>not</b> supported.
411
+ # - {Wx::PG::PG_UINT_PREFIX}: Defines displayed prefix. Possible values are {Wx::PG::PG_PREFIX_NONE}, {Wx::PG_PREFIX_0X} and {Wx::PG::PG_PREFIX_DOLLAR_SIGN}. Only {Wx::PG::PG_PREFIX_NONE} works with decimal and octal numbers.
412
+ # - {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters.
413
+ #
414
+ # <div class="wxrb-remark">
415
+ # <b>Remark:</b>
416
+ # <p>For example how to use seamless 64-bit integer support, see {Wx::PG::IntProperty} documentation (just use {Wx::ULongLong} instead of {Wx::LongLong}).
417
+ # </p>
418
+ # </div>
419
+ #
420
+ # ## wxFloatProperty
421
+ # Like {Wx::PG::StringProperty}, but converts text to a double-precision floating point. Default float-to-text precision is 6 decimals, but this can be changed by modifying {Wx::PG::PG_FLOAT_PRECISION} attribute.
422
+ # Note that when displaying the value, sign is omitted if the resulting textual representation is effectively zero (for example, -0.0001 with precision of 3 will become 0.0 instead of -0.0). This behaviour is unlike what C standard library does, but should result in better end-user experience in almost all cases.
423
+ # Supported special attributes:
424
+ #
425
+ # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}: Specifies acceptable value range.
426
+ # - {Wx::PG::PG_FLOAT_PRECISION}: Sets the (max) precision used when floating point value is rendered as text. The default -1 means shortest floating-point 6-digit representation.
427
+ # - {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters.
428
+ #
429
+ # ## wxBoolProperty
430
+ # Represents a boolean value. {Wx::Choice} is used as editor control, by the default. {Wx::PG::PG_BOOL_USE_CHECKBOX} attribute can be set to true in order to use check box instead.
431
+ # Supported special attributes:
432
+ #
433
+ # - {Wx::PG::PG_BOOL_USE_CHECKBOX}: If set to true uses check box editor instead of combo box.
434
+ # - {Wx::PG::PG_BOOL_USE_DOUBLE_CLICK_CYCLING}: If set to true cycles combo box instead showing the list.
435
+ #
436
+ # ## wxLongStringProperty
437
+ # Like {Wx::PG::StringProperty}, but has a button that triggers a small text editor dialog. Note that in long string values, some control characters are escaped: tab is represented by <code>"\t"</code>, line break by <code>"\n"</code>, carriage return by <code>"\r"</code> and backslash characters are doubled. If another character is preceded by backslash, the backslash is skipped.
438
+ # Note also that depending on the system (port), some sequences of special characters, like e.g. <code>"\r\n"</code>, can be interpreted and presented in a different way in the editor and therefore such sequences may not be the same before and after the edition.
439
+ # To display a custom dialog on button press, you can subclass {Wx::PG::LongStringProperty} and override DisplayEditorDialog, like this:
440
+ #
441
+ # ```
442
+ # bool DisplayEditorDialog( wxPropertyGrid* propGrid, wxVariant& value ) override
443
+ # {
444
+ # wxSize dialogSize(...size of your dialog...);
445
+ #
446
+ # wxPoint dlgPos = propGrid->GetGoodEditorDialogPosition(this,
447
+ # dialogSize)
448
+ #
449
+ # // Create dialog dlg at dlgPos. Use value as initial string
450
+ # // value.
451
+ # ...
452
+ #
453
+ # if ( dlg.ShowModal() == wxID_OK )
454
+ # {
455
+ # value = dlg.GetStringValue);
456
+ # return true;
457
+ # }
458
+ # return false;
459
+ # }
460
+ # ```
461
+ #
462
+ # Supported special attributes:
463
+ #
464
+ # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the text editor dialog.
465
+ #
466
+ # ## wxDirProperty
467
+ # Like {Wx::PG::LongStringProperty}, but the button triggers dir selector instead.
468
+ # Supported special attributes:
469
+ #
470
+ # - {Wx::PG::PG_DIALOG_TITLE}: Sets specific title for the dir selector.
471
+ #
472
+ # ## wxFileProperty
473
+ # Like {Wx::PG::LongStringProperty}, but the button triggers file selector instead. Default wildcard is "All files..." but this can be changed by setting {Wx::PG::PG_FILE_WILDCARD} attribute.
474
+ # Supported special attributes:
475
+ #
476
+ # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the file dialog.
477
+ # - {Wx::PG::PG_FILE_DIALOG_STYLE}: Sets a specific {Wx::FileDialog} style for the file dialog.
478
+ # - {Wx::PG::PG_FILE_WILDCARD}: Sets wildcard (see {Wx::FileDialog} for format details), "All
479
+ # files..." is default.
480
+ # - {Wx::PG::PG_FILE_SHOW_FULL_PATH}: Default true. When false, only the file name is shown (i.e. drive and directory are hidden).
481
+ # - {Wx::PG::PG_FILE_SHOW_RELATIVE_PATH}: If set, then the filename is shown relative to the given path string.
482
+ # - {Wx::PG::PG_FILE_INITIAL_PATH}: Sets the initial path of where to look for files.
483
+ #
484
+ # ## wxEnumProperty
485
+ # Represents a single selection from a list of choices - {Wx::OwnerDrawnComboBox} is used to edit the value.
486
+ #
487
+ # ## wxFlagsProperty
488
+ # Represents a bit set that fits in a long integer. {Wx::PG::BoolProperty} sub- properties are created for editing individual bits. Textctrl is created to manually edit the flags as a text; a continuous sequence of spaces, commas and semicolons are considered as a flag id separator.
489
+ # <b>Note:</b> When changing "choices" (i.e. flag labels) of {Wx::PG::FlagsProperty}, you will need to use {Wx::PG::PGProperty#set_choices} - otherwise they will not get updated properly.
490
+ # {Wx::PG::FlagsProperty} supports the same attributes as {Wx::PG::BoolProperty}.
491
+ #
492
+ # ## wxArrayStringProperty
493
+ # Property that manages a list of strings. Allows editing of a list of strings in {Wx::TextCtrl} and in a separate dialog.
494
+ # Supported special attributes:
495
+ #
496
+ # - {Wx::PG::PG_ARRAY_DELIMITER}: Sets string delimiter character.
497
+ # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the editor dialog. Default is comma (',').
498
+ #
499
+ # ## wxDateProperty
500
+ # Property representing {Wx::DateTime}. Default editor is DatePickerCtrl, although TextCtrl should work as well.
501
+ # Supported special attributes:
502
+ #
503
+ # - {Wx::PG::PG_DATE_FORMAT}: Determines displayed date format (with Wx::DateTime::Format). Default is recommended as it is locale-dependent.
504
+ # - {Wx::PG::PG_DATE_PICKER_STYLE}: Determines window style used with {Wx::DatePickerCtrl}. Default is {Wx::DP_DEFAULT} | {Wx::DP_SHOWCENTURY}. Using {Wx::DP_ALLOWNONE} enables additional support for unspecified property value.
505
+ #
506
+ # ## wxEditEnumProperty
507
+ # Represents a string that can be freely edited or selected from list of choices - custom combobox control is used to edit the value.
508
+ #
509
+ # <div class="wxrb-remark">
510
+ # <b>Remark:</b>
511
+ # <p>Uses int value, similar to {Wx::PG::EnumProperty}, unless text entered by user is not in choices (in which case string value is used).
512
+ # </p>
513
+ # </div>
514
+ #
515
+ # ## wxMultiChoiceProperty
516
+ # Allows editing a multiple selection from a list of strings. This is property is pretty much built around concept of {Wx::MultiChoiceDialog}. It uses {Wx::ArrayString} value.
517
+ # Supported special attributes:
518
+ #
519
+ # - {Wx::PG::PG_ATTR_MULTICHOICE_USERSTRINGMODE}: If > 0, allows user to manually enter strings that are not in the list of choices. If this value is 1, user strings are preferably placed in front of valid choices. If value is 2, then those strings will placed behind valid choices.
520
+ # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the editor dialog.
521
+ #
522
+ # ## wxImageFileProperty
523
+ # Property representing image file(name). Like {Wx::PG::FileProperty}, but has thumbnail of the image in front of the filename and autogenerates wildcard from available image handlers.
524
+ # Supported special attributes:
525
+ #
526
+ # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the file dialog.
527
+ # - {Wx::PG::PG_FILE_DIALOG_STYLE}: Sets a specific {Wx::FileDialog} style for the file dialog.
528
+ # - {Wx::PG::PG_FILE_WILDCARD}: Sets wildcard (see {Wx::FileDialog} for format details), "All
529
+ # files..." is default.
530
+ # - {Wx::PG::PG_FILE_SHOW_FULL_PATH}: Default true. When false, only the file name is shown (i.e. drive and directory are hidden).
531
+ # - {Wx::PG::PG_FILE_SHOW_RELATIVE_PATH}: If set, then the filename is shown relative to the given path string.
532
+ # - {Wx::PG::PG_FILE_INITIAL_PATH}: Sets the initial path of where to look for files.
533
+ #
534
+ # ## wxColourProperty
535
+ # <b>Useful alternate editor:</b> Choice.
536
+ # Represents {Wx::Colour}. {Wx::Button} is used to trigger a colour picker dialog. There are various sub-classing opportunities with this class. See below in {Wx::PG::SystemColourProperty} section for details.
537
+ # Supported special attributes:
538
+ #
539
+ # - {Wx::PG::PG_COLOUR_HAS_ALPHA}: If set to true allows user to edit the alpha colour component.
540
+ #
541
+ # ## wxFontProperty
542
+ # Represents {Wx::Font}. Various sub-properties are used to edit individual subvalues.
543
+ # Supported special attributes:
544
+ #
545
+ # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the font dialog.
546
+ #
547
+ # ## wxSystemColourProperty
548
+ # Represents {Wx::Colour} and a system colour index. {Wx::Choice} is used to edit the value. Drop-down list has color images. Note that value type is {Wx::PG::ColourPropertyValue} instead of {Wx::Colour} (which {Wx::PG::ColourProperty} uses).
549
+ #
550
+ # In {Wx::PG::SystemColourProperty}, and its derived class {Wx::PG::ColourProperty}, there are various sub-classing features. To set a basic list of colour names, call {Wx::PG::PGProperty#set_choices}.
551
+ #
552
+ # ```ruby
553
+ # # Override in derived class to customize how colours are translated
554
+ # # to strings.
555
+ # def colour_to_string(col, index) end
556
+ #
557
+ # # Returns index of entry that triggers colour picker dialog
558
+ # # (default is last).
559
+ # def get_custom_colour_index; end
560
+ #
561
+ # # Helper function to show the colour dialog
562
+ # def query_colour_from_user(variant) end
563
+ #
564
+ # # Returns colour for given choice.
565
+ # # Default function returns Wx::SystemSettings.get_colour(index).
566
+ # def get_colour(index) end
567
+ # ```
568
+ #
569
+ # ## wxCursorProperty
570
+ # Represents a {Wx::Cursor}. {Wx::Choice} is used to edit the value. Drop-down list has cursor images under some (WXMSW) platforms.
571
+ #
572
+ # ## Creating Custom Properties
573
+ # New properties can be created by subclassing {Wx::PG::PGProperty} or one of the provided property classes, and (re)implementing necessary member functions. Below, each virtual member function has ample documentation about its purpose and any odd details which to keep in mind.
574
+ # Here is a very simple 'template' code:
575
+ #
576
+ # ```ruby
577
+ # class MyProperty < Wx::PG::PGProperty
578
+ #
579
+ # # All arguments of this ctor must have a default value -
580
+ # # use Wx::PG::PG_LABEL for label and name
581
+ # def initialize(label = Wx::PG::PG_LABEL, name = Wx::PG::PG_LABEL, value = '')
582
+ # super(label, name)
583
+ # # self.value is Wx::Variant
584
+ # self.value = value
585
+ # end
586
+ #
587
+ # def do_get_editor_class
588
+ # # Determines editor used by property.
589
+ # # You can replace 'TEXT_CTRL' below with any of these
590
+ # # builtin-in property editor identifiers: CHOICE, COMBO_BOX,
591
+ # # TEXT_CTRL_AND_BUTTON, CHOICE_AND_BUTTON, CHECK_BOX, SPIN_CTRL,
592
+ # # DATE_PICKER_CTRL.
593
+ # return Wx::PG::PG_EDITOR_TEXT_CTRL
594
+ # end
595
+ #
596
+ # def value_to_string(value, argFlags)
597
+ # # TODO: Convert given property value to a string
598
+ # end
599
+ #
600
+ # def string_to_value(variant, text, argFlags)
601
+ # # TODO: Adapt string to property value.
602
+ # end
603
+ #
604
+ # protected
605
+ # # ...
606
+ # end
607
+ # ```
608
+ #
609
+ # Category: {Wx::PG::PropertyGrid}
610
+ # @see wxPropertyGrid Property Attribute Identifiers
611
+ #
612
+ # @see wxPropertyGrid Property Attribute Identifiers
613
+ #
614
+ # @see wxPropertyGrid Property Attribute Identifiers
615
+ #
616
+ # @see wxPropertyGrid Property Attribute Identifiers
617
+ #
618
+ # @see wxPropertyGrid Property Attribute Identifiers
619
+ #
620
+ # @see wxPropertyGrid Property Attribute Identifiers
621
+ #
622
+ # @see wxPropertyGrid Property Attribute Identifiers
623
+ #
624
+ # @see wxPropertyGrid Property Attribute Identifiers
625
+ #
626
+ # @see wxPropertyGrid Property Attribute Identifiers
627
+ #
628
+ # @see wxPropertyGrid Property Attribute Identifiers
629
+ #
630
+ # @see wxPropertyGrid Property Attribute Identifiers
631
+ #
632
+ # @see wxPropertyGrid Property Attribute Identifiers
633
+ #
634
+ #
635
+ # @wxrb_require USE_PROPGRID
636
+ class PGProperty < Object
637
+
638
+ # This virtual function is called after m_value has been set.
639
+ #
640
+ # <div class="wxrb-remark">
641
+ # <b>Remark:</b>
642
+ # <p>
643
+ #
644
+ # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::PGProperty#on_set_value} will not be called.
645
+ # - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::PGProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
646
+ # - Default implementation does nothing.
647
+ #
648
+ # </p>
649
+ # </div>
650
+ # @return [void]
651
+ def on_set_value; end
652
+
653
+ # Override this to return something else than m_value as the value.
654
+ # @return [Wx::Variant]
655
+ def do_get_value; end
656
+
657
+ # Implement this function in derived class to check the value.
658
+ #
659
+ # Return true if it is ok. Returning false prevents property change events from occurring.
660
+ #
661
+ # <div class="wxrb-remark">
662
+ # <b>Remark:</b>
663
+ # <p>
664
+ #
665
+ # - Default implementation always returns true.
666
+ #
667
+ # </p>
668
+ # </div>
669
+ # @param value [Wx::Variant]
670
+ # @param validationInfo [Wx::PG::PGValidationInfo]
671
+ # @return [Boolean]
672
+ def validate_value(value, validationInfo) end
673
+
674
+ # Converts text into {Wx::Variant} value appropriate for this property.
675
+ #
676
+ # Returns true if resulting {Wx::Variant} value was different.
677
+ #
678
+ # <div class="wxrb-remark">
679
+ # <b>Remark:</b>
680
+ # <p>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
681
+ # </p>
682
+ # </div>
683
+ #
684
+ # You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
685
+ # @param variant [Wx::Variant] On function entry this is the old value (should not be null {Wx::Variant} in normal cases). Translated value must be assigned back to it.
686
+ # @param text [String] Text to be translated into variant.
687
+ # @param flags [Wx::PGPropValFormatFlags] If {Wx::PG::PGPropValFormatFlags::FullValue} is set, returns complete, storable value instead of displayable one (they may be different). If {Wx::PG::PGPropValFormatFlags::CompositeFragment} is set, text is interpreted as a part of composite property string value (as generated by {Wx::PG::PGProperty#value_to_string} called with this same flag).
688
+ # @return [Boolean]
689
+ def string_to_value(variant, text, flags=PGPropValFormatFlags::Null) end
690
+
691
+ # Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
692
+ #
693
+ # Returns true if resulting {Wx::Variant} value was different.
694
+ #
695
+ # <div class="wxrb-remark">
696
+ # <b>Remark:</b>
697
+ # <p>
698
+ #
699
+ # - If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.
700
+ # - Default implementation simply assign given int to m_value.
701
+ # - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
702
+ # - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
703
+ #
704
+ # </p>
705
+ # </div>
706
+ # @param variant [Wx::Variant] On function entry this is the old value (should not be null {Wx::Variant} in normal cases). Translated value must be assigned back to it.
707
+ # @param number [Integer] Integer to be translated into variant.
708
+ # @param flags [Wx::PGPropValFormatFlags] If {Wx::PG::PGPropValFormatFlags::FullValue} is set, returns complete, storable value instead of displayable one.
709
+ # @return [Boolean]
710
+ def int_to_value(variant, number, flags=PGPropValFormatFlags::Null) end
711
+
712
+ # Converts property value into a text representation.
713
+ #
714
+ # <div class="wxrb-remark">
715
+ # <b>Remark:</b>
716
+ # <p>Default implementation calls {Wx::PG::PGProperty#generate_composed_value}.
717
+ # </p>
718
+ # </div>
719
+ # @param value [Wx::Variant] Value to be converted.
720
+ # @param flags [Wx::PGPropValFormatFlags] If {Wx::PG::PGPropValFormatFlags::Null} (default value), then displayed string is returned. If {Wx::PG::PGPropValFormatFlags::FullValue} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PGPropValFormatFlags::EditableValue} is set, returns string value that must be editable in textctrl. If {Wx::PG::PGPropValFormatFlags::CompositeFragment} is set, returns text that is appropriate to display as a part of string property's composite text representation.
721
+ # @return [String]
722
+ def value_to_string(value, flags=PGPropValFormatFlags::Null) end
723
+
724
+ # Converts string to a value, and if successful, calls {Wx::PG::PGProperty#set_value} on it.
725
+ #
726
+ # Default behaviour is to do nothing.
727
+ #
728
+ # true if value was changed.
729
+ # @param text [String] String to get the value from.
730
+ # @param flags [Wx::PGPropValFormatFlags] If {Wx::PG::PGPropValFormatFlags::FullValue} is set, the function sets complete, storable value instead of displayable one (they may be different). {Wx::PG::PGPropValFormatFlags::ProgrammaticValue} flag is used to indicate that value is being set programmatically (i.e. operation is not caused by user input). If {Wx::PG::PGPropValFormatFlags::ReportError} is set, a special action should be performed if string couldn't have been successfully converted to the valid value (e.g. a special value can be set in this case).
731
+ # @return [Boolean]
732
+ def set_value_from_string(text, flags=PGPropValFormatFlags::ProgrammaticValue) end
733
+ alias_method :value_from_string=, :set_value_from_string
734
+
735
+ # Converts integer to a value, and if successful, calls {Wx::PG::PGProperty#set_value} on it.
736
+ #
737
+ # Default behaviour is to do nothing.
738
+ #
739
+ # true if value was changed.
740
+ # @param value [Integer] Int to get the value from.
741
+ # @param flags [Wx::PGPropValFormatFlags] If has {Wx::PG::PGPropValFormatFlags::FullValue}, then the value given is an actual value and not an index.
742
+ # @return [Boolean]
743
+ def set_value_from_int(value, flags=PGPropValFormatFlags::Null) end
744
+ alias_method :value_from_int=, :set_value_from_int
745
+
746
+ # Returns size of the custom painted image in front of property.
747
+ #
748
+ # This method must be overridden to return non-default value if OnCustomPaint is to be called.
749
+ #
750
+ # <div class="wxrb-remark">
751
+ # <b>Remark:</b>
752
+ # <p>
753
+ #
754
+ # - Default behaviour is to return {size(0,0)}, which means no image.
755
+ # - Default image width or height is indicated with dimension -1.
756
+ # - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
757
+ #
758
+ # </p>
759
+ # </div>
760
+ # @param item [Integer] Normally -1, but can be an index to the property's list of items.
761
+ # @return [Wx::Size]
762
+ def on_measure_image(item=-1) end
763
+
764
+ # Events received by editor widgets are processed here.
765
+ #
766
+ # Note that editor class usually processes most events. Some, such as button press events of TextCtrlAndButton class, can be handled here. Also, if custom handling for regular events is desired, then that can also be done (for example, {Wx::PG::SystemColourProperty} custom handles {Wx::EVT_CHOICE} to display colour picker dialog when 'custom' selection is made).
767
+ # If the event causes value to be changed, {Wx::PG::PGProperty#set_value_in_event} should be called to set the new value.
768
+ # The parameter event is the associated {Wx::Event}.
769
+ #
770
+ # Should
771
+ #
772
+ # return true if any changes in value should be reported.
773
+ #
774
+ # <div class="wxrb-remark">
775
+ # <b>Remark:</b>
776
+ # <p>
777
+ #
778
+ # - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
779
+ #
780
+ # </p>
781
+ # </div>
782
+ # @param propgrid [Wx::PG::PropertyGrid]
783
+ # @param wnd_primary [Wx::Window]
784
+ # @param event [Wx::Event]
785
+ # @return [Boolean]
786
+ def on_event(propgrid, wnd_primary, event) end
787
+
788
+ # Called after value of a child property has been altered.
789
+ #
790
+ # Must return new value of the whole property (after any alterations warranted by child's new value).
791
+ # Note that this function is usually called at the time that value of this property, or given child property, is still pending for change, and as such, result of {Wx::PG::PGProperty#get_value} or m_value should not be relied on.
792
+ # Sample pseudo-code implementation:
793
+ #
794
+ # ```ruby
795
+ # class MyProperty < Wx::PG::FlagsProperty
796
+ #
797
+ # def child_changed(thisValue, childIndex, childValue)
798
+ # # Acquire reference to actual type of data stored in variant
799
+ # flags = thisValue.object;
800
+ # case childIndex
801
+ # when 0
802
+ # flags.sub_prop1 = childValue.to_i
803
+ # when 1
804
+ # flags.sub_prop2 = childValue.to_s
805
+ # # ...
806
+ # end
807
+ # # return altered data
808
+ # Wx::Variant.new(flags)
809
+ # end
810
+ #
811
+ # end
812
+ # ```
813
+ #
814
+ # Modified value of the whole property.
815
+ # @param thisValue [Wx::Variant] Value of this property. Changed value should be returned (in previous versions of {Wx::PG::PropertyGrid} it was only necessary to write value back to this argument).
816
+ # @param childIndex [Integer] Index of child changed (you can use Item(childIndex) to get child property).
817
+ # @param childValue [Wx::Variant] (Pending) value of the child property.
818
+ # @return [Wx::Variant]
819
+ def child_changed(thisValue, childIndex, childValue) end
820
+
821
+ # Returns pointer to an instance of used editor.
822
+ # @return [Wx::PG::PGEditor]
823
+ def do_get_editor_class; end
824
+
825
+ # Returns pointer to the {Wx::Validator} that should be used with the editor of this property (nil for no validator).
826
+ #
827
+ # Setting validator explicitly via \#set_property_validator will override this.
828
+ # In most situations, code like this should work well:
829
+ #
830
+ # ```ruby
831
+ # class MyPropertyClass < Wx::PG::IntProperty
832
+ #
833
+ # class << self
834
+ # def validator
835
+ # @validator ||= MyValidator.new(...)
836
+ # end
837
+ # end
838
+ #
839
+ # # ...
840
+ #
841
+ # def do_get_validator
842
+ # MyPropertyClass.validator
843
+ # end
844
+ #
845
+ # # ...
846
+ #
847
+ # end
848
+ # ```
849
+ #
850
+ # <div class="wxrb-remark">
851
+ # <b>Remark:</b>
852
+ # <p>You can get common filename validator by returning {Wx::PG::FileProperty.get_class_validator}. {Wx::PG::DirProperty}, for example, uses it.
853
+ # </p>
854
+ # </div>
855
+ # @return [Wx::Validator]
856
+ def do_get_validator; end
857
+
858
+ # Override to paint an image in front of the property value text or drop-down list item (but only if {Wx::PG::PGProperty#on_measure_image} is overridden as well).
859
+ #
860
+ # If property's {Wx::PG::PGProperty#on_measure_image} returns size that has height != 0 but less than row height ( < 0 has special meanings), {Wx::PG::PropertyGrid} calls this method to draw a custom image in a limited area in front of the editor control or value text/graphics, and if control has drop-down list, then the image is drawn there as well (even in the case {Wx::PG::PGProperty#on_measure_image} returned higher height than row height).
861
+ # NOTE: Following applies when {Wx::PG::PGProperty#on_measure_image} returns a "flexible" height ( using <code>wxPG_FLEXIBLE_SIZE(W,H)</code> macro), which implies variable height items: If (rect.x+rect.width) is < 0, then this is a measure item call, which means that dc is invalid and only thing that should be done is to set paintdata.m_drawnHeight to the height of the image of item at index paintdata.m_choiceItem. This call may be done even as often as once every drop-down popup show.
862
+ #
863
+ # <div class="wxrb-remark">
864
+ # <b>Remark:</b>
865
+ # <p>
866
+ #
867
+ # - You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth must be set to the full width drawn in pixels.
868
+ # - Due to technical reasons, rect's height will be default even if custom height was reported during measure call.
869
+ # - Brush is guaranteed to be default background colour. It has been already used to clear the background of area being painted. It can be modified.
870
+ # - Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for drawing framing rectangle. It can be changed as well.
871
+ #
872
+ # </p>
873
+ # </div>
874
+ # @see Wx::PG::PGProperty#value_to_string
875
+ # @param dc [Wx::DC] {Wx::DC} to paint on.
876
+ # @param rect [Wx::Rect] Box reserved for custom graphics. Includes surrounding rectangle, if any. If x+width is < 0, then this is a measure item call (see above).
877
+ # @param paintdata [Wx::PG::PGPaintData] {Wx::PG::PGPaintData} structure with much useful data about painted item.
878
+ # @return [void]
879
+ def on_custom_paint(dc, rect, paintdata) end
880
+
881
+ # Returns which choice is currently selected.
882
+ #
883
+ # Only applies to properties which have choices.
884
+ # Needs to reimplemented in derived class if property value does not map directly to a choice. Integer as index, bool, and string usually do.
885
+ # @return [Integer]
886
+ def get_choice_selection; end
887
+ alias_method :choice_selection, :get_choice_selection
888
+
889
+ # Refresh values of child properties.
890
+ #
891
+ # Automatically called after value is set.
892
+ # @return [void]
893
+ def refresh_children; end
894
+
895
+ # Reimplement this member function to add special handling for attributes of this property.
896
+ #
897
+ # Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
898
+ #
899
+ # <div class="wxrb-remark">
900
+ # <b>Remark:</b>
901
+ # <p>To actually set property attribute values from the application, use {Wx::PG::PGProperty#set_attribute} instead.
902
+ # </p>
903
+ # </div>
904
+ # @param name [String]
905
+ # @param value [Wx::Variant]
906
+ # @return [Boolean]
907
+ def do_set_attribute(name, value) end
908
+
909
+ # Returns value of an attribute.
910
+ #
911
+ # Override if custom handling of attributes is needed.
912
+ # Default implementation simply return nil variant.
913
+ # @param name [String]
914
+ # @return [Wx::Variant]
915
+ def do_get_attribute(name) end
916
+
917
+ # Returns instance of a new {Wx::PG::PGEditorDialogAdapter} instance, which is used when user presses the (optional) button next to the editor control;.
918
+ #
919
+ # Default implementation returns nil (i.e. no action is generated when button is pressed).
920
+ # @return [Wx::PG::PGEditorDialogAdapter]
921
+ def get_editor_dialog; end
922
+ alias_method :editor_dialog, :get_editor_dialog
923
+
924
+ # Called whenever validation has failed with given pending value.
925
+ #
926
+ # <div class="wxrb-remark">
927
+ # <b>Remark:</b>
928
+ # <p>If you implement this in your custom property class, please remember to call the base implementation as well, since they may use it to revert property into pre-change state.
929
+ # </p>
930
+ # </div>
931
+ # @param pendingValue [Wx::Variant]
932
+ # @return [void]
933
+ def on_validation_failure(pendingValue) end
934
+
935
+ # Append a new choice to property's list of choices.
936
+ #
937
+ # Index to added choice.
938
+ # @param label [String] Label for added choice.
939
+ # @param value [Integer] Value for new choice. Do not specify if you wish this to equal choice index.
940
+ # @return [Integer]
941
+ def add_choice(label, value=Wx::PG::PG_INVALID_VALUE) end
942
+
943
+ # Adds a private child property.
944
+ #
945
+ # If you use this instead of {Wx::PG::PropertyGridInterface#insert} or {Wx::PG::PropertyGridInterface#append_in}, then property's parental type will automatically be set up to {Wx::PG::PGFlags::Aggregate}. In other words, all properties of this property will become private.
946
+ # @param prop [Wx::PG::PGProperty]
947
+ # @return [void]
948
+ def add_private_child(prop) end
949
+
950
+ # Adapts list variant into proper value using consecutive {Wx::PG::PGProperty#child_changed} calls.
951
+ # @param list [Wx::Variant]
952
+ # @param value [Wx::Variant]
953
+ # @return [void]
954
+ def adapt_list_to_value(list, value) end
955
+
956
+ # Use this member function to add independent (i.e.
957
+ #
958
+ # regular) children to a property.
959
+ # Appended childProperty.
960
+ #
961
+ # <div class="wxrb-remark">
962
+ # <b>Remark:</b>
963
+ # <p>{Wx::PG::PropertyGrid} is not automatically refreshed by this function.
964
+ # </p>
965
+ # </div>
966
+ # @see Wx::PG::PGProperty#insert_child
967
+ # @see Wx::PG::PGProperty#add_private_child
968
+ # @param childProperty [Wx::PG::PGProperty]
969
+ # @return [Wx::PG::PGProperty]
970
+ def append_child(childProperty) end
971
+
972
+ # Determines, recursively, if all children are not unspecified.
973
+ # @param pendingList [Wx::Variant] Assumes members in this {Wx::Variant} list as pending replacement values.
974
+ # @return [Boolean]
975
+ def are_all_children_specified(pendingList=nil) end
976
+
977
+ # Returns true if children of this property are component values (for instance, points size, face name, and is_underlined are component values of a font).
978
+ # @return [Boolean]
979
+ def are_children_components; end
980
+
981
+ # Sets or clears given property flag.
982
+ #
983
+ # Mainly for internal use.
984
+ #
985
+ # <div class="wxrb-remark">
986
+ # <b>Remark:</b>
987
+ # <p>Setting a property flag never has any side-effect, and is intended almost exclusively for internal use. So, for example, if you want to disable a property, call
988
+ # ```ruby
989
+ # enable(false)
990
+ # ```
991
+ # instead of setting {Wx::PG::PGFlags::Disabled} flag.
992
+ # </p>
993
+ # </div>
994
+ # @see Wx::PG::PGProperty#has_flag
995
+ # @see GetFlags()
996
+ # @param flag [Wx::PGFlags]
997
+ # @param set [Boolean]
998
+ # @return [void]
999
+ def change_flag(flag, set) end
1000
+
1001
+ # Deletes children of the property.
1002
+ # @return [void]
1003
+ def delete_children; end
1004
+
1005
+ # Removes entry from property's {Wx::PG::PGChoices} and editor control (if it is active).
1006
+ #
1007
+ # If selected item is deleted, then the value is set to unspecified.
1008
+ # @param index [Integer]
1009
+ # @return [void]
1010
+ def delete_choice(index) end
1011
+
1012
+ # Enables or disables the property.
1013
+ #
1014
+ # Disabled property usually appears as having grey text.
1015
+ # @see Wx::PG::PropertyGridInterface#enable_property
1016
+ # @param enable [Boolean] If false, property is disabled instead.
1017
+ # @return [void]
1018
+ def enable(enable=true) end
1019
+
1020
+ # Call to enable or disable usage of common value (integer value that can be selected for properties instead of their normal values) for this property.
1021
+ #
1022
+ # Common values are disabled by the default for all properties.
1023
+ # @param enable [Boolean]
1024
+ # @return [void]
1025
+ def enable_common_value(enable=true) end
1026
+
1027
+ # Composes text from values of child properties.
1028
+ # @return [String]
1029
+ def generate_composed_value; end
1030
+
1031
+ # Returns property's label.
1032
+ # @return [Wx::String]
1033
+ def get_label; end
1034
+ alias_method :label, :get_label
1035
+
1036
+ # @overload get_attribute(name)
1037
+ # Returns property attribute value, null variant if not found.
1038
+ #
1039
+ # <div class="wxrb-remark">
1040
+ # <b>Remark:</b>
1041
+ # <p>For built-in attribute returns null variant if extra style {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_WRITEONLY_BUILTIN_ATTRIBUTES} is set.
1042
+ # </p>
1043
+ # </div>
1044
+ # @param name [String]
1045
+ # @return [Wx::Variant]
1046
+ # @overload get_attribute(name, defVal)
1047
+ # Returns named attribute, as string, if found.
1048
+ #
1049
+ # Otherwise defVal is returned.
1050
+ #
1051
+ # <div class="wxrb-remark">
1052
+ # <b>Remark:</b>
1053
+ # <p>For built-in attribute returns defVal if extra style {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_WRITEONLY_BUILTIN_ATTRIBUTES} is set.
1054
+ # </p>
1055
+ # </div>
1056
+ # @param name [String]
1057
+ # @param defVal [String]
1058
+ # @return [String]
1059
+ def get_attribute(*args) end
1060
+ alias_method :attribute, :get_attribute
1061
+
1062
+ # Returns named attribute, as long, if found.
1063
+ #
1064
+ # Otherwise defVal is returned.
1065
+ #
1066
+ # <div class="wxrb-remark">
1067
+ # <b>Remark:</b>
1068
+ # <p>For built-in attribute returns defVal if extra style {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_WRITEONLY_BUILTIN_ATTRIBUTES} is set.
1069
+ # </p>
1070
+ # </div>
1071
+ # @param name [String]
1072
+ # @param defVal [Integer]
1073
+ # @return [Integer]
1074
+ def get_attribute_as_long(name, defVal) end
1075
+ alias_method :attribute_as_long, :get_attribute_as_long
1076
+
1077
+ # Returns named attribute, as double, if found.
1078
+ #
1079
+ # Otherwise defVal is returned.
1080
+ #
1081
+ # <div class="wxrb-remark">
1082
+ # <b>Remark:</b>
1083
+ # <p>For built-in attribute returns defVal if extra style {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_WRITEONLY_BUILTIN_ATTRIBUTES} is set.
1084
+ # </p>
1085
+ # </div>
1086
+ # @param name [String]
1087
+ # @param defVal [Float]
1088
+ # @return [Float]
1089
+ def get_attribute_as_double(name, defVal) end
1090
+ alias_method :attribute_as_double, :get_attribute_as_double
1091
+
1092
+ # Returns map-like storage of property's attributes.
1093
+ #
1094
+ # <div class="wxrb-remark">
1095
+ # <b>Remark:</b>
1096
+ # <p>If extra style {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_WRITEONLY_BUILTIN_ATTRIBUTES} is set, then builtin-attributes are not included in the storage.
1097
+ # </p>
1098
+ # </div>
1099
+ # @return [Wx::PGAttributeStorage]
1100
+ def get_attributes; end
1101
+ alias_method :attributes, :get_attributes
1102
+
1103
+ # Returns attributes as list {Wx::Variant}.
1104
+ #
1105
+ # <div class="wxrb-remark">
1106
+ # <b>Remark:</b>
1107
+ # <p>If extra style {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_WRITEONLY_BUILTIN_ATTRIBUTES} is set, then builtin-attributes are not included in the list.
1108
+ # </p>
1109
+ # </div>
1110
+ # @return [Wx::Variant]
1111
+ def get_attributes_as_list; end
1112
+ alias_method :attributes_as_list, :get_attributes_as_list
1113
+
1114
+ # Returns editor used for given column.
1115
+ #
1116
+ # nil for no editor.
1117
+ # @param column [Integer]
1118
+ # @return [Wx::PG::PGEditor]
1119
+ def get_column_editor(column) end
1120
+ alias_method :column_editor, :get_column_editor
1121
+
1122
+ # Returns property's base name (i.e.
1123
+ #
1124
+ # parent's name is not added in any case).
1125
+ # @return [Wx::String]
1126
+ def get_base_name; end
1127
+ alias_method :base_name, :get_base_name
1128
+
1129
+ # Returns {Wx::PG::PGCell} of given column.
1130
+ #
1131
+ # <div class="wxrb-remark">
1132
+ # <b>Remark:</b>
1133
+ # <p>const version of this member function returns 'default' {Wx::PG::PGCell} object if the property itself didn't hold cell data.
1134
+ # </p>
1135
+ # </div>
1136
+ # @param column [Integer]
1137
+ # @return [Wx::PG::PGCell]
1138
+ def get_cell_or_default(column) end
1139
+ alias_method :cell_or_default, :get_cell_or_default
1140
+
1141
+ # Returns {Wx::PG::PGCell} of given column, creating one if necessary.
1142
+ # @param column [Integer]
1143
+ # @return [Wx::PG::PGCell]
1144
+ def get_cell(column) end
1145
+ alias_method :cell, :get_cell
1146
+
1147
+ # Returns number of child properties.
1148
+ # @return [Integer]
1149
+ def get_child_count; end
1150
+ alias_method :child_count, :get_child_count
1151
+
1152
+ # Checks if there is any child property.
1153
+ # @return [Boolean]
1154
+ def has_any_child; end
1155
+ alias_method :has_any_child?, :has_any_child
1156
+
1157
+ # Returns height of children, recursively, and by taking expanded/collapsed status into account.
1158
+ # @param lh [Integer] Line height. Pass result of {Wx::PG::PGProperty#get_grid}->GetRowHeight() here.
1159
+ # @param iMax [Integer] Only used (internally) when finding property y-positions.
1160
+ # @return [Integer]
1161
+ def get_children_height(lh, iMax=-1) end
1162
+ alias_method :children_height, :get_children_height
1163
+
1164
+ # Returns read-only reference to property's list of choices.
1165
+ # @return [Wx::PG::PGChoices]
1166
+ def get_choices; end
1167
+ alias_method :choices, :get_choices
1168
+
1169
+ # Gets managed client object of a property.
1170
+ # @return [Object]
1171
+ def get_client_object; end
1172
+ alias_method :client_object, :get_client_object
1173
+
1174
+ # Returns property's default value.
1175
+ #
1176
+ # If property's value type is not a built-in one, and "DefaultValue" attribute is not defined, then this function usually returns Null variant.
1177
+ # @return [Wx::Variant]
1178
+ def get_default_value; end
1179
+ alias_method :default_value, :get_default_value
1180
+
1181
+ # Returns common value selected for this property.
1182
+ #
1183
+ # -1 for none.
1184
+ # @return [Integer]
1185
+ def get_common_value; end
1186
+ alias_method :common_value, :get_common_value
1187
+
1188
+ # @return [Integer]
1189
+ def get_depth; end
1190
+ alias_method :depth, :get_depth
1191
+
1192
+ # Return number of displayed common values for this property.
1193
+ # @return [Integer]
1194
+ def get_displayed_common_value_count; end
1195
+ alias_method :displayed_common_value_count, :get_displayed_common_value_count
1196
+
1197
+ # Returns property's displayed text.
1198
+ # @return [String]
1199
+ def get_displayed_string; end
1200
+ alias_method :displayed_string, :get_displayed_string
1201
+
1202
+ # Returns {Wx::PG::PGEditor} that will be used and created when property becomes selected.
1203
+ #
1204
+ # Returns more accurate value than {Wx::PG::PGProperty#do_get_editor_class}.
1205
+ # @return [Wx::PG::PGEditor]
1206
+ def get_editor_class; end
1207
+ alias_method :editor_class, :get_editor_class
1208
+
1209
+ # Returns property's hint text (shown in empty value cell).
1210
+ # @return [String]
1211
+ def get_hint_text; end
1212
+ alias_method :hint_text, :get_hint_text
1213
+
1214
+ # Returns property grid where property lies.
1215
+ # @return [Wx::PG::PropertyGrid]
1216
+ def get_grid; end
1217
+ alias_method :grid, :get_grid
1218
+
1219
+ # Returns owner {Wx::PG::PropertyGrid}, but only if one is currently on a page displaying this property.
1220
+ # @return [Wx::PG::PropertyGrid]
1221
+ def get_grid_if_displayed; end
1222
+ alias_method :grid_if_displayed, :get_grid_if_displayed
1223
+
1224
+ # Returns property's help or description text.
1225
+ #
1226
+ #
1227
+ # @see Wx::PG::PGProperty#set_help_string
1228
+ # @return [Wx::String]
1229
+ def get_help_string; end
1230
+ alias_method :help_string, :get_help_string
1231
+
1232
+ # Gets flags as a'|' delimited string.
1233
+ #
1234
+ # Note that flag names are not prepended with '{Wx::PG::PGFlags}'.
1235
+ # @param flagsMask [Wx::PGFlags] String will only be made to include flags combined by this parameter.
1236
+ # @return [String]
1237
+ def get_flags_as_string(flagsMask) end
1238
+ alias_method :flags_as_string, :get_flags_as_string
1239
+
1240
+ # Returns position in parent's array.
1241
+ # @return [Integer]
1242
+ def get_index_in_parent; end
1243
+ alias_method :index_in_parent, :get_index_in_parent
1244
+
1245
+ # Returns last visible child property, recursively.
1246
+ # @return [Wx::PG::PGProperty]
1247
+ def get_last_visible_sub_item; end
1248
+ alias_method :last_visible_sub_item, :get_last_visible_sub_item
1249
+
1250
+ # Returns highest level non-category, non-root parent.
1251
+ #
1252
+ # Useful when you have nested properties with children.
1253
+ #
1254
+ # <div class="wxrb-remark">
1255
+ # <b>Remark:</b>
1256
+ # <p>If immediate parent is root or category, this will return the property itself.
1257
+ # </p>
1258
+ # </div>
1259
+ # @return [Wx::PG::PGProperty]
1260
+ def get_main_parent; end
1261
+ alias_method :main_parent, :get_main_parent
1262
+
1263
+ # Returns maximum allowed length of the text the user can enter in the property text editor.
1264
+ #
1265
+ # <div class="wxrb-remark">
1266
+ # <b>Remark:</b>
1267
+ # <p>0 is returned if length is not explicitly limited and the text can be as long as it is supported by the underlying native text control widget.
1268
+ # </p>
1269
+ # </div>
1270
+ # @return [Integer]
1271
+ def get_max_length; end
1272
+ alias_method :max_length, :get_max_length
1273
+
1274
+ # Returns property's name with all (non-category, non-root) parents.
1275
+ # @return [String]
1276
+ def get_name; end
1277
+ alias_method :name, :get_name
1278
+
1279
+ # Return parent of property.
1280
+ # @return [Wx::PG::PGProperty]
1281
+ def get_parent; end
1282
+ alias_method :parent, :get_parent
1283
+
1284
+ # Returns (direct) child property with given name (or nil if not found).
1285
+ # @param name [String] Name of the child property to look for.
1286
+ # @return [Wx::PG::PGProperty]
1287
+ def get_property_by_name(name) end
1288
+ alias_method :property_by_name, :get_property_by_name
1289
+
1290
+ # Gets assignable version of property's validator.
1291
+ # @return [Wx::Validator]
1292
+ def get_validator; end
1293
+ alias_method :validator, :get_validator
1294
+
1295
+ # Returns property's value.
1296
+ # @return [Wx::Variant]
1297
+ def get_value; end
1298
+ alias_method :value, :get_value
1299
+
1300
+ # Returns bitmap that appears next to value text.
1301
+ #
1302
+ # Only returns non-null bitmap if one was set with {Wx::PG::PGProperty#set_value_image}.
1303
+ # @return [Wx::Bitmap]
1304
+ def get_value_image; end
1305
+ alias_method :value_image, :get_value_image
1306
+
1307
+ # Returns text representation of property's value.
1308
+ #
1309
+ # <div class="wxrb-remark">
1310
+ # <b>Remark:</b>
1311
+ # <p>In older versions, this function used to be overridden to convert property's value into a string representation. This function is now handled by {Wx::PG::PGProperty#value_to_string}, and overriding this function now will result in run-time assertion failure.
1312
+ # </p>
1313
+ # </div>
1314
+ # @param flags [Wx::PGPropValFormatFlags] If {Wx::PG::PGPropValFormatFlags::Null} (default value), then displayed string is returned. If {Wx::PG::PGPropValFormatFlags::FullValue} is set, returns complete, storable string value instead of displayable. If {Wx::PG::PGPropValFormatFlags::EditableValue} is set, returns string value that must be editable in textctrl. If {Wx::PG::PGPropValFormatFlags::CompositeFragment} is set, returns text that is appropriate to display as a part of string property's composite text representation.
1315
+ # @return [String]
1316
+ def get_value_as_string(flags=PGPropValFormatFlags::Null) end
1317
+ alias_method :value_as_string, :get_value_as_string
1318
+
1319
+ # Returns value type used by this property.
1320
+ # @return [String]
1321
+ def get_value_type; end
1322
+ alias_method :value_type, :get_value_type
1323
+
1324
+ # Returns coordinate to the top y of the property.
1325
+ #
1326
+ # Note that the position of scrollbars is not taken into account.
1327
+ # @return [Integer]
1328
+ def get_y; end
1329
+ alias_method :y, :get_y
1330
+
1331
+ # Converts image width into full image offset, with margins.
1332
+ # @param imageWidth [Integer]
1333
+ # @return [Integer]
1334
+ def get_image_offset(imageWidth) end
1335
+ alias_method :image_offset, :get_image_offset
1336
+
1337
+ # Returns property at given virtual y coordinate.
1338
+ # @param y [Integer]
1339
+ # @return [Wx::PG::PGProperty]
1340
+ def get_item_at_y(y) end
1341
+ alias_method :item_at_y, :get_item_at_y
1342
+
1343
+ # Returns true if property has given flag set.
1344
+ #
1345
+ #
1346
+ # @see propgrid_propflags
1347
+ # @param flag [Wx::PGFlags]
1348
+ # @return [Boolean]
1349
+ def has_flag(flag) end
1350
+ alias_method :has_flag?, :has_flag
1351
+
1352
+ # Returns true if property has all given flags set.
1353
+ # @param flags [Wx::PGFlags]
1354
+ # @return [Boolean]
1355
+ def has_flags_exact(flags) end
1356
+ alias_method :has_flags_exact?, :has_flags_exact
1357
+
1358
+ # Returns true if property has even one visible child.
1359
+ # @return [Boolean]
1360
+ def has_visible_children; end
1361
+ alias_method :has_visible_children?, :has_visible_children
1362
+
1363
+ # Hides or reveals the property.
1364
+ # @param hide [Boolean] true for hide, false for reveal.
1365
+ # @param flags [Wx::PGPropertyValuesFlags] By default changes are applied recursively. Set this parameter to {Wx::PG::PGPropertyValuesFlags::DontRecurse} to prevent this.
1366
+ # @return [Boolean]
1367
+ def hide(hide, flags=PGPropertyValuesFlags::Recurse) end
1368
+
1369
+ # Returns index of given child property.
1370
+ #
1371
+ # {Wx::NOT_FOUND} if given property is not child of this.
1372
+ # @param p [Wx::PG::PGProperty]
1373
+ # @return [Integer]
1374
+ def index(p) end
1375
+
1376
+ # Use this member function to add independent (i.e.
1377
+ #
1378
+ # regular) children to a property.
1379
+ # Inserted childProperty.
1380
+ #
1381
+ # <div class="wxrb-remark">
1382
+ # <b>Remark:</b>
1383
+ # <p>{Wx::PG::PropertyGrid} is not automatically refreshed by this function.
1384
+ # </p>
1385
+ # </div>
1386
+ # @see Wx::PG::PGProperty#append_child
1387
+ # @see Wx::PG::PGProperty#add_private_child
1388
+ # @param index [Integer]
1389
+ # @param childProperty [Wx::PG::PGProperty]
1390
+ # @return [Wx::PG::PGProperty]
1391
+ def insert_child(index, childProperty) end
1392
+
1393
+ # Inserts a new choice to property's list of choices.
1394
+ # @param label [String] Text for new choice
1395
+ # @param index [Integer] Insertion position. Use {Wx::NOT_FOUND} to append.
1396
+ # @param value [Integer] Value for new choice. Do not specify if you wish this to equal choice index.
1397
+ # @return [Integer]
1398
+ def insert_choice(label, index, value=Wx::PG::PG_INVALID_VALUE) end
1399
+
1400
+ # Returns true if this property is actually a {Wx::PG::PropertyCategory}.
1401
+ # @return [Boolean]
1402
+ def is_category; end
1403
+ alias_method :category?, :is_category
1404
+
1405
+ # Returns true if property is enabled.
1406
+ # @return [Boolean]
1407
+ def is_enabled; end
1408
+ alias_method :enabled?, :is_enabled
1409
+
1410
+ # Returns true if property has visible children.
1411
+ # @return [Boolean]
1412
+ def is_expanded; end
1413
+ alias_method :expanded?, :is_expanded
1414
+
1415
+ # Returns true if this property is actually a {Wx::RootProperty}.
1416
+ # @return [Boolean]
1417
+ def is_root; end
1418
+ alias_method :root?, :is_root
1419
+
1420
+ # Returns true if this is a sub-property.
1421
+ # @return [Boolean]
1422
+ def is_sub_property; end
1423
+ alias_method :sub_property?, :is_sub_property
1424
+
1425
+ # Returns true if candidateParent is some parent of this property.
1426
+ #
1427
+ # Use, for example, to detect if item is inside collapsed section.
1428
+ # @param candidateParent [Wx::PG::PGProperty]
1429
+ # @return [Boolean]
1430
+ def is_some_parent(candidateParent) end
1431
+ alias_method :some_parent?, :is_some_parent
1432
+
1433
+ # Returns true if property has editable {Wx::TextCtrl} when selected.
1434
+ #
1435
+ # <div class="wxrb-remark">
1436
+ # <b>Remark:</b>
1437
+ # <p>Although disabled properties do not displayed editor, they still return true here as being disabled is considered a temporary condition (unlike being read-only or having limited editing enabled).
1438
+ # </p>
1439
+ # </div>
1440
+ # @return [Boolean]
1441
+ def is_text_editable; end
1442
+ alias_method :text_editable?, :is_text_editable
1443
+
1444
+ # Returns true if property's value is considered unspecified.
1445
+ #
1446
+ # This usually means that value is Null variant.
1447
+ # @return [Boolean]
1448
+ def is_value_unspecified; end
1449
+ alias_method :value_unspecified?, :is_value_unspecified
1450
+
1451
+ # Returns true if all parents expanded.
1452
+ # @return [Boolean]
1453
+ def is_visible; end
1454
+ alias_method :visible?, :is_visible
1455
+
1456
+ # Returns child property at index i.
1457
+ # @param i [Integer]
1458
+ # @return [Wx::PG::PGProperty]
1459
+ def item(i) end
1460
+
1461
+ # Returns last sub-property.
1462
+ # @return [Wx::PG::PGProperty]
1463
+ def last; end
1464
+
1465
+ # If property's editor is created this forces its recreation.
1466
+ #
1467
+ # Useful in SetAttribute etc. Returns true if actually did anything.
1468
+ # @return [Boolean]
1469
+ def recreate_editor; end
1470
+
1471
+ # If property's editor is active, then update it's value.
1472
+ # @return [void]
1473
+ def refresh_editor; end
1474
+
1475
+ # Sets an attribute for this property.
1476
+ #
1477
+ # <div class="wxrb-remark">
1478
+ # <b>Remark:</b>
1479
+ # <p>Setting attribute's value to Null variant will simply remove it from property's set of attributes.
1480
+ # </p>
1481
+ # </div>
1482
+ # @param name [String] Text identifier of attribute. See wxPropertyGrid Property Attribute Identifiers.
1483
+ # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] Value of attribute.
1484
+ # @return [void]
1485
+ def set_attribute(name, value) end
1486
+
1487
+ # @param attributes [Wx::PGAttributeStorage]
1488
+ # @return [void]
1489
+ def set_attributes(attributes) end
1490
+
1491
+ # Set if user can change the property's value to unspecified by modifying the value of the editor control (usually by clearing it).
1492
+ #
1493
+ # Currently, this can work with following properties: {Wx::PG::IntProperty}, {Wx::PG::UIntProperty}, {Wx::PG::FloatProperty}, {Wx::PG::EditEnumProperty}.
1494
+ # @param enable [Boolean] Whether to enable or disable this behaviour (it is disabled by default).
1495
+ # @return [void]
1496
+ def set_auto_unspecified(enable=true) end
1497
+ alias_method :auto_unspecified=, :set_auto_unspecified
1498
+
1499
+ # Sets property's background colour.
1500
+ #
1501
+ # <div class="wxrb-remark">
1502
+ # <b>Remark:</b>
1503
+ # <p>Unlike {Wx::PG::PropertyGridInterface#set_property_background_colour}, this does not automatically update the display.
1504
+ # </p>
1505
+ # </div>
1506
+ # @param colour [Wx::Colour,String,Symbol] Background colour to use.
1507
+ # @param flags [Wx::PGPropertyValuesFlags] Default is {Wx::PG::PGPropertyValuesFlags::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.
1508
+ # @return [void]
1509
+ def set_background_colour(colour, flags=PGPropertyValuesFlags::Recurse) end
1510
+ alias_method :background_colour=, :set_background_colour
1511
+
1512
+ # @overload set_editor(editor)
1513
+ # Sets editor for a property.
1514
+ #
1515
+ # For custom editors, use pointer you received from {Wx::PG::PropertyGrid.register_editor_class}.
1516
+ # @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).
1517
+ # @return [void]
1518
+ # @overload set_editor(editorName)
1519
+ # Sets editor for a property, by editor name.
1520
+ # @param editorName [String]
1521
+ # @return [void]
1522
+ def set_editor(*args) end
1523
+ alias_method :editor=, :set_editor
1524
+
1525
+ # Sets cell information for given column.
1526
+ # @param column [Integer]
1527
+ # @param cell [Wx::PG::PGCell]
1528
+ # @return [void]
1529
+ def set_cell(column, cell) end
1530
+
1531
+ # Sets common value selected for this property.
1532
+ #
1533
+ # -1 for none.
1534
+ # @param commonValue [Integer]
1535
+ # @return [void]
1536
+ def set_common_value(commonValue) end
1537
+ alias_method :common_value=, :set_common_value
1538
+
1539
+ # Sets new set of choices for the property.
1540
+ #
1541
+ # <div class="wxrb-remark">
1542
+ # <b>Remark:</b>
1543
+ # <p>This operation deselects the property and clears its value.
1544
+ # </p>
1545
+ # </div>
1546
+ # @param choices [Wx::PG::PGChoices]
1547
+ # @return [Boolean]
1548
+ def set_choices(choices) end
1549
+ alias_method :choices=, :set_choices
1550
+
1551
+ # Sets client object of a property.
1552
+ # @param clientObject [Object]
1553
+ # @return [void]
1554
+ def set_client_object(clientObject) end
1555
+ alias_method :client_object=, :set_client_object
1556
+
1557
+ # Sets selected choice and changes property value.
1558
+ #
1559
+ # Tries to retain value type, although currently if it is not string, then it is forced to integer.
1560
+ # If newValue is {Wx::NOT_FOUND} (<code>-1</code>), then the property's value is reset to unspecified, as if {Wx::PG::PGProperty#set_value_to_unspecified} was called.
1561
+ # @param newValue [Integer]
1562
+ # @return [void]
1563
+ def set_choice_selection(newValue) end
1564
+ alias_method :choice_selection=, :set_choice_selection
1565
+
1566
+ # Set default value of a property.
1567
+ #
1568
+ # Synonymous to
1569
+ #
1570
+ # ```ruby
1571
+ # set_attribute('DefaultValue', value)
1572
+ # ```
1573
+ # @param value [Wx::Variant]
1574
+ # @return [void]
1575
+ def set_default_value(value) end
1576
+ alias_method :default_value=, :set_default_value
1577
+
1578
+ # @param expanded [Boolean]
1579
+ # @return [void]
1580
+ def set_expanded(expanded) end
1581
+ alias_method :expanded=, :set_expanded
1582
+
1583
+ # Sets flags from a '|' delimited string.
1584
+ #
1585
+ # Note that flag names are not prepended with '{Wx::PG::PGFlags}'.
1586
+ # @param str [String]
1587
+ # @return [void]
1588
+ def set_flags_from_string(str) end
1589
+ alias_method :flags_from_string=, :set_flags_from_string
1590
+
1591
+ # Sets or clears given property flag, recursively.
1592
+ #
1593
+ # This function is primarily intended for internal use.
1594
+ # @see Wx::PG::PGProperty#change_flag
1595
+ # @param flag [Wx::PGFlags]
1596
+ # @param set [Boolean]
1597
+ # @return [void]
1598
+ def set_flag_recursively(flag, set) end
1599
+
1600
+ # Sets property's help string, which is shown, for example, in {Wx::PG::PropertyGridManager}'s description text box.
1601
+ # @param helpString [String]
1602
+ # @return [void]
1603
+ def set_help_string(helpString) end
1604
+ alias_method :help_string=, :set_help_string
1605
+
1606
+ # Sets property's label.
1607
+ #
1608
+ # <div class="wxrb-remark">
1609
+ # <b>Remark:</b>
1610
+ # <p>
1611
+ #
1612
+ # - Properties under same parent may have same labels. However, property names must still remain unique.
1613
+ # - Unlike {Wx::PG::PropertyGridInterface#set_property_label}, this does not automatically update the display.
1614
+ #
1615
+ # </p>
1616
+ # </div>
1617
+ # @param label [String]
1618
+ # @return [void]
1619
+ def set_label(label) end
1620
+ alias_method :label=, :set_label
1621
+
1622
+ # Set maximum length of the text the user can enter in the text editor associated with property.
1623
+ #
1624
+ # It does not affect a text representation of the value already stored when the limit is set, nor does it affect the length of the text representation of the value set programmatically e.g. with {Wx::PG::PGProperty#set_value} or {Wx::PG::PropertyGridInterface#set_property_value}. If maxLen 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.
1625
+ # Returns true if maximum length was set.
1626
+ # @param maxLen [Integer]
1627
+ # @return [Boolean]
1628
+ def set_max_length(maxLen) end
1629
+ alias_method :max_length=, :set_max_length
1630
+
1631
+ # Sets property's "is it modified?" flag.
1632
+ #
1633
+ # Affects children recursively.
1634
+ # @param modified [Boolean]
1635
+ # @return [void]
1636
+ def set_modified_status(modified) end
1637
+ alias_method :modified_status=, :set_modified_status
1638
+
1639
+ # Sets new (base) name for property.
1640
+ # @param newName [String]
1641
+ # @return [void]
1642
+ def set_name(newName) end
1643
+ alias_method :name=, :set_name
1644
+
1645
+ # Changes what sort of parent this property is for its children.
1646
+ #
1647
+ # <div class="wxrb-remark">
1648
+ # <b>Remark:</b>
1649
+ # <p>You generally do not need to call this function.
1650
+ # </p>
1651
+ # </div>
1652
+ # @param flag [Wx::PGFlags] Use one of the following values: {Wx::PG::PGFlags::MiscParent} (for generic parents), {Wx::PG::PGFlags::Category} (for categories), or {Wx::PG::PGFlags::Aggregate} (for derived property classes with private children).
1653
+ # @return [void]
1654
+ def set_parental_type(flag) end
1655
+ alias_method :parental_type=, :set_parental_type
1656
+
1657
+ # Sets property's text colour.
1658
+ #
1659
+ # <div class="wxrb-remark">
1660
+ # <b>Remark:</b>
1661
+ # <p>Unlike {Wx::PG::PropertyGridInterface#set_property_text_colour}, this does not automatically update the display.
1662
+ # </p>
1663
+ # </div>
1664
+ # @param colour [Wx::Colour,String,Symbol] Text colour to use.
1665
+ # @param flags [Wx::PGPropertyValuesFlags] Default is {Wx::PG::PGPropertyValuesFlags::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.
1666
+ # @return [void]
1667
+ def set_text_colour(colour, flags=PGPropertyValuesFlags::Recurse) end
1668
+ alias_method :text_colour=, :set_text_colour
1669
+
1670
+ # Sets property's default text and background colours.
1671
+ #
1672
+ # <div class="wxrb-remark">
1673
+ # <b>Remark:</b>
1674
+ # <p>Unlike {Wx::PG::PropertyGridInterface#set_property_colours_to_default}, this does not automatically update the display.
1675
+ # </p>
1676
+ # </div>
1677
+ # @param flags [Wx::PGPropertyValuesFlags] Default is {Wx::PG::PGPropertyValuesFlags::Recurse} which causes colours to be set recursively. Omit this flag to only set colours for the property in question and not any of its children.
1678
+ # @return [void]
1679
+ def set_default_colours(flags=PGPropertyValuesFlags::Recurse) end
1680
+ alias_method :default_colours=, :set_default_colours
1681
+
1682
+ # Sets {Wx::Validator} for a property.
1683
+ # @param validator [Wx::Validator]
1684
+ # @return [void]
1685
+ def set_validator(validator) end
1686
+ alias_method :validator=, :set_validator
1687
+
1688
+ # Call this to set value of the property.
1689
+ #
1690
+ # Unlike methods in {Wx::PG::PropertyGrid}, this does not automatically update the display.
1691
+ #
1692
+ # <div class="wxrb-remark">
1693
+ # <b>Remark:</b>
1694
+ # <p>Use {Wx::PG::PropertyGrid#change_property_value} instead if you need to run through validation process and send property change event.
1695
+ # </p>
1696
+ # </div>
1697
+ #
1698
+ # If you need to change property value in event, based on user input, use {Wx::PG::PGProperty#set_value_in_event} instead.
1699
+ # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] The value to set.
1700
+ # @param pList [Wx::Variant] Pointer to list variant that contains child values. Used to indicate which children should be marked as modified. Usually you just use nil.
1701
+ # @param flags [Wx::PGSetValueFlags] {Wx::PG::PGSetValueFlags::RefreshEditor} is set by default, to refresh editor and redraw properties.
1702
+ # @return [void]
1703
+ def set_value(value, pList=nil, flags=PGSetValueFlags::RefreshEditor) end
1704
+ alias_method :value=, :set_value
1705
+
1706
+ # Set {Wx::Bitmap} taken from {Wx::BitmapBundle} in front of the value.
1707
+ #
1708
+ # This bitmap may be ignored by custom cell renderers.
1709
+ # @param bmp [Wx::BitmapBundle]
1710
+ # @return [void]
1711
+ def set_value_image(bmp) end
1712
+ alias_method :value_image=, :set_value_image
1713
+
1714
+ # Call this function in {Wx::PG::PGProperty#on_event}, OnButtonClick() etc.
1715
+ #
1716
+ # to change the property value based on user input.
1717
+ #
1718
+ # <div class="wxrb-remark">
1719
+ # <b>Remark:</b>
1720
+ # <p>This method is const since it doesn't actually modify value, but posts given variant as pending value, stored in {Wx::PG::PropertyGrid}.
1721
+ # </p>
1722
+ # </div>
1723
+ # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
1724
+ # @return [void]
1725
+ def set_value_in_event(value) end
1726
+ alias_method :value_in_event=, :set_value_in_event
1727
+
1728
+ # Sets property's value to unspecified (i.e.
1729
+ #
1730
+ # Null variant).
1731
+ # @return [void]
1732
+ def set_value_to_unspecified; end
1733
+
1734
+ # Call with false in {Wx::PG::PGProperty#on_set_value} to cancel value changes after all (i.e.
1735
+ #
1736
+ # cancel true returned by {Wx::PG::PGProperty#string_to_value} or {Wx::PG::PGProperty#int_to_value}).
1737
+ # @param set [Boolean]
1738
+ # @return [void]
1739
+ def set_was_modified(set=true) end
1740
+ alias_method :was_modified=, :set_was_modified
1741
+
1742
+ # Updates composed values of parent non-category properties, recursively.
1743
+ #
1744
+ # Returns topmost property updated.
1745
+ #
1746
+ # <div class="wxrb-remark">
1747
+ # <b>Remark:</b>
1748
+ # <p>Must not call {Wx::PG::PGProperty#set_value} (as can be called in it).
1749
+ # </p>
1750
+ # </div>
1751
+ # @return [Wx::PG::PGProperty]
1752
+ def update_parent_values; end
1753
+
1754
+ # Returns true if containing grid uses {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_AUTO_UNSPECIFIED_VALUES}.
1755
+ # @return [Boolean]
1756
+ def uses_auto_unspecified; end
1757
+
1758
+ # Clear cells associated with property.
1759
+ # @param ignoreWithFlags [Wx::PGFlags] Cells will not be cleared for properties having these flags set.
1760
+ # @param recursively [Boolean] If true, apply this operation recursively in child properties.
1761
+ # @return [void]
1762
+ def clear_cells(ignoreWithFlags, recursively) end
1763
+
1764
+ # Makes sure m_cells has size of column+1 (or more).
1765
+ # @param column [Integer]
1766
+ # @return [void]
1767
+ def ensure_cells(column) end
1768
+
1769
+ # Returns (direct) child property with given name (or nil if not found), with hint index.
1770
+ #
1771
+ # <div class="wxrb-remark">
1772
+ # <b>Remark:</b>
1773
+ # <p>Does not support scope (i.e. Parent.Child notation).
1774
+ # </p>
1775
+ # </div>
1776
+ # @param name [String] Name of the child property to look for.
1777
+ # @param hintIndex [Integer] Start looking for the child at this index.
1778
+ # @return [Wx::PG::PGProperty]
1779
+ def get_property_by_name_wh(name, hintIndex) end
1780
+ alias_method :property_by_name_wh, :get_property_by_name_wh
1781
+
1782
+ # Deletes all child properties.
1783
+ # @return [void]
1784
+ def empty; end
1785
+
1786
+ # Returns true if child property is selected.
1787
+ # @param recursive [Boolean]
1788
+ # @return [Boolean]
1789
+ def is_child_selected(recursive=false) end
1790
+ alias_method :child_selected?, :is_child_selected
1791
+
1792
+ #
1793
+ # @return [Wx::Variant]
1794
+ def value_; end
1795
+ #
1796
+ # @param val [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
1797
+ # @return [void]
1798
+ def value_=(val); end
1799
+
1800
+
1801
+ protected
1802
+
1803
+ # @overload initialize()
1804
+ # Default constructor.
1805
+ #
1806
+ # It is protected because {Wx::PG::PGProperty} is only a base class for other property classes.
1807
+ # @return [Wx::PG::PGProperty]
1808
+ # @overload initialize(label, name)
1809
+ # Constructor.
1810
+ #
1811
+ # It is protected because {Wx::PG::PGProperty} is only a base class for other property classes. Non-abstract property classes should have constructor of this style:
1812
+ #
1813
+ # ```ruby
1814
+ # class WxPointProperty < Wx::PG::PGProperty
1815
+ #
1816
+ # def initialize(label = Wx::PG::PG_LABEL, name = Wx::PG::PG_LABEL, value = Wx::Point.new)
1817
+ # super(label, name)
1818
+ #
1819
+ # # should work in pretty much 100% of cases
1820
+ # self.value = value
1821
+ #
1822
+ # # add private child properties
1823
+ # add_private_child( Wx::PG::IntProperty.new("X", Wx::PG::PG_LABEL,value.x))
1824
+ # add_private_child( Wx::PG::IntProperty.new("Y", Wx::PG::PG_LABEL,value.y))
1825
+ # end
1826
+ #
1827
+ # # ...
1828
+ #
1829
+ # end
1830
+ # ```
1831
+ # @param label [String]
1832
+ # @param name [String]
1833
+ # @return [Wx::PG::PGProperty]
1834
+ def initialize(*args) end
1835
+
1836
+ end # PGProperty
1837
+
1838
+ # Helper class for managing choices of {Wx::PG::PropertyGrid} properties.
1839
+ #
1840
+ # Each entry can have label, value, bitmap, text colour, and background colour.
1841
+ # {Wx::PG::PGChoices} uses reference counting, similar to other wxWidgets classes. This means that assignment operator and copy constructor only copy the reference and not the actual data. Use {Wx::PG::PGChoices#copy} member function to create a real copy.
1842
+ #
1843
+ # <div class="wxrb-remark">
1844
+ # <b>Remark:</b>
1845
+ # <p>If you do not specify value for entry, index is used.
1846
+ # </p>
1847
+ # </div>
1848
+ #
1849
+ # Category: {Wx::PG::PropertyGrid}
1850
+ #
1851
+ #
1852
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1853
+ # @wxrb_require USE_PROPGRID
1854
+ class PGChoices < ::Object
1855
+
1856
+ # @overload initialize()
1857
+ # Default constructor.
1858
+ # @return [Wx::PG::PGChoices]
1859
+ # @overload initialize(a)
1860
+ # Copy constructor, uses reference counting.
1861
+ #
1862
+ # To create a real copy, use {Wx::PG::PGChoices#copy} member function instead.
1863
+ # @param a [Wx::PG::PGChoices]
1864
+ # @return [Wx::PG::PGChoices]
1865
+ # @overload initialize(labels, values=(Wx::ArrayInt.new()))
1866
+ # Constructor.
1867
+ # @param labels [Array<String>] Labels for choices.
1868
+ # @param values [Array<Integer>] Values for choices. If empty, indexes are used. Otherwise must have at least the same size as labels.
1869
+ # @return [Wx::PG::PGChoices]
1870
+ def initialize(*args) end
1871
+
1872
+ # @overload add(arr, arrint)
1873
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
1874
+ # @param arr [Array<String>]
1875
+ # @param arrint [Array<Integer>]
1876
+ # @return [void]
1877
+ # @overload add(label, value=Wx::PG::PG_INVALID_VALUE)
1878
+ # Adds a single choice item.
1879
+ # @param label [String] Label for added choice.
1880
+ # @param value [Integer] Value for added choice. If unspecified, index is used.
1881
+ # @return [Wx::PGChoiceEntry]
1882
+ # @overload add(label, bitmap, value=Wx::PG::PG_INVALID_VALUE)
1883
+ # Adds a single item, with bitmap.
1884
+ # @param label [String]
1885
+ # @param bitmap [Wx::Bitmap]
1886
+ # @param value [Integer]
1887
+ # @return [Wx::PGChoiceEntry]
1888
+ # @overload add(entry)
1889
+ # Adds a single item with full entry information.
1890
+ # @param entry [Wx::PG::PGChoiceEntry]
1891
+ # @return [Wx::PGChoiceEntry]
1892
+ def add(*args) end
1893
+
1894
+ # Adds a single item, sorted.
1895
+ # @param label [String]
1896
+ # @param value [Integer]
1897
+ # @return [Wx::PGChoiceEntry]
1898
+ def add_as_sorted(label, value=Wx::PG::PG_INVALID_VALUE) end
1899
+
1900
+ # Assigns choices data, using reference counting.
1901
+ #
1902
+ # To create a real copy, use {Wx::PG::PGChoices#copy} member function instead.
1903
+ # @param a [Wx::PG::PGChoices]
1904
+ # @return [void]
1905
+ def assign(a) end
1906
+
1907
+ # Deletes all items.
1908
+ # @return [void]
1909
+ def clear; end
1910
+
1911
+ # Returns a real copy of the choices.
1912
+ # @return [Wx::PG::PGChoices]
1913
+ def copy; end
1914
+
1915
+ # @return [void]
1916
+ def ensure_data; end
1917
+
1918
+ # Returns label of item.
1919
+ # @param ind [Integer]
1920
+ # @return [Wx::String]
1921
+ def get_label(ind) end
1922
+ alias_method :label, :get_label
1923
+
1924
+ # Returns number of items.
1925
+ # @return [Integer]
1926
+ def get_count; end
1927
+ alias_method :count, :get_count
1928
+
1929
+ # Returns value of item.
1930
+ # @param ind [Integer]
1931
+ # @return [Integer]
1932
+ def get_value(ind) end
1933
+ alias_method :value, :get_value
1934
+
1935
+ # Returns array of values matching the given strings.
1936
+ #
1937
+ # Unmatching strings result in {Wx::PG::PG_INVALID_VALUE} entry in array.
1938
+ # @param strings [Array<String>]
1939
+ # @return [Array<Integer>]
1940
+ def get_values_for_strings(strings) end
1941
+ alias_method :values_for_strings, :get_values_for_strings
1942
+
1943
+ # Returns array of indices matching given strings.
1944
+ #
1945
+ # Unmatching strings are added to 'unmatched', if not nil.
1946
+ # @param strings [Array<String>]
1947
+ # @param unmatched [Array,nil]
1948
+ # @return [Array<Integer>]
1949
+ def get_indices_for_strings(strings, unmatched=nil) end
1950
+ alias_method :indices_for_strings, :get_indices_for_strings
1951
+
1952
+ # @overload index(label)
1953
+ # Returns index of item with given label.
1954
+ # @param label [String]
1955
+ # @return [Integer]
1956
+ # @overload index(val)
1957
+ # Returns index of item with given value.
1958
+ # @param val [Integer]
1959
+ # @return [Integer]
1960
+ def index(*args) end
1961
+
1962
+ # @overload insert(label, index, value=Wx::PG::PG_INVALID_VALUE)
1963
+ # Inserts a single item.
1964
+ # @param label [String]
1965
+ # @param index [Integer]
1966
+ # @param value [Integer]
1967
+ # @return [Wx::PGChoiceEntry]
1968
+ # @overload insert(entry, index)
1969
+ # Inserts a single item with full entry information.
1970
+ # @param entry [Wx::PG::PGChoiceEntry]
1971
+ # @param index [Integer]
1972
+ # @return [Wx::PGChoiceEntry]
1973
+ def insert(*args) end
1974
+
1975
+ # Returns false if this is a constant empty set of choices, which should not be modified.
1976
+ # @return [Boolean]
1977
+ def is_ok; end
1978
+ alias_method :ok?, :is_ok
1979
+
1980
+ # Returns item at given index.
1981
+ # @param i [Integer]
1982
+ # @return [Wx::PG::PGChoiceEntry]
1983
+ def item(i) end
1984
+
1985
+ # Removes count items starting at position nIndex.
1986
+ # @param nIndex [Integer]
1987
+ # @param count [Integer]
1988
+ # @return [void]
1989
+ def remove_at(nIndex, count=1) end
1990
+
1991
+ # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
1992
+ # @param labels [Array<String>]
1993
+ # @param values [Array<Integer>]
1994
+ # @return [void]
1995
+ def set(labels, values=(Wx::ArrayInt.new())) end
1996
+
1997
+ # Creates exclusive copy of current choices.
1998
+ # @return [void]
1999
+ def alloc_exclusive; end
2000
+
2001
+ # Returns array of choice labels.
2002
+ # @return [Array<String>]
2003
+ def get_labels; end
2004
+ alias_method :labels, :get_labels
2005
+
2006
+ # @overload [](i)
2007
+ # @param i [Integer]
2008
+ # @return [Wx::PGChoiceEntry]
2009
+ # @overload [](i)
2010
+ # @param i [Integer]
2011
+ # @return [Wx::PG::PGChoiceEntry]
2012
+ def [](*args) end
2013
+
2014
+ end # PGChoices
2015
+
2016
+ # Contains information related to property's OnCustomPaint.
2017
+ #
2018
+ #
2019
+ #
2020
+ #
2021
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2022
+ # @wxrb_require USE_PROPGRID
2023
+ class PGPaintData < ::Object
2024
+
2025
+ # {Wx::PG::PropertyGrid}
2026
+ #
2027
+ #
2028
+ # @return [Wx::PG::PropertyGrid]
2029
+ def parent; end
2030
+ # {Wx::PG::PropertyGrid}
2031
+ #
2032
+ #
2033
+ # @param val [Wx::PG::PropertyGrid]
2034
+ # @return [void]
2035
+ def parent=(val); end
2036
+
2037
+ # Normally -1, otherwise index to drop-down list item that has to be drawn.
2038
+ #
2039
+ #
2040
+ # @return [Integer]
2041
+ def choice_item; end
2042
+ # Normally -1, otherwise index to drop-down list item that has to be drawn.
2043
+ #
2044
+ #
2045
+ # @param val [Integer]
2046
+ # @return [void]
2047
+ def choice_item=(val); end
2048
+
2049
+ # Set to drawn width in OnCustomPaint (optional).
2050
+ #
2051
+ #
2052
+ # @return [Integer]
2053
+ def drawn_width; end
2054
+ # Set to drawn width in OnCustomPaint (optional).
2055
+ #
2056
+ #
2057
+ # @param val [Integer]
2058
+ # @return [void]
2059
+ def drawn_width=(val); end
2060
+
2061
+ # In a measure item call, set this to the height of item at m_choiceItem index.
2062
+ #
2063
+ #
2064
+ # @return [Integer]
2065
+ def drawn_height; end
2066
+ # In a measure item call, set this to the height of item at m_choiceItem index.
2067
+ #
2068
+ #
2069
+ # @param val [Integer]
2070
+ # @return [void]
2071
+ def drawn_height=(val); end
2072
+
2073
+ end # PGPaintData
2074
+
2075
+
2076
+ end
2077
+
2078
+ end