Class: Wx::AUI::AuiNotebook

Inherits:
BookCtrlBase show all
Defined in:
lib/wx/doc/gen/aui/aui_notebook.rb,
lib/wx/doc/aui/auinotebook.rb

Overview

AuiNotebook is part of the Wx::AUI class framework, which represents a notebook control, managing multiple windows with associated tabs.

See also wxAUI Overview. AuiNotebook is a notebook control which implements many features common in applications with dockable panes. Specifically, AuiNotebook implements functionality which allows the user to rearrange tab order via drag-and-drop, split the tab window into many different splitter configurations, and toggle through different themes to customize the control’s look and feel. The default theme since wxWidgets 3.3.0 is AuiFlatTabArt. If you would prefer to use the theme which used to be default in the previous versions, you can call #set_art_provider with AuiNativeTabArt as the argument. Notice that AuiNativeTabArt may be not compatible with Wx::AUI::AuiNotebookOption::AUI_NB_BOTTOM, Wx::AUI::AuiNotebookOption::AUI_NB_PIN_ON_ACTIVE_TAB and Wx::AUI::AuiNotebookOption::AUI_NB_UNPIN_ON_ALL_PINNED styles, so using it is not recommended if you use any of them.

Multiple Tab Controls

Initially, AuiNotebook creates the main tab control, which can be retrieved using #get_main_tab_ctrl, and uses it for all tabs. However when Wx::AUI::AuiNotebookOption::AUI_NB_TAB_SPLIT style is used (which is the case by default), the user will be able to drag pages out of it and create new tab controls, that can then themselves be dragged to be docked in a different place inside the notebook. Also, whether Wx::AUI::AuiNotebookOption::AUI_NB_TAB_SPLIT is specified or not, #split function can always be used to create new tab controls programmatically. When using multiple tab controls, exactly one of them is active at any time. This tab control can be retrieved by calling #get_active_tab_ctrl and is always used for appending or inserting new pages. You can also use #get_all_tab_ctrls to get all existing tab controls.

Pages Indices and Positions

Each notebook page has its logical index, which is determined by the order in which the pages are added, i.e. the first page added has index 0, the second one has index 1, and so on, but also has its physical display position, which corresponds to the position at which it is displayed. Initially the indices and positions are the same for all pages, but they may become different if the user reorders the pages by dragging them around (which is possible when Wx::AUI::AuiNotebookOption::AUI_NB_TAB_MOVE style, included in the default notebook flags, is on). Also note that it’s possible to have multiple pages with the same physical position, in different tab controls (see the previous section), e.g. each first page in each tab control has physical position 0, but there is only one page with logical index 0. All functions taking a page index parameter, such as #set_page_text, work with logical indices. Similarly, functions returning a page index, such as #get_selection, also always return logical indices. To get the physical position of a single page, use #get_page_position and to get all pages in some tab control in their physical, display order #get_pages_in_display_order can be used.

Pages Layout

When the user can change the notebook layout interactively, i.e. when Wx::AUI::AuiNotebookOption::AUI_NB_TAB_MOVE and/or Wx::AUI::AuiNotebookOption::AUI_NB_TAB_SPLIT styles are used, it can be useful to remember the current layout on program exit and restore it when it is restarted. This can be done by saving, and reloading, the layout of the entire AuiManager containing this notebook using Wx::AUI::AuiManager#save_layout and Wx::AUI::AuiManager#load_layout, but it can also be done just for the given notebook, without affecting the other panes, using #save_layout and #load_layout functions of this class. Using them is similar to using AuiManager functions, except they only require implementing AuiBookSerializer or AuiBookDeserializer interface, which is a subset of the full AuiSerializer or AuiDeserializer. The Advanced User Interface Sample shows how to use them.

Styles

This class supports the following styles:

Events emitted by this class

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

Please see the note in AuiNotebookEvent documentation about handling these events.

Category: Window Docking (wxAUI)

Requires:

  • USE_AUI

Constant Summary

Constants inherited from BookCtrlBase

BookCtrlBase::NO_IMAGE

Instance Method Summary collapse

Methods inherited from BookCtrlBase

#create_persistent_object, #find_page, #get_control_sizer, #hit_test, #set_page_size

Methods included from WithImages

#get_image_count, #get_image_list, #get_updated_image_list_for, #has_images, #set_image_list, #set_images

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_prepare_update_window_ui, #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_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_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, #msw_disable_composited, #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_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_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_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_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, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::AUI::AuiNotebook #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE) ⇒ Wx::AUI::AuiNotebook #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE) {|win| ... } ⇒ Wx::AUI::AuiNotebook

