wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

data/lib/wx/doc/gen/app_traits.rb

@@ -7,6 +7,7 @@
 module Wx
 
   # The {Wx::AppTraits} class defines various configurable aspects of a {Wx::App}.
+  # 
   # You can access it using {Wx::App#get_traits} function and you can create your own {Wx::AppTraits} overriding the {Wx::App#create_traits} function.
   # Note that {Wx::AppTraits} is an abstract class since it contains many pure virtual functions. In fact, by default, wxWidgets creates a {Wx::ConsoleAppTraits} object for console applications (i.e. those applications linked against {Wx::Base} library only - see the Library List page) and a {Wx::GUIAppTraits} object for GUI applications. Both these classes are derived by {Wx::AppTraits} and represent concrete implementation of the {Wx::AppTraits} interface.
   # 
@@ -18,12 +19,14 @@ module Wx
   class AppTraits < ::Object
   
     # This method returns the name of the desktop environment currently running in a Unix desktop.
+    # 
     # Currently only "KDE" or "GNOME" are supported and the code uses the X11 session protocol vendor name to figure out, which desktop environment is running. The method returns an empty string otherwise and on all other platforms.
     # @return [String]
     def get_desktop_environment; end
     alias_method :desktop_environment, :get_desktop_environment
     
     # Returns the {Wx::StandardPaths} object for the application.
+    # 
     # It's normally the same for {Wx::Base} and {Wx::GUI} except in the case of WXOSX and {Wx::Cocoa}.
     # 
     # <div class="wxrb-note">
@@ -36,6 +39,7 @@ module Wx
     alias_method :standard_paths, :get_standard_paths
     
     # Returns the wxWidgets port ID used by the running program and eventually fills the given pointers with the values of the major, minor, and micro digits of the native toolkit currently used.
+    # 
     # The version numbers returned are thus detected at run-time and not compile-time (except when this is not possible e.g. {Wx::Motif}).
     # E.g. if your program is using WXGTK port this function will return {Wx::PortId::PORT_GTK} and put in given pointers the versions of the GTK library in use. See {Wx::PlatformInfo} for more details.
     # If a micro version is not available it will have a value of 0.
@@ -44,18 +48,21 @@ module Wx
     alias_method :toolkit_version, :get_toolkit_version
     
     # Returns true if the library was built as {Wx::Universal}.
+    # 
     # Always returns false for {Wx::Base}-only apps.
     # @return [Boolean]
     def is_using_universal_widgets; end
     alias_method :using_universal_widgets?, :is_using_universal_widgets
     
     # Shows the assert dialog with the specified message in GUI mode or just prints the string to stderr in console mode.
+    # 
     # Returns true to suppress subsequent asserts, false to continue as before.
     # @param msg [String] 
     # @return [Boolean]
     def show_assert_dialog(msg) end
     
     # Shows a message box with the given text and title if possible.
+    # 
     # In some ports, e.g. WXMSW, a message box will always be shown, while in the other ones it will be only done if the GUI is available (e.g. X11 display was successfully opened for X11-based ports) and the function simply returns false without doing anything otherwise.
     # This function is safe in the sense that it can always be called, even before creating {Wx::App}, similarly to {safe_show_message} which is implemented by calling this function and then logging the message to standard error stream if it returned false.
     # 
@@ -66,6 +73,7 @@ module Wx
     def safe_message_box(text, title) end
     
     # Helper function mostly useful for derived classes {Wx::AppTraits#show_assert_dialog} implementation.
+    # 
     # Returns the stack frame as a plain (and possibly empty) {Wx::String}.
     # This function is only available when {Wx::Setup::USE_STACKWALKER} is 1.
     # @return [String]
@@ -76,6 +84,7 @@ module Wx
   end # AppTraits
   
   # {Wx::StandardPaths} returns the standard locations in the file system and should be used by applications to find their data files in a portable way.
