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

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

@@ -85,7 +85,7 @@ module Wx
     # 
     PORT_BASE = Wx::PortId.new(1)
     
-    # {Wx::MSW}, native toolkit is Windows API
+    # wxMSW, native toolkit is Windows API
     # 
     PORT_MSW = Wx::PortId.new(2)
     
@@ -93,7 +93,7 @@ module Wx
     # 
     PORT_MOTIF = Wx::PortId.new(4)
     
-    # {Wx::GTK}, using GTK+ 1.x, 2.x, 3.x, GPE
+    # wxGTK, using GTK+ 1.x, 2.x, 3.x, GPE
     # 
     PORT_GTK = Wx::PortId.new(8)
     
@@ -101,7 +101,7 @@ module Wx
     # 
     PORT_DFB = Wx::PortId.new(16)
     
-    # {Wx::X11}, using {Wx::Universal}
+    # wxX11, using {Wx::Universal}
     # 
     PORT_X11 = Wx::PortId.new(32)
     
@@ -177,15 +177,15 @@ module Wx
   # === 
   # 
   # Category:  Application and System configuration
-  # @return [true,false]
+  # @return [Boolean]
   def self.is_running_under_wine; end
   
   # This class holds information about the operating system, the toolkit and the basic architecture bitness of the machine where the application is currently running.
   # This class does not only have getters for the information above, it also has setters. This allows you to e.g. save the current platform information in a data file (maybe in string form) so that when you later load it, you can easily retrieve (see the static getters for string->enum conversion functions) and store inside a {Wx::PlatformInfo} instance (using its setters) the signature of the system which generated it.
-  # In general however you only need to use the static {Wx::PlatformInfo.get} function and then access the various information for the current platform: 
-  # ```
-  #   wxLogMessage("This application is running under %s.",
-  #                wxPlatformInfo::Get().GetOperatingSystemIdName());
+  # In general however you only need to use the static {Wx::PlatformInfo.instance} method and then access the various information for the current platform: 
+  # ```ruby
+  #   Wx.log_message("This application is running under %s.", 
+  #                  Wx::PlatformInfo.instance.get_operating_system_id_name)
   # ```
   # 
   # === 
@@ -204,12 +204,12 @@ module Wx
   class PlatformInfo < ::Object
   
     # Returns the architecture bitness ID of this {Wx::PlatformInfo} instance.
-    # @return [Bitness]
+    # @return [Wx::Bitness]
     def get_bitness; end
     alias_method :bitness, :get_bitness
     
     # Returns the endianness ID of this {Wx::PlatformInfo} instance.
-    # @return [Endianness]
+    # @return [Wx::Endianness]
     def get_endianness; end
     alias_method :endianness, :get_endianness
     
@@ -255,7 +255,7 @@ module Wx
     
     # Returns the operating system ID of this {Wx::PlatformInfo} instance.
     # See {get_os_version} for more info.
-    # @return [OperatingSystemId]
+    # @return [Wx::OperatingSystemId]
     def get_operating_system_id; end
     alias_method :operating_system_id, :get_operating_system_id
     
@@ -266,7 +266,7 @@ module Wx
     alias_method :operating_system_description, :get_operating_system_description
     
     # Returns the wxWidgets port ID associated with this {Wx::PlatformInfo} instance.
-    # @return [PortId]
+    # @return [Wx::PortId]
     def get_port_id; end
     alias_method :port_id, :get_port_id
     
@@ -277,27 +277,27 @@ module Wx
     alias_method :linux_distribution_info, :get_linux_distribution_info
     
     # Returns the desktop environment associated with this {Wx::PlatformInfo} instance.
-    # See Wx::AppTraits#get_desktop_environment for more info.
+    # See {Wx::AppTraits#get_desktop_environment} for more info.
     # @return [String]
     def get_desktop_environment; end
     alias_method :desktop_environment, :get_desktop_environment
     
     # Returns the run-time major version of the toolkit associated with this {Wx::PlatformInfo} instance.
-    # Note that if {Wx::PlatformInfo#get_port_id} returns {Wx::PortId::PORT_BASE}, then this value is zero (unless externally modified with {Wx::PlatformInfo#set_toolkit_version}); that is, no native toolkit is in use. See Wx::AppTraits#get_toolkit_version for more info.
+    # Note that if {Wx::PlatformInfo#get_port_id} returns {Wx::PortId::PORT_BASE}, then this value is zero (unless externally modified with {Wx::PlatformInfo#set_toolkit_version}); that is, no native toolkit is in use. See {Wx::AppTraits#get_toolkit_version} for more info.
     # @see Wx::PlatformInfo#check_toolkit_version 
     # @return [Integer]
     def get_toolkit_major_version; end
     alias_method :toolkit_major_version, :get_toolkit_major_version
     
     # Returns the run-time minor version of the toolkit associated with this {Wx::PlatformInfo} instance.
