Class: Wx::RBN::RibbonBar

Inherits:

RibbonControl

• Object
• Object
• EvtHandler
• Window
• Control
• RibbonControl
• Wx::RBN::RibbonBar

Defined in:

lib/wx/doc/gen/rbn/ribbon_bar.rb,
lib/wx/doc/rbn/ribbon_bar.rb

Overview

Top-level control in a ribbon user interface.

Serves as a tabbed container for RibbonPage - a ribbon user interface typically has a ribbon bar, which contains one or more Wx::RibbonPages, which in turn each contain one or more Wx::RibbonPanels, which in turn contain controls. While a RibbonBar has tabs similar to a Notebook, it does not follow the same API for adding pages. Containers like Notebook can contain any type of window as a page, hence the normal procedure is to create the sub-window and then call BookCtrlBase#add_page. As RibbonBar can only have RibbonPage as children (and a RibbonPage can only have a RibbonBar as parent), when a page is created, it is automatically added to the bar - there is no AddPage equivalent to call. After all pages have been created, and all controls and panels placed on those pages, #realize must be called.

Styles

This class supports the following styles:

• Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE: Defined as Wx::RBN::RibbonBarOption::RIBBON_BAR_FLOW_HORIZONTAL | Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PAGE_LABELS | Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS | Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_TOGGLE_BUTTON | Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_HELP_BUTTON.

• Wx::RBN::RibbonBarOption::RIBBON_BAR_FOLDBAR_STYLE: Defined as Wx::RBN::RibbonBarOption::RIBBON_BAR_FLOW_VERTICAL | Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PAGE_ICONS | Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS | Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS

• Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PAGE_LABELS: Causes labels to be shown on the tabs in the ribbon bar.

• Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PAGE_ICONS: Causes icons to be shown on the tabs in the ribbon bar.

• Wx::RBN::RibbonBarOption::RIBBON_BAR_FLOW_HORIZONTAL: Causes panels within pages to stack horizontally.

• Wx::RBN::RibbonBarOption::RIBBON_BAR_FLOW_VERTICAL: Causes panels within pages to stack vertically.

• Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS: Causes extension buttons to be shown on panels (where the panel has such a button).

• Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS: Causes minimise buttons to be shown on panels (where the panel has such a button).

• Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_TOGGLE_BUTTON: Causes a toggle button to appear on the ribbon bar at top-right corner. This style is new since wxWidgets 2.9.5.

• Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_HELP_BUTTON: Causes a help button to appear on the ribbon bar at the top-right corner. This style is new since wxWidgets 2.9.5.

Events emitted by this class

The following event-handler methods redirect the events to member method or handler blocks for RibbonBarEvent events. Event handler methods for events emitted by this class:

• EvtHandler#evt_ribbonbar_page_changed(id, meth = nil, &block): Triggered after the transition from one page being active to a different page being active.

• EvtHandler#evt_ribbonbar_page_changing(id, meth = nil, &block): Triggered prior to the transition from one page being active to a different page being active, and can veto the change.

• EvtHandler#evt_ribbonbar_tab_middle_down(id, meth = nil, &block): Triggered when the middle mouse button is pressed on a tab.

• EvtHandler#evt_ribbonbar_tab_middle_up(id, meth = nil, &block): Triggered when the middle mouse button is released on a tab.

• EvtHandler#evt_ribbonbar_tab_right_down(id, meth = nil, &block): Triggered when the right mouse button is pressed on a tab.

• EvtHandler#evt_ribbonbar_tab_right_up(id, meth = nil, &block): Triggered when the right mouse button is released on a tab.

• EvtHandler#evt_ribbonbar_tab_left_dclick(id, meth = nil, &block): Triggered when the left mouse button is double clicked on a tab.

• EvtHandler#evt_ribbonbar_toggled(id, meth = nil, &block): Triggered when the button triggering the ribbon bar is clicked. This event is new since wxWidgets 2.9.5.

• EvtHandler#evt_ribbonbar_help_click(id, meth = nil, &block): Triggered when the help button is clicked. This even is new since wxWidgets 2.9.5.

Category: Ribbon User Interface

See Also:

• RibbonPage
• RibbonPanel

Requires:

• USE_RIBBON

Instance Method Summary

• #add_page_highlight(page, highlight = true) ⇒ void

  Highlight the specified tab.

