Class: Wx::AUI::AuiNotebook

Inherits:

BookCtrlBase

• Object
• Object
• EvtHandler
• Window
• Control
• BookCtrlBase
• Wx::AUI::AuiNotebook

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 that is used is AuiDefaultTabArt, which provides a modern, glossy look and feel. The theme can be changed by calling #set_art_provider.

Styles

This class supports the following styles:

• Wx::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE: Defined as Wx::AUI::AuiNotebookOption::AUI_NB_TOP | Wx::AUI::AuiNotebookOption::AUI_NB_TAB_SPLIT | Wx::AUI::AuiNotebookOption::AUI_NB_TAB_MOVE | Wx::AUI::AuiNotebookOption::AUI_NB_SCROLL_BUTTONS | Wx::AUI::AuiNotebookOption::AUI_NB_CLOSE_ON_ACTIVE_TAB | Wx::AUI::AuiNotebookOption::AUI_NB_MIDDLE_CLICK_CLOSE.

• Wx::AUI::AuiNotebookOption::AUI_NB_TAB_SPLIT: Allows the tab control to be split by dragging a tab.

• Wx::AUI::AuiNotebookOption::AUI_NB_TAB_MOVE: Allows a tab to be moved horizontally by dragging.

• Wx::AUI::AuiNotebookOption::AUI_NB_TAB_EXTERNAL_MOVE: Allows a tab to be moved to another tab control.

• Wx::AUI::AuiNotebookOption::AUI_NB_TAB_FIXED_WIDTH: With this style, all tabs have the same width.

• Wx::AUI::AuiNotebookOption::AUI_NB_SCROLL_BUTTONS: With this style, left and right scroll buttons are displayed.

• Wx::AUI::AuiNotebookOption::AUI_NB_WINDOWLIST_BUTTON: With this style, a drop-down list of windows is available.

• Wx::AUI::AuiNotebookOption::AUI_NB_CLOSE_BUTTON: With this style, a close button is available on the tab bar.

• Wx::AUI::AuiNotebookOption::AUI_NB_CLOSE_ON_ACTIVE_TAB: With this style, the close button is visible on the active tab.

• Wx::AUI::AuiNotebookOption::AUI_NB_CLOSE_ON_ALL_TABS: With this style, the close button is visible on all tabs.

• Wx::AUI::AuiNotebookOption::AUI_NB_MIDDLE_CLICK_CLOSE: With this style, middle click on a tab closes the tab.

• Wx::AUI::AuiNotebookOption::AUI_NB_TOP: With this style, tabs are drawn along the top of the notebook.

• Wx::AUI::AuiNotebookOption::AUI_NB_BOTTOM: With this style, tabs are drawn along the bottom of the notebook.

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:

• EvtHandler#evt_auinotebook_page_close(id, meth = nil, &block): A page is about to be closed. Processes a EVT_AUINOTEBOOK_PAGE_CLOSE event.

• EvtHandler#evt_auinotebook_page_closed(winid, meth = nil, &block): A page has been closed. Processes a EVT_AUINOTEBOOK_PAGE_CLOSED event.

• EvtHandler#evt_auinotebook_page_changed(id, meth = nil, &block): The page selection was changed. Processes a EVT_AUINOTEBOOK_PAGE_CHANGED event.

• EvtHandler#evt_auinotebook_page_changing(id, meth = nil, &block): The page selection is about to be changed. Processes a EVT_AUINOTEBOOK_PAGE_CHANGING event. This event can be vetoed.

• EvtHandler#evt_auinotebook_button(id, meth = nil, &block): The window list button has been pressed. Processes a EVT_AUINOTEBOOK_BUTTON event.

• EvtHandler#evt_auinotebook_begin_drag(id, meth = nil, &block): Dragging is about to begin. Processes a EVT_AUINOTEBOOK_BEGIN_DRAG event.

• EvtHandler#evt_auinotebook_end_drag(id, meth = nil, &block): Dragging has ended. Processes a EVT_AUINOTEBOOK_END_DRAG event.

• EvtHandler#evt_auinotebook_drag_motion(id, meth = nil, &block): Emitted during a drag and drop operation. Processes a EVT_AUINOTEBOOK_DRAG_MOTION event.