-    # Note that if {Wx::PlatformInfo#get_port_id} returns {Wx::PortId::PORT_BASE}, then this value is zero (unless externally modified with {Wx::PlatformInfo#set_toolkit_version}); that is, no native toolkit is in use. See Wx::AppTraits#get_toolkit_version for more info.
+    # Note that if {Wx::PlatformInfo#get_port_id} returns {Wx::PortId::PORT_BASE}, then this value is zero (unless externally modified with {Wx::PlatformInfo#set_toolkit_version}); that is, no native toolkit is in use. See {Wx::AppTraits#get_toolkit_version} for more info.
     # @see Wx::PlatformInfo#check_toolkit_version 
     # @return [Integer]
     def get_toolkit_minor_version; end
     alias_method :toolkit_minor_version, :get_toolkit_minor_version
     
     # Returns the run-time micro version of the toolkit associated with this {Wx::PlatformInfo} instance.
-    # Note that if {Wx::PlatformInfo#get_port_id} returns {Wx::PortId::PORT_BASE}, then this value is zero (unless externally modified with {Wx::PlatformInfo#set_toolkit_version}); that is, no native toolkit is in use. See Wx::AppTraits#get_toolkit_version for more info.
+    # Note that if {Wx::PlatformInfo#get_port_id} returns {Wx::PortId::PORT_BASE}, then this value is zero (unless externally modified with {Wx::PlatformInfo#set_toolkit_version}); that is, no native toolkit is in use. See {Wx::AppTraits#get_toolkit_version} for more info.
     # @see Wx::PlatformInfo#check_toolkit_version
     # @return [Integer]
     def get_toolkit_micro_version; end
@@ -347,7 +347,7 @@ module Wx
     # @param major [Integer] 
     # @param minor [Integer] 
     # @param micro [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def check_os_version(major, minor, micro=0) end
     
     # Returns true if the toolkit version is at least major.minor.micro.
@@ -359,16 +359,16 @@ module Wx
     # @param major [Integer] 
     # @param minor [Integer] 
     # @param micro [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def check_toolkit_version(major, minor, micro=0) end
     
     # Returns true if this instance is fully initialized with valid values.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
     # Returns true if this {Wx::PlatformInfo} describes {Wx::Universal} build.
-    # @return [true,false]
+    # @return [Boolean]
     def is_using_universal_widgets; end
     alias_method :using_universal_widgets?, :is_using_universal_widgets
     
@@ -378,5 +378,165 @@ module Wx
     
   end # PlatformInfo
   