+  # 
   # Note that you must not create objects of class {Wx::StandardPaths} directly, but use the global standard paths object returned by {Wx::StandardPaths.get} (which can be of a type derived from {Wx::StandardPaths} and not of exactly this type) and call the methods you need on it. The object returned by {Wx::StandardPaths.get} may be customized by overriding {Wx::AppTraits#get_standard_paths} methods.
   # In the description of the methods below, the example return values are given for the Unix, Windows and macOS systems, however please note that these are just the examples and the actual values may differ. For example, under Windows: the system administrator may change the standard directories locations, e.g. the Windows directory may be named <code>"W:\Win2003"</code> instead of the default <code>"C:\Windows"</code>.
   # Notice that in the examples below the string appinfo may be either just the application name (as returned by {Wx::App#get_app_name}) or a combination of the vendor name ({Wx::App#get_vendor_name}) and the application name, with a path separator between them. By default, only the application name is used, use {Wx::StandardPaths#use_app_info} to change this.
@@ -88,6 +97,8 @@ module Wx
   # @see Wx::FileConfig 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class StandardPaths < ::Object
   
     # Possible values for category parameter of {Wx::StandardPaths#get_localized_resources_dir}.
@@ -175,12 +186,14 @@ module Wx
     end # ConfigFileConv
     
     # MSW-specific function undoing the effect of {Wx::StandardPaths#ignore_app_sub_dir} calls.
+    # 
     # After a call to this function the program directory will be exactly the directory containing the main application binary, i.e. it undoes the effect of any previous {Wx::StandardPaths#ignore_app_sub_dir} calls including the ones done indirectly by {Wx::StandardPaths#ignore_app_build_sub_dirs} called from the class constructor.
     # @return [void]
     # @wxrb_require WXMSW
     def dont_ignore_app_sub_dir; end
     
     # Return the directory for the document files used by this application.
+    # 
     # If the application-specific directory doesn't exist, this function returns {Wx::StandardPaths#get_documents_dir}.
     # Example return values:
     # 
@@ -192,6 +205,7 @@ module Wx
     alias_method :app_documents_dir, :get_app_documents_dir
     
     # Return the directory containing the system config files.
+    # 
     # Example return values:
     # 
     # - Unix: <code>/etc</code> 
@@ -209,6 +223,7 @@ module Wx
     alias_method :config_dir, :get_config_dir
     
     # Return the location of the applications global, i.e. not user-specific, data files.
+    # 
     # Example return values:
     # 
     # - Unix: <code>prefix/share/appinfo</code> 
@@ -223,6 +238,7 @@ module Wx
     
     # Same as calling {Wx::StandardPaths#get_user_dir} with Dir_Documents parameter.
     # 
+    # 
     # @see Wx::StandardPaths#get_app_documents_dir
     # @see  Wx::StandardPaths#get_user_dir 
     # @return [String]
@@ -230,6 +246,7 @@ module Wx
     alias_method :documents_dir, :get_documents_dir
     
     # Return the directory and the filename for the current executable.
+    # 
     # Example return values:
     # 
     # - Unix: <code>/usr/local/bin/exename</code> 
@@ -240,20 +257,23 @@ module Wx
     alias_method :executable_path, :get_executable_path
     
     # Return the location for application data files which are host-specific and can't, or shouldn't, be shared with the other machines.
+    # 
     # This is the same as {Wx::StandardPaths#get_data_dir} except under Unix where it returns <code>/etc/appinfo</code>.
     # @return [String]
     def get_local_data_dir; end
     alias_method :local_data_dir, :get_local_data_dir
     
     # Return the localized resources directory containing the resource files of the specified category for the given language.
+    # 
     # In general this is just the same as lang subdirectory of {Wx::StandardPaths#get_resources_dir} (or lang.lproj under macOS) but is something quite different for message catalog category under Unix where it returns the standard <code>prefix/share/locale/lang/LC_MESSAGES</code> directory.
     # @param lang [String] 
-    # @param category [Wx::wxStandardPaths::ResourceCat] 
+    # @param category [Wx::StandardPaths::ResourceCat] 
     # @return [String]
     def get_localized_resources_dir(lang, category=Wx::StandardPaths::ResourceCat::ResourceCat_None) end
     alias_method :localized_resources_dir, :get_localized_resources_dir
     
     # Return the directory where the loadable modules (plugins) live.
+    # 
     # Example return values:
     # 
     # - Unix: <code>prefix/lib/appinfo</code> 