Returns a new instance of AuiNotebook.

Overloads:

  • #initialize ⇒ Wx::AUI::AuiNotebook

    Default ctor.

  • #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE) ⇒ Wx::AUI::AuiNotebook

    Constructor.

    Creates a Wx::AuiNotebok control.

    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::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE)
  • #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE) {|win| ... } ⇒ Wx::AUI::AuiNotebook

    Constructor.

    Creates a Wx::AuiNotebok control.

    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::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE)

    Yield Parameters:



133
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 133

def initialize(*args) end

Instance Method Details

#add_page(page, caption, select = false, bitmap = (Wx::BitmapBundle.new())) ⇒ Boolean #add_page(page, text, select, imageId) ⇒ Boolean

Overloads:

  • #add_page(page, caption, select = false, bitmap = (Wx::BitmapBundle.new())) ⇒ Boolean

    Adds a page.

    If the select parameter is true, calling this will generate a page change event.

    Parameters:

    Returns:

    • (Boolean)
  • #add_page(page, text, select, imageId) ⇒ Boolean

    Adds a new page.

    The page must have the book control itself as the parent and must not have been added to this control previously. The call to this function may generate the page changing events.

    true if successful, false otherwise.

    Remark:

    Do not delete the page, it will be deleted by the book control.

    Parameters:

    • page (Wx::Window) —

      Specifies the new page.

    • text (String) —

      Specifies the text for the new page.

    • select (Boolean) —

      Specifies whether the page should be selected.

    • imageId (Integer) —

      Specifies the optional image index for the new page.

    Returns:

    • (Boolean)

    See Also:



163
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 163

def add_page(*args) end

#advance_selection(forward = true) ⇒ void

This method returns an undefined value.

Sets the selection to the next or previous page in the same tab control.

This function sets selection to the next (if forward is true) or previous (otherwise) page after or before the currently selected one in but without leaving the current tab control.

Parameters:

  • forward (Boolean) (defaults to: true) 


170
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 170

def advance_selection(forward=true) end

#change_selection(n) ⇒ Integer

Changes the selection for the given page, returning the previous selection.

This function behaves as #set_selection but does not generate the page changing events. See User Generated Events vs Programmatically Generated Events for more information.

Parameters:

  • n (Integer)

Returns:

  • (Integer) 


178
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 178

def change_selection(n) end

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

Creates the notebook window.

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: 0)

Returns:

  • (Boolean) 


187
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 187

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

#delete_all_pages ⇒ Boolean

Deletes all pages.

Returns:

  • (Boolean) 


191
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 191

def delete_all_pages; end

#delete_page(page) ⇒ Boolean

Deletes a page at the given index.

Calling this method will generate a page change event.

Parameters:

  • page (Integer)

Returns:

  • (Boolean) 


198
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 198

def delete_page(page) end

#each_page {|page| ... } ⇒ Object #each_page ⇒ Enumerator

Iterate each notebook page. Passes each page to the given block. Returns an Enumerator if no block given.

Overloads:

  • #each_page {|page| ... } ⇒ Object

    Returns last result of block.

    Yield Parameters:

    Returns:

    • (Object) —

      last result of block

  • #each_page ⇒ Enumerator

    Returns enumerator.

    Returns:

    • (Enumerator) —

      enumerator



22
 
# File 'lib/wx/doc/aui/auinotebook.rb', line 22

def each_page(*) end

#find_tab(page) ⇒ Array<Wx::AUI::AuiTabCtrl, Integer>?

Finds tab control and its tab index associated with a given window.

Parameters:

Returns:

  • (Array<Wx::AUI::AuiTabCtrl, Integer>, nil) —

    tab control and index if found else nil



27
 
# File 'lib/wx/doc/aui/auinotebook.rb', line 27

def find_tab(page) end

#get_active_tab_ctrl ⇒ Wx::AUI::AuiTabCtrl Also known as: active_tab_ctrl

Returns active tab control for this notebook.

Active tab control is the one containing the currently selected page. If there is no selected page, the main tab control is returned, see #get_main_tab_ctrl. Non-nil pointer to either the active or main tab control.

Returns:

  • (Wx::AUI::AuiTabCtrl) 


515
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 515

def get_active_tab_ctrl; end

#get_all_tab_ctrls ⇒ std::vector< wxAuiTabCtrl > Also known as: all_tab_ctrls

Returns all tab controls for this notebook.

Vector of all tab controls, never empty as it always contains at least the main tab control.

Returns:

  • (std::vector< wxAuiTabCtrl >) 


522
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 522

def get_all_tab_ctrls; end

#get_art_provider ⇒ Wx::AUI::AuiTabArt Also known as: art_provider

