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

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

@@ -0,0 +1,110 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Objects of this class are similar in appearance to the normal {Wx::Buttons} but are similar to the links in a web page in functionality.
+  # Pressing such button usually results in switching to another window of the program and so they can be used as a replacement for the "Next" button in a multi-page dialog (such as {Wx::Wizard}), for example.
+  # Their advantage compared to the ordinary {Wx::Buttons} is that they emphasize the action of switching the window and also that they allow to give more detailed explanation to the user because, in addition to the short button label, they also show a longer description string.
+  # The short, title-like, part of the label is called the main label and the longer description is the note. Both of them can be set and queried independently using {Wx::CommandLinkButton}-specific methods such as {Wx::CommandLinkButton#set_main_label} or {Wx::CommandLinkButton#get_note} or also via {Wx::CommandLinkButton#set_label} and {Wx::CommandLinkButton#get_label} methods inherited from {Wx::Button}. When using the latter, the main label and the note are concatenated into a single string using a new line character between them (notice that the note part can have more new lines in it).
+  # {Wx::CommandLinkButton} generates the same event as {Wx::Button} but doesn't support any of {Wx::Button}-specific styles nor adds any new styles of its own.
+  # Currently this class uses native implementation under Windows Vista and later versions and a generic implementation for the other platforms and earlier Windows versions.
+  # 
+  # === 
+  # 
+  # Category:  {Wx::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::Button
+  # @see  Wx::BitmapButton 
+  # 
+  # 
+  class CommandLinkButton < Button
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   Use {Wx::CommandLinkButton#create} to really create the control.
+    #   @return [Wx::CommandLinkButton]
+    # @overload initialize(parent, id, mainLabel=(''), note=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ButtonNameStr)
+    #   Constructor really creating a command Link button.
+    #   The button will be decorated with stock icons under GTK+ 2.
+    #   @see Wx::CommandLinkButton#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
+    #   @param id [Integer]  Button identifier. A value of {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param mainLabel [String]  First line of text on the button, typically the label of an action that will be made when the button is pressed.
+    #   @param note [String]  Second line of text describing the action performed when the button is pressed.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Button position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Button size. If the default size is specified then the button is sized appropriately for the text.
+    #   @param style [Integer]  Window style. See {Wx::Button} class description.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::CommandLinkButton]
+    def initialize(*args) end
+    
+    # Button creation function for two-step creation.
+    # For more details, see {Wx::CommandLinkButton#initialize}.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param mainLabel [String] 
+    # @param note [String] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param validator [Wx::Validator] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id, mainLabel=(''), note=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ButtonNameStr) end
+    
+    # Sets a new main label and note for the button.
+    # Neither of the arguments can be empty, if you need to change just the label or just the note, use {Wx::CommandLinkButton#set_main_label} or {Wx::CommandLinkButton#set_note} instead of this function.
+    # @param mainLabel [String]  New main label to use.
+    # @param note [String]  New note to use.
+    # @return [void]
+    def set_main_label_and_note(mainLabel, note) end
+    
+    # Sets the string label and note for the button.
+    # @param label [String]  The label and note to set, with the two separated by the first newline or none to set a blank note.
+    # @return [void]
+    def set_label(label) end
+    alias_method :label=, :set_label
+    
+    # Returns the string label for the button.
+    # A string with the main label and note concatenated together with a newline separating them.
+    # @see Wx::CommandLinkButton#set_label
+    # @return [String]
+    def get_label; end
+    alias_method :label, :get_label
+    
+    # Changes the main label.
+    # @param mainLabel [String]  New main label to use.
+    # @return [void]
+    def set_main_label(mainLabel) end
+    alias_method :main_label=, :set_main_label
+    
+    # Changes the note.
+    # @param note [String]  New note to use.
+    # @return [void]
+    def set_note(note) end
+    alias_method :note=, :set_note
+    
+    # Returns the current main label.
+    # Main label currently displayed.
+    # @return [String]
+    def get_main_label; end
+    alias_method :main_label, :get_main_label
+    
+    # Returns the currently used note.
+    # Note currently displayed.
+    # @return [String]
+    def get_note; end
+    alias_method :note, :get_note
+    
+  end # CommandLinkButton
+  
+
+end

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

@@ -0,0 +1,10 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+
+end

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

@@ -61,7 +61,7 @@ module Wx
     # Constructs a context help object, calling {Wx::ContextHelp#begin_context_help} if doNow is true (the default).
     # If window is NULL, the top window is used.
     # @param window [Wx::Window] 
-    # @param doNow [true,false] 
+    # @param doNow [Boolean] 
     # @return [Wx::ContextHelp]
     def initialize(window=nil, doNow=true) end
     
@@ -69,12 +69,12 @@ module Wx
     # window is the window which will be used to catch events; if NULL, the top window will be used.
     # Returns true if the application was successfully put into context-sensitive help mode. This function only returns when the event loop has finished.
     # @param window [Wx::Window] 
-    # @return [true,false]
+    # @return [Boolean]
     def begin_context_help(window) end
     
     # Ends context-sensitive help mode.
     # Not normally called by the application.
-    # @return [true,false]
+    # @return [Boolean]
     def end_context_help; end
     
   end # ContextHelp

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

@@ -49,7 +49,7 @@ module Wx
     # @param style [Integer] 
     # @param validator [Wx::Validator] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ControlNameStr) end
     
     # Simulates the effect of the user issuing a command to the item.
@@ -216,7 +216,7 @@ module Wx
     # 
     # Currently {Wx::Button} supports markup in all major ports (wxMSW, wxGTK and wxOSX/Cocoa) while {Wx::StaticText} supports it in wxGTK and wxOSX and its generic version (which can be used under MSW if markup support is required). Extending support to more controls is planned in the future.
     # @param markup [String]  String containing markup for the label. It may contain markup tags described above and newline characters but currently only wxGTK and wxOSX support multiline labels with markup, the generic implementation (also used in wxMSW) only handles single line markup labels. Notice that the string must be well-formed (e.g. all tags must be correctly closed) and won't be shown at all otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def set_label_markup(markup) end
     alias_method :label_markup=, :set_label_markup
     
@@ -238,7 +238,7 @@ module Wx
     # Note that this function does not guarantee that the returned string will always be shorter than maxWidth; if maxWidth is extremely small, ellipsized text may be larger.
     # @param label [String]  The string to ellipsize
     # @param dc [Wx::DC]  The DC used to retrieve the character widths through the {Wx::DC#get_partial_text_extents} function.
-    # @param mode [EllipsizeMode]  The ellipsization mode. This is the setting which determines which part of the string should be replaced by the ellipsis (unless it is {Wx::EllipsizeMode::ELLIPSIZE_NONE} in which case nothing is done). See {Wx::EllipsizeMode} enumeration values for more info.
+    # @param mode [Wx::EllipsizeMode]  The ellipsization mode. This is the setting which determines which part of the string should be replaced by the ellipsis (unless it is {Wx::EllipsizeMode::ELLIPSIZE_NONE} in which case nothing is done). See {Wx::EllipsizeMode} enumeration values for more info.
     # @param maxWidth [Integer]  The maximum width of the returned string in pixels. This argument determines how much characters of the string need to be removed (and replaced by ellipsis).
     # @param flags [Integer]  One or more of the {Wx::EllipsizeFlags} enumeration values combined.
     # @return [String]

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

@@ -116,12 +116,12 @@ module Wx
     def delete(n) end
     
     # Returns true, if either untyped data (<code>void*</code>) or object data ({Wx::ClientData}*) is associated with the items of the control.
-    # @return [true,false]
+    # @return [Boolean]
     def has_client_data; end
     alias_method :has_client_data?, :has_client_data
     
     # Returns true, if untyped data (<code>void*</code>) is associated with the items of the control.
-    # @return [true,false]
+    # @return [Boolean]
     def has_client_untyped_data; end
     alias_method :has_client_untyped_data?, :has_client_untyped_data
     
@@ -135,7 +135,7 @@ module Wx
     # Returns true if the control is empty or false if it has some items.
     # 
     # @see Wx::ControlWithItems#get_count 
-    # @return [true,false]
+    # @return [Boolean]
     def is_empty; end
     alias_method :empty?, :is_empty
     
@@ -162,7 +162,7 @@ module Wx
     # Finds an item whose label matches the given string.
     # The zero-based position of the item, or {Wx::NOT_FOUND} if the string was not found.
     # @param string [String]  String to find.
-    # @param caseSensitive [true,false]  Whether search is case sensitive (default is not).
+    # @param caseSensitive [Boolean]  Whether search is case sensitive (default is not).
     # @return [Integer]
     def find_string(string, caseSensitive=false) end
     
@@ -189,7 +189,7 @@ module Wx
     # 
     # true if the specified string has been selected, false if it wasn't found in the control.
     # @param string [String]  The string to select.
-    # @return [true,false]
+    # @return [Boolean]
     def set_string_selection(string) end
     alias_method :string_selection=, :set_string_selection
     

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

@@ -7,10 +7,10 @@
 module Wx
 
   # wxRuby version string
-  Wx::WXRUBY_VERSION = '0.9.0-rc.3'
+  Wx::WXRUBY_VERSION = '0.9.0'
 
   # wxRuby version release type (alpha, beta, rc)
-  Wx::WXRUBY_RELEASE_TYPE = 'rc.3'
+  Wx::WXRUBY_RELEASE_TYPE = ''
   # wxRuby major version number
   Wx::WXRUBY_MAJOR = 0
   # wxRuby minor version number
@@ -19,7 +19,7 @@ module Wx
   Wx::WXRUBY_RELEASE = 0
 
   # Convenience string for WxWidgets version info
-  WXWIDGETS_VERSION = '3.2.2'
+  WXWIDGETS_VERSION = '3.2.3'
 
   # Integer constant reflecting the major version of the wxWidgets release used to build wxRuby
   WXWIDGETS_MAJOR_VERSION = 3
@@ -28,10 +28,10 @@ module Wx
   WXWIDGETS_MINOR_VERSION = 2
 
   # Integer constant reflecting the release number of the wxWidgets release used to build wxRuby
-  WXWIDGETS_RELEASE_NUMBER = 2
+  WXWIDGETS_RELEASE_NUMBER = 3
 
   # Integer constant reflecting the sub-release number of the wxWidgets release used to build wxRuby
-  WXWIDGETS_SUBRELEASE_NUMBER = 1
+  WXWIDGETS_SUBRELEASE_NUMBER = 0
 
   # Integer constant reflecting the wxWidgets wxDEBUG_LEVEL
   WXWIDGETS_DEBUG_LEVEL = 1

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

@@ -44,7 +44,7 @@ module Wx
     #   Constructs a cursor by passing a string resource name or filename.
     #   The arguments hotSpotX and hotSpotY are only used when there's no hotspot info in the resource/image-file to load (e.g. when using {Wx::BitmapType::BITMAP_TYPE_ICO} under wxMSW or {Wx::BitmapType::BITMAP_TYPE_XPM} under wxGTK).
     #   @param cursorName [String]  The name of the resource or the image file to load.
-    #   @param type [BitmapType]  Icon type to load. It defaults to {Wx::CURSOR_DEFAULT_TYPE}, which is a #define associated to different values on different platforms:
+    #   @param type [Wx::BitmapType]  Icon type to load. It defaults to {Wx::CURSOR_DEFAULT_TYPE}, which is a #define associated to different values on different platforms:
     #     
     #     - under Windows, it defaults to {Wx::BITMAP_TYPE_CUR_RESOURCE}. Other permitted types under Windows are {Wx::BitmapType::BITMAP_TYPE_CUR} (to load a cursor from a .cur cursor file), {Wx::BitmapType::BITMAP_TYPE_ICO} (to load a cursor from a .ico icon file) and {Wx::BitmapType::BITMAP_TYPE_ANI} (to load a cursor from a .ani icon file).
     #     - under MacOS, it defaults to {Wx::BITMAP_TYPE_MACCURSOR_RESOURCE}; when specifying a string resource name, first the color cursors 'crsr' and then the black/white cursors 'CURS' in the resource chain are scanned through. Note that resource forks are deprecated on macOS so this is only available for legacy reasons and should not be used in new code.
@@ -56,7 +56,7 @@ module Wx
     #   @return [Wx::Cursor]
     # @overload initialize(cursorId)
     #   Constructs a cursor using a cursor identifier.
-    #   @param cursorId [StockCursor]  A stock cursor identifier. See {Wx::StockCursor}.
+    #   @param cursorId [Wx::StockCursor]  A stock cursor identifier. See {Wx::StockCursor}.
     #   @return [Wx::Cursor]
     # @overload initialize(image)
     #   Constructs a cursor from a {Wx::Image}.
@@ -71,11 +71,6 @@ module Wx
     #   ```
     #   @param image [Wx::Image] 
     #   @return [Wx::Cursor]
-    # @overload initialize(xpmData)
-    #   Constructs a cursor from XPM data.
-    #   In versions of wxWidgets until 3.1.6 constructing {Wx::Cursor} from XPM data implicitly used {Wx::Image} constructor from XPM data and {Wx::Cursor} constructor from {Wx::Image}. Since 3.1.6 this constructor overload is available to allow constructing {Wx::Cursor} from XPM to still work, even though {Wx::Image} constructor from XPM is now explicit.
-    #   @param xpmData [char] 
-    #   @return [Wx::Cursor]
     # @overload initialize(cursor)
     #   Copy constructor, uses reference counting.
     #   @param cursor [Wx::Cursor]  Pointer or reference to a cursor to copy.
@@ -83,7 +78,7 @@ module Wx
     def initialize(*args) end
     
     # Returns true if cursor data is present.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     

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

@@ -48,7 +48,7 @@ module Wx
   
     # @overload initialize(format=Wx::DataFormatId::DF_INVALID)
     #   Constructs a data format object for one of the standard data formats or an empty data object (use {Wx::DataFormat#set_type} or {Wx::DataFormat#set_id} later in this case).
-    #   @param format [DataFormatId] 
+    #   @param format [Wx::DataFormatId] 
     #   @return [Wx::DataFormat]
     # @overload initialize(format)
     #   Constructs a data format object for a custom format identified by its name format.
@@ -68,14 +68,14 @@ module Wx
     alias_method :id=, :set_id
     
     # Sets the format to the given value, which should be one of {Wx::DF_XXX} constants.
-    # @param type [DataFormatId] 
+    # @param type [Wx::DataFormatId] 
     # @return [void]
     def set_type(type) end
     alias_method :type=, :set_type
     
     # Returns true if the formats are equal.
     # @param format [Wx::DataFormat] 
-    # @return [true,false]
+    # @return [Boolean]
     def ==(format) end
     
     # 

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

@@ -79,29 +79,29 @@ module Wx
     
     # Copies all formats supported in the given direction dir to the array pointed to by formats.
     # There must be enough space for GetFormatCount(dir) formats in it.
-    # @param dir [Direction] 
+    # @param dir [Wx::wxDataObject::Direction] 
     # @return [Array<Wx::DataFormat>]
-    def get_all_formats(dir=Wx::DataObjectSimpleBase::Direction::Get) end
+    def get_all_formats(dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
     alias_method :all_formats, :get_all_formats
     
     # The method will write the data of the format format to the buffer buf.
     # In other words, copy the data from this object in the given format to the supplied buffer. Returns true on success, false on failure.
     # @param format [Wx::DataFormat] 
-    # @return [Array(,String)]
+    # @return [String]
     def get_data_here(format) end
     alias_method :data_here, :get_data_here
     
     # Returns the number of available formats for rendering or setting the data.
-    # @param dir [Direction] 
+    # @param dir [Wx::wxDataObject::Direction] 
     # @return [Integer]
-    def get_format_count(dir=Wx::DataObjectSimpleBase::Direction::Get) end
+    def get_format_count(dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
     alias_method :format_count, :get_format_count
     
     # Returns the preferred format for either rendering the data (if dir is Get, its default value) or for setting it.
     # Usually this will be the native format of the {Wx::DataObject}.
-    # @param dir [Direction] 
+    # @param dir [Wx::wxDataObject::Direction] 
     # @return [Wx::DataFormat]
-    def get_preferred_format(dir=Wx::DataObjectSimpleBase::Direction::Get) end
+    def get_preferred_format(dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
     alias_method :preferred_format, :get_preferred_format
     
     # Set the data in the format format of the length len provided in the buffer buf.
@@ -110,14 +110,14 @@ module Wx
     # true on success, false on failure.
     # @param format [Wx::DataFormat]  The format for which to set the data.
     # @param buf [String]  Non-NULL pointer to the data.
-    # @return []
+    # @return [Boolean]
     def set_data(format, buf) end
     
     # Returns true if this format is supported.
     # @param format [Wx::DataFormat] 
-    # @param dir [Direction] 
-    # @return []
-    def is_supported(format, dir=Wx::DataObjectSimpleBase::Direction::Get) end
+    # @param dir [Wx::wxDataObject::Direction] 
+    # @return [Boolean]
+    def is_supported(format, dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
     alias_method :supported?, :is_supported
     
   end # DataObject
@@ -199,7 +199,7 @@ module Wx
     
     # Adds the dataObject to the list of supported objects and it becomes the preferred object if preferred is true.
     # @param dataObject [Wx::DataObjectSimple] 
-    # @param preferred [true,false] 
+    # @param preferred [Boolean] 
     # @return [void]
     def add(dataObject, preferred=false) end
     
@@ -212,7 +212,7 @@ module Wx
     # Returns the pointer to the object which supports the passed format for the specified direction.
     # NULL is returned if the specified format is not supported for this direction dir. The returned pointer is owned by {Wx::DataObjectComposite} itself and shouldn't be deleted by caller.
     # @param format [Wx::DataFormat] 
-    # @param dir [Direction] 
+    # @param dir [Wx::wxDataObject::Direction] 
     # @return [Wx::DataObjectSimple]
     def get_object(format, dir=Wx::DataObject::Get) end
     alias_method :object, :get_object

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

@@ -27,7 +27,7 @@ module Wx
     # @overload initialize(win, dt, type)
     #   @param win [Wx::Window] 
     #   @param dt [Time,Date,DateTime] 
-    #   @param type [Wx::AUI::AuiMDIChildFrame::EventType] 
+    #   @param type [Wx::CommandLinkButton::EventType] 
     #   @return [Wx::DateEvent]
     def initialize(*args) end
     

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

@@ -14,7 +14,7 @@ module Wx
   # 
   DP_SPIN = 1
   
-  # a combobox-like date picker (not supported in mac version)
+  # a combobox-like date picker (not supported on macOS <10.15.4)
   # 
   DP_DROPDOWN = 2
   
@@ -35,7 +35,7 @@ module Wx
   # 
   # - {Wx::DP_SPIN}: Creates a control without a month calendar drop down but with spin-control-like arrows to change individual date components. This style is not supported by the generic version. 
   # 
-  # - {Wx::DP_DROPDOWN}: Creates a control with a month calendar drop-down part from which the user can select a date. This style is not supported in OSX/Cocoa native version. 
+  # - {Wx::DP_DROPDOWN}: Creates a control with a month calendar drop-down part from which the user can select a date. In OSX/Cocoa native version this style is supported on macOS 10.15.4 and later. 
   # 
   # - {Wx::DP_DEFAULT}: Creates a control with the style that is best supported for the current platform (currently {Wx::DP_SPIN} under Windows and OSX/Cocoa and {Wx::DP_DROPDOWN} elsewhere). 
   # 
@@ -67,7 +67,7 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::DatePickerCtrl]
-    # @overload initialize(parent, id, dt=Wx::DefaultDateTime, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DP_DEFAULT|Wx::DP_SHOWCENTURY), validator=Wx::DEFAULT_VALIDATOR, name=("datectrl"))
+    # @overload initialize(parent, id, dt=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DP_DEFAULT|Wx::DP_SHOWCENTURY), validator=Wx::DEFAULT_VALIDATOR, name=("datectrl"))
     #   Initializes the object and calls {Wx::DatePickerCtrl#create} with all the parameters.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -92,8 +92,8 @@ module Wx
     # @param style [Integer]  The window style, see the description of the styles in the class documentation.
     # @param validator [Wx::Validator]  Validator which can be used for additional data checks.
     # @param name [String]  Control name.
-    # @return [true,false]
-    def create(parent, id, dt=Wx::DefaultDateTime, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DP_DEFAULT|Wx::DP_SHOWCENTURY), validator=Wx::DEFAULT_VALIDATOR, name=("datectrl")) end
+    # @return [Boolean]
+    def create(parent, id, dt=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DP_DEFAULT|Wx::DP_SHOWCENTURY), validator=Wx::DEFAULT_VALIDATOR, name=("datectrl")) end
     
     # Returns the currently entered date.
     # For a control with {Wx::DP_ALLOWNONE} style the returned value may be invalid if no date is entered, otherwise it is always valid.