+  # {Wx::VersionInfo} contains version information.
+  # This class is used by wxWidgets to provide version information about the libraries it uses and itself, but you can also apply it in user space, to provide version information about your own libraries, or other libraries that you use.
+  # === 
+  # 
+  # Category:  Data Structures
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class VersionInfo < ::Object
+  
+    # Constructor.
+    # The version information objects need to be initialized with this constructor and are immutable once they are created.
+    # @param name [String]  The name of the library or other entity that this object pertains to.
+    # @param major [Integer]  The major version component.
+    # @param minor [Integer]  The minor version component.
+    # @param micro [Integer]  The micro version component, 0 by default.
+    # @param revision [Integer]  The revision version component, also known as "build
+    #       number". This component is also 0 by default and is only available since wxWidgets 3.2.0.
+    # @param description [String]  Free form description of this version, none by default.
+    # @param copyright [String]  Copyright string, none by default.
+    # @return [Wx::VersionInfo]
+    def initialize(name=(()), major=0, minor=0, micro=0, revision=0, description=(()), copyright=(())) end
+    
+    # Get the name of the object (library).
+    # Name string.
+    # @return [Wx::String]
+    def get_name; end
+    alias_method :name, :get_name
+    
+    # Get the major version number.
+    # Major version number.
+    # @return [Integer]
+    def get_major; end
+    alias_method :major, :get_major
+    
+    # Get the minor version number.
+    # Minor version number.
+    # @return [Integer]
+    def get_minor; end
+    alias_method :minor, :get_minor
+    
+    # Get the micro version, or release number.
+    # This is the third component of the version.
+    # Micro version, or release number.
+    # @return [Integer]
+    def get_micro; end
+    alias_method :micro, :get_micro
+    
+    # Get the revision version, or build number.
+    # This is the fourth component of the version.
+    # Revision version, or build number.
+    # @return [Integer]
+    def get_revision; end
+    alias_method :revision, :get_revision
+    
+    # Get the string representation of this version object.
+    # This function returns the description if it is non-empty or {Wx::VersionInfo#get_version_string} if there is no description.
+    # @see Wx::VersionInfo#get_description
+    # @see  Wx::VersionInfo#get_version_string 
+    # @return [String]
+    def to_string; end
+    
+    # Get the string representation.
+    # The micro and revision components of the version are ignored/not used if they are both zero. If the revision component is non-zero all four parts will be used even if the micro component is zero.
+    # The version string in the form "name major.minor[.micro[.revision]]".
+    # @return [String]
+    def get_version_string; end
+    alias_method :version_string, :get_version_string
+    
+    # Return true if a description string has been specified.
+    # 
+    # @see Wx::VersionInfo#get_description 
+    # @return [Boolean]
+    def has_description; end
+    alias_method :has_description?, :has_description
+    
+    # Get the description string.
+    # The description may be empty.
+    # The description string, free-form.
+    # @return [Wx::String]
+    def get_description; end
+    alias_method :description, :get_description
+    
+    # Returns true if a copyright string has been specified.
+    # 
+    # @see Wx::VersionInfo#get_copyright 
+    # @return [Boolean]
+    def has_copyright; end
+    alias_method :has_copyright?, :has_copyright
+    
+    # Get the copyright string.
+    # The copyright string may be empty.
+    # The copyright string.
+    # @return [Wx::String]
+    def get_copyright; end
+    alias_method :copyright, :get_copyright
+    
+  end # VersionInfo
+  
+  # A structure containing information about a Linux distribution as returned by the lsb_release utility.
+  # See {get_linux_distribution_info} or {Wx::PlatformInfo#get_linux_distribution_info} for more info.
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class LinuxDistributionInfo < ::Object
+  
+    # The id of the distribution; e.g. "Ubuntu".
+    # 
+    # 
+    # @return [String]
+    def id; end
+    # The id of the distribution; e.g. "Ubuntu".
+    # 
+    # 
+    # @param val [String]
+    # @return [void]
+    def id=(val); end
+    
+    # The version of the distribution; e.g. "9.04".
+    # 
+    # 
+    # @return [String]
+    def release; end
+    # The version of the distribution; e.g. "9.04".
+    # 
+    # 
+    # @param val [String]
+    # @return [void]
+    def release=(val); end
+    
+    # The code name of the distribution; e.g. "jaunty".
+    # 
+    # 
+    # @return [String]
+    def code_name; end
+    # The code name of the distribution; e.g. "jaunty".
+    # 
+    # 
+    # @param val [String]
+    # @return [void]
+    def code_name=(val); end
+    
+    # The description of the distribution; e.g. "Ubuntu 9.04".
+    # 
+    # 
+    # @return [String]
+    def description; end
+    # The description of the distribution; e.g. "Ubuntu 9.04".
+    # 
+    # 
+    # @param val [String]
+    # @return [void]
+    def description=(val); end
+    
+    # @param ldi [Wx::LinuxDistributionInfo] 
+    # @return [Boolean]
+    def ==(ldi) end
+    
+  end # LinuxDistributionInfo
+  
 
 end

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

@@ -13,8 +13,8 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
-  # - {Wx::PU_CONTAINS_CONTROLS}: By default in {Wx::MSW}, a popup window will not take focus from its parent window. However many standard controls, including common ones such as {Wx::TextCtrl}, need focus to function correctly and will not work when placed on a default popup. This flag can be used to make the popup take focus and let all controls work but at the price of not allowing the parent window to keep focus while the popup is shown, which can also be sometimes desirable. This style is currently only implemented in MSW and simply does nothing under the other platforms (it's new since wxWidgets 3.1.3). 
+  # 
+  # - {Wx::PU_CONTAINS_CONTROLS}: By default in wxMSW, a popup window will not take focus from its parent window. However many standard controls, including common ones such as {Wx::TextCtrl}, need focus to function correctly and will not work when placed on a default popup. This flag can be used to make the popup take focus and let all controls work but at the price of not allowing the parent window to keep focus while the popup is shown, which can also be sometimes desirable. This style is currently only implemented in MSW and simply does nothing under the other platforms (it's new since wxWidgets 3.1.3). 
   # 
   # === 
   # 
@@ -27,18 +27,18 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [PopupWindow]
+    #   @return [Wx::PopupWindow]
     # @overload initialize(parent, flags=Wx::Border::BORDER_NONE)
     #   Constructor.
     #   @param parent [Wx::Window] 
     #   @param flags [Integer] 
