wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -7,9 +7,9 @@
 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.
-  # === 
   # 
   # Category:  Application and System configuration
   # @see wxApp Overview
@@ -19,40 +19,51 @@ 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 wxMac and {Wx::Cocoa}.
-    # The returned reference is to a {Wx::StandardPathsBase} class but you can consider it to be equivalent to {Wx::StandardPaths} (which is documented).
+    # 
+    # It's normally the same for {Wx::Base} and {Wx::GUI} except in the case of WXOSX and {Wx::Cocoa}.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>The returned reference is to a {Wx::StandardPathsBase} class but you can consider it to be equivalent to {Wx::StandardPaths} (which is documented). 
+    # </p>
+    # </div>
     # @return [Wx::StandardPaths]
     def get_standard_paths; end
     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.
+    # 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.
     # @return [Array(Wx::PortId,Integer,Integer,Integer)]
     def get_toolkit_version; end
     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.
+    # 
+    # 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.
     # 
     # true if the message box was shown or false otherwise.
@@ -62,15 +73,18 @@ 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]
+    # @wxrb_require USE_STACKWALKER
     def get_assert_stack_trace; end
     alias_method :assert_stack_trace, :get_assert_stack_trace
     
   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.
@@ -78,12 +92,13 @@ module Wx
   # The directories returned by the methods of this class may or may not exist. If they don't exist, it's up to the caller to create them, {Wx::StandardPaths} doesn't do it.
   # Finally note that these functions only work with standardly packaged applications. I.e. under Unix you should follow the standard installation conventions and under Mac you should create your application bundle according to the Apple guidelines. Again, this class doesn't help you to do it.
   # This class is MT-safe: its methods may be called concurrently from different threads without additional locking.
-  # === 
   # 
   # Category:  File Handling
   # @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}.
@@ -171,11 +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:
     # 
@@ -187,19 +205,25 @@ 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> 
     # - Windows: <code>"C:\ProgramData\appinfo"</code> or <code>"C:\Documents and Settings\All Users\Application Data\appinfo"</code> 
     # - Mac: <code>/Library/Preferences</code> 
     # 
-    # Under Windows this includes appinfo which makes it inconsistent with other ports.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Under Windows this includes appinfo which makes it inconsistent with other ports.
+    # </p>
+    # </div>
     # @see Wx::FileConfig 
     # @return [String]
     def get_config_dir; end
     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> 
@@ -214,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]
@@ -221,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> 
@@ -231,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> 
@@ -256,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:
     # 
@@ -268,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
@@ -286,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>
@@ -294,20 +327,28 @@ 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.
-    # 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.
-    # @param userDir [Wx::wxStandardPaths::Dir] 
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <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::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.
@@ -317,15 +358,19 @@ module Wx
     # @see Wx::StandardPaths#ignore_app_build_sub_dirs
     # @param subdirPattern [String]  The subdirectory containing the application binary which should be ignored when determining the top application directory. The pattern is case-insensitive and may contain wild card characters <code>'</code>?' and <code>'*'</code>.
     # @return [void]
+    # @wxrb_require WXMSW
     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]
+    # @wxrb_require WXMSW
     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.
@@ -338,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
     
@@ -363,16 +411,18 @@ 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__
+    #   \#ifdef __WXMSW__
     #       // get the location of files waiting to be burned on a CD
     #       wxString cdburnArea =
     #           wxStandardPaths::MSWGetShellDir(CSIDL_CDBURN_AREA);
-    #   #endif // __WXMSW__
+    #   \#endif // __WXMSW__
     # ```
     # @param csidl [Integer]  
     # @return [String]
+    # @wxrb_require WXMSW
     def self.msw_get_shell_dir(csidl) end
     
   end # StandardPaths

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}:
   # 
@@ -287,7 +288,7 @@ module Wx
   # If you need bitmap images (of the same artwork) that should be displayed at different sizes you should probably consider overriding {Wx::ArtProvider#create_icon_bundle} and supplying icon bundles that contain different bitmap sizes.
   # There's another way of taking advantage of this class: you can use it in your code and use platform native icons as provided by {Wx::ArtProvider.get_bitmap_bundle} or {Wx::ArtProvider.get_icon}.
   # 
-  # == Identifying art resources
+  # ## Identifying art resources
   # 
   # Every bitmap and icon bundle are known to {Wx::ArtProvider} under a unique ID that is used when requesting a resource from it. The ID is represented by the {Wx::ArtID} type and can have one of these predefined values (you can see bitmaps represented by these constants in the Art Provider Sample):
   # 
@@ -403,15 +404,19 @@ module Wx
   # 
   # - {Wx::ART_WX_LOGO} (since 3.1.6)  
   # 
