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

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

@@ -7,7 +7,8 @@
 module Wx
 
   # A list event holds information about events associated with {Wx::ListCtrl} objects.
-  # === Events using this class
+  # 
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ListEvent} events.
   # Event handler methods:
@@ -56,16 +57,15 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_list_item_unchecked}(id, meth = nil, &block): The item has been unchecked (new since wxWidgets 3.1.0). 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::ListCtrl 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListEvent < NotifyEvent
   
     # Constructor.
-    # @param commandType [Wx::CommandLinkButton::EventType] 
+    # @param commandType [Wx::StaticLine::EventType] 
     # @param id [Integer] 
     # @return [Wx::ListEvent]
     def initialize(commandType=Wx::EVT_NULL, id=0) end
@@ -81,6 +81,7 @@ module Wx
     alias_method :cache_to, :get_cache_to
     
     # The column position: it is only used with COL events.
+    # 
     # For the column dragging events, it is the column to the left of the divider being dragged, for the column click events it may be -1 if the user clicked in the list control header outside any column.
     # @return [Integer]
     def get_column; end
@@ -102,6 +103,7 @@ module Wx
     alias_method :index, :get_index
     
     # An item object, used by some events.
+    # 
     # See also {Wx::ListCtrl#set_item}.
     # @return [Wx::ListItem]
     def get_item; end
@@ -137,6 +139,7 @@ module Wx
     def is_edit_cancelled; end
     alias_method :edit_cancelled?, :is_edit_cancelled
     
+    # 
     # 
     # 
     # @see Wx::ListEvent#get_key_code 
@@ -145,6 +148,7 @@ module Wx
     def set_key_code(code) end
     alias_method :key_code=, :set_key_code
     
+    # 
     # 
     # 
     # @see Wx::ListEvent#get_index 
@@ -153,6 +157,7 @@ module Wx
     def set_index(index) end
     alias_method :index=, :set_index
     
+    # 
     # 
     # 
     # @see Wx::ListEvent#get_column 
@@ -161,6 +166,7 @@ module Wx
     def set_column(col) end
     alias_method :column=, :set_column
     
+    # 
     # 
     # 
     # @see Wx::ListEvent#get_point 
@@ -169,6 +175,7 @@ module Wx
     def set_point(point) end
     alias_method :point=, :set_point
     
+    # 
     # 
     # 
     # @see Wx::ListEvent#get_item 
@@ -177,6 +184,7 @@ module Wx
     def set_item(item) end
     alias_method :item=, :set_item
     
+    # 
     # 
     # 
     # @see Wx::ListEvent#get_cache_from 
@@ -185,6 +193,7 @@ module Wx
     def set_cache_from(cacheFrom) end
     alias_method :cache_from=, :set_cache_from
     
+    # 
     # 
     # 
     # @see Wx::ListEvent#get_cache_to 

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

@@ -33,9 +33,10 @@ module Wx
   EVT_LISTBOOK_PAGE_CHANGING = 10097
   
   # {Wx::Listbook} is a class similar to {Wx::Notebook} but which uses a {Wx::ListCtrl} to show the labels instead of the tabs.
+  # 
   # The underlying {Wx::ListCtrl} displays page labels in a one-column report view by default. Calling Wx::BookCtrl::SetImageList will implicitly switch the control to use an icon view.
   # For usage documentation of this class, please refer to the base abstract class {Wx::BookCtrl}. You can also use the Notebook Sample to see {Wx::Listbook} in action.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -49,7 +50,7 @@ module Wx
   # 
   # - {Wx::LB_BOTTOM}: Place labels below the page area. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
   # Event handler methods for events emitted by this class:
@@ -58,17 +59,16 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_listbook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_LISTBOOK_PAGE_CHANGING} event. This event can be vetoed. 
   # 
-  # === 
-  # 
-  # Category:  Book Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  Book Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::BookCtrl
   # @see  Wx::Notebook
   # @see  Notebook Sample 
   # 
   # 
+  # @wxrb_require USE_LISTBOOK
   class Listbook < BookCtrlBase
   
     # @overload initialize()

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

