wxruby3 0.9.1 → 0.9.2

data/lib/wx/doc/rbn/ribbon_tool_bar.rb

@@ -5,11 +5,19 @@
 # :startdoc:
 
 
-class Wx::RBN::RibbonToolBar
+module Wx
 
-  # Iterate tool items if block given or return enumerator.
-  # @yieldparam [Integer] tool_id A tool item id
-  # @return [Object,Enumerator] result from last block execution or an enumerator
-  def tools; end
+  module RBN
+
+    class RibbonToolBar
+
+      # Iterate tool items if block given or return enumerator.
+      # @yieldparam [Integer] tool_id A tool item id
+      # @return [Object,Enumerator] result from last block execution or an enumerator
+      def tools; end
+
+    end
+
+  end
 
 end

data/lib/wx/doc/region_iterator.rb

@@ -5,33 +5,37 @@
 # :startdoc:
 
 
-class Wx::RegionIterator
-
-  # Creates a Wx::RegionIterator and passes that to the given block.
-  # Removes the iterator after the block finishes.
-  # @param [Wx::Region] region
-  # @yieldparam [Wx::RegionIterator] region_it
-  def self.for_region(region)  end
-
-  # Creates a Wx::RegionIterator and iterates each rectangle in the region executing the given block
-  # for each iteration passing the region iterator.
-  # @param [Wx::Region] region
-  # @yieldparam [Wx::RegionIterator] region_it
-  def self.iterate(region) end
-
-  alias :have_rects? :have_rects
-
-  # Moves to the next rectangle of the iterated region.
-  # @return [void]
-  def next_rect; end
-
-  # If a block is given the given block is called for each rectangle in the region passing the rectangle.
-  # If no block is given an Enumerator is returned.
-  # @overload each(&block)
-  #   @yieldparam [Wx::Rect] rect
-  #   @return [Object]
-  # @overload each()
-  #   @return [Enumerator]
-  def each; end
+module Wx
+
+  class RegionIterator
+
+    # Creates a Wx::RegionIterator and passes that to the given block.
+    # Removes the iterator after the block finishes.
+    # @param [Wx::Region] region
+    # @yieldparam [Wx::RegionIterator] region_it
+    def self.for_region(region)  end
+
+    # Creates a Wx::RegionIterator and iterates each rectangle in the region executing the given block
+    # for each iteration passing the region iterator.
+    # @param [Wx::Region] region
+    # @yieldparam [Wx::RegionIterator] region_it
+    def self.iterate(region) end
+
+    alias :have_rects? :have_rects
+
+    # Moves to the next rectangle of the iterated region.
+    # @return [void]
+    def next_rect; end
+
+    # If a block is given the given block is called for each rectangle in the region passing the rectangle.
+    # If no block is given an Enumerator is returned.
+    # @overload each(&block)
+    #   @yieldparam [Wx::Rect] rect
+    #   @return [Object]
+    # @overload each()
+    #   @return [Enumerator]
+    def each; end
+
+  end
 
 end

data/lib/wx/doc/rtc/rich_text_composite_object.rb

@@ -0,0 +1,24 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  module RTC
+
+    class RichTextCompositeObject
+
+      # Yield each child object to the given block.
+      # Returns an Enumerator if no block given.
+      # @yieldparam [Wx::RTC::RichTextObject] child the child object yielded
+      # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+      def each_child; end
+
+    end
+
+  end
+
+end

data/lib/wx/doc/rtc/rich_text_ctrl.rb

@@ -0,0 +1,24 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  module RTC
+
+    class RichTextCtrl
+
+      # Yield each line to the given block.
+      # Returns an Enumerator if no block given.
+      # @yieldparam [String] line the line yielded
+      # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+      def each_line; end
+
+    end
+
+  end
+
+end

data/lib/wx/doc/rtc/rich_text_paragraph.rb

@@ -0,0 +1,24 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  module RTC
+
+    class RichTextParagraph
+
+      # Yield each line to the given block.
+      # Returns an Enumerator if no block given.
+      # @yieldparam [Wx::RTC::RichTextLine] line the line yielded
+      # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+      def each_line; end
+
+    end
+
+  end
+
+end

data/lib/wx/doc/rtc/richtext_buffer.rb

@@ -5,24 +5,32 @@
 # :startdoc:
 
 
