wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -7,17 +7,17 @@
 module Wx
 
   # This event class is used for the events generated by {Wx::HyperlinkCtrl}.
-  # === Events using this class
+  # 
+  # ### 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}
   # 
+  # @wxrb_require USE_HYPERLINKCTRL
   class HyperlinkEvent < CommandEvent
   
     # The constructor is not normally used by the user code.

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

@@ -18,10 +18,14 @@ module Wx
   NULL_ICON_BUNDLE = nil
   
   # An icon is a small rectangular bitmap usually used for denoting a minimized application.
+  # 
   # It differs from a {Wx::Bitmap} in always having a mask associated with it for transparent drawing. On some platforms, icons and bitmaps are implemented identically, since there is no real distinction between a {Wx::Bitmap} with a mask and an icon; and there is no specific icon format on some platforms (X-based applications usually standardize on XPMs for small bitmaps and icons). However, some platforms (such as Windows) make the distinction, so a separate class is provided.
-  # It is usually desirable to associate a pertinent icon with a frame. Icons can also be used for other purposes, for example with {Wx::TreeCtrl} and {Wx::ListCtrl}. Icons have different formats on different platforms therefore separate icons will usually be created for the different environments. Platform-specific methods for creating a {Wx::Icon} structure are catered for, and this is an occasion where conditional compilation will probably be required. Note that a new icon must be created for every time the icon is to be used for a new window. In Windows, the icon will not be reloaded if it has already been used. An icon allocated to a frame will be deleted when the frame is deleted. For more information please see Bitmaps and Icons.
   # 
-  # === 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>It is usually desirable to associate a pertinent icon with a frame. Icons can also be used for other purposes, for example with {Wx::TreeCtrl} and {Wx::ListCtrl}. Icons have different formats on different platforms therefore separate icons will usually be created for the different environments. Platform-specific methods for creating a {Wx::Icon} structure are catered for, and this is an occasion where conditional compilation will probably be required. Note that a new icon must be created for every time the icon is to be used for a new window. In Windows, the icon will not be reloaded if it has already been used. An icon allocated to a frame will be deleted when the frame is deleted. For more information please see Bitmaps and Icons.
+  # </p>
+  # </div>
   # 
   # Category:  Graphics Device Interface (GDI)
   # Predefined objects/pointers: {Wx::NULL_ICON}
@@ -38,6 +42,7 @@ 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 [Wx::Icon]
     # @overload initialize(icon)
@@ -47,6 +52,7 @@ module Wx
     # @overload initialize(name, type=Wx::ICON_DEFAULT_TYPE, desiredWidth=-1, desiredHeight=-1)
     #   Loads an icon from a file or resource.
     #   
+    #   
     #   @see Wx::Icon#load_file 
     #   @param name [String]  This can refer to a resource name or a filename under MS Windows and X. Its meaning is determined by the type parameter.
     #   @param type [Wx::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.
@@ -59,16 +65,8 @@ module Wx
     #   @return [Wx::Icon]
     def initialize(*args) end
     
-    # Attach a Windows icon handle.
-    # 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 wxMSW port.  {Wx::msw}
-    # @param icon [WXHICON] 
-    # @return [Boolean]
-    def create_from_hicon(icon) end
-    
     # Copies bmp bitmap to this icon.
+    # 
     # Under MS Windows the bitmap must have mask colour set.
     # @see Wx::Icon#load_file 
     # @param bmp [Wx::Bitmap] 
@@ -76,6 +74,7 @@ module Wx
     def copy_from_bitmap(bmp) end
     
     # Gets the colour depth of the icon.
+    # 
     # A value of 1 indicates a monochrome icon.
     # @return [Integer]
     def get_depth; end
@@ -83,6 +82,7 @@ module Wx
     
     # Gets the height of the icon in physical pixels.
     # 
+    # 
     # @see Wx::Icon#get_width
     # @see  Wx::Icon#get_logical_height 
     # @return [Integer]
@@ -90,24 +90,28 @@ module Wx
     alias_method :height, :get_height
     
     # Gets the height of the icon in logical pixels.
+    # 
     # See {Wx::Bitmap#get_logical_height}.
     # @return [Float]
     def get_logical_height; end
     alias_method :logical_height, :get_logical_height
     
     # Gets the size of the icon in logical pixels.
+    # 
     # See {Wx::Bitmap#get_logical_size}.
     # @return [Wx::Size]
     def get_logical_size; end
     alias_method :logical_size, :get_logical_size
     
     # Gets the width of the icon in logical pixels.
+    # 
     # See {Wx::Bitmap#get_logical_width}.
     # @return [Float]
     def get_logical_width; end
     alias_method :logical_width, :get_logical_width
     
     # Gets the scale factor of this icon.
+    # 
     # See {Wx::Bitmap#get_scale_factor}.
     # @return [Float]
     def get_scale_factor; end