• #are_panels_shown ⇒ Boolean

  Indicates whether the panel area of the ribbon bar is shown.

• #clear_pages ⇒ void

  Delete all pages from the ribbon bar.

• #create(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE) ⇒ Boolean

  Create a ribbon bar in two-step ribbon bar construction.

• #delete_page(n) ⇒ void

  Delete a single page from this ribbon bar.

• #dismiss_expanded_panel ⇒ Boolean

  Dismiss the expanded panel of the currently active page.

• #get_active_page ⇒ Integer (also: #active_page)

  Get the index of the active page.

• #get_display_mode ⇒ Wx::RibbonDisplayMode (also: #display_mode)

  Returns the current display mode of the panel area.

• #get_page(n) ⇒ Wx::RBN::RibbonPage (also: #page)

  Get a page by index.

• #get_page_count ⇒ Integer (also: #page_count)

  Get the number of pages in this bar.

• #get_page_number(page) ⇒ Integer (also: #page_number)

  Returns the number for a given ribbon bar page.

• #hide_page(page) ⇒ void

  Hides the tab for a given page.

• #hide_panels ⇒ void

  Hides the panel area of the ribbon bar.

• #initialize(*args) ⇒ RibbonBar constructor

  A new instance of RibbonBar.

• #is_page_highlighted(page) ⇒ Boolean (also: #page_highlighted?)

  Indicates whether a tab is currently highlighted.

• #is_page_shown(page) ⇒ Boolean (also: #page_shown?)

  Indicates whether the tab for the given page is shown to the user or not.

• #pages {|page| ... } ⇒ Object, Enumerator

  Iterate ribbon pages if block given or return enumerator.

• #realize ⇒ Boolean

  Perform initial layout and size calculations of the bar and its children.

• #remove_page_highlight(page) ⇒ void

  Changes a tab to not be highlighted.

• #set_active_page(*args) ⇒ Object (also: #active_page=)
• #set_art_provider(art) ⇒ void (also: #art_provider=)

  Set the art provider to be used be the ribbon bar.

• #set_tab_ctrl_margins(left, right) ⇒ void

  Set the margin widths (in pixels) on the left and right sides of the tab bar region of the ribbon bar.

• #show_page(page, show_tab = true) ⇒ void

  Show or hide the tab for a given page.

• #show_panels(*args) ⇒ Object

Methods inherited from RibbonControl

#get_ancestor_ribbon_bar, #get_art_provider, #get_best_size_for_parent_size, #get_next_larger_size, #get_next_smaller_size, #is_sizing_continuous, #realise

Methods inherited from Control

#command, ellipsize, escape_mnemonics, #get_label, #get_label_text, #get_size_from_text, #get_size_from_text_size, remove_mnemonics, #set_label, #set_label_markup, #set_label_text

Methods inherited from Window

