wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

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

@@ -11,27 +11,49 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ListEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_list_begin_drag}(id, meth = nil, &block): Begin dragging with the left mouse button. 
+  # 
   # - {Wx::EvtHandler#evt_list_begin_rdrag}(id, meth = nil, &block): Begin dragging with the right mouse button. 
+  # 
   # - {Wx::EvtHandler#evt_list_begin_label_edit}(id, meth = nil, &block): Begin editing a label. This can be prevented by calling {Wx::ListEvent#veto}. 
+  # 
   # - {Wx::EvtHandler#evt_list_end_label_edit}(id, meth = nil, &block): Finish editing a label. This can be prevented by calling {Wx::ListEvent#veto}. 
+  # 
   # - {Wx::EvtHandler#evt_list_delete_item}(id, meth = nil, &block): Delete an item. 
+  # 
   # - {Wx::EvtHandler#evt_list_delete_all_items}(id, meth = nil, &block): Delete all items. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_selected}(id, meth = nil, &block): The item has been selected. Notice that the mouse is captured by the control itself when this event is generated, see event handling overview. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_deselected}(id, meth = nil, &block): The item has been deselected. {Wx::ListEvent#get_index} may be -1 with virtual lists. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_activated}(id, meth = nil, &block): The item has been activated (ENTER or double click). 
+  # 
   # - {Wx::EvtHandler#evt_list_item_focused}(id, meth = nil, &block): The currently focused item has changed. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_middle_click}(id, meth = nil, &block): The middle mouse button has been clicked on an item. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_right_click}(id, meth = nil, &block): The right mouse button has been clicked on an item. 
+  # 
   # - {Wx::EvtHandler#evt_list_key_down}(id, meth = nil, &block): A key has been pressed. {Wx::ListEvent#get_index} may be -1 if no item is selected. 
+  # 
   # - {Wx::EvtHandler#evt_list_insert_item}(id, meth = nil, &block): An item has been inserted. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_click}(id, meth = nil, &block): A column (m_col) has been left-clicked. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_right_click}(id, meth = nil, &block): A column (m_col) (which can be -1 if the click occurred outside any column) has been right-clicked. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_begin_drag}(id, meth = nil, &block): The user started resizing a column - can be vetoed. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_dragging}(id, meth = nil, &block): The divider between columns is being dragged. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_end_drag}(id, meth = nil, &block): A column has been resized by the user. 
+  # 
   # - {Wx::EvtHandler#evt_list_cache_hint}(id, meth = nil, &block): Prepare cache for a virtual list control 
+  # 
   # - {Wx::EvtHandler#evt_list_item_checked}(id, meth = nil, &block): The item has been checked (new since wxWidgets 3.1.0). 
+  # 
   # - {Wx::EvtHandler#evt_list_item_unchecked}(id, meth = nil, &block): The item has been unchecked (new since wxWidgets 3.1.0). 
   # 
   # === 
@@ -43,9 +65,9 @@ module Wx
   class ListEvent < NotifyEvent
   
     # Constructor.
-    # @param commandType [Integer] 
+    # @param commandType [Wx::CommandLinkButton::EventType] 
     # @param id [Integer] 
-    # @return [ListEvent]
+    # @return [Wx::ListEvent]
     def initialize(commandType=Wx::EVT_NULL, id=0) end
     
     # For EVT_LIST_CACHE_HINT event only: return the first item which the list control advises us to cache.
@@ -111,7 +133,7 @@ module Wx
     alias_method :text, :get_text
     
     # This method only makes sense for EVT_LIST_END_LABEL_EDIT message and returns true if it the label editing has been cancelled by the user ({Wx::ListEvent#get_label} returns an empty string in this case but it doesn't allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string).
-    # @return [true,false]
+    # @return [Boolean]
     def is_edit_cancelled; end
     alias_method :edit_cancelled?, :is_edit_cancelled
     

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