-    #   @return [PopupWindow]
+    #   @return [Wx::PopupWindow]
     def initialize(*args) end
     
     # Create method for two-step creation.
     # @param parent [Wx::Window] 
     # @param flags [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, flags=Wx::Border::BORDER_NONE) end
     
     # Move the popup window to the right position, i.e. such that it is entirely visible.
@@ -62,12 +62,12 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [PopupTransientWindow]
+    #   @return [Wx::PopupTransientWindow]
     # @overload initialize(parent, flags=Wx::Border::BORDER_NONE)
     #   Constructor.
     #   @param parent [Wx::Window] 
     #   @param flags [Integer] 
-    #   @return [PopupTransientWindow]
+    #   @return [Wx::PopupTransientWindow]
     def initialize(*args) end
     
     # Popup the window (this will show it too).
@@ -84,7 +84,7 @@ module Wx
     # Called when a mouse is pressed while the popup is shown.
     # Return true from here to prevent its normal processing by the popup (which consists in dismissing it if the mouse is clicked outside it).
     # @param event [Wx::MouseEvent] 
-    # @return [true,false]
+    # @return [Boolean]
     def process_left_down(event) end
     
   end # PopupTransientWindow

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

@@ -40,7 +40,7 @@ module Wx
     # @param maximum [Integer] 
     # @param parent [Wx::Window] 
     # @param style [Integer] 
-    # @return [ProgressDialog]
+    # @return [Wx::ProgressDialog]
     def initialize(title, message, maximum=100, parent=nil, style=(Wx::PD_APP_MODAL|Wx::PD_AUTO_HIDE)) end
     
     # Returns the last value passed to the {Wx::ProgressDialog#update} function or {Wx::NOT_FOUND} if the dialog has no progress bar.
@@ -72,12 +72,12 @@ module Wx
     # Returns true if the "Cancel" button was pressed.
     # Normally a Cancel button press is indicated by {Wx::ProgressDialog#update} returning false but sometimes it may be more convenient to check if the dialog was cancelled from elsewhere in the code and this function allows doing it.
     # It always returns false if the Cancel button is not shown at all.
-    # @return [true,false]
+    # @return [Boolean]
     def was_cancelled; end
     
     # Returns true if the "Skip" button was pressed.
     # This is similar to {Wx::ProgressDialog#was_cancelled} but returns true if the "Skip" button was pressed, not the "Cancel" one.
-    # @return [true,false]
+    # @return [Boolean]
     def was_skipped; end
     
   end # ProgressDialog

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

@@ -51,21 +51,23 @@ module Wx
   # To use this class, call {Wx::PropertySheetDialog#create} from your own Create function. Then call {Wx::PropertySheetDialog#create_buttons}, and create pages, adding them to the book control. Finally call {Wx::PropertySheetDialog#layout_dialog}.
   # For example:
   # 
-  # ```
-  #   bool MyPropertySheetDialog::Create(...)
-  #   {
-  #       if (!wxPropertySheetDialog::Create(...))
-  #           return false;
-  #   
-  #       CreateButtons(wxOK|wxCANCEL|wxHELP);
-  #   
-  #       // Add page
-  #       wxPanel* panel = new wxPanel(GetBookCtrl(), ...);
-  #       GetBookCtrl()->AddPage(panel, "General");
-  #   
-  #       LayoutDialog();
-  #       return true;
-  #   }
+  # ```ruby
+  #   class MyPropertySheetDialog < Wx::PropertySheetDialog
+  # 
+  #     def create(...)
+  #        return false if !super
+  #     
+  #        create_buttons(Wx::OK|Wx::CANCEL|Wx::HELP)
+  #     
+  #        # Add page
+  #        panel = Wx::Panel.new(get_book_ctrl, ...)
+  #        get_book_ctrl.add_page(panel, "General")
+  #     
+  #        layout_dialog
+  #        true
+  #     end
+  # 
+  #   end
   # ```
   # 
   # If necessary, override {Wx::PropertySheetDialog#create_book_ctrl} and {Wx::PropertySheetDialog#add_book_ctrl} to create and add a different kind of book control. You will then need to use two-step construction for the dialog or change the style of the book control by calling {Wx::PropertySheetDialog#set_sheet_style} before calling {Wx::PropertySheetDialog#create}.
@@ -81,7 +83,7 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   Call Create if using this form of constructor.
-    #   @return [PropertySheetDialog]
+    #   @return [Wx::PropertySheetDialog]
     # @overload initialize(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_DIALOG_STYLE, name=Wx::DialogNameStr)
     #   Constructor.
     #   @param parent [Wx::Window] 
