wxruby3 1.8.0 → 1.8.1

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 (391) hide show
  1. checksums.yaml +4 -4
  2. data/lib/wx/doc/stream.rb +7 -3
  3. data/lib/wx/version.rb +1 -1
  4. data/lib/wx/wxruby/cmd/test.rb +8 -2
  5. data/rakelib/lib/config/pkgman/linux.rb +4 -2
  6. data/rakelib/lib/director/derived_dc.rb +41 -32
  7. data/rakelib/lib/director/editable_listbox.rb +10 -8
  8. data/rakelib/lib/director/fs_file.rb +23 -0
  9. data/rakelib/lib/director/ribbon_page.rb +11 -0
  10. data/rakelib/lib/director/top_level_window.rb +12 -4
  11. data/rakelib/lib/specs/interfaces.rb +2 -2
  12. data/tests/test_webview.rb +5 -5
  13. metadata +2 -380
  14. data/assets/repo-social-preview.odg +0 -0
  15. data/assets/repo-social-preview.xcf +0 -0
  16. data/lib/wx/aui/events/evt_list.rb +0 -148
  17. data/lib/wx/core/events/evt_list.rb +0 -1458
  18. data/lib/wx/core/font/encoding.rb +0 -113
  19. data/lib/wx/doc/gen/about_dialog_info.rb +0 -330
  20. data/lib/wx/doc/gen/accelerator.rb +0 -178
  21. data/lib/wx/doc/gen/activity_indicator.rb +0 -83
  22. data/lib/wx/doc/gen/affine_matrix2d.rb +0 -286
  23. data/lib/wx/doc/gen/animation.rb +0 -275
  24. data/lib/wx/doc/gen/animation_ctrl.rb +0 -300
  25. data/lib/wx/doc/gen/any_button.rb +0 -191
  26. data/lib/wx/doc/gen/app.rb +0 -463
  27. data/lib/wx/doc/gen/app_traits.rb +0 -396
  28. data/lib/wx/doc/gen/art_provider.rb +0 -617
  29. data/lib/wx/doc/gen/aui/aui_dock_art.rb +0 -455
  30. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +0 -54
  31. data/lib/wx/doc/gen/aui/aui_manager.rb +0 -847
  32. data/lib/wx/doc/gen/aui/aui_manager_event.rb +0 -131
  33. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +0 -180
  34. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +0 -59
  35. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +0 -130
  36. data/lib/wx/doc/gen/aui/aui_notebook.rb +0 -631
  37. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +0 -233
  38. data/lib/wx/doc/gen/aui/aui_pane_info.rb +0 -769
  39. data/lib/wx/doc/gen/aui/aui_tab_art.rb +0 -352
  40. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +0 -14
  41. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +0 -510
  42. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +0 -340
  43. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +0 -244
  44. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +0 -257
  45. data/lib/wx/doc/gen/aui/event_list.rb +0 -179
  46. data/lib/wx/doc/gen/banner_window.rb +0 -124
  47. data/lib/wx/doc/gen/bitmap.rb +0 -731
  48. data/lib/wx/doc/gen/bitmap_button.rb +0 -123
  49. data/lib/wx/doc/gen/bitmap_combo_box.rb +0 -221
  50. data/lib/wx/doc/gen/book_ctrl_base.rb +0 -274
  51. data/lib/wx/doc/gen/book_ctrl_event.rb +0 -66
  52. data/lib/wx/doc/gen/box_sizer.rb +0 -85
  53. data/lib/wx/doc/gen/brush.rb +0 -251
  54. data/lib/wx/doc/gen/busy_info.rb +0 -157
  55. data/lib/wx/doc/gen/button.rb +0 -182
  56. data/lib/wx/doc/gen/calculate_layout_event.rb +0 -62
  57. data/lib/wx/doc/gen/calendar_ctrl.rb +0 -505
  58. data/lib/wx/doc/gen/calendar_date_attr.rb +0 -138
  59. data/lib/wx/doc/gen/calendar_event.rb +0 -147
  60. data/lib/wx/doc/gen/caret.rb +0 -97
  61. data/lib/wx/doc/gen/check_box.rb +0 -175
  62. data/lib/wx/doc/gen/check_list_box.rb +0 -121
  63. data/lib/wx/doc/gen/choice.rb +0 -175
  64. data/lib/wx/doc/gen/choicebook.rb +0 -116
  65. data/lib/wx/doc/gen/client_dc.rb +0 -43
  66. data/lib/wx/doc/gen/clipboard.rb +0 -144
  67. data/lib/wx/doc/gen/collapsible_pane.rb +0 -138
  68. data/lib/wx/doc/gen/collapsible_pane_event.rb +0 -46
  69. data/lib/wx/doc/gen/colour.rb +0 -333
  70. data/lib/wx/doc/gen/colour_dialog.rb +0 -190
  71. data/lib/wx/doc/gen/colour_picker_ctrl.rb +0 -110
  72. data/lib/wx/doc/gen/colour_picker_event.rb +0 -77
  73. data/lib/wx/doc/gen/combo_box.rb +0 -292
  74. data/lib/wx/doc/gen/combo_ctrl.rb +0 -662
  75. data/lib/wx/doc/gen/command_link_button.rb +0 -134
  76. data/lib/wx/doc/gen/config_base.rb +0 -10
  77. data/lib/wx/doc/gen/context_help_button.rb +0 -56
  78. data/lib/wx/doc/gen/control.rb +0 -277
  79. data/lib/wx/doc/gen/control_with_items.rb +0 -253
  80. data/lib/wx/doc/gen/core.rb +0 -45
  81. data/lib/wx/doc/gen/credential_entry_dialog.rb +0 -137
  82. data/lib/wx/doc/gen/cursor.rb +0 -193
  83. data/lib/wx/doc/gen/data_format.rb +0 -85
  84. data/lib/wx/doc/gen/data_object.rb +0 -436
  85. data/lib/wx/doc/gen/data_object_simple_base.rb +0 -10
  86. data/lib/wx/doc/gen/date_event.rb +0 -49
  87. data/lib/wx/doc/gen/date_picker_ctrl.rb +0 -161
  88. data/lib/wx/doc/gen/dc.rb +0 -1631
  89. data/lib/wx/doc/gen/dc_overlay.rb +0 -102
  90. data/lib/wx/doc/gen/defs.rb +0 -2802
  91. data/lib/wx/doc/gen/dial_up_event.rb +0 -45
  92. data/lib/wx/doc/gen/dial_up_manager.rb +0 -149
  93. data/lib/wx/doc/gen/dialog.rb +0 -541
  94. data/lib/wx/doc/gen/dir_dialog.rb +0 -164
  95. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +0 -90
  96. data/lib/wx/doc/gen/dir_picker_ctrl.rb +0 -125
  97. data/lib/wx/doc/gen/display.rb +0 -238
  98. data/lib/wx/doc/gen/drag_drop.rb +0 -299
  99. data/lib/wx/doc/gen/drag_image.rb +0 -116
  100. data/lib/wx/doc/gen/editable_list_box.rb +0 -109
  101. data/lib/wx/doc/gen/event.rb +0 -990
  102. data/lib/wx/doc/gen/event_blocker.rb +0 -50
  103. data/lib/wx/doc/gen/event_filter.rb +0 -92
  104. data/lib/wx/doc/gen/event_list.rb +0 -1644
  105. data/lib/wx/doc/gen/events.rb +0 -2809
  106. data/lib/wx/doc/gen/evt_handler.rb +0 -229
  107. data/lib/wx/doc/gen/ext_help_controller.rb +0 -155
  108. data/lib/wx/doc/gen/file_ctrl.rb +0 -231
  109. data/lib/wx/doc/gen/file_ctrl_event.rb +0 -83
  110. data/lib/wx/doc/gen/file_dialog.rb +0 -353
  111. data/lib/wx/doc/gen/file_dialog_custom_control.rb +0 -165
  112. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +0 -158
  113. data/lib/wx/doc/gen/file_dir_picker_event.rb +0 -100
  114. data/lib/wx/doc/gen/file_picker_ctrl.rb +0 -132
  115. data/lib/wx/doc/gen/file_system.rb +0 -232
  116. data/lib/wx/doc/gen/find_dialog_event.rb +0 -126
  117. data/lib/wx/doc/gen/find_replace_data.rb +0 -60
  118. data/lib/wx/doc/gen/find_replace_dialog.rb +0 -58
  119. data/lib/wx/doc/gen/flex_grid_sizer.rb +0 -199
  120. data/lib/wx/doc/gen/font.rb +0 -1379
  121. data/lib/wx/doc/gen/font_data.rb +0 -151
  122. data/lib/wx/doc/gen/font_dialog.rb +0 -88
  123. data/lib/wx/doc/gen/font_picker_ctrl.rb +0 -143
  124. data/lib/wx/doc/gen/font_picker_event.rb +0 -65
  125. data/lib/wx/doc/gen/frame.rb +0 -352
  126. data/lib/wx/doc/gen/fs_file.rb +0 -337
  127. data/lib/wx/doc/gen/functions.rb +0 -10
  128. data/lib/wx/doc/gen/gauge.rb +0 -157
  129. data/lib/wx/doc/gen/gb_sizer_item.rb +0 -68
  130. data/lib/wx/doc/gen/gcdc.rb +0 -46
  131. data/lib/wx/doc/gen/gdi_common.rb +0 -1271
  132. data/lib/wx/doc/gen/gdi_object.rb +0 -31
  133. data/lib/wx/doc/gen/generic_about_dialog.rb +0 -140
  134. data/lib/wx/doc/gen/generic_dir_ctrl.rb +0 -223
  135. data/lib/wx/doc/gen/geometry.rb +0 -661
  136. data/lib/wx/doc/gen/graphics_context.rb +0 -1184
  137. data/lib/wx/doc/gen/graphics_object.rb +0 -750
  138. data/lib/wx/doc/gen/grid/event_list.rb +0 -191
  139. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +0 -40
  140. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +0 -280
  141. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +0 -35
  142. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +0 -37
  143. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +0 -49
  144. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +0 -35
  145. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +0 -46
  146. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +0 -38
  147. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +0 -45
  148. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +0 -40
  149. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +0 -197
  150. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +0 -39
  151. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +0 -44
  152. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +0 -45
  153. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +0 -79
  154. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +0 -46
  155. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +0 -35
  156. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +0 -108
  157. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +0 -35
  158. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +0 -49
  159. data/lib/wx/doc/gen/grid/grid_ctrl.rb +0 -3037
  160. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +0 -95
  161. data/lib/wx/doc/gen/grid/grid_event.rb +0 -129
  162. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +0 -104
  163. data/lib/wx/doc/gen/grid/grid_size_event.rb +0 -85
  164. data/lib/wx/doc/gen/grid/grid_string_table.rb +0 -142
  165. data/lib/wx/doc/gen/grid/grid_table_base.rb +0 -317
  166. data/lib/wx/doc/gen/grid/grid_table_message.rb +0 -81
  167. data/lib/wx/doc/gen/grid_bag_sizer.rb +0 -323
  168. data/lib/wx/doc/gen/grid_sizer.rb +0 -195
  169. data/lib/wx/doc/gen/gui_event_loop.rb +0 -159
  170. data/lib/wx/doc/gen/h_scrolled_window.rb +0 -562
  171. data/lib/wx/doc/gen/header_ctrl.rb +0 -880
  172. data/lib/wx/doc/gen/header_ctrl_event.rb +0 -133
  173. data/lib/wx/doc/gen/help_controller.rb +0 -238
  174. data/lib/wx/doc/gen/help_provider.rb +0 -98
  175. data/lib/wx/doc/gen/html/event_list.rb +0 -38
  176. data/lib/wx/doc/gen/html/html_cell.rb +0 -536
  177. data/lib/wx/doc/gen/html/html_cell_event.rb +0 -69
  178. data/lib/wx/doc/gen/html/html_data_object.rb +0 -42
  179. data/lib/wx/doc/gen/html/html_easy_printing.rb +0 -203
  180. data/lib/wx/doc/gen/html/html_help_controller.rb +0 -382
  181. data/lib/wx/doc/gen/html/html_help_data.rb +0 -159
  182. data/lib/wx/doc/gen/html/html_help_window.rb +0 -258
  183. data/lib/wx/doc/gen/html/html_link_event.rb +0 -41
  184. data/lib/wx/doc/gen/html/html_list_box.rb +0 -346
  185. data/lib/wx/doc/gen/html/html_printout.rb +0 -109
  186. data/lib/wx/doc/gen/html/html_window.rb +0 -461
  187. data/lib/wx/doc/gen/hyperlink_ctrl.rb +0 -311
  188. data/lib/wx/doc/gen/hyperlink_event.rb +0 -44
  189. data/lib/wx/doc/gen/icon.rb +0 -267
  190. data/lib/wx/doc/gen/icon_location.rb +0 -40
  191. data/lib/wx/doc/gen/image.rb +0 -1371
  192. data/lib/wx/doc/gen/image_list.rb +0 -168
  193. data/lib/wx/doc/gen/info_bar.rb +0 -195
  194. data/lib/wx/doc/gen/keyboard_state.rb +0 -140
  195. data/lib/wx/doc/gen/list_box.rb +0 -304
  196. data/lib/wx/doc/gen/list_ctrl.rb +0 -1774
  197. data/lib/wx/doc/gen/list_event.rb +0 -208
  198. data/lib/wx/doc/gen/listbook.rb +0 -116
  199. data/lib/wx/doc/gen/locale.rb +0 -4293
  200. data/lib/wx/doc/gen/log.rb +0 -603
  201. data/lib/wx/doc/gen/mb_conv.rb +0 -10
  202. data/lib/wx/doc/gen/mdi_client_window.rb +0 -47
  203. data/lib/wx/doc/gen/mdi_frame.rb +0 -324
  204. data/lib/wx/doc/gen/media_ctrl.rb +0 -269
  205. data/lib/wx/doc/gen/media_event.rb +0 -117
  206. data/lib/wx/doc/gen/memory_dc.rb +0 -174
  207. data/lib/wx/doc/gen/menu.rb +0 -509
  208. data/lib/wx/doc/gen/menu_bar.rb +0 -287
  209. data/lib/wx/doc/gen/menu_item.rb +0 -362
  210. data/lib/wx/doc/gen/message_dialog.rb +0 -238
  211. data/lib/wx/doc/gen/mini_frame.rb +0 -108
  212. data/lib/wx/doc/gen/mirror_dc.rb +0 -22
  213. data/lib/wx/doc/gen/mouse_state.rb +0 -150
  214. data/lib/wx/doc/gen/multi_choice_dialog.rb +0 -80
  215. data/lib/wx/doc/gen/non_owned_window.rb +0 -49
  216. data/lib/wx/doc/gen/notebook.rb +0 -278
  217. data/lib/wx/doc/gen/num_validator.rb +0 -37
  218. data/lib/wx/doc/gen/number_entry_dialog.rb +0 -93
  219. data/lib/wx/doc/gen/object.rb +0 -59
  220. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +0 -395
  221. data/lib/wx/doc/gen/paint_dc.rb +0 -27
  222. data/lib/wx/doc/gen/palette.rb +0 -92
  223. data/lib/wx/doc/gen/panel.rb +0 -127
  224. data/lib/wx/doc/gen/pen.rb +0 -511
  225. data/lib/wx/doc/gen/persistence_manager.rb +0 -135
  226. data/lib/wx/doc/gen/persistent_object.rb +0 -52
  227. data/lib/wx/doc/gen/persistent_window.rb +0 -241
  228. data/lib/wx/doc/gen/pg/event_list.rb +0 -106
  229. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +0 -54
  230. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +0 -292
  231. data/lib/wx/doc/gen/pg/pg_cell.rb +0 -177
  232. data/lib/wx/doc/gen/pg/pg_editor.rb +0 -721
  233. data/lib/wx/doc/gen/pg/pg_multi_button.rb +0 -152
  234. data/lib/wx/doc/gen/pg/pg_properties.rb +0 -2829
  235. data/lib/wx/doc/gen/pg/pg_property.rb +0 -2078
  236. data/lib/wx/doc/gen/pg/pg_validation_info.rb +0 -344
  237. data/lib/wx/doc/gen/pg/property_grid.rb +0 -740
  238. data/lib/wx/doc/gen/pg/property_grid_event.rb +0 -184
  239. data/lib/wx/doc/gen/pg/property_grid_interface.rb +0 -1098
  240. data/lib/wx/doc/gen/pg/property_grid_manager.rb +0 -415
  241. data/lib/wx/doc/gen/pg/property_grid_page.rb +0 -354
  242. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +0 -165
  243. data/lib/wx/doc/gen/picker_base.rb +0 -152
  244. data/lib/wx/doc/gen/platform_info.rb +0 -622
  245. data/lib/wx/doc/gen/popup_window.rb +0 -107
  246. data/lib/wx/doc/gen/progress_dialog.rb +0 -100
  247. data/lib/wx/doc/gen/property_sheet_dialog.rb +0 -216
  248. data/lib/wx/doc/gen/prt/event_list.rb +0 -17
  249. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +0 -44
  250. data/lib/wx/doc/gen/prt/post_script_dc.rb +0 -30
  251. data/lib/wx/doc/gen/prt/preview_frame.rb +0 -78
  252. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +0 -151
  253. data/lib/wx/doc/gen/prt/print_data.rb +0 -804
  254. data/lib/wx/doc/gen/prt/print_dialog.rb +0 -55
  255. data/lib/wx/doc/gen/prt/printer.rb +0 -518
  256. data/lib/wx/doc/gen/prt/printer_dc.rb +0 -37
  257. data/lib/wx/doc/gen/query_layout_info_event.rb +0 -106
  258. data/lib/wx/doc/gen/radio_box.rb +0 -306
  259. data/lib/wx/doc/gen/radio_button.rb +0 -159
  260. data/lib/wx/doc/gen/rbn/event_list.rb +0 -136
  261. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +0 -1142
  262. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +0 -308
  263. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +0 -45
  264. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +0 -458
  265. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +0 -63
  266. data/lib/wx/doc/gen/rbn/ribbon_control.rb +0 -143
  267. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +0 -229
  268. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +0 -55
  269. data/lib/wx/doc/gen/rbn/ribbon_page.rb +0 -174
  270. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +0 -270
  271. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +0 -45
  272. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +0 -360
  273. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +0 -42
  274. data/lib/wx/doc/gen/rearrange_ctrl.rb +0 -78
  275. data/lib/wx/doc/gen/rearrange_list.rb +0 -123
  276. data/lib/wx/doc/gen/region.rb +0 -380
  277. data/lib/wx/doc/gen/region_iterator.rb +0 -76
  278. data/lib/wx/doc/gen/rich_tool_tip.rb +0 -154
  279. data/lib/wx/doc/gen/rt/event_list.rb +0 -17
  280. data/lib/wx/doc/gen/rt/shared_evt_handler.rb +0 -14
  281. data/lib/wx/doc/gen/rt/thread_event.rb +0 -71
  282. data/lib/wx/doc/gen/rtc/event_list.rb +0 -125
  283. data/lib/wx/doc/gen/rtc/rich_text_box.rb +0 -445
  284. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +0 -1188
  285. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +0 -41
  286. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +0 -538
  287. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +0 -2103
  288. data/lib/wx/doc/gen/rtc/rich_text_event.rb +0 -173
  289. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +0 -181
  290. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +0 -319
  291. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +0 -193
  292. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +0 -102
  293. data/lib/wx/doc/gen/rtc/rich_text_image.rb +0 -337
  294. data/lib/wx/doc/gen/rtc/rich_text_object.rb +0 -2922
  295. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +0 -1240
  296. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +0 -258
  297. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +0 -344
  298. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +0 -227
  299. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +0 -59
  300. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +0 -169
  301. data/lib/wx/doc/gen/sash_event.rb +0 -147
  302. data/lib/wx/doc/gen/sash_layout_window.rb +0 -232
  303. data/lib/wx/doc/gen/sash_window.rb +0 -171
  304. data/lib/wx/doc/gen/scaled_dc.rb +0 -10
  305. data/lib/wx/doc/gen/screen_dc.rb +0 -30
  306. data/lib/wx/doc/gen/scroll_bar.rb +0 -204
  307. data/lib/wx/doc/gen/scrolled_canvas.rb +0 -410
  308. data/lib/wx/doc/gen/scrolled_control.rb +0 -410
  309. data/lib/wx/doc/gen/scrolled_window.rb +0 -430
  310. data/lib/wx/doc/gen/search_ctrl.rb +0 -159
  311. data/lib/wx/doc/gen/secret_store.rb +0 -116
  312. data/lib/wx/doc/gen/simplebook.rb +0 -110
  313. data/lib/wx/doc/gen/single_choice_dialog.rb +0 -89
  314. data/lib/wx/doc/gen/sizer.rb +0 -945
  315. data/lib/wx/doc/gen/sizer_item.rb +0 -244
  316. data/lib/wx/doc/gen/slider.rb +0 -342
  317. data/lib/wx/doc/gen/spin_button.rb +0 -157
  318. data/lib/wx/doc/gen/spin_ctrl.rb +0 -231
  319. data/lib/wx/doc/gen/spin_ctrl_double.rb +0 -192
  320. data/lib/wx/doc/gen/spin_double_event.rb +0 -55
  321. data/lib/wx/doc/gen/spin_event.rb +0 -51
  322. data/lib/wx/doc/gen/splash_screen.rb +0 -113
  323. data/lib/wx/doc/gen/splitter_event.rb +0 -99
  324. data/lib/wx/doc/gen/splitter_window.rb +0 -498
  325. data/lib/wx/doc/gen/static_bitmap.rb +0 -256
  326. data/lib/wx/doc/gen/static_box.rb +0 -180
  327. data/lib/wx/doc/gen/static_box_sizer.rb +0 -85
  328. data/lib/wx/doc/gen/static_line.rb +0 -83
  329. data/lib/wx/doc/gen/static_text.rb +0 -127
  330. data/lib/wx/doc/gen/status_bar.rb +0 -290
  331. data/lib/wx/doc/gen/stc/event_list.rb +0 -221
  332. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +0 -4474
  333. data/lib/wx/doc/gen/stc/styled_text_event.rb +0 -8762
  334. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +0 -129
  335. data/lib/wx/doc/gen/svg_file_dc.rb +0 -164
  336. data/lib/wx/doc/gen/system_options.rb +0 -129
  337. data/lib/wx/doc/gen/system_settings.rb +0 -507
  338. data/lib/wx/doc/gen/task_bar_icon.rb +0 -127
  339. data/lib/wx/doc/gen/task_bar_icon_event.rb +0 -88
  340. data/lib/wx/doc/gen/text_attr.rb +0 -756
  341. data/lib/wx/doc/gen/text_ctrl.rb +0 -1033
  342. data/lib/wx/doc/gen/text_entry.rb +0 -441
  343. data/lib/wx/doc/gen/text_entry_dialog.rb +0 -220
  344. data/lib/wx/doc/gen/text_validator.rb +0 -245
  345. data/lib/wx/doc/gen/time_picker_ctrl.rb +0 -128
  346. data/lib/wx/doc/gen/timer.rb +0 -119
  347. data/lib/wx/doc/gen/timer_event.rb +0 -68
  348. data/lib/wx/doc/gen/tip_provider.rb +0 -63
  349. data/lib/wx/doc/gen/tip_window.rb +0 -51
  350. data/lib/wx/doc/gen/toggle_button.rb +0 -182
  351. data/lib/wx/doc/gen/tool_bar.rb +0 -890
  352. data/lib/wx/doc/gen/tool_tip.rb +0 -86
  353. data/lib/wx/doc/gen/toolbook.rb +0 -118
  354. data/lib/wx/doc/gen/top_level_window.rb +0 -516
  355. data/lib/wx/doc/gen/tree_ctrl.rb +0 -1052
  356. data/lib/wx/doc/gen/tree_event.rb +0 -127
  357. data/lib/wx/doc/gen/treebook.rb +0 -180
  358. data/lib/wx/doc/gen/ui_action_simulator.rb +0 -109
  359. data/lib/wx/doc/gen/utils.rb +0 -273
  360. data/lib/wx/doc/gen/v_list_box.rb +0 -272
  361. data/lib/wx/doc/gen/v_scrolled_canvas.rb +0 -195
  362. data/lib/wx/doc/gen/v_scrolled_window.rb +0 -191
  363. data/lib/wx/doc/gen/validator.rb +0 -68
  364. data/lib/wx/doc/gen/variant.rb +0 -294
  365. data/lib/wx/doc/gen/web/event_list.rb +0 -95
  366. data/lib/wx/doc/gen/web/web_view.rb +0 -1136
  367. data/lib/wx/doc/gen/web/web_view_event.rb +0 -210
  368. data/lib/wx/doc/gen/web/web_view_handler.rb +0 -318
  369. data/lib/wx/doc/gen/window.rb +0 -2917
  370. data/lib/wx/doc/gen/window_dc.rb +0 -38
  371. data/lib/wx/doc/gen/window_disabler.rb +0 -30
  372. data/lib/wx/doc/gen/with_images.rb +0 -84
  373. data/lib/wx/doc/gen/wizard.rb +0 -257
  374. data/lib/wx/doc/gen/wizard_event.rb +0 -113
  375. data/lib/wx/doc/gen/wizard_page.rb +0 -65
  376. data/lib/wx/doc/gen/wizard_page_simple.rb +0 -88
  377. data/lib/wx/doc/gen/wrap_sizer.rb +0 -79
  378. data/lib/wx/doc/gen/xml_node.rb +0 -316
  379. data/lib/wx/doc/gen/xml_resource.rb +0 -320
  380. data/lib/wx/grid/events/evt_list.rb +0 -166
  381. data/lib/wx/html/events/evt_list.rb +0 -27
  382. data/lib/wx/pg/events/evt_list.rb +0 -73
  383. data/lib/wx/rbn/events/evt_list.rb +0 -102
  384. data/lib/wx/rt/events/evt_list.rb +0 -8
  385. data/lib/wx/rtc/events/evt_list.rb +0 -98
  386. data/lib/wx/rtc/ext/rich_text_ctrl.rb +0 -24
  387. data/lib/wx/stc/events/evt_list.rb +0 -178
  388. data/lib/wx/web/events/evt_list.rb +0 -74
  389. data/samples/art/wxruby-512x512.png +0 -0
  390. data/tests/assets/test.css +0 -1
  391. data/tests/assets/test.html +0 -9