@@ -10,6 +10,7 @@ module Wx
   # 
   # This enum is generated by misc/languages/genlang.py When making changes, please put them into misc/languages/langtabl.txt
   # 
+  # @wxrb_require USE_INTL
   class Language < Wx::Enum
   
     # User's default/preferred language as got from OS.
@@ -3602,6 +3603,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LayoutDirection < Wx::Enum
   
     # 
@@ -3624,6 +3626,7 @@ module Wx
   # @see Wx::LocaleIdent#get_tag 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleTagType < Wx::Enum
   
     # Default (tag as given or else same as {Wx::LocaleTagType::LOCALE_TAGTYPE_SYSTEM})
@@ -3659,6 +3662,7 @@ module Wx
   # @see  Wx::UILocale#get_info 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleCategory < Wx::Enum
   
     # Number formatting.
@@ -3686,6 +3690,7 @@ module Wx
   # @see Wx::UILocale#get_info 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleInfo < Wx::Enum
   
     # The thousands separator.
@@ -3720,6 +3725,7 @@ module Wx
   # @see Wx::UILocale#get_localized_name 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleName < Wx::Enum
   
     # Display name of a locale.
@@ -3742,6 +3748,7 @@ module Wx
   # @see Wx::UILocale#get_localized_name 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleForm < Wx::Enum
   
     # Name should be returned in the language of the locale itself.
@@ -3758,6 +3765,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleInitFlags < Wx::Enum
   
     # Don't load {Wx::std}.mo catalog.
@@ -3775,13 +3783,17 @@ module Wx
   def self.get_locale; end
   
   # {Wx::Locale} class encapsulates all language-dependent settings and is a generalization of the C locale concept.
-  # This class is known to have several problems under macOS: first of all, it is impossible to change the application UI locale after launching it under this platform and so using this class doesn't affect the native controls and dialogs there. Additionally, versions of macOS between 11.0 and 12.2 inclusive are affected by a bug when changing C locale can break display of the application menus. Because of this, it is recommended to use {Wx::UILocale} instead of this class for the applications targeting macOS.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>This class is known to have several problems under macOS: first of all, it is impossible to change the application UI locale after launching it under this platform and so using this class doesn't affect the native controls and dialogs there. Additionally, versions of macOS between 11.0 and 12.2 inclusive are affected by a bug when changing C locale can break display of the application menus. Because of this, it is recommended to use {Wx::UILocale} instead of this class for the applications targeting macOS.
+  # </p>
+  # </div>
   # 
   # In wxWidgets this class manages current locale. It also initializes and activates {Wx::Translations} object that manages message catalogs.
   # For a list of the supported languages, please see {Wx::Language} enum values. These constants may be used to specify the language in {Wx::Locale#init} and are returned by {Wx::Locale.get_system_language}.
   # 
   #  
-  # === 
   # 
   # Category:  Application and System configuration
   # @see Wx::Internationalization
@@ -3790,6 +3802,7 @@ module Wx
   # @see  Wx::Translations 
   # 
   # 
+  # @wxrb_require USE_INTL
   class Locale < ::Object
   
     # @overload initialize()
@@ -3802,6 +3815,7 @@ module Wx
     #   @return [Wx::Locale]
     # @overload initialize(name, shortName=(''), locale=(''), bLoadDefault=true)
     #   See {Wx::Locale#init} for parameters description.
+    #   
     #   The call of this function has several global side effects which you should understand: first of all, the application locale is changed - note that this will affect many of standard C library functions such as printf() or strftime(). Second, this {Wx::Locale} object becomes the new current global locale for the application and so all subsequent calls to {get_translation} will try to translate the messages using the message catalogs for this locale.
     #   @param name [String] 
     #   @param shortName [String] 
@@ -3828,6 +3842,7 @@ module Wx
     def add_catalog(*args) end
     
     # Returns the canonical form of current locale name.
+    # 
     # Canonical form is the one that is used on UNIX systems: it is a two- or five-letter string in xx or xx_YY format, where xx is ISO 639 code of language and YY is ISO 3166 code of the country. Examples are "en", "en_GB", "en_US" or "fr_FR". This form is internally used when looking up message catalogs. Compare {Wx::Locale#get_sys_name}.
     # @return [String]
     def get_canonical_name; end