-class Wx::RTC::RichTextBuffer
-
-  # Iterates all RichTextFileHandler-s and passes each handler to the given block
-  # or returns an enumerator if no block given.
-  # @yieldparam [Wx::RTC::RichTextFileHandler] handler
-  # @return [Object,Enumerator] last result of given block or enumerator
-  def self.each_handler; end
-
-  # Iterates all RichTextFieldType-s and passes each field type to the given block
-  # or returns an enumerator if no block given.
-  # @yieldparam [Wx::RTC::RichTextFieldType] field type
-  # @return [Object,Enumerator] last result of given block or enumerator
-  def self.each_field_type; end
-
-  # Iterates all RichTextDrawingHandler-s and passes each handler to the given block
-  # or returns an enumerator if no block given.
-  # @yieldparam [Wx::RTC::RichTextDrawingHandler] handler
-  # @return [Object,Enumerator] last result of given block or enumerator
-  def self.each_drawing_handler; end
+module Wx
+
+  module RTC
+
+    class RichTextBuffer
+
+      # Iterates all RichTextFileHandler-s and passes each handler to the given block
+      # or returns an enumerator if no block given.
+      # @yieldparam [Wx::RTC::RichTextFileHandler] handler
+      # @return [Object,Enumerator] last result of given block or enumerator
+      def self.each_handler; end
+
+      # Iterates all RichTextFieldType-s and passes each field type to the given block
+      # or returns an enumerator if no block given.
+      # @yieldparam [Wx::RTC::RichTextFieldType] field type
+      # @return [Object,Enumerator] last result of given block or enumerator
+      def self.each_field_type; end
+
+      # Iterates all RichTextDrawingHandler-s and passes each handler to the given block
+      # or returns an enumerator if no block given.
+      # @yieldparam [Wx::RTC::RichTextDrawingHandler] handler
+      # @return [Object,Enumerator] last result of given block or enumerator
+      def self.each_drawing_handler; end
+
+    end
+
+  end
 
 end

data/lib/wx/doc/rtc/richtext_printing.rb

@@ -5,16 +5,24 @@
 # :startdoc:
 
 
-class Wx::RTC::RichTextPrinting
+module Wx
 
-  # Returns (a copy of) the print data.
-  # @return [Wx::PRT::PrintData] print data copy
-  def get_print_data; end
-  alias :print_data :get_print_data
+  module RTC
 
-  # Returns (a copy of) the page setup data.
-  # @return [Wx::PRT::PageSetupDialogData] page setup data copy
-  def get_page_setup_data; end
-  alias :page_setup_data :get_page_setup_data
+    class RichTextPrinting
+
+      # Returns (a copy of) the print data.
+      # @return [Wx::PRT::PrintData] print data copy
+      def get_print_data; end
+      alias :print_data :get_print_data
+
+      # Returns (a copy of) the page setup data.
+      # @return [Wx::PRT::PageSetupDialogData] page setup data copy
+      def get_page_setup_data; end
+      alias :page_setup_data :get_page_setup_data
+
+    end
+
+  end
 
 end

data/lib/wx/doc/rtc/richtext_style_sheet.rb

@@ -5,16 +5,24 @@
 # :startdoc:
 
 
-class Wx::RTC::RichTextStyleSheet
+module Wx
 
-  # Copy ctor
-  # @param [Wx::RTC::RichTextStyleSheet] sheet
-  # @return [Wx::RTC::RichTextStyleSheet]
-  def initialize(sheet) end
+  module RTC
 
-  # Copy given style sheet
-  # @param [Wx::RTC::RichTextStyleSheet] sheet
-  # @return [void]
-  def copy(sheet) end
+    class RichTextStyleSheet
+
+      # Copy ctor
+      # @param [Wx::RTC::RichTextStyleSheet] sheet
+      # @return [Wx::RTC::RichTextStyleSheet]
+      def initialize(sheet) end
+
+      # Copy given style sheet
+      # @param [Wx::RTC::RichTextStyleSheet] sheet
+      # @return [void]
+      def copy(sheet) end
+
+    end
+
+  end
 
 end

data/lib/wx/doc/sizer.rb

@@ -0,0 +1,20 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class Sizer
+
+    # Yield each child item to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [Wx::SizerItem] child the child item yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_child; end
+
+  end
+
+end

data/lib/wx/doc/stc/styled_text_ctrl.rb

@@ -0,0 +1,24 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  module STC
+
+    class StyledTextCtrl
+
+      # Yield each line to the given block.
+      # Returns an Enumerator if no block given.
+      # @yieldparam [String] line the line yielded
+      # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+      def each_line; end
+
+    end
+
+  end
+
+end

