wxruby3 0.9.5-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

data/lib/wx/doc/gen/aui/aui_notebook.rb

@@ -6,458 +6,462 @@
 
 module Wx::AUI
 
-  # {Wx::AUI::AuiNotebook} is part of the {Wx::AUI} class framework, which represents a notebook control, managing multiple windows with associated tabs.
-  # 
-  # See also wxAUI Overview.
-  # {Wx::AUI::AuiNotebook} is a notebook control which implements many features common in applications with dockable panes. Specifically, {Wx::AUI::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 {Wx::AUI::AuiDefaultTabArt}, which provides a modern, glossy look and feel. The theme can be changed by calling {Wx::AUI::AuiNotebook#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 {Wx::AUI::AuiNotebookEvent} events.
-  # Event handler methods for events emitted by this class:
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_page_close}(id, meth = nil, &block): A page is about to be closed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSE} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_page_closed}(winid, meth = nil, &block): A page has been closed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSED} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGED} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGING} event. This event can be vetoed. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_button}(id, meth = nil, &block): The window list button has been pressed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BUTTON} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_begin_drag}(id, meth = nil, &block): Dragging is about to begin. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BEGIN_DRAG} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_end_drag}(id, meth = nil, &block): Dragging has ended. Processes a {Wx::AUI::EVT_AUINOTEBOOK_END_DRAG} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_drag_motion}(id, meth = nil, &block): Emitted during a drag and drop operation. Processes a {Wx::AUI::EVT_AUINOTEBOOK_DRAG_MOTION} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_allow_dnd}(id, meth = nil, &block): Whether to allow a tab to be dropped. Processes a {Wx::AUI::EVT_AUINOTEBOOK_ALLOW_DND} event. This event must be specially allowed. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_drag_done}(winid, meth = nil, &block): Notify that the tab has been dragged. Processes a {Wx::AUI::EVT_AUINOTEBOOK_DRAG_DONE} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_tab_middle_down}(winid, meth = nil, &block): The middle mouse button is pressed on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_tab_middle_up}(winid, meth = nil, &block): The middle mouse button is released on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_UP} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_tab_right_down}(winid, meth = nil, &block): The right mouse button is pressed on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_DOWN} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_tab_right_up}(winid, meth = nil, &block): The right mouse button is released on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_UP} event. 
-  # 
-  # - {Wx::EvtHandler#evt_auinotebook_bg_dclick}(winid, meth = nil, &block): Double clicked on the tabs background area. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BG_DCLICK} event. 
-  # 
-  # Category:  Window Docking (wxAUI)
-  # 
-  # @wxrb_require USE_AUI
-  class AuiNotebook < BookCtrlBase
-  
-    # @overload initialize()
-    #   Default ctor.
-    #   @return [Wx::AUI::AuiNotebook]
-    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE)
-    #   Constructor.
-    #   
-    #   Creates a {Wx::AuiNotebok} control.
-    #   @param parent [Wx::Window] 
-    #   @param id [Integer] 
-    #   @param pos [Array(Integer, Integer), Wx::Point] 
-    #   @param size [Array(Integer, Integer), Wx::Size] 
-    #   @param style [Integer] 
-    #   @return [Wx::AUI::AuiNotebook]
-    def initialize(*args) end
-    
-    # @overload add_page(page, caption, select=false, bitmap=(Wx::BitmapBundle.new()))
-    #   Adds a page.
-    #   
-    #   If the select parameter is true, calling this will generate a page change event.
-    #   @param page [Wx::Window] 
-    #   @param caption [String] 
-    #   @param select [Boolean] 
-    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
-    #   @return [Boolean]
-    # @overload add_page(page, text, select, imageId)
-    #   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.
-    #   
-    #   <div class="wxrb-remark">
-    #   <b>Remark:</b>
-    #   <p>Do not delete the page, it will be deleted by the book control.
-    #   </p>
-    #   </div>
-    #   @see Wx::AUI::AuiNotebook#insert_page 
-    #   @param page [Wx::Window]  Specifies the new page.
-    #   @param text [String]  Specifies the text for the new page.
-    #   @param select [Boolean]  Specifies whether the page should be selected.
-    #   @param imageId [Integer]  Specifies the optional image index for the new page.
-    #   @return [Boolean]
-    def add_page(*args) end
-    
-    # Sets the selection to the next or previous page.
-    # @param forward [Boolean] 
-    # @return [void]
-    def advance_selection(forward=true) end
-    
-    # Changes the selection for the given page, returning the previous selection.
-    # 
-    # This function behaves as {Wx::AUI::AuiNotebook#set_selection} but does not generate the page changing events.
-    # See User Generated Events vs Programmatically Generated Events for more information.
-    # @param n [Integer] 
-    # @return [Integer]
-    def change_selection(n) end
-    
-    # Creates the notebook window.
-    # @param parent [Wx::Window] 
-    # @param id [Integer] 
-    # @param pos [Array(Integer, Integer), Wx::Point] 
-    # @param size [Array(Integer, Integer), Wx::Size] 
-    # @param style [Integer] 
-    # @return [Boolean]
-    def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0) end
-    
-    # Deletes all pages.
-    # @return [Boolean]
-    def delete_all_pages; end
-    
-    # Deletes a page at the given index.
-    # 
-    # Calling this method will generate a page change event.
-    # @param page [Integer] 
-    # @return [Boolean]
-    def delete_page(page) end
-    
-    # Returns the associated art provider.
-    # @return [Wx::AUI::AuiTabArt]
-    def get_art_provider; end
-    alias_method :art_provider, :get_art_provider
-    
-    # Returns the currently selected page or NULL.
-    # @return [Wx::Window]
-    def get_current_page; end
-    alias_method :current_page, :get_current_page
-    
-    # Returns the desired height of the notebook for the given page height.
-    # 
-    # Use this to fit the notebook to a given page size.
-    # @param pageHeight [Integer] 
-    # @return [Integer]
-    def get_height_for_page_height(pageHeight) end
-    alias_method :height_for_page_height, :get_height_for_page_height
-    
-    # Returns the page specified by the given index.
-    # @param page_idx [Integer] 
-    # @return [Wx::Window]
-    def get_page(page_idx) end
-    alias_method :page, :get_page
-    
-    # Returns the tab bitmap for the page.
-    # @param page [Integer] 
-    # @return [Wx::Bitmap]
-    def get_page_bitmap(page) end
-    alias_method :page_bitmap, :get_page_bitmap
-    
-    # Returns the number of pages in the notebook.
-    # @return [Integer]
-    def get_page_count; end
-    alias_method :page_count, :get_page_count
-    
-    # Returns the page index for the specified window.
-    # 
-    # If the window is not found in the notebook, {Wx::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.
-    # @param page_wnd [Wx::Window] 
-    # @return [Integer]
-    def get_page_index(page_wnd) end
-    alias_method :page_index, :get_page_index
-    
-    # Returns the tab label for the page.
-    # @param page [Integer] 
-    # @return [String]
-    def get_page_text(page) end
-    alias_method :page_text, :get_page_text
-    
-    # Returns the tooltip for the tab label of the page.
-    # @param pageIdx [Integer] 
-    # @return [String]
-    def get_page_tool_tip(pageIdx) end
-    alias_method :page_tool_tip, :get_page_tool_tip
-    
-    # Returns the currently selected page.
-    # @return [Integer]
-    def get_selection; end
-    alias_method :selection, :get_selection
-    
-    # Returns the height of the tab control.
-    # @return [Integer]
-    def get_tab_ctrl_height; end
-    alias_method :tab_ctrl_height, :get_tab_ctrl_height
-    
-    # @overload insert_page(page_idx, page, caption, select=false, bitmap=(Wx::BitmapBundle.new()))
-    #   {Wx::AUI::AuiNotebook#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.
-    #   @param page_idx [Integer] 
-    #   @param page [Wx::Window] 
-    #   @param caption [String] 
-    #   @param select [Boolean] 
-    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
-    #   @return [Boolean]
-    # @overload insert_page(index, page, text, select, imageId)
-    #   Inserts a new page at the specified position.
-    #   
-    #   true if successful, false otherwise.
-    #   
-    #   <div class="wxrb-remark">
-    #   <b>Remark:</b>
-    #   <p>Do not delete the page, it will be deleted by the book control.
-    #   </p>
-    #   </div>
-    #   @see Wx::AUI::AuiNotebook#add_page 
-    #   @param index [Integer]  Specifies the position for the new page.
-    #   @param page [Wx::Window]  Specifies the new page.
-    #   @param text [String]  Specifies the text for the new page.
-    #   @param select [Boolean]  Specifies whether the page should be selected.
-    #   @param imageId [Integer]  Specifies the optional image index for the new page.
-    #   @return [Boolean]
-    def insert_page(*args) end
-    
-    # Removes a page, without deleting the window pointer.
-    # @param page [Integer] 
-    # @return [Boolean]
-    def remove_page(page) end
-    
-    # Sets the art provider to be used by the notebook.
-    # @param art [Wx::AUI::AuiTabArt] 
-    # @return [void]
-    def set_art_provider(art) end
-    alias_method :art_provider=, :set_art_provider
-    
-    # Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.
-    # @param font [Wx::Font,Wx::FontInfo] 
-    # @return [Boolean]
-    def set_font(font) end
-    alias_method :font=, :set_font
-    
-    # Sets the font for measuring tab labels.
-    # @param font [Wx::Font,Wx::FontInfo] 
-    # @return [void]
-    def set_measuring_font(font) end
-    alias_method :measuring_font=, :set_measuring_font
-    
-    # Sets the font for drawing unselected tab labels.
-    # @param font [Wx::Font,Wx::FontInfo] 
-    # @return [void]
-    def set_normal_font(font) end
-    alias_method :normal_font=, :set_normal_font
-    
-    # Sets the bitmap for the page.
-    # 
-    # To remove a bitmap from the tab caption, pass an empty {Wx::BitmapBundle}.
-    # @param page [Integer] 
-    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
-    # @return [Boolean]
-    def set_page_bitmap(page, bitmap) end
-    
-    # Sets the image index for the given page.
-    # 
-    # image is an index into the image list which was set with {Wx::AUI::AuiNotebook#set_image_list}.
-    # @param n [Integer] 
-    # @param imageId [Integer] 
-    # @return [Boolean]
-    def set_page_image(n, imageId) end
-    
-    # Sets the tab label for the page.
-    # @param page [Integer] 
-    # @param text [String] 
-    # @return [Boolean]
-    def set_page_text(page, text) end
-    
-    # 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.
-    # @param page [Integer] 
-    # @param text [String] 
-    # @return [Boolean]
-    def set_page_tool_tip(page, text) end
-    
-    # Sets the font for drawing selected tab labels.
-    # @param font [Wx::Font,Wx::FontInfo] 
-    # @return [void]
-    def set_selected_font(font) end
-    alias_method :selected_font=, :set_selected_font
-    
-    # Sets the page selection.
-    # 
-    # Calling this method will generate a page change event.
-    # @param new_page [Integer] 
-    # @return [Integer]
-    def set_selection(new_page) end
-    alias_method :selection=, :set_selection
-    
-    # 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 {Wx::AUI::AuiNotebook#set_uniform_bitmap_size}.
-    # Specifying -1 as the height will return the control to its default auto-sizing behaviour.
-    # @param height [Integer] 
-    # @return [void]
-    def set_tab_ctrl_height(height) end
-    alias_method :tab_ctrl_height=, :set_tab_ctrl_height
-    
-    # Ensure that all tabs have the same height, even if some of them don't have bitmaps.
-    # 
-    # Passing {Wx::DEFAULT_SIZE} as size undoes the effect of a previous call to this function and instructs the control to use dynamic tab height.
-    # @param size [Array(Integer, Integer), Wx::Size] 
-    # @return [void]
-    def set_uniform_bitmap_size(size) end
-    alias_method :uniform_bitmap_size=, :set_uniform_bitmap_size
-    
-    # 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: {Wx::Direction::TOP}, {Wx::Direction::BOTTOM}, {Wx::Direction::LEFT}, or {Wx::Direction::RIGHT}.
-    # @param page [Integer] 
-    # @param direction [Integer] 
-    # @return [void]
-    def split(page, direction) end
-    
-    # Shows the window menu for the active tab control associated with this notebook, and returns true if a selection was made.
-    # @return [Boolean]
-    def show_window_menu; end
-    
-    # Returns the image index for the given page.
-    # @param nPage [Integer] 
-    # @return [Integer]
-    def get_page_image(nPage) end
-    alias_method :page_image, :get_page_image
-    
-    # Returns tab control based on point coordinates inside the tab frame.
-    # @param pt [Array(Integer, Integer), Wx::Point] 
-    # @return [Wx::AUI::AuiTabCtrl]
-    def get_tab_ctrl_from_point(pt) end
-    alias_method :tab_ctrl_from_point, :get_tab_ctrl_from_point
-    
-    # Returns active tab control for this notebook.
-    # @return [Wx::AUI::AuiTabCtrl]
-    def get_active_tab_ctrl; end
-    alias_method :active_tab_ctrl, :get_active_tab_ctrl
-    
-  end # AuiNotebook
-  
-  # A simple class which holds information about the notebook's pages and their state.
-  # 
-  # Category:  Window Docking (wxAUI)
-  # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-  # @wxrb_require USE_AUI
-  class AuiNotebookPage < ::Object
-  
-    # 
-    # 
-    # 
-    # @return [Wx::Window]
-    def window; end
-    # 
-    # 
-    # 
-    # @param val [Wx::Window]
-    # @return [void]
-    def window=(val); end
-    
-    # 
-    # 
-    # 
-    # @return [String]
-    def caption; end
-    # 
-    # 
-    # 
-    # @param val [String]
-    # @return [void]
-    def caption=(val); end
-    
-    # 
-    # 
-    # 
-    # @return [String]
-    def tooltip; end
-    # 
-    # 
+  module Wx::AUI
+
+    # {Wx::AUI::AuiNotebook} is part of the {Wx::AUI} class framework, which represents a notebook control, managing multiple windows with associated tabs.
     # 