Returns the associated art provider.

Returns:



202
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 202

def get_art_provider; end

#get_current_page ⇒ Wx::Window Also known as: current_page

Returns the currently selected page or nil.

Returns:



207
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 207

def get_current_page; end

#get_height_for_page_height(pageHeight) ⇒ Integer Also known as: height_for_page_height

Returns the desired height of the notebook for the given page height.

Use this to fit the notebook to a given page size.

Parameters:

  • pageHeight (Integer)

Returns:

  • (Integer) 


215
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 215

def get_height_for_page_height(pageHeight) end

#get_main_tab_ctrl ⇒ Wx::AUI::AuiTabCtrl Also known as: main_tab_ctrl

Returns the main tab control for this notebook.

The main tab control is the one created by the notebook itself initially to contain the pages added to it. Non-nil pointer to the main tab control.

Returns:

  • (Wx::AUI::AuiTabCtrl) 


530
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 530

def get_main_tab_ctrl; end

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

Returns the page specified by the given index.

Parameters:

  • page_idx (Integer)

Returns:



221
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 221

def get_page(page_idx) end

#get_page_bitmap(page) ⇒ Wx::Bitmap Also known as: page_bitmap

Returns the tab bitmap for the page.

Parameters:

  • page (Integer)

Returns:



227
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 227

def get_page_bitmap(page) end

#get_page_count ⇒ Integer Also known as: page_count

Returns the number of pages in the notebook.

Returns:

  • (Integer) 


232
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 232

def get_page_count; end

#get_page_image(nPage) ⇒ Integer Also known as: page_image

Returns the image index for the given page.

Parameters:

  • nPage (Integer)

Returns:

  • (Integer) 


501
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 501

def get_page_image(nPage) end

#get_page_index(page_wnd) ⇒ Integer Also known as: page_index

Returns the page index for the specified window.

If the window is not found in the notebook, NOT_FOUND is returned. This is AUI-specific equivalent to Wx::BookCtrl#find_page and it is recommended to use that generic method instead of this one.

Parameters:

Returns:

  • (Integer) 


241
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 241

def get_page_index(page_wnd) end

#get_page_kind(pageIdx) ⇒ Wx::AuiTabKind Also known as: page_kind

Returns the tab kind for the page.

See #set_page_kind.

Parameters:

  • pageIdx (Integer)

Returns:

  • (Wx::AuiTabKind) 


249
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 249

def get_page_kind(pageIdx) end

#get_page_position(page) ⇒ Wx::AUI::AuiNotebookPosition Also known as: page_position

Returns the position of the page in the notebook.

For example, to determine if one page is located immediately next to another one, the following code could be used:

wxAuiNotebookPosition pos1 = notebook->GetPagePosition(page1);
  wxAuiNotebookPosition pos2 = notebook->GetPagePosition(page2);
  if ( pos1.tabctrl == pos2.tabctrl && pos1.page + 1 == pos2.page )
  {
      // page1 is immediately before page2
  }

Note that it would be wrong to just check that page1 + 1 == page2 here because the logical page index may not correspond to their visual position if they have been reordered by the user in a control with Wx::AUI::AuiNotebookOption::AUI_NB_TAB_MOVE style.

Parameters:

  • page (Integer)

Returns:



268
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 268

def get_page_position(page) end

#get_page_text(page) ⇒ String Also known as: page_text

Returns the tab label for the page.

Parameters:

  • page (Integer)

Returns:

  • (String) 


284
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 284

def get_page_text(page) end

#get_page_tool_tip(pageIdx) ⇒ String Also known as: page_tool_tip

Returns the tooltip for the tab label of the page.

Parameters:

  • pageIdx (Integer)

Returns:

  • (String) 


290
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 290

def get_page_tool_tip(pageIdx) end

#get_pages_in_display_order(tabCtrl) ⇒ Array<Integer> Also known as: pages_in_display_order

Returns indices of all pages in the given tab control.

The pages are returned in the order they are displayed in the tab, which may be different from the default order if they were rearranged by the user. The tabCtrl must be valid, see #get_active_tab_ctrl and #get_all_tab_ctrls for the functions that can be used to get the tab control to use. The returned vector contains the logical page indices.

Parameters:

  • tabCtrl (Wx::AUI::AuiTabCtrl)

Returns:

  • (Array<Integer>) 


278
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 278

def get_pages_in_display_order(tabCtrl) end

#get_selection ⇒ Integer Also known as: selection

Returns the currently selected page.

Returns:

  • (Integer) 


295
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 295

def get_selection; end

