wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,847 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module AUI
+
+    # {Wx::AUI::AuiManager} is the central class of the {Wx::AUI} class framework.
+    # 
+    # {Wx::AUI::AuiManager} manages the panes associated with it for a particular window, using a pane's {Wx::AUI::AuiPaneInfo} information to determine each pane's docking and floating behaviour.
+    # {Wx::AUI::AuiManager} uses wxWidgets' sizer mechanism to plan the layout of each frame. It uses a replaceable dock art class to do all drawing, so all drawing is localized in one area, and may be customized depending on an application's specific needs.
+    # {Wx::AUI::AuiManager} works as follows: the programmer adds panes to the class, or makes changes to existing pane properties (dock position, floating state, show state, etc.). To apply these changes, {Wx::AUI::AuiManager}'s {Wx::AUI::AuiManager#update} function is called. This batch processing can be used to avoid flicker, by modifying more than one pane at a time, and then "committing" all of the changes at once by calling {Wx::AUI::AuiManager#update}.
+    # Panes can be added using {Wx::AUI::AuiManager#add_pane}:
+    # 
+    # ```ruby
+    #   @text1 = Wx::TextCtrl.new(self, -1)
+    #   @text2 = Wx::TextCtrl.new(self, -1)
+    #   @mgr.add_pane(@text1, Wx::LEFT, 'Pane Caption')
+    #   @mgr.add_pane(@text2, Wx::BOTTOM, 'Pane Caption')
+    #   @mgr.update
+    # ```
+    # 
+    # Later on, the positions and other attributes can be modified, e.g. the following will float an existing pane in a tool window:
+    # 
+    # ```ruby
+    #   @mgr.get_pane(@text1).float
+    # ```
+    # 
+    # ## Layers, Rows and Directions, Positions
+    # Inside {Wx::AUI}, the docking layout is figured out by checking several pane parameters. Four of these are important for determining where a pane will end up:
+    # 
+    # - Direction: Each docked pane has a direction, Top, Bottom, Left, Right, or Center. This is fairly self-explanatory. The pane will be placed in the location specified by this variable. 
+    # 
+    # - Position: More than one pane can be placed inside of a dock. Imagine two panes being docked on the left side of a window. One pane can be placed over another. In proportionally managed docks, the pane position indicates its sequential position, starting with zero. So, in our scenario with two panes docked on the left side, the top pane in the dock would have position 0, and the second one would occupy position 1. 
+    # 
+    # - Row: A row can allow for two docks to be placed next to each other. One of the most common places for this to happen is in the toolbar. Multiple toolbar rows are allowed, the first row being row 0, and the second row 1. Rows can also be used on vertically docked panes. 
+    # 
+    # - Layer: A layer is akin to an onion. Layer 0 is the very center of the managed pane. Thus, if a pane is in layer 0, it will be closest to the center window (also sometimes known as the "content window"). Increasing layers "swallow up" all layers of a lower value. This can look very similar to multiple rows, but is different because all panes in a lower level yield to panes in higher levels. The best way to understand layers is by running the {Wx::AUI} sample.
+    # 
+    # ## Minimizing Panes
+    # Since wxWidgets 3.3.2, {Wx::AUI::AuiManager} supports minimizing panes which have the minimize button, see {Wx::AUI::AuiPaneInfo#minimize_button}. Such panes appear in the special toolbar(s) showing the buttons for all panes that can be minimized and allowing to either hide or show them again.
+    # By default, the toolbars showing the buttons for the minimized panes are created on the left, bottom and right sides of the managed window. You can change this using {Wx::AUI::AuiManager#allow_docks_for_min_panes} but note that you must still allow for the toolbars to be created on at least one side and the only way not to have any such toolbar at all is to not have any panes with minimize button. See {Wx::AUI::AuiManager#set_docks_for_min_panes_style} and {Wx::AUI::AuiPaneInfo#icon_min} for more customization possibilities.
+    # ### Styles
+    # 
+    # This class supports the following styles:
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_ALLOW_FLOATING}: Allow a pane to be undocked to take the form of a {Wx::MiniFrame}. 
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_ALLOW_ACTIVE_PANE}: Change the color of the title bar of the pane when it is activated. 
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_TRANSPARENT_DRAG}: Make the pane transparent during its movement. 
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_TRANSPARENT_HINT}: The possible location for docking is indicated by a translucent area. 
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_VENETIAN_BLINDS_HINT}: The possible location for docking is indicated by gradually appearing partially transparent hint. 
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_RECTANGLE_HINT}: The possible location for docking is indicated by a rectangular outline. Note that this flag doesn't work, i.e. doesn't show any hint in WXGTK and WXOSX, please use one of the hint flags above instead. 
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_HINT_FADE}: The translucent area where the pane could be docked appears gradually. Note that this flag is not included in {Wx::AUI::AuiManagerOption::AUI_MGR_DEFAULT} since wxWidgets 3.3.0 any longer. 
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_NO_VENETIAN_BLINDS_FADE}: This style is obsolete and doesn't do anything, it is only defined as 0 for compatibility. 
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_LIVE_RESIZE}: When a docked pane is resized, its content is refreshed in live (instead of moving the border alone and refreshing the content at the end). Note that this flag is included in {Wx::AUI::AuiManagerOption::AUI_MGR_DEFAULT} and so needs to be explicitly turned off if you don't need. Also note that it is always enabled in WXGTK3 and WXOSX ports as non-live resizing is not implemented in them. 
+    # 
+    # - {Wx::AUI::AuiManagerOption::AUI_MGR_DEFAULT}: Default behaviour, combines {Wx::AUI::AuiManagerOption::AUI_MGR_ALLOW_FLOATING}, {Wx::AUI::AuiManagerOption::AUI_MGR_TRANSPARENT_HINT} and {Wx::AUI::AuiManagerOption::AUI_MGR_LIVE_RESIZE}. 
+    # 
+    # ### Events emitted by this class
+    # 
+    # The following event-handler methods redirect the events to member method or handler blocks for {Wx::AUI::AuiManagerEvent} events.
+    # Event handler methods for events emitted by this class:
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_button}(meth = nil, &block): Triggered when any button is pressed for any docked panes. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_close}(meth = nil, &block): Triggered when a docked or floating pane is closed. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_minimize}(meth = nil, &block): Triggered when a pane is minimized. This event is new since wxWidgets 3.3.2. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_maximize}(meth = nil, &block): Triggered when a pane is maximized. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_restore}(meth = nil, &block): Triggered when a pane is restored. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_activated}(meth = nil, &block): Triggered when a pane is made 'active'. This event is new since wxWidgets 2.9.4. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_render}(meth = nil, &block): This event can be caught to override the default renderer in order to custom draw your {Wx::AUI::AuiManager} window (not recommended). 
+    # 
+    # Category:  Window Docking (wxAUI)
+    # @see wxAUI Overview
+    # @see  Wx::AUI::AuiNotebook
+    # @see  Wx::AUI::AuiDockArt
+    # @see  Wx::AUI::AuiPaneInfo 
+    # 
+    # 
+    # @wxrb_require USE_AUI
+    class AuiManager < EvtHandler
+    
+      # Constructor.
+      # @param managedWindow [Wx::Window]  Specifies the window which will contain AUI panes. If it is not specified here, it must be set later using {Wx::AUI::AuiManager#set_managed_window}.
+      # @param flags [Integer]  Specifies the frame management behaviour and visual effects with the {Wx::AUI::AuiManagerOption}'s style flags.
+      # @return [Wx::AUI::AuiManager]
+      def initialize(managedWindow=nil, flags=Wx::AUI::AuiManagerOption::AUI_MGR_DEFAULT) end
+      
+      # @overload add_pane(window, pane_info)
+      #   {Wx::AUI::AuiManager#add_pane} tells the frame manager to start managing a child window.
+      #   
+      #   There are several versions of this function. The first version allows the full spectrum of pane parameter possibilities. The second version is used for simpler user interfaces which do not require as much configuration. The last version allows a drop position to be specified, which will determine where the pane will be added.
+      #   @param window [Wx::Window] 
+      #   @param pane_info [Wx::AUI::AuiPaneInfo] 
+      #   @return [Boolean]
+      # @overload add_pane(window, direction=Wx::Direction::LEFT, caption=(''))
+      #   @param window [Wx::Window] 
+      #   @param direction [Integer] 
+      #   @param caption [String] 
+      #   @return [Boolean]
+      # @overload add_pane(window, pane_info, drop_pos)
+      #   @param window [Wx::Window] 
+      #   @param pane_info [Wx::AUI::AuiPaneInfo] 
+      #   @param drop_pos [Array(Integer, Integer), Wx::Point] 
+      #   @return [Boolean]
+      def add_pane(*args) end
+      
+      # Change the sides where docks for minimized panes can be created.
+      # 
+      # The argument direction must be a combination of one or more of {Wx::Direction::LEFT}, {Wx::Direction::RIGHT}, {Wx::Direction::TOP} and {Wx::Direction::BOTTOM} flags.
+      # This function must currently be called before there any minimized panes, so it is recommended to call it before adding any panes at all.
+      # Example of using this function to only allow docks showing the buttons for the minimized panes on the left and right sides of the window: 
+      # ```
+      #   mgr.AllowDocksForMinPanes(wxLEFT | wxRIGHT);
+      #   
+      #   // This pane will be shown in the toolbar on the left side of the
+      #   // window.
+      #   mgr.AddPane(someWindow, wxAuiPaneInfo().Left().MinimizeButton());
+      #   
+      #   // But so will will this one, as creating a toolbar along the bottom
+      #   // side is not allowed.
+      #   mgr.AddPane(otherWindow, wxAuiPaneInfo().Bottom().MinimizeButton());
+      # ```
+      # @param directions [Integer] 
+      # @return [void]
+      def allow_docks_for_min_panes(directions) end
+      
+      # Set style of for the items representing minimized panes in the docking toolbars.
+      # 
+      # If {Wx::AUI::AuiMinDockOption::AUI_MIN_DOCK_ICONS} is specified as part of the style, the pane icon specified by {Wx::AUI::AuiPaneInfo#icon_min} or, if it is not set, {Wx::AUI::AuiPaneInfo#icon}, will be shown for the minimized panes.
+      # If {Wx::AUI::AuiMinDockOption::AUI_MIN_DOCK_TEXT} is specified, the pane title will be shown (possible in addition to its icon). Note that the text will be rendered vertically for the panes shown in the toolbars docked on the left and right sides of the window and that the icons will be rotated to match the text orientation.
+      # By default, both the text and the icons are shown, which corresponds to {Wx::AUI::AuiMinDockOption::AUI_MIN_DOCK_BOTH}. When using this style it may be desired to also use {Wx::AUI::AuiMinDockOption::AUI_MIN_DOCK_ROTATE_ICON_WITH_TEXT} style which makes the icons match the text orientation.
+      # This function must currently be called before there any minimized panes, so it is recommended to call it before adding any panes at all.
+      # @see Wx::AUI::AuiManager#allow_docks_for_min_panes
+      # @param style [Integer]  Combination of {Wx::AUI::AuiMinDockOption} elements.
+      # @return [void]
+      def set_docks_for_min_panes_style(style) end
+      alias_method :docks_for_min_panes_style=, :set_docks_for_min_panes_style
+      
+      # This function is used by controls to calculate the drop hint rectangle.
+      # 
+      # The method first calls DoDrop() to determine the exact position the pane would be at were if dropped.
+      # 
+      # The rectangle hint will be returned in screen coordinates if the pane would indeed become docked at the specified drop point. Otherwise, an empty rectangle is returned.
+      # @param paneWindow [Wx::Window]  The window pointer of the pane being dragged.
+      # @param pt [Array(Integer, Integer), Wx::Point]  The mouse position, in client coordinates.
+      # @param offset [Array(Integer, Integer), Wx::Point]  Describes the offset that the mouse is from the upper-left corner of the item being dragged, 0 by default (since wxWidgets 3.3.0, this parameter had to be specified in the earlier versions).
+      # @return [Wx::Rect]
+      def calculate_hint_rect(paneWindow, pt, offset=(Wx::Point.new(0, 0))) end
+      
+      # Return a reasonable size to use for a new split.
+      # 
+      # This function currently calculates the number of columns and rows in the current layout and returns the size of the managed window divided by one more than that number, i.e. returns half of the available size if there is currently just one row or column, a third if there are two rows or columns, and so on.
+      # The implementation may change in the future, but it will always return some reasonable size to use for a new split.
+      # @see Wx::AUI::AuiManager#split_pane
+      # @see  Wx::AUI::AuiNotebook#calculate_new_split_size
+      # @return [Wx::Size]
+      def calculate_new_split_size; end
+      
+      # Check if a key modifier is pressed (actually {Wx::KeyCode::K_CONTROL} or {Wx::KeyCode::K_ALT}) while dragging the frame to not dock the window.
+      # @param p [Wx::AUI::AuiPaneInfo] 
+      # @return [Boolean]
+      def can_dock_panel(p) end
+      alias_method :can_dock_panel?, :can_dock_panel
+      
+      # Destroys or hides the given pane depending on its flags.
+      # 
+      # 
+      # @see Wx::AUI::AuiPaneInfo#destroy_on_close 
+      # @param paneInfo [Wx::AUI::AuiPaneInfo] 
+      # @return [void]
+      def close_pane(paneInfo) end
+      
+      # Creates a floating frame in this {Wx::AUI::AuiManager} with the given parent and {Wx::AUI::AuiPaneInfo}.
+      # @param parent [Wx::Window] 
+      # @param p [Wx::AUI::AuiPaneInfo] 
+      # @return [Wx::AUI::AuiFloatingFrame]
+      def create_floating_frame(parent, p) end
+      
+      # Tells the {Wx::AUI::AuiManager} to stop managing the pane specified by window.
+      # 
+      # The window, if in a floated frame, is reparented to the frame managed by {Wx::AUI::AuiManager}.
+      # @param window [Wx::Window] 
+      # @return [Boolean]
+      def detach_pane(window) end
+      
+      # This function is used by controls to draw the hint window.
+      # 
+      # It is rarely called, and is mostly used by controls implementing custom pane drag/drop behaviour.
+      # Calling it is equivalent to calling {Wx::AUI::AuiManager#calculate_hint_rect} and {Wx::AUI::AuiManager#update_hint} with the resulting rectangle.
+      # @param paneWindow [Wx::Window]  Window passed to {Wx::AUI::AuiManager#calculate_hint_rect}.
+      # @param pt [Array(Integer, Integer), Wx::Point]  Mouse position passed to {Wx::AUI::AuiManager#calculate_hint_rect}.
+      # @param offset [Array(Integer, Integer), Wx::Point]  Offset passed to {Wx::AUI::AuiManager#calculate_hint_rect}, 0 by default (since wxWidgets 3.3.0, this parameter had to be specified in the earlier versions).
+      # @return [void]
+      def draw_hint_rect(paneWindow, pt, offset=(Wx::Point.new(0, 0))) end
+      
+      # Returns the current art provider being used.
+      # 
+      # 
+      # @see Wx::AUI::AuiDockArt. 
+      # @return [Wx::AUI::AuiDockArt]
+      def get_art_provider; end
+      alias_method :art_provider, :get_art_provider
+      
+      # Returns the current dock constraint values.
+      # 
+      # See {Wx::AUI::AuiManager#set_dock_size_constraint} for more information.
+      # @return [Array(Float,Float)]
+      def get_dock_size_constraint; end
+      alias_method :dock_size_constraint, :get_dock_size_constraint
+      
+      # Returns the current {Wx::AUI::AuiManagerOption}'s flags.
+      # @return [Integer]
+      def get_flags; end
+      alias_method :flags, :get_flags
+      
+      # Returns the frame currently being managed by {Wx::AUI::AuiManager}.
+      # @return [Wx::Window]
+      def get_managed_window; end
+      alias_method :managed_window, :get_managed_window
+      
+      # @overload get_pane(window)
+      #   {Wx::AUI::AuiManager#get_pane} is used to lookup a {Wx::AUI::AuiPaneInfo} object either by window pointer or by pane name, which acts as a unique id for a window pane.
+      #   
+      #   The returned {Wx::AUI::AuiPaneInfo} object may then be modified to change a pane's look, state or position. After one or more modifications to {Wx::AUI::AuiPaneInfo}, {Wx::AUI::AuiManager#update} should be called to commit the changes to the user interface. If the lookup failed (meaning the pane could not be found in the manager), a call to the returned {Wx::AUI::AuiPaneInfo}'s IsOk() method will return false.
+      #   @param window [Wx::Window] 
+      #   @return [Wx::AUI::AuiPaneInfo]
+      # @overload get_pane(name)
+      #   @param name [String] 
+      #   @return [Wx::AUI::AuiPaneInfo]
+      def get_pane(*args) end
+      alias_method :pane, :get_pane
+      
+      # Returns true if windows are resized live.
+      # 
+      # This function combines the check for {Wx::AUI::AuiManager.always_uses_live_resize} and, for the platforms where live resizing is optional, the check for {Wx::AUI::AuiManagerOption::AUI_MGR_LIVE_RESIZE} flag.
+      # Using this accessor allows to verify whether live resizing is being actually used.
+      # @return [Boolean]
+      def has_live_resize; end
+      alias_method :has_live_resize?, :has_live_resize
+      
+      # {Wx::AUI::AuiManager#hide_hint} hides any docking hint that may be visible.
+      # 
+      # 
+      # @see Wx::AUI::AuiManager#update_hint 
+      # @return [void]
+      def hide_hint; end
+      
+      # This method is used to insert either a previously unmanaged pane window into the frame manager, or to insert a currently managed pane somewhere else.
+      # 
+      # {Wx::AUI::AuiManager#insert_pane} will push all panes, rows, or docks aside and insert the window into the position specified by insert_location.
+      # Because insert_location can specify either a pane, dock row, or dock layer, the insert_level parameter is used to disambiguate this. The parameter insert_level can take a value of {Wx::AUI_INSERT_PANE}, {Wx::AUI_INSERT_ROW} or {Wx::AUI_INSERT_DOCK}.
+      # @param window [Wx::Window] 
+      # @param insert_location [Wx::AUI::AuiPaneInfo] 
+      # @param insert_level [Integer] 
+      # @return [Boolean]
+      def insert_pane(window, insert_location, insert_level=Wx::AUI_INSERT_PANE) end
+      
+      # Load the layout information saved by {Wx::AUI::AuiManager#save_layout}.
+      # 
+      # The implementation of {Wx::AUI::AuiDeserializer} object passed to this function should be consistent with that of the serializer used to save the layout. See page_samples_aui for an example of using serializer saving the layout in XML format and matching deserializer restoring the layout from it.
+      # @param deserializer [Wx::AUI::AuiDeserializer] 
+      # @return [void]
+      def load_layout(deserializer) end
+      
+      # {Wx::AUI::AuiManager#load_pane_info} is similar to LoadPerspective, with the exception that it only loads information about a single pane.
+      # 
+      # This method writes the serialized data into the passed pane. Pointers to UI elements are not modified.
+      # 
+      # <div class="wxrb-note">
+      # <b>Note:</b>
+      # <p>This operation also changes the name in the pane information!
+      # </p>
+      # </div>
+      # @see Wx::AUI::AuiManager#load_perspective 
+      # 
+      # @see Wx::AUI::AuiManager#save_pane_info 
+      # 
+      # @see Wx::AUI::AuiManager#save_perspective 
+      # @param pane_part [String] 
+      # @param pane [Wx::AUI::AuiPaneInfo] 
+      # @return [void]
+      def load_pane_info(pane_part, pane) end
+      
+      # Loads a saved perspective.
+      # 
+      # This function is used to load layouts previously saved with {Wx::AUI::AuiManager#save_perspective}, use {Wx::AUI::AuiManager#load_layout} to load a layout saved with {Wx::AUI::AuiManager#save_layout}.
+      # A perspective is the layout state of an AUI managed window.
+      # All currently existing panes that have an object in "perspective" with the same name ("equivalent") will receive the layout parameters of the object in "perspective". Existing panes that do not have an equivalent in "perspective" remain unchanged, objects in "perspective" having no equivalent in the manager are ignored.
+      # @see Wx::AUI::AuiManager#load_pane_info 
+      # 
+      # @see Wx::AUI::AuiManager#load_perspective 
+      # 
+      # @see Wx::AUI::AuiManager#save_perspective 
+      # @param perspective [String]  Serialized layout information of a perspective (excl. pointers to UI elements).
+      # @param update [Boolean]  If update is true, {Wx::AUI::AuiManager#update} is automatically invoked, thus realizing the specified perspective on screen.
+      # @return [Boolean]
+      def load_perspective(perspective, update=true) end
+      
+      # Minimize the given pane.
+      # 
+      # Note that the pane <b>must</b> have the minimize button enabled for this function to work, it cannot be used to minimize the panes without it.
+      # Minimizing a pane hides it, but it can be later shown again by the user by clicking the button corresponding to it in the minimized panes toolbar.
+      # @see Minimizing Panes
+      # @param paneInfo [Wx::AUI::AuiPaneInfo] 
+      # @return [void]
+      def minimize_pane(paneInfo) end
+      
+      # Maximize the given pane.
+      # @param paneInfo [Wx::AUI::AuiPaneInfo] 
+      # @return [void]
+      def maximize_pane(paneInfo) end
+      
+      # Restore the last state of the given pane.
+      # @param paneInfo [Wx::AUI::AuiPaneInfo] 
+      # @return [void]
+      def restore_pane(paneInfo) end
+      
+      # Restore the previously maximized pane.
+      # @return [void]
+      def restore_maximized_pane; end
+      
+      # Save the layout information using the provided object.
+      # 
+      # This function allows to use a custom serializer to save the layout information in any format, e.g. page_samples_aui shows how to save it in XML format.
+      # See {Wx::AUI::AuiSerializer} documentation for more details.
+      # @param serializer [Wx::AUI::AuiSerializer] 
+      # @return [void]
+      def save_layout(serializer) end
+      
+      # {Wx::AUI::AuiManager#save_pane_info} is similar to SavePerspective, with the exception that it only saves information about a single pane.
+      # 
+      # The serialized layout parameters of the pane are returned within the string. Information about the pointers to UI elements stored in the pane are not serialized.
+      # @see Wx::AUI::AuiManager#load_pane_info 
+      # 
+      # @see Wx::AUI::AuiManager#load_perspective 
+      # 
+      # @see Wx::AUI::AuiManager#save_perspective 
+      # @param pane [Wx::AUI::AuiPaneInfo]  Pane whose layout parameters should be serialized.
+      # @return [String]
+      def save_pane_info(pane) end
+      
+      # Saves the entire user interface layout into an encoded {Wx::String}, which can then be stored by the application (probably using {Wx::Config}).
+      # 
+      # <div class="wxrb-note">
+      # <b>Note:</b>
+      # <p>You may prefer to use {Wx::AUI::AuiManager#save_layout} instead of this function for more flexibility.
+      # </p>
+      # </div>
+      # @see Wx::AUI::AuiManager#load_perspective 
+      # 
+      # @see Wx::AUI::AuiManager#load_pane_info 
+      # 
+      # @see Wx::AUI::AuiManager#save_pane_info 
+      # @return [String]
+      def save_perspective; end
+      
+      # Instructs {Wx::AUI::AuiManager} to use art provider specified by parameter art_provider for all drawing calls.
+      # 
+      # This allows pluggable look-and-feel features. The previous art provider object, if any, will be deleted by {Wx::AUI::AuiManager}.
+      # @see Wx::AUI::AuiDockArt. 
+      # @param art_provider [Wx::AUI::AuiDockArt] 
+      # @return [void]
+      def set_art_provider(art_provider) end
+      
+      # When a user creates a new dock by dragging a window into a docked position, often times the large size of the window will create a dock that is unwieldy large.
+      # 
+      # {Wx::AUI::AuiManager} by default limits the size of any new dock to 1/3 of the window size. For horizontal docks, this would be 1/3 of the window height. For vertical docks, 1/3 of the width.
+      # Calling this function will adjust this constraint value. The numbers must be between 0.0 and 1.0. For instance, calling SetDockSizeContraint with 0.5, 0.5 will cause new docks to be limited to half of the size of the entire managed window.
+      # @param widthpct [Float] 
+      # @param heightpct [Float] 
+      # @return [void]
+      def set_dock_size_constraint(widthpct, heightpct) end
+      
+      # This method is used to specify {Wx::AUI::AuiManagerOption}'s flags.
+      # 
+      # flags specifies options which allow the frame management behaviour to be modified.
+      # @param flags [Integer] 
+      # @return [void]
+      def set_flags(flags) end
+      alias_method :flags=, :set_flags
+      
+      # Set the window which is to be managed by {Wx::AUI::AuiManager}.
+      # 
+      # This window will often be a {Wx::Frame} but an arbitrary child window can also be used.
+      # Note that {Wx::AUI::AuiManager} handles many events for the managed window, including {Wx::EVT_SIZE}, so any application-defined handlers for this window should take care to call {Wx::Event#skip} to let {Wx::AUI::AuiManager} perform its own processing.
+      # @param managedWindow [Wx::Window] 
+      # @return [void]
+      def set_managed_window(managedWindow) end
+      
+      # This function is used to show a hint window at the specified rectangle.
+      # 
+      # It can be overridden to customize the hint appearance. When overriding it, {Wx::AUI::AuiManager#hide_hint} should normally be also overridden as well.
+      # Do not call this function directly to show the hint, use {Wx::AUI::AuiManager#update_hint} instead.
+      # @param rect [Wx::Rect]  The area where the hint window should be shown, in screen coordinates, or an empty rectangle to hide the window.
+      # @return [void]
+      def show_hint(rect) end
+      
+      # Create a new pane with the given window near an existing pane.
+      # 
+      # The size of the new pane is determined by {Wx::AUI::AuiManager#calculate_new_split_size} and the existing panes are resized to have the same size in the split direction.
+      # Note that this function calls {Wx::AUI::AuiManager#update} internally, so there is no need to call it separately.
+      # @param window [Wx::Window]  A window already managed by this {Wx::AUI::AuiManager} identifying the pane to split.
+      # @param newWindow [Wx::Window]  The window to be added as a new pane.
+      # @param direction [Integer]  The direction where the new pane should be added, one of {Wx::Direction::LEFT}, {Wx::Direction::RIGHT}, {Wx::Direction::TOP} or {Wx::Direction::BOTTOM}.
+      # @param dropPos [Array(Integer, Integer), Wx::Point]  The position where the pane is dropped, if this function is called in response to a drag-and-drop operation. If not specified, the position is determined by direction.
+      # @return [Boolean]
+      def split_pane(window, newWindow, direction, dropPos=Wx::DEFAULT_POSITION) end
+      
+      # Mostly used internally to define the drag action parameters.
+      # @param paneWindow [Wx::Window] 
+      # @param offset [Array(Integer, Integer), Wx::Point] 
+      # @return [void]
+      def start_pane_drag(paneWindow, offset) end
+      
+      # Dissociate the managed window from the manager.
+      # 
+      # This function may be called before the managed frame or window is destroyed, but, since wxWidgets 3.1.4, it's unnecessary to call it explicitly, as it will be called automatically when this window is destroyed, as well as when the manager itself is.
+      # @return [void]
+      def un_init; end
+      
+      # This method is called after any number of changes are made to any of the managed panes.
+      # 
+      # {Wx::AUI::AuiManager#update} must be invoked after {Wx::AUI::AuiManager#add_pane} or {Wx::AUI::AuiManager#insert_pane} are called in order to "realize" or "commit" the changes. In addition, any number of changes may be made to {Wx::AUI::AuiPaneInfo} structures (retrieved with {Wx::AUI::AuiManager#get_pane}), but to realize the changes, {Wx::AUI::AuiManager#update} must be called. This construction allows pane flicker to be avoided by updating the whole layout at one time.
+      # @return [void]
+      def update; end
+      
+      # Show or hide the hint window.
+      # 
+      # This function is mostly used internally.
+      # @param rect [Wx::Rect]  The area where the hint window should be shown, in screen coordinates, or an empty rectangle to hide the window.
+      # @return [void]
+      def update_hint(rect) end
+      
+      # Returns true if live resize is always used on the current platform.
+      # 
+      # If this function returns true, {Wx::AUI::AuiManagerOption::AUI_MGR_LIVE_RESIZE} flag is ignored and live resize is always used, whether it's specified or not.
+      # Currently this is the case for WXOSX and WXGTK3 when using Wayland, as live resizing is the only implemented method there. See {Wx::ClientDC.can_be_used_for_drawing} for more details.
+      # 
+      # <div class="wxrb-note">
+      # <b>Note:</b>
+      # <p>As of wxWidgets 3.3.0 this function always returns false.
+      # </p>
+      # </div>
+      # @param window [Wx::Window]  The associated window, may be null (this parameter was added in wxWidgets 3.3.0)
+      # @return [Boolean]
+      def self.always_uses_live_resize(window) end
+      
+      # Calling this method will return the {Wx::AUI::AuiManager} for a given window.
+      # 
+      # The window parameter should specify any child window or sub-child window of the frame or window managed by {Wx::AUI::AuiManager}.
+      # The window parameter need not be managed by the manager itself, nor does it even need to be a child or sub-child of a managed window. It must however be inside the window hierarchy underneath the managed window.
+      # @param window [Wx::Window] 
+      # @return [Wx::AUI::AuiManager]
+      def self.get_manager(window) end
+      
+    end # AuiManager
+    
+    # {Wx::AUI::AuiBookSerializer} is used for serializing {Wx::AUI::AuiNotebook} layout.
+    # 
+    # This includes the tab controls layout and the order of pages in them.
+    # It can be used standalone with {Wx::AUI::AuiNotebook#save_layout} or as base class of {Wx::AUI::AuiSerializer} for saving and restoring the entire layout.
+    # 
+    # 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 AuiBookSerializer < ::Object
+    
+      # Trivial default ctor.
+      # @return [Wx::AUI::AuiBookSerializer]
+      def initialize; end
+      
+      # Called before starting to save information about the tabs in the notebook in the AUI pane with the given name.
+      # 
+      # This function needs to be overridden to keep record of the notebook for which {Wx::AUI::AuiBookSerializer#save_notebook_tab_control} will be called next.
+      # If this class is used as a base class of {Wx::AUI::AuiSerializer}, saving notebook layout may be unnecessary, e.g. because the program doesn't use {Wx::AUI::AuiNotebook} at all, and the implementation can be trivial and just do nothing because it is not going to be called at all if there are no notebooks in the full layout.
+      # When using {Wx::AUI::AuiNotebook#save_layout} directly, this function is always called and is the first function of this class to be called.
+      # @param name [String] 
+      # @return [void]
+      def before_save_notebook(name) end
+      
+      # Called to save information about a single tab control in the given notebook.
+      # 
+      # This function will be called for all tab controls in the notebook after {Wx::AUI::AuiBookSerializer#before_save_notebook}.
+      # As with that function, it has to be implemented, but can simply do nothing if saving notebook layout is not necessary.
+      # @param tab [Wx::AUI::AuiTabLayoutInfo] 
+      # @return [void]
+      def save_notebook_tab_control(tab) end
+      
+      # Called after saving information about all the pages of the notebook in the AUI pane with the given name.
+      # 
+      # Does nothing by default.
+      # @return [void]
+      def after_save_notebook; end
+      
+    end # AuiBookSerializer
+    
+    # {Wx::AUI::AuiSerializer} is used by {Wx::AUI::AuiManager#save_layout} to store layout information.
+    # 
+    # This is an abstract base class, you need to inherit from it and override its pure virtual functions, including those inherited from its base {Wx::AUI::AuiBookSerializer} class, in your derived class.
+    # In particular, {Wx::AUI::AuiSerializer#save_pane} must be overridden and will be called by {Wx::AUI::AuiManager} for each pane and dock present in the layout. Most of the other functions don't need to be overridden, but it is often convenient to perform some actions before or after starting to save the objects of the given type or at the beginning or end of the whole saving process, so this class provides hooks for doing it.
+    # If any of the functions of the derived class throw an exception, it is propagated out of {Wx::AUI::AuiManager#save_layout} and it's callers responsibility to handle it.
+    # 
+    # 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 AuiSerializer < AuiBookSerializer
+    
+      # Trivial default ctor.
+      # @return [Wx::AUI::AuiSerializer]
+      def initialize; end
+      
+      # Called before doing anything else.
+      # 
+      # Does nothing by default.
+      # @return [void]
+      def before_save; end
+      
+      # Called before starting to save information about the panes.
+      # 
+      # Does nothing by default.
+      # @return [void]
+      def before_save_panes; end
+      
+      # Save information about the given pane.
+      # 
+      # This function will be called for all panes and must be implemented to save their data in a format from which it can be restored later using a matching {Wx::AUI::AuiDeserializer} implementation.
+      # Note that all sizes and positions in pane are using DIPs, i.e. resolution-independent pixels, when it is passed to this function, so it does not need to perform any scaling itself to ensure that the stored values are restored correctly if the resolution changes.
+      # @param pane [Wx::AUI::AuiPaneLayoutInfo] 
+      # @return [void]
+      def save_pane(pane) end
+      
+      # Called after the last call to {Wx::AUI::AuiSerializer#save_pane}.
+      # 
+      # Does nothing by default.
+      # @return [void]
+      def after_save_panes; end
+      
+      # Called before starting to save information about the notebooks.
+      # 
+      # Does nothing by default.
+      # Note that this function is called after {Wx::AUI::AuiSerializer#after_save_panes} but may not be called at all if there are no panes containing {Wx::AUI::AuiNotebook}.
+      # {Wx::AUI::AuiBookSerializer} member functions will be called after this function if it is called at all.
+      # @return [void]
+      def before_save_notebooks; end
+      
+      # Called after the last call to SaveNotebook().
+      # 
+      # Does nothing by default.
+      # This function is called after all {Wx::AUI::AuiBookSerializer} member functions
+      # @return [void]
+      def after_save_notebooks; end
+      
+      # Called after saving everything.
+      # 
+      # Does nothing by default.
+      # @return [void]
+      def after_save; end
+      
+    end # AuiSerializer
+    
+    # Description of a docked element layout.
+    # 
+    # The fields in this struct are shared by {Wx::AUI::AuiPaneLayoutInfo} and {Wx::AUI::AuiTabLayoutInfo} and contain information about the layout of a docked pane or tab layout.
+    # Note that when saving the objects of this type, fields that have the value of 0 can be omitted, as this is their default value in any case (except for {Wx::dock_direction} which is never 0), to make the serialized representation more compact.
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_AUI
+    class AuiDockLayoutInfo < ::Object
+    
+      # Direction of the dock containing the pane.
+      # 
+      # 
+      # @return [Integer]
+      def dock_direction; end
+      # Direction of the dock containing the pane.
+      # 
+      # 
+      # @param val [Integer]
+      # @return [void]
+      def dock_direction=(val); end
+      
+      # Layer of the dock containing the pane.
+      # 
+      # 
+      # @return [Integer]
+      def dock_layer; end
+      # Layer of the dock containing the pane.
+      # 
+      # 
+      # @param val [Integer]
+      # @return [void]
+      def dock_layer=(val); end
+      
+      # Row of the dock containing the pane.
+      # 
+      # 
+      # @return [Integer]
+      def dock_row; end
+      # Row of the dock containing the pane.
+      # 
+      # 
+      # @param val [Integer]
+      # @return [void]
+      def dock_row=(val); end
+      
+      # Position of the pane in the dock containing it.
+      # 
+      # 
+      # @return [Integer]
+      def dock_pos; end
+      # Position of the pane in the dock containing it.
+      # 
+      # 
+      # @param val [Integer]
+      # @return [void]
+      def dock_pos=(val); end
+      
+      # Relative proportion of the dock allocated to this pane.
+      # 
+      # 
+      # @return [Integer]
+      def dock_proportion; end
+      # Relative proportion of the dock allocated to this pane.
+      # 
+      # 
+      # @param val [Integer]
+      # @return [void]
+      def dock_proportion=(val); end
+      
+      # Size of the containing dock.
+      # 
+      # 
+      # @return [Integer]
+      def dock_size; end
+      # Size of the containing dock.
+      # 
+      # 
+      # @param val [Integer]
+      # @return [void]
+      def dock_size=(val); end
+      
+    end # AuiDockLayoutInfo
+    
+    # Description of user-modifiable pane layout information.
+    # 
+    # This struct is used with {Wx::AUI::AuiSerializer} and {Wx::AUI::AuiDeserializer} to store the pane layout. Its fields, including the inherited ones from {Wx::AUI::AuiDockLayoutInfo}, have the same meaning as the corresponding fields in {Wx::AUI::AuiPaneInfo} (with the exception of {Wx::is_maximized} and {Wx::is_hidden}, which rather correspond to the individual bits of its state field), but it doesn't contain the fields that it wouldn't make sense to serialize.
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_AUI
+    class AuiPaneLayoutInfo < AuiDockLayoutInfo
+    
+      # Unique name of the pane.
+      # 
+      # 
+      # @return [String]
+      def name; end
+      # Unique name of the pane.
+      # 
+      # 
+      # @param val [String]
+      # @return [void]
+      def name=(val); end
+      
+      # Position of the pane when floating, may be invalid.
+      # 
+      # 
+      # @return [Wx::Point]
+      def floating_pos; end
+      # Position of the pane when floating, may be invalid.
+      # 
+      # 
+      # @param val [Wx::Point]
+      # @return [void]
+      def floating_pos=(val); end
+      
+      # Size of the pane when floating, may be invalid.
+      # 
+      # 
+      # @return [Wx::Size]
+      def floating_size; end
+      # Size of the pane when floating, may be invalid.
+      # 
+      # 
+      # @param val [Wx::Size]
+      # @return [void]
+      def floating_size=(val); end
+      
+      # True if the pane is currently maximized.
+      # 
+      # 
+      # @return [Boolean]
+      def is_maximized; end
+      # True if the pane is currently maximized.
+      # 
+      # 
+      # @param val [Boolean]
+      # @return [void]
+      def is_maximized=(val); end
+      
+      # Ctor sets the name, which is always required.
+      # @param name [String] 
+      # @return [Wx::AUI::AuiPaneLayoutInfo]
+      def initialize(name) end
+      
+    end # AuiPaneLayoutInfo
+    
+    # Contains information about the layout of a tab control in a {Wx::AUI::AuiNotebook}.
+    # 
+    # This includes where it is docked, via the fields inherited from {Wx::AUI::AuiDockLayoutInfo}, and, optionally, the order of pages in it if it was changed as well as pinned pages indices, if any.
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_AUI
+    class AuiTabLayoutInfo < AuiDockLayoutInfo
+    
+      # Returns the indices of the pages in this tab control in their order on screen.
+      # If this array is empty, it means that the tab control contains all notebook pages in natural order.
+      # @return [::Array<Integer>] indices of the pages in this tab control
+      def get_pages; end
+      alias :pages :get_pages
+      
+      # Set the indices of the pages in this tab control in their order on screen.
+      # If this array is empty, it means that the tab control contains all notebook pages in natural order.
+      # @param [::Array<Integer>] pages indices of the pages in this tab control
+      def set_pages(pages) end
+      alias :pages= :set_pages
+    end # AuiTabLayoutInfo
+    
+    # {Wx::AUI::AuiBookDeserializer} is used for deserializing {Wx::AUI::AuiNotebook} layout.
+    # 
+    # Similarly to {Wx::AUI::AuiBookSerializer}, it can be used standalone with {Wx::AUI::AuiNotebook#load_layout} or as base class of {Wx::AUI::AuiDeserializer}.
+    # 
+    # 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 AuiBookDeserializer < ::Object
+    
+      # Trivial default ctor.
+      # @return [Wx::AUI::AuiBookDeserializer]
+      def initialize; end
+      
+      # Load information about the notebook tabs previously saved by {Wx::AUI::AuiBookSerializer#save_notebook_tab_control}.
+      # 
+      # When using this class as a base class of {Wx::AUI::AuiDeserializer}, this function is called by {Wx::AUI::AuiManager#load_layout} after loading the pane with the name name if it is a {Wx::AUI::AuiNotebook}. Otherwise, i.e. when using {Wx::AUI::AuiNotebook#load_layout} directly, this function is called with the same name as was passed to that function.
+      # If restoring the notebook layout is not necessary, this function can just return an empty vector which is interpreted as meaning that the default notebook layout should be used.
+      # @param name [String] 
+      # @return [Array<Wx::AuiTabLayoutInfo>]
+      def load_notebook_tabs(name) end
+      
+      # Determine what should be done with the pages not attached to any tab control after restoring the pages order.
+      # 
+      # It is possible that the data returned by {Wx::AUI::AuiBookDeserializer#load_notebook_tabs} doesn't contain the layout information for all the currently existing pages, e.g. because data saved by an earlier program version is being loaded into a newer version in which new pages were added. In this case, this function is called for each page that wasn't assigned to any tab after restoring the pages order and can be overridden to determine what should be done with it.
+      # The overridden version may return a 2-element array with an {Wx::AUI::AuiTabCtrl} and tab index instead to change where the page should be inserted, e.g. by returning a tab index of 0 to insert the new pages at the beginning instead of appending them.
+      # 
+      # Finally, the overridden function may return false to indicate that the page should be removed from the notebook.
+      # 
+      # <div class="wxrb-note">
+      # <b>Note:</b>
+      # <p>The book parameter can be used to retrieve the total number of pages or to call functions such as {Wx::AUI::AuiNotebook#get_main_tab_ctrl} or {Wx::AUI::AuiNotebook#get_all_tab_ctrls} on it, but this function must not attempt to modify it by adding or removing pages to/from it. 
+      # </p>
+      # </div>
+      # @param book [Wx::AUI::AuiNotebook] 
+      # @param page [Integer] 
+      # @return [Boolean,Array(Wx::AUI::AuiTabCtrl, Integer)]
+      def handle_orphaned_page(book, page) end
+      
+    end # AuiBookDeserializer
+    
+    # {Wx::AUI::AuiDeserializer} is used by {Wx::AUI::AuiManager#load_layout} to restore layout information saved by {Wx::AUI::AuiManager#save_layout}.
+    # 
+    # As {Wx::AUI::AuiSerializer}, this is an abstract base class, you need to inherit from it and override its pure virtual functions in your derived class.
+    # Derived class function also may throw and, if any of them other than {Wx::AUI::AuiDeserializer#after_load} does, the existing layout is not changed, i.e. {Wx::AUI::AuiManager#load_layout} is exception-safe.
+    # 
+    # 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 AuiDeserializer < AuiBookDeserializer
+    
+      # Constructor taking the manager for which we're restoring the layout.
+      # 
+      # The manager remains valid for the lifetime of this object.
+      # @param manager [Wx::AUI::AuiManager] 
+      # @return [Wx::AUI::AuiDeserializer]
+      def initialize(manager) end
+      
+      # Called before doing anything else.
+      # 
+      # Does nothing by default.
+      # @return [void]
+      def before_load; end
+      
+      # Load information about all the panes previously saved by {Wx::AUI::AuiSerializer#save_pane}.
+      # 
+      # Unlike the serializer function, this one is called only once and should return all the panes in the layout.
+      # Just as the serializer function, this one doesn't need to perform any scaling itself as this will be done, if necessary, by {Wx::AUI::AuiManager} itself.
+      # If some pane in the returned vector doesn't already exist, i.e. there is no pane with the matching name, {Wx::AUI::AuiDeserializer#create_pane_window} is called to allow creating it on the fly.
+      # @return [Array<Wx::AuiPaneLayoutInfo>]
+      def load_panes; end
+      
+      # Create the window to be managed by the given pane if necessary.
+      # 
+      # This function is called if any of the panes returned by {Wx::AUI::AuiDeserializer#load_panes} doesn't exist in the existing layout and allows to create windows on the fly.
+      # If this function returns nil, as it does by default, the pane is not added to the manager.
+      # If the function does create a new window, it should typically modify pane parameter to fill in the fields such as caption or icon that wouldn't normally be serialized and so wouldn't be restored by {Wx::AUI::AuiDeserializer#load_panes}.
+      # @param pane [Wx::AUI::AuiPaneInfo] 
+      # @return [Wx::Window]
+      def create_pane_window(pane) end
+      
+      # Called after restoring everything.
+      # 
+      # Default implementation calls {Wx::AUI::AuiManager#update}. Override this function and do not call the base class version if you want to prevent this from happening, e.g. if you need to make further changes to the restored layout before updating it.
+      # @return [void]
+      def after_load; end
+      
+    end # AuiDeserializer
+    
+
+  end
+
+end