-    # @param val [String]
-    # @return [void]
-    def tooltip=(val); end
-    
+    # See also wxAUI Overview.
+    # {Wx::AUI::AuiNotebook} is a notebook control which implements many features common in applications with dockable panes. Specifically, {Wx::AUI::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 {Wx::AUI::AuiDefaultTabArt}, which provides a modern, glossy look and feel. The theme can be changed by calling {Wx::AUI::AuiNotebook#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}. 
     # 
-    # @return [Wx::BitmapBundle]
-    def bitmap; end
+    # - {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. 
     # 
-    # @param val [Wx::BitmapBundle]
-    # @return [void]
-    def bitmap=(val); end
-    
+    # - {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. 
     # 
-    # @return [Wx::Rect]
-    def rect; end
+    # - {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. 
     # 
-    # @param val [Wx::Rect]
-    # @return [void]
-    def rect=(val); end
-    
+    # - {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. 
     # 
-    # @return [Boolean]
-    def active; end
+    # ### Events emitted by this class
     # 
+    # The following event-handler methods redirect the events to member method or handler blocks for {Wx::AUI::AuiNotebookEvent} events.
+    # Event handler methods for events emitted by this class:
     # 
+    # - {Wx::EvtHandler#evt_auinotebook_page_close}(id, meth = nil, &block): A page is about to be closed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSE} event. 
     # 
