Class: Wx::RBN::Backstage

Inherits:

Window

• Object
• Object
• EvtHandler
• Window
• Wx::RBN::Backstage

Defined in:

lib/wx/doc/gen/rbn/backstage.rb

Overview

A backstage view, as shown by a ribbon's "File" tab.

The control has two areas: buttons on the left (which are defined once) and pages on the right (which are connected to the buttons by ID). The buttons can be disabled, and there can be separators and a flexible space. For example, buttons added after it are anchored to the bottom, such as "Account" and "Options". Every button fires a EVT_BACKSTAGE_CLICKED event carrying the button's ID. If the button has a page, then the page is shown afterwards (unless the handler vetoes the event). Buttons without a page are simply actions (e.g., "Exit"). Buttons on the pages fire regular EVT_BUTTON events with their own IDs. The backstage lives in the frame's client area, in the same spot as the application's main content, and never closes itself. Use RibbonBar#set_backstage to connect it to a ribbon bar. The controls in BackstageButton, BackstageHeading, BackstageCallout, BackstageItemList and BackstageMRUList are meant for building its pages.

Events emitted by this class

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

• EvtHandler#evt_backstage_clicked(id, meth = nil, &block): Triggered when a button on the left is clicked or activated. The event's ID is the button's ID. Call NotifyEvent#veto to keep the button's page from being shown.

Category: Ribbon User Interface

See Also:

• RibbonBar#set_backstage

Requires:

• USE_RIBBON

Instance Method Summary

• #add_button(id, label, icon = (Wx::BitmapBundle.new())) ⇒ Boolean

  Adds a button to the left side.

• #add_flexible_space ⇒ void

  Anchors the buttons added after this to the bottom of the left side.

• #add_page(buttonId) ⇒ Wx::RBN::BackstagePage

  Creates a page and connects it to a button.

• #add_separator ⇒ void

  Adds a separator line to the left side.

• #create(parent, id = Wx::StandardID::ID_ANY) ⇒ Boolean

  Creates the backstage, for use with the default constructor.

• #enable_button(id, enable = true) ⇒ void

  Enables or disables a button.

• #get_current_page_id ⇒ Integer (also: #current_page_id)

  Returns the ID of the button whose page is shown, or NOT_FOUND if there is none.

• #get_highlight_colour ⇒ Wx::Colour, ... (also: #highlight_colour)

  Returns the colour of the highlighted button, which is invalid if it is derived from the left side's background colour.

• #get_highlight_style ⇒ Wx::BackstageHighlightStyle (also: #highlight_style)

  Returns how the highlighted button is drawn.

• #get_nav_background_colour ⇒ Wx::Colour (also: #nav_background_colour)

  Returns the background colour of the left side.

• #get_page(buttonId) ⇒ Wx::Window (also: #page)

  Returns the page connected to a button, or nil if there is none.

• #get_page_background_colour ⇒ Wx::Colour (also: #page_background_colour)

  Returns the background colour of the pages.