#accepts_focus, #accepts_focus_from_keyboard, #accepts_focus_recursively, #add_child, #adjust_for_layout_direction, #always_show_scrollbars, #begin_repositioning_children, #cache_best_size, #can_accept_focus, #can_accept_focus_from_keyboard, #can_scroll, #can_set_transparent, #capture_mouse, #center, #center_on_parent, #centre, #centre_on_parent, #clear_background, #client_to_screen, #client_to_window_size, #close, #convert_dialog_to_pixels, #convert_pixels_to_dialog, #destroy, #destroy_children, #disable, #disable_focus_from_keyboard, #do_update_window_ui, #drag_accept_files, #each_child, #enable, #enable_touch_events, #enable_visible_focus, #end_repositioning_children, find_focus, #find_window_by_id, find_window_by_id, #find_window_by_label, find_window_by_label, #find_window_by_name, find_window_by_name, #fit, #fit_inside, #freeze, #from_dip, from_dip, #from_phys, from_phys, #get_accelerator_table, #get_auto_layout, #get_background_colour, #get_background_style, #get_best_height, #get_best_size, #get_best_virtual_size, #get_best_width, #get_border, get_capture, #get_caret, #get_char_height, #get_char_width, #get_children, get_class_default_attributes, #get_client_area_origin, #get_client_rect, #get_client_size, #get_containing_sizer, #get_content_scale_factor, #get_cursor, #get_default_attributes, #get_dpi, #get_dpi_scale_factor, #get_drop_target, #get_effective_min_size, #get_event_handler, #get_extra_style, #get_font, #get_foreground_colour, #get_grand_parent, #get_help_text, #get_help_text_at_point, #get_id, #get_label, #get_layout_direction, #get_max_client_size, #get_max_height, #get_max_size, #get_max_width, #get_min_client_size, #get_min_height, #get_min_size, #get_min_width, #get_name, #get_next_sibling, #get_parent, #get_popup_menu_selection_from_user, #get_position, #get_prev_sibling, #get_rect, #get_screen_position, #get_screen_rect, #get_scroll_pos, #get_scroll_range, #get_scroll_thumb, #get_size, #get_sizer, #get_text_extent, #get_theme_enabled, #get_tool_tip, #get_tool_tip_text, #get_update_client_rect, #get_update_region, #get_validator, #get_virtual_size, #get_window_border_size, #get_window_style, #get_window_style_flag, #get_window_variant, #handle_as_navigation_key, #handle_window_event, #has_capture, #has_extra_style, #has_flag, #has_focus, #has_multiple_pages, #has_scrollbar, #has_transparent_background, #hide, #hide_with_effect, #hit_test, #inform_first_direction, #inherit_attributes, #inherits_background_colour, #inherits_foreground_colour, #init_dialog, #invalidate_best_size, #is_being_deleted, #is_descendant, #is_double_buffered, #is_enabled, #is_exposed, #is_focusable, #is_frozen, #is_retained, #is_scrollbar_always_shown, #is_shown, #is_shown_on_screen, #is_this_enabled, #is_top_level, #is_transparent_background_supported, #layout, #line_down, #line_up, #locked, #lower_window, #move, #move_after_in_tab_order, #move_before_in_tab_order, #navigate, #navigate_in, new_control_id, #on_internal_idle, #page_down, #page_up, #paint, #paint_buffered, #popup_menu, #post_size_event, #post_size_event_to_parent, #process_window_event, #process_window_event_locally, #push_event_handler, #raise_window, #refresh, #refresh_rect, #register_hot_key, #release_mouse, #remove_child, #remove_event_handler, #reparent, #screen_to_client, #scroll_lines, #scroll_pages, #scroll_window, #send_size_event, #send_size_event_to_parent, #set_accelerator_table, #set_auto_layout, #set_background_colour, #set_background_style, #set_can_focus, #set_caret, #set_client_size, #set_containing_sizer, #set_cursor, #set_double_buffered, #set_drop_target, #set_event_handler, #set_extra_style, #set_focus, #set_focus_from_kbd, #set_font, #set_foreground_colour, #set_help_text, #set_id, #set_initial_size, #set_label, #set_layout_direction, #set_max_client_size, #set_max_size, #set_min_client_size, #set_min_size, #set_name, #set_next_handler, #set_own_background_colour, #set_own_font, #set_own_foreground_colour, #set_position, #set_previous_handler, #set_scroll_pos, #set_scrollbar, #set_size, #set_size_hints, #set_sizer, #set_sizer_and_fit, #set_theme_enabled, #set_tool_tip, #set_transparent, #set_validator, #set_virtual_size, #set_window_style, #set_window_style_flag, #set_window_variant, #should_inherit_colours, #show, #show_with_effect, #switch_sizer, #thaw, #to_dip, to_dip, #to_phys, to_phys, #toggle_window_style, #transfer_data_from_window, #transfer_data_to_window, #unregister_hot_key, unreserve_control_id, #unset_tool_tip, #update, #update_window_ui, #use_background_colour, #use_bg_col, #use_foreground_colour, #validate, #warp_pointer, #window_to_client_size

Methods inherited from EvtHandler