@@ -91,7 +93,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [PropertySheetDialog]
+    #   @return [Wx::PropertySheetDialog]
     def initialize(*args) end
     
     # Override this if you wish to add the book control in a way different from the standard way (for example, using different spacing).
@@ -107,7 +109,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, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_DIALOG_STYLE, name=Wx::DialogNameStr) end
     
     # Call this to create the buttons for the dialog.

data/lib/wx/doc/gen/prt/page_setup_dialog.rb

@@ -24,8 +24,8 @@ module Wx::PRT
     # Constructor.
     # Pass a parent window, and optionally a pointer to a block of page setup data, which will be copied to the print dialog's internal data.
     # @param parent [Wx::Window] 
-    # @param data [Wx::PageSetupDialogData] 
-    # @return [PageSetupDialog]
+    # @param data [Wx::PRT::PageSetupDialogData] 
+    # @return [Wx::PRT::PageSetupDialog]
     def initialize(parent, data=nil) end
     
     # Shows the dialog, returning {Wx::StandardID::ID_OK} if the user pressed OK, and {Wx::StandardID::ID_CANCEL} otherwise.

data/lib/wx/doc/gen/prt/preview_frame.rb

@@ -18,6 +18,19 @@ module Wx::PRT
   # 
   class PreviewFrame < Frame
   
+    # Constructor.
+    # Pass a print preview object plus other normal frame arguments. The print preview object will be destroyed by the frame when it closes.
+    # Note that size typically should not be specified explicitly to let the frame use its default size, adapted to its contents.
+    # @param preview [Wx::PrintPreview] 
+    # @param parent [Wx::Window] 
+    # @param title [String] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [Wx::PRT::PreviewFrame]
+    def initialize(preview, parent, title=("Print Preview"), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FrameNameStr) end
+    
     # Initializes the frame elements and prepares for showing it.
     # Calling this method is equivalent to calling {Wx::PRT::PreviewFrame#initialize_with_modality} with {Wx::PRT::PreviewFrameModalityKind::PreviewFrame_AppModal} argument, please see its documentation for more details.
     # Please notice that this function is virtual mostly for backwards compatibility only, there is no real need to override it as it's never called by wxWidgets itself.
@@ -26,10 +39,13 @@ module Wx::PRT
     
     # Initializes the frame elements and prepares for showing it with the given modality kind.
     # This method creates the frame elements by calling {Wx::PRT::PreviewFrame#create_canvas} and {Wx::PRT::PreviewFrame#create_control_bar} methods (which may be overridden to customize them) and prepares to show the frame according to the value of kind parameter:
-    # - If it is {Wx::PRT::PreviewFrameModalityKind::PreviewFrame_AppModal}, all the other application windows will be disabled when this frame is shown. This is the same behaviour as that of simple {Wx::PRT::PreviewFrame#initialize}.- If it is {Wx::PRT::PreviewFrameModalityKind::PreviewFrame_WindowModal}, only the parent window of the preview frame will be disabled when it is shown.- And if it is {Wx::PRT::PreviewFrameModalityKind::PreviewFrame_NonModal}, no windows at all will be disabled while the preview is shown.
+    # 
+    # - If it is {Wx::PRT::PreviewFrameModalityKind::PreviewFrame_AppModal}, all the other application windows will be disabled when this frame is shown. This is the same behaviour as that of simple {Wx::PRT::PreviewFrame#initialize}.
+    # - If it is {Wx::PRT::PreviewFrameModalityKind::PreviewFrame_WindowModal}, only the parent window of the preview frame will be disabled when it is shown.
+    # - And if it is {Wx::PRT::PreviewFrameModalityKind::PreviewFrame_NonModal}, no windows at all will be disabled while the preview is shown.
     # 
     # Notice that this function (or {Wx::PRT::PreviewFrame#initialize}) must be called by the application prior to showing the frame but you still must call <code>Show(true)</code> to actually show it afterwards.
-    # @param kind [PreviewFrameModalityKind]  The modality kind of preview frame.
+    # @param kind [Wx::PreviewFrameModalityKind]  The modality kind of preview frame.
     # @return [void]
     def initialize_with_modality(kind) end
     

data/lib/wx/doc/gen/prt/print_abort_dialog.rb

@@ -111,7 +111,7 @@ module Wx::PRT
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [PrintAbortDialog]
+    # @return [Wx::PRT::PrintAbortDialog]
     def initialize(parent, documentTitle, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_DIALOG_STYLE, name=("dialog")) end
     
     # @param currentPage [Integer]