data/lib/wx/doc/stream.rb

@@ -5,40 +5,44 @@
 # :startdoc:
 
 
-class Wx::InputStream
-
-  # @overload read(size)
-  #   Reads max size bytes from stream.
-  #   @param [Integer] size max number of bytes to read
-  #   @return [String,nil] string with bytes read (nil if none read)
-  # @overload read(output)
-  #   Reads bytes from stream and writes these to output stream until eof or error.
-  #   @param [IO,Wx::OutputStream] output output stream to write to
-  #   @return [self]
-  def read(*args); end
-
-  #   Reads size bytes from stream (until eof or error).
-  #   @param [Integer] size number of bytes to read
-  #   @return [String,nil] string with bytes read (nil if none read)
-  def read_all(size); end
-
-end
-
-class Wx::OutputStream
-
-  # @overload write(buffer)
-  #   Writes some or all bytes from buffer to stream.
-  #   @param [String] buffer string with bytes to write
-  #   @return [Integer] number of bytes written
-  # @overload write(input)
-  #   Write bytes read from input stream (until eof or error)
-  #   @param [IO,Wx::InputStream] input input stream to read from
-  #   @return [self]
-  def write(*args); end
-
-  # Writes bytes from buffer to stream.
-  # @param [String] buffer string with bytes to write
-  # @return [Integer] number of bytes written
-  def write_all(buffer); end
+module Wx
+
+  class InputStream
+
+    # @overload read(size)
+    #   Reads max size bytes from stream.
+    #   @param [Integer] size max number of bytes to read
+    #   @return [String,nil] string with bytes read (nil if none read)
+    # @overload read(output)
+    #   Reads bytes from stream and writes these to output stream until eof or error.
+    #   @param [IO,Wx::OutputStream] output output stream to write to
+    #   @return [self]
+    def read(*args); end
+
+    #   Reads size bytes from stream (until eof or error).
+    #   @param [Integer] size number of bytes to read
+    #   @return [String,nil] string with bytes read (nil if none read)
+    def read_all(size); end
+
+  end
+
+  class OutputStream
+
+    # @overload write(buffer)
+    #   Writes some or all bytes from buffer to stream.
+    #   @param [String] buffer string with bytes to write
+    #   @return [Integer] number of bytes written
+    # @overload write(input)
+    #   Write bytes read from input stream (until eof or error)
+    #   @param [IO,Wx::InputStream] input input stream to read from
+    #   @return [self]
+    def write(*args); end
+
+    # Writes bytes from buffer to stream.
+    # @param [String] buffer string with bytes to write
+    # @return [Integer] number of bytes written
+    def write_all(buffer); end
+
+  end
 
 end

data/lib/wx/doc/system_settings.rb

@@ -5,31 +5,35 @@
 # :startdoc:
 
 
-class Wx::SystemSettings
-
-  # Return the name of the current system appearance if available or empty string otherwise.
-  #
-  # This is currently only implemented for macOS and returns a not necessarily user-readable
-  # string such as "NSAppearanceNameAqua" there and an empty string under all the other platforms.
-  # @return [String]
-  def get_appearance_name; end
-  alias :appearance_name :get_appearance_name
-
-  # Return true if the current system there is explicitly recognized as being a dark theme or if
-  # the default window background is dark.
-  #
-  # This method should be used to check whether custom colours more appropriate for the default (light)
-  # or dark appearance should be used.
-  # return [true,false]
-  def is_appearance_dark; end
-  alias :appearance_dark? :is_appearance_dark
-
-  # Return true if the default window background is significantly darker than foreground.
-  #
-  # This is used by #is_appearance_dark if there is no platform-specific way to determine whether a dark
-  # mode is being used and is generally not very useful to call directly.
-  # return [true,false]
-  def is_appearance_using_dark_background; end
-  alias :appearance_using_dark_background? :is_appearance_using_dark_background
+module Wx
+
+  class SystemSettings
+
+    # Return the name of the current system appearance if available or empty string otherwise.
+    #
+    # This is currently only implemented for macOS and returns a not necessarily user-readable
+    # string such as "NSAppearanceNameAqua" there and an empty string under all the other platforms.
+    # @return [String]
+    def get_appearance_name; end
+    alias :appearance_name :get_appearance_name
+
+    # Return true if the current system there is explicitly recognized as being a dark theme or if
+    # the default window background is dark.
+    #
+    # This method should be used to check whether custom colours more appropriate for the default (light)
+    # or dark appearance should be used.
+    # return [true,false]
+    def is_appearance_dark; end
+    alias :appearance_dark? :is_appearance_dark
+
+    # Return true if the default window background is significantly darker than foreground.
+    #
+    # This is used by #is_appearance_dark if there is no platform-specific way to determine whether a dark
+    # mode is being used and is generally not very useful to call directly.
+    # return [true,false]
+    def is_appearance_using_dark_background; end
+    alias :appearance_using_dark_background? :is_appearance_using_dark_background
+
+  end
 
 end

