wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,631 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module 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 since wxWidgets 3.3.0 is {Wx::AUI::AuiFlatTabArt}. If you would prefer to use the theme which used to be default in the previous versions, you can call {Wx::AUI::AuiNotebook#set_art_provider} with {Wx::AUI::AuiNativeTabArt} as the argument. Notice that {Wx::AUI::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, {Wx::AUI::AuiNotebook} creates the main tab control, which can be retrieved using {Wx::AUI::AuiNotebook#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, {Wx::AUI::AuiNotebook#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 {Wx::AUI::AuiNotebook#get_active_tab_ctrl} and is always used for appending or inserting new pages. You can also use {Wx::AUI::AuiNotebook#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 {Wx::AUI::AuiNotebook#set_page_text}, work with logical indices. Similarly, functions returning a page index, such as {Wx::AUI::AuiNotebook#get_selection}, also always return logical indices. To get the physical position of a single page, use {Wx::AUI::AuiNotebook#get_page_position} and to get all pages in some tab control in their physical, display order {Wx::AUI::AuiNotebook#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 {Wx::AUI::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 {Wx::AUI::AuiNotebook#save_layout} and {Wx::AUI::AuiNotebook#load_layout} functions of this class.
+    # Using them is similar to using {Wx::AUI::AuiManager} functions, except they only require implementing {Wx::AUI::AuiBookSerializer} or {Wx::AUI::AuiBookDeserializer} interface, which is a subset of the full {Wx::AUI::AuiSerializer} or {Wx::AUI::AuiDeserializer}. The page_samples_aui shows how to use them.
+    # ### 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. Note that this style is ignored if {Wx::AUI::AuiNotebookOption::AUI_NB_MULTILINE} is used. 
+    # 
+    # - {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. 
+    # 
+    # - {Wx::AUI::AuiNotebookOption::AUI_NB_MULTILINE}: If this style is specified and all the tabs don't fit in the visible area, multiple rows of tabs are used instead of adding a button allowing to scroll them. This style is only available in wxWidgets 3.3.0 or later. 
+    # 
+    # - {Wx::AUI::AuiNotebookOption::AUI_NB_PIN_ON_ACTIVE_TAB}: If this style is specified, the active tab shows either a "pin" icon allowing to pin it (i.e. change its kind to {Wx::AUI::AuiTabKind::Pinned}) if it's not currently pinned or an "unpin" icon to change the kind back to normal. This style is not included in the default notebook style and has to be explicitly specified for the user to be able to pin the tabs interactively. It is available in wxWidgets 3.3.0 or later. 
+    # 
+    # - {Wx::AUI::AuiNotebookOption::AUI_NB_UNPIN_ON_ALL_PINNED}: If this style is specified, "unpin" button is shown on all currently pinned tabs, allowing the user to unpin them, i.e. make them normal again. This style can be combined with {Wx::AUI::AuiNotebookOption::AUI_NB_PIN_ON_ACTIVE_TAB} or used on its own. It is available in wxWidgets 3.3.0 or later. 
+    # 
+    # ### 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. 
+    # 
+    # Please see the note in {Wx::AUI::AuiNotebookEvent} documentation about handling these events.
+    # 
+    # 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]
+      # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AUI::AuiNotebookOption::AUI_NB_DEFAULT_STYLE, &block)
+      #   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] 
+      #   @yieldparam [Wx::AUI::AuiNotebook] win new instance
+      #   @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 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.
+      # @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 nil.
+      # @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 kind for the page.
+      # 
+      # See {Wx::AUI::AuiNotebook#set_page_kind}.
+      # @param pageIdx [Integer] 
+      # @return [Wx::AuiTabKind]
+      def get_page_kind(pageIdx) end
+      alias_method :page_kind, :get_page_kind
+      
+      # 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 <code>page1 + 1 == page2</code> 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.
+      # @param page [Integer] 
+      # @return [Wx::AUI::AuiNotebookPosition]
+      def get_page_position(page) end
+      alias_method :page_position, :get_page_position
+      
+      # 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 {Wx::AUI::AuiNotebook#get_active_tab_ctrl} and {Wx::AUI::AuiNotebook#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.
+      # @param tabCtrl [Wx::AUI::AuiTabCtrl] 
+      # @return [Array<Integer>]
+      def get_pages_in_display_order(tabCtrl) end
+      alias_method :pages_in_display_order, :get_pages_in_display_order
+      
+      # 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(index, page, text, 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.
+      #   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 {Wx::AUI::AuiNotebook#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 {Wx::AUI::AuiNotebook#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.
+      #   
+      #   <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 page before which the new page should be inserted.
+      #   @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 bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Specifies the optional bitmap to use for the new page.
+      #   @return [Boolean]
+      # @overload insert_page(index, page, text, select, imageId)
+      #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+      #   @param index [Integer] 
+      #   @param page [Wx::Window] 
+      #   @param text [String] 
+      #   @param select [Boolean] 
+      #   @param imageId [Integer] 
+      #   @return [Boolean]
+      def insert_page(*args) end
+      
+      # Load the previously saved layout of the notebook.
+      # 
+      # This function is used to restore the layout previously saved by {Wx::AUI::AuiNotebook#save_layout}.
+      # @see Wx::AUI::AuiManager#load_layout
+      # @param name [String]  Used as argument for {Wx::AUI::AuiBookDeserializer#load_notebook_tabs} call.
+      # @param deserializer [Wx::AUI::AuiBookDeserializer]  The object to use for restoring the layout.
+      # @return [void]
+      def load_layout(name, deserializer) end
+      
+      # Removes a page, without deleting the window pointer.
+      # @param page [Integer] 
+      # @return [Boolean]
+      def remove_page(page) end
+      
+      # 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 {Wx::AUI::AuiNotebook#load_layout} should be able to restore it from the same name.
+      # @see Wx::AUI::AuiManager#save_layout
+      # @param name [String]  Used as argument for {Wx::AUI::AuiBookSerializer#before_save_notebook} call.
+      # @param serializer [Wx::AUI::AuiBookSerializer]  The object to use for saving the layout.
+      # @return [void]
+      def save_layout(name, serializer) 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 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
+      #   );
+      # ```
+      # @see Wx::AUI::AuiManager#set_flags
+      # @see  Wx::AUI::AuiManagerOption
+      # @param flags [Integer] 
+      # @return [void]
+      def set_manager_flags(flags) end
+      alias_method :manager_flags=, :set_manager_flags
+      
+      # 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
+      
+      # 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):
+      # 
+      # - Shown first are locked tabs which are typically used for showing some different content from the normal (and pinned) tabs. These tabs are special, they're always shown and can't be closed nor moved, by dragging them, by the user.
+      # - Next are pinned tabs: these tabs can be closed and, depending on whether {Wx::AUI::AuiNotebookOption::AUI_NB_PIN_ON_ACTIVE_TAB} and {Wx::AUI::AuiNotebookOption::AUI_NB_UNPIN_ON_ALL_PINNED} styles are specified, can also be unpinned (i.e. made normal) by the user. If {Wx::AUI::AuiNotebookOption::AUI_NB_TAB_MOVE} is specified, they can be moved by dragging them, however they are restricted to remain in the pinned tabs group, i.e. only the order of the pinned tabs can be changed.
+      # - Finally, normal tabs are shown. These tabs can be closed and, depending on {Wx::AUI::AuiNotebookOption::AUI_NB_PIN_ON_ACTIVE_TAB} style, pinned by the user. They can also be moved by dragging them, but only inside the same group.
+      # 
+      # 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.
+      # @param pageIdx [Integer]  The index of the page to change.
+      # @param kind [Wx::AuiTabKind]  The new kind for the page.
+      # @return [Boolean]
+      def set_page_kind(pageIdx, kind) 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.
+      # 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.
+      # @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}.
+      # @see Wx::AUI::AuiNotebook#unsplit_all 
+      # @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
+      
+      # Remove all split tab controls, leaving only the single one.
+      # 
+      # This is the opposite of {Wx::AUI::AuiNotebook#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 {Wx::AUI::AuiNotebook#split} followed by {Wx::AUI::AuiNotebook#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.
+      # @return [void]
+      def unsplit_all; 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.
+      # 
+      # Active tab control is the one containing the currently selected page. If there is no selected page, the main tab control is returned, see {Wx::AUI::AuiNotebook#get_main_tab_ctrl}.
+      # Non-nil pointer to either the active or main tab control.
+      # @return [Wx::AUI::AuiTabCtrl]
+      def get_active_tab_ctrl; end
+      alias_method :active_tab_ctrl, :get_active_tab_ctrl
+      
+      # Returns all tab controls for this notebook.
+      # 
+      # Vector of all tab controls, never empty as it always contains at least the main tab control.
+      # @return [std::vector< wxAuiTabCtrl >]
+      def get_all_tab_ctrls; end
+      alias_method :all_tab_ctrls, :get_all_tab_ctrls
+      
+      # 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.
+      # @return [Wx::AUI::AuiTabCtrl]
+      def get_main_tab_ctrl; end
+      alias_method :main_tab_ctrl, :get_main_tab_ctrl
+      
+    end # AuiNotebook
+    
+    # Holds information about a page in {Wx::AUI::AuiNotebook}.
+    # 
+    # An object of this class is notably passed to {Wx::AUI::AuiTabArt#draw_tab} and is used by it to render the pages tab accordingly.
+    # 
+    # 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
+    
+      # Window shown on this page.
+      # 
+      # 
+      # @return [Wx::Window]
+      def window; end
+      # Window shown on this page.
+      # 
+      # 
+      # @param val [Wx::Window]
+      # @return [void]
+      def window=(val); end
+      
+      # Text displayed on the tab.
+      # 
+      # 
+      # @return [String]
+      def caption; end
+      # Text displayed on the tab.
+      # 
+      # 
+      # @param val [String]
+      # @return [void]
+      def caption=(val); end
+      
+      # Tooltip displayed when hovering over tab title.
+      # 
+      # 
+      # @return [String]
+      def tooltip; end
+      # Tooltip displayed when hovering over tab title.
+      # 
+      # 
+      # @param val [String]
+      # @return [void]
+      def tooltip=(val); end
+      
+      # Bitmap shown in the tab if valid.
+      # 
+      # 
+      # @return [Wx::BitmapBundle]
+      def bitmap; end
+      # Bitmap shown in the tab if valid.
+      # 
+      # 
+      # @param val [Wx::BitmapBundle]
+      # @return [void]
+      def bitmap=(val); end
+      
+      # True if the page is the currently selected page.
+      # 
+      # 
+      # @return [Boolean]
+      def active; end
+      # True if the page is the currently selected page.
+      # 
+      # 
+      # @param val [Boolean]
+      # @return [void]
+      def active=(val); end
+      
+    end # AuiNotebookPage
+    
+    # Simple struct combining {Wx::AUI::AuiTabCtrl} with the position inside it.
+    # 
+    # This information fully determines the position of the page in {Wx::AUI::AuiNotebook}, see {Wx::AUI::AuiNotebook#get_page_position}.
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_AUI
+    class AuiNotebookPosition < ::Object
+    
+      # Tab control containing the page or nil if the position is invalid.
+      # 
+      # 
+      # @return [Wx::AUI::AuiTabCtrl]
+      def tab_ctrl; end
+      
+      # Index of the page in this tab control or {Wx::NOT_FOUND} if invalid.
+      # 
+      # 
+      # @return [Integer]
+      def tab_idx; end
+      
+    end # AuiNotebookPosition
+    
+
+  end
+
+end