wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (646) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +35 -29
  3. data/README.md +24 -15
  4. data/ext/wxbase32u_gcc_custom.dll +0 -0
  5. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  7. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  19. data/lib/wx/core/bitmap_combobox.rb +17 -21
  20. data/lib/wx/core/combobox.rb +13 -3
  21. data/lib/wx/core/controlwithitems.rb +40 -130
  22. data/lib/wx/core/enum.rb +17 -1
  23. data/lib/wx/core/event.rb +6 -1
  24. data/lib/wx/core/events/evt_list.rb +5 -4
  25. data/lib/wx/core/evthandler.rb +8 -2
  26. data/lib/wx/core/generic_validator.rb +312 -0
  27. data/lib/wx/core/listbox.rb +2 -2
  28. data/lib/wx/core/log.rb +1 -1
  29. data/lib/wx/core/owner_drawn_combobox.rb +45 -0
  30. data/lib/wx/core/size.rb +4 -0
  31. data/lib/wx/core/sizer.rb +1 -2
  32. data/lib/wx/core/standard_paths.rb +22 -0
  33. data/lib/wx/core/text_entry.rb +4 -1
  34. data/lib/wx/core/validator.rb +70 -5
  35. data/lib/wx/core/window.rb +3 -7
  36. data/lib/wx/doc/art_locator.rb +1 -0
  37. data/lib/wx/doc/comboctrl.rb +18 -0
  38. data/lib/wx/doc/controlwithitems.rb +16 -0
  39. data/lib/wx/doc/date_picker_ctrl.rb +23 -0
  40. data/lib/wx/doc/editable_listbox.rb +44 -0
  41. data/lib/wx/doc/enum.rb +15 -0
  42. data/lib/wx/doc/event.rb +12 -0
  43. data/lib/wx/doc/extra/12_client_data.md +89 -0
  44. data/lib/wx/doc/extra/13_validators.md +139 -0
  45. data/lib/wx/doc/gdi_common.rb +4 -0
  46. data/lib/wx/doc/gen/about_dialog_info.rb +25 -0
  47. data/lib/wx/doc/gen/accelerator.rb +7 -1
  48. data/lib/wx/doc/gen/accessible.rb +13 -0
  49. data/lib/wx/doc/gen/activity_indicator.rb +7 -0
  50. data/lib/wx/doc/gen/animation.rb +12 -0
  51. data/lib/wx/doc/gen/animation_ctrl.rb +10 -0
  52. data/lib/wx/doc/gen/any_button.rb +17 -1
  53. data/lib/wx/doc/gen/app.rb +35 -1
  54. data/lib/wx/doc/gen/app_traits.rb +38 -5
  55. data/lib/wx/doc/gen/art_provider.rb +14 -0
  56. data/lib/wx/doc/gen/aui/aui_dock_art.rb +12 -0
  57. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +1 -0
  58. data/lib/wx/doc/gen/aui/aui_manager.rb +24 -1
  59. data/lib/wx/doc/gen/aui/aui_manager_event.rb +9 -1
  60. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +3 -0
  61. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +2 -0
  62. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +3 -1
  63. data/lib/wx/doc/gen/aui/aui_notebook.rb +20 -2
  64. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +2 -1
  65. data/lib/wx/doc/gen/aui/aui_pane_info.rb +30 -1
  66. data/lib/wx/doc/gen/aui/aui_tab_art.rb +6 -0
  67. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +1 -0
  68. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +11 -0
  69. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +2 -0
  70. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +2 -1
  71. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +4 -0
  72. data/lib/wx/doc/gen/banner_window.rb +7 -0
  73. data/lib/wx/doc/gen/bitmap.rb +64 -3
  74. data/lib/wx/doc/gen/bitmap_button.rb +6 -1
  75. data/lib/wx/doc/gen/bitmap_combo_box.rb +9 -3
  76. data/lib/wx/doc/gen/book_ctrl_base.rb +17 -2
  77. data/lib/wx/doc/gen/book_ctrl_event.rb +3 -1
  78. data/lib/wx/doc/gen/box_sizer.rb +5 -0
  79. data/lib/wx/doc/gen/brush.rb +16 -1
  80. data/lib/wx/doc/gen/busy_info.rb +8 -0
  81. data/lib/wx/doc/gen/button.rb +11 -3
  82. data/lib/wx/doc/gen/calculate_layout_event.rb +4 -0
  83. data/lib/wx/doc/gen/calendar_ctrl.rb +22 -0
  84. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -0
  85. data/lib/wx/doc/gen/calendar_event.rb +3 -1
  86. data/lib/wx/doc/gen/caret.rb +3 -0
  87. data/lib/wx/doc/gen/check_box.rb +10 -0
  88. data/lib/wx/doc/gen/check_list_box.rb +3 -0
  89. data/lib/wx/doc/gen/choice.rb +14 -2
  90. data/lib/wx/doc/gen/choicebook.rb +1 -0
  91. data/lib/wx/doc/gen/client_dc.rb +1 -0
  92. data/lib/wx/doc/gen/clipboard.rb +9 -0
  93. data/lib/wx/doc/gen/collapsible_pane.rb +3 -0
  94. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -0
  95. data/lib/wx/doc/gen/colour.rb +20 -0
  96. data/lib/wx/doc/gen/colour_dialog.rb +10 -0
  97. data/lib/wx/doc/gen/colour_picker_ctrl.rb +4 -0
  98. data/lib/wx/doc/gen/colour_picker_event.rb +1 -0
  99. data/lib/wx/doc/gen/combo_box.rb +20 -1
  100. data/lib/wx/doc/gen/combo_ctrl.rb +54 -295
  101. data/lib/wx/doc/gen/command_link_button.rb +8 -0
  102. data/lib/wx/doc/gen/context_help_button.rb +7 -1
  103. data/lib/wx/doc/gen/control.rb +12 -0
  104. data/lib/wx/doc/gen/control_with_items.rb +45 -9
  105. data/lib/wx/doc/gen/core.rb +2 -2
  106. data/lib/wx/doc/gen/cursor.rb +4 -0
  107. data/lib/wx/doc/gen/data_format.rb +1 -0
  108. data/lib/wx/doc/gen/data_object.rb +27 -5
  109. data/lib/wx/doc/gen/date_event.rb +2 -1
  110. data/lib/wx/doc/gen/date_picker_ctrl.rb +7 -1
  111. data/lib/wx/doc/gen/dc.rb +87 -3
  112. data/lib/wx/doc/gen/dial_up_event.rb +2 -0
  113. data/lib/wx/doc/gen/dial_up_manager.rb +12 -0
  114. data/lib/wx/doc/gen/dialog.rb +42 -3
  115. data/lib/wx/doc/gen/dir_dialog.rb +6 -1
  116. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -0
  117. data/lib/wx/doc/gen/dir_picker_ctrl.rb +5 -0
  118. data/lib/wx/doc/gen/drag_drop.rb +20 -0
  119. data/lib/wx/doc/gen/drag_image.rb +7 -0
  120. data/lib/wx/doc/gen/editable_list_box.rb +5 -3
  121. data/lib/wx/doc/gen/event.rb +26 -11
  122. data/lib/wx/doc/gen/event_blocker.rb +2 -1
  123. data/lib/wx/doc/gen/event_filter.rb +3 -0
  124. data/lib/wx/doc/gen/event_list.rb +4 -4
  125. data/lib/wx/doc/gen/events.rb +165 -26
  126. data/lib/wx/doc/gen/evt_handler.rb +40 -2
  127. data/lib/wx/doc/gen/ext_help_controller.rb +9 -0
  128. data/lib/wx/doc/gen/file_ctrl.rb +11 -2
  129. data/lib/wx/doc/gen/file_ctrl_event.rb +5 -1
  130. data/lib/wx/doc/gen/file_dialog.rb +13 -0
  131. data/lib/wx/doc/gen/file_dialog_custom_control.rb +12 -0
  132. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +9 -0
  133. data/lib/wx/doc/gen/file_dir_picker_event.rb +2 -1
  134. data/lib/wx/doc/gen/file_picker_ctrl.rb +4 -0
  135. data/lib/wx/doc/gen/file_system.rb +17 -1
  136. data/lib/wx/doc/gen/find_dialog_event.rb +2 -1
  137. data/lib/wx/doc/gen/find_replace_data.rb +1 -0
  138. data/lib/wx/doc/gen/find_replace_dialog.rb +3 -0
  139. data/lib/wx/doc/gen/flex_grid_sizer.rb +13 -0
  140. data/lib/wx/doc/gen/font.rb +75 -3
  141. data/lib/wx/doc/gen/font_data.rb +14 -0
  142. data/lib/wx/doc/gen/font_dialog.rb +6 -0
  143. data/lib/wx/doc/gen/font_picker_ctrl.rb +8 -0
  144. data/lib/wx/doc/gen/font_picker_event.rb +1 -0
  145. data/lib/wx/doc/gen/frame.rb +24 -7
  146. data/lib/wx/doc/gen/fs_file.rb +22 -0
  147. data/lib/wx/doc/gen/gauge.rb +8 -0
  148. data/lib/wx/doc/gen/gb_sizer_item.rb +5 -0
  149. data/lib/wx/doc/gen/gcdc.rb +2 -0
  150. data/lib/wx/doc/gen/gdi_common.rb +50 -0
  151. data/lib/wx/doc/gen/gdi_object.rb +1 -0
  152. data/lib/wx/doc/gen/generic_dir_ctrl.rb +7 -0
  153. data/lib/wx/doc/gen/graphics_context.rb +36 -7
  154. data/lib/wx/doc/gen/graphics_object.rb +24 -0
  155. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +2 -0
  156. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +14 -2
  157. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +1 -0
  158. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +1 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +2 -0
  160. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +1 -0
  161. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +2 -0
  162. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +1 -0
  163. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +1 -0
  164. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +1 -0
  165. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +9 -0
  166. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +1 -0
  167. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +1 -0
  168. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +1 -0
  169. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +2 -0
  170. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +2 -0
  171. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +1 -0
  172. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +6 -0
  173. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +1 -0
  174. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +1 -0
  175. data/lib/wx/doc/gen/grid/grid_ctrl.rb +229 -7
  176. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +4 -1
  177. data/lib/wx/doc/gen/grid/grid_event.rb +4 -1
  178. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +2 -1
  179. data/lib/wx/doc/gen/grid/grid_size_event.rb +2 -1
  180. data/lib/wx/doc/gen/grid/grid_string_table.rb +7 -0
  181. data/lib/wx/doc/gen/grid/grid_table_base.rb +27 -1
  182. data/lib/wx/doc/gen/grid/grid_table_message.rb +1 -0
  183. data/lib/wx/doc/gen/grid_bag_sizer.rb +24 -4
  184. data/lib/wx/doc/gen/grid_sizer.rb +11 -0
  185. data/lib/wx/doc/gen/gui_event_loop.rb +12 -0
  186. data/lib/wx/doc/gen/header_ctrl.rb +106 -0
  187. data/lib/wx/doc/gen/header_ctrl_event.rb +5 -1
  188. data/lib/wx/doc/gen/help_controller.rb +11 -0
  189. data/lib/wx/doc/gen/help_provider.rb +12 -3
  190. data/lib/wx/doc/gen/html/html_cell.rb +25 -0
  191. data/lib/wx/doc/gen/html/html_cell_event.rb +3 -1
  192. data/lib/wx/doc/gen/html/html_easy_printing.rb +13 -1
  193. data/lib/wx/doc/gen/html/html_help_controller.rb +18 -0
  194. data/lib/wx/doc/gen/html/html_help_data.rb +5 -0
  195. data/lib/wx/doc/gen/html/html_help_window.rb +8 -0
  196. data/lib/wx/doc/gen/html/html_link_event.rb +1 -0
  197. data/lib/wx/doc/gen/html/html_list_box.rb +49 -9
  198. data/lib/wx/doc/gen/html/html_printout.rb +7 -0
  199. data/lib/wx/doc/gen/html/html_window.rb +31 -0
  200. data/lib/wx/doc/gen/hyperlink_ctrl.rb +2 -1
  201. data/lib/wx/doc/gen/hyperlink_event.rb +1 -0
  202. data/lib/wx/doc/gen/icon.rb +19 -1
  203. data/lib/wx/doc/gen/icon_location.rb +1 -0
  204. data/lib/wx/doc/gen/image.rb +67 -10
  205. data/lib/wx/doc/gen/image_list.rb +12 -2
  206. data/lib/wx/doc/gen/info_bar.rb +12 -0
  207. data/lib/wx/doc/gen/keyboard_state.rb +11 -0
  208. data/lib/wx/doc/gen/list_box.rb +20 -3
  209. data/lib/wx/doc/gen/list_ctrl.rb +89 -0
  210. data/lib/wx/doc/gen/list_event.rb +11 -1
  211. data/lib/wx/doc/gen/listbook.rb +1 -0
  212. data/lib/wx/doc/gen/locale.rb +22 -0
  213. data/lib/wx/doc/gen/log.rb +42 -0
  214. data/lib/wx/doc/gen/mdi_client_window.rb +4 -1
  215. data/lib/wx/doc/gen/mdi_frame.rb +27 -4
  216. data/lib/wx/doc/gen/media_ctrl.rb +17 -0
  217. data/lib/wx/doc/gen/media_event.rb +2 -1
  218. data/lib/wx/doc/gen/memory_dc.rb +10 -0
  219. data/lib/wx/doc/gen/menu.rb +48 -7
  220. data/lib/wx/doc/gen/menu_bar.rb +32 -13
  221. data/lib/wx/doc/gen/menu_item.rb +26 -0
  222. data/lib/wx/doc/gen/message_dialog.rb +10 -0
  223. data/lib/wx/doc/gen/mini_frame.rb +5 -2
  224. data/lib/wx/doc/gen/mirror_dc.rb +1 -0
  225. data/lib/wx/doc/gen/mouse_state.rb +1 -0
  226. data/lib/wx/doc/gen/multi_choice_dialog.rb +3 -1
  227. data/lib/wx/doc/gen/non_owned_window.rb +3 -0
  228. data/lib/wx/doc/gen/notebook.rb +11 -1
  229. data/lib/wx/doc/gen/num_validator.rb +37 -0
  230. data/lib/wx/doc/gen/number_entry_dialog.rb +4 -0
  231. data/lib/wx/doc/gen/object.rb +3 -0
  232. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +340 -0
  233. data/lib/wx/doc/gen/paint_dc.rb +1 -0
  234. data/lib/wx/doc/gen/palette.rb +5 -0
  235. data/lib/wx/doc/gen/panel.rb +10 -2
  236. data/lib/wx/doc/gen/pen.rb +30 -1
  237. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +2 -1
  238. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +4 -1
  239. data/lib/wx/doc/gen/pg/pg_cell.rb +6 -1
  240. data/lib/wx/doc/gen/pg/pg_editor.rb +61 -15
  241. data/lib/wx/doc/gen/pg/pg_multi_button.rb +2 -0
  242. data/lib/wx/doc/gen/pg/pg_properties.rb +198 -81
  243. data/lib/wx/doc/gen/pg/pg_property.rb +129 -52
  244. data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
  245. data/lib/wx/doc/gen/pg/property_grid.rb +56 -14
  246. data/lib/wx/doc/gen/pg/property_grid_event.rb +16 -6
  247. data/lib/wx/doc/gen/pg/property_grid_interface.rb +98 -37
  248. data/lib/wx/doc/gen/pg/property_grid_manager.rb +29 -7
  249. data/lib/wx/doc/gen/pg/property_grid_page.rb +11 -4
  250. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +7 -2
  251. data/lib/wx/doc/gen/picker_base.rb +11 -1
  252. data/lib/wx/doc/gen/platform_info.rb +31 -0
  253. data/lib/wx/doc/gen/popup_window.rb +5 -0
  254. data/lib/wx/doc/gen/progress_dialog.rb +4 -0
  255. data/lib/wx/doc/gen/property_sheet_dialog.rb +7 -1
  256. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +2 -0
  257. data/lib/wx/doc/gen/prt/post_script_dc.rb +1 -0
  258. data/lib/wx/doc/gen/prt/preview_frame.rb +4 -0
  259. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +1 -0
  260. data/lib/wx/doc/gen/prt/print_data.rb +27 -0
  261. data/lib/wx/doc/gen/prt/print_dialog.rb +4 -0
  262. data/lib/wx/doc/gen/prt/printer.rb +42 -5
  263. data/lib/wx/doc/gen/prt/printer_dc.rb +2 -0
  264. data/lib/wx/doc/gen/query_layout_info_event.rb +9 -0
  265. data/lib/wx/doc/gen/radio_box.rb +19 -0
  266. data/lib/wx/doc/gen/radio_button.rb +9 -0
  267. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +63 -0
  268. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +23 -0
  269. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +2 -1
  270. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +35 -9
  271. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +2 -1
  272. data/lib/wx/doc/gen/rbn/ribbon_control.rb +10 -0
  273. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +17 -7
  274. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +2 -1
  275. data/lib/wx/doc/gen/rbn/ribbon_page.rb +12 -0
  276. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +11 -0
  277. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +2 -1
  278. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +25 -0
  279. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +2 -1
  280. data/lib/wx/doc/gen/rearrange_ctrl.rb +4 -0
  281. data/lib/wx/doc/gen/rearrange_list.rb +9 -0
  282. data/lib/wx/doc/gen/region.rb +42 -13
  283. data/lib/wx/doc/gen/region_iterator.rb +1 -0
  284. data/lib/wx/doc/gen/rtc/rich_text_box.rb +25 -8
  285. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +41 -4
  286. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +1 -0
  287. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +23 -11
  288. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +74 -0
  289. data/lib/wx/doc/gen/rtc/rich_text_event.rb +6 -1
  290. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +8 -0
  291. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +6 -0
  292. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +1 -0
  293. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +4 -0
  294. data/lib/wx/doc/gen/rtc/rich_text_image.rb +7 -0
  295. data/lib/wx/doc/gen/rtc/rich_text_object.rb +64 -4
  296. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +51 -4
  297. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +13 -0
  298. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +9 -4
  299. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +3 -0
  300. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +2 -0
  301. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +1 -0
  302. data/lib/wx/doc/gen/sash_event.rb +5 -1
  303. data/lib/wx/doc/gen/sash_layout_window.rb +10 -0
  304. data/lib/wx/doc/gen/sash_window.rb +3 -0
  305. data/lib/wx/doc/gen/screen_dc.rb +1 -0
  306. data/lib/wx/doc/gen/scroll_bar.rb +11 -2
  307. data/lib/wx/doc/gen/scrolled_canvas.rb +20 -4
  308. data/lib/wx/doc/gen/scrolled_control.rb +20 -4
  309. data/lib/wx/doc/gen/scrolled_window.rb +20 -4
  310. data/lib/wx/doc/gen/search_ctrl.rb +6 -0
  311. data/lib/wx/doc/gen/simplebook.rb +7 -0
  312. data/lib/wx/doc/gen/single_choice_dialog.rb +3 -1
  313. data/lib/wx/doc/gen/sizer.rb +79 -9
  314. data/lib/wx/doc/gen/sizer_item.rb +16 -2
  315. data/lib/wx/doc/gen/slider.rb +23 -0
  316. data/lib/wx/doc/gen/spin_button.rb +9 -0
  317. data/lib/wx/doc/gen/spin_ctrl.rb +11 -0
  318. data/lib/wx/doc/gen/spin_ctrl_double.rb +7 -0
  319. data/lib/wx/doc/gen/spin_double_event.rb +4 -1
  320. data/lib/wx/doc/gen/spin_event.rb +2 -1
  321. data/lib/wx/doc/gen/splash_screen.rb +2 -0
  322. data/lib/wx/doc/gen/splitter_event.rb +10 -1
  323. data/lib/wx/doc/gen/splitter_window.rb +38 -14
  324. data/lib/wx/doc/gen/static_bitmap.rb +99 -2
  325. data/lib/wx/doc/gen/static_box.rb +6 -0
  326. data/lib/wx/doc/gen/static_box_sizer.rb +3 -0
  327. data/lib/wx/doc/gen/static_line.rb +4 -0
  328. data/lib/wx/doc/gen/static_text.rb +5 -0
  329. data/lib/wx/doc/gen/status_bar.rb +17 -3
  330. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +174 -6
  331. data/lib/wx/doc/gen/stc/styled_text_event.rb +27 -1
  332. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +7 -0
  333. data/lib/wx/doc/gen/svg_file_dc.rb +9 -0
  334. data/lib/wx/doc/gen/system_options.rb +8 -0
  335. data/lib/wx/doc/gen/system_settings.rb +7 -0
  336. data/lib/wx/doc/gen/task_bar_button.rb +12 -0
  337. data/lib/wx/doc/gen/task_bar_icon.rb +5 -0
  338. data/lib/wx/doc/gen/task_bar_icon_event.rb +2 -1
  339. data/lib/wx/doc/gen/text_attr.rb +27 -0
  340. data/lib/wx/doc/gen/text_ctrl.rb +27 -3
  341. data/lib/wx/doc/gen/text_entry.rb +43 -5
  342. data/lib/wx/doc/gen/text_entry_dialog.rb +12 -0
  343. data/lib/wx/doc/gen/text_validator.rb +16 -0
  344. data/lib/wx/doc/gen/time_picker_ctrl.rb +6 -0
  345. data/lib/wx/doc/gen/timer.rb +8 -0
  346. data/lib/wx/doc/gen/timer_event.rb +1 -0
  347. data/lib/wx/doc/gen/tip_provider.rb +5 -0
  348. data/lib/wx/doc/gen/toggle_button.rb +68 -0
  349. data/lib/wx/doc/gen/tool_bar.rb +57 -14
  350. data/lib/wx/doc/gen/tool_tip.rb +6 -0
  351. data/lib/wx/doc/gen/toolbook.rb +3 -0
  352. data/lib/wx/doc/gen/top_level_window.rb +34 -3
  353. data/lib/wx/doc/gen/tree_ctrl.rb +49 -0
  354. data/lib/wx/doc/gen/tree_event.rb +7 -1
  355. data/lib/wx/doc/gen/treebook.rb +9 -0
  356. data/lib/wx/doc/gen/ui_action_simulator.rb +4 -0
  357. data/lib/wx/doc/gen/utils.rb +55 -0
  358. data/lib/wx/doc/gen/v_list_box.rb +21 -0
  359. data/lib/wx/doc/gen/v_scrolled_window.rb +15 -0
  360. data/lib/wx/doc/gen/validator.rb +9 -13
  361. data/lib/wx/doc/gen/variant.rb +6 -0
  362. data/lib/wx/doc/gen/window.rb +260 -52
  363. data/lib/wx/doc/gen/window_dc.rb +2 -0
  364. data/lib/wx/doc/gen/window_disabler.rb +1 -0
  365. data/lib/wx/doc/gen/with_images.rb +7 -1
  366. data/lib/wx/doc/gen/wizard.rb +18 -0
  367. data/lib/wx/doc/gen/wizard_event.rb +3 -1
  368. data/lib/wx/doc/gen/wizard_page.rb +5 -0
  369. data/lib/wx/doc/gen/wizard_page_simple.rb +4 -0
  370. data/lib/wx/doc/gen/wrap_sizer.rb +5 -0
  371. data/lib/wx/doc/gen/xml_node.rb +14 -0
  372. data/lib/wx/doc/gen/xml_resource.rb +22 -0
  373. data/lib/wx/doc/generic_validator.rb +95 -0
  374. data/lib/wx/doc/html/simple_html_listbox.rb +22 -0
  375. data/lib/wx/doc/num_validator.rb +387 -0
  376. data/lib/wx/doc/owner_drawn_combobox.rb +96 -0
  377. data/lib/wx/doc/pg/numeric_property_validator.rb +33 -0
  378. data/lib/wx/doc/static_bitmap.rb +25 -0
  379. data/lib/wx/doc/text_validator.rb +10 -0
  380. data/lib/wx/doc/validator.rb +113 -0
  381. data/lib/wx/doc/window.rb +30 -0
  382. data/lib/wx/html/events/evt_list.rb +0 -10
  383. data/lib/wx/html/simple_html_listbox.rb +24 -91
  384. data/lib/wx/keyword_defs.rb +34 -2
  385. data/lib/wx/rbn/ribbon_gallery.rb +0 -21
  386. data/lib/wx/version.rb +1 -1
  387. data/lib/wxruby_aui.so +0 -0
  388. data/lib/wxruby_core.so +0 -0
  389. data/lib/wxruby_grid.so +0 -0
  390. data/lib/wxruby_html.so +0 -0
  391. data/lib/wxruby_pg.so +0 -0
  392. data/lib/wxruby_prt.so +0 -0
  393. data/lib/wxruby_rbn.so +0 -0
  394. data/lib/wxruby_rtc.so +0 -0
  395. data/lib/wxruby_stc.so +0 -0
  396. data/rakelib/lib/config/mingw.rb +12 -0
  397. data/samples/aui/aui.rb +1237 -1233
  398. data/samples/calendar/calendar.rb +293 -289
  399. data/samples/controls/get_item_sample.rb +83 -79
  400. data/samples/controls/htlbox.rb +331 -327
  401. data/samples/dialogs/dialogs.rb +682 -694
  402. data/samples/dialogs/wizard.rb +52 -55
  403. data/samples/dragdrop/dragdrop.rb +146 -142
  404. data/samples/drawing/bitmap.rb +29 -26
  405. data/samples/drawing/bitmap_image.rb +84 -80
  406. data/samples/drawing/graphics_drawing.rb +209 -205
  407. data/samples/drawing/image_prt.rb +344 -340
  408. data/samples/drawing/maths_images.rb +18 -1
  409. data/samples/drawing/rmagic_bitmap_image.rb +88 -84
  410. data/samples/etc/caret.rb +306 -0
  411. data/samples/etc/miniframe.rb +65 -60
  412. data/samples/etc/sash.rb +109 -105
  413. data/samples/etc/scrollwin.rb +86 -80
  414. data/samples/etc/system_settings.rb +216 -209
  415. data/samples/event/activation.rb +72 -67
  416. data/samples/event/event.rb +160 -153
  417. data/samples/event/threaded.rb +8 -1
  418. data/samples/event/update_ui_event.rb +67 -60
  419. data/samples/grid/grid.rb +188 -181
  420. data/samples/grid/gridtablebase.rb +136 -129
  421. data/samples/html/html.rb +208 -204
  422. data/samples/mdi/mdi.rb +59 -54
  423. data/samples/minimal/minimal.rb +54 -51
  424. data/samples/minimal/nothing.rb +1 -0
  425. data/samples/printing/printing.rb +367 -377
  426. data/samples/printing/printing2.rb +203 -198
  427. data/samples/propgrid/propgrid.rb +2312 -2308
  428. data/samples/propgrid/propgrid_minimal.rb +57 -50
  429. data/samples/ribbon/ribbon.rb +780 -774
  430. data/samples/sampler/ext.rb +0 -33
  431. data/samples/sampler/sample.rb +4 -9
  432. data/samples/sampler.rb +1 -1
  433. data/samples/splash/splash.rb +118 -116
  434. data/samples/text/rich_textctrl.rb +207 -201
  435. data/samples/text/richtext.rb +1409 -1405
  436. data/samples/text/scintilla.rb +137 -128
  437. data/samples/text/textctrl.rb +89 -83
  438. data/samples/text/unicode.rb +175 -168
  439. data/samples/treectrl/treectrl.rb +1430 -1426
  440. data/samples/widgets/activityindicator.rb +95 -0
  441. data/samples/widgets/art/widgets/activityindicator.xpm +278 -0
  442. data/samples/widgets/art/widgets/bmpbtn.xpm +37 -0
  443. data/samples/widgets/art/widgets/bmpcombobox.xpm +54 -0
  444. data/samples/widgets/art/widgets/button.xpm +54 -0
  445. data/samples/widgets/art/widgets/checkbox.xpm +54 -0
  446. data/samples/{bigdemo/icons → widgets/art/widgets}/choice.xpm +1 -1
  447. data/samples/widgets/art/widgets/choicebk.xpm +54 -0
  448. data/samples/widgets/art/widgets/clrpicker.xpm +193 -0
  449. data/samples/widgets/art/widgets/combobox.xpm +54 -0
  450. data/samples/widgets/art/widgets/datepick.xpm +200 -0
  451. data/samples/widgets/art/widgets/dirctrl.xpm +54 -0
  452. data/samples/widgets/art/widgets/dirpicker.xpm +213 -0
  453. data/samples/widgets/art/widgets/filepicker.xpm +214 -0
  454. data/samples/widgets/art/widgets/fontpicker.xpm +185 -0
  455. data/samples/widgets/art/widgets/gauge.xpm +54 -0
  456. data/samples/widgets/art/widgets/header.xpm +54 -0
  457. data/samples/widgets/art/widgets/hyperlnk.xpm +54 -0
  458. data/samples/widgets/art/widgets/listbook.xpm +54 -0
  459. data/samples/widgets/art/widgets/listbox.xpm +54 -0
  460. data/samples/widgets/art/widgets/native.xpm +81 -0
  461. data/samples/widgets/art/widgets/notebook.xpm +54 -0
  462. data/samples/widgets/art/widgets/odcombobox.xpm +54 -0
  463. data/samples/widgets/art/widgets/radiobox.xpm +54 -0
  464. data/samples/widgets/art/widgets/scrolbar.xpm +54 -0
  465. data/samples/widgets/art/widgets/slider.xpm +54 -0
  466. data/samples/widgets/art/widgets/spinbtn.xpm +40 -0
  467. data/samples/widgets/art/widgets/statbmp.xpm +40 -0
  468. data/samples/widgets/art/widgets/statbox.xpm +54 -0
  469. data/samples/widgets/art/widgets/stattext.xpm +54 -0
  470. data/samples/widgets/art/widgets/text.xpm +54 -0
  471. data/samples/widgets/art/widgets/timepick.xpm +207 -0
  472. data/samples/widgets/art/widgets/toggle.xpm +54 -0
  473. data/samples/widgets/art/widgets/toucan.png +0 -0
  474. data/samples/widgets/bmpcombobox.rb +651 -0
  475. data/samples/widgets/button.rb +462 -0
  476. data/samples/widgets/checkbox.rb +211 -0
  477. data/samples/widgets/choice.rb +287 -0
  478. data/samples/widgets/clrpicker.rb +156 -0
  479. data/samples/widgets/combobox.rb +516 -0
  480. data/samples/widgets/datepick.rb +215 -0
  481. data/samples/widgets/dirctrl.rb +265 -0
  482. data/samples/widgets/dirpicker.rb +158 -0
  483. data/samples/widgets/editlbox.rb +122 -0
  484. data/samples/widgets/filectrl.rb +216 -0
  485. data/samples/widgets/filepicker.rb +214 -0
  486. data/samples/widgets/fontpicker.rb +135 -0
  487. data/samples/widgets/gauge.rb +311 -0
  488. data/samples/widgets/headerctrl.rb +236 -0
  489. data/samples/widgets/hyperlink.rb +203 -0
  490. data/samples/widgets/itemcontainer.rb +185 -0
  491. data/samples/widgets/listbox.rb +473 -0
  492. data/samples/widgets/notebook.rb +488 -0
  493. data/samples/widgets/odcombobox.rb +608 -0
  494. data/samples/widgets/radiobox.rb +328 -0
  495. data/samples/widgets/searchctrl.rb +159 -0
  496. data/samples/widgets/slider.rb +594 -0
  497. data/samples/widgets/spinbtn.rb +443 -0
  498. data/samples/widgets/statbmp.rb +130 -0
  499. data/samples/widgets/static.rb +436 -0
  500. data/samples/widgets/textctrl.rb +700 -0
  501. data/samples/widgets/timepick.rb +148 -0
  502. data/samples/widgets/tn_widgets.png +0 -0
  503. data/samples/widgets/toggle.rb +385 -0
  504. data/samples/widgets/widgets.rb +1233 -0
  505. data/samples/xrc/custom_xrc_sample.rb +47 -41
  506. data/samples/xrc/xrc_sample.rb +53 -47
  507. data/tests/test_event_handling.rb +52 -34
  508. data/tests/test_events.rb +7 -0
  509. data/tests/test_item_data.rb +24 -0
  510. data/tests/test_sizer.rb +44 -1
  511. data/tests/test_validators.rb +805 -0
  512. metadata +87 -137
  513. data/lib/wx/core/choice.rb +0 -14
  514. data/lib/wx/core/combo_ctrl.rb +0 -110
  515. data/samples/bigdemo/About.rbw +0 -39
  516. data/samples/bigdemo/ColorPanel.rbw +0 -23
  517. data/samples/bigdemo/GridSimple.rbw +0 -78
  518. data/samples/bigdemo/MDIDemo.rbw +0 -57
  519. data/samples/bigdemo/PopupMenu.rbw +0 -146
  520. data/samples/bigdemo/ShapedWindow.rbw +0 -128
  521. data/samples/bigdemo/Sizers.rbw +0 -541
  522. data/samples/bigdemo/bigdemo.rb +0 -817
  523. data/samples/bigdemo/demoTemplate.rbw +0 -33
  524. data/samples/bigdemo/helpfile.htb +0 -0
  525. data/samples/bigdemo/icons/Test 015.jpg +0 -0
  526. data/samples/bigdemo/icons/Test 015.png +0 -0
  527. data/samples/bigdemo/icons/choice.bmp +0 -0
  528. data/samples/bigdemo/icons/combo.bmp +0 -0
  529. data/samples/bigdemo/icons/combo.xpm +0 -27
  530. data/samples/bigdemo/icons/copy.xpm +0 -25
  531. data/samples/bigdemo/icons/cut.xpm +0 -24
  532. data/samples/bigdemo/icons/gauge.bmp +0 -0
  533. data/samples/bigdemo/icons/gauge.xpm +0 -27
  534. data/samples/bigdemo/icons/help.xpm +0 -25
  535. data/samples/bigdemo/icons/list.bmp +0 -0
  536. data/samples/bigdemo/icons/list.xpm +0 -27
  537. data/samples/bigdemo/icons/mondrian.ico +0 -0
  538. data/samples/bigdemo/icons/mondrian.xpm +0 -44
  539. data/samples/bigdemo/icons/new.xpm +0 -24
  540. data/samples/bigdemo/icons/ogl.ico +0 -0
  541. data/samples/bigdemo/icons/ogl.xpm +0 -45
  542. data/samples/bigdemo/icons/open.xpm +0 -26
  543. data/samples/bigdemo/icons/paste.bmp +0 -0
  544. data/samples/bigdemo/icons/paste.xpm +0 -38
  545. data/samples/bigdemo/icons/pointy.png +0 -0
  546. data/samples/bigdemo/icons/preview.xpm +0 -26
  547. data/samples/bigdemo/icons/print.xpm +0 -26
  548. data/samples/bigdemo/icons/radio.bmp +0 -0
  549. data/samples/bigdemo/icons/radio.xpm +0 -27
  550. data/samples/bigdemo/icons/robert.xpm +0 -415
  551. data/samples/bigdemo/icons/sashtest.ico +0 -0
  552. data/samples/bigdemo/icons/save.xpm +0 -25
  553. data/samples/bigdemo/icons/smiles.bmp +0 -0
  554. data/samples/bigdemo/icons/smiles.xpm +0 -39
  555. data/samples/bigdemo/icons/smiley.ico +0 -0
  556. data/samples/bigdemo/icons/smiley.xpm +0 -42
  557. data/samples/bigdemo/icons/stattext.xpm +0 -24
  558. data/samples/bigdemo/icons/test2.bmp +0 -0
  559. data/samples/bigdemo/icons/test2.png +0 -0
  560. data/samples/bigdemo/icons/test2.xpm +0 -79
  561. data/samples/bigdemo/icons/text.bmp +0 -0
  562. data/samples/bigdemo/icons/text.xpm +0 -27
  563. data/samples/bigdemo/icons/tog1.bmp +0 -0
  564. data/samples/bigdemo/icons/tog1.xpm +0 -38
  565. data/samples/bigdemo/icons/tog2.bmp +0 -0
  566. data/samples/bigdemo/icons/tog2.xpm +0 -38
  567. data/samples/bigdemo/icons/wxruby-128x128.png +0 -0
  568. data/samples/bigdemo/icons/wxwin.ico +0 -0
  569. data/samples/bigdemo/icons/wxwin16x16.png +0 -0
  570. data/samples/bigdemo/icons/wxwin16x16.xpm +0 -25
  571. data/samples/bigdemo/icons/wxwin32x32.png +0 -0
  572. data/samples/bigdemo/icons/wxwin48x48.png +0 -0
  573. data/samples/bigdemo/run.rb +0 -98
  574. data/samples/bigdemo/tips.txt +0 -7
  575. data/samples/bigdemo/utils.rb +0 -20
  576. data/samples/bigdemo/wxArtProvider.rbw +0 -282
  577. data/samples/bigdemo/wxBitmapButton.rbw +0 -65
  578. data/samples/bigdemo/wxButton.rbw +0 -64
  579. data/samples/bigdemo/wxCalendarCtrl.rbw +0 -59
  580. data/samples/bigdemo/wxCheckBox.rbw +0 -50
  581. data/samples/bigdemo/wxCheckListBox.rbw +0 -65
  582. data/samples/bigdemo/wxChoice.rbw +0 -47
  583. data/samples/bigdemo/wxChoicebook.rbw +0 -78
  584. data/samples/bigdemo/wxColourDialog.rbw +0 -33
  585. data/samples/bigdemo/wxComboBox.rbw +0 -77
  586. data/samples/bigdemo/wxCursor.rbw +0 -136
  587. data/samples/bigdemo/wxDialog.rbw +0 -74
  588. data/samples/bigdemo/wxDirDialog.rbw +0 -29
  589. data/samples/bigdemo/wxDragImage.rbw +0 -70
  590. data/samples/bigdemo/wxFileDialog.rbw +0 -37
  591. data/samples/bigdemo/wxFileDialog_Save.rbw +0 -35
  592. data/samples/bigdemo/wxFindReplaceDialog.rbw +0 -82
  593. data/samples/bigdemo/wxFontDialog.rbw +0 -200
  594. data/samples/bigdemo/wxFrame.rbw +0 -53
  595. data/samples/bigdemo/wxGauge.rbw +0 -65
  596. data/samples/bigdemo/wxGenericDirCtrl.rbw +0 -74
  597. data/samples/bigdemo/wxGrid.rbw +0 -66
  598. data/samples/bigdemo/wxHtmlHelpController.rbw +0 -52
  599. data/samples/bigdemo/wxListBox.rbw +0 -140
  600. data/samples/bigdemo/wxListCtrl_virtual.rbw +0 -112
  601. data/samples/bigdemo/wxMDIWindows.rbw +0 -50
  602. data/samples/bigdemo/wxMenu.rbw +0 -247
  603. data/samples/bigdemo/wxMessageDialog.rbw +0 -27
  604. data/samples/bigdemo/wxMiniFrame.rbw +0 -70
  605. data/samples/bigdemo/wxMultipleChoiceDialog.rbw +0 -29
  606. data/samples/bigdemo/wxNotebook.rbw +0 -136
  607. data/samples/bigdemo/wxProgressDialog.rbw +0 -43
  608. data/samples/bigdemo/wxRadioBox.rbw +0 -72
  609. data/samples/bigdemo/wxRadioButton.rbw +0 -125
  610. data/samples/bigdemo/wxSashWindow.rbw +0 -141
  611. data/samples/bigdemo/wxScrolledMessageDialog.rbw +0 -57
  612. data/samples/bigdemo/wxScrolledWindow.rbw +0 -199
  613. data/samples/bigdemo/wxSingleChoiceDialog.rbw +0 -33
  614. data/samples/bigdemo/wxSlider.rbw +0 -42
  615. data/samples/bigdemo/wxSpinButton.rbw +0 -50
  616. data/samples/bigdemo/wxSpinCtrl.rbw +0 -51
  617. data/samples/bigdemo/wxSplitterWindow.rbw +0 -63
  618. data/samples/bigdemo/wxStaticBitmap.rbw +0 -47
  619. data/samples/bigdemo/wxStaticText.rbw +0 -55
  620. data/samples/bigdemo/wxStatusBar.rbw +0 -126
  621. data/samples/bigdemo/wxTextCtrl.rbw +0 -149
  622. data/samples/bigdemo/wxTextEntryDialog.rbw +0 -31
  623. data/samples/bigdemo/wxToggleButton.rbw +0 -49
  624. data/samples/bigdemo/wxToolBar.rbw +0 -131
  625. data/samples/bigdemo/wxTreeCtrl.rbw +0 -191
  626. data/samples/caret/caret.rb +0 -298
  627. data/samples/caret/mondrian.xpm +0 -44
  628. data/samples/controls/books.rb +0 -189
  629. data/samples/controls/choice.xpm +0 -27
  630. data/samples/controls/combo.xpm +0 -27
  631. data/samples/controls/controls.rb +0 -1099
  632. data/samples/controls/gauge.xpm +0 -27
  633. data/samples/controls/list.xpm +0 -27
  634. data/samples/controls/mondrian.ico +0 -0
  635. data/samples/controls/mondrian.xpm +0 -44
  636. data/samples/controls/radio.xpm +0 -27
  637. data/samples/controls/stattext.xpm +0 -24
  638. data/samples/controls/test2.bmp +0 -0
  639. data/samples/controls/text.xpm +0 -27
  640. data/samples/controls/tn_books.png +0 -0
  641. data/samples/controls/tn_controls.png +0 -0
  642. data/samples/etc/choice.rb +0 -87
  643. data/samples/etc/tn_choice.png +0 -0
  644. data/samples/text/mondrian.ico +0 -0
  645. data/samples/text/mondrian.xpm +0 -44
  646. /data/samples/{caret → etc}/tn_caret.png +0 -0
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # Objects of this class are similar in appearance to the normal {Wx::Buttons} but are similar to the links in a web page in functionality.
10
+ #
10
11
  # Pressing such button usually results in switching to another window of the program and so they can be used as a replacement for the "Next" button in a multi-page dialog (such as {Wx::Wizard}), for example.
