wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,76 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class is used to iterate through the rectangles in a region, typically when examining the damaged regions of a window within an OnPaint call.
+  # 
+  # To use it, construct an iterator object on the stack and loop through the regions, testing the object and incrementing the iterator at the end of the loop.
+  # See {Wx::PaintEvent} for an example of use.
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # Predefined objects/pointers: {Wx::NullRegion}
+  # @see Wx::PaintEvent 
+  # 
+  # 
+  class RegionIterator < Object
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::RegionIterator]
+    # @overload initialize(region)
+    #   Creates an iterator object given a region.
+    #   @param region [Wx::Region] 
+    #   @return [Wx::RegionIterator]
+    def initialize(*args) end
+    
+    # An alias for {Wx::RegionIterator#get_height}.
+    # @return [Integer]
+    def get_h; end
+    alias_method :h, :get_h
+    
+    # Returns the height value for the current region.
+    # @return [Integer]
+    def get_height; end
+    alias_method :height, :get_height
+    
+    # Returns the current rectangle.
+    # @return [Wx::Rect]
+    def get_rect; end
+    alias_method :rect, :get_rect
+    
+    # An alias for {Wx::RegionIterator#get_width}.
+    # @return [Integer]
+    def get_w; end
+    alias_method :w, :get_w
+    
+    # Returns the width value for the current region.
+    # @return [Integer]
+    def get_width; end
+    alias_method :width, :get_width
+    
+    # Returns the x value for the current region.
+    # @return [Integer]
+    def get_x; end
+    alias_method :x, :get_x
+    
+    # Returns the y value for the current region.
+    # @return [Integer]
+    def get_y; end
+    alias_method :y, :get_y
+    
+    # Returns true if there are still some rectangles; otherwise returns false.
+    # @return [Boolean]
+    def have_rects; end
+    
+    # Resets the iterator to the beginning of the rectangles.
+    # @return [void]
+    def reset; end
+    
+  end # RegionIterator
+  
+
+end

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