@@ -1,253 +0,0 @@
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
- # This is convenience class that derives from both {Wx::Control} and {Wx::ItemContainer}.
10
- #
11
- # It is used as basis for some wxWidgets controls ({Wx::Choice} and {Wx::ListBox}).
12
- #
13
- # Category: {Wx::Controls}
14
- # @see Wx::ItemContainer
15
- # @see Wx::ItemContainerImmutable
16
- #
17
- #
18
- class ControlWithItems < Control
19
-
20
- # @overload append(item)
21
- # Appends item into the control.
22
- #
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).
24
- # @param item [String] String to add.
25
- # @return [Integer]
26
- # @overload append(item, clientData)
27
- # Appends item into the control.
28
- #
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).
30
- # @param item [String] String to add.
31
- # @param clientData [Object] Pointer to client data to associate with the new item.
32
- # @return [Integer]
33
- # @overload append(items)
34
- # Appends several items at once into the control.
35
- #
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.
37
- # @param items [Array<String>] Array of strings to insert.
38
- # @return [Integer]
39
- # @overload append(items, clientData)
40
- # Appends several items at once into the control.
41
- #
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.
43
- # @param items [Array<String>] Array of strings to insert.
44
- # @param clientData [Array] Array of client data pointers of the same size as items to associate with the new items.
45
- # @return [Integer]
46
- def append(*args) end
47
-
48
- # Returns a pointer to the client data associated with the given item (if any).
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.
52
- #
53
- # A pointer to the client data, or nil if not present.
54
- # @param n [Integer] The zero-based position of the item.
55
- # @return [Object]
56
- def get_client_object(n) end
57
- alias_method :client_object, :get_client_object
58
-
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.
62
- # @param n [Integer] The zero-based item index.
63
- # @param data [Object] The client data to associate with the item.
64
- # @return [void]
65
- def set_client_object(n, data) end
66
-
67
- # @overload insert(item, pos)
68
- # Inserts item into the control.
69
- #
70
- # The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
71
- # @param item [String] String to add.
72
- # @param pos [Integer] Position to insert item before, zero based.
73
- # @return [Integer]
74
- # @overload insert(item, pos, clientData)
75
- # Inserts item into the control.
76
- #
77
- # The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
78
- # @param item [String] String to add.
79
- # @param pos [Integer] Position to insert item before, zero based.
80
- # @param clientData [Object] Pointer to client data to associate with the new item.
81
- # @return [Integer]
82
- # @overload insert(items, pos)
83
- # Inserts several items at once into the control.
84
- #
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.
86
- #
87
- # The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
88
- # @param items [Array<String>] Array of strings to insert.
89
- # @param pos [Integer] Position to insert the items before, zero based.
90
- # @return [Integer]
91
- # @overload insert(items, pos, clientData)
92
- # Inserts several items at once into the control.
93
- #
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.
95
- #
96
- # The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
97
- # @param items [Array<String>] Array of strings to insert.
98
- # @param pos [Integer] Position to insert the items before, zero based.
99
- # @param clientData [Array] Array of client data pointers of the same size as items to associate with the new items.
100
- # @return [Integer]
101
- def insert(*args) end
102
-
103
- # @overload set(items)
104
- # Replaces the current control contents with the given items.
105
- #
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.
107
- # @param items [Array<String>] Array of strings to insert.
108
- # @return [void]
109
- # @overload set(items, clientData)
110
- # Replaces the current control contents with the given items.
111
- #
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.
113
- # @param items [Array<String>] Array of strings to insert.
114
- # @param clientData [Array] Array of client data pointers of the same size as items to associate with the new items.
115
- # @return [void]
116
- def set(*args) end
117
-
118
- # Removes all items from the control.
119
- #
120
- # {Wx::ControlWithItems#clear} also deletes the client data of the existing items if it is owned by the control.
121
- # @return [void]
122
- def clear; end
123
-
124
- # Deletes an item from the control.
125
- #
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.
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.
128
- # @see Wx::ControlWithItems#clear
129
- # @param n [Integer] The zero-based item index.
130
- # @return [void]
131
- def delete(n) end
132
-
133
- # The control may maintain its items in a sorted order in which case items are automatically inserted at the right position when they are inserted or appended.
134
- #
135
- # Returns true if the control maintains its items in a sorted order.
136
- # @return [Boolean]
137
- def is_sorted; end
138
- alias_method :sorted?, :is_sorted
139
-
140
- # Returns the client object associated with the given item and transfers its ownership to the caller.
141
- #
142
- # This method, unlike {Wx::ControlWithItems#get_client_object}, expects the caller to delete the returned pointer. It also replaces the internally stored pointer with nil, i.e. completely detaches the client object pointer from the control.
143
- # It's an error to call this method unless {Wx::ControlWithItems#has_client_object_data} returns true.
144
- #
145
- # The associated client object pointer to be deleted by caller or nil.
146
- # @param n [Integer] The zero-based item index.
147
- # @return [Object]
148
- def detach_client_object(n) end
149
-
150
- # Returns true, if either untyped data (<code>void*</code>) or object data ({Wx::ClientData}*) is associated with the items of the control.
151
- # @return [Boolean]
152
- def has_client_data; end
153
- alias_method :has_client_data?, :has_client_data
154
-
155
- # Returns true, if object data is associated with the items of the control.
156
- #
157
- # 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.
158
- # @return [Boolean]
159
- def has_client_object_data; end
160
- alias_method :has_client_object_data?, :has_client_object_data
161
-
162
- # Returns the number of items in the control.
163
- #
164
- #
165
- # @see Wx::ControlWithItems#is_empty
166
- # @return [Integer]
167
- def get_count; end
168
- alias_method :count, :get_count
169
-
170
- # Returns true if the control is empty or false if it has some items.
171
- #
172
- #
173
- # @see Wx::ControlWithItems#get_count
174
- # @return [Boolean]
175
- def is_empty; end
176
- alias_method :empty?, :is_empty
177
-
178
- # Returns the label of the item with the given index.
179
- #
180
- # 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.
181
- #
182
- # The label of the item.
183
- # @param n [Integer] The zero-based index.
184
- # @return [String]
185
- def get_string(n) end
186
- alias_method :string, :get_string
187
-
188
- # Returns the array of the labels of all items in the control.
189
- # @return [Array<String>]
190
- def get_strings; end
191
- alias_method :strings, :get_strings
192
-
193
- # Sets the label for the given item.
194
- # @param n [Integer] The zero-based item index.
195
- # @param string [String] The label to set.
196
- # @return [void]
197
- def set_string(n, string) end
198
-
199
- # Finds an item whose label matches the given string.
200
- #
201
- # The zero-based position of the item, or {Wx::NOT_FOUND} if the string was not found.
202
- # @param string [String] String to find.
203
- # @param caseSensitive [Boolean] Whether search is case sensitive (default is not).
204
- # @return [Integer]
205
- def find_string(string, caseSensitive=false) end
206
-
207
- # Sets the selection to the given item n or removes the selection entirely if n == {Wx::NOT_FOUND}.
208
- #
209
- # 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.
210
- # @see Wx::ControlWithItems#set_string
211
- # @see Wx::ControlWithItems#set_string_selection
212
- # @param n [Integer] The string position to select, starting from zero.
213
- # @return [void]
214
- def set_selection(n) end
215
- alias_method :selection=, :set_selection
216
-
217
- # Returns the index of the selected item or {Wx::NOT_FOUND} if no item is selected.
218
- #
219
- # The position of the current selection.
220
- # @see Wx::ControlWithItems#set_selection
221
- # @see Wx::ControlWithItems#get_string_selection
222
- # @return [Integer]
223
- def get_selection; end
224
- alias_method :selection, :get_selection
225
-
226
- # Selects the item with the specified string in the control.
227
- #
228
- # This method doesn't cause any command events to be emitted.
229
- # 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.
230
- #
231
- # true if the specified string has been selected, false if it wasn't found in the control.
232
- # @param string [String] The string to select.
233
- # @return [Boolean]
234
- def set_string_selection(string) end
235
- alias_method :string_selection=, :set_string_selection
236
-
237
- # Returns the label of the selected item or an empty string if no item is selected.
238
- #
239
- #
240
- # @see Wx::ControlWithItems#get_selection
241
- # @return [String]
242
- def get_string_selection; end
243
- alias_method :string_selection, :get_string_selection
244
-
245
- # This is the same as {Wx::ControlWithItems#set_selection} and exists only because it is slightly more natural for controls which support multiple selection.
246
- # @param n [Integer]
247
- # @return [void]
248
- def select(n) end
249
-
250
- end # ControlWithItems
251
-
252
-
253
- end
@@ -1,45 +0,0 @@
1
- # ----------------------------------------------------------------------------
2
- # This file is automatically generated by the WXRuby3 documentation
3
- # generator. Do not alter this file.
4
- # ----------------------------------------------------------------------------
5
-
6
-
7
- module Wx
8
-
9
- # wxRuby version string
10
- WXRUBY_VERSION = '1.8.0'
11
-
12
- # wxRuby version release type (alpha, beta, rc)
13
- WXRUBY_RELEASE_TYPE = ''
14
- # wxRuby major version number
15
- WXRUBY_MAJOR = 1
16
- # wxRuby minor version number
17
- WXRUBY_MINOR = 8
18
- # wxRuby release number
19
- WXRUBY_RELEASE = 0
20
-
21
- # Convenience string for WxWidgets version info
22
- WXWIDGETS_VERSION = '3.3.3'
23
-
24
- # Integer constant reflecting the major version of the wxWidgets release used to build wxRuby
25
- WXWIDGETS_MAJOR_VERSION = 3
26
-
27
- # Integer constant reflecting the minor version of the wxWidgets release used to build wxRuby
28
- WXWIDGETS_MINOR_VERSION = 3
29
-
30
- # Integer constant reflecting the release number of the wxWidgets release used to build wxRuby
31
- WXWIDGETS_RELEASE_NUMBER = 3
32
-
33
- # Integer constant reflecting the sub-release number of the wxWidgets release used to build wxRuby
34
- WXWIDGETS_SUBRELEASE_NUMBER = 0
35
-
36
- # Integer constant reflecting the wxWidgets wxDEBUG_LEVEL
37
- WXWIDGETS_DEBUG_LEVEL = 1
38
-
39
- # Boolean constant indicating if wxRuby was build in debug (true) or release (false) mode
40
- DEBUG = false
41
-
42
- # Platform id of the wxWidgets port used to build wxRuby
43
- PLATFORM = 'WXGTK'
44
-
45
- end
@@ -1,137 +0,0 @@
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
- #
10
- #
11
- EVT_WEBREQUEST_STATE = 10340
12
-
13
- #
14
- #
15
- EVT_WEBREQUEST_DATA = 10341
16
-
17
- # This class represents a dialog that requests a user name and a password from the user.
18
- #
19
- # Currently it is implemented as a generic wxWidgets dialog on all platforms.
20
- #
21
- # <div class="wxrb-note">
22
- # <b>Note:</b>
23
- # <p>For secure saving and loading users and passwords, have a look at {Wx::SecretStore}.
24
- # </p>
25
- # </div>
26
- #
27
- # Category: Common Dialogs
28
- # @see wxCredentialEntryDialog Overview
29
- #
30
- #
31
- # @wxrb_require USE_CREDENTIALDLG
32
- class CredentialEntryDialog < Dialog
33
-
34
- # @overload initialize()
35
- # Default constructor.
36
- #
37
- # Call {Wx::CredentialEntryDialog#create} to really create the dialog later.
38
- # @return [Wx::CredentialEntryDialog]
39
- # @overload initialize(parent, message, title, cred=(Wx::WebCredentials.new()))
40
- # Constructor.
41
- #
42
- # Use {Wx::CredentialEntryDialog#show_modal} to show the dialog.
43
- # See {Wx::CredentialEntryDialog#create} method for parameter description.
44
- # @param parent [Wx::Window]
45
- # @param message [String]
46
- # @param title [String]
47
- # @param cred [Wx::WebCredentials]
48
- # @return [Wx::CredentialEntryDialog]
49
- # @overload initialize(parent, message, title, cred=(Wx::WebCredentials.new()), &block)
50
- # Constructor.
51
- #
52
- # Use {Wx::CredentialEntryDialog#show_modal} to show the dialog.
53
- # See {Wx::CredentialEntryDialog#create} method for parameter description.
54
- # @param parent [Wx::Window]
55
- # @param message [String]
56
- # @param title [String]
57
- # @param cred [Wx::WebCredentials]
58
- # @yieldparam [Wx::CredentialEntryDialog] win new instance
59
- # @return [Wx::CredentialEntryDialog]
60
- def initialize(*args) end
61
-
62
- # Create the dialog constructed using the default constructor.
63
- # @param parent [Wx::Window] Parent window.
64
- # @param message [String] Message to show on the dialog.
65
- # @param title [String] Title of the dialog.
66
- # @param cred [Wx::WebCredentials] The default username and password to use (optional).
67
- # @return [Boolean]
68
- def create(parent, message, title, cred=(Wx::WebCredentials.new())) end
69
-
70
- # Returns the credentials entered by the user.
71
- #
72
- # This should be called if {Wx::CredentialEntryDialog#show_modal} returned {Wx::StandardID::ID_OK}.
73
- # @return [Wx::WebCredentials]
74
- def get_credentials; end
75
- alias_method :credentials, :get_credentials
76
-
77
- # Sets the current user name.
78
- #
79
- # This function may be called before showing the dialog to provide the default value for the user name, if it's different from the one given at the creation time.
80
- # @param user [String]
81
- # @return [void]
82
- def set_user(user) end
83
- alias_method :user=, :set_user
84
-
85
- # Sets the current password.
86
- #
87
- # This function may be called before showing the dialog for the reasons similar to {Wx::CredentialEntryDialog#set_user}.
88
- # @param password [String]
89
- # @return [void]
90
- def set_password(password) end
91
- alias_method :password=, :set_password
92
-
93
- end # CredentialEntryDialog
94
-
95
- # Simple class containing the username and password to use for authenticating.
96
- #
97
- # Category: {Wx::Networking}
98
- # @see Wx::WebAuthChallenge
99
- #
100
- #
101
- #
102
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
103
- # @wxrb_require USE_CREDENTIALDLG
104
- class WebCredentials < ::Object
105
-
106
- # Create the new credentials object.
107
- #
108
- # Note that the password is a {Wx::SecretValue} object, to construct it from a string you need to explicitly use {Wx::SecretValue} ctor.
109
- # @param user [String]
110
- # @param password [Wx::SecretValue]
111
- # @return [Wx::WebCredentials]
112
- def initialize(user=(''), password=(Wx::SecretValue.new())) end
113
-
114
- # Return true if user name is set.
115
- #
116
- # This can be used to distinguish this object from the default-constructed one.
117
- # @return [Boolean]
118
- def is_ok; end
119
- alias_method :ok?, :is_ok
120
-
121
- # Return the user.
122
- # @return [Wx::String]
123
- def get_user; end
124
- alias_method :user, :get_user
125
-
126
- # Return the password.
127
- #
128
- #
129
- # @see Wx::SecretString
130
- # @return [Wx::SecretValue]
131
- def get_password; end
132
- alias_method :password, :get_password
133
-
134
- end # WebCredentials
135
-
136
-
137
- end
@@ -1,193 +0,0 @@
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
- #
10
- #
11
- NULL_CURSOR = nil
12
-
13
- # A cursor is a small bitmap used for denoting where the mouse pointer is, with a picture that indicates the point of a mouse click.
14
- #
15
- # As with icons, cursors in X and MS Windows are created in a different manner. Therefore, separate cursors
16
- # will be created for the different environments. Platform-specific methods for creating a {Wx::Cursor} object
17
- # are catered for, and this is an occasion where conditional compilation will probably be required
18
- # (see {Wx::Icon} for an example).
19
- # A single cursor object may be used in many windows (any subwindow type). The wxWidgets convention is to set
20
- # the cursor for a window, as in X, rather than to set it globally as in MS Windows, although a global
21
- # {set_cursor} function is also available for MS Windows use.
22
- #
23
- # Category: Graphics Device Interface (GDI)
24
- # Predefined objects/pointers:
25
- # - {Wx::NULL_CURSOR}
26
- # - {Wx::STANDARD_CURSOR}
27
- # - {Wx::HOURGLASS_CURSOR}
28
- # - {Wx::CROSS_CURSOR}
29
- # @see Wx::Bitmap
30
- # @see Wx::Icon
31
- # @see Wx::Window#set_cursor
32
- # @see Wx.set_cursor
33
- # @see Wx::StockCursor
34
- #
35
- #
36
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
37
- class Cursor < GDIObject
38
-
39
- # @overload initialize()
40
- # Default constructor.
41
- # @return [Wx::Cursor]
42
- # @overload initialize(bitmap, hotSpotX=0, hotSpotY=0)
43
- # Constructs a cursor from the provided bitmap and hotspot position.
44
- # @param bitmap [Wx::Bitmap] The bitmap to use for the cursor, should be valid.
45
- # @param hotSpotX [Integer] Hotspot x coordinate (relative to the top left of the image).
46
- # @param hotSpotY [Integer] Hotspot y coordinate (relative to the top left of the image).
47
- # @return [Wx::Cursor]
48
- # @overload initialize(bitmap, hotSpot)
49
- # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
50
- # @param bitmap [Wx::Bitmap]
51
- # @param hotSpot [Array(Integer, Integer), Wx::Point]
52
- # @return [Wx::Cursor]
53
- # @overload initialize(cursorName, type=Wx::CURSOR_DEFAULT_TYPE, hotSpotX=0, hotSpotY=0)
54
- # Constructs a cursor by passing a string resource name or filename.
55
- #
56
- # 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).
57
- # @param cursorName [String] The name of the resource or the image file to load.
58
- # @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:
59
- #
60
- # - under Windows, it defaults to {Wx::BITMAP_TYPE_CUR_RESOURCE}. Other permitted types under Windows are {Wx::BitmapType::BITMAP_TYPE_CUR} (to load a cursor from a .cur cursor file), {Wx::BitmapType::BITMAP_TYPE_ICO} (to load a cursor from a .ico icon file) and {Wx::BitmapType::BITMAP_TYPE_ANI} (to load a cursor from a .ani icon file).
61
- # - under MacOS, it defaults to {Wx::BITMAP_TYPE_MACCURSOR_RESOURCE}; when specifying a string resource name, first a PNG and then a CUR image is searched in resources.
62
- # - under GTK, it defaults to {Wx::BitmapType::BITMAP_TYPE_XPM}. See the wxCursor(const wxImage& image) ctor for more info.
63
- # - under X11, it defaults to {Wx::BitmapType::BITMAP_TYPE_XPM}.
64
- # @param hotSpotX [Integer] Hotspot x coordinate (relative to the top left of the image).
65
- # @param hotSpotY [Integer] Hotspot y coordinate (relative to the top left of the image).
66
- # @return [Wx::Cursor]
67
- # @overload initialize(name, type, hotSpot)
68
- # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
69
- # @param name [String]
70
- # @param type [Wx::BitmapType]
71
- # @param hotSpot [Array(Integer, Integer), Wx::Point]
72
- # @return [Wx::Cursor]
73
- # @overload initialize(cursorId)
74
- # Constructs a cursor using a cursor identifier.
75
- # @param cursorId [Wx::StockCursor] A stock cursor identifier. See {Wx::StockCursor}.
76
- # @return [Wx::Cursor]
77
- # @overload initialize(image)
78
- # Constructs a cursor from a {Wx::Image}.
79
- #
80
- # 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.
81
- # In WXMSW the foreground will be white and the background black. If the cursor is larger than 32x32 it is resized.
82
- # 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.
83
- # Under WXOSX (Cocoa), large cursors are supported.
84
- # Notice that the image can define the cursor hot spot. To set it you need to use {Wx::Image#set_option} with {Wx::IMAGE_OPTION_CUR_HOTSPOT_X} or {Wx::IMAGE_OPTION_CUR_HOTSPOT_Y}, e.g.
85
- # ```ruby
86
- # image.set_option(Wx::IMAGE_OPTION_CUR_HOTSPOT_X, hotSpotX)
87
- # image.set_option(Wx::IMAGE_OPTION_CUR_HOTSPOT_X, hotSpotY)
88
- # ```
89
- # @param image [Wx::Image]
90
- # @return [Wx::Cursor]
91
- # @overload initialize(cursor)
92
- # Copy constructor, uses reference counting.
93
- # @param cursor [Wx::Cursor] Pointer or reference to a cursor to copy.
94
- # @return [Wx::Cursor]
95
- def initialize(*args) end
96
-
97
- # Returns true if cursor data is present.
98
- # @return [Boolean]
99
- def is_ok; end
100
- alias_method :ok?, :is_ok
101
-
102
- # Returns the coordinates of the cursor hot spot.
103
- #
104
- # The hot spot is the point at which the mouse is actually considered to be when this cursor is used.
105
- # This method is currently implemented in WXMSW, WXGTK and WXOSX (since wxWidgets 3.3.0) and returns {Wx::DEFAULT_POSITION} in the other ports.
106
- # @return [Wx::Point]
107
- def get_hot_spot; end
108
- alias_method :hot_spot, :get_hot_spot
109
-
110
- end # Cursor
111
-
112
- # A cursor bundle is a set of different versions of the same cursor at different sizes.
113
- #
114
- # This class relationship with {Wx::Cursor} is similar to that of {Wx::BitmapBundle} with {Wx::Bitmap}, but it has a simpler interface because cursors are never scaled and always use the closest available size. It is typically used like the following:
115
- #
116
- # ```
117
- # MyFrame::MyFrame()
118
- # {
119
- # SetCursorBundle(wxCursorBundle(wxBitmapBundle::FromResources("mycursor"),
120
- # wxPoint(1, 1)));
121
- # }
122
- # ```
123
- #
124
- # Please see {Wx::BitmapBundle} documentation for more information about different ways of creating it.
125
- #
126
- # Category: Graphics Device Interface (GDI)
127
- #
128
- #
129
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
130
- class CursorBundle < ::Object
131
-
132
- # @overload initialize()
133
- # Default ctor constructs an empty bundle.
134
- #
135
- # Such bundle represents the absence of any custom cursor but not an empty cursor ({Wx::StockCursor::CURSOR_BLANK} can be used if this is really needed).
136
- # You can use the assignment operator to set the bundle contents later.
137
- # @return [Wx::CursorBundle]
138
- # @overload initialize(bitmaps, hotSpot)
139
- # Create a cursor bundle from the given bitmap bundle.
140
- # @param bitmaps [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] The bitmap bundle to use for the cursor, typically containing bitmap in at least two sizes.
141
- # @param hotSpot [Array(Integer, Integer), Wx::Point] Hotspot coordinates (relative to the top left of the image). The coordinates are relative to the default size of the bitmap bundle and are scaled by wxWidgets for other sizes.
142
- # @return [Wx::CursorBundle]
143
- # @overload initialize(bitmaps, hotSpotX=0, hotSpotY=0)
144
- # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
145
- # @param bitmaps [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]
146
- # @param hotSpotX [Integer]
147
- # @param hotSpotY [Integer]
148
- # @return [Wx::CursorBundle]
149
- # @overload initialize(other)
150
- # Copy constructor performs a shallow copy of the bundle.
151
- #
152
- # This operation is cheap as it doesn't copy any bitmaps.
153
- # @param other [Wx::CursorBundle]
154
- # @return [Wx::CursorBundle]
155
- def initialize(*args) end
156
-
157
- # Check if cursor bundle is non-empty.
158
- # @return [Boolean]
159
- def is_ok; end
160
- alias_method :ok?, :is_ok
161
-
162
- # Clear the bundle contents.
163
- #
164
- # {Wx::CursorBundle#is_ok} will return false after doing this.
165
- # Use the assignment operator to set the bundle contents later.
166
- # @return [void]
167
- def clear; end
168
-
169
- # Get the cursor of the size suitable for the given window.
170
- # @param window [Wx::Window]
171
- # @return [Wx::Cursor]
172
- def get_cursor_for(window) end
173
- alias_method :cursor_for, :get_cursor_for
174
-
175
- # Get the cursor of the default size.
176
- #
177
- # Prefer to use {Wx::CursorBundle#get_cursor_for} instead if there is a suitable window available, this function only exists as last resort.
178
- # @return [Wx::Cursor]
179
- def get_cursor_for_main_window; end
180
- alias_method :cursor_for_main_window, :get_cursor_for_main_window
181
-
182
- # Check if two objects refer to the same bundle.
183
- #
184
- # Note that this compares the object identity, i.e. this function returns true only for copies of the same bundle, but false for two bundles created from the same bitmap bundle and same hotspot coordinates.
185
- # @param other [Wx::CursorBundle]
186
- # @return [Boolean]
187
- def is_same_as(other) end
188
- alias_method :same_as?, :is_same_as
189
-
190
- end # CursorBundle
191
-
192
-
193
- end