11
12
  # Their advantage compared to the ordinary {Wx::Buttons} is that they emphasize the action of switching the window and also that they allow to give more detailed explanation to the user because, in addition to the short button label, they also show a longer description string.
12
13
  # The short, title-like, part of the label is called the main label and the longer description is the note. Both of them can be set and queried independently using {Wx::CommandLinkButton}-specific methods such as {Wx::CommandLinkButton#set_main_label} or {Wx::CommandLinkButton#get_note} or also via {Wx::CommandLinkButton#set_label} and {Wx::CommandLinkButton#get_label} methods inherited from {Wx::Button}. When using the latter, the main label and the note are concatenated into a single string using a new line character between them (notice that the note part can have more new lines in it).
@@ -26,10 +27,12 @@ module Wx
26
27
 
27
28
  # @overload initialize()
28
29
  # Default constructor.
30
+ #
29
31
  # Use {Wx::CommandLinkButton#create} to really create the control.
30
32
  # @return [Wx::CommandLinkButton]
31
33
  # @overload initialize(parent, id, mainLabel=(''), note=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR)
32
34
  # Constructor really creating a command Link button.
35
+ #
33
36
  # The button will be decorated with stock icons under GTK+ 2.
34
37
  # @see Wx::CommandLinkButton#create
35
38
  # @see Wx::Validator