@@ -0,0 +1,154 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Support tip kinds for {Wx::RichToolTip}.
+  # 
+  # This enum describes the kind of the tip shown which combines both the tip position and appearance because the two are related (when the tip is positioned asymmetrically, a right handed triangle is used but an equilateral one when it's in the middle of a side).
+  # Automatic selects the tip appearance best suited for the current platform and the position best suited for the window the tooltip is shown for, i.e. chosen in such a way that the tooltip is always fully on screen.
+  # Other values describe the position of the tooltip itself, not the window it relates to. E.g. {Wx::TipKind::TipKind_Top} places the tip on the top of the tooltip and so the tooltip itself is located beneath its associated window.
+  # 
+  # @wxrb_require USE_RICHTOOLTIP
+  class TipKind < Wx::Enum
+  
+    # Don't show any tip, the tooltip will be (roughly) rectangular.
+    # 
+    TipKind_None = Wx::TipKind.new(0)
+    
+    # Show a right triangle tip in the top left corner of the tooltip.
+    # 
+    TipKind_TopLeft = Wx::TipKind.new(1)
+    
+    # Show an equilateral triangle tip in the middle of the tooltip top side.
+    # 
+    TipKind_Top = Wx::TipKind.new(2)
+    
+    # Show a right triangle tip in the top right corner of the tooltip.
+    # 
+    TipKind_TopRight = Wx::TipKind.new(3)
+    
+    # Show a right triangle tip in the bottom left corner of the tooltip.
+    # 
+    TipKind_BottomLeft = Wx::TipKind.new(4)
+    
+    # Show an equilateral triangle tip in the middle of the tooltip bottom side.
+    # 
+    TipKind_Bottom = Wx::TipKind.new(5)
+    
+    # Show a right triangle tip in the bottom right corner of the tooltip.
+    # 
+    TipKind_BottomRight = Wx::TipKind.new(6)
+    
+    # Choose the appropriate tip shape and position automatically.
+    # 
+    TipKind_Auto = Wx::TipKind.new(7)
+    
+  end # TipKind
+  
+  # Allows showing a tool tip with more customizations than {Wx::ToolTip}.
+  # 
+  # Using this class is very simple, to give a standard warning for a password text control if the password was entered correctly you could simply do: 
+  # ```ruby
+  #   password = Wx::TextCtrl.new(..., style: Wx::TE_PASSWORD)
+  #   # ...
+  #   tip = Wx::RichToolTip.new("Caps Lock is on",
+  #                             "You might have made an error in your password\n" +
+  #                             "entry because Caps Lock is turned on.\n" +
+  #                             "\n" +
+  #                             "Press Caps Lock key to turn it off.")
+  #    tip.set_icon(Wx::ICON_WARNING)
+  #    tip.show_for(password)
+  # ```
+  # 
+  # Currently this class has generic implementation that can be used with any window and implements all the functionality but doesn't exactly match the appearance of the native tooltips (even though it makes some efforts to use the style most appropriate for the current platform) and a native MSW version which can be only used with text controls and doesn't provide as much in the way of customization. Because of this, it's inadvisable to customize the tooltips unnecessarily as doing this turns off auto-detection of the native style in the generic version and may prevent the native MSW version from being used at all.
+  # Notice that this class is not derived from {Wx::Window} and hence doesn't represent a window, even if its {Wx::RichToolTip#show_for} method does create one internally to show the tooltip.
+  # 
+  # Category:  Miscellaneous Windows
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_RICHTOOLTIP
+  class RichToolTip < ::Object
+  
+    # @overload set_icon(icon=Wx::ICON_INFORMATION)
+    #   Set the small icon to show.
+    #   
+    #   The icon can be either one of the standard information/warning/error ones, i.e. {Wx::ICON_INFORMATION}, {Wx::ICON_WARNING} or {Wx::ICON_ERROR} respectively (the question icon doesn't make sense for a tooltip so {Wx::ICON_QUESTION} can't be used here) or a custom icon. The latter is unsupported by the native MSW implementation of this class so the use of a standard icon is preferred.
+    #   @param icon [Integer] 
+    #   @return [void]
+    # @overload set_icon(icon)
+    #   Set the small icon to show.
+    #   
+    #   The icon can be either one of the standard information/warning/error ones, i.e. {Wx::ICON_INFORMATION}, {Wx::ICON_WARNING} or {Wx::ICON_ERROR} respectively (the question icon doesn't make sense for a tooltip so {Wx::ICON_QUESTION} can't be used here) or a custom icon. The latter is unsupported by the native MSW implementation of this class so the use of a standard icon is preferred.
+    #   @param icon [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @return [void]
+    def set_icon(*args) end
+    alias_method :icon=, :set_icon
+    
+    # Constructor must specify the tooltip title and main message.
+    # 
+    # The main message can contain embedded new lines. Both the title and message must be non-empty.
+    # Additional attributes can be set later.
+    # @param title [String] 
+    # @param message [String] 
+    # @return [Wx::RichToolTip]
+    def initialize(title, message) end
+    
+    # Set the background colour.
+    # 
+    # If two colours are specified, the background is drawn using a gradient from top to bottom, otherwise a single solid colour is used.
+    # By default the colour or colours most appropriate for the current platform are used. If a colour is explicitly set, native MSW version won't be used as it doesn't support setting the colour.
+    # @param col [Wx::Colour,String,Symbol] 
+    # @param colEnd [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_background_colour(col, colEnd=(Wx::Colour.new())) end
+    alias_method :background_colour=, :set_background_colour
+    
+    # Set timeout after which the tooltip should disappear and optionally set a delay before the tooltip is shown, in milliseconds.
+    # 
+    # By default the tooltip is shown immediately and hidden after a system-dependent interval of time elapses. This method can be used to change this or also disable hiding the tooltip automatically entirely by passing 0 in this parameter (but doing this will prevent the native MSW version from being used).
+    # Notice that the tooltip will always be hidden if the user presses a key or clicks a mouse button.
+    # Parameter millisecondsDelay is new since wxWidgets 2.9.5.
+    # @param millisecondsTimeout [unsigned] 
+    # @param millisecondsDelay [unsigned] 
+    # @return [void]
+    def set_timeout(millisecondsTimeout, millisecondsDelay=0) end
+    alias_method :timeout=, :set_timeout
+    
+    # Choose the tip kind, possibly none.
+    # 
+    # See {Wx::TipKind} documentation for the possible choices here.
+    # By default the tip is positioned automatically, as if {Wx::TipKind::TipKind_Auto} was used. Native MSW implementation doesn't support setting the tip kind explicitly and won't be used if this method is called with any value other than {Wx::TipKind::TipKind_Auto}.
+    # Notice that using non automatic tooltip kind may result in the tooltip being positioned partially off screen and it's the callers responsibility to ensure that this doesn't happen in this case.
+    # @param tipKind [Wx::TipKind] 
+    # @return [void]
+    def set_tip_kind(tipKind) end
+    alias_method :tip_kind=, :set_tip_kind
+    
+    # Set the title text font.
+    # 
+    # By default it's emphasized using the font style or colour appropriate for the current platform. Calling this method prevents the native MSW implementation from being used as it doesn't support changing the font.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_title_font(font) end
+    alias_method :title_font=, :set_title_font
+    
+    # Show the tooltip for the given window and optionally specify where to show the tooltip.
+    # 
+    # By default the tooltip tip points to the (middle of the) specified window which must be non-null or, if rect is non-nil, the middle of the specified {Wx::Rect}.
+    # The coordinates of the rect parameter are relative to the given window.
+    # Currently the native MSW implementation is used only if win is a {Wx::TextCtrl} and rect is nil. This limitation may be removed in the future.
+    # Parameter rect is new since wxWidgets 2.9.5.
+    # @param win [Wx::Window] 
+    # @param rect [Wx::Rect] 
+    # @return [void]
+    def show_for(win, rect=nil) end
+    
+  end # RichToolTip
+  
+
+end

