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

data/lib/wx/doc/gen/html/html_window.rb

@@ -78,17 +78,22 @@ module Wx::HTML
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::HTML::HW_SCROLLBAR_NEVER}: Never display scrollbars, not even when the page is larger than the window. 
+  # 
   # - {Wx::HTML::HW_SCROLLBAR_AUTO}: Display scrollbars only if page's size exceeds window's size. 
+  # 
   # - {Wx::HTML::HW_NO_SELECTION}: Don't allow the user to select text. 
   # 
   # === Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HTML::HtmlLinkEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_html_cell_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} was clicked. 
+  # 
   # - {Wx::EvtHandler#evt_html_cell_hover}(id, meth = nil, &block): The mouse passed over a {Wx::HTML::HtmlCell}. 
+  # 
   # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} which contains a hyperlink was clicked. 
   # 
   # === 
@@ -102,7 +107,7 @@ module Wx::HTML
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [HtmlWindow]
+    #   @return [Wx::HTML::HtmlWindow]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HTML::HW_DEFAULT_STYLE, name=("htmlWindow"))
     #   Constructor.
     #   The parameters are the same as Wx::Scrolled#initialize constructor.
@@ -112,7 +117,7 @@ module Wx::HTML
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [HtmlWindow]
+    #   @return [Wx::HTML::HtmlWindow]
     def initialize(*args) end
     
     # Appends HTML fragment to currently displayed text and refreshes the window.
@@ -125,7 +130,7 @@ module Wx::HTML
     # 
     # @see Cells and Containers
     # @see  Printing Framework Overview 
-    # @return [Wx::HtmlContainerCell]
+    # @return [Wx::HTML::HtmlContainerCell]
     def get_internal_representation; end
     alias_method :internal_representation, :get_internal_representation
     
@@ -199,9 +204,15 @@ module Wx::HTML
     # You can override {Wx::HTML::HtmlWindow#on_opening_url} to selectively block some URLs (e.g. for security reasons) or to redirect them elsewhere. Default behaviour is to always return {Wx::HTML::HtmlOpeningStatus::HTML_OPEN}.
     # 
     # The return value is:
-    # - {Wx::HTML::HtmlOpeningStatus::HTML_OPEN}: Open the URL.- {Wx::HTML::HtmlOpeningStatus::HTML_BLOCK}: Deny access to the URL, Wx::HtmlParser::OpenURL will return NULL.- {Wx::HTML::HtmlOpeningStatus::HTML_REDIRECT}: Don't open url, redirect to another URL. {Wx::HTML::HtmlWindow#on_opening_url} must fill *redirect with the new URL. {Wx::HTML::HtmlWindow#on_opening_url} will be called again on returned URL.
+    # 
+    # - {Wx::HTML::HtmlOpeningStatus::HTML_OPEN}: Open the URL.
+    # - {Wx::HTML::HtmlOpeningStatus::HTML_BLOCK}: Deny access to the URL, Wx::HtmlParser::OpenURL will return NULL.
+    # - {Wx::HTML::HtmlOpeningStatus::HTML_REDIRECT}: Don't open url, redirect to another URL. {Wx::HTML::HtmlWindow#on_opening_url} must fill *redirect with the new URL. {Wx::HTML::HtmlWindow#on_opening_url} will be called again on returned URL.
     # @param type [HtmlURLType]  Indicates type of the resource. Is one of
-    #   - {Wx::HTML::HtmlURLType::HTML_URL_PAGE}: Opening a HTML page.- {Wx::HTML::HtmlURLType::HTML_URL_IMAGE}: Opening an image.- {Wx::HTML::HtmlURLType::HTML_URL_OTHER}: Opening a resource that doesn't fall into any other category.
+    #   
+    #   - {Wx::HTML::HtmlURLType::HTML_URL_PAGE}: Opening a HTML page.
+    #   - {Wx::HTML::HtmlURLType::HTML_URL_IMAGE}: Opening an image.
+    #   - {Wx::HTML::HtmlURLType::HTML_URL_OTHER}: Opening a resource that doesn't fall into any other category.
     # @param url [String]  URL being opened.
     # @return [HtmlOpeningStatus]
     def on_opening_url(type, url) end
@@ -328,7 +339,7 @@ module Wx::HTML
     # ```
     # 
     # The plain text filter will be used if no other filter matches.
-    # @param filter [Wx::HtmlFilter] 
+    # @param filter [Wx::HTML::HtmlFilter] 
     # @return [void]
     def self.add_filter(filter) end
     
@@ -357,7 +368,7 @@ module Wx::HTML
   class HtmlFilter < Object
   
     # Constructor.
-    # @return [HtmlFilter]
+    # @return [Wx::HTML::HtmlFilter]
     def initialize; end
     
     # Returns true if this filter is capable of reading file file.

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