@@ -46,6 +49,7 @@ module Wx
46
49
  def initialize(*args) end
47
50
 
48
51
  # Button creation function for two-step creation.
52
+ #
49
53
  # For more details, see {Wx::CommandLinkButton#initialize}.
50
54
  # @param parent [Wx::Window]
51
55
  # @param id [Integer]
@@ -60,6 +64,7 @@ module Wx
60
64
  def create(parent, id, mainLabel=(''), note=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR) end
61
65
 
62
66
  # Sets a new main label and note for the button.
67
+ #
63
68
  # Neither of the arguments can be empty, if you need to change just the label or just the note, use {Wx::CommandLinkButton#set_main_label} or {Wx::CommandLinkButton#set_note} instead of this function.
64
69
  # @param mainLabel [String] New main label to use.
65
70
  # @param note [String] New note to use.
@@ -73,6 +78,7 @@ module Wx
73
78
  alias_method :label=, :set_label
74
79
 
75
80
  # Returns the string label for the button.
81
+ #
76
82
  # A string with the main label and note concatenated together with a newline separating them.
77
83
  # @see Wx::CommandLinkButton#set_label
78
84
  # @return [String]
@@ -92,12 +98,14 @@ module Wx
92
98
  alias_method :note=, :set_note
93
99
 