-  # When running under GTK+ 2, GTK+ stock item IDs (e.g. <code>"gtk-cdrom"</code>) may be used as well: 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>When running under GTK+ 2, GTK+ stock item IDs (e.g. <code>"gtk-cdrom"</code>) may be used as well: 
   # ```ruby
   #   if Wx::PLATFORM == 'WXGTK'
   #     bmp = Wx::ArtProvider.get_bitmap("gtk-cdrom", Wx::ART_MENU)
   #   end
   # ```
   #  For a list of the GTK+ stock items please refer to the GTK+ documentation page. It is also possible to load icons from the current icon theme by specifying their name (without extension and directory components). Icon themes recognized by GTK+ follow the freedesktop.org Icon Themes specification. Note that themes are not guaranteed to contain all icons, so {Wx::ArtProvider} may return {Wx::NULL_BITMAP} or {Wx::NULL_ICON}. The default theme is typically installed in <code>/usr/share/icons/hicolor</code>.
+  # </p>
+  # </div>
   # 
-  # == Clients
+  # ## Clients
   # 
   # The client is the entity that calls {Wx::ArtProvider}'s {Wx::ArtProvider.get_bitmap} or {Wx::ArtProvider.get_icon} function. It is represented by {Wx::ClientID} type and can have one of these values:
   # 
@@ -432,7 +437,6 @@ module Wx
   # - {Wx::ART_OTHER} (used for all requests that don't fit into any of the categories above)
   # 
   # Client ID serve as a hint to {Wx::ArtProvider} that is supposed to help it to choose the best looking bitmap. For example it is often desirable to use slightly different icons in menus and toolbars even though they represent the same action (e.g. {Wx::ART_FILE_OPEN}). Remember that this is really only a hint for {Wx::ArtProvider}  it is common that {Wx::ArtProvider.get_bitmap} returns identical bitmap for different client values!
-  # === 
   # 
   # Category:  {Wx::Miscellaneous}
   # @see Art Provider Sample for an example of Wx::ArtProvider usage; stock ID list 
@@ -446,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.
@@ -456,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).
@@ -471,13 +477,20 @@ 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}.
-    # In some cases, a platform may have several appropriate native sizes (for example, {Wx::ART_FRAME_ICON} for frame icons). In that case, this method returns only one of them, picked reasonably.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>In some cases, a platform may have several appropriate native sizes (for example, {Wx::ART_FRAME_ICON} for frame icons). In that case, this method returns only one of them, picked reasonably.
+    # </p>
+    # </div>
     # @param client [Wx::ArtClient] 
     # @return [Wx::Size]
     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] 
@@ -485,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] 
@@ -492,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] 
@@ -500,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).
@@ -507,7 +523,8 @@ 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.
+    # 
+    # 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]
     def self.has_native_provider; end
@@ -517,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] 
@@ -524,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] 
@@ -544,16 +563,22 @@ 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).
     # 
-    # This is not part of {Wx::ArtProvider}'s public API, use {Wx::ArtProvider.get_bitmap} or {Wx::ArtProvider.get_icon_bundle} or {Wx::ArtProvider.get_icon} to query {Wx::ArtProvider} for a resource.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This is not part of {Wx::ArtProvider}'s public API, use {Wx::ArtProvider.get_bitmap} or {Wx::ArtProvider.get_icon_bundle} or {Wx::ArtProvider.get_icon} to query {Wx::ArtProvider} for a resource.
+    # </p>
+    # </div>
     # @see Wx::ArtProvider#create_icon_bundle 
     # @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.
@@ -562,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

@@ -8,10 +8,9 @@ module Wx::AUI
 
   # These are the possible pane dock art settings for {Wx::AUI::AuiDefaultDockArt}.
   # 
-  # === 
-  # 
   # Category:  Window Docking (wxAUI)
   # 
+  # @wxrb_require USE_AUI
   class AuiPaneDockArtSetting < Wx::Enum
   
     # Customizes the sash size.
@@ -88,6 +87,7 @@ module Wx::AUI
   # 
   # 
   # 
+  # @wxrb_require USE_AUI
   class AuiPaneDockArtGradients < Wx::Enum
   
     # No gradient on the captions, in other words a solid colour.
@@ -108,6 +108,7 @@ module Wx::AUI
   # 
   # 
   # 
+  # @wxrb_require USE_AUI
   class AuiPaneButtonState < Wx::Enum
   
     # Normal button state.
@@ -140,6 +141,7 @@ module Wx::AUI
   # 
   # 
   # 
+  # @wxrb_require USE_AUI
   class AuiButtonId < Wx::Enum
   
     # Shows a close button on the pane.
@@ -197,16 +199,17 @@ 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.
-  # === 
   # 
   # Category:  Window Docking (wxAUI)
   # @see Wx::AUI::AuiManager
   # @see  Wx::AUI::AuiPaneInfo 
   # 
   # 
+  # @wxrb_require USE_AUI
   class AuiDockArt < ::Object
   
     # Constructor.
@@ -251,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] 
@@ -270,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]
@@ -283,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]
@@ -290,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] 
@@ -303,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] 
@@ -312,8 +320,10 @@ 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
   class AuiDefaultDockArt < AuiDockArt
   
     # @return [Wx::AUI::AuiDefaultDockArt]
@@ -324,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]
@@ -331,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] 
@@ -338,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]
@@ -345,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] 
@@ -405,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,8 @@ module Wx::AUI
   # 
   # 
   # 
+  # 
+  # @wxrb_require USE_AUI
   class AuiFloatingFrame < Frame
   
     # @param parent [Wx::Window]