data/lib/wx/doc/gen/rtc/event_list.rb

@@ -0,0 +1,125 @@
+# ----------------------------------------------------------------------------
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# ----------------------------------------------------------------------------
+
+
+module Wx
+
+  class EvtHandler
+
+    # @!group RTC Event handler methods
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_LEFT_CLICK} event, generated when the user releases the left mouse button over an object. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_left_click(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_RIGHT_CLICK} event, generated when the user releases the right mouse button over an object. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_right_click(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_MIDDLE_CLICK} event, generated when the user releases the middle mouse button over an object. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_middle_click(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_LEFT_DCLICK} event, generated when the user double-clicks an object. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_left_dclick(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_RETURN} event, generated when the user presses the return key. Valid event functions: GetFlags, GetPosition. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_return(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_CHARACTER} event, generated when the user presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_character(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_CONSUMING_CHARACTER} event, generated when the user presses a character key but before it is processed and inserted into the control. Call Veto to prevent normal processing. Valid event functions: GetFlags, GetPosition, GetCharacter, Veto. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_consuming_character(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_DELETE} event, generated when the user presses the backspace or delete key. Valid event functions: GetFlags, GetPosition. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_delete(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_STYLE_CHANGED} event, generated when styling has been applied to the control. Valid event functions: GetPosition, GetRange. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_style_changed(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_STYLESHEET_CHANGING} event, generated when the control's stylesheet has changed, for example the user added, edited or deleted a style. Valid event functions: GetRange, GetPosition. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_stylesheet_changed(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_STYLESHEET_REPLACING} event, generated when the control's stylesheet is about to be replaced, for example when a file is loaded into the control. Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_stylesheet_replacing(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_STYLESHEET_REPLACED} event, generated when the control's stylesheet has been replaced, for example when a file is loaded into the control. Valid event functions: GetOldStyleSheet, GetNewStyleSheet. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_stylesheet_replaced(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_PROPERTIES_CHANGED} event, generated when properties have been applied to the control. Valid event functions: GetPosition, GetRange. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_properties_changed(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_CONTENT_INSERTED} event, generated when content has been inserted into the control. Valid event functions: GetPosition, GetRange. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_content_inserted(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_CONTENT_DELETED} event, generated when content has been deleted from the control. Valid event functions: GetPosition, GetRange. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_content_deleted(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_BUFFER_RESET} event, generated when the buffer has been reset by deleting all content. You can use this to set a default style for the first new paragraph. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_buffer_reset(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_SELECTION_CHANGED} event, generated when the selection range has changed. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_selection_changed(id, meth = nil, &block) end
+    
+    # Process a {Wx::RTC::EVT_RICHTEXT_FOCUS_OBJECT_CHANGED} event, generated when the current focus object has changed. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::RTC::RichTextEvent] event the event to handle
+    def evt_richtext_focus_object_changed(id, meth = nil, &block) end
+    
+    # @!endgroup
+
+  end
+
+end