94
100
  # Returns the current main label.
101
+ #
95
102
  # Main label currently displayed.
96
103
  # @return [String]
97
104
  def get_main_label; end
98
105
  alias_method :main_label, :get_main_label
99
106
 
100
107
  # Returns the currently used note.
108
+ #
101
109
  # Note currently displayed.
102
110
  # @return [String]
103
111
  def get_note; end
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # Instances of this class may be used to add a question mark button that when pressed, puts the application into context-help mode.
10
+ #
10
11
  # It does this by creating a {Wx::ContextHelp} object which itself generates a {Wx::EVT_HELP} event when the user clicks on a window.
11
12
  # On Windows, you may add a question-mark icon to a dialog by use of the {Wx::DIALOG_EX_CONTEXTHELP} extra style, but on other platforms you will have to add a button explicitly, usually next to OK, Cancel or similar buttons.
12
13
  #
@@ -19,11 +20,12 @@ module Wx
19
20
  class ContextHelpButton < BitmapButton
20
21
 
21
22
  # Constructor, creating and showing a context help button.
23
+ #
22
24
  # <div class="wxrb-remark">
23
25
  # <b>Remark:</b>
24
26
  # <p>Normally you only need pass the parent window to the constructor, and use the defaults for the remaining parameters.
25
27
  # </p>