#get_tab_ctrl_from_point(pt) ⇒ Wx::AUI::AuiTabCtrl Also known as: tab_ctrl_from_point

Returns tab control based on point coordinates inside the tab frame.

Parameters:

Returns:

  • (Wx::AUI::AuiTabCtrl) 


507
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 507

def get_tab_ctrl_from_point(pt) end

#get_tab_ctrl_height ⇒ Integer Also known as: tab_ctrl_height

Returns the height of the tab control.

Returns:

  • (Integer) 


300
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 300

def get_tab_ctrl_height; end

#insert_page(index, page, text, select = false, bitmap = (Wx::BitmapBundle.new())) ⇒ Boolean #insert_page(index, page, text, select, imageId) ⇒ Boolean

Overloads:

  • #insert_page(index, page, text, select = false, bitmap = (Wx::BitmapBundle.new())) ⇒ Boolean

    #insert_page is similar to AddPage, but allows the ability to specify the insert location.

    If the select parameter is true, calling this will generate a page change event. Page index page_idx specifies the page before which the new page should be inserted. It may be equal to the current number of pages in the notebook, in which case this function is equivalent to #add_page, but can’t be strictly greater than it. Note that if you want to insert the page at the specified physical position, e.g. at the beginning of the current tab control, you need to use #get_pages_in_display_order to get the logical page index corresponding to the position 0 and then pass this index to this function. Note that if the page with the given index is not in the currently active tab control, the new page will be added at the end of the active tab instead of being inserted into another tab control.

    true if successful, false otherwise.

    Remark:

    Do not delete the page, it will be deleted by the book control.

    Parameters:

    • index (Integer) —

      Specifies the page before which the new page should be inserted.

    • page (Wx::Window) —

      Specifies the new page.

    • text (String) —

      Specifies the text for the new page.

    • select (Boolean) (defaults to: false) —

      Specifies whether the page should be selected.

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

      Specifies the optional bitmap to use for the new page.

    Returns:

    • (Boolean)

    See Also:

  • #insert_page(index, page, text, select, imageId) ⇒ Boolean

    This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

    Parameters:

    • index (Integer)
    • page (Wx::Window)
    • text (String)
    • select (Boolean)
    • imageId (Integer)

    Returns:

    • (Boolean) 


333
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 333

def insert_page(*args) end

#load_layout(name, deserializer) ⇒ void

This method returns an undefined value.

Load the previously saved layout of the notebook.

This function is used to restore the layout previously saved by #save_layout.

Parameters:

See Also:



342
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 342

def load_layout(name, deserializer) end

#remove_page(page) ⇒ Boolean

Removes a page, without deleting the window pointer.

Parameters:

  • page (Integer)

Returns:

  • (Boolean) 


347
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 347

def remove_page(page) end

#save_layout(name, serializer) ⇒ void

This method returns an undefined value.

Save the layout of the notebook using the provided serializer.

The notebook layout includes the number and positions of all the tab controls as well as the pages contained in each of them and their order. The serializer defines how exactly this information is saved: it can use any form of serialization, e.g. XML or JSON, to do it, with the only requirement being that #load_layout should be able to restore it from the same name.

Parameters:

See Also:



357
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 357

def save_layout(name, serializer) end

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

This method returns an undefined value.

Sets the art provider to be used by the notebook.

Parameters:



362
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 362

def set_art_provider(art) end

#set_font(font) ⇒ Boolean Also known as: font=

Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.

Parameters:

Returns:

  • (Boolean) 


368
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 368

def set_font(font) end

#set_manager_flags(flags) ⇒ void Also known as: manager_flags=

This method returns an undefined value.

Sets the flags for the Wx::AUI::AuiManager used by Wx::AUI::AuiNotebook.

Please note that it makes sense to use only some of Wx::AUI::AuiManager flags, documented in Wx::AUI::AuiManagerOption, with Wx::AUI::AuiNotebook, but the other ones are simply ignored, so it is always possible to reuse the same flags for the main Wx::AUI::AuiManager and the one used by the notebook. Example of using this function to enable the Venetian blinds effect for the notebook:

auiNotebook->SetManagerFlags(
      wxAuiManager::GetManager()->GetFlags() | ~wxAUI_MGR_VENETIAN_BLINDS_HINT
  );

Parameters:

  • flags (Integer)

See Also:



384
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 384

def set_manager_flags(flags) end

#set_measuring_font(font) ⇒ void Also known as: measuring_font=

This method returns an undefined value.

Sets the font for measuring tab labels.

Parameters:



390
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 390

def set_measuring_font(font) end

#set_normal_font(font) ⇒ void Also known as: normal_font=

This method returns an undefined value.