data/lib/wx/doc/text_validator.rb

@@ -5,14 +5,18 @@
 # :startdoc:
 
 
-class Wx::TextValidator
+module Wx
 
-  # @overload initialize(validator)
-  #   Copy constructor.
-  #   @param [Wx::TextValidator] validator validator to copy
-  # @overload initialize(style=Wx::FILTER_NONE)
-  #   Constructor taking a style.
-  #   @param [Integer] style One or more of the {Wx::TextValidatorStyle} styles. See #set_style.
-  def initialize(*args) end
+  class TextValidator
+
+    # @overload initialize(validator)
+    #   Copy constructor.
+    #   @param [Wx::TextValidator] validator validator to copy
+    # @overload initialize(style=Wx::FILTER_NONE)
+    #   Constructor taking a style.
+    #   @param [Integer] style One or more of the {Wx::TextValidatorStyle} styles. See #set_style.
+    def initialize(*args) end
+
+  end
 
 end

data/lib/wx/doc/textctrl.rb

@@ -23,6 +23,7 @@ module Wx
   #   ````
   #
   # This class is only available if `Wx.has_feature?(:USE_SPELLCHECK)` returns true.
+  # @wxrb_require USE_SPELLCHECK
   class TextProofOptions
     def initialize(schk=false, gchk=false, lang='')end
 
@@ -59,6 +60,18 @@ module Wx
 
   class TextCtrl
 
+    # Appends the string representation of `obj` to the text value of the control.
+    # Calls #to_s to get the string representation of `obj`.
+    # @param [Object] obj
+    # @return [self]
+    def <<(obj) end
+
+    # Yield each line to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [String] line the line yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_line; end
+
     # @overload enable_proof_check(text_proof_options = Wx::TextProofOptions.default)
     #   Enable or disable native spell checking on this text control if it is available on the current platform.
     #   Currently this is supported in WXMSW (when running under Windows 8 or later), WXGTK when using GTK 3 and wxOSX.
@@ -67,6 +80,7 @@ module Wx
     #   When using WXGTK, this method only works if gspell library was available during the wxWidgets library build.
     #   @param [Wx::TextProofOptions] text_proof_options A Wx::TextProofOptions object specifying the desired behaviour of the proof checker (e.g. language to use, spell check, grammar check, etc.) and whether the proof checks should be enabled at all. By default, spelling checks for the current language are enabled. Passing Wx::TextProofOptions.disable disables all the checks.
     #   @return [Boolean] true if proof checking has been successfully enabled or disabled, false otherwise (usually because the corresponding functionality is not available under the current platform or for this type of text control).
+    #   @wxrb_require USE_SPELLCHECK
     # @overload enable_proof_check(spell_checking, grammar_checking, language)
     #   Enable or disable native spell checking on this text control if it is available on the current platform.
     #   Currently this is supported in WXMSW (when running under Windows 8 or later), WXGTK when using GTK 3 and wxOSX.
@@ -77,11 +91,13 @@ module Wx
     #   @param [Boolean] grammar_checking
     #   @param [String] language
     #   @return [Boolean] true if proof checking has been successfully enabled or disabled, false otherwise (usually because the corresponding functionality is not available under the current platform or for this type of text control).
+    #   @wxrb_require USE_SPELLCHECK
     def enable_proof_check(*opts) end
 
     # Returns the current text proofing options.
     # Only available if `Wx.has_feature?(:USE_SPELLCHECK)` returns true.
     # @return [Wx::TextProofOptions]
+    # @wxrb_require USE_SPELLCHECK
     def get_proof_check_options; end
 
   end

data/lib/wx/doc/tree_ctrl.rb