@@ -0,0 +1,152 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  HL_CONTEXTMENU = 1
+  
+  # 
+  HL_ALIGN_LEFT = 2
+  
+  # 
+  HL_ALIGN_RIGHT = 4
+  
+  # 
+  HL_ALIGN_CENTRE = 8
+  
+  # 
+  HL_DEFAULT_STYLE = 2097161
+  
+  # 
+  # 
+  EVT_HYPERLINK = 10023
+  
+  # This class shows a static text element which links to an URL.
+  # Appearance and behaviour is completely customizable.
+  # In fact, when the user clicks on the hyperlink, a {Wx::HyperlinkEvent} is sent but if that event is not handled (or it's skipped; see {Wx::Event#skip}), then a call to {launch_default_browser} is done with the hyperlink's URL.
+  # Note that standard {Wx::Window} functions like {Wx::Window#set_background_colour}, {Wx::Window#set_font}, {Wx::Window#set_cursor}, {Wx::Window#set_label} can be used to customize appearance of the hyperlink.
+  # === Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::HL_ALIGN_LEFT}: Align the text to the left. 
+  # 
+  # - {Wx::HL_ALIGN_RIGHT}: Align the text to the right. This style is not supported under Windows. 
+  # 
+  # - {Wx::HL_ALIGN_CENTRE}: Center the text (horizontally). This style is not supported under Windows. 
+  # 
+  # - {Wx::HL_CONTEXTMENU}: Pop up a context menu when the hyperlink is right-clicked. The context menu contains a "Copy URL" menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control. 
+  # 
+  # - {Wx::HL_DEFAULT_STYLE}: The default style for {Wx::HyperlinkCtrl}: {Wx::Border::BORDER_NONE}|{Wx::HL_CONTEXTMENU}|{Wx::HL_ALIGN_CENTRE}. 
+  # 
+  # === Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_hyperlink}(id, meth = nil, &block): The hyperlink was (left) clicked. If this event is not handled in user's code (or it's skipped; see {Wx::Event#skip}), then a call to {Wx::LaunchDefaultBrowser} is done with the hyperlink's URL. 
+  # 
+  # Currently this class is implemented using native support in wxGTK and wxMSW and a generic version is used by the other ports.
+  # === 
+  # 
+  # 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::URL
+  # @see  Wx::HyperlinkEvent 
+  # 
+  # 
+  class HyperlinkCtrl < Control
+  
+    # @overload initialize()
+    #   @return [Wx::HyperlinkCtrl]
+    # @overload initialize(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HyperlinkCtrlNameStr)
+    #   Constructor.
+    #   See {Wx::HyperlinkCtrl#create} for more info.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param label [String] 
+    #   @param url [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::HyperlinkCtrl]
+    def initialize(*args) end
+    
+    # Creates the hyperlink control.
+    # @param parent [Wx::Window]  Parent window. Must not be NULL.
+    # @param id [Integer]  Window identifier. A value of {Wx::StandardID::ID_ANY} indicates a default value.
+    # @param label [String]  The label of the hyperlink.
+    # @param url [String]  The URL associated with the given label.
+    # @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    # @param size [Array(Integer, Integer), Wx::Size]  Window size. If the {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    # @param style [Integer]  Window style. See {Wx::HyperlinkCtrl}.
+    # @param name [String]  Window name.
+    # @return [true,false]
+    def create(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HyperlinkCtrlNameStr) end
+    
+    # Returns the colour used to print the label of the hyperlink when the mouse is over the control.
+    # @return [Wx::Colour]
+    def get_hover_colour; end
+    alias_method :hover_colour, :get_hover_colour
+    
+    # Returns the colour used to print the label when the link has never been clicked before (i.e. the link has not been visited) and the mouse is not over the control.
+    # @return [Wx::Colour]
+    def get_normal_colour; end
+    alias_method :normal_colour, :get_normal_colour
+    
+    # Returns the URL associated with the hyperlink.
+    # @return [String]
+    def get_url; end
+    alias_method :url, :get_url
+    
+    # Returns true if the hyperlink has already been clicked by the user at least one time.
+    # @return [true,false]
+    def get_visited; end
+    alias_method :visited, :get_visited
+    
+    # Returns the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been visited).
+    # @return [Wx::Colour]
+    def get_visited_colour; end
+    alias_method :visited_colour, :get_visited_colour
+    
+    # Sets the colour used to print the label of the hyperlink when the mouse is over the control.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_hover_colour(colour) end
+    alias_method :hover_colour=, :set_hover_colour
+    
+    # Sets the colour used to print the label when the link has never been clicked before (i.e. the link has not been visited) and the mouse is not over the control.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_normal_colour(colour) end
+    alias_method :normal_colour=, :set_normal_colour
+    
+    # Sets the URL associated with the hyperlink.
+    # @param url [String] 
+    # @return [void]
+    def set_url(url) end
+    alias_method :url=, :set_url
+    
+    # Marks the hyperlink as visited (see {Wx::HyperlinkCtrl#set_visited_colour}).
+    # @param visited [true,false] 
+    # @return [void]
+    def set_visited(visited=true) end
+    alias_method :visited=, :set_visited
+    
+    # Sets the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been visited).
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_visited_colour(colour) end
+    alias_method :visited_colour=, :set_visited_colour
+    
+  end # HyperlinkCtrl
+  
+
+end

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