• #get_page_foreground_colour ⇒ Wx::Colour (also: #page_foreground_colour)

  Returns the colour to draw text with on the pages (black or white, depending on the page's background colour).

• #initialize(*args) ⇒ Backstage constructor

  A new instance of Backstage.

• #is_button_enabled(id) ⇒ Boolean (also: #button_enabled?)

  Returns true if the button is enabled.

• #keep_window_colours(window) ⇒ void

  Keeps a control on a page from following the page's colours, so that its own colours are left alone.

• #remove_page(buttonId) ⇒ Boolean

  Removes the page connected to a button.

• #set_button_label(id, label) ⇒ void

  Changes a button's label.

• #set_highlight_colour(colour) ⇒ void (also: #highlight_colour=)

  Sets the colour of the highlighted button.

• #set_highlight_style(style) ⇒ void (also: #highlight_style=)

  Sets how the highlighted button is drawn.

• #set_nav_background_colour(colour) ⇒ void (also: #nav_background_colour=)

  Sets the background colour of the left side.

• #set_page(buttonId, page) ⇒ Boolean

  Connects a window that you created to a button.

• #set_page_background_colour(colour) ⇒ void (also: #page_background_colour=)

  Sets the background colour of the pages.

• #show_page(buttonId) ⇒ Boolean

  Shows the page connected to a button, and highlights the button.

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_prepare_update_window_ui, #do_update_window_ui, #drag_accept_files, #each_child, #enable, #enable_focus_from_keyboard, #enable_input_method, #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_cursor_bundle, #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_id_at_point, #get_help_text, #get_help_text_at_point, #get_id, #get_input_method_cursor_rect, #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_size_from_known_direction, #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_scrollbar_size, #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_input_method_enabled, #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, #pop_event_handler, #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_accessible_name, #set_auto_layout, #set_background_colour, #set_background_style, #set_can_focus, #set_caret, #set_client_size, #set_containing_sizer, #set_cursor, #set_cursor_bundle, #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_input_method_cursor_rect, #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_minimize, #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_backstage_clicked, #evt_backstage_item_clicked, #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_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_label_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_label_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_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_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_webview_browsing_data_cleared, #evt_webview_created, #evt_webview_error, #evt_webview_fullscreen_changed, #evt_webview_loaded, #evt_webview_navigated, #evt_webview_navigating, #evt_webview_newwindow, #evt_webview_newwindow_features, #evt_webview_pdf_saved, #evt_webview_script_message_received, #evt_webview_script_result, #evt_webview_title_changed, #evt_webview_window_close_requested, #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, #make_shared, #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, #try_after, #try_before, #unlink

Constructor Details

#initialize ⇒ Wx::RBN::Backstage #initialize(parent, id = Wx::StandardID::ID_ANY) ⇒ Wx::RBN::Backstage #initialize(parent, id = Wx::StandardID::ID_ANY) {|win| ... } ⇒ Wx::RBN::Backstage

Returns a new instance of Backstage.

Overloads:

• #initialize ⇒ Wx::RBN::Backstage

  Default constructor.

  Call #create before using the backstage.
• #initialize(parent, id = Wx::StandardID::ID_ANY) ⇒ Wx::RBN::Backstage

  Constructor.

  Parameters:

  • parent (Wx::Window) —

    The parent window, which should be the same as the ribbon bar's.

  • id (Integer) (defaults to: Wx::StandardID::ID_ANY) —

    The window ID.

• #initialize(parent, id = Wx::StandardID::ID_ANY) {|win| ... } ⇒ Wx::RBN::Backstage

  Constructor.

  Parameters:

  • parent (Wx::Window) —

    The parent window, which should be the same as the ribbon bar's.

  • id (Integer) (defaults to: Wx::StandardID::ID_ANY) —

    The window ID.

  Yield Parameters:

  • win (Wx::RBN::Backstage) —

    new instance

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 209

def initialize(*args) end

Instance Method Details

#add_button(id, label, icon = (Wx::BitmapBundle.new())) ⇒ Boolean

Adds a button to the left side.

true if the button was added, false if the ID was invalid or already in use.

Parameters:

• id (Integer) —

  The button's ID, which also connects it to a page. It must be unique and not StandardID::ID_ANY.

• label (String) —

  The button's label.

• icon (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image) (defaults to: (Wx::BitmapBundle.new())) —

  An optional icon.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 58

def add_button(id, label, icon=(Wx::BitmapBundle.new())) end

#add_flexible_space ⇒ void

This method returns an undefined value.

Anchors the buttons added after this to the bottom of the left side.

Only the first call has an effect.

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 68

def add_flexible_space; end

#add_page(buttonId) ⇒ Wx::RBN::BackstagePage

Creates a page and connects it to a button.

The new page, to which controls can be added.

Parameters:

• buttonId (Integer) —

  The ID of the button that shows the page.

Returns:

• (Wx::RBN::BackstagePage)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 93

def add_page(buttonId) end

#add_separator ⇒ void

This method returns an undefined value.

Adds a separator line to the left side.

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 62

def add_separator; end

#create(parent, id = Wx::StandardID::ID_ANY) ⇒ Boolean

Creates the backstage, for use with the default constructor.

true if the backstage was created.

Parameters:

• parent (Wx::Window)
• id (Integer) (defaults to: Wx::StandardID::ID_ANY)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 217

def create(parent, id=Wx::StandardID::ID_ANY) end

#enable_button(id, enable = true) ⇒ void

This method returns an undefined value.

Enables or disables a button.

Parameters:

• id (Integer)
• enable (Boolean) (defaults to: true)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 74

def enable_button(id, enable=true) end

#get_current_page_id ⇒ Integer Also known as: current_page_id

Returns the ID of the button whose page is shown, or NOT_FOUND if there is none.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 126

def get_current_page_id; end

#get_highlight_colour ⇒ Wx::Colour, ... Also known as: highlight_colour

Returns the colour of the highlighted button, which is invalid if it is derived from the left side's background colour.

Returns:

• (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 146

def get_highlight_colour; end

#get_highlight_style ⇒ Wx::BackstageHighlightStyle Also known as: highlight_style

Returns how the highlighted button is drawn.

Returns:

• (Wx::BackstageHighlightStyle)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 159

def get_highlight_style; end

#get_nav_background_colour ⇒ Wx::Colour Also known as: nav_background_colour

Returns the background colour of the left side.

If none was set, a theme-aware default is returned.

Returns:

• (Wx::Colour)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 133

def get_nav_background_colour; end

#get_page(buttonId) ⇒ Wx::Window Also known as: page

Returns the page connected to a button, or nil if there is none.

Parameters:

• buttonId (Integer)

Returns:

• (Wx::Window)

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

def get_page(buttonId) end

#get_page_background_colour ⇒ Wx::Colour Also known as: page_background_colour

Returns the background colour of the pages.

If none was set, a theme-aware default is returned.

Returns:

• (Wx::Colour)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 172

def get_page_background_colour; end

#get_page_foreground_colour ⇒ Wx::Colour Also known as: page_foreground_colour

Returns the colour to draw text with on the pages (black or white, depending on the page's background colour).

Returns:

• (Wx::Colour)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 185

def get_page_foreground_colour; end

#is_button_enabled(id) ⇒ Boolean Also known as: button_enabled?

Returns true if the button is enabled.

Parameters:

• id (Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 79

def is_button_enabled(id) end

#keep_window_colours(window) ⇒ void

This method returns an undefined value.

Keeps a control on a page from following the page's colours, so that its own colours are left alone.

Parameters:

• window (Wx::Window)

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

def keep_window_colours(window) end

#remove_page(buttonId) ⇒ Boolean

Removes the page connected to a button.

true if the button had a page.

Parameters:

• buttonId (Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 109

def remove_page(buttonId) end

#set_button_label(id, label) ⇒ void

This method returns an undefined value.

Changes a button's label.

Parameters:

• id (Integer)
• label (String)

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

def set_button_label(id, label) end

#set_highlight_colour(colour) ⇒ void Also known as: highlight_colour=

This method returns an undefined value.

Sets the colour of the highlighted button.

An invalid colour derives it from the left side's background colour.

Parameters:

• colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 154

def set_highlight_colour(colour) end

#set_highlight_style(style) ⇒ void Also known as: highlight_style=

This method returns an undefined value.

Sets how the highlighted button is drawn.

Parameters:

• style (Wx::BackstageHighlightStyle)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 165

def set_highlight_style(style) end

#set_nav_background_colour(colour) ⇒ void Also known as: nav_background_colour=

This method returns an undefined value.

Sets the background colour of the left side.

An invalid colour returns to the default. When used by a ribbon bar, this is set from the ribbon bar's art provider.

Parameters:

• colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 141

def set_nav_background_colour(colour) end

#set_page(buttonId, page) ⇒ Boolean

Connects a window that you created to a button.

The window is moved into the backstage's page area, which owns it. true if the page was set. This fails if the button wasn't found or already has a page.

Parameters:

• buttonId (Integer)
• page (Wx::Window)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 102

def set_page(buttonId, page) end

#set_page_background_colour(colour) ⇒ void Also known as: page_background_colour=

This method returns an undefined value.

Sets the background colour of the pages.

An invalid colour returns to the default. Controls on the pages that use the old colours are moved to the new colours.

Parameters:

• colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 180

def set_page_background_colour(colour) end

#show_page(buttonId) ⇒ Boolean

Shows the page connected to a button, and highlights the button.

true if the page was shown.

Parameters:

• buttonId (Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/backstage.rb', line 122

def show_page(buttonId) end