26
- # </div>>
28
+ # </div>
27
29
  # @param parent [Wx::Window] Parent window. Must not be NULL.
28
30
  # @param id [Integer] Button identifier. Defaults to {Wx::StandardID::ID_CONTEXT_HELP}.
29
31
  # @param pos [Array(Integer, Integer), Wx::Point] Button position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
@@ -35,6 +37,7 @@ module Wx
35
37
  end # ContextHelpButton
36
38
 
37
39
  # This class changes the cursor to a query and puts the application into a 'context-sensitive help mode'.
40
+ #
38
41
  # When the user left-clicks on a window within the specified window, a {Wx::EVT_HELP} event is sent to that control, and the application may respond to it by popping up some help.
39
42
  # For example:
40
43
  # ```ruby
@@ -63,6 +66,7 @@ module Wx
63
66
  class ContextHelp < Object
64
67
 
65
68
  # Constructs a context help object, calling {Wx::ContextHelp#begin_context_help} if doNow is true (the default).
69
+ #
66
70
  # If window is NULL, the top window is used.
67
71
  # @param window [Wx::Window]
68
72
  # @param doNow [Boolean]
@@ -70,6 +74,7 @@ module Wx
70
74
  def initialize(window=nil, doNow=true) end
71
75
 
72
76
  # Puts the application into context-sensitive help mode.
77
+ #
73
78
  # window is the window which will be used to catch events; if NULL, the top window will be used.
74
79
  # Returns true if the application was successfully put into context-sensitive help mode. This function only returns when the event loop has finished.
75
80
  # @param window [Wx::Window]
@@ -77,6 +82,7 @@ module Wx
77
82
  def begin_context_help(window) end
78
83
 
79
84
  # Ends context-sensitive help mode.
85
+ #
80
86
  # Not normally called by the application.
81
87
  # @return [Boolean]
82
88
  def end_context_help; end
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # This is the base class for a control or "widget".
10
+ #
10
11
  # A control is generally a small window which processes user input and/or displays one or more item of data.
11
12
  # ### Events emitted by this class
12
13
  #
@@ -52,12 +53,14 @@ module Wx
52
53
 
53
54
  # Simulates the effect of the user issuing a command to the item.
54
55
  #
56
+ #
55
57
  # @see Wx::CommandEvent
56
58
  # @param event [Wx::CommandEvent]
57
59
  # @return [void]
58
60
  def command(event) end
59
61
 
60
62
  # Returns the control's label, as it was passed to {Wx::Control#set_label}.
63
+ #
61
64
  # Note that the returned string may contains mnemonics ("&" characters) if they were passed to the {Wx::Control#set_label} function; use {Wx::Control#get_label_text} if they are undesired.
62
65
  # Also note that the returned string is always the string which was passed to {Wx::Control#set_label} but may be different from the string passed to {Wx::Control#set_label_text} (since this last one escapes mnemonic characters).
63
66
  # @return [String]
@@ -65,6 +68,7 @@ module Wx
65
68
  alias_method :label, :get_label
66
69
 
67
70
  # Returns the control's label without mnemonics.
71
+ #
68
72
  # Note that because of the stripping of the mnemonics the returned string may differ from the string which was passed to {Wx::Control#set_label} but should always be the same which was passed to {Wx::Control#set_label_text}.
69
73
  # @return [String]
70
74
  def get_label_text; end
@@ -72,6 +76,7 @@ module Wx
72
76
 
73
77
  # @overload get_size_from_text_size(xlen, ylen=-1)
74
78
  # Determine the size needed by the control to leave the given area for its text.
79
+ #
75
80
  # This function is mostly useful with control displaying short amounts of text that can be edited by the user, e.g. {Wx::TextCtrl}, {Wx::ComboBox}, {Wx::SearchCtrl} etc. Typically it is used to size these controls for the maximal amount of input they are supposed to contain, for example:
76
81
  # ```ruby
77
82
  # # Create a control for post code entry.
@@ -98,6 +103,7 @@ module Wx
98
103
  alias_method :size_from_text_size, :get_size_from_text_size
99
104
 
100
105
  # Determine the minimum size needed by the control to display the given text.
106
+ #
101
107
  # The helper function that uses combination of {Wx::Control#get_size_from_text_size} and {Wx::Control#get_text_extent} which used together pretty often:
102
108
  # ```ruby
103
109
  # def get_size_from_text(text)
@@ -112,6 +118,7 @@ module Wx
112
118
  alias_method :size_from_text, :get_size_from_text
113
119
 
114
120
  # Sets the control's label.
121
+ #
115
122
  # All "&" characters in the label are special and indicate that the following character is a mnemonic for this control and can be used to activate it from the keyboard (typically by using Alt key in combination with it). To insert a literal ampersand character, you need to double it, i.e. use "&&". If this behaviour is undesirable, use {Wx::Control#set_label_text} instead.
116
123
  # @param label [String]
117
124
  # @return [void]
@@ -119,6 +126,7 @@ module Wx
119
126
  alias_method :label=, :set_label
120
127
 
121
128
  # Sets the control's label to exactly the given string.
129
+ #
122
130
  # Unlike {Wx::Control#set_label}, this function shows exactly the text passed to it in the control, without interpreting ampersands in it in any way. Notice that it means that the control can't have any mnemonic defined for it using this function.
123
131
  # @see Wx::Control.escape_mnemonics
124
132
  # @param text [String]
@@ -127,6 +135,7 @@ module Wx
127
135
  alias_method :label_text=, :set_label_text
128
136
 
129
137
  # Sets the controls label to a string using markup.
138
+ #
130
139
  # Simple markup supported by this function can be used to apply different fonts or colours to different parts of the control label when supported. If markup is not supported by the control or platform, it is simply stripped and {Wx::Control#set_label} is used with the resulting string.
131
140
  # For example,
132
141
  # ```ruby
@@ -219,6 +228,7 @@ module Wx
219
228
  alias_method :label_markup=, :set_label_markup
220
229
 
221
230
  # Returns the given str string without mnemonics ("&" characters).
231
+ #
222
232
  # <div class="wxrb-note">
223
233
  # <b>Note:</b>
224
234
  # <p>This function is identical to {Wx::Control#get_label_text} and is provided mostly for symmetry with {Wx::Control.escape_mnemonics}.
@@ -229,6 +239,7 @@ module Wx
229
239
  def self.remove_mnemonics(str) end
230
240
 
231
241
  # Escapes the special mnemonics characters ("&") in the given string.
242
+ #
232
243
  # This function can be helpful if you need to set the controls label to a user-provided string. If the string contains ampersands, they wouldn't appear on the display but be used instead to indicate that the character following the first of them can be used as a control mnemonic. While this can sometimes be desirable (e.g. to allow the user to configure mnemonics of the controls), more often you will want to use this function before passing a user-defined string to {Wx::Control#set_label}. Alternatively, if the label is entirely user-defined, you can just call {Wx::Control#set_label_text} directly but this function must be used if the label is a combination of a part defined by program containing the control mnemonics and a user-defined part.
233
244
  #
234
245
  # The same string with the ampersands in it doubled.
@@ -237,6 +248,7 @@ module Wx
237
248
  def self.escape_mnemonics(text) end
238
249
 
239
250
  # Replaces parts of the label string with ellipsis, if needed, so that it fits into maxWidth pixels if possible.
251
+ #
240
252
  # Note that this function does not guarantee that the returned string will always be shorter than maxWidth; if maxWidth is extremely small, ellipsized text may be larger.
241
253
  # @param label [String] The string to ellipsize
242
254
  # @param dc [Wx::DC] The DC used to retrieve the character widths through the {Wx::DC#get_partial_text_extents} function.
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # This is convenience class that derives from both {Wx::Control} and {Wx::ItemContainer}.
10
+ #
10
11
  # It is used as basis for some wxWidgets controls ({Wx::Choice} and {Wx::ListBox}).
11
12
  #
12
13
  # Category: {Wx::Controls}
@@ -18,22 +19,26 @@ module Wx
18
19
 
19
20
  # @overload append(item)
20
21
  # Appends item into the control.
22
+ #
21
23
  # The return value is the index of the newly inserted item. Note that this may be different from the last one if the control is sorted (e.g. has {Wx::LB_SORT} or {Wx::CB_SORT} style).
22
24
  # @param item [String] String to add.
23
25
  # @return [Integer]
24
26
  # @overload append(item, clientData)
25
27
  # Appends item into the control.
28
+ #
26
29
  # The return value is the index of the newly inserted item. Note that this may be different from the last one if the control is sorted (e.g. has {Wx::LB_SORT} or {Wx::CB_SORT} style).
27
30
  # @param item [String] String to add.
28
31
  # @param clientData [Object] Pointer to client data to associate with the new item.
29
32
  # @return [Integer]
30
33
  # @overload append(items)
31
34
  # Appends several items at once into the control.
35
+ #
32
36
  # Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
33
37
  # @param items [Array<String>] Array of strings to insert.
34
38
  # @return [Integer]
35
39
  # @overload append(items, clientData)
36
40
  # Appends several items at once into the control.
41
+ #
37
42
  # Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
38
43
  # @param items [Array<String>] Array of strings to insert.
39
44
  # @param clientData [Array] Array of client data pointers of the same size as items to associate with the new items.
@@ -41,29 +46,34 @@ module Wx
41
46
  def append(*args) end
42
47
 
43
48
  # Returns a pointer to the client data associated with the given item (if any).
44
- # It is an error to call this function for a control which doesn't have untyped client data at all although it is OK to call it even if the given item doesn't have any client data associated with it (but other items do).
49
+ #
50
+ # It is an error to call this function for a control which doesn't have typed client data at all although it is OK to call it even if the given item doesn't have any client data associated with it (but other items do).
51
+ # Notice that the returned pointer is still owned by the control and will be deleted by it, use {Wx::ControlWithItems#detach_client_object} if you want to remove the pointer from the control.
45
52
  #
46
53
  # A pointer to the client data, or NULL if not present.
47
54
  # @param n [Integer] The zero-based position of the item.
48
55
  # @return [Object]
49
- def get_client_data(n) end
50
- alias_method :client_data, :get_client_data
56
+ def get_client_object(n) end
57
+ alias_method :client_object, :get_client_object
51
58
 
52
- # Associates the given untyped client data pointer with the given item.
53
- # Note that it is an error to call this function if any typed client data pointers had been associated with the control items before.
59
+ # Associates the given typed client data pointer with the given item: the data object will be deleted when the item is deleted (either explicitly by using {Wx::ControlWithItems#delete} or implicitly when the control itself is destroyed).
60
+ #
61
+ # Note that it is an error to call this function if any untyped client data pointers had been associated with the control items before.
54
62
  # @param n [Integer] The zero-based item index.
55
63
  # @param data [Object] The client data to associate with the item.
56
64
  # @return [void]
57
- def set_client_data(n, data) end
65
+ def set_client_object(n, data) end
58
66
 
59
67
  # @overload insert(item, pos)
60
68
  # Inserts item into the control.
69
+ #
61
70
  # The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
62
71
  # @param item [String] String to add.
63
72
  # @param pos [Integer] Position to insert item before, zero based.
64
73
  # @return [Integer]
65
74
  # @overload insert(item, pos, clientData)
66
75
  # Inserts item into the control.
76
+ #
67
77
  # The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
68
78
  # @param item [String] String to add.
69
79
  # @param pos [Integer] Position to insert item before, zero based.
@@ -71,6 +81,7 @@ module Wx
71
81
  # @return [Integer]
72
82
  # @overload insert(items, pos)
73
83
  # Inserts several items at once into the control.
84
+ #
74
85
  # Notice that calling this method is usually much faster than inserting them one by one if you need to insert a lot of items.
75
86
  #
76
87
  # The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
@@ -79,6 +90,7 @@ module Wx
79
90
  # @return [Integer]
80
91
  # @overload insert(items, pos, clientData)
81
92
  # Inserts several items at once into the control.
93
+ #
82
94
  # Notice that calling this method is usually much faster than inserting them one by one if you need to insert a lot of items.
83
95
  #
84
96
  # The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
@@ -90,11 +102,13 @@ module Wx
90
102
 
91
103
  # @overload set(items)
92
104
  # Replaces the current control contents with the given items.
105
+ #
93
106
  # Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
94
107
  # @param items [Array<String>] Array of strings to insert.
95
108
  # @return [void]
96
109
  # @overload set(items, clientData)
97
110
  # Replaces the current control contents with the given items.
111
+ #
98
112
  # Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
99
113
  # @param items [Array<String>] Array of strings to insert.
100
114
  # @param clientData [Array] Array of client data pointers of the same size as items to associate with the new items.
@@ -102,11 +116,13 @@ module Wx
102
116
  def set(*args) end
103
117
 
104
118
  # Removes all items from the control.
119
+ #
105
120
  # {Wx::ControlWithItems#clear} also deletes the client data of the existing items if it is owned by the control.
106
121
  # @return [void]
107
122
  def clear; end
108
123
 
109
124
  # Deletes an item from the control.
125
+ #
110
126
  # The client data associated with the item will be also deleted if it is owned by the control. Note that it is an error (signalled by an assert failure in debug builds) to remove an item with the index negative or greater or equal than the number of items in the control.
111
127
  # If there is a currently selected item below the item being deleted, i.e. if {Wx::ControlWithItems#get_selection} returns a valid index greater than or equal to n, the selection is invalidated when this function is called. However if the selected item appears before the item being deleted, the selection is preserved unchanged.
112
128
  # @see Wx::ControlWithItems#clear
@@ -114,18 +130,31 @@ module Wx
114
130
  # @return [void]
115
131
  def delete(n) end
116
132
 
