wxruby3 0.9.4-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.wxconfig +9 -8
- data/INSTALL.md +315 -78
- data/README.md +32 -21
- data/ext/wxbase32u_gcc_custom.dll +0 -0
- data/ext/wxbase32u_net_gcc_custom.dll +0 -0
- data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
- data/lib/wx/core/combo_ctrl.rb +171 -0
- data/lib/wx/core/ext.rb +22 -3
- data/lib/wx/doc/comboctrl.rb +128 -3
- data/lib/wx/doc/gen/about_dialog_info.rb +1 -1
- data/lib/wx/doc/gen/accelerator.rb +1 -1
- data/lib/wx/doc/gen/accessible.rb +1 -1
- data/lib/wx/doc/gen/activity_indicator.rb +1 -1
- data/lib/wx/doc/gen/animation.rb +1 -1
- data/lib/wx/doc/gen/animation_ctrl.rb +1 -1
- data/lib/wx/doc/gen/any_button.rb +1 -1
- data/lib/wx/doc/gen/app.rb +1 -1
- data/lib/wx/doc/gen/app_traits.rb +3 -55
- data/lib/wx/doc/gen/art_provider.rb +1 -3
- data/lib/wx/doc/gen/aui/aui_dock_art.rb +430 -426
- data/lib/wx/doc/gen/aui/aui_floating_frame.rb +34 -30
- data/lib/wx/doc/gen/aui/aui_manager.rb +352 -349
- data/lib/wx/doc/gen/aui/aui_manager_event.rb +107 -103
- data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +157 -153
- data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +42 -37
- data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +109 -105
- data/lib/wx/doc/gen/aui/aui_notebook.rb +438 -434
- data/lib/wx/doc/gen/aui/aui_notebook_event.rb +145 -141
- data/lib/wx/doc/gen/aui/aui_pane_info.rb +689 -685
- data/lib/wx/doc/gen/aui/aui_tab_art.rb +369 -365
- data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +100 -96
- data/lib/wx/doc/gen/aui/aui_tool_bar.rb +445 -441
- data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +268 -264
- data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +179 -175
- data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +219 -215
- data/lib/wx/doc/gen/banner_window.rb +1 -1
- data/lib/wx/doc/gen/bitmap.rb +1 -1
- data/lib/wx/doc/gen/bitmap_button.rb +1 -1
- data/lib/wx/doc/gen/bitmap_combo_box.rb +1 -1
- data/lib/wx/doc/gen/book_ctrl_base.rb +1 -1
- data/lib/wx/doc/gen/book_ctrl_event.rb +1 -1
- data/lib/wx/doc/gen/box_sizer.rb +1 -1
- data/lib/wx/doc/gen/brush.rb +1 -1
- data/lib/wx/doc/gen/busy_info.rb +1 -1
- data/lib/wx/doc/gen/button.rb +1 -1
- data/lib/wx/doc/gen/calculate_layout_event.rb +1 -1
- data/lib/wx/doc/gen/calendar_ctrl.rb +1 -1
- data/lib/wx/doc/gen/calendar_date_attr.rb +1 -1
- data/lib/wx/doc/gen/calendar_event.rb +1 -1
- data/lib/wx/doc/gen/caret.rb +1 -1
- data/lib/wx/doc/gen/check_box.rb +1 -1
- data/lib/wx/doc/gen/check_list_box.rb +1 -1
- data/lib/wx/doc/gen/choice.rb +1 -1
- data/lib/wx/doc/gen/choicebook.rb +1 -1
- data/lib/wx/doc/gen/client_dc.rb +1 -1
- data/lib/wx/doc/gen/clipboard.rb +1 -1
- data/lib/wx/doc/gen/collapsible_pane.rb +1 -1
- data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -1
- data/lib/wx/doc/gen/colour.rb +1 -2
- data/lib/wx/doc/gen/colour_dialog.rb +2 -2
- data/lib/wx/doc/gen/colour_picker_ctrl.rb +1 -1
- data/lib/wx/doc/gen/colour_picker_event.rb +1 -1
- data/lib/wx/doc/gen/combo_box.rb +4 -3
- data/lib/wx/doc/gen/combo_ctrl.rb +92 -228
- data/lib/wx/doc/gen/command_link_button.rb +1 -1
- data/lib/wx/doc/gen/config_base.rb +1 -1
- data/lib/wx/doc/gen/context_help_button.rb +1 -1
- data/lib/wx/doc/gen/control.rb +1 -1
- data/lib/wx/doc/gen/control_with_items.rb +1 -1
- data/lib/wx/doc/gen/core.rb +5 -5
- data/lib/wx/doc/gen/cursor.rb +1 -1
- data/lib/wx/doc/gen/data_format.rb +1 -1
- data/lib/wx/doc/gen/data_object.rb +1 -1
- data/lib/wx/doc/gen/data_object_simple_base.rb +1 -1
- data/lib/wx/doc/gen/date_event.rb +1 -1
- data/lib/wx/doc/gen/date_picker_ctrl.rb +1 -1
- data/lib/wx/doc/gen/dc.rb +1 -4
- data/lib/wx/doc/gen/defs.rb +1 -1
- data/lib/wx/doc/gen/dial_up_event.rb +1 -1
- data/lib/wx/doc/gen/dial_up_manager.rb +1 -1
- data/lib/wx/doc/gen/dialog.rb +1 -2
- data/lib/wx/doc/gen/dir_dialog.rb +1 -1
- data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -1
- data/lib/wx/doc/gen/dir_picker_ctrl.rb +1 -1
- data/lib/wx/doc/gen/drag_drop.rb +1 -1
- data/lib/wx/doc/gen/drag_image.rb +1 -1
- data/lib/wx/doc/gen/editable_list_box.rb +1 -1
- data/lib/wx/doc/gen/event.rb +1 -1
- data/lib/wx/doc/gen/event_blocker.rb +1 -1
- data/lib/wx/doc/gen/event_filter.rb +1 -1
- data/lib/wx/doc/gen/events.rb +3 -25
- data/lib/wx/doc/gen/evt_handler.rb +1 -1
- data/lib/wx/doc/gen/ext_help_controller.rb +1 -1
- data/lib/wx/doc/gen/file_ctrl.rb +1 -1
- data/lib/wx/doc/gen/file_ctrl_event.rb +1 -1
- data/lib/wx/doc/gen/file_dialog.rb +1 -3
- data/lib/wx/doc/gen/file_dialog_custom_control.rb +1 -1
- data/lib/wx/doc/gen/file_dialog_customize_hook.rb +54 -62
- data/lib/wx/doc/gen/file_dir_picker_event.rb +1 -1
- data/lib/wx/doc/gen/file_picker_ctrl.rb +1 -1
- data/lib/wx/doc/gen/file_system.rb +2 -59
- data/lib/wx/doc/gen/find_dialog_event.rb +1 -1
- data/lib/wx/doc/gen/find_replace_data.rb +1 -1
- data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
- data/lib/wx/doc/gen/flex_grid_sizer.rb +1 -1
- data/lib/wx/doc/gen/font.rb +1 -1
- data/lib/wx/doc/gen/font_data.rb +1 -1
- data/lib/wx/doc/gen/font_dialog.rb +1 -1
- data/lib/wx/doc/gen/font_picker_ctrl.rb +1 -1
- data/lib/wx/doc/gen/font_picker_event.rb +1 -1
- data/lib/wx/doc/gen/frame.rb +1 -2
- data/lib/wx/doc/gen/fs_file.rb +1 -1
- data/lib/wx/doc/gen/functions.rb +1 -1
- data/lib/wx/doc/gen/gauge.rb +1 -1
- data/lib/wx/doc/gen/gb_sizer_item.rb +1 -1
- data/lib/wx/doc/gen/gcdc.rb +1 -1
- data/lib/wx/doc/gen/gdi_common.rb +3 -3
- data/lib/wx/doc/gen/gdi_object.rb +1 -1
- data/lib/wx/doc/gen/generic_dir_ctrl.rb +1 -1
- data/lib/wx/doc/gen/graphics_context.rb +1 -1
- data/lib/wx/doc/gen/graphics_object.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +28 -24
- data/lib/wx/doc/gen/grid/grid_cell_attr.rb +251 -247
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +25 -21
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +27 -23
- data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +38 -34
- data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +25 -21
- data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +35 -31
- data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +28 -24
- data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +34 -30
- data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +30 -26
- data/lib/wx/doc/gen/grid/grid_cell_editor.rb +183 -179
- data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +29 -25
- data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +33 -29
- data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +34 -30
- data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +67 -63
- data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +34 -30
- data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +25 -21
- data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +93 -89
- data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +25 -21
- data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +38 -34
- data/lib/wx/doc/gen/grid/grid_ctrl.rb +2716 -2724
- data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +82 -78
- data/lib/wx/doc/gen/grid/grid_event.rb +106 -102
- data/lib/wx/doc/gen/grid/grid_range_select_event.rb +93 -89
- data/lib/wx/doc/gen/grid/grid_size_event.rb +70 -66
- data/lib/wx/doc/gen/grid/grid_string_table.rb +130 -126
- data/lib/wx/doc/gen/grid/grid_table_base.rb +303 -299
- data/lib/wx/doc/gen/grid/grid_table_message.rb +70 -66
- data/lib/wx/doc/gen/grid_bag_sizer.rb +1 -1
- data/lib/wx/doc/gen/grid_sizer.rb +1 -1
- data/lib/wx/doc/gen/gui_event_loop.rb +1 -1
- data/lib/wx/doc/gen/header_ctrl.rb +1 -2
- data/lib/wx/doc/gen/header_ctrl_event.rb +1 -1
- data/lib/wx/doc/gen/help_controller.rb +1 -1
- data/lib/wx/doc/gen/help_provider.rb +1 -1
- data/lib/wx/doc/gen/html/html_cell.rb +515 -511
- data/lib/wx/doc/gen/html/html_cell_event.rb +58 -54
- data/lib/wx/doc/gen/html/html_easy_printing.rb +171 -167
- data/lib/wx/doc/gen/html/html_help_controller.rb +292 -288
- data/lib/wx/doc/gen/html/html_help_data.rb +147 -143
- data/lib/wx/doc/gen/html/html_help_window.rb +232 -228
- data/lib/wx/doc/gen/html/html_link_event.rb +30 -26
- data/lib/wx/doc/gen/html/html_list_box.rb +301 -297
- data/lib/wx/doc/gen/html/html_printout.rb +94 -90
- data/lib/wx/doc/gen/html/html_window.rb +406 -402
- data/lib/wx/doc/gen/hyperlink_ctrl.rb +1 -1
- data/lib/wx/doc/gen/hyperlink_event.rb +1 -1
- data/lib/wx/doc/gen/icon.rb +1 -1
- data/lib/wx/doc/gen/icon_location.rb +1 -1
- data/lib/wx/doc/gen/image.rb +1 -3
- data/lib/wx/doc/gen/image_list.rb +1 -1
- data/lib/wx/doc/gen/info_bar.rb +1 -1
- data/lib/wx/doc/gen/keyboard_state.rb +1 -1
- data/lib/wx/doc/gen/list_box.rb +1 -1
- data/lib/wx/doc/gen/list_ctrl.rb +1 -2
- data/lib/wx/doc/gen/list_event.rb +1 -1
- data/lib/wx/doc/gen/listbook.rb +1 -1
- data/lib/wx/doc/gen/locale.rb +1 -1
- data/lib/wx/doc/gen/log.rb +1 -1
- data/lib/wx/doc/gen/mdi_client_window.rb +1 -1
- data/lib/wx/doc/gen/mdi_frame.rb +1 -1
- data/lib/wx/doc/gen/media_ctrl.rb +1 -7
- data/lib/wx/doc/gen/media_event.rb +1 -1
- data/lib/wx/doc/gen/memory_dc.rb +1 -1
- data/lib/wx/doc/gen/menu.rb +1 -3
- data/lib/wx/doc/gen/menu_bar.rb +1 -1
- data/lib/wx/doc/gen/menu_item.rb +1 -1
- data/lib/wx/doc/gen/message_dialog.rb +1 -1
- data/lib/wx/doc/gen/mini_frame.rb +1 -1
- data/lib/wx/doc/gen/mirror_dc.rb +1 -1
- data/lib/wx/doc/gen/mouse_state.rb +1 -1
- data/lib/wx/doc/gen/multi_choice_dialog.rb +1 -1
- data/lib/wx/doc/gen/non_owned_window.rb +1 -1
- data/lib/wx/doc/gen/notebook.rb +1 -2
- data/lib/wx/doc/gen/num_validator.rb +1 -1
- data/lib/wx/doc/gen/number_entry_dialog.rb +1 -1
- data/lib/wx/doc/gen/object.rb +1 -1
- data/lib/wx/doc/gen/owner_drawn_combo_box.rb +1 -1
- data/lib/wx/doc/gen/paint_dc.rb +1 -1
- data/lib/wx/doc/gen/palette.rb +1 -1
- data/lib/wx/doc/gen/panel.rb +1 -1
- data/lib/wx/doc/gen/pen.rb +1 -1
- data/lib/wx/doc/gen/persistence_manager.rb +1 -1
- data/lib/wx/doc/gen/persistent_object.rb +1 -1
- data/lib/wx/doc/gen/persistent_window.rb +1 -1
- data/lib/wx/doc/gen/pg/numeric_property_validator.rb +33 -29
- data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +299 -295
- data/lib/wx/doc/gen/pg/pg_cell.rb +162 -158
- data/lib/wx/doc/gen/pg/pg_editor.rb +693 -689
- data/lib/wx/doc/gen/pg/pg_multi_button.rb +133 -129
- data/lib/wx/doc/gen/pg/pg_properties.rb +2662 -2658
- data/lib/wx/doc/gen/pg/pg_property.rb +1929 -1938
- data/lib/wx/doc/gen/pg/pg_validation_info.rb +275 -273
- data/lib/wx/doc/gen/pg/property_grid.rb +708 -706
- data/lib/wx/doc/gen/pg/property_grid_event.rb +168 -164
- data/lib/wx/doc/gen/pg/property_grid_interface.rb +1071 -1067
- data/lib/wx/doc/gen/pg/property_grid_manager.rb +386 -384
- data/lib/wx/doc/gen/pg/property_grid_page.rb +267 -265
- data/lib/wx/doc/gen/pg/property_grid_page_state.rb +147 -144
- data/lib/wx/doc/gen/picker_base.rb +1 -1
- data/lib/wx/doc/gen/platform_info.rb +1 -1
- data/lib/wx/doc/gen/popup_window.rb +1 -1
- data/lib/wx/doc/gen/progress_dialog.rb +1 -1
- data/lib/wx/doc/gen/property_sheet_dialog.rb +1 -1
- data/lib/wx/doc/gen/prt/page_setup_dialog.rb +32 -28
- data/lib/wx/doc/gen/prt/post_script_dc.rb +21 -18
- data/lib/wx/doc/gen/prt/preview_frame.rb +49 -45
- data/lib/wx/doc/gen/prt/print_abort_dialog.rb +126 -122
- data/lib/wx/doc/gen/prt/print_data.rb +637 -633
- data/lib/wx/doc/gen/prt/print_dialog.rb +43 -39
- data/lib/wx/doc/gen/prt/printer.rb +484 -480
- data/lib/wx/doc/gen/prt/printer_dc.rb +26 -22
- data/lib/wx/doc/gen/query_layout_info_event.rb +1 -1
- data/lib/wx/doc/gen/radio_box.rb +1 -1
- data/lib/wx/doc/gen/radio_button.rb +1 -1
- data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +1716 -1712
- data/lib/wx/doc/gen/rbn/ribbon_bar.rb +239 -235
- data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +34 -30
- data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +439 -435
- data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +52 -48
- data/lib/wx/doc/gen/rbn/ribbon_control.rb +116 -112
- data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +205 -201
- data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +44 -40
- data/lib/wx/doc/gen/rbn/ribbon_page.rb +129 -125
- data/lib/wx/doc/gen/rbn/ribbon_panel.rb +229 -225
- data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +34 -30
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +329 -325
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +31 -27
- data/lib/wx/doc/gen/rearrange_ctrl.rb +1 -1
- data/lib/wx/doc/gen/rearrange_list.rb +1 -1
- data/lib/wx/doc/gen/region.rb +1 -1
- data/lib/wx/doc/gen/region_iterator.rb +1 -1
- data/lib/wx/doc/gen/rtc/rich_text_box.rb +424 -420
- data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +1148 -1144
- data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +30 -26
- data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +516 -512
- data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +1991 -1987
- data/lib/wx/doc/gen/rtc/rich_text_event.rb +159 -155
- data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +167 -163
- data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +271 -267
- data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +171 -167
- data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +88 -85
- data/lib/wx/doc/gen/rtc/rich_text_image.rb +323 -319
- data/lib/wx/doc/gen/rtc/rich_text_object.rb +2819 -2815
- data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1187 -1183
- data/lib/wx/doc/gen/rtc/rich_text_printing.rb +242 -238
- data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +286 -279
- data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +181 -177
- data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +47 -44
- data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +145 -141
- data/lib/wx/doc/gen/sash_event.rb +1 -1
- data/lib/wx/doc/gen/sash_layout_window.rb +1 -1
- data/lib/wx/doc/gen/sash_window.rb +1 -1
- data/lib/wx/doc/gen/scaled_dc.rb +1 -1
- data/lib/wx/doc/gen/screen_dc.rb +1 -1
- data/lib/wx/doc/gen/scroll_bar.rb +1 -2
- data/lib/wx/doc/gen/scrolled_canvas.rb +1 -1
- data/lib/wx/doc/gen/scrolled_control.rb +1 -1
- data/lib/wx/doc/gen/scrolled_window.rb +1 -1
- data/lib/wx/doc/gen/search_ctrl.rb +1 -1
- data/lib/wx/doc/gen/simplebook.rb +1 -1
- data/lib/wx/doc/gen/single_choice_dialog.rb +1 -1
- data/lib/wx/doc/gen/sizer.rb +1 -2
- data/lib/wx/doc/gen/sizer_item.rb +1 -1
- data/lib/wx/doc/gen/slider.rb +1 -2
- data/lib/wx/doc/gen/spin_button.rb +1 -1
- data/lib/wx/doc/gen/spin_ctrl.rb +1 -1
- data/lib/wx/doc/gen/spin_ctrl_double.rb +1 -1
- data/lib/wx/doc/gen/spin_double_event.rb +1 -1
- data/lib/wx/doc/gen/spin_event.rb +1 -1
- data/lib/wx/doc/gen/splash_screen.rb +2 -2
- data/lib/wx/doc/gen/splitter_event.rb +1 -1
- data/lib/wx/doc/gen/splitter_window.rb +1 -1
- data/lib/wx/doc/gen/static_bitmap.rb +1 -1
- data/lib/wx/doc/gen/static_box.rb +1 -1
- data/lib/wx/doc/gen/static_box_sizer.rb +1 -1
- data/lib/wx/doc/gen/static_line.rb +1 -1
- data/lib/wx/doc/gen/static_text.rb +1 -1
- data/lib/wx/doc/gen/status_bar.rb +1 -1
- data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4202 -4199
- data/lib/wx/doc/gen/stc/styled_text_event.rb +7511 -7508
- data/lib/wx/doc/gen/std_dialog_button_sizer.rb +1 -1
- data/lib/wx/doc/gen/svg_file_dc.rb +1 -1
- data/lib/wx/doc/gen/system_options.rb +1 -1
- data/lib/wx/doc/gen/system_settings.rb +1 -1
- data/lib/wx/doc/gen/task_bar_button.rb +1 -1
- data/lib/wx/doc/gen/task_bar_icon.rb +1 -2
- data/lib/wx/doc/gen/task_bar_icon_event.rb +1 -1
- data/lib/wx/doc/gen/text_attr.rb +1 -1
- data/lib/wx/doc/gen/text_ctrl.rb +1 -6
- data/lib/wx/doc/gen/text_entry.rb +1 -1
- data/lib/wx/doc/gen/text_entry_dialog.rb +1 -1
- data/lib/wx/doc/gen/text_validator.rb +1 -1
- data/lib/wx/doc/gen/time_picker_ctrl.rb +1 -1
- data/lib/wx/doc/gen/timer.rb +1 -1
- data/lib/wx/doc/gen/timer_event.rb +1 -1
- data/lib/wx/doc/gen/tip_provider.rb +1 -1
- data/lib/wx/doc/gen/toggle_button.rb +1 -1
- data/lib/wx/doc/gen/tool_bar.rb +1 -1
- data/lib/wx/doc/gen/tool_tip.rb +1 -1
- data/lib/wx/doc/gen/toolbook.rb +1 -1
- data/lib/wx/doc/gen/top_level_window.rb +1 -1
- data/lib/wx/doc/gen/tree_ctrl.rb +1 -3
- data/lib/wx/doc/gen/tree_event.rb +1 -1
- data/lib/wx/doc/gen/treebook.rb +1 -1
- data/lib/wx/doc/gen/ui_action_simulator.rb +1 -1
- data/lib/wx/doc/gen/utils.rb +1 -1
- data/lib/wx/doc/gen/v_list_box.rb +1 -1
- data/lib/wx/doc/gen/v_scrolled_window.rb +1 -2
- data/lib/wx/doc/gen/validator.rb +1 -1
- data/lib/wx/doc/gen/variant.rb +1 -1
- data/lib/wx/doc/gen/window.rb +1 -1
- data/lib/wx/doc/gen/window_dc.rb +1 -1
- data/lib/wx/doc/gen/window_disabler.rb +1 -1
- data/lib/wx/doc/gen/with_images.rb +1 -1
- data/lib/wx/doc/gen/wizard.rb +1 -2
- data/lib/wx/doc/gen/wizard_event.rb +1 -1
- data/lib/wx/doc/gen/wizard_page.rb +1 -2
- data/lib/wx/doc/gen/wizard_page_simple.rb +1 -1
- data/lib/wx/doc/gen/wrap_sizer.rb +1 -1
- data/lib/wx/doc/gen/xml_node.rb +1 -1
- data/lib/wx/doc/gen/xml_resource.rb +1 -1
- data/lib/wx/doc/owner_drawn_combobox.rb +5 -1
- data/lib/wx/rtc/ext/rich_text_ctrl.rb +5 -5
- data/lib/wx/version.rb +1 -1
- data/lib/wx/wxruby/base.rb +6 -4
- data/lib/wx/wxruby/cmd/sampler.rb +39 -29
- data/lib/wx/wxruby/cmd/setup.rb +122 -0
- data/lib/wx/wxruby/cmd/test.rb +56 -6
- data/lib/wxruby_aui.so +0 -0
- data/lib/wxruby_core.so +0 -0
- data/lib/wxruby_grid.so +0 -0
- data/lib/wxruby_html.so +0 -0
- data/lib/wxruby_pg.so +0 -0
- data/lib/wxruby_prt.so +0 -0
- data/lib/wxruby_rbn.so +0 -0
- data/lib/wxruby_rtc.so +0 -0
- data/lib/wxruby_stc.so +0 -0
- data/rakelib/install.rb +2 -0
- data/rakelib/lib/config/linux.rb +24 -2
- data/rakelib/lib/config/macosx.rb +16 -0
- data/rakelib/lib/config/mingw.rb +133 -9
- data/rakelib/lib/config/pkgman/arch.rb +53 -0
- data/rakelib/lib/config/pkgman/base.rb +169 -0
- data/rakelib/lib/config/pkgman/debian.rb +66 -0
- data/rakelib/lib/config/pkgman/macosx.rb +183 -0
- data/rakelib/lib/config/pkgman/rhel.rb +54 -0
- data/rakelib/lib/config/pkgman/suse.rb +54 -0
- data/rakelib/lib/config/unixish.rb +36 -19
- data/rakelib/lib/config.rb +254 -61
- data/rakelib/prepost.rake +9 -4
- data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +14 -0
- data/rakelib/yard/templates/default/fulldoc/html/setup.rb +5 -5
- data/rakelib/yard/yard/relative_markdown_links.rb +7 -1
- data/tests/test_combo_ctrl.rb +196 -0
- metadata +25 -4
@@ -6,1732 +6,1736 @@
|
|
6
6
|
|
7
7
|
module Wx::RBN
|
8
8
|
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
# @see Wx::RBN::RibbonArtProvider#get_colour
|
13
|
-
#
|
14
|
-
# @see Wx::RBN::RibbonArtProvider#get_font
|
15
|
-
#
|
16
|
-
# @see Wx::RBN::RibbonArtProvider#get_metric
|
17
|
-
#
|
18
|
-
# @see Wx::RBN::RibbonArtProvider#set_colour
|
19
|
-
#
|
20
|
-
# @see Wx::RBN::RibbonArtProvider#set_font
|
21
|
-
#
|
22
|
-
# @see Wx::RBN::RibbonArtProvider#set_metric
|
23
|
-
#
|
24
|
-
#
|
25
|
-
# @wxrb_require USE_RIBBON
|
26
|
-
class RibbonArtSetting < Wx::Enum
|
27
|
-
|
28
|
-
#
|
29
|
-
#
|
30
|
-
RIBBON_ART_TAB_SEPARATION_SIZE = Wx::RBN::RibbonArtSetting.new(0)
|
31
|
-
|
32
|
-
#
|
33
|
-
#
|
34
|
-
RIBBON_ART_PAGE_BORDER_LEFT_SIZE = Wx::RBN::RibbonArtSetting.new(1)
|
35
|
-
|
36
|
-
#
|
37
|
-
#
|
38
|
-
RIBBON_ART_PAGE_BORDER_TOP_SIZE = Wx::RBN::RibbonArtSetting.new(2)
|
39
|
-
|
40
|
-
#
|
41
|
-
#
|
42
|
-
RIBBON_ART_PAGE_BORDER_RIGHT_SIZE = Wx::RBN::RibbonArtSetting.new(3)
|
43
|
-
|
44
|
-
#
|
45
|
-
#
|
46
|
-
RIBBON_ART_PAGE_BORDER_BOTTOM_SIZE = Wx::RBN::RibbonArtSetting.new(4)
|
47
|
-
|
48
|
-
#
|
49
|
-
#
|
50
|
-
RIBBON_ART_PANEL_X_SEPARATION_SIZE = Wx::RBN::RibbonArtSetting.new(5)
|
51
|
-
|
52
|
-
#
|
53
|
-
#
|
54
|
-
RIBBON_ART_PANEL_Y_SEPARATION_SIZE = Wx::RBN::RibbonArtSetting.new(6)
|
55
|
-
|
56
|
-
#
|
57
|
-
#
|
58
|
-
RIBBON_ART_TOOL_GROUP_SEPARATION_SIZE = Wx::RBN::RibbonArtSetting.new(7)
|
59
|
-
|
60
|
-
#
|
61
|
-
#
|
62
|
-
RIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE = Wx::RBN::RibbonArtSetting.new(8)
|
63
|
-
|
64
|
-
#
|
65
|
-
#
|
66
|
-
RIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE = Wx::RBN::RibbonArtSetting.new(9)
|
67
|
-
|
68
|
-
#
|
69
|
-
#
|
70
|
-
RIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE = Wx::RBN::RibbonArtSetting.new(10)
|
71
|
-
|
72
|
-
#
|
73
|
-
#
|
74
|
-
RIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE = Wx::RBN::RibbonArtSetting.new(11)
|
75
|
-
|
76
|
-
#
|
77
|
-
#
|
78
|
-
RIBBON_ART_PANEL_LABEL_FONT = Wx::RBN::RibbonArtSetting.new(12)
|
79
|
-
|
80
|
-
#
|
81
|
-
#
|
82
|
-
RIBBON_ART_BUTTON_BAR_LABEL_FONT = Wx::RBN::RibbonArtSetting.new(13)
|
83
|
-
|
84
|
-
#
|
85
|
-
#
|
86
|
-
RIBBON_ART_TAB_LABEL_FONT = Wx::RBN::RibbonArtSetting.new(14)
|
87
|
-
|
88
|
-
#
|
89
|
-
#
|
90
|
-
RIBBON_ART_BUTTON_BAR_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(15)
|
91
|
-
|
92
|
-
#
|
93
|
-
#
|
94
|
-
RIBBON_ART_BUTTON_BAR_LABEL_DISABLED_COLOUR = Wx::RBN::RibbonArtSetting.new(106)
|
95
|
-
|
96
|
-
#
|
97
|
-
#
|
98
|
-
RIBBON_ART_BUTTON_BAR_HOVER_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(16)
|
99
|
-
|
100
|
-
#
|
101
|
-
#
|
102
|
-
RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(17)
|
103
|
-
|
104
|
-
#
|
105
|
-
#
|
106
|
-
RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(18)
|
107
|
-
|
108
|
-
#
|
109
|
-
#
|
110
|
-
RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(19)
|
111
|
-
|
112
|
-
#
|
113
|
-
#
|
114
|
-
RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(20)
|
115
|
-
|
116
|
-
#
|
117
|
-
#
|
118
|
-
RIBBON_ART_BUTTON_BAR_ACTIVE_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(21)
|
119
|
-
|
120
|
-
#
|
121
|
-
#
|
122
|
-
RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(22)
|
123
|
-
|
124
|
-
#
|
125
|
-
#
|
126
|
-
RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(23)
|
127
|
-
|
128
|
-
#
|
129
|
-
#
|
130
|
-
RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(24)
|
131
|
-
|
132
|
-
#
|
133
|
-
#
|
134
|
-
RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(25)
|
135
|
-
|
136
|
-
#
|
137
|
-
#
|
138
|
-
RIBBON_ART_GALLERY_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(26)
|
139
|
-
|
140
|
-
#
|
141
|
-
#
|
142
|
-
RIBBON_ART_GALLERY_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(27)
|
143
|
-
|
144
|
-
#
|
145
|
-
#
|
146
|
-
RIBBON_ART_GALLERY_BUTTON_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(28)
|
147
|
-
|
148
|
-
#
|
149
|
-
#
|
150
|
-
RIBBON_ART_GALLERY_BUTTON_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(29)
|
151
|
-
|
152
|
-
#
|
153
|
-
#
|
154
|
-
RIBBON_ART_GALLERY_BUTTON_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(30)
|
155
|
-
|
156
|
-
#
|
157
|
-
#
|
158
|
-
RIBBON_ART_GALLERY_BUTTON_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(31)
|
159
|
-
|
160
|
-
#
|
161
|
-
#
|
162
|
-
RIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(32)
|
163
|
-
|
164
|
-
#
|
165
|
-
#
|
166
|
-
RIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(33)
|
167
|
-
|
168
|
-
#
|
169
|
-
#
|
170
|
-
RIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(34)
|
171
|
-
|
172
|
-
#
|
173
|
-
#
|
174
|
-
RIBBON_ART_GALLERY_BUTTON_HOVER_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(35)
|
175
|
-
|
176
|
-
#
|
177
|
-
#
|
178
|
-
RIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(36)
|
179
|
-
|
180
|
-
#
|
181
|
-
#
|
182
|
-
RIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(37)
|
183
|
-
|
184
|
-
#
|
185
|
-
#
|
186
|
-
RIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(38)
|
187
|
-
|
188
|
-
#
|
189
|
-
#
|
190
|
-
RIBBON_ART_GALLERY_BUTTON_ACTIVE_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(39)
|
191
|
-
|
192
|
-
#
|
193
|
-
#
|
194
|
-
RIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(40)
|
195
|
-
|
196
|
-
#
|
197
|
-
#
|
198
|
-
RIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(41)
|
199
|
-
|
200
|
-
#
|
201
|
-
#
|
202
|
-
RIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(42)
|
203
|
-
|
204
|
-
#
|
205
|
-
#
|
206
|
-
RIBBON_ART_GALLERY_BUTTON_DISABLED_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(43)
|
207
|
-
|
208
|
-
#
|
209
|
-
#
|
210
|
-
RIBBON_ART_GALLERY_ITEM_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(44)
|
211
|
-
|
212
|
-
#
|
213
|
-
#
|
214
|
-
RIBBON_ART_TAB_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(45)
|
215
|
-
|
216
|
-
#
|
217
|
-
#
|
218
|
-
RIBBON_ART_TAB_ACTIVE_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(46)
|
219
|
-
|
220
|
-
#
|
221
|
-
#
|
222
|
-
RIBBON_ART_TAB_HOVER_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(47)
|
223
|
-
|
224
|
-
#
|
225
|
-
#
|
226
|
-
RIBBON_ART_TAB_SEPARATOR_COLOUR = Wx::RBN::RibbonArtSetting.new(48)
|
227
|
-
|
228
|
-
#
|
229
|
-
#
|
230
|
-
RIBBON_ART_TAB_SEPARATOR_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(49)
|
231
|
-
|
232
|
-
#
|
233
|
-
#
|
234
|
-
RIBBON_ART_TAB_CTRL_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(50)
|
235
|
-
|
236
|
-
#
|
237
|
-
#
|
238
|
-
RIBBON_ART_TAB_CTRL_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(51)
|
239
|
-
|
240
|
-
#
|
241
|
-
#
|
242
|
-
RIBBON_ART_TAB_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(52)
|
243
|
-
|
244
|
-
#
|
245
|
-
#
|
246
|
-
RIBBON_ART_TAB_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(53)
|
247
|
-
|
248
|
-
#
|
249
|
-
#
|
250
|
-
RIBBON_ART_TAB_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(54)
|
251
|
-
|
252
|
-
#
|
253
|
-
#
|
254
|
-
RIBBON_ART_TAB_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(55)
|
255
|
-
|
256
|
-
#
|
257
|
-
#
|
258
|
-
RIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(56)
|
259
|
-
|
260
|
-
#
|
261
|
-
#
|
262
|
-
RIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(57)
|
263
|
-
|
264
|
-
#
|
265
|
-
#
|
266
|
-
RIBBON_ART_TAB_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(58)
|
267
|
-
|
268
|
-
#
|
269
|
-
#
|
270
|
-
RIBBON_ART_TAB_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(59)
|
271
|
-
|
272
|
-
#
|
273
|
-
#
|
274
|
-
RIBBON_ART_TAB_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(60)
|
275
|
-
|
276
|
-
#
|
277
|
-
#
|
278
|
-
RIBBON_ART_PANEL_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(61)
|
279
|
-
|
280
|
-
#
|
281
|
-
#
|
282
|
-
RIBBON_ART_PANEL_BORDER_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(62)
|
283
|
-
|
284
|
-
#
|
285
|
-
#
|
286
|
-
RIBBON_ART_PANEL_HOVER_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(63)
|
287
|
-
|
288
|
-
#
|
289
|
-
#
|
290
|
-
RIBBON_ART_PANEL_HOVER_BORDER_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(64)
|
291
|
-
|
292
|
-
#
|
293
|
-
#
|
294
|
-
RIBBON_ART_PANEL_MINIMISED_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(65)
|
295
|
-
|
296
|
-
#
|
297
|
-
#
|
298
|
-
RIBBON_ART_PANEL_MINIMISED_BORDER_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(66)
|
299
|
-
|
300
|
-
#
|
301
|
-
#
|
302
|
-
RIBBON_ART_PANEL_LABEL_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(67)
|
303
|
-
|
304
|
-
#
|
305
|
-
#
|
306
|
-
RIBBON_ART_PANEL_LABEL_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(68)
|
307
|
-
|
308
|
-
#
|
309
|
-
#
|
310
|
-
RIBBON_ART_PANEL_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(69)
|
311
|
-
|
312
|
-
#
|
313
|
-
#
|
314
|
-
RIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(70)
|
315
|
-
|
316
|
-
#
|
317
|
-
#
|
318
|
-
RIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(71)
|
319
|
-
|
320
|
-
#
|
321
|
-
#
|
322
|
-
RIBBON_ART_PANEL_HOVER_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(72)
|
323
|
-
|
324
|
-
#
|
325
|
-
#
|
326
|
-
RIBBON_ART_PANEL_MINIMISED_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(73)
|
327
|
-
|
328
|
-
#
|
329
|
-
#
|
330
|
-
RIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(74)
|
331
|
-
|
332
|
-
#
|
333
|
-
#
|
334
|
-
RIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(75)
|
335
|
-
|
336
|
-
#
|
337
|
-
#
|
338
|
-
RIBBON_ART_PANEL_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(76)
|
339
|
-
|
340
|
-
#
|
341
|
-
#
|
342
|
-
RIBBON_ART_PANEL_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(77)
|
343
|
-
|
344
|
-
#
|
345
|
-
#
|
346
|
-
RIBBON_ART_PAGE_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(82)
|
347
|
-
|
348
|
-
#
|
349
|
-
#
|
350
|
-
RIBBON_ART_PAGE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(83)
|
351
|
-
|
352
|
-
#
|
353
|
-
#
|
354
|
-
RIBBON_ART_PAGE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(84)
|
355
|
-
|
356
|
-
#
|
357
|
-
#
|
358
|
-
RIBBON_ART_PAGE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(85)
|
359
|
-
|
360
|
-
#
|
361
|
-
#
|
362
|
-
RIBBON_ART_PAGE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(86)
|
363
|
-
|
364
|
-
#
|
365
|
-
#
|
366
|
-
RIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(87)
|
367
|
-
|
368
|
-
#
|
369
|
-
#
|
370
|
-
RIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(88)
|
371
|
-
|
372
|
-
#
|
373
|
-
#
|
374
|
-
RIBBON_ART_PAGE_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(89)
|
375
|
-
|
376
|
-
#
|
377
|
-
#
|
378
|
-
RIBBON_ART_PAGE_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(90)
|
379
|
-
|
380
|
-
#
|
381
|
-
#
|
382
|
-
RIBBON_ART_TOOLBAR_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(91)
|
383
|
-
|
384
|
-
#
|
385
|
-
#
|
386
|
-
RIBBON_ART_TOOLBAR_HOVER_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(92)
|
387
|
-
|
388
|
-
#
|
389
|
-
#
|
390
|
-
RIBBON_ART_TOOLBAR_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(93)
|
391
|
-
|
392
|
-
#
|
393
|
-
#
|
394
|
-
RIBBON_ART_TOOL_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(94)
|
395
|
-
|
396
|
-
#
|
397
|
-
#
|
398
|
-
RIBBON_ART_TOOL_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(95)
|
399
|
-
|
400
|
-
#
|
401
|
-
#
|
402
|
-
RIBBON_ART_TOOL_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(96)
|
403
|
-
|
404
|
-
#
|
405
|
-
#
|
406
|
-
RIBBON_ART_TOOL_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(97)
|
407
|
-
|
408
|
-
#
|
409
|
-
#
|
410
|
-
RIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(98)
|
411
|
-
|
412
|
-
#
|
413
|
-
#
|
414
|
-
RIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(99)
|
415
|
-
|
416
|
-
#
|
417
|
-
#
|
418
|
-
RIBBON_ART_TOOL_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(100)
|
419
|
-
|
420
|
-
#
|
421
|
-
#
|
422
|
-
RIBBON_ART_TOOL_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(101)
|
423
|
-
|
424
|
-
#
|
425
|
-
#
|
426
|
-
RIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(102)
|
427
|
-
|
428
|
-
#
|
429
|
-
#
|
430
|
-
RIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(103)
|
431
|
-
|
432
|
-
#
|
433
|
-
#
|
434
|
-
RIBBON_ART_TOOL_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(104)
|
435
|
-
|
436
|
-
#
|
437
|
-
#
|
438
|
-
RIBBON_ART_TOOL_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(105)
|
439
|
-
|
440
|
-
#
|
441
|
-
#
|
442
|
-
RIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_COLOUR = Wx::RBN::RibbonArtSetting.new(107)
|
443
|
-
|
444
|
-
#
|
445
|
-
#
|
446
|
-
RIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(108)
|
447
|
-
|
448
|
-
#
|
449
|
-
#
|
450
|
-
RIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(109)
|
451
|
-
|
452
|
-
#
|
453
|
-
#
|
454
|
-
RIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_GRADIENT_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(110)
|
455
|
-
|
456
|
-
end # RibbonArtSetting
|
457
|
-
|
458
|
-
# Flags used to describe the direction, state, and/or purpose of a ribbon-style scroll button.
|
459
|
-
#
|
460
|
-
#
|
461
|
-
# @see Wx::RBN::RibbonArtProvider#draw_scroll_button
|
462
|
-
#
|
463
|
-
# @see Wx::RBN::RibbonArtProvider#get_scroll_button_minimum_size
|
464
|
-
#
|
465
|
-
#
|
466
|
-
# @wxrb_require USE_RIBBON
|
467
|
-
class RibbonScrollButtonStyle < Wx::Enum
|
468
|
-
|
469
|
-
# Button will scroll to the left.
|
470
|
-
#
|
471
|
-
RIBBON_SCROLL_BTN_LEFT = Wx::RBN::RibbonScrollButtonStyle.new(0)
|
472
|
-
|
473
|
-
# Button will scroll to the right.
|
474
|
-
#
|
475
|
-
RIBBON_SCROLL_BTN_RIGHT = Wx::RBN::RibbonScrollButtonStyle.new(1)
|
476
|
-
|
477
|
-
# Button will scroll upward.
|
478
|
-
#
|
479
|
-
RIBBON_SCROLL_BTN_UP = Wx::RBN::RibbonScrollButtonStyle.new(2)
|
480
|
-
|
481
|
-
# Button will scroll downward.
|
482
|
-
#
|
483
|
-
RIBBON_SCROLL_BTN_DOWN = Wx::RBN::RibbonScrollButtonStyle.new(3)
|
484
|
-
|
485
|
-
# A mask to extract direction from a combination of flags.
|
486
|
-
#
|
487
|
-
RIBBON_SCROLL_BTN_DIRECTION_MASK = Wx::RBN::RibbonScrollButtonStyle.new(3)
|
488
|
-
|
489
|
-
# Button is not active or hovered.
|
490
|
-
#
|
491
|
-
RIBBON_SCROLL_BTN_NORMAL = Wx::RBN::RibbonScrollButtonStyle.new(0)
|
492
|
-
|
493
|
-
# Button has a cursor hovering over it.
|
494
|
-
#
|
495
|
-
RIBBON_SCROLL_BTN_HOVERED = Wx::RBN::RibbonScrollButtonStyle.new(4)
|
496
|
-
|
497
|
-
# Button is being pressed.
|
498
|
-
#
|
499
|
-
RIBBON_SCROLL_BTN_ACTIVE = Wx::RBN::RibbonScrollButtonStyle.new(8)
|
500
|
-
|
501
|
-
# A mask to extract state from a combination of flags.
|
502
|
-
#
|
503
|
-
RIBBON_SCROLL_BTN_STATE_MASK = Wx::RBN::RibbonScrollButtonStyle.new(12)
|
504
|
-
|
505
|
-
# Button is not for scrolling tabs nor pages.
|
506
|
-
#
|
507
|
-
RIBBON_SCROLL_BTN_FOR_OTHER = Wx::RBN::RibbonScrollButtonStyle.new(0)
|
508
|
-
|
509
|
-
# Button is for scrolling tabs.
|
510
|
-
#
|
511
|
-
RIBBON_SCROLL_BTN_FOR_TABS = Wx::RBN::RibbonScrollButtonStyle.new(16)
|
512
|
-
|
513
|
-
# Button is for scrolling pages.
|
514
|
-
#
|
515
|
-
RIBBON_SCROLL_BTN_FOR_PAGE = Wx::RBN::RibbonScrollButtonStyle.new(32)
|
516
|
-
|
517
|
-
# A mask to extract purpose from a combination of flags.
|
518
|
-
#
|
519
|
-
RIBBON_SCROLL_BTN_FOR_MASK = Wx::RBN::RibbonScrollButtonStyle.new(48)
|
520
|
-
|
521
|
-
end # RibbonScrollButtonStyle
|
522
|
-
|
523
|
-
# Buttons on a ribbon button bar and tools on a ribbon tool bar can each be one of three different kinds.
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
# @wxrb_require USE_RIBBON
|
528
|
-
class RibbonButtonKind < Wx::Enum
|
529
|
-
|
530
|
-
# Normal button or tool with a clickable area which causes some generic action.
|
531
|
-
#
|
532
|
-
RIBBON_BUTTON_NORMAL = Wx::RBN::RibbonButtonKind.new(1)
|
533
|
-
|
534
|
-
# Dropdown button or tool with a clickable area which typically causes a dropdown menu.
|
535
|
-
#
|
536
|
-
RIBBON_BUTTON_DROPDOWN = Wx::RBN::RibbonButtonKind.new(2)
|
537
|
-
|
538
|
-
# Button or tool with two clickable areas - one which causes a dropdown menu, and one which causes a generic action.
|
539
|
-
#
|
540
|
-
RIBBON_BUTTON_HYBRID = Wx::RBN::RibbonButtonKind.new(3)
|
541
|
-
|
542
|
-
# Normal button or tool with a clickable area which toggles the button between a pressed and unpressed state.
|
543
|
-
#
|
544
|
-
RIBBON_BUTTON_TOGGLE = Wx::RBN::RibbonButtonKind.new(4)
|
545
|
-
|
546
|
-
end # RibbonButtonKind
|
547
|
-
|
548
|
-
#
|
549
|
-
#
|
550
|
-
#
|
551
|
-
#
|
552
|
-
# @wxrb_require USE_RIBBON
|
553
|
-
class RibbonBarOption < Wx::Enum
|
554
|
-
|
555
|
-
#
|
556
|
-
#
|
557
|
-
RIBBON_BAR_SHOW_PAGE_LABELS = Wx::RBN::RibbonBarOption.new(1)
|
558
|
-
|
559
|
-
#
|
560
|
-
#
|
561
|
-
RIBBON_BAR_SHOW_PAGE_ICONS = Wx::RBN::RibbonBarOption.new(2)
|
562
|
-
|
563
|
-
#
|
564
|
-
#
|
565
|
-
RIBBON_BAR_FLOW_HORIZONTAL = Wx::RBN::RibbonBarOption.new(0)
|
566
|
-
|
567
|
-
#
|
568
|
-
#
|
569
|
-
RIBBON_BAR_FLOW_VERTICAL = Wx::RBN::RibbonBarOption.new(4)
|
570
|
-
|
571
|
-
#
|
572
|
-
#
|
573
|
-
RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS = Wx::RBN::RibbonBarOption.new(8)
|
574
|
-
|
575
|
-
#
|
576
|
-
#
|
577
|
-
RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS = Wx::RBN::RibbonBarOption.new(16)
|
578
|
-
|
579
|
-
#
|
580
|
-
#
|
581
|
-
RIBBON_BAR_ALWAYS_SHOW_TABS = Wx::RBN::RibbonBarOption.new(32)
|
582
|
-
|
583
|
-
#
|
584
|
-
#
|
585
|
-
RIBBON_BAR_SHOW_TOGGLE_BUTTON = Wx::RBN::RibbonBarOption.new(64)
|
586
|
-
|
587
|
-
#
|
588
|
-
#
|
589
|
-
RIBBON_BAR_SHOW_HELP_BUTTON = Wx::RBN::RibbonBarOption.new(128)
|
590
|
-
|
591
|
-
#
|
592
|
-
#
|
593
|
-
RIBBON_BAR_DEFAULT_STYLE = Wx::RBN::RibbonBarOption.new(201)
|
594
|
-
|
595
|
-
#
|
596
|
-
#
|
597
|
-
RIBBON_BAR_FOLDBAR_STYLE = Wx::RBN::RibbonBarOption.new(30)
|
598
|
-
|
599
|
-
end # RibbonBarOption
|
600
|
-
|
601
|
-
# The possible display modes of the panel area of a {Wx::RBN::RibbonBar} widget.
|
602
|
-
#
|
603
|
-
#
|
604
|
-
# @see Wx::RBN::RibbonBar#show_panels
|
605
|
-
#
|
606
|
-
# @see Wx::RBN::RibbonBar#get_display_mode
|
607
|
-
#
|
608
|
-
#
|
609
|
-
# @wxrb_require USE_RIBBON
|
610
|
-
class RibbonDisplayMode < Wx::Enum
|
611
|
-
|
612
|
-
# The panel area is visible and pinned: it remains visible when the ribbon bar loses the focus.
|
613
|
-
#
|
614
|
-
RIBBON_BAR_PINNED = Wx::RBN::RibbonDisplayMode.new(0)
|
615
|
-
|
616
|
-
# The panel area is hidden: only the pages tabs remain visible.
|
617
|
-
#
|
618
|
-
RIBBON_BAR_MINIMIZED = Wx::RBN::RibbonDisplayMode.new(1)
|
619
|
-
|
620
|
-
# The panel area is visible, but not pinned: it minimizes as soon as the focus is lost.
|
621
|
-
#
|
622
|
-
RIBBON_BAR_EXPANDED = Wx::RBN::RibbonDisplayMode.new(2)
|
623
|
-
|
624
|
-
end # RibbonDisplayMode
|
625
|
-
|
626
|
-
#
|
627
|
-
#
|
628
|
-
EVT_RIBBONBAR_PAGE_CHANGED = 10442
|
629
|
-
|
630
|
-
#
|
631
|
-
#
|
632
|
-
EVT_RIBBONBAR_PAGE_CHANGING = 10443
|
633
|
-
|
634
|
-
#
|
635
|
-
#
|
636
|
-
EVT_RIBBONBAR_TAB_MIDDLE_DOWN = 10444
|
637
|
-
|
638
|
-
#
|
639
|
-
#
|
640
|
-
EVT_RIBBONBAR_TAB_MIDDLE_UP = 10445
|
641
|
-
|
642
|
-
#
|
643
|
-
#
|
644
|
-
EVT_RIBBONBAR_TAB_RIGHT_DOWN = 10446
|
645
|
-
|
646
|
-
#
|
647
|
-
#
|
648
|
-
EVT_RIBBONBAR_TAB_RIGHT_UP = 10447
|
649
|
-
|
650
|
-
#
|
651
|
-
#
|
652
|
-
EVT_RIBBONBAR_TAB_LEFT_DCLICK = 10448
|
653
|
-
|
654
|
-
#
|
655
|
-
#
|
656
|
-
EVT_RIBBONBAR_TOGGLED = 10449
|
657
|
-
|
658
|
-
#
|
659
|
-
#
|
660
|
-
EVT_RIBBONBAR_HELP_CLICK = 10450
|
661
|
-
|
662
|
-
# {Wx::RBN::RibbonArtProvider} is responsible for drawing all the components of the ribbon interface.
|
663
|
-
#
|
664
|
-
# This allows a ribbon bar to have a pluggable look-and-feel, while retaining the same underlying behaviour. As a single art provider is used for all ribbon components, a ribbon bar usually has a consistent (though unique) appearance.
|
665
|
-
# By default, a {Wx::RBN::RibbonBar} uses an instance of this class called {Wx::RBN::RibbonDefaultArtProvider}, which resolves to {Wx::RBN::RibbonAUIArtProvider}, {Wx::RBN::RibbonMSWArtProvider}, or {Wx::RibbonOSXArtProvider} - whichever is most appropriate to the current platform. These art providers are all slightly configurable with regard to colours and fonts, but for larger modifications, you can derive from one of these classes, or write a completely new art provider class. Call {Wx::RBN::RibbonBar#set_art_provider} to change the art provider being used.
|
666
|
-
#
|
667
|
-
# Category: Ribbon User Interface
|
668
|
-
# @see Wx::RBN::RibbonBar
|
669
|
-
#
|
670
|
-
#
|
671
|
-
# @wxrb_require USE_RIBBON
|
672
|
-
class RibbonArtProvider < ::Object
|
673
|
-
|
674
|
-
# Constructor.
|
675
|
-
# @return [Wx::RBN::RibbonArtProvider]
|
676
|
-
def initialize; end
|
677
|
-
|
678
|
-
# Create a new art provider which is a clone of this one.
|
679
|
-
# @return [Wx::RBN::RibbonArtProvider]
|
680
|
-
def clone; end
|
681
|
-
|
682
|
-
# Set the style flags.
|
683
|
-
#
|
684
|
-
# Normally called automatically by {Wx::RBN::RibbonBar#set_art_provider} with the ribbon bar's style flags, so that the art provider has the same flags as the bar which it is serving.
|
685
|
-
# @param flags [Integer]
|
686
|
-
# @return [void]
|
687
|
-
def set_flags(flags) end
|
688
|
-
alias_method :flags=, :set_flags
|
689
|
-
|
690
|
-
# Get the previously set style flags.
|
691
|
-
# @return [Integer]
|
692
|
-
def get_flags; end
|
693
|
-
alias_method :flags, :get_flags
|
694
|
-
|
695
|
-
# Get the value of a certain integer setting.
|
696
|
-
#
|
697
|
-
# id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
|
698
|
-
# @param id [Integer]
|
699
|
-
# @return [Integer]
|
700
|
-
def get_metric(id) end
|
701
|
-
alias_method :metric, :get_metric
|
702
|
-
|
703
|
-
# Set the value of a certain integer setting to the value new_val.
|
704
|
-
#
|
705
|
-
# id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
|
706
|
-
# @param id [Integer]
|
707
|
-
# @param new_val [Integer]
|
708
|
-
# @return [void]
|
709
|
-
def set_metric(id, new_val) end
|
710
|
-
|
711
|
-
# Set the value of a certain font setting to the value font.
|
712
|
-
#
|
713
|
-
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
714
|
-
# @param id [Integer]
|
715
|
-
# @param font [Wx::Font,Wx::FontInfo]
|
716
|
-
# @return [void]
|
717
|
-
def set_font(id, font) end
|
718
|
-
|
719
|
-
# Get the value of a certain font setting.
|
720
|
-
#
|
721
|
-
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
722
|
-
# @param id [Integer]
|
723
|
-
# @return [Wx::Font]
|
724
|
-
def get_font(id) end
|
725
|
-
alias_method :font, :get_font
|
726
|
-
|
727
|
-
# Get the value of a certain colour setting.
|
728
|
-
#
|
729
|
-
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
|
730
|
-
# @param id [Integer]
|
731
|
-
# @return [Wx::Colour]
|
732
|
-
def get_colour(id) end
|
733
|
-
alias_method :colour, :get_colour
|
734
|
-
|
735
|
-
# Set the value of a certain colour setting to the value colour.
|
736
|
-
#
|
737
|
-
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
|
738
|
-
# @see Wx::RBN::RibbonArtProvider#set_colour_scheme
|
739
|
-
# @param id [Integer]
|
740
|
-
# @param colour [Wx::Colour,String,Symbol]
|
741
|
-
# @return [void]
|
742
|
-
def set_colour(id, colour) end
|
743
|
-
|
744
|
-
#
|
9
|
+
module Wx::RBN
|
10
|
+
|
11
|
+
# Identifiers for common settings on ribbon art providers which can be used to tweak the appearance of the art provider.
|
745
12
|
#
|
746
13
|
#
|
747
14
|
# @see Wx::RBN::RibbonArtProvider#get_colour
|
748
|
-
# @param id [Integer]
|
749
|
-
# @return [Wx::Colour]
|
750
|
-
def get_color(id) end
|
751
|
-
alias_method :color, :get_color
|
752
|
-
|
753
|
-
#
|
754
|
-
#
|
755
15
|
#
|
756
|
-
# @see Wx::RBN::RibbonArtProvider#
|
757
|
-
# @param id [Integer]
|
758
|
-
# @param color [Wx::Colour,String,Symbol]
|
759
|
-
# @return [void]
|
760
|
-
def set_color(id, color) end
|
761
|
-
|
762
|
-
# Get the current colour scheme.
|
16
|
+
# @see Wx::RBN::RibbonArtProvider#get_font
|
763
17
|
#
|
764
|
-
#
|
765
|
-
# @param primary [Wx::Colour] Pointer to a location to store the primary colour, or NULL.
|
766
|
-
# @param secondary [Wx::Colour] Pointer to a location to store the secondary colour, or NULL.
|
767
|
-
# @param tertiary [Wx::Colour] Pointer to a location to store the tertiary colour, or NULL.
|
768
|
-
# @return [void]
|
769
|
-
def get_colour_scheme(primary, secondary, tertiary) end
|
770
|
-
alias_method :colour_scheme, :get_colour_scheme
|
771
|
-
|
772
|
-
# Set all applicable colour settings from a few base colours.
|
18
|
+
# @see Wx::RBN::RibbonArtProvider#get_metric
|
773
19
|
#
|
774
|
-
# Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
|
775
20
|
# @see Wx::RBN::RibbonArtProvider#set_colour
|
776
21
|
#
|
777
|
-
# @see Wx::RBN::RibbonArtProvider#
|
778
|
-
#
|
779
|
-
# @
|
780
|
-
#
|
781
|
-
#
|
782
|
-
|
783
|
-
|
784
|
-
|
785
|
-
|
786
|
-
|
787
|
-
|
788
|
-
|
789
|
-
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
|
800
|
-
|
801
|
-
|
802
|
-
|
803
|
-
|
804
|
-
|
805
|
-
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
818
|
-
|
819
|
-
|
820
|
-
|
821
|
-
|
822
|
-
|
823
|
-
|
824
|
-
|
825
|
-
|
826
|
-
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
|
834
|
-
|
835
|
-
|
836
|
-
|
837
|
-
|
838
|
-
|
839
|
-
|
840
|
-
|
841
|
-
|
842
|
-
|
843
|
-
|
844
|
-
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
853
|
-
|
854
|
-
|
855
|
-
|
856
|
-
|
857
|
-
|
858
|
-
|
859
|
-
|
860
|
-
|
861
|
-
|
862
|
-
|
863
|
-
|
864
|
-
|
865
|
-
|
866
|
-
|
867
|
-
|
868
|
-
|
869
|
-
|
870
|
-
|
871
|
-
|
872
|
-
|
873
|
-
|
874
|
-
|
875
|
-
|
876
|
-
|
877
|
-
|
878
|
-
|
879
|
-
|
880
|
-
|
881
|
-
|
882
|
-
|
883
|
-
|
884
|
-
|
885
|
-
|
886
|
-
|
887
|
-
|
888
|
-
|
889
|
-
|
890
|
-
|
891
|
-
|
892
|
-
|
893
|
-
|
894
|
-
|
895
|
-
|
896
|
-
|
897
|
-
|
898
|
-
|
899
|
-
|
900
|
-
|
901
|
-
|
902
|
-
|
903
|
-
|
904
|
-
|
905
|
-
|
906
|
-
|
907
|
-
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
|
22
|
+
# @see Wx::RBN::RibbonArtProvider#set_font
|
23
|
+
#
|
24
|
+
# @see Wx::RBN::RibbonArtProvider#set_metric
|
25
|
+
#
|
26
|
+
#
|
27
|
+
# @wxrb_require USE_RIBBON
|
28
|
+
class RibbonArtSetting < Wx::Enum
|
29
|
+
|
30
|
+
#
|
31
|
+
#
|
32
|
+
RIBBON_ART_TAB_SEPARATION_SIZE = Wx::RBN::RibbonArtSetting.new(0)
|
33
|
+
|
34
|
+
#
|
35
|
+
#
|
36
|
+
RIBBON_ART_PAGE_BORDER_LEFT_SIZE = Wx::RBN::RibbonArtSetting.new(1)
|
37
|
+
|
38
|
+
#
|
39
|
+
#
|
40
|
+
RIBBON_ART_PAGE_BORDER_TOP_SIZE = Wx::RBN::RibbonArtSetting.new(2)
|
41
|
+
|
42
|
+
#
|
43
|
+
#
|
44
|
+
RIBBON_ART_PAGE_BORDER_RIGHT_SIZE = Wx::RBN::RibbonArtSetting.new(3)
|
45
|
+
|
46
|
+
#
|
47
|
+
#
|
48
|
+
RIBBON_ART_PAGE_BORDER_BOTTOM_SIZE = Wx::RBN::RibbonArtSetting.new(4)
|
49
|
+
|
50
|
+
#
|
51
|
+
#
|
52
|
+
RIBBON_ART_PANEL_X_SEPARATION_SIZE = Wx::RBN::RibbonArtSetting.new(5)
|
53
|
+
|
54
|
+
#
|
55
|
+
#
|
56
|
+
RIBBON_ART_PANEL_Y_SEPARATION_SIZE = Wx::RBN::RibbonArtSetting.new(6)
|
57
|
+
|
58
|
+
#
|
59
|
+
#
|
60
|
+
RIBBON_ART_TOOL_GROUP_SEPARATION_SIZE = Wx::RBN::RibbonArtSetting.new(7)
|
61
|
+
|
62
|
+
#
|
63
|
+
#
|
64
|
+
RIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE = Wx::RBN::RibbonArtSetting.new(8)
|
65
|
+
|
66
|
+
#
|
67
|
+
#
|
68
|
+
RIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE = Wx::RBN::RibbonArtSetting.new(9)
|
69
|
+
|
70
|
+
#
|
71
|
+
#
|
72
|
+
RIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE = Wx::RBN::RibbonArtSetting.new(10)
|
73
|
+
|
74
|
+
#
|
75
|
+
#
|
76
|
+
RIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE = Wx::RBN::RibbonArtSetting.new(11)
|
77
|
+
|
78
|
+
#
|
79
|
+
#
|
80
|
+
RIBBON_ART_PANEL_LABEL_FONT = Wx::RBN::RibbonArtSetting.new(12)
|
81
|
+
|
82
|
+
#
|
83
|
+
#
|
84
|
+
RIBBON_ART_BUTTON_BAR_LABEL_FONT = Wx::RBN::RibbonArtSetting.new(13)
|
85
|
+
|
86
|
+
#
|
87
|
+
#
|
88
|
+
RIBBON_ART_TAB_LABEL_FONT = Wx::RBN::RibbonArtSetting.new(14)
|
89
|
+
|
90
|
+
#
|
91
|
+
#
|
92
|
+
RIBBON_ART_BUTTON_BAR_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(15)
|
93
|
+
|
94
|
+
#
|
95
|
+
#
|
96
|
+
RIBBON_ART_BUTTON_BAR_LABEL_DISABLED_COLOUR = Wx::RBN::RibbonArtSetting.new(106)
|
97
|
+
|
98
|
+
#
|
99
|
+
#
|
100
|
+
RIBBON_ART_BUTTON_BAR_HOVER_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(16)
|
101
|
+
|
102
|
+
#
|
103
|
+
#
|
104
|
+
RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(17)
|
105
|
+
|
106
|
+
#
|
107
|
+
#
|
108
|
+
RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(18)
|
109
|
+
|
110
|
+
#
|
111
|
+
#
|
112
|
+
RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(19)
|
113
|
+
|
114
|
+
#
|
115
|
+
#
|
116
|
+
RIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(20)
|
117
|
+
|
118
|
+
#
|
119
|
+
#
|
120
|
+
RIBBON_ART_BUTTON_BAR_ACTIVE_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(21)
|
121
|
+
|
122
|
+
#
|
123
|
+
#
|
124
|
+
RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(22)
|
125
|
+
|
126
|
+
#
|
127
|
+
#
|
128
|
+
RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(23)
|
129
|
+
|
130
|
+
#
|
131
|
+
#
|
132
|
+
RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(24)
|
133
|
+
|
134
|
+
#
|
135
|
+
#
|
136
|
+
RIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(25)
|
137
|
+
|
138
|
+
#
|
139
|
+
#
|
140
|
+
RIBBON_ART_GALLERY_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(26)
|
141
|
+
|
142
|
+
#
|
143
|
+
#
|
144
|
+
RIBBON_ART_GALLERY_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(27)
|
145
|
+
|
146
|
+
#
|
147
|
+
#
|
148
|
+
RIBBON_ART_GALLERY_BUTTON_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(28)
|
149
|
+
|
150
|
+
#
|
151
|
+
#
|
152
|
+
RIBBON_ART_GALLERY_BUTTON_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(29)
|
153
|
+
|
154
|
+
#
|
155
|
+
#
|
156
|
+
RIBBON_ART_GALLERY_BUTTON_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(30)
|
157
|
+
|
158
|
+
#
|
159
|
+
#
|
160
|
+
RIBBON_ART_GALLERY_BUTTON_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(31)
|
161
|
+
|
162
|
+
#
|
163
|
+
#
|
164
|
+
RIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(32)
|
165
|
+
|
166
|
+
#
|
167
|
+
#
|
168
|
+
RIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(33)
|
169
|
+
|
170
|
+
#
|
171
|
+
#
|
172
|
+
RIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(34)
|
173
|
+
|
174
|
+
#
|
175
|
+
#
|
176
|
+
RIBBON_ART_GALLERY_BUTTON_HOVER_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(35)
|
177
|
+
|
178
|
+
#
|
179
|
+
#
|
180
|
+
RIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(36)
|
181
|
+
|
182
|
+
#
|
183
|
+
#
|
184
|
+
RIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(37)
|
185
|
+
|
186
|
+
#
|
187
|
+
#
|
188
|
+
RIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(38)
|
189
|
+
|
190
|
+
#
|
191
|
+
#
|
192
|
+
RIBBON_ART_GALLERY_BUTTON_ACTIVE_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(39)
|
193
|
+
|
194
|
+
#
|
195
|
+
#
|
196
|
+
RIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(40)
|
197
|
+
|
198
|
+
#
|
199
|
+
#
|
200
|
+
RIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(41)
|
201
|
+
|
202
|
+
#
|
203
|
+
#
|
204
|
+
RIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(42)
|
205
|
+
|
206
|
+
#
|
207
|
+
#
|
208
|
+
RIBBON_ART_GALLERY_BUTTON_DISABLED_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(43)
|
209
|
+
|
210
|
+
#
|
211
|
+
#
|
212
|
+
RIBBON_ART_GALLERY_ITEM_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(44)
|
213
|
+
|
214
|
+
#
|
215
|
+
#
|
216
|
+
RIBBON_ART_TAB_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(45)
|
217
|
+
|
218
|
+
#
|
219
|
+
#
|
220
|
+
RIBBON_ART_TAB_ACTIVE_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(46)
|
221
|
+
|
222
|
+
#
|
223
|
+
#
|
224
|
+
RIBBON_ART_TAB_HOVER_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(47)
|
225
|
+
|
226
|
+
#
|
227
|
+
#
|
228
|
+
RIBBON_ART_TAB_SEPARATOR_COLOUR = Wx::RBN::RibbonArtSetting.new(48)
|
229
|
+
|
230
|
+
#
|
231
|
+
#
|
232
|
+
RIBBON_ART_TAB_SEPARATOR_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(49)
|
233
|
+
|
234
|
+
#
|
235
|
+
#
|
236
|
+
RIBBON_ART_TAB_CTRL_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(50)
|
237
|
+
|
238
|
+
#
|
239
|
+
#
|
240
|
+
RIBBON_ART_TAB_CTRL_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(51)
|
241
|
+
|
242
|
+
#
|
243
|
+
#
|
244
|
+
RIBBON_ART_TAB_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(52)
|
245
|
+
|
246
|
+
#
|
247
|
+
#
|
248
|
+
RIBBON_ART_TAB_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(53)
|
249
|
+
|
250
|
+
#
|
251
|
+
#
|
252
|
+
RIBBON_ART_TAB_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(54)
|
253
|
+
|
254
|
+
#
|
255
|
+
#
|
256
|
+
RIBBON_ART_TAB_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(55)
|
257
|
+
|
258
|
+
#
|
259
|
+
#
|
260
|
+
RIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(56)
|
261
|
+
|
262
|
+
#
|
263
|
+
#
|
264
|
+
RIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(57)
|
265
|
+
|
266
|
+
#
|
267
|
+
#
|
268
|
+
RIBBON_ART_TAB_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(58)
|
269
|
+
|
270
|
+
#
|
271
|
+
#
|
272
|
+
RIBBON_ART_TAB_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(59)
|
273
|
+
|
274
|
+
#
|
275
|
+
#
|
276
|
+
RIBBON_ART_TAB_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(60)
|
277
|
+
|
278
|
+
#
|
279
|
+
#
|
280
|
+
RIBBON_ART_PANEL_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(61)
|
281
|
+
|
282
|
+
#
|
283
|
+
#
|
284
|
+
RIBBON_ART_PANEL_BORDER_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(62)
|
285
|
+
|
286
|
+
#
|
287
|
+
#
|
288
|
+
RIBBON_ART_PANEL_HOVER_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(63)
|
289
|
+
|
290
|
+
#
|
291
|
+
#
|
292
|
+
RIBBON_ART_PANEL_HOVER_BORDER_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(64)
|
293
|
+
|
294
|
+
#
|
295
|
+
#
|
296
|
+
RIBBON_ART_PANEL_MINIMISED_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(65)
|
297
|
+
|
298
|
+
#
|
299
|
+
#
|
300
|
+
RIBBON_ART_PANEL_MINIMISED_BORDER_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(66)
|
301
|
+
|
302
|
+
#
|
303
|
+
#
|
304
|
+
RIBBON_ART_PANEL_LABEL_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(67)
|
305
|
+
|
306
|
+
#
|
307
|
+
#
|
308
|
+
RIBBON_ART_PANEL_LABEL_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(68)
|
309
|
+
|
310
|
+
#
|
311
|
+
#
|
312
|
+
RIBBON_ART_PANEL_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(69)
|
313
|
+
|
314
|
+
#
|
315
|
+
#
|
316
|
+
RIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(70)
|
317
|
+
|
318
|
+
#
|
319
|
+
#
|
320
|
+
RIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(71)
|
321
|
+
|
322
|
+
#
|
323
|
+
#
|
324
|
+
RIBBON_ART_PANEL_HOVER_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(72)
|
325
|
+
|
326
|
+
#
|
327
|
+
#
|
328
|
+
RIBBON_ART_PANEL_MINIMISED_LABEL_COLOUR = Wx::RBN::RibbonArtSetting.new(73)
|
329
|
+
|
330
|
+
#
|
331
|
+
#
|
332
|
+
RIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(74)
|
333
|
+
|
334
|
+
#
|
335
|
+
#
|
336
|
+
RIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(75)
|
337
|
+
|
338
|
+
#
|
339
|
+
#
|
340
|
+
RIBBON_ART_PANEL_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(76)
|
341
|
+
|
342
|
+
#
|
343
|
+
#
|
344
|
+
RIBBON_ART_PANEL_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(77)
|
345
|
+
|
346
|
+
#
|
347
|
+
#
|
348
|
+
RIBBON_ART_PAGE_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(82)
|
349
|
+
|
350
|
+
#
|
351
|
+
#
|
352
|
+
RIBBON_ART_PAGE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(83)
|
353
|
+
|
354
|
+
#
|
355
|
+
#
|
356
|
+
RIBBON_ART_PAGE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(84)
|
357
|
+
|
358
|
+
#
|
359
|
+
#
|
360
|
+
RIBBON_ART_PAGE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(85)
|
361
|
+
|
362
|
+
#
|
363
|
+
#
|
364
|
+
RIBBON_ART_PAGE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(86)
|
365
|
+
|
366
|
+
#
|
367
|
+
#
|
368
|
+
RIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(87)
|
369
|
+
|
370
|
+
#
|
371
|
+
#
|
372
|
+
RIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(88)
|
373
|
+
|
374
|
+
#
|
375
|
+
#
|
376
|
+
RIBBON_ART_PAGE_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(89)
|
377
|
+
|
378
|
+
#
|
379
|
+
#
|
380
|
+
RIBBON_ART_PAGE_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(90)
|
381
|
+
|
382
|
+
#
|
383
|
+
#
|
384
|
+
RIBBON_ART_TOOLBAR_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(91)
|
385
|
+
|
386
|
+
#
|
387
|
+
#
|
388
|
+
RIBBON_ART_TOOLBAR_HOVER_BORDER_COLOUR = Wx::RBN::RibbonArtSetting.new(92)
|
389
|
+
|
390
|
+
#
|
391
|
+
#
|
392
|
+
RIBBON_ART_TOOLBAR_FACE_COLOUR = Wx::RBN::RibbonArtSetting.new(93)
|
393
|
+
|
394
|
+
#
|
395
|
+
#
|
396
|
+
RIBBON_ART_TOOL_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(94)
|
397
|
+
|
398
|
+
#
|
399
|
+
#
|
400
|
+
RIBBON_ART_TOOL_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(95)
|
401
|
+
|
402
|
+
#
|
403
|
+
#
|
404
|
+
RIBBON_ART_TOOL_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(96)
|
405
|
+
|
406
|
+
#
|
407
|
+
#
|
408
|
+
RIBBON_ART_TOOL_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(97)
|
409
|
+
|
410
|
+
#
|
411
|
+
#
|
412
|
+
RIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(98)
|
413
|
+
|
414
|
+
#
|
415
|
+
#
|
416
|
+
RIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(99)
|
417
|
+
|
418
|
+
#
|
419
|
+
#
|
420
|
+
RIBBON_ART_TOOL_HOVER_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(100)
|
421
|
+
|
422
|
+
#
|
423
|
+
#
|
424
|
+
RIBBON_ART_TOOL_HOVER_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(101)
|
425
|
+
|
426
|
+
#
|
427
|
+
#
|
428
|
+
RIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(102)
|
429
|
+
|
430
|
+
#
|
431
|
+
#
|
432
|
+
RIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(103)
|
433
|
+
|
434
|
+
#
|
435
|
+
#
|
436
|
+
RIBBON_ART_TOOL_ACTIVE_BACKGROUND_COLOUR = Wx::RBN::RibbonArtSetting.new(104)
|
437
|
+
|
438
|
+
#
|
439
|
+
#
|
440
|
+
RIBBON_ART_TOOL_ACTIVE_BACKGROUND_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(105)
|
441
|
+
|
442
|
+
#
|
443
|
+
#
|
444
|
+
RIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_COLOUR = Wx::RBN::RibbonArtSetting.new(107)
|
445
|
+
|
446
|
+
#
|
447
|
+
#
|
448
|
+
RIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_GRADIENT_COLOUR = Wx::RBN::RibbonArtSetting.new(108)
|
449
|
+
|
450
|
+
#
|
451
|
+
#
|
452
|
+
RIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(109)
|
453
|
+
|
454
|
+
#
|
455
|
+
#
|
456
|
+
RIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_GRADIENT_TOP_COLOUR = Wx::RBN::RibbonArtSetting.new(110)
|
457
|
+
|
458
|
+
end # RibbonArtSetting
|
459
|
+
|
460
|
+
# Flags used to describe the direction, state, and/or purpose of a ribbon-style scroll button.
|
461
|
+
#
|
462
|
+
#
|
463
|
+
# @see Wx::RBN::RibbonArtProvider#draw_scroll_button
|
464
|
+
#
|
465
|
+
# @see Wx::RBN::RibbonArtProvider#get_scroll_button_minimum_size
|
466
|
+
#
|
467
|
+
#
|
468
|
+
# @wxrb_require USE_RIBBON
|
469
|
+
class RibbonScrollButtonStyle < Wx::Enum
|
470
|
+
|
471
|
+
# Button will scroll to the left.
|
472
|
+
#
|
473
|
+
RIBBON_SCROLL_BTN_LEFT = Wx::RBN::RibbonScrollButtonStyle.new(0)
|
474
|
+
|
475
|
+
# Button will scroll to the right.
|
476
|
+
#
|
477
|
+
RIBBON_SCROLL_BTN_RIGHT = Wx::RBN::RibbonScrollButtonStyle.new(1)
|
478
|
+
|
479
|
+
# Button will scroll upward.
|
480
|
+
#
|
481
|
+
RIBBON_SCROLL_BTN_UP = Wx::RBN::RibbonScrollButtonStyle.new(2)
|
482
|
+
|
483
|
+
# Button will scroll downward.
|
484
|
+
#
|
485
|
+
RIBBON_SCROLL_BTN_DOWN = Wx::RBN::RibbonScrollButtonStyle.new(3)
|
486
|
+
|
487
|
+
# A mask to extract direction from a combination of flags.
|
488
|
+
#
|
489
|
+
RIBBON_SCROLL_BTN_DIRECTION_MASK = Wx::RBN::RibbonScrollButtonStyle.new(3)
|
490
|
+
|
491
|
+
# Button is not active or hovered.
|
492
|
+
#
|
493
|
+
RIBBON_SCROLL_BTN_NORMAL = Wx::RBN::RibbonScrollButtonStyle.new(0)
|
494
|
+
|
495
|
+
# Button has a cursor hovering over it.
|
496
|
+
#
|
497
|
+
RIBBON_SCROLL_BTN_HOVERED = Wx::RBN::RibbonScrollButtonStyle.new(4)
|
498
|
+
|
499
|
+
# Button is being pressed.
|
500
|
+
#
|
501
|
+
RIBBON_SCROLL_BTN_ACTIVE = Wx::RBN::RibbonScrollButtonStyle.new(8)
|
502
|
+
|
503
|
+
# A mask to extract state from a combination of flags.
|
504
|
+
#
|
505
|
+
RIBBON_SCROLL_BTN_STATE_MASK = Wx::RBN::RibbonScrollButtonStyle.new(12)
|
506
|
+
|
507
|
+
# Button is not for scrolling tabs nor pages.
|
508
|
+
#
|
509
|
+
RIBBON_SCROLL_BTN_FOR_OTHER = Wx::RBN::RibbonScrollButtonStyle.new(0)
|
510
|
+
|
511
|
+
# Button is for scrolling tabs.
|
512
|
+
#
|
513
|
+
RIBBON_SCROLL_BTN_FOR_TABS = Wx::RBN::RibbonScrollButtonStyle.new(16)
|
514
|
+
|
515
|
+
# Button is for scrolling pages.
|
516
|
+
#
|
517
|
+
RIBBON_SCROLL_BTN_FOR_PAGE = Wx::RBN::RibbonScrollButtonStyle.new(32)
|
518
|
+
|
519
|
+
# A mask to extract purpose from a combination of flags.
|
520
|
+
#
|
521
|
+
RIBBON_SCROLL_BTN_FOR_MASK = Wx::RBN::RibbonScrollButtonStyle.new(48)
|
522
|
+
|
523
|
+
end # RibbonScrollButtonStyle
|
524
|
+
|
525
|
+
# Buttons on a ribbon button bar and tools on a ribbon tool bar can each be one of three different kinds.
|
526
|
+
#
|
527
|
+
#
|
528
|
+
#
|
529
|
+
# @wxrb_require USE_RIBBON
|
530
|
+
class RibbonButtonKind < Wx::Enum
|
531
|
+
|
532
|
+
# Normal button or tool with a clickable area which causes some generic action.
|
533
|
+
#
|
534
|
+
RIBBON_BUTTON_NORMAL = Wx::RBN::RibbonButtonKind.new(1)
|
535
|
+
|
536
|
+
# Dropdown button or tool with a clickable area which typically causes a dropdown menu.
|
537
|
+
#
|
538
|
+
RIBBON_BUTTON_DROPDOWN = Wx::RBN::RibbonButtonKind.new(2)
|
539
|
+
|
540
|
+
# Button or tool with two clickable areas - one which causes a dropdown menu, and one which causes a generic action.
|
541
|
+
#
|
542
|
+
RIBBON_BUTTON_HYBRID = Wx::RBN::RibbonButtonKind.new(3)
|
543
|
+
|
544
|
+
# Normal button or tool with a clickable area which toggles the button between a pressed and unpressed state.
|
545
|
+
#
|
546
|
+
RIBBON_BUTTON_TOGGLE = Wx::RBN::RibbonButtonKind.new(4)
|
547
|
+
|
548
|
+
end # RibbonButtonKind
|
549
|
+
|
550
|
+
#
|
551
|
+
#
|
552
|
+
#
|
553
|
+
#
|
554
|
+
# @wxrb_require USE_RIBBON
|
555
|
+
class RibbonBarOption < Wx::Enum
|
556
|
+
|
557
|
+
#
|
558
|
+
#
|
559
|
+
RIBBON_BAR_SHOW_PAGE_LABELS = Wx::RBN::RibbonBarOption.new(1)
|
560
|
+
|
561
|
+
#
|
562
|
+
#
|
563
|
+
RIBBON_BAR_SHOW_PAGE_ICONS = Wx::RBN::RibbonBarOption.new(2)
|
564
|
+
|
565
|
+
#
|
566
|
+
#
|
567
|
+
RIBBON_BAR_FLOW_HORIZONTAL = Wx::RBN::RibbonBarOption.new(0)
|
568
|
+
|
569
|
+
#
|
570
|
+
#
|
571
|
+
RIBBON_BAR_FLOW_VERTICAL = Wx::RBN::RibbonBarOption.new(4)
|
572
|
+
|
573
|
+
#
|
574
|
+
#
|
575
|
+
RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS = Wx::RBN::RibbonBarOption.new(8)
|
576
|
+
|
577
|
+
#
|
578
|
+
#
|
579
|
+
RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS = Wx::RBN::RibbonBarOption.new(16)
|
580
|
+
|
581
|
+
#
|
582
|
+
#
|
583
|
+
RIBBON_BAR_ALWAYS_SHOW_TABS = Wx::RBN::RibbonBarOption.new(32)
|
584
|
+
|
585
|
+
#
|
586
|
+
#
|
587
|
+
RIBBON_BAR_SHOW_TOGGLE_BUTTON = Wx::RBN::RibbonBarOption.new(64)
|
588
|
+
|
589
|
+
#
|
590
|
+
#
|
591
|
+
RIBBON_BAR_SHOW_HELP_BUTTON = Wx::RBN::RibbonBarOption.new(128)
|
592
|
+
|
593
|
+
#
|
594
|
+
#
|
595
|
+
RIBBON_BAR_DEFAULT_STYLE = Wx::RBN::RibbonBarOption.new(201)
|
596
|
+
|
597
|
+
#
|
598
|
+
#
|
599
|
+
RIBBON_BAR_FOLDBAR_STYLE = Wx::RBN::RibbonBarOption.new(30)
|
600
|
+
|
601
|
+
end # RibbonBarOption
|
913
602
|
|
914
|
-
#
|
603
|
+
# The possible display modes of the panel area of a {Wx::RBN::RibbonBar} widget.
|
915
604
|
#
|
916
|
-
# This should draw a help button at top right corner of ribbon bar.
|
917
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
918
|
-
# @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
919
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
920
|
-
# @return [void]
|
921
|
-
def draw_help_button(dc, wnd, rect) end
|
922
|
-
|
923
|
-
# Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
|
924
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
925
|
-
# @param wnd [Wx::Window] The window onto which the tab will eventually be drawn.
|
926
|
-
# @param label [String] The tab's label (or {Wx::EmptyString} if it has none).
|
927
|
-
# @param bitmap [Wx::Bitmap] The tab's icon (or {Wx::NULL_BITMAP} if it has none).
|
928
|
-
# @return [Array(Integer,Integer,Integer,Integer)]
|
929
|
-
def get_bar_tab_width(dc, wnd, label, bitmap) end
|
930
|
-
alias_method :bar_tab_width, :get_bar_tab_width
|
931
|
-
|
932
|
-
# Calculate the height (in pixels) of the tab region of a ribbon bar.
|
933
|
-
#
|
934
|
-
# Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
|
935
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
936
|
-
# @param wnd [Wx::Window] The window onto which the tabs will eventually be drawn.
|
937
|
-
# @param pages [Array<Wx::RBN::RibbonPageTabInfo>] The tabs which will acquire the returned height.
|
938
|
-
# @return [Integer]
|
939
|
-
def get_tab_ctrl_height(dc, wnd, pages) end
|
940
|
-
alias_method :tab_ctrl_height, :get_tab_ctrl_height
|
941
|
-
|
942
|
-
# Calculate the minimum size (in pixels) of a scroll button.
|
943
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
944
|
-
# @param wnd [Wx::Window] The window onto which the scroll button will eventually be drawn.
|
945
|
-
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, and a for flag (state flags may be given too, but should be ignored, as a button should retain a constant size, regardless of its state).
|
946
|
-
# @return [Wx::Size]
|
947
|
-
def get_scroll_button_minimum_size(dc, wnd, style) end
|
948
|
-
alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
|
949
|
-
|
950
|
-
# Calculate the size of a panel for a given client size.
|
951
|
-
#
|
952
|
-
# This should increment the given size by enough to fit the panel label and other chrome.
|
953
|
-
# @see Wx::RBN::RibbonArtProvider#get_panel_client_size
|
954
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
955
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
956
|
-
# @param client_size [Wx::Size] The client size.
|
957
|
-
# @param client_offset [Wx::Point] The offset where the client rectangle begins within the panel (may be NULL).
|
958
|
-
# @return [Wx::Size]
|
959
|
-
def get_panel_size(dc, wnd, client_size, client_offset) end
|
960
|
-
alias_method :panel_size, :get_panel_size
|
961
|
-
|
962
|
-
# Calculate the client size of a panel for a given overall size.
|
963
|
-
#
|
964
|
-
# This should act as the inverse to {Wx::RBN::RibbonArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
|
965
|
-
# @see Wx::RBN::RibbonArtProvider#get_panel_size
|
966
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
967
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
968
|
-
# @param size [Wx::Size] The overall size to calculate client size for.
|
969
|
-
# @param client_offset [Wx::Point] The offset where the returned client size begins within the given size (may be NULL).
|
970
|
-
# @return [Wx::Size]
|
971
|
-
def get_panel_client_size(dc, wnd, size, client_offset) end
|
972
|
-
alias_method :panel_client_size, :get_panel_client_size
|
973
|
-
|
974
|
-
# Calculate the position and size of the panel extension button.
|
975
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
976
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
977
|
-
# @param rect [Wx::Rect] The panel rectangle from which calculate extension button rectangle.
|
978
|
-
# @return [Wx::Rect]
|
979
|
-
def get_panel_ext_button_area(dc, wnd, rect) end
|
980
|
-
alias_method :panel_ext_button_area, :get_panel_ext_button_area
|
981
|
-
|
982
|
-
# Calculate the size of a {Wx::RBN::RibbonGallery} control for a given client size.
|
983
|
-
#
|
984
|
-
# This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.
|
985
|
-
# @see Wx::RBN::RibbonArtProvider#get_gallery_client_size
|
986
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
987
|
-
# @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
|
988
|
-
# @param client_size [Wx::Size] The client size.
|
989
|
-
# @return [Wx::Size]
|
990
|
-
def get_gallery_size(dc, wnd, client_size) end
|
991
|
-
alias_method :gallery_size, :get_gallery_size
|
992
|
-
|
993
|
-
# Calculate the client size of a {Wx::RBN::RibbonGallery} control for a given size.
|
994
|
-
#
|
995
|
-
# This should act as the inverse to {Wx::RBN::RibbonArtProvider#get_gallery_size}, and decrement the given size by enough to fit the gallery border, buttons, and other chrome.
|
996
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
997
|
-
# @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
|
998
|
-
# @param size [Wx::Size] The overall size to calculate the client size for.
|
999
|
-
# @param client_offset [Wx::Point] The position within the given size at which the returned client size begins.
|
1000
|
-
# @param scroll_up_button [Wx::Rect] The rectangle within the given size which the scroll up button occupies.
|
1001
|
-
# @param scroll_down_button [Wx::Rect] The rectangle within the given size which the scroll down button occupies.
|
1002
|
-
# @param extension_button [Wx::Rect] The rectangle within the given size which the extension button occupies.
|
1003
|
-
# @return [Wx::Size]
|
1004
|
-
def get_gallery_client_size(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) end
|
1005
|
-
alias_method :gallery_client_size, :get_gallery_client_size
|
1006
|
-
|
1007
|
-
# Calculate the portion of a page background which needs to be redrawn when a page is resized.
|
1008
|
-
#
|
1009
|
-
# To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.
|
1010
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1011
|
-
# @param wnd [Wx::RBN::RibbonPage] The page which is being resized.
|
1012
|
-
# @param page_old_size [Wx::Size] The size of the page prior to the resize (which has already been painted).
|
1013
|
-
# @param page_new_size [Wx::Size] The size of the page after the resize.
|
1014
|
-
# @return [Wx::Rect]
|
1015
|
-
def get_page_background_redraw_area(dc, wnd, page_old_size, page_new_size) end
|
1016
|
-
alias_method :page_background_redraw_area, :get_page_background_redraw_area
|
1017
|
-
|
1018
|
-
# Calculate the size of a button within a {Wx::RBN::RibbonButtonBar}.
|
1019
|
-
#
|
1020
|
-
# true if a size exists for the button, false otherwise.
|
1021
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1022
|
-
# @param wnd [Wx::Window] The window onto which the button will eventually be drawn (which is normally a {Wx::RBN::RibbonButtonBar}, though this is not guaranteed).
|
1023
|
-
# @param kind [Wx::RibbonButtonKind] The kind of button.
|
1024
|
-
# @param size [Wx::RibbonButtonBarButtonState] The size-class to calculate the size for. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}. If the requested size-class is not applicable, then false should be returned.
|
1025
|
-
# @param label [String] The label of the button.
|
1026
|
-
# @param text_min_width [Integer] The minimum width of the button label. Set this to 0 if it is not used.
|
1027
|
-
# @param bitmap_size_large [Wx::Size] The size of all "large" bitmaps on the button bar.
|
1028
|
-
# @param bitmap_size_small [Wx::Size] The size of all "small" bitmaps on the button bar.
|
1029
|
-
# @param button_size [Wx::Size] The size, in pixels, of the button.
|
1030
|
-
# @param normal_region [Wx::Rect] The region of the button which constitutes the normal button.
|
1031
|
-
# @param dropdown_region [Wx::Rect] The region of the button which constitutes the dropdown button.
|
1032
|
-
# @return [Boolean]
|
1033
|
-
def get_button_bar_button_size(dc, wnd, kind, size, label, text_min_width, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) end
|
1034
|
-
alias_method :button_bar_button_size, :get_button_bar_button_size
|
1035
|
-
|
1036
|
-
# Gets the width of the string if it is used as a {Wx::RBN::RibbonButtonBar} button label.
|
1037
|
-
#
|
1038
|
-
# Width of the given label text in pixel.
|
1039
|
-
#
|
1040
|
-
# <div class="wxrb-note">
|
1041
|
-
# <b>Note:</b>
|
1042
|
-
# <p>This function only works with single-line strings.
|
1043
|
-
# </p>
|
1044
|
-
# </div>
|
1045
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1046
|
-
# @param label [String] The string whose width shall be calculated.
|
1047
|
-
# @param kind [Wx::RibbonButtonKind] The kind of button.
|
1048
|
-
# @param size [Wx::RibbonButtonBarButtonState] The size-class to calculate the size for. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}. If the requested size-class is not applicable, then NULL should be returned.
|
1049
|
-
# @return [Integer]
|
1050
|
-
def get_button_bar_button_text_width(dc, label, kind, size) end
|
1051
|
-
alias_method :button_bar_button_text_width, :get_button_bar_button_text_width
|
1052
|
-
|
1053
|
-
# Calculate the size of a minimised ribbon panel.
|
1054
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1055
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question. Attributes like the panel label can be queried from this.
|
1056
|
-
# @param desired_bitmap_size [Wx::Size] Optional parameter which is filled with the size of the bitmap suitable for a minimised ribbon panel.
|
1057
|
-
# @return [Array(Wx::Size,Wx::Direction)]
|
1058
|
-
def get_minimised_panel_minimum_size(dc, wnd, desired_bitmap_size) end
|
1059
|
-
alias_method :minimised_panel_minimum_size, :get_minimised_panel_minimum_size
|
1060
|
-
|
1061
|
-
# Calculate the size of a tool within a {Wx::RBN::RibbonToolBar}.
|
1062
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1063
|
-
# @param wnd [Wx::Window] The window onto which the tool will eventually be drawn.
|
1064
|
-
# @param bitmap_size [Wx::Size] The size of the tool's foreground bitmap.
|
1065
|
-
# @param kind [Wx::RibbonButtonKind] The kind of tool (normal, dropdown, or hybrid).
|
1066
|
-
# @param is_first [Boolean] true if the tool is the first within its group. false otherwise.
|
1067
|
-
# @param is_last [Boolean] true if the tool is the last within its group. false otherwise.
|
1068
|
-
# @param dropdown_region [Wx::Rect] For dropdown and hybrid tools, the region within the returned size which counts as the dropdown part.
|
1069
|
-
# @return [Wx::Size]
|
1070
|
-
def get_tool_size(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) end
|
1071
|
-
alias_method :tool_size, :get_tool_size
|
1072
|
-
|
1073
|
-
# Calculate the position and size of the ribbon's toggle button.
|
1074
|
-
# @param rect [Wx::Rect] The ribbon bar rectangle from which calculate toggle button rectangle.
|
1075
|
-
# @return [Wx::Rect]
|
1076
|
-
def get_bar_toggle_button_area(rect) end
|
1077
|
-
alias_method :bar_toggle_button_area, :get_bar_toggle_button_area
|
1078
|
-
|
1079
|
-
# Calculate the position and size of the ribbon's help button.
|
1080
|
-
# @param rect [Wx::Rect] The ribbon bar rectangle from which calculate help button rectangle.
|
1081
|
-
# @return [Wx::Rect]
|
1082
|
-
def get_ribbon_help_button_area(rect) end
|
1083
|
-
alias_method :ribbon_help_button_area, :get_ribbon_help_button_area
|
1084
|
-
|
1085
|
-
end # RibbonArtProvider
|
1086
|
-
|
1087
|
-
#
|
1088
|
-
#
|
1089
|
-
#
|
1090
|
-
#
|
1091
|
-
#
|
1092
|
-
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
1093
|
-
# @wxrb_require USE_RIBBON
|
1094
|
-
class RibbonPageTabInfo < ::Object
|
1095
|
-
|
1096
|
-
end # RibbonPageTabInfo
|
1097
|
-
|
1098
|
-
#
|
1099
|
-
#
|
1100
|
-
#
|
1101
|
-
#
|
1102
|
-
#
|
1103
|
-
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
1104
|
-
# @wxrb_require USE_RIBBON
|
1105
|
-
class RibbonMSWArtProvider < RibbonArtProvider
|
1106
|
-
|
1107
|
-
# @param set_colour_scheme [Boolean]
|
1108
|
-
# @return [Wx::RBN::RibbonMSWArtProvider]
|
1109
|
-
def initialize(set_colour_scheme=true) end
|
1110
|
-
|
1111
|
-
# Create a new art provider which is a clone of this one.
|
1112
|
-
# @return [Wx::RBN::RibbonArtProvider]
|
1113
|
-
def clone; end
|
1114
|
-
|
1115
|
-
# Set the style flags.
|
1116
|
-
#
|
1117
|
-
# Normally called automatically by {Wx::RBN::RibbonBar#set_art_provider} with the ribbon bar's style flags, so that the art provider has the same flags as the bar which it is serving.
|
1118
|
-
# @param flags [Integer]
|
1119
|
-
# @return [void]
|
1120
|
-
def set_flags(flags) end
|
1121
|
-
alias_method :flags=, :set_flags
|
1122
|
-
|
1123
|
-
# Get the previously set style flags.
|
1124
|
-
# @return [Integer]
|
1125
|
-
def get_flags; end
|
1126
|
-
alias_method :flags, :get_flags
|
1127
|
-
|
1128
|
-
# Get the value of a certain integer setting.
|
1129
|
-
#
|
1130
|
-
# id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
|
1131
|
-
# @param id [Integer]
|
1132
|
-
# @return [Integer]
|
1133
|
-
def get_metric(id) end
|
1134
|
-
alias_method :metric, :get_metric
|
1135
|
-
|
1136
|
-
# Set the value of a certain integer setting to the value new_val.
|
1137
|
-
#
|
1138
|
-
# id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
|
1139
|
-
# @param id [Integer]
|
1140
|
-
# @param new_val [Integer]
|
1141
|
-
# @return [void]
|
1142
|
-
def set_metric(id, new_val) end
|
1143
|
-
|
1144
|
-
# Set the value of a certain font setting to the value font.
|
1145
|
-
#
|
1146
|
-
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
1147
|
-
# @param id [Integer]
|
1148
|
-
# @param font [Wx::Font,Wx::FontInfo]
|
1149
|
-
# @return [void]
|
1150
|
-
def set_font(id, font) end
|
1151
|
-
|
1152
|
-
# Get the value of a certain font setting.
|
1153
|
-
#
|
1154
|
-
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
1155
|
-
# @param id [Integer]
|
1156
|
-
# @return [Wx::Font]
|
1157
|
-
def get_font(id) end
|
1158
|
-
alias_method :font, :get_font
|
1159
|
-
|
1160
|
-
# Get the value of a certain colour setting.
|
1161
|
-
#
|
1162
|
-
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
|
1163
|
-
# @param id [Integer]
|
1164
|
-
# @return [Wx::Colour]
|
1165
|
-
def get_colour(id) end
|
1166
|
-
alias_method :colour, :get_colour
|
1167
|
-
|
1168
|
-
# Set the value of a certain colour setting to the value colour.
|
1169
|
-
#
|
1170
|
-
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
|
1171
|
-
# @see Wx::RBN::RibbonMSWArtProvider#set_colour_scheme
|
1172
|
-
# @param id [Integer]
|
1173
|
-
# @param colour [Wx::Colour,String,Symbol]
|
1174
|
-
# @return [void]
|
1175
|
-
def set_colour(id, colour) end
|
1176
|
-
|
1177
|
-
# Get the current colour scheme.
|
1178
|
-
#
|
1179
|
-
# Returns three colours such that if {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} were called with them, the colour scheme would be restored to what it was when {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} was last called. In practice, this usually means that the returned values are the three colours given in the last call to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}, however if {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} performs an idempotent operation upon the colours it is given (like clamping a component of the colour), then the returned values may not be the three colours given in the last call to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}. If {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} has not been called, then the returned values should result in a colour scheme similar to, if not identical to, the default colours of the art provider. Note that if {Wx::RBN::RibbonMSWArtProvider#set_colour} is called, then {Wx::RBN::RibbonMSWArtProvider#get_colour_scheme} does not try and return a colour scheme similar to colours being used - it's return values are dependent upon the last values given to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}, as described above.
|
1180
|
-
# @param primary [Wx::Colour] Pointer to a location to store the primary colour, or NULL.
|
1181
|
-
# @param secondary [Wx::Colour] Pointer to a location to store the secondary colour, or NULL.
|
1182
|
-
# @param tertiary [Wx::Colour] Pointer to a location to store the tertiary colour, or NULL.
|
1183
|
-
# @return [void]
|
1184
|
-
def get_colour_scheme(primary, secondary, tertiary) end
|
1185
|
-
alias_method :colour_scheme, :get_colour_scheme
|
1186
|
-
|
1187
|
-
# Set all applicable colour settings from a few base colours.
|
1188
|
-
#
|
1189
|
-
# Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
|
1190
|
-
# @see Wx::RBN::RibbonMSWArtProvider#set_colour
|
1191
|
-
#
|
1192
|
-
# @see Wx::RBN::RibbonMSWArtProvider#get_colour_scheme
|
1193
|
-
# @param primary [Wx::Colour,String,Symbol]
|
1194
|
-
# @param secondary [Wx::Colour,String,Symbol]
|
1195
|
-
# @param tertiary [Wx::Colour,String,Symbol]
|
1196
|
-
# @return [void]
|
1197
|
-
def set_colour_scheme(primary, secondary, tertiary) end
|
1198
|
-
|
1199
|
-
# Calculate the height (in pixels) of the tab region of a ribbon bar.
|
1200
|
-
#
|
1201
|
-
# Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
|
1202
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1203
|
-
# @param wnd [Wx::Window] The window onto which the tabs will eventually be drawn.
|
1204
|
-
# @param pages [Array<Wx::RBN::RibbonPageTabInfo>] The tabs which will acquire the returned height.
|
1205
|
-
# @return [Integer]
|
1206
|
-
def get_tab_ctrl_height(dc, wnd, pages) end
|
1207
|
-
alias_method :tab_ctrl_height, :get_tab_ctrl_height
|
1208
|
-
|
1209
|
-
# Draw the background of the tab region of a ribbon bar.
|
1210
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1211
|
-
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1212
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1213
|
-
# @return [void]
|
1214
|
-
def draw_tab_ctrl_background(dc, wnd, rect) end
|
1215
|
-
|
1216
|
-
# Draw a single tab in the tab region of a ribbon bar.
|
1217
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1218
|
-
# @param wnd [Wx::Window] The window which is being drawn onto (not the {Wx::RBN::RibbonPage} associated with the tab being drawn).
|
1219
|
-
# @param tab [Wx::RBN::RibbonPageTabInfo] The rectangle within which to draw, and also the tab label, icon, and state (active and/or hovered). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tab_ctrl_background}. The rectangle's width will be at least the minimum value returned by {Wx::RBN::RibbonMSWArtProvider#get_bar_tab_width}, and height will be the value returned by {Wx::RBN::RibbonMSWArtProvider#get_tab_ctrl_height}.
|
1220
|
-
# @return [void]
|
1221
|
-
def draw_tab(dc, wnd, tab) end
|
1222
|
-
|
1223
|
-
# Draw a separator between two tabs in a ribbon bar.
|
1224
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1225
|
-
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1226
|
-
# @param rect [Wx::Rect] The rectangle within which to draw, which will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tab_ctrl_background}.
|
1227
|
-
# @param visibility [Float] The opacity with which to draw the separator. Values are in the range [0, 1], with 0 being totally transparent, and 1 being totally opaque.
|
1228
|
-
# @return [void]
|
1229
|
-
def draw_tab_separator(dc, wnd, rect, visibility) end
|
1230
|
-
|
1231
|
-
# Draw the background of a ribbon page.
|
1232
|
-
#
|
1233
|
-
#
|
1234
|
-
# @see Wx::RBN::RibbonMSWArtProvider#get_page_background_redraw_area
|
1235
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1236
|
-
# @param wnd [Wx::Window] The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
|
1237
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1238
|
-
# @return [void]
|
1239
|
-
def draw_page_background(dc, wnd, rect) end
|
1240
|
-
|
1241
|
-
# Draw a ribbon-style scroll button.
|
1242
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1243
|
-
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1244
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be at least the size returned by {Wx::RBN::RibbonMSWArtProvider#get_scroll_button_minimum_size} for a scroll button with the same style. For tab scroll buttons, this rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tab_ctrl_background}, but this is not guaranteed for other types of button (for example, page scroll buttons will not be painted on an area previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_page_background}).
|
1245
|
-
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, a for flag, and one or more states.
|
1246
|
-
# @return [void]
|
1247
|
-
def draw_scroll_button(dc, wnd, rect, style) end
|
1248
|
-
|
1249
|
-
# Draw the background and chrome for a ribbon panel.
|
1250
|
-
#
|
1251
|
-
# This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
|
1252
|
-
# Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonMSWArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
|
1253
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1254
|
-
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
1255
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1256
|
-
# @return [void]
|
1257
|
-
def draw_panel_background(dc, wnd, rect) end
|
1258
|
-
|
1259
|
-
# Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
|
1260
|
-
#
|
1261
|
-
# This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
|
1262
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1263
|
-
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
|
1264
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is the entire area of the gallery control, not just the client rectangle.
|
1265
|
-
# @return [void]
|
1266
|
-
def draw_gallery_background(dc, wnd, rect) end
|
1267
|
-
|
1268
|
-
# Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
|
1269
|
-
#
|
1270
|
-
# This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonMSWArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonMSWArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
|
1271
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1272
|
-
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery which contains the item being drawn.
|
1273
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be the size of the item's bitmap, expanded by gallery item padding values ({Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE}, and {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE}). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_gallery_background}.
|
1274
|
-
# @param item [Integer] The item whose background is being painted. Typically the background will vary if the item is hovered, active, or selected; {Wx::RBN::RibbonGallery#get_selection}, {Wx::RBN::RibbonGallery#get_active_item}, and {Wx::RBN::RibbonGallery#get_hovered_item} can be called to test if the given item is in one of these states.
|
1275
|
-
# @return [void]
|
1276
|
-
def draw_gallery_item_background(dc, wnd, rect, item) end
|
1277
|
-
|
1278
|
-
# Draw a minimised ribbon panel.
|
1279
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1280
|
-
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel which is minimised. The panel label can be obtained from this window. The minimised icon obtained from querying the window may not be the size requested by {Wx::RBN::RibbonMSWArtProvider#get_minimised_panel_minimum_size} - the bitmap argument contains the icon in the requested size.
|
1281
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. The size of the rectangle will be at least the size returned by {Wx::RBN::RibbonMSWArtProvider#get_minimised_panel_minimum_size}.
|
1282
|
-
# @param bitmap [Wx::Bitmap] A copy of the panel's minimised bitmap rescaled to the size returned by {Wx::RBN::RibbonMSWArtProvider#get_minimised_panel_minimum_size}.
|
1283
|
-
# @return [void]
|
1284
|
-
def draw_minimised_panel(dc, wnd, rect, bitmap) end
|
1285
|
-
|
1286
|
-
# Draw the background for a {Wx::RBN::RibbonButtonBar} control.
|
1287
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1288
|
-
# @param wnd [Wx::Window] The window which is being drawn onto (which will typically be the button bar itself, though this is not guaranteed).
|
1289
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1290
|
-
# @return [void]
|
1291
|
-
def draw_button_bar_background(dc, wnd, rect) end
|
1292
|
-
|
1293
|
-
# Draw a single button for a {Wx::RBN::RibbonButtonBar} control.
|
1294
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1295
|
-
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1296
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be a size previously returned by {Wx::RBN::RibbonMSWArtProvider#get_button_bar_button_size}, and the rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_button_bar_background}.
|
1297
|
-
# @param kind [Wx::RibbonButtonKind] The kind of button to draw (normal, dropdown or hybrid).
|
1298
|
-
# @param state [Integer] Combination of a size flag and state flags from the {Wx::RBN::RibbonButtonBarButtonState} enumeration.
|
1299
|
-
# @param label [String] The label of the button.
|
1300
|
-
# @param bitmap_large [Wx::Bitmap] The large bitmap of the button (or the large disabled bitmap when {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_DISABLED} is set in state).
|
1301
|
-
# @param bitmap_small [Wx::Bitmap] The small bitmap of the button (or the small disabled bitmap when {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_DISABLED} is set in state).
|
1302
|
-
# @return [void]
|
1303
|
-
def draw_button_bar_button(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) end
|
1304
|
-
|
1305
|
-
# Draw the background for a {Wx::RBN::RibbonToolBar} control.
|
1306
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1307
|
-
# @param wnd [Wx::Window] The which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1308
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. Some of this rectangle will later be drawn over using {Wx::RBN::RibbonMSWArtProvider#draw_tool_group_background} and {Wx::RBN::RibbonMSWArtProvider#draw_tool}, but not all of it will (unless there is only a single group of tools).
|
1309
|
-
# @return [void]
|
1310
|
-
def draw_tool_bar_background(dc, wnd, rect) end
|
1311
|
-
|
1312
|
-
# Draw the background for a group of tools on a {Wx::RBN::RibbonToolBar} control.
|
1313
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1314
|
-
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1315
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is a union of the individual tools' rectangles. As there are no gaps between tools, this rectangle will be painted over exactly once by calls to {Wx::RBN::RibbonMSWArtProvider#draw_tool}. The group background could therefore be painted by {Wx::RBN::RibbonMSWArtProvider#draw_tool}, though it can be conceptually easier and more efficient to draw it all at once here. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tool_bar_background}.
|
1316
|
-
# @return [void]
|
1317
|
-
def draw_tool_group_background(dc, wnd, rect) end
|
1318
|
-
|
1319
|
-
# Draw a single tool (for a {Wx::RBN::RibbonToolBar} control).
|
1320
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1321
|
-
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1322
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will at least the size returned by {Wx::RBN::RibbonMSWArtProvider#get_tool_size}, and the height of it will be equal for all tools within the same group. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tool_group_background}.
|
1323
|
-
# @param bitmap [Wx::Bitmap] The bitmap to use as the tool's foreground. If the tool is a hybrid or dropdown tool, then the foreground should also contain a standard dropdown button.
|
1324
|
-
# @param kind [Wx::RibbonButtonKind] The kind of tool to draw (normal, dropdown, or hybrid).
|
1325
|
-
# @param state [Integer] A combination of {Wx::RibbonToolBarToolState} flags giving the state of the tool and it's relative position within a tool group.
|
1326
|
-
# @return [void]
|
1327
|
-
def draw_tool(dc, wnd, rect, bitmap, kind, state) end
|
1328
|
-
|
1329
|
-
# Draw toggle button on {Wx::RBN::RibbonBar}.
|
1330
|
-
#
|
1331
|
-
# This should draw a small toggle button at top right corner of ribbon bar.
|
1332
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1333
|
-
# @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
1334
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1335
|
-
# @param mode [Wx::RibbonDisplayMode] The {Wx::RBN::RibbonDisplayMode} which should be applied to display button
|
1336
|
-
# @return [void]
|
1337
|
-
def draw_toggle_button(dc, wnd, rect, mode) end
|
1338
|
-
|
1339
|
-
# Draw help button on {Wx::RBN::RibbonBar}.
|
1340
|
-
#
|
1341
|
-
# This should draw a help button at top right corner of ribbon bar.
|
1342
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1343
|
-
# @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
1344
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1345
|
-
# @return [void]
|
1346
|
-
def draw_help_button(dc, wnd, rect) end
|
1347
|
-
|
1348
|
-
# Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
|
1349
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1350
|
-
# @param wnd [Wx::Window] The window onto which the tab will eventually be drawn.
|
1351
|
-
# @param label [String] The tab's label (or {Wx::EmptyString} if it has none).
|
1352
|
-
# @param bitmap [Wx::Bitmap] The tab's icon (or {Wx::NULL_BITMAP} if it has none).
|
1353
|
-
# @return [Array(Integer,Integer,Integer,Integer)]
|
1354
|
-
def get_bar_tab_width(dc, wnd, label, bitmap) end
|
1355
|
-
alias_method :bar_tab_width, :get_bar_tab_width
|
1356
|
-
|
1357
|
-
# Calculate the minimum size (in pixels) of a scroll button.
|
1358
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1359
|
-
# @param wnd [Wx::Window] The window onto which the scroll button will eventually be drawn.
|
1360
|
-
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, and a for flag (state flags may be given too, but should be ignored, as a button should retain a constant size, regardless of its state).
|
1361
|
-
# @return [Wx::Size]
|
1362
|
-
def get_scroll_button_minimum_size(dc, wnd, style) end
|
1363
|
-
alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
|
1364
|
-
|
1365
|
-
# Calculate the size of a panel for a given client size.
|
1366
|
-
#
|
1367
|
-
# This should increment the given size by enough to fit the panel label and other chrome.
|
1368
|
-
# @see Wx::RBN::RibbonMSWArtProvider#get_panel_client_size
|
1369
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1370
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1371
|
-
# @param client_size [Wx::Size] The client size.
|
1372
|
-
# @param client_offset [Wx::Point] The offset where the client rectangle begins within the panel (may be NULL).
|
1373
|
-
# @return [Wx::Size]
|
1374
|
-
def get_panel_size(dc, wnd, client_size, client_offset) end
|
1375
|
-
alias_method :panel_size, :get_panel_size
|
1376
|
-
|
1377
|
-
# Calculate the client size of a panel for a given overall size.
|
1378
|
-
#
|
1379
|
-
# This should act as the inverse to {Wx::RBN::RibbonMSWArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
|
1380
|
-
# @see Wx::RBN::RibbonMSWArtProvider#get_panel_size
|
1381
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1382
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1383
|
-
# @param size [Wx::Size] The overall size to calculate client size for.
|
1384
|
-
# @param client_offset [Wx::Point] The offset where the returned client size begins within the given size (may be NULL).
|
1385
|
-
# @return [Wx::Size]
|
1386
|
-
def get_panel_client_size(dc, wnd, size, client_offset) end
|
1387
|
-
alias_method :panel_client_size, :get_panel_client_size
|
1388
|
-
|
1389
|
-
# Calculate the position and size of the panel extension button.
|
1390
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1391
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1392
|
-
# @param rect [Wx::Rect] The panel rectangle from which calculate extension button rectangle.
|
1393
|
-
# @return [Wx::Rect]
|
1394
|
-
def get_panel_ext_button_area(dc, wnd, rect) end
|
1395
|
-
alias_method :panel_ext_button_area, :get_panel_ext_button_area
|
1396
|
-
|
1397
|
-
# Calculate the size of a {Wx::RBN::RibbonGallery} control for a given client size.
|
1398
|
-
#
|
1399
|
-
# This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.
|
1400
|
-
# @see Wx::RBN::RibbonMSWArtProvider#get_gallery_client_size
|
1401
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1402
|
-
# @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
|
1403
|
-
# @param client_size [Wx::Size] The client size.
|
1404
|
-
# @return [Wx::Size]
|
1405
|
-
def get_gallery_size(dc, wnd, client_size) end
|
1406
|
-
alias_method :gallery_size, :get_gallery_size
|
1407
|
-
|
1408
|
-
# Calculate the client size of a {Wx::RBN::RibbonGallery} control for a given size.
|
1409
|
-
#
|
1410
|
-
# This should act as the inverse to {Wx::RBN::RibbonMSWArtProvider#get_gallery_size}, and decrement the given size by enough to fit the gallery border, buttons, and other chrome.
|
1411
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1412
|
-
# @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
|
1413
|
-
# @param size [Wx::Size] The overall size to calculate the client size for.
|
1414
|
-
# @param client_offset [Wx::Point] The position within the given size at which the returned client size begins.
|
1415
|
-
# @param scroll_up_button [Wx::Rect] The rectangle within the given size which the scroll up button occupies.
|
1416
|
-
# @param scroll_down_button [Wx::Rect] The rectangle within the given size which the scroll down button occupies.
|
1417
|
-
# @param extension_button [Wx::Rect] The rectangle within the given size which the extension button occupies.
|
1418
|
-
# @return [Wx::Size]
|
1419
|
-
def get_gallery_client_size(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) end
|
1420
|
-
alias_method :gallery_client_size, :get_gallery_client_size
|
1421
|
-
|
1422
|
-
# Calculate the portion of a page background which needs to be redrawn when a page is resized.
|
1423
|
-
#
|
1424
|
-
# To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.
|
1425
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1426
|
-
# @param wnd [Wx::RBN::RibbonPage] The page which is being resized.
|
1427
|
-
# @param page_old_size [Wx::Size] The size of the page prior to the resize (which has already been painted).
|
1428
|
-
# @param page_new_size [Wx::Size] The size of the page after the resize.
|
1429
|
-
# @return [Wx::Rect]
|
1430
|
-
def get_page_background_redraw_area(dc, wnd, page_old_size, page_new_size) end
|
1431
|
-
alias_method :page_background_redraw_area, :get_page_background_redraw_area
|
1432
|
-
|
1433
|
-
# Calculate the size of a button within a {Wx::RBN::RibbonButtonBar}.
|
1434
|
-
#
|
1435
|
-
# true if a size exists for the button, false otherwise.
|
1436
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1437
|
-
# @param wnd [Wx::Window] The window onto which the button will eventually be drawn (which is normally a {Wx::RBN::RibbonButtonBar}, though this is not guaranteed).
|
1438
|
-
# @param kind [Wx::RibbonButtonKind] The kind of button.
|
1439
|
-
# @param size [Wx::RibbonButtonBarButtonState] The size-class to calculate the size for. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}. If the requested size-class is not applicable, then false should be returned.
|
1440
|
-
# @param label [String] The label of the button.
|
1441
|
-
# @param text_min_width [Integer] The minimum width of the button label. Set this to 0 if it is not used.
|
1442
|
-
# @param bitmap_size_large [Wx::Size] The size of all "large" bitmaps on the button bar.
|
1443
|
-
# @param bitmap_size_small [Wx::Size] The size of all "small" bitmaps on the button bar.
|
1444
|
-
# @param button_size [Wx::Size] The size, in pixels, of the button.
|
1445
|
-
# @param normal_region [Wx::Rect] The region of the button which constitutes the normal button.
|
1446
|
-
# @param dropdown_region [Wx::Rect] The region of the button which constitutes the dropdown button.
|
1447
|
-
# @return [Boolean]
|
1448
|
-
def get_button_bar_button_size(dc, wnd, kind, size, label, text_min_width, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) end
|
1449
|
-
alias_method :button_bar_button_size, :get_button_bar_button_size
|
1450
|
-
|
1451
|
-
# Gets the width of the string if it is used as a {Wx::RBN::RibbonButtonBar} button label.
|
1452
|
-
#
|
1453
|
-
# Width of the given label text in pixel.
|
1454
|
-
#
|
1455
|
-
# <div class="wxrb-note">
|
1456
|
-
# <b>Note:</b>
|
1457
|
-
# <p>This function only works with single-line strings.
|
1458
|
-
# </p>
|
1459
|
-
# </div>
|
1460
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1461
|
-
# @param label [String] The string whose width shall be calculated.
|
1462
|
-
# @param kind [Wx::RibbonButtonKind] The kind of button.
|
1463
|
-
# @param size [Wx::RibbonButtonBarButtonState] The size-class to calculate the size for. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}. If the requested size-class is not applicable, then NULL should be returned.
|
1464
|
-
# @return [Integer]
|
1465
|
-
def get_button_bar_button_text_width(dc, label, kind, size) end
|
1466
|
-
alias_method :button_bar_button_text_width, :get_button_bar_button_text_width
|
1467
|
-
|
1468
|
-
# Calculate the size of a minimised ribbon panel.
|
1469
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1470
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question. Attributes like the panel label can be queried from this.
|
1471
|
-
# @param desired_bitmap_size [Wx::Size] Optional parameter which is filled with the size of the bitmap suitable for a minimised ribbon panel.
|
1472
|
-
# @return [Array(Wx::Size,Wx::Direction)]
|
1473
|
-
def get_minimised_panel_minimum_size(dc, wnd, desired_bitmap_size) end
|
1474
|
-
alias_method :minimised_panel_minimum_size, :get_minimised_panel_minimum_size
|
1475
|
-
|
1476
|
-
# Calculate the size of a tool within a {Wx::RBN::RibbonToolBar}.
|
1477
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1478
|
-
# @param wnd [Wx::Window] The window onto which the tool will eventually be drawn.
|
1479
|
-
# @param bitmap_size [Wx::Size] The size of the tool's foreground bitmap.
|
1480
|
-
# @param kind [Wx::RibbonButtonKind] The kind of tool (normal, dropdown, or hybrid).
|
1481
|
-
# @param is_first [Boolean] true if the tool is the first within its group. false otherwise.
|
1482
|
-
# @param is_last [Boolean] true if the tool is the last within its group. false otherwise.
|
1483
|
-
# @param dropdown_region [Wx::Rect] For dropdown and hybrid tools, the region within the returned size which counts as the dropdown part.
|
1484
|
-
# @return [Wx::Size]
|
1485
|
-
def get_tool_size(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) end
|
1486
|
-
alias_method :tool_size, :get_tool_size
|
1487
|
-
|
1488
|
-
# Calculate the position and size of the ribbon's toggle button.
|
1489
|
-
# @param rect [Wx::Rect] The ribbon bar rectangle from which calculate toggle button rectangle.
|
1490
|
-
# @return [Wx::Rect]
|
1491
|
-
def get_bar_toggle_button_area(rect) end
|
1492
|
-
alias_method :bar_toggle_button_area, :get_bar_toggle_button_area
|
1493
|
-
|
1494
|
-
# Calculate the position and size of the ribbon's help button.
|
1495
|
-
# @param rect [Wx::Rect] The ribbon bar rectangle from which calculate help button rectangle.
|
1496
|
-
# @return [Wx::Rect]
|
1497
|
-
def get_ribbon_help_button_area(rect) end
|
1498
|
-
alias_method :ribbon_help_button_area, :get_ribbon_help_button_area
|
1499
|
-
|
1500
|
-
end # RibbonMSWArtProvider
|
1501
|
-
|
1502
|
-
#
|
1503
|
-
#
|
1504
|
-
#
|
1505
|
-
#
|
1506
|
-
#
|
1507
|
-
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
1508
|
-
# @wxrb_require USE_RIBBON
|
1509
|
-
class RibbonAUIArtProvider < RibbonMSWArtProvider
|
1510
|
-
|
1511
|
-
# @return [Wx::RBN::RibbonAUIArtProvider]
|
1512
|
-
def initialize; end
|
1513
|
-
|
1514
|
-
# Create a new art provider which is a clone of this one.
|
1515
|
-
# @return [Wx::RBN::RibbonArtProvider]
|
1516
|
-
def clone; end
|
1517
|
-
|
1518
|
-
# Get the value of a certain colour setting.
|
1519
605
|
#
|
1520
|
-
#
|
1521
|
-
# @param id [Integer]
|
1522
|
-
# @return [Wx::Colour]
|
1523
|
-
def get_colour(id) end
|
1524
|
-
alias_method :colour, :get_colour
|
1525
|
-
|
1526
|
-
# Set the value of a certain colour setting to the value colour.
|
1527
|
-
#
|
1528
|
-
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
|
1529
|
-
# @see Wx::RBN::RibbonAUIArtProvider#set_colour_scheme
|
1530
|
-
# @param id [Integer]
|
1531
|
-
# @param colour [Wx::Colour,String,Symbol]
|
1532
|
-
# @return [void]
|
1533
|
-
def set_colour(id, colour) end
|
1534
|
-
|
1535
|
-
# Set all applicable colour settings from a few base colours.
|
1536
|
-
#
|
1537
|
-
# Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
|
1538
|
-
# @see Wx::RBN::RibbonAUIArtProvider#set_colour
|
1539
|
-
#
|
1540
|
-
# @see Wx::RBN::RibbonAUIArtProvider#get_colour_scheme
|
1541
|
-
# @param primary [Wx::Colour,String,Symbol]
|
1542
|
-
# @param secondary [Wx::Colour,String,Symbol]
|
1543
|
-
# @param tertiary [Wx::Colour,String,Symbol]
|
1544
|
-
# @return [void]
|
1545
|
-
def set_colour_scheme(primary, secondary, tertiary) end
|
1546
|
-
|
1547
|
-
# Set the value of a certain font setting to the value font.
|
1548
|
-
#
|
1549
|
-
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
1550
|
-
# @param id [Integer]
|
1551
|
-
# @param font [Wx::Font,Wx::FontInfo]
|
1552
|
-
# @return [void]
|
1553
|
-
def set_font(id, font) end
|
1554
|
-
|
1555
|
-
# Calculate the minimum size (in pixels) of a scroll button.
|
1556
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1557
|
-
# @param wnd [Wx::Window] The window onto which the scroll button will eventually be drawn.
|
1558
|
-
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, and a for flag (state flags may be given too, but should be ignored, as a button should retain a constant size, regardless of its state).
|
1559
|
-
# @return [Wx::Size]
|
1560
|
-
def get_scroll_button_minimum_size(dc, wnd, style) end
|
1561
|
-
alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
|
1562
|
-
|
1563
|
-
# Draw a ribbon-style scroll button.
|
1564
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1565
|
-
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1566
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be at least the size returned by {Wx::RBN::RibbonAUIArtProvider#get_scroll_button_minimum_size} for a scroll button with the same style. For tab scroll buttons, this rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tab_ctrl_background}, but this is not guaranteed for other types of button (for example, page scroll buttons will not be painted on an area previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_page_background}).
|
1567
|
-
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, a for flag, and one or more states.
|
1568
|
-
# @return [void]
|
1569
|
-
def draw_scroll_button(dc, wnd, rect, style) end
|
1570
|
-
|
1571
|
-
# Calculate the size of a panel for a given client size.
|
1572
|
-
#
|
1573
|
-
# This should increment the given size by enough to fit the panel label and other chrome.
|
1574
|
-
# @see Wx::RBN::RibbonAUIArtProvider#get_panel_client_size
|
1575
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1576
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1577
|
-
# @param client_size [Wx::Size] The client size.
|
1578
|
-
# @param client_offset [Wx::Point] The offset where the client rectangle begins within the panel (may be NULL).
|
1579
|
-
# @return [Wx::Size]
|
1580
|
-
def get_panel_size(dc, wnd, client_size, client_offset) end
|
1581
|
-
alias_method :panel_size, :get_panel_size
|
1582
|
-
|
1583
|
-
# Calculate the client size of a panel for a given overall size.
|
1584
|
-
#
|
1585
|
-
# This should act as the inverse to {Wx::RBN::RibbonAUIArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
|
1586
|
-
# @see Wx::RBN::RibbonAUIArtProvider#get_panel_size
|
1587
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1588
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1589
|
-
# @param size [Wx::Size] The overall size to calculate client size for.
|
1590
|
-
# @param client_offset [Wx::Point] The offset where the returned client size begins within the given size (may be NULL).
|
1591
|
-
# @return [Wx::Size]
|
1592
|
-
def get_panel_client_size(dc, wnd, size, client_offset) end
|
1593
|
-
alias_method :panel_client_size, :get_panel_client_size
|
1594
|
-
|
1595
|
-
# Calculate the position and size of the panel extension button.
|
1596
|
-
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1597
|
-
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1598
|
-
# @param rect [Wx::Rect] The panel rectangle from which calculate extension button rectangle.
|
1599
|
-
# @return [Wx::Rect]
|
1600
|
-
def get_panel_ext_button_area(dc, wnd, rect) end
|
1601
|
-
alias_method :panel_ext_button_area, :get_panel_ext_button_area
|
1602
|
-
|
1603
|
-
# Draw the background of the tab region of a ribbon bar.
|
1604
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1605
|
-
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1606
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1607
|
-
# @return [void]
|
1608
|
-
def draw_tab_ctrl_background(dc, wnd, rect) end
|
1609
|
-
|
1610
|
-
# Calculate the height (in pixels) of the tab region of a ribbon bar.
|
606
|
+
# @see Wx::RBN::RibbonBar#show_panels
|
1611
607
|
#
|
1612
|
-
#
|
1613
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1614
|
-
# @param wnd [Wx::Window] The window onto which the tabs will eventually be drawn.
|
1615
|
-
# @param pages [Array<Wx::RBN::RibbonPageTabInfo>] The tabs which will acquire the returned height.
|
1616
|
-
# @return [Integer]
|
1617
|
-
def get_tab_ctrl_height(dc, wnd, pages) end
|
1618
|
-
alias_method :tab_ctrl_height, :get_tab_ctrl_height
|
1619
|
-
|
1620
|
-
# Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
|
1621
|
-
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1622
|
-
# @param wnd [Wx::Window] The window onto which the tab will eventually be drawn.
|
1623
|
-
# @param label [String] The tab's label (or {Wx::EmptyString} if it has none).
|
1624
|
-
# @param bitmap [Wx::Bitmap] The tab's icon (or {Wx::NULL_BITMAP} if it has none).
|
1625
|
-
# @return [Array(Integer,Integer,Integer,Integer)]
|
1626
|
-
def get_bar_tab_width(dc, wnd, label, bitmap) end
|
1627
|
-
alias_method :bar_tab_width, :get_bar_tab_width
|
1628
|
-
|
1629
|
-
# Draw a single tab in the tab region of a ribbon bar.
|
1630
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1631
|
-
# @param wnd [Wx::Window] The window which is being drawn onto (not the {Wx::RBN::RibbonPage} associated with the tab being drawn).
|
1632
|
-
# @param tab [Wx::RBN::RibbonPageTabInfo] The rectangle within which to draw, and also the tab label, icon, and state (active and/or hovered). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tab_ctrl_background}. The rectangle's width will be at least the minimum value returned by {Wx::RBN::RibbonAUIArtProvider#get_bar_tab_width}, and height will be the value returned by {Wx::RBN::RibbonAUIArtProvider#get_tab_ctrl_height}.
|
1633
|
-
# @return [void]
|
1634
|
-
def draw_tab(dc, wnd, tab) end
|
1635
|
-
|
1636
|
-
# Draw a separator between two tabs in a ribbon bar.
|
1637
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1638
|
-
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1639
|
-
# @param rect [Wx::Rect] The rectangle within which to draw, which will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tab_ctrl_background}.
|
1640
|
-
# @param visibility [Float] The opacity with which to draw the separator. Values are in the range [0, 1], with 0 being totally transparent, and 1 being totally opaque.
|
1641
|
-
# @return [void]
|
1642
|
-
def draw_tab_separator(dc, wnd, rect, visibility) end
|
1643
|
-
|
1644
|
-
# Draw the background of a ribbon page.
|
1645
|
-
#
|
1646
|
-
#
|
1647
|
-
# @see Wx::GetPageBackgroundRedrawArea
|
1648
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1649
|
-
# @param wnd [Wx::Window] The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
|
1650
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1651
|
-
# @return [void]
|
1652
|
-
def draw_page_background(dc, wnd, rect) end
|
1653
|
-
|
1654
|
-
# Draw the background and chrome for a ribbon panel.
|
1655
|
-
#
|
1656
|
-
# This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
|
1657
|
-
# Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonAUIArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
|
1658
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1659
|
-
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
1660
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1661
|
-
# @return [void]
|
1662
|
-
def draw_panel_background(dc, wnd, rect) end
|
1663
|
-
|
1664
|
-
# Draw a minimised ribbon panel.
|
1665
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1666
|
-
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel which is minimised. The panel label can be obtained from this window. The minimised icon obtained from querying the window may not be the size requested by {Wx::RBN::RibbonAUIArtProvider#get_minimised_panel_minimum_size} - the bitmap argument contains the icon in the requested size.
|
1667
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. The size of the rectangle will be at least the size returned by {Wx::RBN::RibbonAUIArtProvider#get_minimised_panel_minimum_size}.
|
1668
|
-
# @param bitmap [Wx::Bitmap] A copy of the panel's minimised bitmap rescaled to the size returned by {Wx::RBN::RibbonAUIArtProvider#get_minimised_panel_minimum_size}.
|
1669
|
-
# @return [void]
|
1670
|
-
def draw_minimised_panel(dc, wnd, rect, bitmap) end
|
1671
|
-
|
1672
|
-
# Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
|
608
|
+
# @see Wx::RBN::RibbonBar#get_display_mode
|
1673
609
|
#
|
1674
|
-
# This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
|
1675
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1676
|
-
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
|
1677
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is the entire area of the gallery control, not just the client rectangle.
|
1678
|
-
# @return [void]
|
1679
|
-
def draw_gallery_background(dc, wnd, rect) end
|
1680
|
-
|
1681
|
-
# Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
|
1682
610
|
#
|
1683
|
-
#
|
1684
|
-
|
1685
|
-
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery which contains the item being drawn.
|
1686
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be the size of the item's bitmap, expanded by gallery item padding values ({Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE}, and {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE}). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_gallery_background}.
|
1687
|
-
# @param item [Integer] The item whose background is being painted. Typically the background will vary if the item is hovered, active, or selected; {Wx::RBN::RibbonGallery#get_selection}, {Wx::RBN::RibbonGallery#get_active_item}, and {Wx::RBN::RibbonGallery#get_hovered_item} can be called to test if the given item is in one of these states.
|
1688
|
-
# @return [void]
|
1689
|
-
def draw_gallery_item_background(dc, wnd, rect, item) end
|
1690
|
-
|
1691
|
-
# Draw the background for a {Wx::RBN::RibbonButtonBar} control.
|
1692
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1693
|
-
# @param wnd [Wx::Window] The window which is being drawn onto (which will typically be the button bar itself, though this is not guaranteed).
|
1694
|
-
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1695
|
-
# @return [void]
|
1696
|
-
def draw_button_bar_background(dc, wnd, rect) end
|
611
|
+
# @wxrb_require USE_RIBBON
|
612
|
+
class RibbonDisplayMode < Wx::Enum
|
1697
613
|
|
1698
|
-
|
1699
|
-
|
1700
|
-
|
1701
|
-
|
1702
|
-
|
1703
|
-
|
1704
|
-
|
1705
|
-
|
1706
|
-
|
1707
|
-
|
1708
|
-
|
614
|
+
# The panel area is visible and pinned: it remains visible when the ribbon bar loses the focus.
|
615
|
+
#
|
616
|
+
RIBBON_BAR_PINNED = Wx::RBN::RibbonDisplayMode.new(0)
|
617
|
+
|
618
|
+
# The panel area is hidden: only the pages tabs remain visible.
|
619
|
+
#
|
620
|
+
RIBBON_BAR_MINIMIZED = Wx::RBN::RibbonDisplayMode.new(1)
|
621
|
+
|
622
|
+
# The panel area is visible, but not pinned: it minimizes as soon as the focus is lost.
|
623
|
+
#
|
624
|
+
RIBBON_BAR_EXPANDED = Wx::RBN::RibbonDisplayMode.new(2)
|
625
|
+
|
626
|
+
end # RibbonDisplayMode
|
627
|
+
|
628
|
+
#
|
629
|
+
#
|
630
|
+
EVT_RIBBONBAR_PAGE_CHANGED = 10442
|
631
|
+
|
632
|
+
#
|
633
|
+
#
|
634
|
+
EVT_RIBBONBAR_PAGE_CHANGING = 10443
|
635
|
+
|
636
|
+
#
|
637
|
+
#
|
638
|
+
EVT_RIBBONBAR_TAB_MIDDLE_DOWN = 10444
|
639
|
+
|
640
|
+
#
|
641
|
+
#
|
642
|
+
EVT_RIBBONBAR_TAB_MIDDLE_UP = 10445
|
643
|
+
|
644
|
+
#
|
645
|
+
#
|
646
|
+
EVT_RIBBONBAR_TAB_RIGHT_DOWN = 10446
|
647
|
+
|
648
|
+
#
|
649
|
+
#
|
650
|
+
EVT_RIBBONBAR_TAB_RIGHT_UP = 10447
|
651
|
+
|
652
|
+
#
|
653
|
+
#
|
654
|
+
EVT_RIBBONBAR_TAB_LEFT_DCLICK = 10448
|
655
|
+
|
656
|
+
#
|
657
|
+
#
|
658
|
+
EVT_RIBBONBAR_TOGGLED = 10449
|
659
|
+
|
660
|
+
#
|
661
|
+
#
|
662
|
+
EVT_RIBBONBAR_HELP_CLICK = 10450
|
663
|
+
|
664
|
+
# {Wx::RBN::RibbonArtProvider} is responsible for drawing all the components of the ribbon interface.
|
665
|
+
#
|
666
|
+
# This allows a ribbon bar to have a pluggable look-and-feel, while retaining the same underlying behaviour. As a single art provider is used for all ribbon components, a ribbon bar usually has a consistent (though unique) appearance.
|
667
|
+
# By default, a {Wx::RBN::RibbonBar} uses an instance of this class called {Wx::RBN::RibbonDefaultArtProvider}, which resolves to {Wx::RBN::RibbonAUIArtProvider}, {Wx::RBN::RibbonMSWArtProvider}, or {Wx::RibbonOSXArtProvider} - whichever is most appropriate to the current platform. These art providers are all slightly configurable with regard to colours and fonts, but for larger modifications, you can derive from one of these classes, or write a completely new art provider class. Call {Wx::RBN::RibbonBar#set_art_provider} to change the art provider being used.
|
668
|
+
#
|
669
|
+
# Category: Ribbon User Interface
|
670
|
+
# @see Wx::RBN::RibbonBar
|
671
|
+
#
|
672
|
+
#
|
673
|
+
# @wxrb_require USE_RIBBON
|
674
|
+
class RibbonArtProvider < ::Object
|
675
|
+
|
676
|
+
# Constructor.
|
677
|
+
# @return [Wx::RBN::RibbonArtProvider]
|
678
|
+
def initialize; end
|
679
|
+
|
680
|
+
# Create a new art provider which is a clone of this one.
|
681
|
+
# @return [Wx::RBN::RibbonArtProvider]
|
682
|
+
def clone; end
|
683
|
+
|
684
|
+
# Set the style flags.
|
685
|
+
#
|
686
|
+
# Normally called automatically by {Wx::RBN::RibbonBar#set_art_provider} with the ribbon bar's style flags, so that the art provider has the same flags as the bar which it is serving.
|
687
|
+
# @param flags [Integer]
|
688
|
+
# @return [void]
|
689
|
+
def set_flags(flags) end
|
690
|
+
alias_method :flags=, :set_flags
|
691
|
+
|
692
|
+
# Get the previously set style flags.
|
693
|
+
# @return [Integer]
|
694
|
+
def get_flags; end
|
695
|
+
alias_method :flags, :get_flags
|
696
|
+
|
697
|
+
# Get the value of a certain integer setting.
|
698
|
+
#
|
699
|
+
# id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
|
700
|
+
# @param id [Integer]
|
701
|
+
# @return [Integer]
|
702
|
+
def get_metric(id) end
|
703
|
+
alias_method :metric, :get_metric
|
704
|
+
|
705
|
+
# Set the value of a certain integer setting to the value new_val.
|
706
|
+
#
|
707
|
+
# id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
|
708
|
+
# @param id [Integer]
|
709
|
+
# @param new_val [Integer]
|
710
|
+
# @return [void]
|
711
|
+
def set_metric(id, new_val) end
|
712
|
+
|
713
|
+
# Set the value of a certain font setting to the value font.
|
714
|
+
#
|
715
|
+
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
716
|
+
# @param id [Integer]
|
717
|
+
# @param font [Wx::Font,Wx::FontInfo]
|
718
|
+
# @return [void]
|
719
|
+
def set_font(id, font) end
|
720
|
+
|
721
|
+
# Get the value of a certain font setting.
|
722
|
+
#
|
723
|
+
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
724
|
+
# @param id [Integer]
|
725
|
+
# @return [Wx::Font]
|
726
|
+
def get_font(id) end
|
727
|
+
alias_method :font, :get_font
|
728
|
+
|
729
|
+
# Get the value of a certain colour setting.
|
730
|
+
#
|
731
|
+
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
|
732
|
+
# @param id [Integer]
|
733
|
+
# @return [Wx::Colour]
|
734
|
+
def get_colour(id) end
|
735
|
+
alias_method :colour, :get_colour
|
736
|
+
|
737
|
+
# Set the value of a certain colour setting to the value colour.
|
738
|
+
#
|
739
|
+
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
|
740
|
+
# @see Wx::RBN::RibbonArtProvider#set_colour_scheme
|
741
|
+
# @param id [Integer]
|
742
|
+
# @param colour [Wx::Colour,String,Symbol]
|
743
|
+
# @return [void]
|
744
|
+
def set_colour(id, colour) end
|
745
|
+
|
746
|
+
#
|
747
|
+
#
|
748
|
+
#
|
749
|
+
# @see Wx::RBN::RibbonArtProvider#get_colour
|
750
|
+
# @param id [Integer]
|
751
|
+
# @return [Wx::Colour]
|
752
|
+
def get_color(id) end
|
753
|
+
alias_method :color, :get_color
|
754
|
+
|
755
|
+
#
|
756
|
+
#
|
757
|
+
#
|
758
|
+
# @see Wx::RBN::RibbonArtProvider#set_colour
|
759
|
+
# @param id [Integer]
|
760
|
+
# @param color [Wx::Colour,String,Symbol]
|
761
|
+
# @return [void]
|
762
|
+
def set_color(id, color) end
|
763
|
+
|
764
|
+
# Get the current colour scheme.
|
765
|
+
#
|
766
|
+
# Returns three colours such that if {Wx::RBN::RibbonArtProvider#set_colour_scheme} were called with them, the colour scheme would be restored to what it was when {Wx::RBN::RibbonArtProvider#set_colour_scheme} was last called. In practice, this usually means that the returned values are the three colours given in the last call to {Wx::RBN::RibbonArtProvider#set_colour_scheme}, however if {Wx::RBN::RibbonArtProvider#set_colour_scheme} performs an idempotent operation upon the colours it is given (like clamping a component of the colour), then the returned values may not be the three colours given in the last call to {Wx::RBN::RibbonArtProvider#set_colour_scheme}. If {Wx::RBN::RibbonArtProvider#set_colour_scheme} has not been called, then the returned values should result in a colour scheme similar to, if not identical to, the default colours of the art provider. Note that if {Wx::RBN::RibbonArtProvider#set_colour} is called, then {Wx::RBN::RibbonArtProvider#get_colour_scheme} does not try and return a colour scheme similar to colours being used - it's return values are dependent upon the last values given to {Wx::RBN::RibbonArtProvider#set_colour_scheme}, as described above.
|
767
|
+
# @param primary [Wx::Colour] Pointer to a location to store the primary colour, or NULL.
|
768
|
+
# @param secondary [Wx::Colour] Pointer to a location to store the secondary colour, or NULL.
|
769
|
+
# @param tertiary [Wx::Colour] Pointer to a location to store the tertiary colour, or NULL.
|
770
|
+
# @return [void]
|
771
|
+
def get_colour_scheme(primary, secondary, tertiary) end
|
772
|
+
alias_method :colour_scheme, :get_colour_scheme
|
773
|
+
|
774
|
+
# Set all applicable colour settings from a few base colours.
|
775
|
+
#
|
776
|
+
# Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
|
777
|
+
# @see Wx::RBN::RibbonArtProvider#set_colour
|
778
|
+
#
|
779
|
+
# @see Wx::RBN::RibbonArtProvider#get_colour_scheme
|
780
|
+
# @param primary [Wx::Colour,String,Symbol]
|
781
|
+
# @param secondary [Wx::Colour,String,Symbol]
|
782
|
+
# @param tertiary [Wx::Colour,String,Symbol]
|
783
|
+
# @return [void]
|
784
|
+
def set_colour_scheme(primary, secondary, tertiary) end
|
785
|
+
|
786
|
+
# Draw the background of the tab region of a ribbon bar.
|
787
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
788
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
789
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
790
|
+
# @return [void]
|
791
|
+
def draw_tab_ctrl_background(dc, wnd, rect) end
|
792
|
+
|
793
|
+
# Draw a single tab in the tab region of a ribbon bar.
|
794
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
795
|
+
# @param wnd [Wx::Window] The window which is being drawn onto (not the {Wx::RBN::RibbonPage} associated with the tab being drawn).
|
796
|
+
# @param tab [Wx::RBN::RibbonPageTabInfo] The rectangle within which to draw, and also the tab label, icon, and state (active and/or hovered). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonArtProvider#draw_tab_ctrl_background}. The rectangle's width will be at least the minimum value returned by {Wx::RBN::RibbonArtProvider#get_bar_tab_width}, and height will be the value returned by {Wx::RBN::RibbonArtProvider#get_tab_ctrl_height}.
|
797
|
+
# @return [void]
|
798
|
+
def draw_tab(dc, wnd, tab) end
|
799
|
+
|
800
|
+
# Draw a separator between two tabs in a ribbon bar.
|
801
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
802
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
803
|
+
# @param rect [Wx::Rect] The rectangle within which to draw, which will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonArtProvider#draw_tab_ctrl_background}.
|
804
|
+
# @param visibility [Float] The opacity with which to draw the separator. Values are in the range [0, 1], with 0 being totally transparent, and 1 being totally opaque.
|
805
|
+
# @return [void]
|
806
|
+
def draw_tab_separator(dc, wnd, rect, visibility) end
|
807
|
+
|
808
|
+
# Draw the background of a ribbon page.
|
809
|
+
#
|
810
|
+
#
|
811
|
+
# @see Wx::RBN::RibbonArtProvider#get_page_background_redraw_area
|
812
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
813
|
+
# @param wnd [Wx::Window] The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
|
814
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
815
|
+
# @return [void]
|
816
|
+
def draw_page_background(dc, wnd, rect) end
|
817
|
+
|
818
|
+
# Draw a ribbon-style scroll button.
|
819
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
820
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
821
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be at least the size returned by {Wx::RBN::RibbonArtProvider#get_scroll_button_minimum_size} for a scroll button with the same style. For tab scroll buttons, this rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonArtProvider#draw_tab_ctrl_background}, but this is not guaranteed for other types of button (for example, page scroll buttons will not be painted on an area previously painted with {Wx::RBN::RibbonArtProvider#draw_page_background}).
|
822
|
+
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, a for flag, and one or more states.
|
823
|
+
# @return [void]
|
824
|
+
def draw_scroll_button(dc, wnd, rect, style) end
|
825
|
+
|
826
|
+
# Draw the background and chrome for a ribbon panel.
|
827
|
+
#
|
828
|
+
# This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
|
829
|
+
# Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
|
830
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
831
|
+
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
832
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
833
|
+
# @return [void]
|
834
|
+
def draw_panel_background(dc, wnd, rect) end
|
835
|
+
|
836
|
+
# Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
|
837
|
+
#
|
838
|
+
# This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
|
839
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
840
|
+
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
|
841
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is the entire area of the gallery control, not just the client rectangle.
|
842
|
+
# @return [void]
|
843
|
+
def draw_gallery_background(dc, wnd, rect) end
|
844
|
+
|
845
|
+
# Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
|
846
|
+
#
|
847
|
+
# This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
|
848
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
849
|
+
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery which contains the item being drawn.
|
850
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be the size of the item's bitmap, expanded by gallery item padding values ({Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE}, and {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE}). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonArtProvider#draw_gallery_background}.
|
851
|
+
# @param item [Integer] The item whose background is being painted. Typically the background will vary if the item is hovered, active, or selected; {Wx::RBN::RibbonGallery#get_selection}, {Wx::RBN::RibbonGallery#get_active_item}, and {Wx::RBN::RibbonGallery#get_hovered_item} can be called to test if the given item is in one of these states.
|
852
|
+
# @return [void]
|
853
|
+
def draw_gallery_item_background(dc, wnd, rect, item) end
|
854
|
+
|
855
|
+
# Draw a minimised ribbon panel.
|
856
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
857
|
+
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel which is minimised. The panel label can be obtained from this window. The minimised icon obtained from querying the window may not be the size requested by {Wx::RBN::RibbonArtProvider#get_minimised_panel_minimum_size} - the bitmap argument contains the icon in the requested size.
|
858
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of the rectangle will be at least the size returned by {Wx::RBN::RibbonArtProvider#get_minimised_panel_minimum_size}.
|
859
|
+
# @param bitmap [Wx::Bitmap] A copy of the panel's minimised bitmap rescaled to the size returned by {Wx::RBN::RibbonArtProvider#get_minimised_panel_minimum_size}.
|
860
|
+
# @return [void]
|
861
|
+
def draw_minimised_panel(dc, wnd, rect, bitmap) end
|
862
|
+
|
863
|
+
# Draw the background for a {Wx::RBN::RibbonButtonBar} control.
|
864
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
865
|
+
# @param wnd [Wx::Window] The window which is being drawn onto (which will typically be the button bar itself, though this is not guaranteed).
|
866
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
867
|
+
# @return [void]
|
868
|
+
def draw_button_bar_background(dc, wnd, rect) end
|
869
|
+
|
870
|
+
# Draw a single button for a {Wx::RBN::RibbonButtonBar} control.
|
871
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
872
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
873
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be a size previously returned by {Wx::RBN::RibbonArtProvider#get_button_bar_button_size}, and the rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonArtProvider#draw_button_bar_background}.
|
874
|
+
# @param kind [Wx::RibbonButtonKind] The kind of button to draw (normal, dropdown or hybrid).
|
875
|
+
# @param state [Integer] Combination of a size flag and state flags from the {Wx::RBN::RibbonButtonBarButtonState} enumeration.
|
876
|
+
# @param label [String] The label of the button.
|
877
|
+
# @param bitmap_large [Wx::Bitmap] The large bitmap of the button (or the large disabled bitmap when {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_DISABLED} is set in state).
|
878
|
+
# @param bitmap_small [Wx::Bitmap] The small bitmap of the button (or the small disabled bitmap when {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_DISABLED} is set in state).
|
879
|
+
# @return [void]
|
880
|
+
def draw_button_bar_button(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) end
|
881
|
+
|
882
|
+
# Draw the background for a {Wx::RBN::RibbonToolBar} control.
|
883
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
884
|
+
# @param wnd [Wx::Window] The which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
885
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. Some of this rectangle will later be drawn over using {Wx::RBN::RibbonArtProvider#draw_tool_group_background} and {Wx::RBN::RibbonArtProvider#draw_tool}, but not all of it will (unless there is only a single group of tools).
|
886
|
+
# @return [void]
|
887
|
+
def draw_tool_bar_background(dc, wnd, rect) end
|
888
|
+
|
889
|
+
# Draw the background for a group of tools on a {Wx::RBN::RibbonToolBar} control.
|
890
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
891
|
+
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
892
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is a union of the individual tools' rectangles. As there are no gaps between tools, this rectangle will be painted over exactly once by calls to {Wx::RBN::RibbonArtProvider#draw_tool}. The group background could therefore be painted by {Wx::RBN::RibbonArtProvider#draw_tool}, though it can be conceptually easier and more efficient to draw it all at once here. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonArtProvider#draw_tool_bar_background}.
|
893
|
+
# @return [void]
|
894
|
+
def draw_tool_group_background(dc, wnd, rect) end
|
895
|
+
|
896
|
+
# Draw a single tool (for a {Wx::RBN::RibbonToolBar} control).
|
897
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
898
|
+
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
899
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will at least the size returned by {Wx::RBN::RibbonArtProvider#get_tool_size}, and the height of it will be equal for all tools within the same group. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonArtProvider#draw_tool_group_background}.
|
900
|
+
# @param bitmap [Wx::Bitmap] The bitmap to use as the tool's foreground. If the tool is a hybrid or dropdown tool, then the foreground should also contain a standard dropdown button.
|
901
|
+
# @param kind [Wx::RibbonButtonKind] The kind of tool to draw (normal, dropdown, or hybrid).
|
902
|
+
# @param state [Integer] A combination of {Wx::RibbonToolBarToolState} flags giving the state of the tool and it's relative position within a tool group.
|
903
|
+
# @return [void]
|
904
|
+
def draw_tool(dc, wnd, rect, bitmap, kind, state) end
|
905
|
+
|
906
|
+
# Draw toggle button on {Wx::RBN::RibbonBar}.
|
907
|
+
#
|
908
|
+
# This should draw a small toggle button at top right corner of ribbon bar.
|
909
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
910
|
+
# @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
911
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
912
|
+
# @param mode [Wx::RibbonDisplayMode] The {Wx::RBN::RibbonDisplayMode} which should be applied to display button
|
913
|
+
# @return [void]
|
914
|
+
def draw_toggle_button(dc, wnd, rect, mode) end
|
915
|
+
|
916
|
+
# Draw help button on {Wx::RBN::RibbonBar}.
|
917
|
+
#
|
918
|
+
# This should draw a help button at top right corner of ribbon bar.
|
919
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
920
|
+
# @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
921
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
922
|
+
# @return [void]
|
923
|
+
def draw_help_button(dc, wnd, rect) end
|
924
|
+
|
925
|
+
# Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
|
926
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
927
|
+
# @param wnd [Wx::Window] The window onto which the tab will eventually be drawn.
|
928
|
+
# @param label [String] The tab's label (or {Wx::EmptyString} if it has none).
|
929
|
+
# @param bitmap [Wx::Bitmap] The tab's icon (or {Wx::NULL_BITMAP} if it has none).
|
930
|
+
# @return [Array(Integer,Integer,Integer,Integer)]
|
931
|
+
def get_bar_tab_width(dc, wnd, label, bitmap) end
|
932
|
+
alias_method :bar_tab_width, :get_bar_tab_width
|
933
|
+
|
934
|
+
# Calculate the height (in pixels) of the tab region of a ribbon bar.
|
935
|
+
#
|
936
|
+
# Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
|
937
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
938
|
+
# @param wnd [Wx::Window] The window onto which the tabs will eventually be drawn.
|
939
|
+
# @param pages [Array<Wx::RBN::RibbonPageTabInfo>] The tabs which will acquire the returned height.
|
940
|
+
# @return [Integer]
|
941
|
+
def get_tab_ctrl_height(dc, wnd, pages) end
|
942
|
+
alias_method :tab_ctrl_height, :get_tab_ctrl_height
|
943
|
+
|
944
|
+
# Calculate the minimum size (in pixels) of a scroll button.
|
945
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
946
|
+
# @param wnd [Wx::Window] The window onto which the scroll button will eventually be drawn.
|
947
|
+
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, and a for flag (state flags may be given too, but should be ignored, as a button should retain a constant size, regardless of its state).
|
948
|
+
# @return [Wx::Size]
|
949
|
+
def get_scroll_button_minimum_size(dc, wnd, style) end
|
950
|
+
alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
|
951
|
+
|
952
|
+
# Calculate the size of a panel for a given client size.
|
953
|
+
#
|
954
|
+
# This should increment the given size by enough to fit the panel label and other chrome.
|
955
|
+
# @see Wx::RBN::RibbonArtProvider#get_panel_client_size
|
956
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
957
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
958
|
+
# @param client_size [Wx::Size] The client size.
|
959
|
+
# @param client_offset [Wx::Point] The offset where the client rectangle begins within the panel (may be NULL).
|
960
|
+
# @return [Wx::Size]
|
961
|
+
def get_panel_size(dc, wnd, client_size, client_offset) end
|
962
|
+
alias_method :panel_size, :get_panel_size
|
963
|
+
|
964
|
+
# Calculate the client size of a panel for a given overall size.
|
965
|
+
#
|
966
|
+
# This should act as the inverse to {Wx::RBN::RibbonArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
|
967
|
+
# @see Wx::RBN::RibbonArtProvider#get_panel_size
|
968
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
969
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
970
|
+
# @param size [Wx::Size] The overall size to calculate client size for.
|
971
|
+
# @param client_offset [Wx::Point] The offset where the returned client size begins within the given size (may be NULL).
|
972
|
+
# @return [Wx::Size]
|
973
|
+
def get_panel_client_size(dc, wnd, size, client_offset) end
|
974
|
+
alias_method :panel_client_size, :get_panel_client_size
|
975
|
+
|
976
|
+
# Calculate the position and size of the panel extension button.
|
977
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
978
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
979
|
+
# @param rect [Wx::Rect] The panel rectangle from which calculate extension button rectangle.
|
980
|
+
# @return [Wx::Rect]
|
981
|
+
def get_panel_ext_button_area(dc, wnd, rect) end
|
982
|
+
alias_method :panel_ext_button_area, :get_panel_ext_button_area
|
983
|
+
|
984
|
+
# Calculate the size of a {Wx::RBN::RibbonGallery} control for a given client size.
|
985
|
+
#
|
986
|
+
# This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.
|
987
|
+
# @see Wx::RBN::RibbonArtProvider#get_gallery_client_size
|
988
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
989
|
+
# @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
|
990
|
+
# @param client_size [Wx::Size] The client size.
|
991
|
+
# @return [Wx::Size]
|
992
|
+
def get_gallery_size(dc, wnd, client_size) end
|
993
|
+
alias_method :gallery_size, :get_gallery_size
|
994
|
+
|
995
|
+
# Calculate the client size of a {Wx::RBN::RibbonGallery} control for a given size.
|
996
|
+
#
|
997
|
+
# This should act as the inverse to {Wx::RBN::RibbonArtProvider#get_gallery_size}, and decrement the given size by enough to fit the gallery border, buttons, and other chrome.
|
998
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
999
|
+
# @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
|
1000
|
+
# @param size [Wx::Size] The overall size to calculate the client size for.
|
1001
|
+
# @param client_offset [Wx::Point] The position within the given size at which the returned client size begins.
|
1002
|
+
# @param scroll_up_button [Wx::Rect] The rectangle within the given size which the scroll up button occupies.
|
1003
|
+
# @param scroll_down_button [Wx::Rect] The rectangle within the given size which the scroll down button occupies.
|
1004
|
+
# @param extension_button [Wx::Rect] The rectangle within the given size which the extension button occupies.
|
1005
|
+
# @return [Wx::Size]
|
1006
|
+
def get_gallery_client_size(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) end
|
1007
|
+
alias_method :gallery_client_size, :get_gallery_client_size
|
1008
|
+
|
1009
|
+
# Calculate the portion of a page background which needs to be redrawn when a page is resized.
|
1010
|
+
#
|
1011
|
+
# To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.
|
1012
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1013
|
+
# @param wnd [Wx::RBN::RibbonPage] The page which is being resized.
|
1014
|
+
# @param page_old_size [Wx::Size] The size of the page prior to the resize (which has already been painted).
|
1015
|
+
# @param page_new_size [Wx::Size] The size of the page after the resize.
|
1016
|
+
# @return [Wx::Rect]
|
1017
|
+
def get_page_background_redraw_area(dc, wnd, page_old_size, page_new_size) end
|
1018
|
+
alias_method :page_background_redraw_area, :get_page_background_redraw_area
|
1019
|
+
|
1020
|
+
# Calculate the size of a button within a {Wx::RBN::RibbonButtonBar}.
|
1021
|
+
#
|
1022
|
+
# true if a size exists for the button, false otherwise.
|
1023
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1024
|
+
# @param wnd [Wx::Window] The window onto which the button will eventually be drawn (which is normally a {Wx::RBN::RibbonButtonBar}, though this is not guaranteed).
|
1025
|
+
# @param kind [Wx::RibbonButtonKind] The kind of button.
|
1026
|
+
# @param size [Wx::RibbonButtonBarButtonState] The size-class to calculate the size for. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}. If the requested size-class is not applicable, then false should be returned.
|
1027
|
+
# @param label [String] The label of the button.
|
1028
|
+
# @param text_min_width [Integer] The minimum width of the button label. Set this to 0 if it is not used.
|
1029
|
+
# @param bitmap_size_large [Wx::Size] The size of all "large" bitmaps on the button bar.
|
1030
|
+
# @param bitmap_size_small [Wx::Size] The size of all "small" bitmaps on the button bar.
|
1031
|
+
# @param button_size [Wx::Size] The size, in pixels, of the button.
|
1032
|
+
# @param normal_region [Wx::Rect] The region of the button which constitutes the normal button.
|
1033
|
+
# @param dropdown_region [Wx::Rect] The region of the button which constitutes the dropdown button.
|
1034
|
+
# @return [Boolean]
|
1035
|
+
def get_button_bar_button_size(dc, wnd, kind, size, label, text_min_width, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) end
|
1036
|
+
alias_method :button_bar_button_size, :get_button_bar_button_size
|
1037
|
+
|
1038
|
+
# Gets the width of the string if it is used as a {Wx::RBN::RibbonButtonBar} button label.
|
1039
|
+
#
|
1040
|
+
# Width of the given label text in pixel.
|
1041
|
+
#
|
1042
|
+
# <div class="wxrb-note">
|
1043
|
+
# <b>Note:</b>
|
1044
|
+
# <p>This function only works with single-line strings.
|
1045
|
+
# </p>
|
1046
|
+
# </div>
|
1047
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1048
|
+
# @param label [String] The string whose width shall be calculated.
|
1049
|
+
# @param kind [Wx::RibbonButtonKind] The kind of button.
|
1050
|
+
# @param size [Wx::RibbonButtonBarButtonState] The size-class to calculate the size for. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}. If the requested size-class is not applicable, then NULL should be returned.
|
1051
|
+
# @return [Integer]
|
1052
|
+
def get_button_bar_button_text_width(dc, label, kind, size) end
|
1053
|
+
alias_method :button_bar_button_text_width, :get_button_bar_button_text_width
|
1054
|
+
|
1055
|
+
# Calculate the size of a minimised ribbon panel.
|
1056
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1057
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question. Attributes like the panel label can be queried from this.
|
1058
|
+
# @param desired_bitmap_size [Wx::Size] Optional parameter which is filled with the size of the bitmap suitable for a minimised ribbon panel.
|
1059
|
+
# @return [Array(Wx::Size,Wx::Direction)]
|
1060
|
+
def get_minimised_panel_minimum_size(dc, wnd, desired_bitmap_size) end
|
1061
|
+
alias_method :minimised_panel_minimum_size, :get_minimised_panel_minimum_size
|
1062
|
+
|
1063
|
+
# Calculate the size of a tool within a {Wx::RBN::RibbonToolBar}.
|
1064
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1065
|
+
# @param wnd [Wx::Window] The window onto which the tool will eventually be drawn.
|
1066
|
+
# @param bitmap_size [Wx::Size] The size of the tool's foreground bitmap.
|
1067
|
+
# @param kind [Wx::RibbonButtonKind] The kind of tool (normal, dropdown, or hybrid).
|
1068
|
+
# @param is_first [Boolean] true if the tool is the first within its group. false otherwise.
|
1069
|
+
# @param is_last [Boolean] true if the tool is the last within its group. false otherwise.
|
1070
|
+
# @param dropdown_region [Wx::Rect] For dropdown and hybrid tools, the region within the returned size which counts as the dropdown part.
|
1071
|
+
# @return [Wx::Size]
|
1072
|
+
def get_tool_size(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) end
|
1073
|
+
alias_method :tool_size, :get_tool_size
|
1074
|
+
|
1075
|
+
# Calculate the position and size of the ribbon's toggle button.
|
1076
|
+
# @param rect [Wx::Rect] The ribbon bar rectangle from which calculate toggle button rectangle.
|
1077
|
+
# @return [Wx::Rect]
|
1078
|
+
def get_bar_toggle_button_area(rect) end
|
1079
|
+
alias_method :bar_toggle_button_area, :get_bar_toggle_button_area
|
1080
|
+
|
1081
|
+
# Calculate the position and size of the ribbon's help button.
|
1082
|
+
# @param rect [Wx::Rect] The ribbon bar rectangle from which calculate help button rectangle.
|
1083
|
+
# @return [Wx::Rect]
|
1084
|
+
def get_ribbon_help_button_area(rect) end
|
1085
|
+
alias_method :ribbon_help_button_area, :get_ribbon_help_button_area
|
1086
|
+
|
1087
|
+
end # RibbonArtProvider
|
1088
|
+
|
1089
|
+
#
|
1090
|
+
#
|
1091
|
+
#
|
1092
|
+
#
|
1093
|
+
#
|
1094
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
1095
|
+
# @wxrb_require USE_RIBBON
|
1096
|
+
class RibbonPageTabInfo < ::Object
|
1097
|
+
|
1098
|
+
end # RibbonPageTabInfo
|
1099
|
+
|
1100
|
+
#
|
1101
|
+
#
|
1102
|
+
#
|
1103
|
+
#
|
1104
|
+
#
|
1105
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
1106
|
+
# @wxrb_require USE_RIBBON
|
1107
|
+
class RibbonMSWArtProvider < RibbonArtProvider
|
1108
|
+
|
1109
|
+
# @param set_colour_scheme [Boolean]
|
1110
|
+
# @return [Wx::RBN::RibbonMSWArtProvider]
|
1111
|
+
def initialize(set_colour_scheme=true) end
|
1112
|
+
|
1113
|
+
# Create a new art provider which is a clone of this one.
|
1114
|
+
# @return [Wx::RBN::RibbonArtProvider]
|
1115
|
+
def clone; end
|
1116
|
+
|
1117
|
+
# Set the style flags.
|
1118
|
+
#
|
1119
|
+
# Normally called automatically by {Wx::RBN::RibbonBar#set_art_provider} with the ribbon bar's style flags, so that the art provider has the same flags as the bar which it is serving.
|
1120
|
+
# @param flags [Integer]
|
1121
|
+
# @return [void]
|
1122
|
+
def set_flags(flags) end
|
1123
|
+
alias_method :flags=, :set_flags
|
1124
|
+
|
1125
|
+
# Get the previously set style flags.
|
1126
|
+
# @return [Integer]
|
1127
|
+
def get_flags; end
|
1128
|
+
alias_method :flags, :get_flags
|
1129
|
+
|
1130
|
+
# Get the value of a certain integer setting.
|
1131
|
+
#
|
1132
|
+
# id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
|
1133
|
+
# @param id [Integer]
|
1134
|
+
# @return [Integer]
|
1135
|
+
def get_metric(id) end
|
1136
|
+
alias_method :metric, :get_metric
|
1137
|
+
|
1138
|
+
# Set the value of a certain integer setting to the value new_val.
|
1139
|
+
#
|
1140
|
+
# id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
|
1141
|
+
# @param id [Integer]
|
1142
|
+
# @param new_val [Integer]
|
1143
|
+
# @return [void]
|
1144
|
+
def set_metric(id, new_val) end
|
1145
|
+
|
1146
|
+
# Set the value of a certain font setting to the value font.
|
1147
|
+
#
|
1148
|
+
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
1149
|
+
# @param id [Integer]
|
1150
|
+
# @param font [Wx::Font,Wx::FontInfo]
|
1151
|
+
# @return [void]
|
1152
|
+
def set_font(id, font) end
|
1153
|
+
|
1154
|
+
# Get the value of a certain font setting.
|
1155
|
+
#
|
1156
|
+
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
1157
|
+
# @param id [Integer]
|
1158
|
+
# @return [Wx::Font]
|
1159
|
+
def get_font(id) end
|
1160
|
+
alias_method :font, :get_font
|
1161
|
+
|
1162
|
+
# Get the value of a certain colour setting.
|
1163
|
+
#
|
1164
|
+
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
|
1165
|
+
# @param id [Integer]
|
1166
|
+
# @return [Wx::Colour]
|
1167
|
+
def get_colour(id) end
|
1168
|
+
alias_method :colour, :get_colour
|
1169
|
+
|
1170
|
+
# Set the value of a certain colour setting to the value colour.
|
1171
|
+
#
|
1172
|
+
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
|
1173
|
+
# @see Wx::RBN::RibbonMSWArtProvider#set_colour_scheme
|
1174
|
+
# @param id [Integer]
|
1175
|
+
# @param colour [Wx::Colour,String,Symbol]
|
1176
|
+
# @return [void]
|
1177
|
+
def set_colour(id, colour) end
|
1178
|
+
|
1179
|
+
# Get the current colour scheme.
|
1180
|
+
#
|
1181
|
+
# Returns three colours such that if {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} were called with them, the colour scheme would be restored to what it was when {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} was last called. In practice, this usually means that the returned values are the three colours given in the last call to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}, however if {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} performs an idempotent operation upon the colours it is given (like clamping a component of the colour), then the returned values may not be the three colours given in the last call to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}. If {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} has not been called, then the returned values should result in a colour scheme similar to, if not identical to, the default colours of the art provider. Note that if {Wx::RBN::RibbonMSWArtProvider#set_colour} is called, then {Wx::RBN::RibbonMSWArtProvider#get_colour_scheme} does not try and return a colour scheme similar to colours being used - it's return values are dependent upon the last values given to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}, as described above.
|
1182
|
+
# @param primary [Wx::Colour] Pointer to a location to store the primary colour, or NULL.
|
1183
|
+
# @param secondary [Wx::Colour] Pointer to a location to store the secondary colour, or NULL.
|
1184
|
+
# @param tertiary [Wx::Colour] Pointer to a location to store the tertiary colour, or NULL.
|
1185
|
+
# @return [void]
|
1186
|
+
def get_colour_scheme(primary, secondary, tertiary) end
|
1187
|
+
alias_method :colour_scheme, :get_colour_scheme
|
1188
|
+
|
1189
|
+
# Set all applicable colour settings from a few base colours.
|
1190
|
+
#
|
1191
|
+
# Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
|
1192
|
+
# @see Wx::RBN::RibbonMSWArtProvider#set_colour
|
1193
|
+
#
|
1194
|
+
# @see Wx::RBN::RibbonMSWArtProvider#get_colour_scheme
|
1195
|
+
# @param primary [Wx::Colour,String,Symbol]
|
1196
|
+
# @param secondary [Wx::Colour,String,Symbol]
|
1197
|
+
# @param tertiary [Wx::Colour,String,Symbol]
|
1198
|
+
# @return [void]
|
1199
|
+
def set_colour_scheme(primary, secondary, tertiary) end
|
1200
|
+
|
1201
|
+
# Calculate the height (in pixels) of the tab region of a ribbon bar.
|
1202
|
+
#
|
1203
|
+
# Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
|
1204
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1205
|
+
# @param wnd [Wx::Window] The window onto which the tabs will eventually be drawn.
|
1206
|
+
# @param pages [Array<Wx::RBN::RibbonPageTabInfo>] The tabs which will acquire the returned height.
|
1207
|
+
# @return [Integer]
|
1208
|
+
def get_tab_ctrl_height(dc, wnd, pages) end
|
1209
|
+
alias_method :tab_ctrl_height, :get_tab_ctrl_height
|
1210
|
+
|
1211
|
+
# Draw the background of the tab region of a ribbon bar.
|
1212
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1213
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1214
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1215
|
+
# @return [void]
|
1216
|
+
def draw_tab_ctrl_background(dc, wnd, rect) end
|
1217
|
+
|
1218
|
+
# Draw a single tab in the tab region of a ribbon bar.
|
1219
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1220
|
+
# @param wnd [Wx::Window] The window which is being drawn onto (not the {Wx::RBN::RibbonPage} associated with the tab being drawn).
|
1221
|
+
# @param tab [Wx::RBN::RibbonPageTabInfo] The rectangle within which to draw, and also the tab label, icon, and state (active and/or hovered). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tab_ctrl_background}. The rectangle's width will be at least the minimum value returned by {Wx::RBN::RibbonMSWArtProvider#get_bar_tab_width}, and height will be the value returned by {Wx::RBN::RibbonMSWArtProvider#get_tab_ctrl_height}.
|
1222
|
+
# @return [void]
|
1223
|
+
def draw_tab(dc, wnd, tab) end
|
1224
|
+
|
1225
|
+
# Draw a separator between two tabs in a ribbon bar.
|
1226
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1227
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1228
|
+
# @param rect [Wx::Rect] The rectangle within which to draw, which will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tab_ctrl_background}.
|
1229
|
+
# @param visibility [Float] The opacity with which to draw the separator. Values are in the range [0, 1], with 0 being totally transparent, and 1 being totally opaque.
|
1230
|
+
# @return [void]
|
1231
|
+
def draw_tab_separator(dc, wnd, rect, visibility) end
|
1232
|
+
|
1233
|
+
# Draw the background of a ribbon page.
|
1234
|
+
#
|
1235
|
+
#
|
1236
|
+
# @see Wx::RBN::RibbonMSWArtProvider#get_page_background_redraw_area
|
1237
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1238
|
+
# @param wnd [Wx::Window] The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
|
1239
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1240
|
+
# @return [void]
|
1241
|
+
def draw_page_background(dc, wnd, rect) end
|
1242
|
+
|
1243
|
+
# Draw a ribbon-style scroll button.
|
1244
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1245
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1246
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be at least the size returned by {Wx::RBN::RibbonMSWArtProvider#get_scroll_button_minimum_size} for a scroll button with the same style. For tab scroll buttons, this rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tab_ctrl_background}, but this is not guaranteed for other types of button (for example, page scroll buttons will not be painted on an area previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_page_background}).
|
1247
|
+
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, a for flag, and one or more states.
|
1248
|
+
# @return [void]
|
1249
|
+
def draw_scroll_button(dc, wnd, rect, style) end
|
1250
|
+
|
1251
|
+
# Draw the background and chrome for a ribbon panel.
|
1252
|
+
#
|
1253
|
+
# This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
|
1254
|
+
# Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonMSWArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
|
1255
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1256
|
+
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
1257
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1258
|
+
# @return [void]
|
1259
|
+
def draw_panel_background(dc, wnd, rect) end
|
1260
|
+
|
1261
|
+
# Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
|
1262
|
+
#
|
1263
|
+
# This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
|
1264
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1265
|
+
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
|
1266
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is the entire area of the gallery control, not just the client rectangle.
|
1267
|
+
# @return [void]
|
1268
|
+
def draw_gallery_background(dc, wnd, rect) end
|
1269
|
+
|
1270
|
+
# Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
|
1271
|
+
#
|
1272
|
+
# This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonMSWArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonMSWArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
|
1273
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1274
|
+
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery which contains the item being drawn.
|
1275
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be the size of the item's bitmap, expanded by gallery item padding values ({Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE}, and {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE}). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_gallery_background}.
|
1276
|
+
# @param item [Integer] The item whose background is being painted. Typically the background will vary if the item is hovered, active, or selected; {Wx::RBN::RibbonGallery#get_selection}, {Wx::RBN::RibbonGallery#get_active_item}, and {Wx::RBN::RibbonGallery#get_hovered_item} can be called to test if the given item is in one of these states.
|
1277
|
+
# @return [void]
|
1278
|
+
def draw_gallery_item_background(dc, wnd, rect, item) end
|
1279
|
+
|
1280
|
+
# Draw a minimised ribbon panel.
|
1281
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1282
|
+
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel which is minimised. The panel label can be obtained from this window. The minimised icon obtained from querying the window may not be the size requested by {Wx::RBN::RibbonMSWArtProvider#get_minimised_panel_minimum_size} - the bitmap argument contains the icon in the requested size.
|
1283
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of the rectangle will be at least the size returned by {Wx::RBN::RibbonMSWArtProvider#get_minimised_panel_minimum_size}.
|
1284
|
+
# @param bitmap [Wx::Bitmap] A copy of the panel's minimised bitmap rescaled to the size returned by {Wx::RBN::RibbonMSWArtProvider#get_minimised_panel_minimum_size}.
|
1285
|
+
# @return [void]
|
1286
|
+
def draw_minimised_panel(dc, wnd, rect, bitmap) end
|
1287
|
+
|
1288
|
+
# Draw the background for a {Wx::RBN::RibbonButtonBar} control.
|
1289
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1290
|
+
# @param wnd [Wx::Window] The window which is being drawn onto (which will typically be the button bar itself, though this is not guaranteed).
|
1291
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1292
|
+
# @return [void]
|
1293
|
+
def draw_button_bar_background(dc, wnd, rect) end
|
1294
|
+
|
1295
|
+
# Draw a single button for a {Wx::RBN::RibbonButtonBar} control.
|
1296
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1297
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1298
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be a size previously returned by {Wx::RBN::RibbonMSWArtProvider#get_button_bar_button_size}, and the rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_button_bar_background}.
|
1299
|
+
# @param kind [Wx::RibbonButtonKind] The kind of button to draw (normal, dropdown or hybrid).
|
1300
|
+
# @param state [Integer] Combination of a size flag and state flags from the {Wx::RBN::RibbonButtonBarButtonState} enumeration.
|
1301
|
+
# @param label [String] The label of the button.
|
1302
|
+
# @param bitmap_large [Wx::Bitmap] The large bitmap of the button (or the large disabled bitmap when {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_DISABLED} is set in state).
|
1303
|
+
# @param bitmap_small [Wx::Bitmap] The small bitmap of the button (or the small disabled bitmap when {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_DISABLED} is set in state).
|
1304
|
+
# @return [void]
|
1305
|
+
def draw_button_bar_button(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) end
|
1306
|
+
|
1307
|
+
# Draw the background for a {Wx::RBN::RibbonToolBar} control.
|
1308
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1309
|
+
# @param wnd [Wx::Window] The which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1310
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. Some of this rectangle will later be drawn over using {Wx::RBN::RibbonMSWArtProvider#draw_tool_group_background} and {Wx::RBN::RibbonMSWArtProvider#draw_tool}, but not all of it will (unless there is only a single group of tools).
|
1311
|
+
# @return [void]
|
1312
|
+
def draw_tool_bar_background(dc, wnd, rect) end
|
1313
|
+
|
1314
|
+
# Draw the background for a group of tools on a {Wx::RBN::RibbonToolBar} control.
|
1315
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1316
|
+
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1317
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is a union of the individual tools' rectangles. As there are no gaps between tools, this rectangle will be painted over exactly once by calls to {Wx::RBN::RibbonMSWArtProvider#draw_tool}. The group background could therefore be painted by {Wx::RBN::RibbonMSWArtProvider#draw_tool}, though it can be conceptually easier and more efficient to draw it all at once here. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tool_bar_background}.
|
1318
|
+
# @return [void]
|
1319
|
+
def draw_tool_group_background(dc, wnd, rect) end
|
1320
|
+
|
1321
|
+
# Draw a single tool (for a {Wx::RBN::RibbonToolBar} control).
|
1322
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1323
|
+
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1324
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will at least the size returned by {Wx::RBN::RibbonMSWArtProvider#get_tool_size}, and the height of it will be equal for all tools within the same group. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonMSWArtProvider#draw_tool_group_background}.
|
1325
|
+
# @param bitmap [Wx::Bitmap] The bitmap to use as the tool's foreground. If the tool is a hybrid or dropdown tool, then the foreground should also contain a standard dropdown button.
|
1326
|
+
# @param kind [Wx::RibbonButtonKind] The kind of tool to draw (normal, dropdown, or hybrid).
|
1327
|
+
# @param state [Integer] A combination of {Wx::RibbonToolBarToolState} flags giving the state of the tool and it's relative position within a tool group.
|
1328
|
+
# @return [void]
|
1329
|
+
def draw_tool(dc, wnd, rect, bitmap, kind, state) end
|
1330
|
+
|
1331
|
+
# Draw toggle button on {Wx::RBN::RibbonBar}.
|
1332
|
+
#
|
1333
|
+
# This should draw a small toggle button at top right corner of ribbon bar.
|
1334
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1335
|
+
# @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
1336
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1337
|
+
# @param mode [Wx::RibbonDisplayMode] The {Wx::RBN::RibbonDisplayMode} which should be applied to display button
|
1338
|
+
# @return [void]
|
1339
|
+
def draw_toggle_button(dc, wnd, rect, mode) end
|
1340
|
+
|
1341
|
+
# Draw help button on {Wx::RBN::RibbonBar}.
|
1342
|
+
#
|
1343
|
+
# This should draw a help button at top right corner of ribbon bar.
|
1344
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1345
|
+
# @param wnd [Wx::RBN::RibbonBar] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
1346
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1347
|
+
# @return [void]
|
1348
|
+
def draw_help_button(dc, wnd, rect) end
|
1349
|
+
|
1350
|
+
# Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
|
1351
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1352
|
+
# @param wnd [Wx::Window] The window onto which the tab will eventually be drawn.
|
1353
|
+
# @param label [String] The tab's label (or {Wx::EmptyString} if it has none).
|
1354
|
+
# @param bitmap [Wx::Bitmap] The tab's icon (or {Wx::NULL_BITMAP} if it has none).
|
1355
|
+
# @return [Array(Integer,Integer,Integer,Integer)]
|
1356
|
+
def get_bar_tab_width(dc, wnd, label, bitmap) end
|
1357
|
+
alias_method :bar_tab_width, :get_bar_tab_width
|
1358
|
+
|
1359
|
+
# Calculate the minimum size (in pixels) of a scroll button.
|
1360
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1361
|
+
# @param wnd [Wx::Window] The window onto which the scroll button will eventually be drawn.
|
1362
|
+
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, and a for flag (state flags may be given too, but should be ignored, as a button should retain a constant size, regardless of its state).
|
1363
|
+
# @return [Wx::Size]
|
1364
|
+
def get_scroll_button_minimum_size(dc, wnd, style) end
|
1365
|
+
alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
|
1366
|
+
|
1367
|
+
# Calculate the size of a panel for a given client size.
|
1368
|
+
#
|
1369
|
+
# This should increment the given size by enough to fit the panel label and other chrome.
|
1370
|
+
# @see Wx::RBN::RibbonMSWArtProvider#get_panel_client_size
|
1371
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1372
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1373
|
+
# @param client_size [Wx::Size] The client size.
|
1374
|
+
# @param client_offset [Wx::Point] The offset where the client rectangle begins within the panel (may be NULL).
|
1375
|
+
# @return [Wx::Size]
|
1376
|
+
def get_panel_size(dc, wnd, client_size, client_offset) end
|
1377
|
+
alias_method :panel_size, :get_panel_size
|
1378
|
+
|
1379
|
+
# Calculate the client size of a panel for a given overall size.
|
1380
|
+
#
|
1381
|
+
# This should act as the inverse to {Wx::RBN::RibbonMSWArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
|
1382
|
+
# @see Wx::RBN::RibbonMSWArtProvider#get_panel_size
|
1383
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1384
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1385
|
+
# @param size [Wx::Size] The overall size to calculate client size for.
|
1386
|
+
# @param client_offset [Wx::Point] The offset where the returned client size begins within the given size (may be NULL).
|
1387
|
+
# @return [Wx::Size]
|
1388
|
+
def get_panel_client_size(dc, wnd, size, client_offset) end
|
1389
|
+
alias_method :panel_client_size, :get_panel_client_size
|
1390
|
+
|
1391
|
+
# Calculate the position and size of the panel extension button.
|
1392
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1393
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1394
|
+
# @param rect [Wx::Rect] The panel rectangle from which calculate extension button rectangle.
|
1395
|
+
# @return [Wx::Rect]
|
1396
|
+
def get_panel_ext_button_area(dc, wnd, rect) end
|
1397
|
+
alias_method :panel_ext_button_area, :get_panel_ext_button_area
|
1398
|
+
|
1399
|
+
# Calculate the size of a {Wx::RBN::RibbonGallery} control for a given client size.
|
1400
|
+
#
|
1401
|
+
# This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.
|
1402
|
+
# @see Wx::RBN::RibbonMSWArtProvider#get_gallery_client_size
|
1403
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1404
|
+
# @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
|
1405
|
+
# @param client_size [Wx::Size] The client size.
|
1406
|
+
# @return [Wx::Size]
|
1407
|
+
def get_gallery_size(dc, wnd, client_size) end
|
1408
|
+
alias_method :gallery_size, :get_gallery_size
|
1409
|
+
|
1410
|
+
# Calculate the client size of a {Wx::RBN::RibbonGallery} control for a given size.
|
1411
|
+
#
|
1412
|
+
# This should act as the inverse to {Wx::RBN::RibbonMSWArtProvider#get_gallery_size}, and decrement the given size by enough to fit the gallery border, buttons, and other chrome.
|
1413
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1414
|
+
# @param wnd [Wx::RBN::RibbonGallery] The gallery in question.
|
1415
|
+
# @param size [Wx::Size] The overall size to calculate the client size for.
|
1416
|
+
# @param client_offset [Wx::Point] The position within the given size at which the returned client size begins.
|
1417
|
+
# @param scroll_up_button [Wx::Rect] The rectangle within the given size which the scroll up button occupies.
|
1418
|
+
# @param scroll_down_button [Wx::Rect] The rectangle within the given size which the scroll down button occupies.
|
1419
|
+
# @param extension_button [Wx::Rect] The rectangle within the given size which the extension button occupies.
|
1420
|
+
# @return [Wx::Size]
|
1421
|
+
def get_gallery_client_size(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) end
|
1422
|
+
alias_method :gallery_client_size, :get_gallery_client_size
|
1423
|
+
|
1424
|
+
# Calculate the portion of a page background which needs to be redrawn when a page is resized.
|
1425
|
+
#
|
1426
|
+
# To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.
|
1427
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1428
|
+
# @param wnd [Wx::RBN::RibbonPage] The page which is being resized.
|
1429
|
+
# @param page_old_size [Wx::Size] The size of the page prior to the resize (which has already been painted).
|
1430
|
+
# @param page_new_size [Wx::Size] The size of the page after the resize.
|
1431
|
+
# @return [Wx::Rect]
|
1432
|
+
def get_page_background_redraw_area(dc, wnd, page_old_size, page_new_size) end
|
1433
|
+
alias_method :page_background_redraw_area, :get_page_background_redraw_area
|
1434
|
+
|
1435
|
+
# Calculate the size of a button within a {Wx::RBN::RibbonButtonBar}.
|
1436
|
+
#
|
1437
|
+
# true if a size exists for the button, false otherwise.
|
1438
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1439
|
+
# @param wnd [Wx::Window] The window onto which the button will eventually be drawn (which is normally a {Wx::RBN::RibbonButtonBar}, though this is not guaranteed).
|
1440
|
+
# @param kind [Wx::RibbonButtonKind] The kind of button.
|
1441
|
+
# @param size [Wx::RibbonButtonBarButtonState] The size-class to calculate the size for. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}. If the requested size-class is not applicable, then false should be returned.
|
1442
|
+
# @param label [String] The label of the button.
|
1443
|
+
# @param text_min_width [Integer] The minimum width of the button label. Set this to 0 if it is not used.
|
1444
|
+
# @param bitmap_size_large [Wx::Size] The size of all "large" bitmaps on the button bar.
|
1445
|
+
# @param bitmap_size_small [Wx::Size] The size of all "small" bitmaps on the button bar.
|
1446
|
+
# @param button_size [Wx::Size] The size, in pixels, of the button.
|
1447
|
+
# @param normal_region [Wx::Rect] The region of the button which constitutes the normal button.
|
1448
|
+
# @param dropdown_region [Wx::Rect] The region of the button which constitutes the dropdown button.
|
1449
|
+
# @return [Boolean]
|
1450
|
+
def get_button_bar_button_size(dc, wnd, kind, size, label, text_min_width, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) end
|
1451
|
+
alias_method :button_bar_button_size, :get_button_bar_button_size
|
1452
|
+
|
1453
|
+
# Gets the width of the string if it is used as a {Wx::RBN::RibbonButtonBar} button label.
|
1454
|
+
#
|
1455
|
+
# Width of the given label text in pixel.
|
1456
|
+
#
|
1457
|
+
# <div class="wxrb-note">
|
1458
|
+
# <b>Note:</b>
|
1459
|
+
# <p>This function only works with single-line strings.
|
1460
|
+
# </p>
|
1461
|
+
# </div>
|
1462
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1463
|
+
# @param label [String] The string whose width shall be calculated.
|
1464
|
+
# @param kind [Wx::RibbonButtonKind] The kind of button.
|
1465
|
+
# @param size [Wx::RibbonButtonBarButtonState] The size-class to calculate the size for. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}. If the requested size-class is not applicable, then NULL should be returned.
|
1466
|
+
# @return [Integer]
|
1467
|
+
def get_button_bar_button_text_width(dc, label, kind, size) end
|
1468
|
+
alias_method :button_bar_button_text_width, :get_button_bar_button_text_width
|
1469
|
+
|
1470
|
+
# Calculate the size of a minimised ribbon panel.
|
1471
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1472
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question. Attributes like the panel label can be queried from this.
|
1473
|
+
# @param desired_bitmap_size [Wx::Size] Optional parameter which is filled with the size of the bitmap suitable for a minimised ribbon panel.
|
1474
|
+
# @return [Array(Wx::Size,Wx::Direction)]
|
1475
|
+
def get_minimised_panel_minimum_size(dc, wnd, desired_bitmap_size) end
|
1476
|
+
alias_method :minimised_panel_minimum_size, :get_minimised_panel_minimum_size
|
1477
|
+
|
1478
|
+
# Calculate the size of a tool within a {Wx::RBN::RibbonToolBar}.
|
1479
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1480
|
+
# @param wnd [Wx::Window] The window onto which the tool will eventually be drawn.
|
1481
|
+
# @param bitmap_size [Wx::Size] The size of the tool's foreground bitmap.
|
1482
|
+
# @param kind [Wx::RibbonButtonKind] The kind of tool (normal, dropdown, or hybrid).
|
1483
|
+
# @param is_first [Boolean] true if the tool is the first within its group. false otherwise.
|
1484
|
+
# @param is_last [Boolean] true if the tool is the last within its group. false otherwise.
|
1485
|
+
# @param dropdown_region [Wx::Rect] For dropdown and hybrid tools, the region within the returned size which counts as the dropdown part.
|
1486
|
+
# @return [Wx::Size]
|
1487
|
+
def get_tool_size(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) end
|
1488
|
+
alias_method :tool_size, :get_tool_size
|
1489
|
+
|
1490
|
+
# Calculate the position and size of the ribbon's toggle button.
|
1491
|
+
# @param rect [Wx::Rect] The ribbon bar rectangle from which calculate toggle button rectangle.
|
1492
|
+
# @return [Wx::Rect]
|
1493
|
+
def get_bar_toggle_button_area(rect) end
|
1494
|
+
alias_method :bar_toggle_button_area, :get_bar_toggle_button_area
|
1495
|
+
|
1496
|
+
# Calculate the position and size of the ribbon's help button.
|
1497
|
+
# @param rect [Wx::Rect] The ribbon bar rectangle from which calculate help button rectangle.
|
1498
|
+
# @return [Wx::Rect]
|
1499
|
+
def get_ribbon_help_button_area(rect) end
|
1500
|
+
alias_method :ribbon_help_button_area, :get_ribbon_help_button_area
|
1501
|
+
|
1502
|
+
end # RibbonMSWArtProvider
|
1503
|
+
|
1504
|
+
#
|
1505
|
+
#
|
1506
|
+
#
|
1507
|
+
#
|
1508
|
+
#
|
1509
|
+
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
1510
|
+
# @wxrb_require USE_RIBBON
|
1511
|
+
class RibbonAUIArtProvider < RibbonMSWArtProvider
|
1512
|
+
|
1513
|
+
# @return [Wx::RBN::RibbonAUIArtProvider]
|
1514
|
+
def initialize; end
|
1515
|
+
|
1516
|
+
# Create a new art provider which is a clone of this one.
|
1517
|
+
# @return [Wx::RBN::RibbonArtProvider]
|
1518
|
+
def clone; end
|
1519
|
+
|
1520
|
+
# Get the value of a certain colour setting.
|
1521
|
+
#
|
1522
|
+
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
|
1523
|
+
# @param id [Integer]
|
1524
|
+
# @return [Wx::Colour]
|
1525
|
+
def get_colour(id) end
|
1526
|
+
alias_method :colour, :get_colour
|
1527
|
+
|
1528
|
+
# Set the value of a certain colour setting to the value colour.
|
1529
|
+
#
|
1530
|
+
# id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
|
1531
|
+
# @see Wx::RBN::RibbonAUIArtProvider#set_colour_scheme
|
1532
|
+
# @param id [Integer]
|
1533
|
+
# @param colour [Wx::Colour,String,Symbol]
|
1534
|
+
# @return [void]
|
1535
|
+
def set_colour(id, colour) end
|
1536
|
+
|
1537
|
+
# Set all applicable colour settings from a few base colours.
|
1538
|
+
#
|
1539
|
+
# Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
|
1540
|
+
# @see Wx::RBN::RibbonAUIArtProvider#set_colour
|
1541
|
+
#
|
1542
|
+
# @see Wx::RBN::RibbonAUIArtProvider#get_colour_scheme
|
1543
|
+
# @param primary [Wx::Colour,String,Symbol]
|
1544
|
+
# @param secondary [Wx::Colour,String,Symbol]
|
1545
|
+
# @param tertiary [Wx::Colour,String,Symbol]
|
1546
|
+
# @return [void]
|
1547
|
+
def set_colour_scheme(primary, secondary, tertiary) end
|
1548
|
+
|
1549
|
+
# Set the value of a certain font setting to the value font.
|
1550
|
+
#
|
1551
|
+
# id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
|
1552
|
+
# @param id [Integer]
|
1553
|
+
# @param font [Wx::Font,Wx::FontInfo]
|
1554
|
+
# @return [void]
|
1555
|
+
def set_font(id, font) end
|
1556
|
+
|
1557
|
+
# Calculate the minimum size (in pixels) of a scroll button.
|
1558
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1559
|
+
# @param wnd [Wx::Window] The window onto which the scroll button will eventually be drawn.
|
1560
|
+
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, and a for flag (state flags may be given too, but should be ignored, as a button should retain a constant size, regardless of its state).
|
1561
|
+
# @return [Wx::Size]
|
1562
|
+
def get_scroll_button_minimum_size(dc, wnd, style) end
|
1563
|
+
alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
|
1564
|
+
|
1565
|
+
# Draw a ribbon-style scroll button.
|
1566
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1567
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1568
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be at least the size returned by {Wx::RBN::RibbonAUIArtProvider#get_scroll_button_minimum_size} for a scroll button with the same style. For tab scroll buttons, this rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tab_ctrl_background}, but this is not guaranteed for other types of button (for example, page scroll buttons will not be painted on an area previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_page_background}).
|
1569
|
+
# @param style [Integer] A combination of flags from {Wx::RBN::RibbonScrollButtonStyle}, including a direction, a for flag, and one or more states.
|
1570
|
+
# @return [void]
|
1571
|
+
def draw_scroll_button(dc, wnd, rect, style) end
|
1572
|
+
|
1573
|
+
# Calculate the size of a panel for a given client size.
|
1574
|
+
#
|
1575
|
+
# This should increment the given size by enough to fit the panel label and other chrome.
|
1576
|
+
# @see Wx::RBN::RibbonAUIArtProvider#get_panel_client_size
|
1577
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1578
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1579
|
+
# @param client_size [Wx::Size] The client size.
|
1580
|
+
# @param client_offset [Wx::Point] The offset where the client rectangle begins within the panel (may be NULL).
|
1581
|
+
# @return [Wx::Size]
|
1582
|
+
def get_panel_size(dc, wnd, client_size, client_offset) end
|
1583
|
+
alias_method :panel_size, :get_panel_size
|
1584
|
+
|
1585
|
+
# Calculate the client size of a panel for a given overall size.
|
1586
|
+
#
|
1587
|
+
# This should act as the inverse to {Wx::RBN::RibbonAUIArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
|
1588
|
+
# @see Wx::RBN::RibbonAUIArtProvider#get_panel_size
|
1589
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1590
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1591
|
+
# @param size [Wx::Size] The overall size to calculate client size for.
|
1592
|
+
# @param client_offset [Wx::Point] The offset where the returned client size begins within the given size (may be NULL).
|
1593
|
+
# @return [Wx::Size]
|
1594
|
+
def get_panel_client_size(dc, wnd, size, client_offset) end
|
1595
|
+
alias_method :panel_client_size, :get_panel_client_size
|
1596
|
+
|
1597
|
+
# Calculate the position and size of the panel extension button.
|
1598
|
+
# @param dc [Wx::DC] A device context to use if one is required for size calculations.
|
1599
|
+
# @param wnd [Wx::RBN::RibbonPanel] The ribbon panel in question.
|
1600
|
+
# @param rect [Wx::Rect] The panel rectangle from which calculate extension button rectangle.
|
1601
|
+
# @return [Wx::Rect]
|
1602
|
+
def get_panel_ext_button_area(dc, wnd, rect) end
|
1603
|
+
alias_method :panel_ext_button_area, :get_panel_ext_button_area
|
1604
|
+
|
1605
|
+
# Draw the background of the tab region of a ribbon bar.
|
1606
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1607
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1608
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1609
|
+
# @return [void]
|
1610
|
+
def draw_tab_ctrl_background(dc, wnd, rect) end
|
1611
|
+
|
1612
|
+
# Calculate the height (in pixels) of the tab region of a ribbon bar.
|
1613
|
+
#
|
1614
|
+
# Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
|
1615
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1616
|
+
# @param wnd [Wx::Window] The window onto which the tabs will eventually be drawn.
|
1617
|
+
# @param pages [Array<Wx::RBN::RibbonPageTabInfo>] The tabs which will acquire the returned height.
|
1618
|
+
# @return [Integer]
|
1619
|
+
def get_tab_ctrl_height(dc, wnd, pages) end
|
1620
|
+
alias_method :tab_ctrl_height, :get_tab_ctrl_height
|
1621
|
+
|
1622
|
+
# Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
|
1623
|
+
# @param dc [Wx::DC] A device context to use when one is required for size calculations.
|
1624
|
+
# @param wnd [Wx::Window] The window onto which the tab will eventually be drawn.
|
1625
|
+
# @param label [String] The tab's label (or {Wx::EmptyString} if it has none).
|
1626
|
+
# @param bitmap [Wx::Bitmap] The tab's icon (or {Wx::NULL_BITMAP} if it has none).
|
1627
|
+
# @return [Array(Integer,Integer,Integer,Integer)]
|
1628
|
+
def get_bar_tab_width(dc, wnd, label, bitmap) end
|
1629
|
+
alias_method :bar_tab_width, :get_bar_tab_width
|
1630
|
+
|
1631
|
+
# Draw a single tab in the tab region of a ribbon bar.
|
1632
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1633
|
+
# @param wnd [Wx::Window] The window which is being drawn onto (not the {Wx::RBN::RibbonPage} associated with the tab being drawn).
|
1634
|
+
# @param tab [Wx::RBN::RibbonPageTabInfo] The rectangle within which to draw, and also the tab label, icon, and state (active and/or hovered). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tab_ctrl_background}. The rectangle's width will be at least the minimum value returned by {Wx::RBN::RibbonAUIArtProvider#get_bar_tab_width}, and height will be the value returned by {Wx::RBN::RibbonAUIArtProvider#get_tab_ctrl_height}.
|
1635
|
+
# @return [void]
|
1636
|
+
def draw_tab(dc, wnd, tab) end
|
1637
|
+
|
1638
|
+
# Draw a separator between two tabs in a ribbon bar.
|
1639
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1640
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1641
|
+
# @param rect [Wx::Rect] The rectangle within which to draw, which will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tab_ctrl_background}.
|
1642
|
+
# @param visibility [Float] The opacity with which to draw the separator. Values are in the range [0, 1], with 0 being totally transparent, and 1 being totally opaque.
|
1643
|
+
# @return [void]
|
1644
|
+
def draw_tab_separator(dc, wnd, rect, visibility) end
|
1645
|
+
|
1646
|
+
# Draw the background of a ribbon page.
|
1647
|
+
#
|
1648
|
+
#
|
1649
|
+
# @see Wx::GetPageBackgroundRedrawArea
|
1650
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1651
|
+
# @param wnd [Wx::Window] The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
|
1652
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1653
|
+
# @return [void]
|
1654
|
+
def draw_page_background(dc, wnd, rect) end
|
1655
|
+
|
1656
|
+
# Draw the background and chrome for a ribbon panel.
|
1657
|
+
#
|
1658
|
+
# This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
|
1659
|
+
# Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonAUIArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
|
1660
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1661
|
+
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
|
1662
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1663
|
+
# @return [void]
|
1664
|
+
def draw_panel_background(dc, wnd, rect) end
|
1665
|
+
|
1666
|
+
# Draw a minimised ribbon panel.
|
1667
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1668
|
+
# @param wnd [Wx::RBN::RibbonPanel] The window which is being drawn onto, which is always the panel which is minimised. The panel label can be obtained from this window. The minimised icon obtained from querying the window may not be the size requested by {Wx::RBN::RibbonAUIArtProvider#get_minimised_panel_minimum_size} - the bitmap argument contains the icon in the requested size.
|
1669
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of the rectangle will be at least the size returned by {Wx::RBN::RibbonAUIArtProvider#get_minimised_panel_minimum_size}.
|
1670
|
+
# @param bitmap [Wx::Bitmap] A copy of the panel's minimised bitmap rescaled to the size returned by {Wx::RBN::RibbonAUIArtProvider#get_minimised_panel_minimum_size}.
|
1671
|
+
# @return [void]
|
1672
|
+
def draw_minimised_panel(dc, wnd, rect, bitmap) end
|
1673
|
+
|
1674
|
+
# Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
|
1675
|
+
#
|
1676
|
+
# This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
|
1677
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1678
|
+
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
|
1679
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is the entire area of the gallery control, not just the client rectangle.
|
1680
|
+
# @return [void]
|
1681
|
+
def draw_gallery_background(dc, wnd, rect) end
|
1682
|
+
|
1683
|
+
# Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
|
1684
|
+
#
|
1685
|
+
# This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonAUIArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonAUIArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
|
1686
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1687
|
+
# @param wnd [Wx::RBN::RibbonGallery] The window which is being drawn onto, which is always the gallery which contains the item being drawn.
|
1688
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be the size of the item's bitmap, expanded by gallery item padding values ({Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE}, {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE}, and {Wx::RBN::RibbonArtSetting::RIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE}). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_gallery_background}.
|
1689
|
+
# @param item [Integer] The item whose background is being painted. Typically the background will vary if the item is hovered, active, or selected; {Wx::RBN::RibbonGallery#get_selection}, {Wx::RBN::RibbonGallery#get_active_item}, and {Wx::RBN::RibbonGallery#get_hovered_item} can be called to test if the given item is in one of these states.
|
1690
|
+
# @return [void]
|
1691
|
+
def draw_gallery_item_background(dc, wnd, rect, item) end
|
1692
|
+
|
1693
|
+
# Draw the background for a {Wx::RBN::RibbonButtonBar} control.
|
1694
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1695
|
+
# @param wnd [Wx::Window] The window which is being drawn onto (which will typically be the button bar itself, though this is not guaranteed).
|
1696
|
+
# @param rect [Wx::Rect] The rectangle within which to draw.
|
1697
|
+
# @return [void]
|
1698
|
+
def draw_button_bar_background(dc, wnd, rect) end
|
1699
|
+
|
1700
|
+
# Draw a single button for a {Wx::RBN::RibbonButtonBar} control.
|
1701
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1702
|
+
# @param wnd [Wx::Window] The window which is being drawn onto.
|
1703
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will be a size previously returned by {Wx::RBN::RibbonAUIArtProvider#get_button_bar_button_size}, and the rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_button_bar_background}.
|
1704
|
+
# @param kind [Wx::RibbonButtonKind] The kind of button to draw (normal, dropdown or hybrid).
|
1705
|
+
# @param state [Integer] Combination of a size flag and state flags from the {Wx::RBN::RibbonButtonBarButtonState} enumeration.
|
1706
|
+
# @param label [String] The label of the button.
|
1707
|
+
# @param bitmap_large [Wx::Bitmap] The large bitmap of the button (or the large disabled bitmap when {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_DISABLED} is set in state).
|
1708
|
+
# @param bitmap_small [Wx::Bitmap] The small bitmap of the button (or the small disabled bitmap when {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_DISABLED} is set in state).
|
1709
|
+
# @return [void]
|
1710
|
+
def draw_button_bar_button(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) end
|
1711
|
+
|
1712
|
+
# Draw the background for a {Wx::RBN::RibbonToolBar} control.
|
1713
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1714
|
+
# @param wnd [Wx::Window] The which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1715
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. Some of this rectangle will later be drawn over using {Wx::RBN::RibbonAUIArtProvider#draw_tool_group_background} and {Wx::RBN::RibbonAUIArtProvider#draw_tool}, but not all of it will (unless there is only a single group of tools).
|
1716
|
+
# @return [void]
|
1717
|
+
def draw_tool_bar_background(dc, wnd, rect) end
|
1718
|
+
|
1719
|
+
# Draw the background for a group of tools on a {Wx::RBN::RibbonToolBar} control.
|
1720
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1721
|
+
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1722
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is a union of the individual tools' rectangles. As there are no gaps between tools, this rectangle will be painted over exactly once by calls to {Wx::RBN::RibbonAUIArtProvider#draw_tool}. The group background could therefore be painted by {Wx::RBN::RibbonAUIArtProvider#draw_tool}, though it can be conceptually easier and more efficient to draw it all at once here. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tool_bar_background}.
|
1723
|
+
# @return [void]
|
1724
|
+
def draw_tool_group_background(dc, wnd, rect) end
|
1725
|
+
|
1726
|
+
# Draw a single tool (for a {Wx::RBN::RibbonToolBar} control).
|
1727
|
+
# @param dc [Wx::DC] The device context to draw onto.
|
1728
|
+
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1729
|
+
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will at least the size returned by {Wx::RBN::RibbonAUIArtProvider#get_tool_size}, and the height of it will be equal for all tools within the same group. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tool_group_background}.
|
1730
|
+
# @param bitmap [Wx::Bitmap] The bitmap to use as the tool's foreground. If the tool is a hybrid or dropdown tool, then the foreground should also contain a standard dropdown button.
|
1731
|
+
# @param kind [Wx::RibbonButtonKind] The kind of tool to draw (normal, dropdown, or hybrid).
|
1732
|
+
# @param state [Integer] A combination of {Wx::RibbonToolBarToolState} flags giving the state of the tool and it's relative position within a tool group.
|
1733
|
+
# @return [void]
|
1734
|
+
def draw_tool(dc, wnd, rect, bitmap, kind, state) end
|
1735
|
+
|
1736
|
+
end # RibbonAUIArtProvider
|
1709
1737
|
|
1710
|
-
# Draw the background for a {Wx::RBN::RibbonToolBar} control.
|
1711
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1712
|
-
# @param wnd [Wx::Window] The which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1713
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. Some of this rectangle will later be drawn over using {Wx::RBN::RibbonAUIArtProvider#draw_tool_group_background} and {Wx::RBN::RibbonAUIArtProvider#draw_tool}, but not all of it will (unless there is only a single group of tools).
|
1714
|
-
# @return [void]
|
1715
|
-
def draw_tool_bar_background(dc, wnd, rect) end
|
1716
|
-
|
1717
|
-
# Draw the background for a group of tools on a {Wx::RBN::RibbonToolBar} control.
|
1718
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1719
|
-
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1720
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. This rectangle is a union of the individual tools' rectangles. As there are no gaps between tools, this rectangle will be painted over exactly once by calls to {Wx::RBN::RibbonAUIArtProvider#draw_tool}. The group background could therefore be painted by {Wx::RBN::RibbonAUIArtProvider#draw_tool}, though it can be conceptually easier and more efficient to draw it all at once here. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tool_bar_background}.
|
1721
|
-
# @return [void]
|
1722
|
-
def draw_tool_group_background(dc, wnd, rect) end
|
1723
|
-
|
1724
|
-
# Draw a single tool (for a {Wx::RBN::RibbonToolBar} control).
|
1725
|
-
# @param dc [Wx::DC] The device context to draw onto.
|
1726
|
-
# @param wnd [Wx::Window] The window which is being drawn onto. In most cases this will be a {Wx::RBN::RibbonToolBar}, but it doesn't have to be.
|
1727
|
-
# @param rect [Wx::Rect] The rectangle within which to draw. The size of this rectangle will at least the size returned by {Wx::RBN::RibbonAUIArtProvider#get_tool_size}, and the height of it will be equal for all tools within the same group. The rectangle will be entirely within a rectangle on the same device context previously painted with {Wx::RBN::RibbonAUIArtProvider#draw_tool_group_background}.
|
1728
|
-
# @param bitmap [Wx::Bitmap] The bitmap to use as the tool's foreground. If the tool is a hybrid or dropdown tool, then the foreground should also contain a standard dropdown button.
|
1729
|
-
# @param kind [Wx::RibbonButtonKind] The kind of tool to draw (normal, dropdown, or hybrid).
|
1730
|
-
# @param state [Integer] A combination of {Wx::RibbonToolBarToolState} flags giving the state of the tool and it's relative position within a tool group.
|
1731
|
-
# @return [void]
|
1732
|
-
def draw_tool(dc, wnd, rect, bitmap, kind, state) end
|
1733
|
-
|
1734
|
-
end # RibbonAUIArtProvider
|
1735
|
-
|
1736
1738
|
|
1737
|
-
end
|
1739
|
+
end
|
1740
|
+
|
1741
|
+
end
|