@@ -265,6 +285,7 @@ module Wx
     alias_method :plugins_dir, :get_plugins_dir
     
     # Return the directory where the application resource files are located.
+    # 
     # The resources are the auxiliary data files needed for the application to run and include, for example, image and sound files it might use.
     # This function is the same as {Wx::StandardPaths#get_data_dir} for all platforms except macOS. Example return values:
     # 
@@ -277,12 +298,14 @@ module Wx
     alias_method :resources_dir, :get_resources_dir
     
     # Return the directory for storing temporary files, for the current user.
+    # 
     # Same as Wx::FileName#get_temp_dir. To create unique temporary files, it is best to use Wx::FileName#create_temp_file_name for correct behaviour when multiple processes are attempting to create temporary files.
     # @return [String]
     def get_temp_dir; end
     alias_method :temp_dir, :get_temp_dir
     
     # Return the directory for the user config files.
+    # 
     # This directory is:
     # 
     # - Unix: <code>~</code> (the home directory) or XDG_CONFIG_HOME depending on {Wx::StandardPaths#get_file_layout} return value
@@ -295,6 +318,7 @@ module Wx
     alias_method :user_config_dir, :get_user_config_dir
     
     # Return the directory for the user-dependent application data files:
+    # 
     # - Unix: <code>~/</code>.appinfo
     # - Windows: <code>"C:\Users\username\AppData\Roaming\appinfo"</code> or <code>"C:\Documents and Settings\username\Application Data\appinfo"</code> 
     # - Mac: <code>"~/Library/Application Support/appinfo"</code>
@@ -303,6 +327,7 @@ module Wx
     alias_method :user_data_dir, :get_user_data_dir
     
     # Return the path of the specified user data directory.
+    # 
     # If the value could not be determined the users home directory is returned.
     # 
     # <div class="wxrb-note">
@@ -310,18 +335,20 @@ module Wx
     # <p>On Unix this (newer) method always respects the XDG base directory specification, even if {Wx::StandardPaths#set_file_layout} with FileLayout_XDG hadn't been called.
     # </p>
     # </div>
-    # @param userDir [Wx::wxStandardPaths::Dir] 
+    # @param userDir [Wx::StandardPaths::Dir] 
     # @return [String]
     def get_user_dir(userDir) end
     alias_method :user_dir, :get_user_dir
     
     # Return the directory for user data files which shouldn't be shared with the other machines.
+    # 
     # This is the same as {Wx::StandardPaths#get_user_data_dir} for all platforms except Windows where it returns <code>"C:\Users\username\AppData\Local\appinfo"</code> or <code>"C:\Documents and Settings\username\Local Settings\Application Data\appinfo"</code>
     # @return [String]
     def get_user_local_data_dir; end
     alias_method :user_local_data_dir, :get_user_local_data_dir
     
     # MSW-specific function to customize application directory detection.
+    # 
     # This class supposes that data, plugins &c files are located under the program directory which is the directory containing the application binary itself. But sometimes this binary may be in a subdirectory of the main program directory, e.g. this happens in at least the following common cases:
     # 
     # - The program is in "bin" subdirectory of the installation directory.
@@ -335,6 +362,7 @@ module Wx
     def ignore_app_sub_dir(subdirPattern) end
     
     # MSW-specific function to ignore all common build directories.
+    # 
     # This function calls {Wx::StandardPaths#ignore_app_sub_dir} with all common values for build directory, e.g. <code>"debug"</code> and <code>"release"</code>.
     # It is called by the class constructor and so the build directories are always ignored by default. You may use {Wx::StandardPaths#dont_ignore_app_sub_dir} to avoid ignoring them if this is inappropriate for your application.
     # @return [void]
@@ -342,6 +370,7 @@ module Wx
     def ignore_app_build_sub_dirs; end
     
     # Controls what application information is used when constructing paths that should be unique to this program, such as the application data directory, the plugins directory on Unix, etc.
+    # 
     # Valid values for info are:
     # 
     # - AppInfo_None: use neither application nor vendor name in the paths.
@@ -354,23 +383,26 @@ module Wx
     def use_app_info(info) end
     
     # Sets the current file layout.
+    # 
     # The default layout is FileLayout_Classic for compatibility, however newer applications are encouraged to set it to FileLayout_XDG on program startup.