@@ -38,25 +38,31 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::LB_DEFAULT}: Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top). 
+  # 
   # - {Wx::LB_TOP}: Place labels above the page area. 
+  # 
   # - {Wx::LB_LEFT}: Place labels on the left side. 
+  # 
   # - {Wx::LB_RIGHT}: Place labels on the right side. 
+  # 
   # - {Wx::LB_BOTTOM}: Place labels below the page area. 
   # 
   # === 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:
+  # 
   # - {Wx::EvtHandler#evt_listbook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_LISTBOOK_PAGE_CHANGED} event. 
+  # 
   # - {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> {Wx::MSW} Appearance
-  #   </td><td> {Wx::GTK} Appearance
-  #   </td><td> {Wx::OSX} 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
@@ -67,7 +73,7 @@ module Wx
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [Listbook]
+    #   @return [Wx::Listbook]
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''))
     #   Constructs a listbook control.
     #   @param parent [Wx::Window] 
@@ -76,7 +82,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [Listbook]
+    #   @return [Wx::Listbook]
     def initialize(*args) end
     
     # Create the list book control that has already been constructed with the default constructor.
@@ -86,7 +92,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) end
     
     # Returns the {Wx::ListView} associated with the control.

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

@@ -3780,33 +3780,6 @@ module Wx
   # 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}.
   # 
-  # ```
-  #   # this imports gettext ( equivalent to Wx::GetTranslation
-  #   # and gettext_noop ( a noop )
-  #   # into your module
-  #   use Wx::Locale qw(:default);
-  #   
-  #   # ....
-  #   
-  #   # use the functions
-  #   print gettext( "Panic!" );
-  #   
-  #   button = Wx::Button-new( window, -1, gettext( "Label" ) );
-  # ```
-  # 
-  # If you need to translate a lot of strings, then adding gettext( ) around each one is a long task ( that is why _( ) was introduced ), so just choose a shorter name for gettext:
-  # 
-  # ```
-  #   use Wx::Locale 'gettext' = 't',
-  #                  'gettext_noop' = 'gettext_noop';
-  #   
-  #   # ...
-  #   
-  #   # use the functions
-  #   print t( "Panic!!" );
-  #   
-  #   # ...
-  # ```
   #  
   # === 
   # 
@@ -3821,37 +3794,37 @@ module Wx
   
     # @overload initialize()
     #   This is the default constructor and it does nothing to initialize the object: {Wx::Locale#init} must be used to do that.
-    #   @return [Locale]
+    #   @return [Wx::Locale]
     # @overload initialize(language, flags=Wx::LocaleInitFlags::LOCALE_LOAD_DEFAULT)
     #   See {Wx::Locale#init} for parameters description.
     #   @param language [Integer] 
     #   @param flags [Integer] 
-    #   @return [Locale]
+    #   @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] 
     #   @param locale [String] 
-    #   @param bLoadDefault [true,false] 
-    #   @return [Locale]
+    #   @param bLoadDefault [Boolean] 
+    #   @return [Wx::Locale]
     def initialize(*args) end
     
     # @overload add_catalog(domain)
     #   Calls Wx::Translations#add_catalog(wxString).
     #   @param domain [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload add_catalog(domain, msgIdLanguage)
     #   Calls wxTranslations::AddCatalog(const wxString&, wxLanguage).
     #   @param domain [String] 
-    #   @param msgIdLanguage [Language] 
-    #   @return [true,false]
+    #   @param msgIdLanguage [Wx::Language] 
+    #   @return [Boolean]
     # @overload add_catalog(domain, msgIdLanguage, msgIdCharset)
     #   Calls wxTranslations::AddCatalog(const wxString&, wxLanguage, const wxString&).
     #   @param domain [String] 
-    #   @param msgIdLanguage [Language] 
+    #   @param msgIdLanguage [Wx::Language] 
     #   @param msgIdCharset [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def add_catalog(*args) end
     
     # Returns the canonical form of current locale name.