• EvtHandler#evt_auinotebook_allow_dnd(id, meth = nil, &block): Whether to allow a tab to be dropped. Processes a EVT_AUINOTEBOOK_ALLOW_DND event. This event must be specially allowed.

• EvtHandler#evt_auinotebook_drag_done(winid, meth = nil, &block): Notify that the tab has been dragged. Processes a EVT_AUINOTEBOOK_DRAG_DONE event.

• EvtHandler#evt_auinotebook_tab_middle_down(winid, meth = nil, &block): The middle mouse button is pressed on a tab. Processes a EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN event.

• EvtHandler#evt_auinotebook_tab_middle_up(winid, meth = nil, &block): The middle mouse button is released on a tab. Processes a EVT_AUINOTEBOOK_TAB_MIDDLE_UP event.

• EvtHandler#evt_auinotebook_tab_right_down(winid, meth = nil, &block): The right mouse button is pressed on a tab. Processes a EVT_AUINOTEBOOK_TAB_RIGHT_DOWN event.

• EvtHandler#evt_auinotebook_tab_right_up(winid, meth = nil, &block): The right mouse button is released on a tab. Processes a EVT_AUINOTEBOOK_TAB_RIGHT_UP event.

• EvtHandler#evt_auinotebook_bg_dclick(winid, meth = nil, &block): Double clicked on the tabs background area. Processes a EVT_AUINOTEBOOK_BG_DCLICK event.

Category: Window Docking (wxAUI)

Requires:

• USE_AUI

Constant Summary

Constants inherited from BookCtrlBase

BookCtrlBase::NO_IMAGE

Instance Method Summary

• #add_page(*args) ⇒ Object
• #advance_selection(forward = true) ⇒ void

  Sets the selection to the next or previous page.

• #change_selection(n) ⇒ Integer

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

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

  Creates the notebook window.

• #delete_all_pages ⇒ Boolean

  Deletes all pages.

• #delete_page(page) ⇒ Boolean

  Deletes a page at the given index.

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

  Iterate each notebook page.

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

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

• #get_active_tab_ctrl ⇒ Wx::AUI::AuiTabCtrl (also: #active_tab_ctrl)

  Returns active tab control for this notebook.

• #get_art_provider ⇒ Wx::AUI::AuiTabArt (also: #art_provider)

  Returns the associated art provider.

• #get_current_page ⇒ Wx::Window (also: #current_page)

  Returns the currently selected page or NULL.

• #get_height_for_page_height(pageHeight) ⇒ Integer (also: #height_for_page_height)

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

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

  Returns the page specified by the given index.

• #get_page_bitmap(page) ⇒ Wx::Bitmap (also: #page_bitmap)

  Returns the tab bitmap for the page.

• #get_page_count ⇒ Integer (also: #page_count)

  Returns the number of pages in the notebook.

• #get_page_image(nPage) ⇒ Integer (also: #page_image)

  Returns the image index for the given page.

• #get_page_index(page_wnd) ⇒ Integer (also: #page_index)

  Returns the page index for the specified window.

• #get_page_text(page) ⇒ String (also: #page_text)

  Returns the tab label for the page.

• #get_page_tool_tip(pageIdx) ⇒ String (also: #page_tool_tip)

  Returns the tooltip for the tab label of the page.

• #get_selection ⇒ Integer (also: #selection)

  Returns the currently selected page.

• #get_tab_ctrl_from_point(pt) ⇒ Wx::AUI::AuiTabCtrl (also: #tab_ctrl_from_point)

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

• #get_tab_ctrl_height ⇒ Integer (also: #tab_ctrl_height)

  Returns the height of the tab control.

• #initialize(*args) ⇒ AuiNotebook constructor

  A new instance of AuiNotebook.

• #insert_page(*args) ⇒ Object
• #remove_page(page) ⇒ Boolean

  Removes a page, without deleting the window pointer.

• #set_art_provider(art) ⇒ void (also: #art_provider=)

  Sets the art provider to be used by the notebook.

• #set_font(font) ⇒ Boolean (also: #font=)

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

• #set_measuring_font(font) ⇒ void (also: #measuring_font=)

  Sets the font for measuring tab labels.

• #set_normal_font(font) ⇒ void (also: #normal_font=)

  Sets the font for drawing unselected tab labels.