@@ -3841,12 +3856,14 @@ module Wx
     alias_method :header_value, :get_header_value
     
     # Returns the {Wx::Language} constant of current language.
+    # 
     # Note that you can call this function only if you used the form of {Wx::Locale#init} that takes {Wx::Language} argument.
     # @return [Integer]
     def get_language; end
     alias_method :language, :get_language
     
     # Returns the locale name as passed to the constructor or {Wx::Locale#init}.
+    # 
     # This is a full, human-readable name, e.g. "English" or "French".
     # @return [Wx::String]
     def get_locale; end
@@ -3873,12 +3890,14 @@ module Wx
     alias_method :string, :get_string
     
     # Returns current platform-specific locale name as passed to setlocale().
+    # 
     # Compare {Wx::Locale#get_canonical_name}.
     # @return [String]
     def get_sys_name; end
     alias_method :sys_name, :get_sys_name
     
     # Initializes the {Wx::Locale} instance.
+    # 
     # The call of this function has several global side effects which you should understand: first of all, the application locale is changed - note that this will affect many of standard C library functions such as printf() or strftime(). Second, this {Wx::Locale} object becomes the new current global locale for the application and so all subsequent calls to {get_translation} will try to translate the messages using the message catalogs for this locale.
     # 
     # true on success or false if the given locale couldn't be set.
@@ -3907,12 +3926,14 @@ module Wx
     def self.add_catalog_lookup_path_prefix(prefix) end
     
     # Adds custom, user-defined language to the database of known languages.
+    # 
     # This database is used in conjunction with the first form of {Wx::Locale#init}.
     # @param info [Wx::LanguageInfo] 
     # @return [void]
     def self.add_language(info) end
     
     # This function may be used to find the language description structure for the given locale, specified either as a two letter ISO language code (for example, "pt"), a language code followed by the country code ("pt_BR") or a full, human readable, language description ("Portuguese_Brazil").
+    # 
     # Returns the information for the given language or NULL if this language is unknown. Note that even if the returned pointer is valid, the caller should not delete it.
     # @see Wx::Locale.get_language_info 
     # @param locale [String] 
@@ -3920,6 +3941,7 @@ module Wx
     def self.find_language_info(locale) end
     
     # Returns a pointer to {Wx::LanguageInfo} structure containing information about the given language or NULL if this language is unknown.
+    # 
     # Note that even if the returned pointer is valid, the caller should not delete it.
     # See {Wx::Locale.add_language} for the {Wx::LanguageInfo} description. As with {Wx::Locale#init}, {Wx::Language::LANGUAGE_DEFAULT} has the special meaning if passed as an argument to this function and in this case the result of {Wx::Locale.get_system_language} is used.
     # @param lang [Integer] 
@@ -3927,30 +3949,39 @@ module Wx
     def self.get_language_info(lang) end
     
     # Returns English name of the given language or empty string if this language is unknown.
+    # 
     # See {Wx::Locale.get_language_info} for a remark about special meaning of {Wx::Language::LANGUAGE_DEFAULT}.
     # @param lang [Integer] 
     # @return [String]
     def self.get_language_name(lang) end
     
     # Returns canonical name (see {Wx::Locale#get_canonical_name}) of the given language or empty string if this language is unknown.
+    # 
     # See {Wx::Locale.get_language_info} for a remark about special meaning of {Wx::Language::LANGUAGE_DEFAULT}.
     # @param lang [Integer] 
     # @return [String]
     def self.get_language_canonical_name(lang) end
     
     # Tries to detect the user's default font encoding.
+    # 
     # Returns {font_encoding} value or {Wx::FontEncoding::FONTENCODING_SYSTEM} if it couldn't be determined.
     # @return [Wx::FontEncoding]
     def self.get_system_encoding; end
     
     # Tries to detect the name of the user's default font encoding.
+    # 
     # This string isn't particularly useful for the application as its form is platform-dependent and so you should probably use {Wx::Locale.get_system_encoding} instead.
     # Returns a user-readable string value or an empty string if it couldn't be determined.
     # @return [String]
     def self.get_system_encoding_name; end
     
     # Tries to detect the user's default locale setting.