@@ -115,6 +119,7 @@ module Wx
     
     # Gets the size of the icon in physical pixels.
     # 
+    # 
     # @see Wx::Icon#get_logical_size 
     # @return [Wx::Size]
     def get_size; end
@@ -122,6 +127,7 @@ module Wx
     
     # Gets the width of the icon in physical pixels.
     # 
+    # 
     # @see Wx::Icon#get_height
     # @see  Wx::Icon#get_logical_width 
     # @return [Integer]
@@ -134,6 +140,7 @@ module Wx
     alias_method :ok?, :is_ok
     
     # Loads an icon from a file or resource.
+    # 
     # true if the operation succeeded, false otherwise.
     # @param name [String]  Either a filename or a Windows resource name. The meaning of name is determined by the type parameter.
     # @param type [Wx::BitmapType]  One of the {Wx::BitmapType} values; 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.
@@ -145,8 +152,8 @@ module Wx
   end # Icon
   
   # This class contains multiple copies of an icon in different sizes.
+  # 
   # It is typically used in {Wx::Dialog#set_icons} and {Wx::TopLevelWindow#set_icons}.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # Predefined objects/pointers: {Wx::NULL_ICON_BUNDLE}
@@ -177,6 +184,7 @@ module Wx
     #   @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 [Wx::BitmapType] 
@@ -185,16 +193,6 @@ module Wx
     #   Initializes the bundle with a single icon.
     #   @param icon [Wx::Icon] 
     #   @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 wxMSW port.  {Wx::msw}
-    #   @see AddIcon(const wxString&
-    #   @see  WXHINSTANCE)
-    #   @param resourceName [String] 
-    #   @param module_ [WXHINSTANCE] 
-    #   @return [Wx::IconBundle]
     # @overload initialize(ic)
     #   Copy constructor.
     #   @param ic [Wx::IconBundle] 
@@ -208,17 +206,11 @@ module Wx
     #   @return [void]
     # @overload add_icon(stream, type=Wx::BitmapType::BITMAP_TYPE_ANY)
     #   Adds all the icons contained in the stream to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
+    #   
     #   Notice that, as well as in the constructor loading the icon bundle from stream, the stream must be seekable, at least if more than one icon is to be loaded from it.
     #   @param stream [IO,Wx::InputStream] 
     #   @param type [Wx::BitmapType] 
     #   @return [void]
-    # @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 wxMSW port.  {Wx::msw}
-    #   @param resourceName [String] 
-    #   @param module_ [WXHINSTANCE] 
-    #   @return [void]
     # @overload add_icon(icon)
     #   Adds the icon to the collection; if the collection already contains an icon with the same width and height, it is replaced by the new one.
     #   @param icon [Wx::Icon] 
@@ -227,6 +219,7 @@ module Wx
     
     # @overload get_icon(size, flags=Wx::IconBundle::FALLBACK_SYSTEM)
     #   Returns the icon with the given size.
+    #   
     #   If size is {Wx::DEFAULT_SIZE}, it is interpreted as the standard system icon size, i.e. the size returned by {Wx::SystemSettings.get_metric} for {Wx::SystemMetric::SYS_ICON_X} and {Wx::SystemMetric::SYS_ICON_Y}.
     #   If the bundle contains an icon with exactly the requested size, it's always returned. Otherwise, the behaviour depends on the flags. If only {Wx::IconBundle::FALLBACK_NONE} is given, the function returns an invalid icon. If {Wx::IconBundle::FALLBACK_SYSTEM} is given, it tries to find the icon of standard system size, regardless of the size passed as parameter. Otherwise, or if the icon system size is not found either, but {Wx::IconBundle::FALLBACK_NEAREST_LARGER} flag is specified, the function returns the smallest icon of the size larger than the requested one or, if this fails too, just the icon closest to the specified size.
     #   The flags parameter is available only since wxWidgets 2.9.4.
@@ -235,6 +228,7 @@ module Wx
     #   @return [Wx::Icon]
     # @overload get_icon(size=Wx::DEFAULT_COORD, flags=Wx::IconBundle::FALLBACK_SYSTEM)
     #   Same as.
+    #   
     #   ```
     #     GetIcon( wxSize( size, size ) ) 
     #   ```

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

@@ -7,9 +7,9 @@
 module Wx
 
   # {Wx::IconLocation} is a tiny class describing the location of an (external, i.e.
+  # 
   # not embedded into the application resources) icon. For most platforms it simply contains the file name but under some others (notably Windows) the same file may contain multiple icons and so this class also stores the index of the icon inside the file.
   # In any case, its details should be of no interest to the application code and most of them are not even documented here (on purpose) as it is only meant to be used as an opaque class: the application may get the object of this class from somewhere and the only reasonable thing to do with it later is to create a {Wx::Icon} from it.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # @see Wx::Icon