add_filter, #add_pending_event, #call_after, clear_filters, #connect, #delete_pending_events, #disconnect, #evt_activate, #evt_activate_app, #evt_aui_pane_activated, #evt_aui_pane_button, #evt_aui_pane_close, #evt_aui_pane_maximize, #evt_aui_pane_restore, #evt_aui_render, #evt_auinotebook_allow_dnd, #evt_auinotebook_begin_drag, #evt_auinotebook_bg_dclick, #evt_auinotebook_button, #evt_auinotebook_drag_done, #evt_auinotebook_drag_motion, #evt_auinotebook_end_drag, #evt_auinotebook_page_changed, #evt_auinotebook_page_changing, #evt_auinotebook_page_close, #evt_auinotebook_page_closed, #evt_auinotebook_tab_middle_down, #evt_auinotebook_tab_middle_up, #evt_auinotebook_tab_right_down, #evt_auinotebook_tab_right_up, #evt_auitoolbar_begin_drag, #evt_auitoolbar_middle_click, #evt_auitoolbar_overflow_click, #evt_auitoolbar_right_click, #evt_auitoolbar_tool_dropdown, #evt_button, #evt_calculate_layout, #evt_calendar, #evt_calendar_page_changed, #evt_calendar_sel_changed, #evt_calendar_week_clicked, #evt_calendar_weekday_clicked, #evt_char, #evt_char_hook, #evt_checkbox, #evt_checklistbox, #evt_child_focus, #evt_choice, #evt_choicebook_page_changed, #evt_choicebook_page_changing, #evt_close, #evt_collapsiblepane_changed, #evt_colourpicker_changed, #evt_colourpicker_current_changed, #evt_colourpicker_dialog_cancelled, #evt_combobox, #evt_combobox_closeup, #evt_combobox_dropdown, #evt_command, #evt_command_enter, #evt_command_kill_focus, #evt_command_left_click, #evt_command_left_dclick, #evt_command_range, #evt_command_right_click, #evt_command_scroll, #evt_command_scroll_bottom, #evt_command_scroll_changed, #evt_command_scroll_linedown, #evt_command_scroll_lineup, #evt_command_scroll_pagedown, #evt_command_scroll_pageup, #evt_command_scroll_thumbrelease, #evt_command_scroll_thumbtrack, #evt_command_scroll_top, #evt_command_set_focus, #evt_context_menu, #evt_date_changed, #evt_dialup_connected, #evt_dialup_disconnected, #evt_dirctrl_fileactivated, #evt_dirctrl_selectionchanged, #evt_dirpicker_changed, #evt_display_changed, #evt_dpi_changed, #evt_drop_files, #evt_end_session, #evt_enter_window, #evt_erase_background, #evt_filectrl_fileactivated, #evt_filectrl_filterchanged, #evt_filectrl_folderchanged, #evt_filectrl_selectionchanged, #evt_filepicker_changed, #evt_find, #evt_find_close, #evt_find_next, #evt_find_replace, #evt_find_replace_all, #evt_fontpicker_changed, #evt_fullscreen, #evt_gesture_pan, #evt_gesture_rotate, #evt_gesture_zoom, #evt_grid_cell_changed, #evt_grid_cell_changing, #evt_grid_cell_left_click, #evt_grid_cell_left_dclick, #evt_grid_cell_right_click, #evt_grid_cell_right_dclick, #evt_grid_cmd_col_size, #evt_grid_cmd_editor_created, #evt_grid_cmd_range_selected, #evt_grid_cmd_range_selecting, #evt_grid_cmd_row_size, #evt_grid_col_auto_size, #evt_grid_col_move, #evt_grid_col_size, #evt_grid_col_sort, #evt_grid_editor_created, #evt_grid_editor_hidden, #evt_grid_editor_shown, #evt_grid_label_left_click, #evt_grid_label_left_dclick, #evt_grid_label_right_click, #evt_grid_label_right_dclick, #evt_grid_range_selected, #evt_grid_range_selecting, #evt_grid_row_auto_size, #evt_grid_row_move, #evt_grid_row_size, #evt_grid_select_cell, #evt_grid_tabbing, #evt_header_begin_reorder, #evt_header_begin_resize, #evt_header_click, #evt_header_dclick, #evt_header_dragging_cancelled, #evt_header_end_reorder, #evt_header_end_resize, #evt_header_middle_click, #evt_header_middle_dclick, #evt_header_resizing, #evt_header_right_click, #evt_header_right_dclick, #evt_header_separator_dclick, #evt_help, #evt_help_range, #evt_hibernate, #evt_hotkey, #evt_html_cell_clicked, #evt_html_cell_hover, #evt_html_link_clicked, #evt_hyperlink, #evt_iconize, #evt_idle, #evt_init_dialog, #evt_joy_button_down, #evt_joy_button_up, #evt_joy_move, #evt_joy_zmove, #evt_joystick_events, #evt_key_down, #evt_key_up, #evt_kill_focus, #evt_leave_window, #evt_left_dclick, #evt_left_down, #evt_left_up, #evt_list_begin_drag, #evt_list_begin_label_edit, #evt_list_begin_rdrag, #evt_list_cache_hint, #evt_list_col_begin_drag, #evt_list_col_click, #evt_list_col_dragging, #evt_list_col_end_drag, #evt_list_col_right_click, #evt_list_delete_all_items, #evt_list_delete_item, #evt_list_end_label_edit, #evt_list_insert_item, #evt_list_item_activated, #evt_list_item_checked, #evt_list_item_deselected, #evt_list_item_focused, #evt_list_item_middle_click, #evt_list_item_right_click, #evt_list_item_selected, #evt_list_item_unchecked, #evt_list_key_down, #evt_listbook_page_changed, #evt_listbook_page_changing, #evt_listbox, #evt_listbox_dclick, #evt_long_press, #evt_magnify, #evt_maximize, #evt_media_finished, #evt_media_loaded, #evt_media_pause, #evt_media_play, #evt_media_statechanged, #evt_media_stop, #evt_menu, #evt_menu_close, #evt_menu_highlight, #evt_menu_highlight_all, #evt_menu_open, #evt_menu_range, #evt_middle_dclick, #evt_middle_down, #evt_middle_up, #evt_motion, #evt_mouse_aux1_dclick, #evt_mouse_aux1_down, #evt_mouse_aux1_up, #evt_mouse_aux2_dclick, #evt_mouse_aux2_down, #evt_mouse_aux2_up, #evt_mouse_capture_changed, #evt_mouse_capture_lost, #evt_mouse_events, #evt_mousewheel, #evt_move, #evt_move_end, #evt_move_start, #evt_moving, #evt_navigation_key, #evt_notebook_page_changed, #evt_notebook_page_changing, #evt_paint, #evt_pg_changed, #evt_pg_changing, #evt_pg_col_begin_drag, #evt_pg_col_dragging, #evt_pg_col_end_drag, #evt_pg_double_click, #evt_pg_highlighted, #evt_pg_item_collapsed, #evt_pg_item_expanded, #evt_pg_label_edit_begin, #evt_pg_label_edit_ending, #evt_pg_page_changed, #evt_pg_right_click, #evt_pg_selected, #evt_press_and_tap, #evt_query_end_session, #evt_query_layout_info, #evt_radiobox, #evt_radiobutton, #evt_ribbonbar_help_click, #evt_ribbonbar_page_changed, #evt_ribbonbar_page_changing, #evt_ribbonbar_tab_left_dclick, #evt_ribbonbar_tab_middle_down, #evt_ribbonbar_tab_middle_up, #evt_ribbonbar_tab_right_down, #evt_ribbonbar_tab_right_up, #evt_ribbonbar_toggled, #evt_ribbonbuttonbar_clicked, #evt_ribbonbuttonbar_dropdown_clicked, #evt_ribbongallery_clicked, #evt_ribbongallery_hover_changed, #evt_ribbongallery_selected, #evt_ribbonpanel_extbutton_activated, #evt_ribbontoolbar_clicked, #evt_ribbontoolbar_dropdown_clicked, #evt_richtext_buffer_reset, #evt_richtext_character, #evt_richtext_consuming_character, #evt_richtext_content_deleted, #evt_richtext_content_inserted, #evt_richtext_delete, #evt_richtext_focus_object_changed, #evt_richtext_left_click, #evt_richtext_left_dclick, #evt_richtext_middle_click, #evt_richtext_properties_changed, #evt_richtext_return, #evt_richtext_right_click, #evt_richtext_selection_changed, #evt_richtext_style_changed, #evt_richtext_stylesheet_changed, #evt_richtext_stylesheet_replaced, #evt_richtext_stylesheet_replacing, #evt_right_dclick, #evt_right_down, #evt_right_up, #evt_sash_dragged, #evt_sash_dragged_range, #evt_scroll, #evt_scroll_bottom, #evt_scroll_changed, #evt_scroll_command, #evt_scroll_linedown, #evt_scroll_lineup, #evt_scroll_pagedown, #evt_scroll_pageup, #evt_scroll_thumbrelease, #evt_scroll_thumbtrack, #evt_scroll_top, #evt_scrollbar, #evt_scrollwin, #evt_scrollwin_bottom, #evt_scrollwin_linedown, #evt_scrollwin_lineup, #evt_scrollwin_pagedown, #evt_scrollwin_pageup, #evt_scrollwin_thumbrelease, #evt_scrollwin_thumbtrack, #evt_scrollwin_top, #evt_search, #evt_search_cancel, #evt_set_cursor, #evt_set_focus, #evt_show, #evt_size, #evt_slider, #evt_spin, #evt_spin_down, #evt_spin_up, #evt_spinctrl, #evt_spinctrldouble, #evt_splitter_dclick, #evt_splitter_sash_pos_changed, #evt_splitter_sash_pos_changing, #evt_splitter_sash_pos_resize, #evt_splitter_unsplit, #evt_stc_autocomp_cancelled, #evt_stc_autocomp_char_deleted, #evt_stc_autocomp_completed, #evt_stc_autocomp_selection, #evt_stc_autocomp_selection_change, #evt_stc_calltip_click, #evt_stc_change, #evt_stc_charadded, #evt_stc_clipboard_copy, #evt_stc_clipboard_paste, #evt_stc_do_drop, #evt_stc_doubleclick, #evt_stc_drag_over, #evt_stc_dwellend, #evt_stc_dwellstart, #evt_stc_hotspot_click, #evt_stc_hotspot_dclick, #evt_stc_hotspot_release_click, #evt_stc_indicator_click, #evt_stc_indicator_release, #evt_stc_macrorecord, #evt_stc_margin_right_click, #evt_stc_marginclick, #evt_stc_modified, #evt_stc_needshown, #evt_stc_painted, #evt_stc_romodifyattempt, #evt_stc_savepointleft, #evt_stc_savepointreached, #evt_stc_start_drag, #evt_stc_styleneeded, #evt_stc_updateui, #evt_stc_userlistselection, #evt_stc_zoom, #evt_sys_colour_changed, #evt_taskbar_click, #evt_taskbar_left_dclick, #evt_taskbar_left_down, #evt_taskbar_left_up, #evt_taskbar_move, #evt_taskbar_right_dclick, #evt_taskbar_right_down, #evt_taskbar_right_up, #evt_text, #evt_text_copy, #evt_text_cut, #evt_text_enter, #evt_text_maxlen, #evt_text_paste, #evt_text_url, #evt_time_changed, #evt_timer, #evt_togglebutton, #evt_tool, #evt_tool_dropdown, #evt_tool_enter, #evt_tool_range, #evt_tool_rclicked, #evt_tool_rclicked_range, #evt_toolbook_page_changed, #evt_toolbook_page_changing, #evt_tree_begin_drag, #evt_tree_begin_label_edit, #evt_tree_begin_rdrag, #evt_tree_delete_item, #evt_tree_end_drag, #evt_tree_end_label_edit, #evt_tree_get_info, #evt_tree_item_activated, #evt_tree_item_collapsed, #evt_tree_item_collapsing, #evt_tree_item_expanded, #evt_tree_item_expanding, #evt_tree_item_gettooltip, #evt_tree_item_menu, #evt_tree_item_middle_click, #evt_tree_item_right_click, #evt_tree_key_down, #evt_tree_sel_changed, #evt_tree_sel_changing, #evt_tree_set_info, #evt_tree_state_image_click, #evt_treebook_node_collapsed, #evt_treebook_node_expanded, #evt_treebook_page_changed, #evt_treebook_page_changing, #evt_two_finger_tap, #evt_update_ui, #evt_update_ui_range, #evt_window_create, #evt_window_destroy, #evt_wizard_before_page_changed, #evt_wizard_cancel, #evt_wizard_finished, #evt_wizard_help, #evt_wizard_page_changed, #evt_wizard_page_changing, #evt_wizard_page_shown, #get_client_object, #get_evt_handler_enabled, #get_next_handler, #get_previous_handler, #is_unlinked, #process_event, #process_event_locally, #process_pending_events, #queue_event, register_class, remove_filter, #safely_process_event, #set_client_object, #set_evt_handler_enabled, #set_next_handler, #set_previous_handler, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::RBN::RibbonBar #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE) ⇒ Wx::RBN::RibbonBar