@@ -0,0 +1,95 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class TreeCtrl
+
+    # Yield each tree item id (recursively) to the given block.
+    # Starts at tree item specified or at root if none specified.
+    # Returns an Enumerator if no block given.
+    # @param [Wx::TreeItemId,nil] start_id
+    # @yieldparam [Wx::TreeItemId] child_id the child tree item id yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def traverse(start_id=nil) end
+    alias :each :traverse
+
+    # Returns the first child; call #get_next_child() for the next child.
+    # For this enumeration method a 'cookie' is returned which is opaque for the application but is necessary
+    # for the library to make these methods reentrant (i.e. allow more than one enumeration on one and the
+    # same object simultaneously). The cookie returned from (and passed to) #get_first_child() and #get_next_child()
+    # should be the same variable.
+    #
+    # Returns an invalid tree item (i.e. Wx::TreeItemId#ok? returns false) if there are no further children.
+    # @param [Wx::TreeItemId] parent_id the id of the parent tree item for which to iterate children
+    # @return [Array(Wx::TreeItemId, Object)] first child item id (if any) and cookie value
+    def get_first_child(parent_id) end
+
+    # Returns the next child; call #get_first_child() for the first child.
+    # For this enumeration function you must pass in a 'cookie' parameter which is opaque for the application
+    # but is necessary for the library to make these functions reentrant (i.e. allow more than one enumeration
+    # on one and the same object simultaneously). The cookie returned from (and passed to) #get_first_child()
+    # and #get_next_child() should be the same variable.
+    #
+    # Returns an invalid tree item if there are no further children.
+    # @param [Wx::TreeItemId] parent_id the id of the parent tree item for which to iterate children
+    # @param [Object] cookie cookie value as returned from previous #get_first_cild or #get_next_child call.
+    # @return [Array(Wx::TreeItemId, Object)] first child item id (if any) and cookie value
+    def get_next_child(parent_id, cookie) end
+
+    # Iterate all child items of the given parent and yield it's id to the given block.
+    # Returns an Enumerator if no block given.
+    # @param [Wx::TreeItemId] parent_id
+    # @yieldparam [Wx::TreeItemId] child_id the child tree item id yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_item_child(parent_id) end
+
+    # Returns an array of tree item ids of the child items of the given parent.
+    # @param [Wx::TreeItemId] parent_id
+    # @return [Array<Wx::TreeItemId>]
+    def get_item_children(parent_id) end
+    alias :item_children :get_item_children
+
+    # Returns an array of tree item ids of the current child items of the root.
+    # Mainly useful for tree control using TR_HIDE_ROOT style where there are
+    # multiple root-like items.
+    # @return [Array<Wx::TreeItemId>]
+    def get_root_items; end
+
+    # Returns an array of tree item ids of the currently selected items.
+    # This function can be called only if the control has the wxTR_MULTIPLE style.
+    # @return [Array<Wx::TreeItemId>]
+    def get_selections; end
+
+    # Inserts an item before one identified by its position (pos).
+    # pos must be less than or equal to the number of children.
+    # The image and selImage parameters are an index within the normal image list specifying
+    # the image to use for unselected and selected items, respectively. If image > -1 and
+    # selImage is -1, the same image is used for both selected and unselected items.
+    # @param [Wx::TreeItemId] parent parent tree item id to insert child item for
+    # @param [Integer] pos child item's position to insert before
+    # @param [Integer] image image index for unselected item
+    # @param [Integer] selImage image index for selected item
+    # @param data [Object]
+    # @return [Wx::TreeItemId] id of inserted tree item
+    def insert_item_before(parent, pos, text, image=-1, selImage=-1, data=nil) end
+
+    # Starts editing the label of the given item.
+    # This function generates a EVT_TREE_BEGIN_LABEL_EDIT event which can be vetoed to prevent the editing from starting.
+    # If it does start, a text control, which can be retrieved using GetEditControl(), allowing the user to edit the
+    # label interactively is shown.
+    # When the editing ends, EVT_TREE_END_LABEL_EDIT event is sent and this event can be vetoed as well to prevent the
+    # label from changing. Note that this event is sent both when the user accepts (e.g. by pressing Enter) or cancels
+    # (e.g. by pressing Escape) and its handler can use wxTreeEvent::IsEditCancelled() to distinguish between these
+    # situations.
+    # @param [Wx::TreeItemId] item_id
+    # @return [void]
+    def edit_label(item_id) end
+
+  end
+
+end