-    # This function is somewhat misleading, as it uses the default system locale to determine its return value, and not just the system language. It is preserved for backwards compatibility, but to actually get the language, and not locale, used by the system by default, call Wx::UILocale#get_system_language instead.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This function is somewhat misleading, as it uses the default system locale to determine its return value, and not just the system language. It is preserved for backwards compatibility, but to actually get the language, and not locale, used by the system by default, call Wx::UILocale#get_system_language instead.
+    # </p>
+    # </div>
     # 
     # Returns the {Wx::Language} value or {Wx::Language::LANGUAGE_UNKNOWN} if the locale is not recognized, as can notably happen when combining any language with a region where this language is not typically spoken.
     # @see Wx::Translations#get_best_translation. 
@@ -3958,6 +3989,7 @@ module Wx
     def self.get_system_language; end
     
     # Get the values of the given locale-dependent datum.
+    # 
     # This function returns the value of the locale-specific option specified by the given index.
     # 
     # The option value or empty string if the function failed.
@@ -3967,6 +3999,7 @@ module Wx
     def self.get_info(index, cat=Wx::LocaleCategory::LOCALE_CAT_DEFAULT) end
     
     # Get the values of a locale datum in the OS locale.
+    # 
     # This function shouldn't be used in the new code, use Wx::UILocale#get_info instead.
     # This function is similar to {Wx::Locale.get_info} and, in fact, identical to it under non-MSW systems. Under MSW it differs from it when no locale had been explicitly set: {Wx::Locale.get_info} returns the values corresponding to the "C" locale used by the standard library functions, while this method returns the values used by the OS which, in Windows case, correspond to the user settings in the control panel.
     # @param index [Wx::LocaleInfo] 
@@ -3975,6 +4008,7 @@ module Wx
     def self.get_os_info(index, cat=Wx::LocaleCategory::LOCALE_CAT_DEFAULT) end
     
     # Check whether the operating system and/or C run time environment supports this locale.
+    # 
     # For example in Windows, support for many locales is not installed by default. Returns true if the locale is supported.
     # The argument lang is the {Wx::Language} identifier. To obtain this for a given a two letter ISO language code, use {Wx::Locale.find_language_info} to obtain its {Wx::LanguageInfo} structure. See {Wx::Locale.add_language} for the {Wx::LanguageInfo} description.
     # @param lang [Integer] 
@@ -3987,9 +4021,35 @@ module Wx
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_INTL
   class LanguageInfo < ::Object
   
+    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
+    # Availability:  only available for the WXMSW port.
+    # 
+    # @return [Integer]
+    def win_lang; end
+    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
+    # Availability:  only available for the WXMSW port.
+    # 
+    # @param val [Integer]
+    # @return [void]
+    def win_lang=(val); end
+    
+    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
+    # Availability:  only available for the WXMSW port.
+    # 
+    # @return [Integer]
+    def win_sublang; end
+    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
+    # Availability:  only available for the WXMSW port.
+    # 
+    # @param val [Integer]
+    # @return [void]
+    def win_sublang=(val); end
+    
     # {Wx::Language} id.
     # It should be greater than {Wx::Language::LANGUAGE_USER_DEFINED} when defining your own language info structure.
     # 
@@ -4075,18 +4135,22 @@ module Wx
     def layout_direction=(val); end
     
     # Return the LCID corresponding to this language.
-    # Availability:  only available for the wxMSW port.  {Wx::msw}
+    # 
+    # Availability:  only available for the WXMSW port.
     # @return [Integer]
+    # @wxrb_require WXMSW
     def get_lcid; end
     alias_method :lcid, :get_lcid
     
     # Return the locale name corresponding to this language usable with <code>setlocale()</code> on the current system.
+    # 
     # If setting locale for this language is not supported, the returned string is empty.
     # @return [String]
     def get_locale_name; end
     alias_method :locale_name, :get_locale_name
     
     # Return the canonical locale name including the region, if known.
+    # 
     # The value is identical to CanonicalRef, if not empty, otherwise it is identical to CanonicalName.
     # @return [String]
     def get_canonical_with_region; end