-    # @param layout [Wx::wxStandardPaths::FileLayout] 
+    # @param layout [Wx::StandardPaths::FileLayout] 
     # @return [void]
     def set_file_layout(layout) end
     alias_method :file_layout=, :set_file_layout
     
     # Returns the current file layout.
     # 
+    # 
     # @see Wx::StandardPaths#set_file_layout
-    # @return [Wx::wxStandardPaths::FileLayout]
+    # @return [Wx::StandardPaths::FileLayout]
     def get_file_layout; end
     alias_method :file_layout, :get_file_layout
     
     # Return the file name which would be used by {Wx::FileConfig} if it were constructed with basename.
+    # 
     # conv is used to construct the name of the file under Unix and only matters when using the class file layout, i.e. if {Wx::StandardPaths#set_file_layout} had not been called with FileLayout_XDG argument. In this case, this argument is used to determine whether to use an extension or a leading dot. When following XDG specification, the function always appends the extension, regardless of conv value. Finally, this argument is not used at all under non-Unix platforms.
     # @param basename [String] 
-    # @param conv [Wx::wxStandardPaths::ConfigFileConv] 
+    # @param conv [Wx::StandardPaths::ConfigFileConv] 
     # @return [String]
     def make_config_file_name(basename, conv=Wx::StandardPaths::ConfigFileConv::ConfigFileConv_Ext) end
     
@@ -379,6 +411,7 @@ module Wx
     def self.get; end
     
     # Returns location of Windows shell special folder.
+    # 
     # This function is, by definition, MSW-specific. It can be used to access pre-defined shell directories not covered by the existing methods of this class, e.g.: 
     # ```
     #   \#ifdef __WXMSW__

data/lib/wx/doc/gen/art_provider.rb

@@ -267,6 +267,7 @@ module Wx
   ART_WX_LOGO = "wxART_WX_LOGO"
   
   # {Wx::ArtProvider} class is used to customize the look of wxWidgets application.
+  # 
   # When wxWidgets needs to display an icon or a bitmap (e.g. in the standard file dialog), it does not use a hard-coded resource but asks {Wx::ArtProvider} for it instead. This way users can plug in their own {Wx::ArtProvider} class and easily replace standard art with their own version.
   # All that is needed is to derive a class from {Wx::ArtProvider}, override either its {Wx::ArtProvider#create_bitmap} and/or its {Wx::ArtProvider#create_icon_bundle} methods and register the provider with {Wx::ArtProvider.push}:
   # 
@@ -449,6 +450,7 @@ module Wx
     def self.delete(provider) end
     
     # Query registered providers for bitmap with given ID.
+    # 
     # Note that applications using wxWidgets 3.1.6 or later should prefer calling {Wx::ArtProvider.get_bitmap_bundle}.
     # 
     # The bitmap if one of registered providers recognizes the ID or {Wx::NULL_BITMAP} otherwise.
@@ -459,6 +461,7 @@ module Wx
     def self.get_bitmap(id, client=Wx::ART_OTHER, size=Wx::DEFAULT_SIZE) end
     
     # Query registered providers for a bundle of bitmaps with given ID.
+    # 
     # If any of the registered providers recognizes the ID in its {Wx::ArtProvider#create_bitmap_bundle}, this bundle is returned. Otherwise, if any of providers returns a valid bitmap from {Wx::ArtProvider#create_bitmap}, the bundle containing only this bitmap is returned. Otherwise, an empty bundle is returned.
     # @param id [Wx::ArtID]  {Wx::ArtID} unique identifier of the bitmap.
     # @param client [Wx::ArtClient]  {Wx::ArtClient} identifier of the client (i.e. who is asking for the bitmap).
@@ -474,6 +477,7 @@ module Wx
     def self.get_icon(id, client=Wx::ART_OTHER, size=Wx::DEFAULT_SIZE) end
     
     # Returns native icon size for use specified by client hint in DIPs.
+    # 
     # If the platform has no commonly used default for this use or if client is not recognized, returns {Wx::DEFAULT_SIZE}.
     # 
     # <div class="wxrb-note">