133
+ # Returns the client object associated with the given item and transfers its ownership to the caller.
134
+ #
135
+ # This method, unlike {Wx::ControlWithItems#get_client_object}, expects the caller to delete the returned pointer. It also replaces the internally stored pointer with NULL, i.e. completely detaches the client object pointer from the control.
136
+ # It's an error to call this method unless {Wx::ControlWithItems#has_client_object_data} returns true.
137
+ #
138
+ # The associated client object pointer to be deleted by caller or NULL.
139
+ # @param n [Integer] The zero-based item index.
140
+ # @return [Object]
141
+ def detach_client_object(n) end
142
+
117
143
  # Returns true, if either untyped data (<code>void*</code>) or object data ({Wx::ClientData}*) is associated with the items of the control.
118
144
  # @return [Boolean]
119
145
  def has_client_data; end
120
146
  alias_method :has_client_data?, :has_client_data
121
147
 
122
- # Returns true, if untyped data (<code>void*</code>) is associated with the items of the control.
148
+ # Returns true, if object data is associated with the items of the control.
149
+ #
150
+ # Object data pointers have the type <code>wxClientData*</code> instead of <code>void*</code> and, importantly, are owned by the control, i.e. will be deleted by it, unlike their untyped counterparts.
123
151
  # @return [Boolean]
124
- def has_client_untyped_data; end
125
- alias_method :has_client_untyped_data?, :has_client_untyped_data
152
+ def has_client_object_data; end
153
+ alias_method :has_client_object_data?, :has_client_object_data
126
154
 
127
155
  # Returns the number of items in the control.
128
156
  #
157
+ #
129
158
  # @see Wx::ControlWithItems#is_empty
130
159
  # @return [Integer]
131
160
  def get_count; end
@@ -133,12 +162,14 @@ module Wx
133
162
 
134
163
  # Returns true if the control is empty or false if it has some items.
135
164
  #
165
+ #
136
166
  # @see Wx::ControlWithItems#get_count
137
167
  # @return [Boolean]
138
168
  def is_empty; end
139
169
  alias_method :empty?, :is_empty
140
170
 
141
171
  # Returns the label of the item with the given index.
172
+ #
142
173
  # The index must be valid, i.e. less than the value returned by {Wx::ControlWithItems#get_count}, otherwise an assert is triggered. Notably, this function can't be called if the control is empty.
143
174
  #
144
175
  # The label of the item.
@@ -159,6 +190,7 @@ module Wx
159
190
  def set_string(n, string) end
160
191
 
161
192
  # Finds an item whose label matches the given string.
193
+ #
162
194
  # The zero-based position of the item, or {Wx::NOT_FOUND} if the string was not found.
163
195
  # @param string [String] String to find.
164
196
  # @param caseSensitive [Boolean] Whether search is case sensitive (default is not).
@@ -166,6 +198,7 @@ module Wx
166
198
  def find_string(string, caseSensitive=false) end
167
199
 
168
200
  # Sets the selection to the given item n or removes the selection entirely if n == {Wx::NOT_FOUND}.
201
+ #
169
202
  # Note that this does not cause any command events to be emitted nor does it deselect any other items in the controls which support multiple selections.
170
203
  # @see Wx::ControlWithItems#set_string
171
204
  # @see Wx::ControlWithItems#set_string_selection
@@ -175,6 +208,7 @@ module Wx
175
208
  alias_method :selection=, :set_selection
176
209
 
177
210
  # Returns the index of the selected item or {Wx::NOT_FOUND} if no item is selected.
211
+ #
178
212
  # The position of the current selection.
179
213
  # @see Wx::ControlWithItems#set_selection
180
214
  # @see Wx::ControlWithItems#get_string_selection
@@ -183,6 +217,7 @@ module Wx
183
217
  alias_method :selection, :get_selection
184
218
 
185
219
  # Selects the item with the specified string in the control.
220
+ #
186
221
  # This method doesn't cause any command events to be emitted.
187
222
  # Notice that this method is case-insensitive, i.e. the string is compared with all the elements of the control case-insensitively and the first matching entry is selected, even if it doesn't have exactly the same case as this string and there is an exact match afterwards.
188
223
  #
@@ -194,6 +229,7 @@ module Wx
194
229
 
195
230
  # Returns the label of the selected item or an empty string if no item is selected.
196
231
  #
232
+ #
197
233
  # @see Wx::ControlWithItems#get_selection
198
234
  # @return [String]
199
235
  def get_string_selection; end
@@ -7,7 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # wxRuby version string
10
- Wx::WXRUBY_VERSION = '0.9.2'
10
+ Wx::WXRUBY_VERSION = '0.9.3'
11
11
 
12
12
  # wxRuby version release type (alpha, beta, rc)
13
13
  Wx::WXRUBY_RELEASE_TYPE = ''
@@ -16,7 +16,7 @@ module Wx
16
16
  # wxRuby minor version number
17
17
  Wx::WXRUBY_MINOR = 9
18
18
  # wxRuby release number
19
- Wx::WXRUBY_RELEASE = 2
19
+ Wx::WXRUBY_RELEASE = 3
20
20
 
21
21
  # Convenience string for WxWidgets version info
22
22
  WXWIDGETS_VERSION = '3.2.4'
@@ -11,6 +11,7 @@ module Wx
11
11
  NULL_CURSOR = nil
12
12
 
13
13
  # A cursor is a small bitmap usually used for denoting where the mouse pointer is, with a picture that might indicate the interpretation of a mouse click.
14
+ #
14
15
  # As with icons, cursors in X and MS Windows are created in a different manner. Therefore, separate cursors
15
16
  # will be created for the different environments. Platform-specific methods for creating a {Wx::Cursor} object
16
17
  # are catered for, and this is an occasion where conditional compilation will probably be required
@@ -40,6 +41,7 @@ module Wx
40
41
  # @return [Wx::Cursor]
41
42
  # @overload initialize(cursorName, type=Wx::CURSOR_DEFAULT_TYPE, hotSpotX=0, hotSpotY=0)
42
43
  # Constructs a cursor by passing a string resource name or filename.
44
+ #
43
45
  # The arguments hotSpotX and hotSpotY are only used when there's no hotspot info in the resource/image-file to load (e.g. when using {Wx::BitmapType::BITMAP_TYPE_ICO} under WXMSW or {Wx::BitmapType::BITMAP_TYPE_XPM} under WXGTK).
44
46
  # @param cursorName [String] The name of the resource or the image file to load.
45
47
  # @param type [Wx::BitmapType] Icon type to load. It defaults to {Wx::CURSOR_DEFAULT_TYPE}, which is a \#define associated to different values on different platforms:
@@ -58,6 +60,7 @@ module Wx
58
60
  # @return [Wx::Cursor]
59
61
  # @overload initialize(image)
60
62
  # Constructs a cursor from a {Wx::Image}.
63
+ #
61
64
  # If cursor are monochrome on the current platform, colors with the RGB elements all greater than 127 will be foreground, colors less than this background. The mask (if any) will be used to specify the transparent area.
62
65
  # In WXMSW the foreground will be white and the background black. If the cursor is larger than 32x32 it is resized.
63
66
  # In WXGTK, colour cursors and alpha channel are supported (starting from GTK+ 2.2). Otherwise the two most frequent colors will be used for foreground and background. In any case, the cursor will be displayed at the size of the image.
@@ -81,6 +84,7 @@ module Wx
81
84
  alias_method :ok?, :is_ok
82
85
 
83
86
  # Returns the coordinates of the cursor hot spot.
87
+ #
84
88
  # The hot spot is the point at which the mouse is actually considered to be when this cursor is used.
85
89
  # This method is currently only implemented in WXMSW and WXGTK2+ and simply returns {Wx::DEFAULT_POSITION} in the other ports.
86
90
  # @return [Wx::Point]
@@ -7,6 +7,7 @@
7
7
  module Wx
8
8
 
9
9
  # A {Wx::DataFormat} is an encapsulation of a platform-specific format handle which is used by the system for the clipboard and drag and drop operations.
10
+ #
10
11
  # The applications are usually only interested in, for example, pasting data from the clipboard only if the data is in a format the program understands and a data format is something which uniquely identifies this format.
11
12
  # On the system level, a data format is usually just a number (CLIPFORMAT under Windows or Atom under X11, for example) and the standard formats are, indeed, just numbers which can be implicitly converted to {Wx::DataFormat}. The standard formats are:
12
13
  #
@@ -11,6 +11,7 @@ module Wx
11
11
  FORMAT_INVALID = nil
12
12
 
13
13
  # A {Wx::DataObject} represents data that can be copied to or from the clipboard, or dragged and dropped.
14
+ #
14
15
  # The important thing about {Wx::DataObject} is that this is a 'smart' piece of data unlike 'dumb' data containers such as memory buffers or files. Being 'smart' here means that the data object itself should know what data formats it supports and how to render itself in each of its supported formats.
15
16
  # A supported format, incidentally, is exactly the format in which the data can be requested from a data object or from which the data object may be set. In the general case, an object may support different formats on 'input' and 'output', i.e. it may be able to render itself in a given format but not be created from data on this format or vice versa. {Wx::DataObject} defines the {Wx::DataObject::Direction} enumeration type which distinguishes between them.
16
17
  # See {Wx::DataFormat} documentation for more about formats.
@@ -78,13 +79,15 @@ module Wx
78
79
  def initialize; end
79
80
 
80
81
  # Copies all formats supported in the given direction dir to the array pointed to by formats.
82
+ #
81
83
  # There must be enough space for GetFormatCount(dir) formats in it.
82
- # @param dir [Wx::wxDataObject::Direction]
84
+ # @param dir [Wx::DataObject::Direction]
83
85
  # @return [Array<Wx::DataFormat>]