-    # @param val [Boolean]
-    # @return [void]
-    def active=(val); end
+    # - {Wx::EvtHandler#evt_auinotebook_page_closed}(winid, meth = nil, &block): A page has been closed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSED} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGED} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGING} event. This event can be vetoed. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_button}(id, meth = nil, &block): The window list button has been pressed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BUTTON} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_begin_drag}(id, meth = nil, &block): Dragging is about to begin. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BEGIN_DRAG} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_end_drag}(id, meth = nil, &block): Dragging has ended. Processes a {Wx::AUI::EVT_AUINOTEBOOK_END_DRAG} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_drag_motion}(id, meth = nil, &block): Emitted during a drag and drop operation. Processes a {Wx::AUI::EVT_AUINOTEBOOK_DRAG_MOTION} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_allow_dnd}(id, meth = nil, &block): Whether to allow a tab to be dropped. Processes a {Wx::AUI::EVT_AUINOTEBOOK_ALLOW_DND} event. This event must be specially allowed. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_drag_done}(winid, meth = nil, &block): Notify that the tab has been dragged. Processes a {Wx::AUI::EVT_AUINOTEBOOK_DRAG_DONE} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_tab_middle_down}(winid, meth = nil, &block): The middle mouse button is pressed on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_tab_middle_up}(winid, meth = nil, &block): The middle mouse button is released on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_UP} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_tab_right_down}(winid, meth = nil, &block): The right mouse button is pressed on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_DOWN} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_tab_right_up}(winid, meth = nil, &block): The right mouse button is released on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_UP} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_bg_dclick}(winid, meth = nil, &block): Double clicked on the tabs background area. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BG_DCLICK} event. 
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiNotebook < BookCtrlBase
+    
+      # @overload initialize()
+      #   Default ctor.
+      #   @return [Wx::AUI::AuiNotebook]
+      # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE)
+      #   Constructor.
+      #   
+      #   Creates a {Wx::AuiNotebok} control.
+      #   @param parent [Wx::Window] 
+      #   @param id [Integer] 
+      #   @param pos [Array(Integer, Integer), Wx::Point] 
+      #   @param size [Array(Integer, Integer), Wx::Size] 
+      #   @param style [Integer] 
+      #   @return [Wx::AUI::AuiNotebook]
+      def initialize(*args) end
+      
+      # @overload add_page(page, caption, select=false, bitmap=(Wx::BitmapBundle.new()))
+      #   Adds a page.
+      #   
+      #   If the select parameter is true, calling this will generate a page change event.
+      #   @param page [Wx::Window] 
+      #   @param caption [String] 
+      #   @param select [Boolean] 
+      #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+      #   @return [Boolean]
+      # @overload add_page(page, text, select, imageId)
+      #   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.
+      #   
+      #   <div class="wxrb-remark">
+      #   <b>Remark:</b>
+      #   <p>Do not delete the page, it will be deleted by the book control.
+      #   </p>
+      #   </div>
+      #   @see Wx::AUI::AuiNotebook#insert_page 
+      #   @param page [Wx::Window]  Specifies the new page.
+      #   @param text [String]  Specifies the text for the new page.
+      #   @param select [Boolean]  Specifies whether the page should be selected.
+      #   @param imageId [Integer]  Specifies the optional image index for the new page.
+      #   @return [Boolean]
+      def add_page(*args) end
+      
+      # Sets the selection to the next or previous page.
+      # @param forward [Boolean] 
+      # @return [void]
+      def advance_selection(forward=true) end
+      
+      # Changes the selection for the given page, returning the previous selection.
+      # 
+      # This function behaves as {Wx::AUI::AuiNotebook#set_selection} but does not generate the page changing events.
+      # See User Generated Events vs Programmatically Generated Events for more information.
+      # @param n [Integer] 
+      # @return [Integer]
+      def change_selection(n) end
+      
+      # Creates the notebook window.
+      # @param parent [Wx::Window] 
+      # @param id [Integer] 
+      # @param pos [Array(Integer, Integer), Wx::Point] 
+      # @param size [Array(Integer, Integer), Wx::Size] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0) end
+      
+      # Deletes all pages.
+      # @return [Boolean]
+      def delete_all_pages; end
+      
+      # Deletes a page at the given index.
+      # 
+      # Calling this method will generate a page change event.
+      # @param page [Integer] 
+      # @return [Boolean]
+      def delete_page(page) end
+      
+      # Returns the associated art provider.
+      # @return [Wx::AUI::AuiTabArt]
+      def get_art_provider; end
+      alias_method :art_provider, :get_art_provider
+      
+      # Returns the currently selected page or NULL.
+      # @return [Wx::Window]
+      def get_current_page; end
+      alias_method :current_page, :get_current_page
+      
+      # Returns the desired height of the notebook for the given page height.
+      # 
+      # Use this to fit the notebook to a given page size.
+      # @param pageHeight [Integer] 
+      # @return [Integer]
+      def get_height_for_page_height(pageHeight) end
+      alias_method :height_for_page_height, :get_height_for_page_height
+      
+      # Returns the page specified by the given index.
+      # @param page_idx [Integer] 
+      # @return [Wx::Window]
+      def get_page(page_idx) end
+      alias_method :page, :get_page
+      
+      # Returns the tab bitmap for the page.
+      # @param page [Integer] 
+      # @return [Wx::Bitmap]
+      def get_page_bitmap(page) end
+      alias_method :page_bitmap, :get_page_bitmap
+      
+      # Returns the number of pages in the notebook.
+      # @return [Integer]
+      def get_page_count; end
+      alias_method :page_count, :get_page_count
+      
+      # Returns the page index for the specified window.
+      # 
+      # If the window is not found in the notebook, {Wx::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.
+      # @param page_wnd [Wx::Window] 
+      # @return [Integer]
+      def get_page_index(page_wnd) end
+      alias_method :page_index, :get_page_index
+      
+      # Returns the tab label for the page.
+      # @param page [Integer] 
+      # @return [String]
+      def get_page_text(page) end
+      alias_method :page_text, :get_page_text
+      
+      # Returns the tooltip for the tab label of the page.
+      # @param pageIdx [Integer] 
+      # @return [String]
+      def get_page_tool_tip(pageIdx) end
+      alias_method :page_tool_tip, :get_page_tool_tip
+      
+      # Returns the currently selected page.
+      # @return [Integer]
+      def get_selection; end
+      alias_method :selection, :get_selection
+      
+      # Returns the height of the tab control.
+      # @return [Integer]
+      def get_tab_ctrl_height; end
+      alias_method :tab_ctrl_height, :get_tab_ctrl_height
+      
+      # @overload insert_page(page_idx, page, caption, select=false, bitmap=(Wx::BitmapBundle.new()))
+      #   {Wx::AUI::AuiNotebook#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.
+      #   @param page_idx [Integer] 
+      #   @param page [Wx::Window] 
+      #   @param caption [String] 
+      #   @param select [Boolean] 
+      #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+      #   @return [Boolean]
+      # @overload insert_page(index, page, text, select, imageId)
+      #   Inserts a new page at the specified position.
+      #   
+      #   true if successful, false otherwise.
+      #   
+      #   <div class="wxrb-remark">
+      #   <b>Remark:</b>
+      #   <p>Do not delete the page, it will be deleted by the book control.
+      #   </p>
+      #   </div>
+      #   @see Wx::AUI::AuiNotebook#add_page 
+      #   @param index [Integer]  Specifies the position for the new page.
+      #   @param page [Wx::Window]  Specifies the new page.
+      #   @param text [String]  Specifies the text for the new page.
+      #   @param select [Boolean]  Specifies whether the page should be selected.
+      #   @param imageId [Integer]  Specifies the optional image index for the new page.
+      #   @return [Boolean]
+      def insert_page(*args) end
+      
+      # Removes a page, without deleting the window pointer.
+      # @param page [Integer] 
+      # @return [Boolean]
+      def remove_page(page) end
+      
+      # Sets the art provider to be used by the notebook.
+      # @param art [Wx::AUI::AuiTabArt] 
+      # @return [void]
+      def set_art_provider(art) end
+      alias_method :art_provider=, :set_art_provider
+      
+      # Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.
+      # @param font [Wx::Font,Wx::FontInfo] 
+      # @return [Boolean]
+      def set_font(font) end
+      alias_method :font=, :set_font
+      
+      # Sets the font for measuring tab labels.
+      # @param font [Wx::Font,Wx::FontInfo] 
+      # @return [void]
+      def set_measuring_font(font) end
+      alias_method :measuring_font=, :set_measuring_font
+      
+      # Sets the font for drawing unselected tab labels.
+      # @param font [Wx::Font,Wx::FontInfo] 
+      # @return [void]
+      def set_normal_font(font) end
+      alias_method :normal_font=, :set_normal_font
+      
+      # Sets the bitmap for the page.
+      # 
+      # To remove a bitmap from the tab caption, pass an empty {Wx::BitmapBundle}.
+      # @param page [Integer] 
+      # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+      # @return [Boolean]
+      def set_page_bitmap(page, bitmap) end
+      
+      # Sets the image index for the given page.
+      # 
+      # image is an index into the image list which was set with {Wx::AUI::AuiNotebook#set_image_list}.
+      # @param n [Integer] 
+      # @param imageId [Integer] 
+      # @return [Boolean]
+      def set_page_image(n, imageId) end
+      
+      # Sets the tab label for the page.
+      # @param page [Integer] 
+      # @param text [String] 
+      # @return [Boolean]
+      def set_page_text(page, text) end
+      
+      # 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.
+      # @param page [Integer] 
+      # @param text [String] 
+      # @return [Boolean]
+      def set_page_tool_tip(page, text) end
+      
+      # Sets the font for drawing selected tab labels.
+      # @param font [Wx::Font,Wx::FontInfo] 
+      # @return [void]
+      def set_selected_font(font) end
+      alias_method :selected_font=, :set_selected_font
+      
+      # Sets the page selection.
+      # 
+      # Calling this method will generate a page change event.
+      # @param new_page [Integer] 
+      # @return [Integer]
+      def set_selection(new_page) end
+      alias_method :selection=, :set_selection
+      
+      # 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 {Wx::AUI::AuiNotebook#set_uniform_bitmap_size}.
+      # Specifying -1 as the height will return the control to its default auto-sizing behaviour.
+      # @param height [Integer] 
+      # @return [void]
+      def set_tab_ctrl_height(height) end
+      alias_method :tab_ctrl_height=, :set_tab_ctrl_height
+      
+      # Ensure that all tabs have the same height, even if some of them don't have bitmaps.
+      # 
+      # Passing {Wx::DEFAULT_SIZE} as size undoes the effect of a previous call to this function and instructs the control to use dynamic tab height.
+      # @param size [Array(Integer, Integer), Wx::Size] 
+      # @return [void]
+      def set_uniform_bitmap_size(size) end
+      alias_method :uniform_bitmap_size=, :set_uniform_bitmap_size
+      
+      # 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: {Wx::Direction::TOP}, {Wx::Direction::BOTTOM}, {Wx::Direction::LEFT}, or {Wx::Direction::RIGHT}.
+      # @param page [Integer] 
+      # @param direction [Integer] 
+      # @return [void]
+      def split(page, direction) end
+      
+      # Shows the window menu for the active tab control associated with this notebook, and returns true if a selection was made.
+      # @return [Boolean]
+      def show_window_menu; end
+      
+      # Returns the image index for the given page.
+      # @param nPage [Integer] 
+      # @return [Integer]
+      def get_page_image(nPage) end
+      alias_method :page_image, :get_page_image
+      
+      # Returns tab control based on point coordinates inside the tab frame.
+      # @param pt [Array(Integer, Integer), Wx::Point] 
+      # @return [Wx::AUI::AuiTabCtrl]
+      def get_tab_ctrl_from_point(pt) end
+      alias_method :tab_ctrl_from_point, :get_tab_ctrl_from_point
+      
+      # Returns active tab control for this notebook.
+      # @return [Wx::AUI::AuiTabCtrl]
+      def get_active_tab_ctrl; end
+      alias_method :active_tab_ctrl, :get_active_tab_ctrl
+      
+    end # AuiNotebook
+    
+    # A simple class which holds information about the notebook's pages and their state.
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_AUI
+    class AuiNotebookPage < ::Object
+    
+      # 
+      # 
+      # 
+      # @return [Wx::Window]
+      def window; end
+      # 
+      # 
+      # 
+      # @param val [Wx::Window]
+      # @return [void]
+      def window=(val); end
+      
+      # 
+      # 
+      # 
+      # @return [String]
+      def caption; end
+      # 
+      # 
+      # 
+      # @param val [String]
+      # @return [void]
+      def caption=(val); end
+      
+      # 
+      # 
+      # 
+      # @return [String]
+      def tooltip; end
+      # 
+      # 
+      # 
+      # @param val [String]
+      # @return [void]
+      def tooltip=(val); end
+      
+      # 
+      # 
+      # 
+      # @return [Wx::BitmapBundle]
+      def bitmap; end
+      # 
+      # 
+      # 
+      # @param val [Wx::BitmapBundle]
+      # @return [void]
+      def bitmap=(val); end
+      
+      # 
+      # 
+      # 
+      # @return [Wx::Rect]
+      def rect; end
+      # 
+      # 
+      # 
+      # @param val [Wx::Rect]
+      # @return [void]
+      def rect=(val); end
+      
+      # 
+      # 
+      # 
+      # @return [Boolean]
+      def active; end
+      # 
+      # 
+      # 
+      # @param val [Boolean]
+      # @return [void]
+      def active=(val); end
+      
+    end # AuiNotebookPage
     
-  end # AuiNotebookPage
-  
 
-end
+    end
+
+  end