• #set_page_bitmap(page, bitmap) ⇒ Boolean

  Sets the bitmap for the page.

• #set_page_image(n, imageId) ⇒ Boolean

  Sets the image index for the given page.

• #set_page_text(page, text) ⇒ Boolean

  Sets the tab label for the page.

• #set_page_tool_tip(page, text) ⇒ Boolean

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

• #set_selected_font(font) ⇒ void (also: #selected_font=)

  Sets the font for drawing selected tab labels.

• #set_selection(new_page) ⇒ Integer (also: #selection=)

  Sets the page selection.

• #set_tab_ctrl_height(height) ⇒ void (also: #tab_ctrl_height=)

  Sets the tab height.

• #set_uniform_bitmap_size(size) ⇒ void (also: #uniform_bitmap_size=)

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

• #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.

• #split(page, direction) ⇒ void

  Split performs a split operation programmatically.

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_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, #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_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_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_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

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)

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

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:

  • page (Wx::Window)
  • caption (String)
  • select (Boolean) (defaults to: false)
  • bitmap (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image) (defaults to: (Wx::BitmapBundle.new()))

  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:

  • #insert_page

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

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.

Parameters:

• forward (Boolean) (defaults to: true)

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

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)

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

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)

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

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)

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

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)

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

def delete_page(page) end

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

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

Yield Parameters:

• page (Wx::Window) —

  notebook page

Returns:

• (Object, Enumerator) —

  last result of block or Enumerator if no block given.

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

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:

• page (Wx::Window) —

  the notebook page window

Returns:

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

  tab control and index if found else nil

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

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.

Returns:

• (Wx::AUI::AuiTabCtrl)

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

def get_active_tab_ctrl; end

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

Returns the associated art provider.

Returns:

• (Wx::AUI::AuiTabArt)

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

def get_art_provider; end

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

Returns the currently selected page or NULL.

Returns:

• (Wx::Window)

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

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)

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

def get_height_for_page_height(pageHeight) end

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

Returns the page specified by the given index.

Parameters:

• page_idx (Integer)

Returns:

• (Wx::Window)

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

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:

• (Wx::Bitmap)

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

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)

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

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)

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

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:

• page_wnd (Wx::Window)

Returns:

• (Integer)

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

def get_page_index(page_wnd) end

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

Returns the tab label for the page.

Parameters:

• page (Integer)

Returns:

• (String)

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

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)

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

def get_page_tool_tip(pageIdx) end

#get_selection ⇒ Integer Also known as: selection

Returns the currently selected page.

Returns:

• (Integer)

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

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:

• pt (Array(Integer, Integer), Wx::Point)

Returns:

• (Wx::AUI::AuiTabCtrl)

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

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)

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

def get_tab_ctrl_height; end

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

Overloads:

• #insert_page(page_idx, page, caption, 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.

  Parameters:

  • page_idx (Integer)
  • page (Wx::Window)
  • caption (String)
  • select (Boolean) (defaults to: false)
  • bitmap (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image) (defaults to: (Wx::BitmapBundle.new()))

  Returns:

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

  Inserts a new page at the specified position.

  true if successful, false otherwise.

  Remark:

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

  Parameters:

  • index (Integer) —

    Specifies the position for the new page.

  • 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:

  • #add_page

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

def insert_page(*args) end

#remove_page(page) ⇒ Boolean

Removes a page, without deleting the window pointer.

Parameters:

• page (Integer)

Returns:

• (Boolean)

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

def remove_page(page) 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:

• art (Wx::AUI::AuiTabArt)

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

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:

• font (Wx::Font, Wx::FontInfo)

Returns:

• (Boolean)

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

def set_font(font) 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:

• font (Wx::Font, Wx::FontInfo)

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

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:

• font (Wx::Font, Wx::FontInfo)

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

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:

• page (Integer)
• bitmap (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image)

Returns:

• (Boolean)

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

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)

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

def set_page_image(n, imageId) end

#set_page_text(page, text) ⇒ Boolean

Sets the tab label for the page.

Parameters:

• page (Integer)
• text (String)

Returns:

• (Boolean)

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

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)

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

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:

• font (Wx::Font, Wx::FontInfo)

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

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)

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

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.

Parameters:

• height (Integer)

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

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)

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

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)

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

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)

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

def split(page, direction) end