@@ -3911,18 +3884,20 @@ module Wx
     # true on success or false if the given locale couldn't be set.
     # @param language [Integer]  {Wx::Language} identifier of the locale. It can be either some concrete language, e.g. {Wx::Language::LANGUAGE_ESPERANTO}, or a special value {Wx::Language::LANGUAGE_DEFAULT} which means that {Wx::Locale} should use system's default language (see {Wx::Locale.get_system_language}). Notice that the value {Wx::Language::LANGUAGE_UNKNOWN} is not allowed here.
     # @param flags [Integer]  Combination of the following:
-    #   - {Wx::LocaleInitFlags::LOCALE_LOAD_DEFAULT}: Load the message catalog for the given locale containing the translations of standard wxWidgets messages automatically.- {Wx::LocaleInitFlags::LOCALE_DONT_LOAD_DEFAULT}: Negation of {Wx::LocaleInitFlags::LOCALE_LOAD_DEFAULT}.
-    # @return [true,false]
+    #   
+    #   - {Wx::LocaleInitFlags::LOCALE_LOAD_DEFAULT}: Load the message catalog for the given locale containing the translations of standard wxWidgets messages automatically.
+    #   - {Wx::LocaleInitFlags::LOCALE_DONT_LOAD_DEFAULT}: Negation of {Wx::LocaleInitFlags::LOCALE_LOAD_DEFAULT}.
+    # @return [Boolean]
     def init(language=Wx::Language::LANGUAGE_DEFAULT, flags=Wx::LocaleInitFlags::LOCALE_LOAD_DEFAULT) end
     
     # Calls Wx::Translations#is_loaded.
     # @param domain [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_loaded(domain) end
     alias_method :loaded?, :is_loaded
     
     # Returns true if the locale could be set successfully.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
@@ -3965,7 +3940,7 @@ module Wx
     
     # 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 [FontEncoding]
+    # @return [Wx::FontEncoding]
     def self.get_system_encoding; end
     
     # Tries to detect the name of the user's default font encoding.
@@ -3986,16 +3961,16 @@ module Wx
     # 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.
-    # @param index [LocaleInfo]  One of the elements of {Wx::LocaleInfo} enum.
-    # @param cat [LocaleCategory]  The category to use with the given index or {Wx::LocaleCategory::LOCALE_CAT_DEFAULT} if the index can only apply to a single category.
+    # @param index [Wx::LocaleInfo]  One of the elements of {Wx::LocaleInfo} enum.
+    # @param cat [Wx::LocaleCategory]  The category to use with the given index or {Wx::LocaleCategory::LOCALE_CAT_DEFAULT} if the index can only apply to a single category.
     # @return [String]
     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 [LocaleInfo] 
-    # @param cat [LocaleCategory] 
+    # @param index [Wx::LocaleInfo] 
+    # @param cat [Wx::LocaleCategory] 
     # @return [String]
     def self.get_os_info(index, cat=Wx::LocaleCategory::LOCALE_CAT_DEFAULT) end
     
@@ -4003,7 +3978,7 @@ module Wx
     # 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] 
-    # @return [true,false]
+    # @return [Boolean]
     def self.is_available(lang) end
     
   end # Locale
@@ -4015,30 +3990,6 @@ module Wx
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class LanguageInfo < ::Object
   
-    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
-    # 
-    # @return [Integer]
-    def win_lang; end
-    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
-    # 
-    # @param val [Integer]
-    # @return [void]
-    def win_lang=(val); end
-    
-    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
-    # 
-    # @return [Integer]
-    def win_sublang; end
-    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
-    # 
-    # @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.
     # 
@@ -4124,7 +4075,7 @@ module Wx
     def layout_direction=(val); end
     
     # Return the LCID corresponding to this language.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @return [Integer]
     def get_lcid; end
     alias_method :lcid, :get_lcid