@@ -0,0 +1,44 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This event class is used for the events generated by {Wx::HyperlinkCtrl}.
+  # === Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
+  # Event handler methods:
+  # 
+  # - {Wx::EvtHandler#evt_hyperlink}(id, meth = nil, &block): User clicked on a hyperlink. 
+  # 
+  # === 
+  # 
+  # Category:  {Wx::Events}
+  # 
+  class HyperlinkEvent < CommandEvent
+  
+    # The constructor is not normally used by the user code.
+    # @param generator [Wx::Object] 
+    # @param id [Integer] 
+    # @param url [String] 
+    # @return [Wx::HyperlinkEvent]
+    def initialize(generator, id, url) end
+    
+    # Returns the URL of the hyperlink where the user has just clicked.
+    # @return [String]
+    def get_url; end
+    alias_method :url, :get_url
+    
+    # Sets the URL associated with the event.
+    # @param url [String] 
+    # @return [void]
+    def set_url(url) end
+    alias_method :url=, :set_url
+    
+  end # HyperlinkEvent
+  
+
+end

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

@@ -39,11 +39,11 @@ module Wx
     # @overload initialize()
     #   Default ctor.
     #   Constructs an icon object with no data; an assignment or another member function such as {Wx::Icon#load_file} must be called subsequently.
-    #   @return [Icon]
+    #   @return [Wx::Icon]
     # @overload initialize(icon)
     #   Copy ctor.
     #   @param icon [Wx::Icon] 
-    #   @return [Icon]
+    #   @return [Wx::Icon]
     # @overload initialize(name, type=Wx::ICON_DEFAULT_TYPE, desiredWidth=-1, desiredHeight=-1)
     #   Loads an icon from a file or resource.
     #   
@@ -52,18 +52,18 @@ module Wx
     #   @param type [BitmapType]  May be one of the {Wx::BitmapType} values and indicates which type of bitmap should be loaded. See the note in the class detailed description. Note that the {Wx::ICON_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the {Wx::icon.h} header for the value it takes for a specific port.
     #   @param desiredWidth [Integer]  Specifies the desired width of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
     #   @param desiredHeight [Integer]  Specifies the desired height of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
-    #   @return [Icon]
+    #   @return [Wx::Icon]
     # @overload initialize(loc)
     #   Loads an icon from the specified location.
     #   @param loc [Wx::IconLocation] 
-    #   @return [Icon]
+    #   @return [Wx::Icon]
     def initialize(*args) end
     
     # Attach a Windows icon handle.
-    # This {Wx::MSW}-specific method allows assigning a native Windows HICON (which must be cast to WXHICON opaque handle type) to {Wx::Icon}. Notice that this means that the HICON will be destroyed by {Wx::Icon} when it is destroyed.
+    # This wxMSW-specific method allows assigning a native Windows HICON (which must be cast to WXHICON opaque handle type) to {Wx::Icon}. Notice that this means that the HICON will be destroyed by {Wx::Icon} when it is destroyed.
     # true if successful.
     # 
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param icon [WXHICON] 
     # @return [true,false]
     def create_from_hicon(icon) end
@@ -169,36 +169,36 @@ module Wx
     
     # @overload initialize()
     #   Default ctor.
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     # @overload initialize(file, type=Wx::BitmapType::BITMAP_TYPE_ANY)
     #   Initializes the bundle with the icon(s) found in the file.
     #   @param file [String] 
     #   @param type [BitmapType] 
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     # @overload initialize(stream, type=Wx::BitmapType::BITMAP_TYPE_ANY)
     #   Initializes the bundle with the icon(s) found in the stream.
     #   Notice that the stream must be seekable, at least if it contains more than one icon. The stream pointer is positioned after the last icon read from the stream when this function returns.
     #   @param stream [IO,Wx::InputStream] 
     #   @param type [BitmapType] 
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     # @overload initialize(icon)
     #   Initializes the bundle with a single icon.
     #   @param icon [Wx::Icon] 
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     # @overload initialize(resourceName, module_)
     #   Initializes the bundle with all sizes of a group icon with resourceName stored as an MS Windows resource in module.
     #   When module is 0, the current instance is used.
     #   
-    #   Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    #   Availability:  only available for the wxMSW port.  {Wx::msw}
     #   @see AddIcon(const wxString&
     #   @see  WXHINSTANCE)
     #   @param resourceName [String] 
     #   @param module_ [WXHINSTANCE] 
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     # @overload initialize(ic)
     #   Copy constructor.
     #   @param ic [Wx::IconBundle] 
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     def initialize(*args) end
     
     # @overload add_icon(file, type=Wx::BitmapType::BITMAP_TYPE_ANY)
@@ -215,7 +215,7 @@ module Wx
     # @overload add_icon(resourceName, module_)
     #   Loads all sizes of a group icon with resourceName stored as an MS Windows resource in module.
     #   When module is 0, the current instance is used.
-    #   Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    #   Availability:  only available for the wxMSW port.  {Wx::msw}
     #   @param resourceName [String] 
     #   @param module_ [WXHINSTANCE] 
     #   @return [void]