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,945 +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
- # Values which define the behaviour for resizing {Wx::FlexGridSizer} cells in the "non-flexible" direction.
10
- #
11
- #
12
- #
13
- class FlexSizerGrowMode < Wx::Enum
14
-
15
- # Don't resize the cells in non-flexible direction at all.
16
- #
17
- FLEX_GROWMODE_NONE = Wx::FlexSizerGrowMode.new(0)
18
-
19
- # Uniformly resize only the specified ones (default).
20
- #
21
- FLEX_GROWMODE_SPECIFIED = Wx::FlexSizerGrowMode.new(1)
22
-
23
- # Uniformly resize all cells.
24
- #
25
- FLEX_GROWMODE_ALL = Wx::FlexSizerGrowMode.new(2)
26
-
27
- end # FlexSizerGrowMode
28
-
29
- # {Wx::Sizer} is the abstract base class used for laying out subwindows in a window.
30
- #
31
- # You cannot use {Wx::Sizer} directly; instead, you will have to use one of the sizer classes derived from it. Currently there are {Wx::BoxSizer}, {Wx::StaticBoxSizer}, {Wx::GridSizer}, {Wx::FlexGridSizer}, {Wx::WrapSizer} and {Wx::GridBagSizer}.
32
- # The layout algorithm used by sizers in wxWidgets is closely related to layout in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is based upon the idea of the individual subwindows reporting their minimal required size and their ability to get stretched if the size of the parent window has changed.
33
- # This will most often mean that the programmer does not set the original size of a dialog in the beginning, rather the dialog will be assigned a sizer and this sizer will be queried about the recommended size. The sizer in turn will query its children, which can be normal windows, empty space or other sizers, so that a hierarchy of sizers can be constructed. Note that {Wx::Sizer} does not derive from {Wx::Window} and thus does not interfere with tab ordering and requires very little resources compared to a real window on screen.
34
- # What makes sizers so well fitted for use in wxWidgets is the fact that every control reports its own minimal size and the algorithm can handle differences in font sizes or different window (dialog item) sizes on different platforms without problems. If e.g. the standard font as well as the overall design of GTK widgets requires more space than on Windows, the initial dialog size will automatically be bigger on GTK than on Windows.
35
- # Sizers may also be used to control the layout of custom drawn items on the window. The {Wx::Sizer#add}, {Wx::Sizer#insert}, and {Wx::Sizer#prepend} functions return a pointer to the newly added {Wx::SizerItem}. Just add empty space of the desired size and attributes, and then use the {Wx::SizerItem#get_rect} method to determine where the drawing operations should take place.
36
- # Please notice that sizers, like child windows, are owned by the library and will be deleted by it which implies that they must be allocated on the heap. However if you create a sizer and do not add it to another sizer or window, the library wouldn't be able to delete such an orphan sizer and in this, and only this, case it should be deleted explicitly.
37
- #
38
- # ## wxSizer flags
39
- # The "flag" argument accepted by {Wx::SizerItem} constructors and other functions, e.g. {Wx::Sizer#add}, is an OR-combination of the following flags. Two main behaviours are defined using these flags. One is the border around a window: the border parameter determines the border width whereas the flags given here determine which side(s) of the item that the border will be added. The other flags determine how the sizer item behaves when the space allotted to the sizer changes, and is somewhat dependent on the specific kind of sizer used.
40
- #
41
- # {Wx::Direction::TOP}
42
- #
43
- # {Wx::Direction::BOTTOM}
44
- #
45
- # {Wx::Direction::LEFT}
46
- #
47
- # {Wx::Direction::RIGHT}
48
- #
49
- # {Wx::Direction::ALL}
50
- # These flags are used to specify which side(s) of the sizer item the border width will apply to.
51
- #
52
- # {Wx::Stretch::EXPAND}
53
- # The item will be expanded to fill the space assigned to the item. When used for the items of {Wx::BoxSizer}, the expansion only happens in the transversal direction of the sizer as only the item proportion governs its behaviour in the principal sizer direction. But when it is used for the items of {Wx::GridSizer}, this flag can be combined with the alignment flags which override it in the corresponding direction if specified, e.g. {Wx::Stretch::EXPAND} | {Wx::Alignment::ALIGN_CENTRE_VERTICAL} would expand the item only horizontally but center it vertically. Notice that this doesn't work for the default left/top alignment and {Wx::Stretch::EXPAND} still applies in both directions if it is combined with {Wx::Alignment::ALIGN_LEFT} or {Wx::Alignment::ALIGN_TOP}.
54
- #
55
- # {Wx::Stretch::SHAPED}
56
- # The item will be expanded as much as possible while also maintaining its aspect ratio.
57
- #
58
- # {Wx::SizerFlagBits::FIXED_MINSIZE}
59
- # Normally sizers use the "best", i.e. most appropriate, size of the window to determine what the minimal size of window items should be. This allows layouts to adjust correctly when the item contents, and hence its best size, changes. If this behaviour is unwanted, {Wx::SizerFlagBits::FIXED_MINSIZE} can be used to fix minimal size of the window to its initial value and not change it any more in the future. Note that the same thing can be accomplished by calling {Wx::Window#set_min_size} explicitly as well.
60
- #
61
- # {Wx::SizerFlagBits::RESERVE_SPACE_EVEN_IF_HIDDEN}
62
- # Normally {Wx::Sizers} don't allocate space for hidden windows or other items. This flag overrides this behaviour so that sufficient space is allocated for the window even if it isn't visible. This makes it possible to dynamically show and hide controls without resizing parent dialog, for example. (Available since 2.8.8.)
63
- #
64
- # {Wx::Alignment::ALIGN_CENTER}
65
- #
66
- # {Wx::Alignment::ALIGN_CENTRE}
67
- #
68
- # {Wx::Alignment::ALIGN_LEFT}
69
- #
70
- # {Wx::Alignment::ALIGN_RIGHT}
71
- #
72
- # {Wx::Alignment::ALIGN_TOP}
73
- #
74
- # {Wx::Alignment::ALIGN_BOTTOM}
75
- #
76
- # {Wx::Alignment::ALIGN_CENTER_VERTICAL}
77
- #
78
- # {Wx::Alignment::ALIGN_CENTRE_VERTICAL}
79
- #
80
- # {Wx::Alignment::ALIGN_CENTER_HORIZONTAL}
81
- #
82
- # {Wx::Alignment::ALIGN_CENTRE_HORIZONTAL}
83
- # The <code>wxALIGN_*</code> flags allow you to specify the alignment of the item within the space allotted to it by the sizer, adjusted for the border if any.
84
- #
85
- # Category: Window Layout
86
- # @see Sizers Overview
87
- #
88
- #
89
- class Sizer < Object
90
-
91
- # Returns the list of the items in this sizer.
92
- #
93
- # The elements of type-safe {Wx::List} {Wx::SizerItemList} are pointers to objects of type {Wx::SizerItem}.
94
- # @return [Wx::SizerItemList]
95
- def get_children; end
96
- alias_method :children, :get_children
97
-
98
- # @overload set_item_min_size(window, width, height)
99
- # Set an item's minimum size by window, sizer, or position.
100
- #
101
- # This function enables an application to set the size of an item after initial creation.
102
- # The window or sizer will be found recursively in the sizer's descendants.
103
- #
104
- # true if the minimal size was successfully set or false if the item was not found.
105
- # @see Wx::SizerItem#set_min_size
106
- # @param window [Wx::Window]
107
- # @param width [Integer]
108
- # @param height [Integer]
109
- # @return [Boolean]
110
- # @overload set_item_min_size(window, size)
111
- # Set an item's minimum size by window, sizer, or position.
112
- #
113
- # This function enables an application to set the size of an item after initial creation.
114
- # The window or sizer will be found recursively in the sizer's descendants.
115
- #
116
- # true if the minimal size was successfully set or false if the item was not found.
117
- # @see Wx::SizerItem#set_min_size
118
- # @param window [Wx::Window]
119
- # @param size [Array(Integer, Integer), Wx::Size]
120
- # @return [Boolean]
121
- # @overload set_item_min_size(sizer, width, height)
122
- # Set an item's minimum size by window, sizer, or position.
123
- #
124
- # This function enables an application to set the size of an item after initial creation.
125
- # The window or sizer will be found recursively in the sizer's descendants.
126
- #
127
- # true if the minimal size was successfully set or false if the item was not found.
128
- # @see Wx::SizerItem#set_min_size
129
- # @param sizer [Wx::Sizer]
130
- # @param width [Integer]
131
- # @param height [Integer]
132
- # @return [Boolean]
133
- # @overload set_item_min_size(sizer, size)
134
- # Set an item's minimum size by window, sizer, or position.
135
- #
136
- # This function enables an application to set the size of an item after initial creation.
137
- # The window or sizer will be found recursively in the sizer's descendants.
138
- #
139
- # true if the minimal size was successfully set or false if the item was not found.
140
- # @see Wx::SizerItem#set_min_size
141
- # @param sizer [Wx::Sizer]
142
- # @param size [Array(Integer, Integer), Wx::Size]
143
- # @return [Boolean]
144
- # @overload set_item_min_size(index, width, height)
145
- # Set an item's minimum size by window, sizer, or position.
146
- #
147
- # This function enables an application to set the size of an item after initial creation.
148
- # The window or sizer will be found recursively in the sizer's descendants.
149
- #
150
- # true if the minimal size was successfully set or false if the item was not found.
151
- # @see Wx::SizerItem#set_min_size
152
- # @param index [Integer]
153
- # @param width [Integer]
154
- # @param height [Integer]
155
- # @return [Boolean]
156
- # @overload set_item_min_size(index, size)
157
- # Set an item's minimum size by window, sizer, or position.
158
- #
159
- # This function enables an application to set the size of an item after initial creation.
160
- # The window or sizer will be found recursively in the sizer's descendants.
161
- #
162
- # true if the minimal size was successfully set or false if the item was not found.
163
- # @see Wx::SizerItem#set_min_size
164
- # @param index [Integer]
165
- # @param size [Array(Integer, Integer), Wx::Size]
166
- # @return [Boolean]
167
- def set_item_min_size(*args) end
168
-
169
- # The constructor.
170
- #
171
- # Note that {Wx::Sizer} is an abstract base class and may not be instantiated.
172
- # @return [Wx::Sizer]
173
- def initialize; end
174
-
175
- # @overload add(window, flags)
176
- # Appends a child to the sizer.
177
- #
178
- # {Wx::Sizer} itself is an abstract class, but the parameters are equivalent in the derived classes that you will instantiate to use it so they are described here:
179
- # @param window [Wx::Window] The window to be added to the sizer. Its initial size (either set explicitly by the user or calculated internally when using {Wx::DEFAULT_SIZE}) is interpreted as the minimal and in many cases also the initial size.
180
- # @param flags [Wx::SizerFlags] A {Wx::SizerFlags} object that enables you to specify most of the above parameters more conveniently.
181
- # @return [Wx::SizerItem]
182
- # @overload add(window, proportion=0, flag=0, border=0, userData=nil)
183
- # Appends a child to the sizer.
184
- #
185
- # {Wx::Sizer} itself is an abstract class, but the parameters are equivalent in the derived classes that you will instantiate to use it so they are described here:
186
- # @param window [Wx::Window] The window to be added to the sizer. Its initial size (either set explicitly by the user or calculated internally when using {Wx::DEFAULT_SIZE}) is interpreted as the minimal and in many cases also the initial size.
187
- # @param proportion [Integer] Although the meaning of this parameter is undefined in {Wx::Sizer}, it is used in {Wx::BoxSizer} to indicate if a child of a sizer can change its size in the main orientation of the {Wx::BoxSizer} - where 0 stands for not changeable and a value of more than zero is interpreted relative to the value of other children of the same {Wx::BoxSizer}. For example, you might have a horizontal {Wx::BoxSizer} with three children, two of which are supposed to change their size with the sizer. Then the two stretchable windows would get a value of 1 each to make them grow and shrink equally with the sizer's horizontal dimension.
188
- # @param flag [Integer] OR-combination of flags affecting sizer's behaviour. See wxSizer flags list for details.
189
- # @param border [Integer] Determines the border width, if the flag parameter is set to include any border flag.
190
- # @param userData [Object] Allows an extra object to be attached to the sizer item, for use in derived classes when sizing information is more complex than the proportion and flag will allow for.
191
- # @return [Wx::SizerItem]
192
- # @overload add(sizer, flags)
193
- # Appends a child to the sizer.
194
- #
195
- # {Wx::Sizer} itself is an abstract class, but the parameters are equivalent in the derived classes that you will instantiate to use it so they are described here:
196
- # @param sizer [Wx::Sizer] The (child-)sizer to be added to the sizer. This allows placing a child sizer in a sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several horizontal boxes on the level beneath).
197
- # @param flags [Wx::SizerFlags] A {Wx::SizerFlags} object that enables you to specify most of the above parameters more conveniently.
198
- # @return [Wx::SizerItem]
199
- # @overload add(sizer, proportion=0, flag=0, border=0, userData=nil)
200
- # Appends a child to the sizer.
201
- #
202
- # {Wx::Sizer} itself is an abstract class, but the parameters are equivalent in the derived classes that you will instantiate to use it so they are described here:
203
- # @param sizer [Wx::Sizer] The (child-)sizer to be added to the sizer. This allows placing a child sizer in a sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several horizontal boxes on the level beneath).
204
- # @param proportion [Integer] Although the meaning of this parameter is undefined in {Wx::Sizer}, it is used in {Wx::BoxSizer} to indicate if a child of a sizer can change its size in the main orientation of the {Wx::BoxSizer} - where 0 stands for not changeable and a value of more than zero is interpreted relative to the value of other children of the same {Wx::BoxSizer}. For example, you might have a horizontal {Wx::BoxSizer} with three children, two of which are supposed to change their size with the sizer. Then the two stretchable windows would get a value of 1 each to make them grow and shrink equally with the sizer's horizontal dimension.
205
- # @param flag [Integer] OR-combination of flags affecting sizer's behaviour. See wxSizer flags list for details.
206
- # @param border [Integer] Determines the border width, if the flag parameter is set to include any border flag.
207
- # @param userData [Object] Allows an extra object to be attached to the sizer item, for use in derived classes when sizing information is more complex than the proportion and flag will allow for.
208
- # @return [Wx::SizerItem]
209
- # @overload add(width, height, proportion=0, flag=0, border=0, userData=nil)
210
- # Appends a spacer child to the sizer.
211
- #
212
- # {Wx::Sizer} itself is an abstract class, but the parameters are equivalent in the derived classes that you will instantiate to use it so they are described here.
213
- # width and height specify the dimension of a spacer to be added to the sizer. Adding spacers to sizers gives more flexibility in the design of dialogs; imagine for example a horizontal box with two buttons at the bottom of a dialog: you might want to insert a space between the two buttons and make that space stretchable using the proportion flag and the result will be that the left button will be aligned with the left side of the dialog and the right button with the right side - the space in between will shrink and grow with the dialog.
214
- # @param width [Integer] Width of the spacer.
215
- # @param height [Integer] Height of the spacer.
216
- # @param proportion [Integer] Although the meaning of this parameter is undefined in {Wx::Sizer}, it is used in {Wx::BoxSizer} to indicate if a child of a sizer can change its size in the main orientation of the {Wx::BoxSizer} - where 0 stands for not changeable and a value of more than zero is interpreted relative to the value of other children of the same {Wx::BoxSizer}. For example, you might have a horizontal {Wx::BoxSizer} with three children, two of which are supposed to change their size with the sizer. Then the two stretchable windows would get a value of 1 each to make them grow and shrink equally with the sizer's horizontal dimension.
217
- # @param flag [Integer] OR-combination of flags affecting sizer's behaviour. See wxSizer flags list for details.
218
- # @param border [Integer] Determines the border width, if the flag parameter is set to include any border flag.
219
- # @param userData [Object] Allows an extra object to be attached to the sizer item, for use in derived classes when sizing information is more complex than the proportion and flag will allow for.
220
- # @return [Wx::SizerItem]
221
- # @overload add(width, height, flags)
222
- # Appends a spacer child to the sizer.
223
- # @param width [Integer] Width of the spacer.
224
- # @param height [Integer] Height of the spacer.
225
- # @param flags [Wx::SizerFlags] A {Wx::SizerFlags} object that enables you to specify most of the other parameters more conveniently.
226
- # @return [Wx::SizerItem]
227
- def add(*args) end
228
-
229
- # This base function adds non-stretchable space to both the horizontal and vertical orientation of the sizer.
230
- #
231
- # More readable way of calling:
232
- # ```ruby
233
- # Wx::Sizer::add(size, size, 0)
234
- # ```
235
- # @see Wx::BoxSizer#add_spacer
236
- # @param size [Integer]
237
- # @return [Wx::SizerItem]
238
- def add_spacer(size) end
239
-
240
- # Adds stretchable space to the sizer.
241
- #
242
- # More readable way of calling:
243
- # ```ruby
244
- # Wx::Sizer::add(0, 0, prop)
245
- # ```
246
- # @param prop [Integer]
247
- # @return [Wx::SizerItem]
248
- def add_stretch_spacer(prop=1) end
249
-
250
- # This method is abstract and has to be overwritten by any derived class.
251
- #
252
- # Here, the sizer will do the actual calculation of its children's minimal sizes.
253
- # @return [Wx::Size]
254
- def calc_min; end
255
-
256
- # May be overridden by sizers whose minimal size depends on the layout direction.
257
- #
258
- # It may be useful to override it if the sizer minimal size varies depending on its size in some direction. For example, {Wx::WrapSizer} uses it to determine the smallest size it can use and still show all of its items when the size in some direction is fixed, e.g. it returns the width of the widest control when direction is {Wx::Orientation::VERTICAL} or the total height of all controls wrapped at the given width when direction is {Wx::Orientation::HORIZONTAL}.
259
- # If the sizer minimal size doesn't depend on the size known in the given direction, this function should return {Wx::DEFAULT_SIZE} to avoid unnecessary re-layouts.
260
- # The default implementation simply returns {Wx::DEFAULT_SIZE} (after calling {Wx::Sizer#inform_first_direction} for backward compatibility).
261
- #
262
- # The minimal size of the sizer when its size in the given direction is fixed to size or {Wx::DEFAULT_SIZE} if the minimum size doesn't depend on the layout direction and is always the same.
263
- # @param direction [Integer] The direction in which the size is fixed, either {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
264
- # @param size [Integer] The size in the direction given by the direction parameter, always valid, i.e. positive.
265
- # @param availableOtherDir [Integer] The size available in the other direction, may be -1 if the available size is not known.
266
- # @return [Wx::Size]
267
- def calc_min_size_from_known_direction(direction, size, availableOtherDir) end
268
-
269
- # Detaches all children from the sizer.
270
- #
271
- # If delete_windows is true then child windows will also be deleted.
272
- # Notice that child sizers are always deleted, as a general consequence of the principle that sizers own their sizer children, but don't own their window children (because they are already owned by their parent windows).
273
- # @param delete_windows [Boolean]
274
- # @return [void]
275
- def clear(delete_windows=false) end
276
-
277
- # Computes client area size for window so that it matches the sizer's minimal size.
278
- #
279
- # Unlike {Wx::Sizer#get_min_size}, this method accounts for other constraints imposed on window, namely display's size (returned size will never be too large for the display) and maximum window size if previously set by {Wx::Window#set_max_size}.
280
- # The returned value is suitable for passing to {Wx::Window#set_client_size} or {Wx::Window#set_min_client_size}.
281
- # @see Wx::Sizer#compute_fitting_window_size
282
- # @see Wx::Sizer#fit
283
- # @param window [Wx::Window]
284
- # @return [Wx::Size]
285
- def compute_fitting_client_size(window) end
286
-
287
- # Like {Wx::Sizer#compute_fitting_client_size}, but converts the result into window size.
288
- #
289
- # The returned value is suitable for passing to {Wx::Window#set_size} or {Wx::Window#set_min_size}.
290
- # @see Wx::Sizer#compute_fitting_client_size
291
- # @see Wx::Sizer#fit
292
- # @param window [Wx::Window]
293
- # @return [Wx::Size]
294
- def compute_fitting_window_size(window) end
295
-
296
- # @overload detach(window)
297
- # Detach the child window from the sizer without destroying it.
298
- #
299
- # This method does not cause any layout or resizing to take place, call {Wx::Sizer#layout} to update the layout "on screen" after detaching a child from the sizer.
300
- # Returns true if the child item was found and detached, false otherwise.
301
- # @see Wx::Sizer#remove
302
- # @param window [Wx::Window]
303
- # @return [Boolean]
304
- # @overload detach(sizer)
305
- # Detach the child sizer from the sizer without destroying it.
306
- #
307
- # This method does not cause any layout or resizing to take place, call {Wx::Sizer#layout} to update the layout "on screen" after detaching a child from the sizer.
308
- # Returns true if the child item was found and detached, false otherwise.
309
- # @see Wx::Sizer#remove
310
- # @param sizer [Wx::Sizer]
311
- # @return [Boolean]
312
- # @overload detach(index)
313
- # Detach an item at position index from the sizer without destroying it.
314
- #
315
- # This method does not cause any layout or resizing to take place, call {Wx::Sizer#layout} to update the layout "on screen" after detaching a child from the sizer. Returns true if the child item was found and detached, false otherwise.
316
- # @see Wx::Sizer#remove
317
- # @param index [Integer]
318
- # @return [Boolean]
319
- def detach(*args) end
320
-
321
- # Tell the sizer to resize the window so that its client area matches the sizer's minimal size ({Wx::Sizer#compute_fitting_client_size} is called to determine it).
322
- #
323
- # This is commonly done in the constructor of the window itself, see sample in the description of {Wx::BoxSizer}.
324
- # The new window size.
325
- # @see Wx::Sizer#compute_fitting_client_size
326
- # @see Wx::Sizer#compute_fitting_window_size
327
- # @param window [Wx::Window]
328
- # @return [Wx::Size]
329
- def fit(window) end
330
-
331
- # Tell the sizer to resize the virtual size of the window to match the sizer's minimal size.
332
- #
333
- # This will not alter the on screen size of the window, but may cause the addition/removal/alteration of scrollbars required to view the virtual area in windows which manage it.
334
- # @see Wx::Scrolled#set_scrollbars
335
- # @see Wx::Sizer#set_virtual_size_hints
336
- # @param window [Wx::Window]
337
- # @return [void]
338
- def fit_inside(window) end
339
-
340
- # Compatibility function called by {Wx::Sizer#calc_min_size_from_known_direction}.
341
- #
342
- # This function shouldn't be used in the new code, please override {Wx::Sizer#calc_min_size_from_known_direction} instead.
343
- # @param direction [Integer]
344
- # @param size [Integer]
345
- # @param availableOtherDir [Integer]
346
- # @return [Boolean]
347
- def inform_first_direction(direction, size, availableOtherDir) end
348
-
349
- # Returns the window this sizer is used in or nil if none.
350
- # @return [Wx::Window]
351
- def get_containing_window; end
352
- alias_method :containing_window, :get_containing_window
353
-
354
- # Set the window this sizer is used in.
355
- # @param window [Wx::Window]
356
- # @return [void]
357
- def set_containing_window(window) end
358
- alias_method :containing_window=, :set_containing_window
359
-
360
- # Returns the number of items in the sizer.
361
- #
362
- # If you just need to test whether the sizer is empty or not you can also use the {Wx::Sizer#is_empty} function.
363
- # @return [Integer]
364
- def get_item_count; end
365
- alias_method :item_count, :get_item_count
366
-
367
- # @overload get_item(window, recursive=false)
368
- # Finds the {Wx::SizerItem} which holds the given window.
369
- #
370
- # Use parameter recursive to search in subsizers too.
371
- # Pointer to the item or nil if there is no item with the window.
372
- # @param window [Wx::Window]
373
- # @param recursive [Boolean]
374
- # @return [Wx::SizerItem]
375
- # @overload get_item(sizer, recursive=false)
376
- # Finds the {Wx::SizerItem} which holds the given sizer.
377
- #
378
- # Use parameter recursive to search in subsizers too.
379
- # Pointer to the item or nil if the given sizer is not in the sizer.
380
- # @param sizer [Wx::Sizer]
381
- # @param recursive [Boolean]
382
- # @return [Wx::SizerItem]
383
- # @overload get_item(index)
384
- # Finds the {Wx::SizerItem} which is located in the sizer at position index.
385
- #
386
- # Pointer to the item or nil if there is no item at that index.
387
- # @param index [Integer]
388
- # @return [Wx::SizerItem]
389
- def get_item(*args) end
390
- alias_method :item, :get_item
391
-
392
- # Finds the item in the sizer which has the given id.
393
- #
394
- # This id is not the window id but the id of the {Wx::SizerItem} itself. This is mainly useful for retrieving the sizers created from XRC resources. Use parameter recursive to search in subsizers too.
395
- # Pointer to item or nil if no item has that id.
396
- # @param id [Integer]
397
- # @param recursive [Boolean]
398
- # @return [Wx::SizerItem]
399
- def get_item_by_id(id, recursive=false) end
400
- alias_method :item_by_id, :get_item_by_id
401
-
402
- # Returns the minimal size of the sizer.
403
- #
404
- # This is either the combined minimal size of all the children and their borders or the minimal size set by {Wx::Sizer#set_min_size}, depending on which is bigger. Note that the returned value is client size, not window size. In particular, if you use the value to set toplevel window's minimal or actual size, use {Wx::Window#set_min_client_size} or {Wx::Window#set_client_size}, not {Wx::Window#set_min_size} or {Wx::Window#set_size}.
405
- # @return [Wx::Size]
406
- def get_min_size; end
407
- alias_method :min_size, :get_min_size
408
-
409
- # Returns the current position of the sizer.
410
- # @return [Wx::Point]
411
- def get_position; end
412
- alias_method :position, :get_position
413
-
414
- # Returns the current size of the sizer.
415
- # @return [Wx::Size]
416
- def get_size; end
417
- alias_method :size, :get_size
418
-
419
- # @overload hide(window, recursive=false)
420
- # Hides the child window.
421
- #
422
- # To make a sizer item disappear, use {Wx::Sizer#hide} followed by {Wx::Sizer#layout}.
423
- # Use parameter recursive to hide elements found in subsizers. Returns true if the child item was found, false otherwise.
424
- # @see Wx::Sizer#is_shown
425
- # @see Wx::Sizer#show
426
- # @param window [Wx::Window]
427
- # @param recursive [Boolean]
428
- # @return [Boolean]
429
- # @overload hide(sizer, recursive=false)
430
- # Hides the child sizer.
431
- #
432
- # To make a sizer item disappear, use {Wx::Sizer#hide} followed by {Wx::Sizer#layout}.
433
- # Use parameter recursive to hide elements found in subsizers. Returns true if the child item was found, false otherwise.
434
- # @see Wx::Sizer#is_shown
435
- # @see Wx::Sizer#show
436
- # @param sizer [Wx::Sizer]
437
- # @param recursive [Boolean]
438
- # @return [Boolean]
439
- # @overload hide(index)
440
- # Hides the item at position index.
441
- #
442
- # To make a sizer item disappear, use {Wx::Sizer#hide} followed by {Wx::Sizer#layout}.
443
- # Use parameter recursive to hide elements found in subsizers. Returns true if the child item was found, false otherwise.
444
- # @see Wx::Sizer#is_shown
445
- # @see Wx::Sizer#show
446
- # @param index [Integer]
447
- # @return [Boolean]
448
- def hide(*args) end
449
-
450
- # @overload insert(index, window, flags)
451
- # Insert a child into the sizer before any existing item at index.
452
- #
453
- # See {Wx::Sizer#add} for the meaning of the other parameters.
454
- # @param index [Integer]
455
- # @param window [Wx::Window]
456
- # @param flags [Wx::SizerFlags]
457
- # @return [Wx::SizerItem]
458
- # @overload insert(index, window, proportion=0, flag=0, border=0, userData=nil)
459
- # Insert a child into the sizer before any existing item at index.
460
- #
461
- # See {Wx::Sizer#add} for the meaning of the other parameters.
462
- # @param index [Integer]
463
- # @param window [Wx::Window]
464
- # @param proportion [Integer]
465
- # @param flag [Integer]
466
- # @param border [Integer]
467
- # @param userData [Object]
468
- # @return [Wx::SizerItem]
469
- # @overload insert(index, sizer, flags)
470
- # Insert a child into the sizer before any existing item at index.
471
- #
472
- # See {Wx::Sizer#add} for the meaning of the other parameters.
473
- # @param index [Integer]
474
- # @param sizer [Wx::Sizer]
475
- # @param flags [Wx::SizerFlags]
476
- # @return [Wx::SizerItem]
477
- # @overload insert(index, sizer, proportion=0, flag=0, border=0, userData=nil)
478
- # Insert a child into the sizer before any existing item at index.
479
- #
480
- # See {Wx::Sizer#add} for the meaning of the other parameters.
481
- # @param index [Integer]
482
- # @param sizer [Wx::Sizer]
483
- # @param proportion [Integer]
484
- # @param flag [Integer]
485
- # @param border [Integer]
486
- # @param userData [Object]
487
- # @return [Wx::SizerItem]
488
- # @overload insert(index, width, height, proportion=0, flag=0, border=0, userData=nil)
489
- # Insert a child into the sizer before any existing item at index.
490
- #
491
- # See {Wx::Sizer#add} for the meaning of the other parameters.
492
- # @param index [Integer]
493
- # @param width [Integer]
494
- # @param height [Integer]
495
- # @param proportion [Integer]
496
- # @param flag [Integer]
497
- # @param border [Integer]
498
- # @param userData [Object]
499
- # @return [Wx::SizerItem]
500
- # @overload insert(index, width, height, flags)
501
- # Insert a child into the sizer before any existing item at index.
502
- #
503
- # See {Wx::Sizer#add} for the meaning of the other parameters.
504
- # @param index [Integer]
505
- # @param width [Integer]
506
- # @param height [Integer]
507
- # @param flags [Wx::SizerFlags]
508
- # @return [Wx::SizerItem]
509
- def insert(*args) end
510
-
511
- # Inserts non-stretchable space to the sizer.
512
- #
513
- # More readable way of calling {Wx::Sizer#insert(index,size,size)}.
514
- # @param index [Integer]
515
- # @param size [Integer]
516
- # @return [Wx::SizerItem]
517
- def insert_spacer(index, size) end
518
-
519
- # Inserts stretchable space to the sizer.
520
- #
521
- # More readable way of calling {Wx::Sizer#insert(0,0,prop)}.
522
- # @param index [Integer]
523
- # @param prop [Integer]
524
- # @return [Wx::SizerItem]
525
- def insert_stretch_spacer(index, prop=1) end
526
-
527
- # Return true if the sizer has no elements.
528
- #
529
- #
530
- # @see Wx::Sizer#get_item_count
531
- # @return [Boolean]
532
- def is_empty; end
533
- alias_method :empty?, :is_empty
534
-
535
- # Call this to force layout of the children anew, e.g. after having added a child to or removed a child (window, other sizer or space) from the sizer while keeping the current dimension.
536
- # @return [void]
537
- def layout; end
538
-
539
- # @overload prepend(window, flags)
540
- # Same as {Wx::Sizer#add}, but prepends the items to the beginning of the list of items (windows, subsizers or spaces) owned by this sizer.
541
- # @param window [Wx::Window]
542
- # @param flags [Wx::SizerFlags]
543
- # @return [Wx::SizerItem]
544
- # @overload prepend(window, proportion=0, flag=0, border=0, userData=nil)
545
- # Same as {Wx::Sizer#add}, but prepends the items to the beginning of the list of items (windows, subsizers or spaces) owned by this sizer.
546
- # @param window [Wx::Window]
547
- # @param proportion [Integer]
548
- # @param flag [Integer]
549
- # @param border [Integer]
550
- # @param userData [Object]
551
- # @return [Wx::SizerItem]
552
- # @overload prepend(sizer, flags)
553
- # Same as {Wx::Sizer#add}, but prepends the items to the beginning of the list of items (windows, subsizers or spaces) owned by this sizer.
554
- # @param sizer [Wx::Sizer]
555
- # @param flags [Wx::SizerFlags]
556
- # @return [Wx::SizerItem]
557
- # @overload prepend(sizer, proportion=0, flag=0, border=0, userData=nil)
558
- # Same as {Wx::Sizer#add}, but prepends the items to the beginning of the list of items (windows, subsizers or spaces) owned by this sizer.
559
- # @param sizer [Wx::Sizer]
560
- # @param proportion [Integer]
561
- # @param flag [Integer]
562
- # @param border [Integer]
563
- # @param userData [Object]
564
- # @return [Wx::SizerItem]
565
- # @overload prepend(width, height, proportion=0, flag=0, border=0, userData=nil)
566
- # Same as {Wx::Sizer#add}, but prepends the items to the beginning of the list of items (windows, subsizers or spaces) owned by this sizer.
567
- # @param width [Integer]
568
- # @param height [Integer]
569
- # @param proportion [Integer]
570
- # @param flag [Integer]
571
- # @param border [Integer]
572
- # @param userData [Object]
573
- # @return [Wx::SizerItem]
574
- # @overload prepend(width, height, flags)
575
- # Same as {Wx::Sizer#add}, but prepends the items to the beginning of the list of items (windows, subsizers or spaces) owned by this sizer.
576
- # @param width [Integer]
577
- # @param height [Integer]
578
- # @param flags [Wx::SizerFlags]
579
- # @return [Wx::SizerItem]
580
- def prepend(*args) end
581
-
582
- # Prepends non-stretchable space to the sizer.
583
- #
584
- # More readable way of calling {Wx::Sizer#prepend(size,size,0)}.
585
- # @param size [Integer]
586
- # @return [Wx::SizerItem]
587
- def prepend_spacer(size) end
588
-
589
- # Prepends stretchable space to the sizer.
590
- #
591
- # More readable way of calling {Wx::Sizer#prepend(0,0,prop)}.
592
- # @param prop [Integer]
593
- # @return [Wx::SizerItem]
594
- def prepend_stretch_spacer(prop=1) end
595
-
596
- # Method which must be overridden in the derived sizer classes.
597
- #
598
- # The implementation should reposition the children using the current total size available to the sizer (m_size) and the size computed by the last call to {Wx::Sizer#calc_min}.
599
- # Note that you should never call this method directly, call {Wx::Sizer#layout} instead if you need to manually update the sizer elements positions. This method is only called by wxWidgets itself.
600
- # @param minSize [Array(Integer, Integer), Wx::Size]
601
- # @return [void]
602
- def reposition_children(minSize) end
603
-
604
- # @overload remove(sizer)
605
- # Removes a sizer child from the sizer and destroys it.
606
- #
607
- # <div class="wxrb-note">
608
- # <b>Note:</b>
609
- # <p>This method does not cause any layout or resizing to take place, call {Wx::Sizer#layout} to update the layout "on screen" after removing a child from the sizer.
610
- # </p>
611
- # </div>
612
- #
613
- # true if the child item was found and removed, false otherwise.
614
- # @param sizer [Wx::Sizer] The {Wx::Sizer} to be removed.
615
- # @return [Boolean]
616
- # @overload remove(index)
617
- # Removes a child from the sizer and destroys it if it is a sizer or a spacer, but not if it is a window (because windows are owned by their parent window, not the sizer).
618
- #
619
- # <div class="wxrb-note">
620
- # <b>Note:</b>
621
- # <p>This method does not cause any layout or resizing to take place, call {Wx::Sizer#layout} to update the layout "on screen" after removing a child from the sizer.
622
- # </p>
623
- # </div>
624
- #
625
- # true if the child item was found and removed, false otherwise.
626
- # @param index [Integer] The position of the child in the sizer, e.g. 0 for the first item.
627
- # @return [Boolean]
628
- def remove(*args) end
629
-
630
- # @overload replace(oldwin, newwin, recursive=false)
631
- # Detaches the given oldwin from the sizer and replaces it with the given newwin.
632
- #
633
- # The detached child window is <b>not</b> deleted (because windows are owned by their parent window, not the sizer).
634
- # Use parameter recursive to search the given element recursively in subsizers.
635
- # This method does not cause any layout or resizing to take place, call {Wx::Sizer#layout} to update the layout "on screen" after replacing a child from the sizer.
636
- # Returns true if the child item was found and removed, false otherwise.
637
- # @param oldwin [Wx::Window]
638
- # @param newwin [Wx::Window]
639
- # @param recursive [Boolean]
640
- # @return [Boolean]
641
- # @overload replace(oldsz, newsz, recursive=false)
642
- # Detaches the given oldsz from the sizer and replaces it with the given newsz.
643
- #
644
- # The detached child sizer is deleted.
645
- # Use parameter recursive to search the given element recursively in subsizers.
646
- # This method does not cause any layout or resizing to take place, call {Wx::Sizer#layout} to update the layout "on screen" after replacing a child from the sizer.
647
- # Returns true if the child item was found and removed, false otherwise.
648
- # @param oldsz [Wx::Sizer]
649
- # @param newsz [Wx::Sizer]
650
- # @param recursive [Boolean]
651
- # @return [Boolean]
652
- # @overload replace(index, newitem)
653
- # Detaches the given item at position index from the sizer and replaces it with the given {Wx::SizerItem} newitem.
654
- #
655
- # The detached child is deleted <b>only</b> if it is a sizer or a spacer (but not if it is a {Wx::Window} because windows are owned by their parent window, not the sizer).
656
- # This method does not cause any layout or resizing to take place, call {Wx::Sizer#layout} to update the layout "on screen" after replacing a child from the sizer.
657
- # Returns true if the child item was found and removed, false otherwise.
658
- # @param index [Integer]
659
- # @param newitem [Wx::SizerItem]
660
- # @return [Boolean]
661
- def replace(*args) end
662
-
663
- # @overload set_dimension(x, y, width, height)
664
- # Call this to force the sizer to take the given dimension and thus force the items owned by the sizer to resize themselves according to the rules defined by the parameter in the {Wx::Sizer#add} and {Wx::Sizer#prepend} methods.
665
- # @param x [Integer]
666
- # @param y [Integer]
667
- # @param width [Integer]
668
- # @param height [Integer]
669
- # @return [void]
670
- # @overload set_dimension(pos, size)
671
- # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
672
- # @param pos [Array(Integer, Integer), Wx::Point]
673
- # @param size [Array(Integer, Integer), Wx::Size]
674
- # @return [void]
675
- def set_dimension(*args) end
676
-
677
- # @overload set_min_size(size)
678
- # Call this to give the sizer a minimal size.
679
- #
680
- # Normally, the sizer will calculate its minimal size based purely on how much space its children need. After calling this method {Wx::Sizer#get_min_size} will return either the minimal size as requested by its children or the minimal size set here, depending on which is bigger.
681
- # @param size [Array(Integer, Integer), Wx::Size]
682
- # @return [void]
683
- # @overload set_min_size(width, height)
684
- # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
685
- # @param width [Integer]
686
- # @param height [Integer]
687
- # @return [void]
688
- def set_min_size(*args) end
689
- alias_method :min_size=, :set_min_size
690
-
691
- # This method first calls {Wx::Sizer#fit} and then {Wx::TopLevelWindow#set_size_hints} on the window passed to it.
692
- #
693
- # This function is only when window is actually a {Wx::TopLevelWindow} such as a {Wx::Frame} or a {Wx::Dialog}, since SetSizeHints only has any effect in these classes. It does nothing in normal windows or controls.
694
- # Note that window does not need to be the window using this sizer and it is, in fact, common to call this function on the sizer associated with the panel covering the client area of a frame passing it the frame pointer, as this has the desired effect of adjusting the frame size to the size fitting the panel, e.g.:
695
- # ```ruby
696
- # class MyFrame < Wx::Frame
697
- # def initialize(...)
698
- # super
699
- # panel = Wx::Panel.new(self)
700
- # sizer = Wx::BoxSizer.new(Wx::VERTICAL)
701
- # sizer.add(...)
702
- # sizer.add(...)
703
- # panel.set_sizer(sizer)
704
- #
705
- # # Use the panel sizer to set the initial and minimal size of the
706
- # # frame to fit its contents.
707
- # sizer.set_size_hints(this)
708
- # end
709
- # ```
710
- #
711
- # This function is also used by {Wx::Window#set_sizer_and_fit} which is commonly invoked in the constructor of {Wx::Dialog}-derived classes, which don't need to use an intermediate panel, see the example in wxBoxSizer overview.
712
- # @param window [Wx::Window]
713
- # @return [void]
714
- def set_size_hints(window) end
715
- alias_method :size_hints=, :set_size_hints
716
-
717
- # @overload show(window, show=true, recursive=false)
718
- # Shows or hides the window.
719
- #
720
- # To make a sizer item disappear or reappear, use {Wx::Sizer#show} followed by {Wx::Sizer#layout}.
721
- # Use parameter recursive to show or hide elements found in subsizers.
722
- # Returns true if the child item was found, false otherwise.
723
- # @see Wx::Sizer#hide
724
- # @see Wx::Sizer#is_shown
725
- # @param window [Wx::Window]
726
- # @param show [Boolean]
727
- # @param recursive [Boolean]
728
- # @return [Boolean]
729
- # @overload show(sizer, show=true, recursive=false)
730
- # Shows or hides sizer.
731
- #
732
- # To make a sizer item disappear or reappear, use {Wx::Sizer#show} followed by {Wx::Sizer#layout}.
733
- # Use parameter recursive to show or hide elements found in subsizers.
734
- # Returns true if the child item was found, false otherwise.
735
- # @see Wx::Sizer#hide
736
- # @see Wx::Sizer#is_shown
737
- # @param sizer [Wx::Sizer]
738
- # @param show [Boolean]
739
- # @param recursive [Boolean]
740
- # @return [Boolean]
741
- # @overload show(index, show=true)
742
- # Shows the item at index.
743
- #
744
- # To make a sizer item disappear or reappear, use {Wx::Sizer#show} followed by {Wx::Sizer#layout}.
745
- # Returns true if the child item was found, false otherwise.
746
- # @see Wx::Sizer#hide
747
- # @see Wx::Sizer#is_shown
748
- # @param index [Integer]
749
- # @param show [Boolean]
750
- # @return [Boolean]
751
- def show(*args) end
752
-
753
- # Show or hide all items managed by the sizer.
754
- # @param show [Boolean]
755
- # @return [void]
756
- def show_items(show) end
757
-
758
- end # Sizer
759
-
760
- # Container for sizer items flags providing readable names for them.
761
- #
762
- # Normally, when you add an item to a sizer via {Wx::Sizer#add}, you have to specify a lot of flags and parameters which can be unwieldy. This is where {Wx::SizerFlags} comes in: it allows you to specify all parameters using the named methods instead. For example, instead of
763
- #
764
- # ```ruby
765
- # sizer.add(ctrl, 0, Wx::EXPAND | Wx::ALL, 10)
766
- # ```
767
- #
768
- # you can now write
769
- #
770
- # ```ruby
771
- # sizer.add(ctrl, Wx::SizerFlags.new.expand.border(Wx::ALL, 10))
772
- # ```
773
- #
774
- # This is more readable and also allows you to create {Wx::SizerFlags} objects which can be reused for several sizer items.
775
- #
776
- # ```ruby
777
- # flagsExpand = Wx::SizerFlags.new(1)
778
- # flagsExpand.expand.border(Wx::ALL, 10)
779
- #
780
- # sizer.add(ctrl1, flagsExpand)
781
- # sizer.add(ctrl2, flagsExpand)
782
- # ```
783
- #
784
- # Note that by specification, all methods of {Wx::SizerFlags} return the {Wx::SizerFlags} object itself to allowing chaining multiple methods calls like in the examples above.
785
- #
786
- # Category: Window Layout
787
- # @see Wx::Sizer
788
- #
789
- #
790
- #
791
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
792
- class SizerFlags < ::Object
793
-
794
- # Creates the {Wx::Sizer} with the proportion specified by proportion.
795
- # @param proportion [Integer]
796
- # @return [Wx::SizerFlags]
797
- def initialize(proportion=0) end
798
-
799
- # Sets the alignment of this {Wx::SizerFlags} to align.
800
- #
801
- # This method replaces the previously set alignment with the specified one.
802
- # @see Wx::SizerFlags#top
803
- # @see Wx::SizerFlags#left
804
- # @see Wx::SizerFlags#right
805
- # @see Wx::SizerFlags#bottom
806
- # @see Wx::SizerFlags#centre
807
- # @param alignment [Integer] Combination of {Wx::ALIGN_XXX} bit masks.
808
- # @return [Wx::SizerFlags]
809
- def align(alignment) end
810
-
811
- # @overload border(direction, borderinpixels)
812
- # Sets the {Wx::SizerFlags} to have a border of a number of pixels specified by borderinpixels with the directions specified by direction.
813
- #
814
- # Prefer to use the overload below or {Wx::SizerFlags#double_border} or {Wx::SizerFlags#triple_border} versions instead of hard-coding the border value in pixels to avoid too small borders on devices with high DPI displays.
815
- # @param direction [Integer]
816
- # @param borderinpixels [Integer]
817
- # @return [Wx::SizerFlags]
818
- # @overload border(direction=Wx::Direction::ALL)
819
- # Sets the {Wx::SizerFlags} to have a border with size as returned by {Wx::SizerFlags.get_default_border}.
820
- # @param direction [Integer] Direction(s) to apply the border in.
821
- # @return [Wx::SizerFlags]
822
- def border(*args) end
823
-
824
- # Aligns the object to the bottom, similar for <code>Align(wxALIGN_BOTTOM)</code>.
825
- #
826
- # Unlike {Wx::SizerFlags#align}, this method doesn't change the horizontal alignment of the item.
827
- # @return [Wx::SizerFlags]
828
- def bottom; end
829
-
830
- # Sets the object of the {Wx::SizerFlags} to center itself in the area it is given.
831
- # @return [Wx::SizerFlags]
832
- def center; end
833
-
834
- # {Wx::SizerFlags#center} for people with the other dialect of English.
835
- # @return [Wx::SizerFlags]
836
- def centre; end
837
-
838
- # Same as {Wx::SizerFlags#centre_horizontal}.
839
- # @return [Wx::SizerFlags]
840
- def center_horizontal; end
841
-
842
- # Same as {Wx::SizerFlags#centre_vertical}.
843
- # @return [Wx::SizerFlags]
844
- def center_vertical; end
845
-
846
- # Center an item only in horizontal direction.
847
- #
848
- # This is mostly useful for 2D sizers as for the 1D ones it is shorter to just use {Wx::SizerFlags#centre} as the alignment is only used in one direction with them anyhow. For 2D sizers, centering an item in one direction is quite different from centering it in both directions however.
849
- # Note that, unlike {Wx::SizerFlags#align}, this method doesn't change the vertical alignment.
850
- # @see Wx::SizerFlags#centre_vertical
851
- # @return [Wx::SizerFlags]
852
- def centre_horizontal; end
853
-
854
- # Center an item only in vertical direction.
855
- #
856
- # The remarks in {Wx::SizerFlags#centre_horizontal} documentation also apply to this function.
857
- # Note that, unlike {Wx::SizerFlags#align}, this method doesn't change the horizontal alignment.
858
- # @return [Wx::SizerFlags]
859
- def centre_vertical; end
860
-
861
- # Sets the border in the given direction having twice the default border size.
862
- # @param direction [Integer]
863
- # @return [Wx::SizerFlags]
864
- def double_border(direction=Wx::Direction::ALL) end
865
-
866
- # Sets the border in left and right directions having the default border size.
867
- # @return [Wx::SizerFlags]
868
- def horz_border; end
869
-
870
- # Sets the border in left and right directions having twice the default border size.
871
- # @return [Wx::SizerFlags]
872
- def double_horz_border; end
873
-
874
- # Sets the object of the {Wx::SizerFlags} to expand to fill as much area as it can.
875
- # @return [Wx::SizerFlags]
876
- def expand; end
877
-
878
- # Set the {Wx::SizerFlagBits::FIXED_MINSIZE} flag which indicates that the initial size of the window should be also set as its minimal size.
879
- # @return [Wx::SizerFlags]
880
- def fixed_min_size; end
881
-
882
- # Set the {Wx::SizerFlagBits::RESERVE_SPACE_EVEN_IF_HIDDEN} flag.
883
- #
884
- # Normally {Wx::Sizers} don't allocate space for hidden windows or other items. This flag overrides this behaviour so that sufficient space is allocated for the window even if it isn't visible. This makes it possible to dynamically show and hide controls without resizing parent dialog, for example.
885
- # @return [Wx::SizerFlags]
886
- def reserve_space_even_if_hidden; end
887
-
888
- # Aligns the object to the left, similar for <code>Align(wxALIGN_LEFT)</code>.
889
- #
890
- # Unlike {Wx::SizerFlags#align}, this method doesn't change the vertical alignment of the item.
891
- # @return [Wx::SizerFlags]
892
- def left; end
893
-
894
- # Sets the proportion of this {Wx::SizerFlags} to proportion.
895
- # @param proportion [Integer]
896
- # @return [Wx::SizerFlags]
897
- def proportion(proportion) end
898
-
899
- # Aligns the object to the right, similar for <code>Align(wxALIGN_RIGHT)</code>.
900
- #
901
- # Unlike {Wx::SizerFlags#align}, this method doesn't change the vertical alignment of the item.
902
- # @return [Wx::SizerFlags]
903
- def right; end
904
-
905
- # Sets the {Wx::Stretch::SHAPED} flag which indicates that the elements should always keep the fixed width to height ratio equal to its original value.
906
- # @return [Wx::SizerFlags]
907
- def shaped; end
908
-
909
- # Aligns the object to the top, similar for <code>Align(wxALIGN_TOP)</code>.
910
- #
911
- # Unlike {Wx::SizerFlags#align}, this method doesn't change the horizontal alignment of the item.
912
- # @return [Wx::SizerFlags]
913
- def top; end
914
-
915
- # Sets the border in the given direction having thrice the default border size.
916
- # @param direction [Integer]
917
- # @return [Wx::SizerFlags]
918
- def triple_border(direction=Wx::Direction::ALL) end
919
-
920
- # Globally disable checks for sizer flag consistency in debug builds.
921
- #
922
- # By default, sizer classes such as {Wx::BoxSizer} and {Wx::FlexGridSizer} assert when passed invalid flags, even though doing this usually doesn't result in any catastrophic consequences and the invalid flags are simply ignored later. Due to this, and the fact that these checks were only added in wxWidgets 3.1, existing code may run into multiple asserts warning about incorrect sizer flags use. Using this function provides a temporary solution for avoiding such asserts when upgrading to wxWidgets 3.1 from a previous version and will prevent such checks from being done.
923
- # Please do note that correcting the code by removing the invalid flags remains a much better solution as these asserts may be very helpful to understand why some code using sizer flags doesn't work as expected, so using this function, especially permanently, rather than a temporary workaround, is not recommended.
924
- # Notice that the same effect as calling this function can be achieved by setting the environment variable WXSUPPRESS_SIZER_FLAGS_CHECK to any value.
925
- # @return [void]
926
- def self.disable_consistency_checks; end
927
-
928
- # Returns the border used by default in {Wx::SizerFlags#border} method.
929
- #
930
- # This value is scaled appropriately for the current DPI on the systems where physical pixel values are used for the control positions and sizes, i.e. not with WXGTK or WXOSX.
931
- # @see Wx::SizerFlags.get_default_border_fractional
932
- # @return [Integer]
933
- def self.get_default_border; end
934
-
935
- # Returns the border used by default, with fractional precision.
936
- #
937
- # For example when the border is scaled to a non-integer DPI.
938
- # @see Wx::SizerFlags.get_default_border
939
- # @return [Float]
940
- def self.get_default_border_fractional; end
941
-
942
- end # SizerFlags
943
-
944
-
945
- end