Returns a new instance of RibbonBar.

Overloads:

• #initialize ⇒ Wx::RBN::RibbonBar

  Default constructor.

  With this constructor, #create should be called in order to create the ribbon bar.
• #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE) ⇒ Wx::RBN::RibbonBar

  Construct a ribbon bar with the given parameters.

  Parameters:

  • parent (Wx::Window)
  • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
  • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
  • style (Integer) (defaults to: Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 86

def initialize(*args) end

Instance Method Details

#add_page_highlight(page, highlight = true) ⇒ void

This method returns an undefined value.

Highlight the specified tab.

Highlighted tabs have a colour between that of the active tab and a tab over which the mouse is hovering. This can be used to make a tab (usually temporarily) more noticeable to the user.

Parameters:

• page (Integer)
• highlight (Boolean) (defaults to: true)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 215

def add_page_highlight(page, highlight=true) end

#are_panels_shown ⇒ Boolean

Indicates whether the panel area of the ribbon bar is shown.

Returns:

• (Boolean)

See Also:

• #show_panels

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 249

def are_panels_shown; end

#clear_pages ⇒ void

This method returns an undefined value.

Delete all pages from the ribbon bar.

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 175

def clear_pages; end

#create(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE) ⇒ Boolean

Create a ribbon bar in two-step ribbon bar construction.

Should only be called when the default constructor is used, and arguments have the same meaning as in the full constructor.

Parameters:

• parent (Wx::Window)
• id (Integer) (defaults to: Wx::StandardID::ID_ANY)
• pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
• size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
• style (Integer) (defaults to: Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 97

def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE) end

#delete_page(n) ⇒ void

This method returns an undefined value.

Delete a single page from this ribbon bar.

The user must call #realize after one (or more) calls to this function.

Parameters:

• n (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 171

def delete_page(n) end

#dismiss_expanded_panel ⇒ Boolean

Dismiss the expanded panel of the currently active page.

Calls and returns the value from Wx::RBN::RibbonPage#dismiss_expanded_panel for the currently active page, or false if there is no active page.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 156

def dismiss_expanded_panel; end

#get_active_page ⇒ Integer Also known as: active_page

Get the index of the active page.

In the rare case of no page being active, -1 is returned.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 136

def get_active_page; end

#get_display_mode ⇒ Wx::RibbonDisplayMode Also known as: display_mode

Returns the current display mode of the panel area.

Returns:

• (Wx::RibbonDisplayMode)

See Also:

• #show_panels

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 256

def get_display_mode; end

#get_page(n) ⇒ Wx::RBN::RibbonPage Also known as: page

Get a page by index.

NULL will be returned if the given index is out of range.

Parameters:

• n (Integer)

Returns:

• (Wx::RBN::RibbonPage)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 144

def get_page(n) end

#get_page_count ⇒ Integer Also known as: page_count

Get the number of pages in this bar.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 149

def get_page_count; end

#get_page_number(page) ⇒ Integer Also known as: page_number

Returns the number for a given ribbon bar page.

The number can be used in other ribbon bar calls.

Parameters:

• page (Wx::RBN::RibbonPage)

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 163

def get_page_number(page) end

#hide_page(page) ⇒ void

This method returns an undefined value.

Hides the tab for a given page.

Equivalent to ShowPage(page, false).

Parameters:

• page (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 198

def hide_page(page) end

#hide_panels ⇒ void

This method returns an undefined value.

Hides the panel area of the ribbon bar.

This method behaves like #show_panels with false argument.

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 242

def hide_panels; end

#is_page_highlighted(page) ⇒ Boolean Also known as: page_highlighted?

Indicates whether a tab is currently highlighted.

Parameters:

• page (Integer)

Returns:

• (Boolean)

See Also:

• #add_page_highlight

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 206

def is_page_highlighted(page) end

#is_page_shown(page) ⇒ Boolean Also known as: page_shown?

Indicates whether the tab for the given page is shown to the user or not.

By default all page tabs are shown.

Parameters:

• page (Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 182

def is_page_shown(page) end

#pages {|page| ... } ⇒ Object, Enumerator

Iterate ribbon pages if block given or return enumerator.

Yield Parameters:

• page (Wx::RBN::RibbonPage) —

  A ribbon page instance

Returns:

• (Object, Enumerator) —

  result from last block execution or an enumerator

# File 'lib/wx/doc/rbn/ribbon_bar.rb', line 17

def pages; end

#realize ⇒ Boolean

Perform initial layout and size calculations of the bar and its children.

This must be called after all of the bar’s children have been created (and their children created, etc.) - if it is not, then windows may not be laid out or sized correctly. Also calls Wx::RBN::RibbonPage#realize on each child page.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 264

def realize; end

#remove_page_highlight(page) ⇒ void

This method returns an undefined value.

Changes a tab to not be highlighted.

Parameters:

• page (Integer)

See Also:

• #add_page_highlight

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 223

def remove_page_highlight(page) end

#set_active_page(page) ⇒ Boolean #set_active_page(page) ⇒ Boolean Also known as: active_page=

Overloads:

• #set_active_page(page) ⇒ Boolean

  Set the active page by index, without triggering any events.

  true if the specified page is now active, false if it could not be activated (for example because the page index is invalid).

  Parameters:

  • page (Integer) —

    The zero-based index of the page to activate.

  Returns:

  • (Boolean)
• #set_active_page(page) ⇒ Boolean

  Set the active page, without triggering any events.

  true if the specified page is now active, false if it could not be activated (for example because the given page is not a child of the ribbon bar).

  Parameters:

  • page (Wx::RBN::RibbonPage) —

    The page to activate.

  Returns:

  • (Boolean)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 129

def set_active_page(*args) end

#set_art_provider(art) ⇒ void Also known as: art_provider=

This method returns an undefined value.

Set the art provider to be used be the ribbon bar.

Also sets the art provider on all current Wx::RBN::RibbonPage children, and any Wx::RBN::RibbonPage children added in the future. Note that unlike most other ribbon controls, the ribbon bar creates a default art provider when initialised, so an explicit call to #set_art_provider is not required if the default art provider is sufficient. Also, unlike other ribbon controls, the ribbon bar takes ownership of the given pointer, and will delete it when the art provider is changed or the bar is destroyed. If this behaviour is not desired, then clone the art provider before setting it.

Parameters:

• art (Wx::RBN::RibbonArtProvider)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 114

def set_art_provider(art) end

#set_tab_ctrl_margins(left, right) ⇒ void

This method returns an undefined value.

Set the margin widths (in pixels) on the left and right sides of the tab bar region of the ribbon bar.

These margins will be painted with the tab background, but tabs and scroll buttons will never be painted in the margins. The left margin could be used for rendering something equivalent to the “Office Button”, though this is not currently implemented. The right margin could be used for rendering a help button, and/or MDI buttons, but again, this is not currently implemented.

Parameters:

• left (Integer)
• right (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 106

def set_tab_ctrl_margins(left, right) end

#show_page(page, show_tab = true) ⇒ void

This method returns an undefined value.

Show or hide the tab for a given page.

After showing or hiding a tab, you need to call #realize. If you hide the tab for the currently active page (GetActivePage) then you should call SetActivePage to activate a different page.

Parameters:

• page (Integer)
• show_tab (Boolean) (defaults to: true)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 191

def show_page(page, show_tab=true) end

#show_panels(mode) ⇒ void #show_panels(show = true) ⇒ void

Overloads:

• #show_panels(mode) ⇒ void

  This method returns an undefined value.

  Shows or hide the panel area of the ribbon bar according to the given display mode.

  Parameters:

  • mode (Wx::RibbonDisplayMode)
• #show_panels(show = true) ⇒ void

  This method returns an undefined value.

  Shows or hides the panel area of the ribbon bar.

  If the panel area is hidden, then only the tab of the ribbon bar will be shown. This is useful for giving the user more screen space to work with when he/she doesn’t need to see the ribbon’s options. If the panel is currently shown, this method pins it, use the other overload of this method to specify the exact panel display mode to avoid it.

  Parameters:

  • show (Boolean) (defaults to: true)

# File 'lib/wx/doc/gen/rbn/ribbon_bar.rb', line 236

def show_panels(*args) end