@@ -486,6 +490,7 @@ module Wx
     def self.get_native_dip_size_hint(client) end
     
     # Returns native icon size for use specified by client hint.
+    # 
     # This function does the same thing as {Wx::ArtProvider.get_native_dip_size_hint}, but uses win to convert the returned value to logical pixels. If win is NULL, default DPI scaling (i.e. that of the primary display) is used.
     # @param client [Wx::ArtClient] 
     # @param win [Wx::Window] 
@@ -493,6 +498,7 @@ module Wx
     def self.get_native_size_hint(client, win=nil) end
     
     # Returns a suitable size hint for the given {Wx::ArtClient} in DIPs.
+    # 
     # Return the size used by the topmost {Wx::ArtProvider} for the given client. {Wx::DEFAULT_SIZE} may be returned if the client doesn't have a specified size, like {Wx::ART_OTHER} for example.
     # @see Wx::ArtProvider.get_native_dip_size_hint 
     # @param client [Wx::ArtClient] 
@@ -500,6 +506,7 @@ module Wx
     def self.get_dip_size_hint(client) end
     
     # Returns a suitable size hint for the given {Wx::ArtClient}.
+    # 
     # This function does the same thing as {Wx::ArtProvider.get_dip_size_hint}, but uses win to convert the returned value to logical pixels. If win is NULL, default DPI scaling (i.e. that of the primary display) is used.
     # Note that win parameter is only available since wxWidgets 3.1.6.
     # @param client [Wx::ArtClient] 
@@ -508,6 +515,7 @@ module Wx
     def self.get_size_hint(client, win=nil) end
     
     # Query registered providers for icon bundle with given ID.
+    # 
     # The icon bundle if one of registered providers recognizes the ID or {Wx::NULL_ICON_BUNDLE} otherwise.
     # @param id [Wx::ArtID]  {Wx::ArtID} unique identifier of the icon bundle.
     # @param client [Wx::ArtClient]  {Wx::ArtClient} identifier of the client (i.e. who is asking for the icon bundle).
@@ -515,6 +523,7 @@ module Wx
     def self.get_icon_bundle(id, client=Wx::ART_OTHER) end
     
     # Returns true if the platform uses native icons provider that should take precedence over any customizations.
+    # 
     # This is true for any platform that has user-customizable icon themes, currently only WXGTK.
     # A typical use for this method is to decide whether a custom art provider should be plugged in using {Wx::ArtProvider.push} or {Wx::ArtProvider.push_back}.
     # @return [Boolean]
@@ -525,6 +534,7 @@ module Wx
     def self.pop; end
     
     # Register new art provider and add it to the top of providers stack (i.e.
+    # 
     # it will be queried as the first provider).
     # @see Wx::ArtProvider.push_back 
     # @param provider [Wx::ArtProvider] 
@@ -532,6 +542,7 @@ module Wx
     def self.push(provider) end
     
     # Register new art provider and add it to the bottom of providers stack.
+    # 
     # In other words, it will be queried as the last one, after all others, including the default provider.
     # @see Wx::ArtProvider.push
     # @param provider [Wx::ArtProvider] 
@@ -552,12 +563,14 @@ module Wx
     protected
     
     # Derived art provider classes may override this method to return the size of the images used by this provider.
+    # 
     # Note that the returned size should be in DPI-independent pixels, i.e. DIPs. The default implementation returns the result of {Wx::ArtProvider.get_native_dip_size_hint}.
     # @param client [Wx::ArtClient] 
     # @return [Wx::Size]
     def do_get_size_hint(client) end
     
     # Derived art provider classes may override this method to create requested art resource.
+    # 
     # For bitmaps available in more than one size, {Wx::ArtProvider#create_bitmap_bundle} should be overridden instead.
     # Note that returned bitmaps are cached by {Wx::ArtProvider} and it is therefore not necessary to optimize {Wx::ArtProvider#create_bitmap} for speed (e.g. you may create {Wx::Bitmap} objects from XPMs here).
     # 
@@ -574,6 +587,7 @@ module Wx
     def create_bitmap(id, client, size) end
     
     # Override this method to create the requested art resources available in more than one size.