84
86
  def get_all_formats(dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
85
87
  alias_method :all_formats, :get_all_formats
86
88
 
87
89
  # The method will write the data of the format format to the buffer buf.
90
+ #
88
91
  # In other words, copy the data from this object in the given format to the supplied buffer. Returns true on success, false on failure.
89
92
  # @param format [Wx::DataFormat]
90
93
  # @return [String]
@@ -92,19 +95,21 @@ module Wx
92
95
  alias_method :data_here, :get_data_here
93
96
 
94
97
  # Returns the number of available formats for rendering or setting the data.
95
- # @param dir [Wx::wxDataObject::Direction]
98
+ # @param dir [Wx::DataObject::Direction]
96
99
  # @return [Integer]
97
100
  def get_format_count(dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
98
101
  alias_method :format_count, :get_format_count
99
102
 
100
103
  # Returns the preferred format for either rendering the data (if dir is Get, its default value) or for setting it.
104
+ #
101
105
  # Usually this will be the native format of the {Wx::DataObject}.
102
- # @param dir [Wx::wxDataObject::Direction]
106
+ # @param dir [Wx::DataObject::Direction]
103
107
  # @return [Wx::DataFormat]
104
108
  def get_preferred_format(dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
105
109
  alias_method :preferred_format, :get_preferred_format
106
110
 
107
111
  # Set the data in the format format of the length len provided in the buffer buf.
112
+ #
108
113
  # In other words, copy length bytes of data from the buffer to this data object.
109
114
  #
110
115
  # true on success, false on failure.
@@ -115,7 +120,7 @@ module Wx
115
120
 
116
121
  # Returns true if this format is supported.
117
122
  # @param format [Wx::DataFormat]
118
- # @param dir [Wx::wxDataObject::Direction]
123
+ # @param dir [Wx::DataObject::Direction]
119
124
  # @return [Boolean]
120
125
  def is_supported(format, dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
121
126
  alias_method :supported?, :is_supported
@@ -131,6 +136,7 @@ module Wx
131
136
  def initialize(format=Wx::FORMAT_INVALID) end
132
137
 
133
138
  # Returns the (one and only one) format supported by this object.
139
+ #
134
140
  # It is assumed that the format is supported in both directions.
135
141
  # @return [Wx::DataFormat]
136
142
  def get_format; end
@@ -139,6 +145,7 @@ module Wx
139
145
  end # DataObjectSimple
140
146
 
141
147
  # {Wx::DataObjectComposite} is the simplest {Wx::DataObject} derivation which may be used to support multiple formats.
148
+ #
142
149
  # It contains several {Wx::DataObjectSimple} objects and supports any format supported by at least one of them. Only one of these data objects is preferred (the first one if not explicitly changed by using the second parameter of {Wx::DataObjectComposite#add}) and its format determines the preferred format of the composite data object as well.
143
150
  # See {Wx::DataObject} documentation for the reasons why you might prefer to use {Wx::DataObject} directly instead of {Wx::DataObjectComposite} for efficiency reasons.
144
151
  # This example shows how a composite data object capable of storing either bitmaps or file names (presumably of bitmap files) can be initialized and used:
@@ -204,15 +211,17 @@ module Wx
204
211
  def add(dataObject, preferred=false) end
205
212
 
206
213
  # Report the format passed to the {Wx::DataObjectComposite#set_data} method.
214
+ #
207
215
  # This should be the format of the data object within the composite that received data from the clipboard or the DnD operation. You can use this method to find out what kind of data object was received.
208
216
  # @return [Wx::DataFormat]
209
217
  def get_received_format; end
210
218
  alias_method :received_format, :get_received_format
211
219
 
212
220
  # Returns the pointer to the object which supports the passed format for the specified direction.
221
+ #
213
222
  # NULL is returned if the specified format is not supported for this direction dir. The returned pointer is owned by {Wx::DataObjectComposite} itself and shouldn't be deleted by caller.
214
223
  # @param format [Wx::DataFormat]
215
- # @param dir [Wx::wxDataObject::Direction]
224
+ # @param dir [Wx::DataObject::Direction]
216
225
  # @return [Wx::DataObjectSimple]
217
226
  def get_object(format, dir=DataObject::Get) end
218
227
  alias_method :object, :get_object
@@ -220,6 +229,7 @@ module Wx
220
229
  end # DataObjectComposite
221
230
 
222
231
  # {Wx::BitmapDataObject} is a specialization of {Wx::DataObject} for bitmap data.
232
+ #
223
233
  # It can be used without change to paste data into the {Wx::Clipboard} or a {Wx::DropSource}. A user may wish to derive a new class from this class for providing a bitmap on-demand in order to minimize memory consumption when offering data in several formats, such as a bitmap and GIF.
224
234
  # This class may be used as is, but {Wx::BitmapDataObject#get_bitmap} may be overridden to increase efficiency.
225
235
  #
@@ -241,12 +251,14 @@ module Wx
241
251
  def initialize(bitmap=Wx::NULL_BITMAP) end
242
252
 
243
253
  # Returns the bitmap associated with the data object.
254
+ #
244
255
  # You may wish to override this method when offering data on-demand, but this is not required by wxWidgets' internals. Use this method to get data in bitmap form from the {Wx::Clipboard}.
245
256
  # @return [Wx::Bitmap]
246
257
  def get_bitmap; end
247
258
  alias_method :bitmap, :get_bitmap
248
259
 
249
260
  # Sets the bitmap associated with the data object.
261
+ #
250
262
  # This method is called when the data object receives data. Usually there will be no reason to override this function.
251
263
  # @param bitmap [Wx::Bitmap]
252
264
  # @return [void]
@@ -256,6 +268,7 @@ module Wx
256
268
  end # BitmapDataObject
257
269
 
258
270
  # {Wx::FileDataObject} is a specialization of {Wx::DataObject} for file names.
271
+ #
259
272
  # The program works with it just as if it were a list of absolute file names, but internally it uses the same format as Explorer and other compatible programs under Windows or GNOME/KDE file manager under Unix which makes it possible to receive files from them using this class.
260
273
  #
261
274
  # Category: Clipboard and Drag & Drop
@@ -286,6 +299,7 @@ module Wx
286
299
  end # FileDataObject
287
300
 
288
301
  # {Wx::TextDataObject} is a specialization of {Wx::DataObjectSimple} for text data.
302
+ #
289
303
  # It can be used without change to paste data into the {Wx::Clipboard} or a {Wx::DropSource}. A user may wish to derive a new class from this class for providing text on-demand in order to minimize memory consumption when offering data in several formats, such as plain text and RTF because by default the text is stored in a string in this class, but it might as well be generated when requested. For this, {Wx::TextDataObject#get_text_length} and {Wx::TextDataObject#get_text} will have to be overridden.
290
304
  # Note that if you already have the text inside a string, you will not achieve any efficiency gain by overriding these functions because copying {Wx::Strings} is already a very efficient operation (data is not actually copied because {Wx::Strings} are reference counted).
291
305
  #
@@ -306,18 +320,21 @@ module Wx
306
320
  def initialize(text=('')) end
307
321
 
308
322
  # Returns the text associated with the data object.
323
+ #
309
324
  # You may wish to override this method when offering data on-demand, but this is not required by wxWidgets' internals. Use this method to get data in text form from the {Wx::Clipboard}.
310
325
  # @return [String]
311
326
  def get_text; end
312
327
  alias_method :text, :get_text
313
328
 
314
329
  # Returns the data size.
330
+ #
315
331
  # By default, returns the size of the text data set in the constructor or using {Wx::TextDataObject#set_text}. This can be overridden to provide text size data on-demand. It is recommended to return the text length plus 1 for a trailing zero, but this is not strictly required.
316
332
  # @return [Integer]
317
333
  def get_text_length; end
318
334
  alias_method :text_length, :get_text_length
319
335
 
320
336
  # Sets the text associated with the data object.
337
+ #
321
338
  # This method is called when the data object receives the data and, by default, copies the text into the member variable. If you want to process the text on the fly you may wish to override this function.
322
339
  # @param strText [String]
323
340
  # @return [void]
@@ -327,6 +344,7 @@ module Wx
327
344
  end # TextDataObject
328
345
 
329
346
  # {Wx::CustomDataObject} is a specialization of {Wx::DataObjectSimple} for some application-specific data in arbitrary (either custom or one of the standard ones).
347
+ #
330
348
  # The only restriction is that it is supposed that this data can be copied bitwise (i.e. with <code>memcpy()</code>), so it would be a bad idea to make it contain a C++ object (though C struct is fine).
331
349
  # By default, {Wx::CustomDataObject} stores the data inside in a buffer. To put the data into the buffer you may use either {Wx::CustomDataObject#set_data} or {Wx::CustomDataObject#take_data} depending on whether you want the object to make a copy of data or not.
332
350
  # This class may be used as is, but if you don't want store the data inside the object but provide it on demand instead, you should override {Wx::CustomDataObject#get_size}, {Wx::CustomDataObject#get_data} and {Wx::CustomDataObject#set_data} (or may be only the first two or only the last one if you only allow reading/writing the data).
@@ -339,6 +357,7 @@ module Wx
339
357
  class CustomDataObject < DataObjectSimple
340
358
 
341
359
  # The constructor accepts a format argument which specifies the (single) format supported by this object.
360
+ #
342
361
  # If it isn't set here, {Wx::DataObjectSimple#set_format} should be used.
343
362
  # @param format [Wx::DataFormat]
344
363
  # @return [Wx::CustomDataObject]
@@ -347,6 +366,7 @@ module Wx
347
366
  end # CustomDataObject
348
367
 
349
368
  # {Wx::ImageDataObject} is a specialization of {Wx::DataObject} for image data.
369
+ #
350
370
  # It can be used e.g. when you need to put on and retrieve from the clipboard a {Wx::Image} with its metadata (like image resolution).
351
371
  #
352
372
  # Category: Clipboard and Drag & Drop
@@ -378,6 +398,7 @@ module Wx
378
398
  end # ImageDataObject
379
399
 
380
400
  # {Wx::URLDataObject} is a {Wx::DataObject} containing an URL and can be used e.g.
401
+ #
381
402
  # when you need to put an URL on or retrieve it from the clipboard:
382
403
  #
383
404
  # ```ruby
@@ -399,6 +420,7 @@ module Wx
399
420
  class URLDataObject < DataObject
400
421
 
401
422
  # Constructor, may be used to initialize the URL.
423
+ #
402
424
  # If url is empty, {Wx::URLDataObject#set_url} can be used later.
403
425
  # @param url [String]
404
426
  # @return [Wx::URLDataObject]