Sets the font for drawing unselected tab labels.

Parameters:



396
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 396

def set_normal_font(font) end

#set_page_bitmap(page, bitmap) ⇒ Boolean

Sets the bitmap for the page.

To remove a bitmap from the tab caption, pass an empty BitmapBundle.

Parameters:

Returns:

  • (Boolean) 


405
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 405

def set_page_bitmap(page, bitmap) end

#set_page_image(n, imageId) ⇒ Boolean

Sets the image index for the given page.

image is an index into the image list which was set with WithImages#set_image_list.

Parameters:

  • n (Integer)
  • imageId (Integer)

Returns:

  • (Boolean) 


413
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 413

def set_page_image(n, imageId) end

#set_page_kind(pageIdx, kind) ⇒ Boolean

Set the tab kind.

Can be used to pin or lock a tab. Tabs are are grouped in 3 subsets (each of which can possibly be empty):

true if the kind was changed, false if it didn’t change, either because the page already was of the specified kind or because the preconditions were not satisfied, e.g. the page index was invalid.

Parameters:

  • pageIdx (Integer) —

    The index of the page to change.

  • kind (Wx::AuiTabKind) —

    The new kind for the page.

Returns:

  • (Boolean) 


428
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 428

def set_page_kind(pageIdx, kind) end

#set_page_text(page, text) ⇒ Boolean

Sets the tab label for the page.

Parameters:

  • page (Integer)
  • text (String)

Returns:

  • (Boolean) 


434
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 434

def set_page_text(page, text) end

#set_page_tool_tip(page, text) ⇒ Boolean

Sets the tooltip displayed when hovering over the tab label of the page.

true if tooltip was updated, false if it failed, e.g. because the page index is invalid.

Parameters:

  • page (Integer)
  • text (String)

Returns:

  • (Boolean) 


442
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 442

def set_page_tool_tip(page, text) end

#set_selected_font(font) ⇒ void Also known as: selected_font=

This method returns an undefined value.

Sets the font for drawing selected tab labels.

Parameters:



447
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 447

def set_selected_font(font) end

#set_selection(new_page) ⇒ Integer Also known as: selection=

Sets the page selection.

Calling this method will generate a page change event.

Parameters:

  • new_page (Integer)

Returns:

  • (Integer) 


455
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 455

def set_selection(new_page) end

#set_tab_ctrl_height(height) ⇒ void Also known as: tab_ctrl_height=

This method returns an undefined value.

Sets the tab height.

By default, the tab control height is calculated by measuring the text height and bitmap sizes on the tab captions. Calling this method will override that calculation and set the tab control to the specified height parameter. A call to this method will override any call to #set_uniform_bitmap_size. Specifying -1 as the height will return the control to its default auto-sizing behaviour. If the control uses Wx::AUI::AuiNotebookOption::AUI_NB_MULTILINE style, the height parameter specifies the height of a single row of tabs and not the combined height of all rows.

Parameters:

  • height (Integer) 


465
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 465

def set_tab_ctrl_height(height) end

#set_uniform_bitmap_size(size) ⇒ void Also known as: uniform_bitmap_size=

This method returns an undefined value.

Ensure that all tabs have the same height, even if some of them don’t have bitmaps.

Passing DEFAULT_SIZE as size undoes the effect of a previous call to this function and instructs the control to use dynamic tab height.

Parameters:

  • size (Array(Integer, Integer), Wx::Size) 


473
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 473

def set_uniform_bitmap_size(size) end

#show_window_menu ⇒ Boolean

Shows the window menu for the active tab control associated with this notebook, and returns true if a selection was made.

Returns:

  • (Boolean) 


488
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 488

def show_window_menu; end

#split(page, direction) ⇒ void

This method returns an undefined value.

Split performs a split operation programmatically.

The argument page indicates the page that will be split off. This page will also become the active page after the split. The direction argument specifies where the pane should go, it should be one of the following: Direction::TOP, Direction::BOTTOM, Direction::LEFT, or Direction::RIGHT.

Parameters:

  • page (Integer)
  • direction (Integer)

See Also:



484
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 484

def split(page, direction) end

#unsplit_all ⇒ void

This method returns an undefined value.

Remove all split tab controls, leaving only the single one.

This is the opposite of #split function and collects all the pages from all tab controls in the central tab control and removes the other ones. If there are no other tab controls, this function doesn’t do anything. Note that calling #split followed by #unsplit_all does not preserve the page order, as all previously split pages are added at the end of the main tab control and not at their previous positions.



496
 
# File 'lib/wx/doc/gen/aui/aui_notebook.rb', line 496

def unsplit_all; end