+    # 
     # Unlike {Wx::ArtProvider#create_bitmap}, this method can be overridden to return the same bitmap in several (or all, if {Wx::BitmapBundle.from_svg} is used) sizes at once, which will allow selecting the size best suited for the current display resolution automatically.
     # @param id [Wx::ArtID]  {Wx::ArtID} unique identifier of the bitmap.
     # @param client [Wx::ArtClient]  {Wx::ArtClient} identifier of the client (i.e. who is asking for the bitmap). This only serves as a hint.

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

@@ -199,6 +199,7 @@ module Wx::AUI
   end # AuiButtonId
   
   # {Wx::AUI::AuiDockArt} is part of the {Wx::AUI} class framework.
+  # 
   # See also wxAUI Overview.
   # {Wx::AUI::AuiDockArt} is the art provider: provides all drawing functionality to the {Wx::AUI} dock manager. This allows the dock manager to have a pluggable look-and-feel.
   # By default, a {Wx::AUI::AuiManager} uses an instance of this class called {Wx::AUI::AuiDefaultDockArt} which provides bitmap art and a colour scheme that is adapted to the major platforms' look. You can either derive from that class to alter its behaviour or write a completely new dock art class. Call {Wx::AUI::AuiManager#set_art_provider} to force {Wx::AUI} to use your new dock art provider.
@@ -253,6 +254,7 @@ module Wx::AUI
     def draw_gripper(dc, window, rect, pane) end
     
     # Draws a button in the pane's title bar.
+    # 
     # button can be one of the values of <b>{Wx::AUI::AuiButtonId}</b>. button_state can be one of the values of <b>{Wx::AUI::AuiPaneButtonState}</b>.
     # @param dc [Wx::DC] 
     # @param window [Wx::Window] 
@@ -272,6 +274,7 @@ module Wx::AUI
     def draw_sash(dc, window, orientation, rect) end
     
     # Get the colour of a certain setting.
+    # 
     # id can be one of the colour values of <b>{Wx::AUI::AuiPaneDockArtSetting}</b>.
     # @param id [Integer] 
     # @return [Wx::Colour]
@@ -285,6 +288,7 @@ module Wx::AUI
     alias_method :font, :get_font
     
     # Get the value of a certain setting.
+    # 
     # id can be one of the size values of <b>{Wx::AUI::AuiPaneDockArtSetting}</b>.
     # @param id [Integer] 
     # @return [Integer]
@@ -292,6 +296,7 @@ module Wx::AUI
     alias_method :metric, :get_metric
     
     # Set a certain setting with the value colour.
+    # 
     # id can be one of the colour values of <b>{Wx::AUI::AuiPaneDockArtSetting}</b>.
     # @param id [Integer] 
     # @param colour [Wx::Colour,String,Symbol] 
@@ -305,6 +310,7 @@ module Wx::AUI
     def set_font(id, font) end
     
     # Set a certain setting with the value new_val.
+    # 
     # id can be one of the size values of <b>{Wx::AUI::AuiPaneDockArtSetting}</b>.
     # @param id [Integer] 
     # @param new_val [Integer] 
@@ -314,6 +320,7 @@ module Wx::AUI
   end # AuiDockArt
   
   # This is the default art provider for {Wx::AUI::AuiManager}.
+  # 
   # Dock art can be customized by creating a class derived from this one, or replacing this class entirely.
   # 
   # @wxrb_require USE_AUI
@@ -327,6 +334,7 @@ module Wx::AUI
     def clone; end
     
     # Get the value of a certain setting.
+    # 
     # id can be one of the size values of <b>{Wx::AUI::AuiPaneDockArtSetting}</b>.
     # @param id [Integer] 
     # @return [Integer]
@@ -334,6 +342,7 @@ module Wx::AUI
     alias_method :metric, :get_metric
     
     # Set a certain setting with the value new_val.
+    # 
     # id can be one of the size values of <b>{Wx::AUI::AuiPaneDockArtSetting}</b>.
     # @param id [Integer] 
     # @param new_val [Integer] 
@@ -341,6 +350,7 @@ module Wx::AUI
     def set_metric(id, new_val) end
     
     # Get the colour of a certain setting.
+    # 
     # id can be one of the colour values of <b>{Wx::AUI::AuiPaneDockArtSetting}</b>.
     # @param id [Integer] 
     # @return [Wx::Colour]
@@ -348,6 +358,7 @@ module Wx::AUI
     alias_method :colour, :get_colour
     
     # Set a certain setting with the value colour.
+    # 
     # id can be one of the colour values of <b>{Wx::AUI::AuiPaneDockArtSetting}</b>.
     # @param id [Integer] 
     # @param colour [Wx::Colour,String,Symbol] 
@@ -408,6 +419,7 @@ module Wx::AUI
     def draw_border(dc, window, rect, pane) end
     
     # Draws a button in the pane's title bar.
+    # 
     # button can be one of the values of <b>{Wx::AUI::AuiButtonId}</b>. button_state can be one of the values of <b>{Wx::AUI::AuiPaneButtonState}</b>.
     # @param dc [Wx::DC] 
     # @param window [Wx::Window] 

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

@@ -9,6 +9,7 @@ module Wx::AUI
   # 
   # 
   # 
+  # 
   # @wxrb_require USE_AUI
   class AuiFloatingFrame < Frame
   

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

@@ -7,6 +7,7 @@
 module Wx::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 {Wx::Frame}, 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}.
@@ -97,6 +98,7 @@ module Wx::AUI
     
     # @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] 
@@ -114,6 +116,7 @@ module Wx::AUI
     def add_pane(*args) end
     
     # 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.
@@ -131,6 +134,7 @@ module Wx::AUI
     
     # Destroys or hides the given pane depending on its flags.
     # 
+    # 
     # @see Wx::AUI::AuiPaneInfo#destroy_on_close 
     # @param paneInfo [Wx::AUI::AuiPaneInfo] 
     # @return [void]
@@ -143,12 +147,14 @@ module Wx::AUI
     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.
     # @param paneWindow [Wx::Window] 
     # @param pt [Array(Integer, Integer), Wx::Point] 
@@ -158,12 +164,14 @@ module Wx::AUI
     
     # 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
@@ -181,6 +189,7 @@ module Wx::AUI
     
     # @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]
@@ -191,6 +200,7 @@ module Wx::AUI
     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]
@@ -202,6 +212,7 @@ module Wx::AUI
     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] 
@@ -211,6 +222,7 @@ module Wx::AUI
     def insert_pane(window, insert_location, insert_level=Wx::AUI_INSERT_PANE) 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">
@@ -229,6 +241,7 @@ module Wx::AUI
     def load_pane_info(pane_part, pane) end
     
     # Loads a saved perspective.
+    # 
     # 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 
@@ -256,6 +269,7 @@ module Wx::AUI
     def restore_maximized_pane; 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 
     # 
@@ -268,6 +282,7 @@ module Wx::AUI
     
     # Saves the entire user interface layout into an encoded {Wx::String}, which can then be stored by the application (probably using {Wx::Config}).
     # 
+    # 
     # @see Wx::AUI::AuiManager#load_perspective 
     # 
     # @see Wx::AUI::AuiManager#load_pane_info 
@@ -277,6 +292,7 @@ module Wx::AUI
     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] 
@@ -285,6 +301,7 @@ module Wx::AUI
     alias_method :art_provider=, :set_art_provider
     
     # 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] 
@@ -293,6 +310,7 @@ module Wx::AUI
     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]
@@ -300,13 +318,14 @@ module Wx::AUI
     alias_method :flags=, :set_flags
     
     # Called to specify the frame or window which is to be managed by {Wx::AUI::AuiManager}.
+    # 
     # Frame management is not restricted to just frames. Child windows or custom controls are also allowed.
     # @param managed_wnd [Wx::Window] 
     # @return [void]
     def set_managed_window(managed_wnd) end
-    alias_method :managed_window=, :set_managed_window
     
     # This function is used by controls to explicitly show a hint window at the specified rectangle.
+    # 
     # It is rarely called, and is mostly used by controls implementing custom pane drag/drop behaviour. The specified rectangle should be in screen coordinates.
     # @param rect [Wx::Rect] 
     # @return [void]
@@ -319,22 +338,26 @@ module Wx::AUI
     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
     
     # 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 ports, as live resizing is the only implemented method there.
     # @return [Boolean]
     def self.always_uses_live_resize; 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]