wxruby3 0.9.0-x64-mingw-ucrt → 0.9.2-x64-mingw-ucrt

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

@@ -19,8 +19,6 @@ module Wx
   # the cursor for a window, as in X, rather than to set it globally as in MS Windows, although a global 
   # {set_cursor} function is also available for MS Windows use.
   # 
-  # === 
-  # 
   # Category:  Graphics Device Interface (GDI)
   # Predefined objects/pointers:
   # - {Wx::NULL_CURSOR}
@@ -42,9 +40,9 @@ module Wx
     #   @return [Wx::Cursor]
     # @overload initialize(cursorName, type=Wx::CURSOR_DEFAULT_TYPE, hotSpotX=0, hotSpotY=0)
     #   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).
+    #   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 [Wx::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.
@@ -61,9 +59,9 @@ module Wx
     # @overload initialize(image)
     #   Constructs a cursor from a {Wx::Image}.
     #   If cursor are monochrome on the current platform, colors with the RGB elements all greater than 127 will be foreground, colors less than this background. The mask (if any) will be used to specify the transparent area.
-    #   In wxMSW the foreground will be white and the background black. If the cursor is larger than 32x32 it is resized.
-    #   In wxGTK, colour cursors and alpha channel are supported (starting from GTK+ 2.2). Otherwise the two most frequent colors will be used for foreground and background. In any case, the cursor will be displayed at the size of the image.
-    #   Under {Wx::Mac} (Cocoa), large cursors are supported.
+    #   In WXMSW the foreground will be white and the background black. If the cursor is larger than 32x32 it is resized.
+    #   In WXGTK, colour cursors and alpha channel are supported (starting from GTK+ 2.2). Otherwise the two most frequent colors will be used for foreground and background. In any case, the cursor will be displayed at the size of the image.
+    #   Under WXOSX (Cocoa), large cursors are supported.
     #   Notice that the image can define the cursor hot spot. To set it you need to use {Wx::Image#set_option} with {Wx::IMAGE_OPTION_CUR_HOTSPOT_X} or {Wx::IMAGE_OPTION_CUR_HOTSPOT_Y}, e.g. 
     #   ```ruby
     #     image.set_option(Wx::IMAGE_OPTION_CUR_HOTSPOT_X, hotSpotX)
@@ -84,7 +82,7 @@ module Wx
     
     # Returns the coordinates of the cursor hot spot.
     # The hot spot is the point at which the mouse is actually considered to be when this cursor is used.
-    # This method is currently only implemented in wxMSW and wxGTK2+ and simply returns {Wx::DEFAULT_POSITION} in the other ports.
+    # This method is currently only implemented in WXMSW and WXGTK2+ and simply returns {Wx::DEFAULT_POSITION} in the other ports.
     # @return [Wx::Point]
     def get_hot_spot; end
     alias_method :hot_spot, :get_hot_spot

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

@@ -36,7 +36,6 @@ module Wx
   # 
   # As mentioned above, these standard formats may be passed to any function taking {Wx::DataFormat} argument because {Wx::DataFormat} has an implicit conversion from them (or, to be precise from the type {Wx::DataFormat::NativeFormat} which is the type used by the underlying platform for data formats).
   # Aside the standard formats, the application may also use custom formats which are identified by their names (strings) and not numeric identifiers. Although internally custom format must be created (or registered) first, you shouldn't care about it because it is done automatically the first time the {Wx::DataFormat} object corresponding to a given format name is created. The only implication of this is that you should avoid having global {Wx::DataFormat} objects with non-default constructor because their constructors are executed before the program has time to perform all necessary initialisations and so an attempt to do clipboard format registration at this time will usually lead to a crash!
-  # === 
   # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
@@ -44,6 +43,7 @@ module Wx
   # @see  Wx::DataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class DataFormat < ::Object
   
     # @overload initialize(format=Wx::DataFormatId::DF_INVALID)
@@ -61,6 +61,11 @@ module Wx
     def get_id; end
     alias_method :id, :get_id
     
+    # Returns the platform-specific number identifying the format.
+    # @return [Wx::DataFormatId]
+    def get_type; end
+    alias_method :type, :get_type
+    
     # Sets the format to be the custom format identified by the given name.
     # @param format [String] 
     # @return [void]

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

@@ -36,8 +36,6 @@ module Wx
   # You may also derive your own data object classes from {Wx::CustomDataObject} for user-defined types. The format of user-defined data is given as a mime-type string literal, such as "application/word" or "image/png". These strings are used as they are under Unix (so far only GTK+) to identify a format and are translated into their Windows equivalent under Win32 (using the OLE IDataObject for data exchange to and from the clipboard and for drag and drop). Note that the format string translation under Windows is not yet finished.
   # Each class derived directly from {Wx::DataObject} must override and implement all of its functions which are pure virtual in the base class. The data objects which only render their data or only set it (i.e. work in only one direction), should return 0 from {Wx::DataObject#get_format_count}.
   # 
-  # === 
-  # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
   # @see  Drag & Drop Sample
@@ -51,12 +49,14 @@ module Wx
   # @see  Wx::FileDropTarget 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class DataObject < ::Object
   
     # 
     # 
     # 
     # 
+    # @wxrb_require USE_CLIPBOARD
     class Direction < Wx::Enum
     
       # Format is supported by {Wx::DataObject#get_data_here}
@@ -122,6 +122,7 @@ module Wx
     
   end # DataObject
   
+  # @wxrb_require USE_CLIPBOARD
   class DataObjectSimple < DataObject
   
     # Constructor accepts the supported format (none by default) which may also be set later with {Wx::DataObjectSimple#set_format}.
@@ -180,8 +181,6 @@ module Wx
   #   end
   # ```
   # 
-  # === 
-  # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
   # @see  Wx::DataObject
@@ -191,6 +190,7 @@ module Wx
   # @see  Wx::BitmapDataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class DataObjectComposite < DataObject
   
     # The default constructor.
@@ -214,7 +214,7 @@ module Wx
     # @param format [Wx::DataFormat] 
     # @param dir [Wx::wxDataObject::Direction] 
     # @return [Wx::DataObjectSimple]
-    def get_object(format, dir=Wx::DataObject::Get) end
+    def get_object(format, dir=DataObject::Get) end
     alias_method :object, :get_object
     
   end # DataObjectComposite
@@ -222,7 +222,6 @@ module Wx
   # {Wx::BitmapDataObject} is a specialization of {Wx::DataObject} for bitmap data.
   # It can be used without change to paste data into the {Wx::Clipboard} or a {Wx::DropSource}. A user may wish to derive a new class from this class for providing a bitmap on-demand in order to minimize memory consumption when offering data in several formats, such as a bitmap and GIF.
   # This class may be used as is, but {Wx::BitmapDataObject#get_bitmap} may be overridden to increase efficiency.
-  # === 
   # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
@@ -233,6 +232,7 @@ module Wx
   # @see  Wx::DataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class BitmapDataObject < DataObjectSimple
   
     # Constructor, optionally passing a bitmap (otherwise use {Wx::BitmapDataObject#set_bitmap} later).
@@ -257,7 +257,6 @@ module Wx
   
   # {Wx::FileDataObject} is a specialization of {Wx::DataObject} for file names.
   # The program works with it just as if it were a list of absolute file names, but internally it uses the same format as Explorer and other compatible programs under Windows or GNOME/KDE file manager under Unix which makes it possible to receive files from them using this class.
-  # === 
   # 
   # Category:  Clipboard and Drag & Drop
   # @see Wx::DataObject
@@ -267,6 +266,7 @@ module Wx
   # @see  Wx::DataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class FileDataObject < DataObjectSimple
   
     # Constructor.
@@ -288,7 +288,6 @@ module Wx
   # {Wx::TextDataObject} is a specialization of {Wx::DataObjectSimple} for text data.
   # It can be used without change to paste data into the {Wx::Clipboard} or a {Wx::DropSource}. A user may wish to derive a new class from this class for providing text on-demand in order to minimize memory consumption when offering data in several formats, such as plain text and RTF because by default the text is stored in a string in this class, but it might as well be generated when requested. For this, {Wx::TextDataObject#get_text_length} and {Wx::TextDataObject#get_text} will have to be overridden.
   # Note that if you already have the text inside a string, you will not achieve any efficiency gain by overriding these functions because copying {Wx::Strings} is already a very efficient operation (data is not actually copied because {Wx::Strings} are reference counted).
-  # === 
   # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
@@ -298,6 +297,7 @@ module Wx
   # @see  Wx::BitmapDataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class TextDataObject < DataObjectSimple
   
     # Constructor, may be used to initialise the text (otherwise {Wx::TextDataObject#set_text} should be used later).
@@ -330,12 +330,12 @@ module Wx
   # The only restriction is that it is supposed that this data can be copied bitwise (i.e. with <code>memcpy()</code>), so it would be a bad idea to make it contain a C++ object (though C struct is fine).
   # By default, {Wx::CustomDataObject} stores the data inside in a buffer. To put the data into the buffer you may use either {Wx::CustomDataObject#set_data} or {Wx::CustomDataObject#take_data} depending on whether you want the object to make a copy of data or not.
   # This class may be used as is, but if you don't want store the data inside the object but provide it on demand instead, you should override {Wx::CustomDataObject#get_size}, {Wx::CustomDataObject#get_data} and {Wx::CustomDataObject#set_data} (or may be only the first two or only the last one if you only allow reading/writing the data).
-  # === 
   # 
   # Category:  Clipboard and Drag & Drop
   # @see Wx::DataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class CustomDataObject < DataObjectSimple
   
     # The constructor accepts a format argument which specifies the (single) format supported by this object.
@@ -349,8 +349,6 @@ module Wx
   # {Wx::ImageDataObject} is a specialization of {Wx::DataObject} for image data.
   # It can be used e.g. when you need to put on and retrieve from the clipboard a {Wx::Image} with its metadata (like image resolution).
   # 
-  # === 
-  # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
   # @see  Wx::DataObject
@@ -358,6 +356,7 @@ module Wx
   # @see  Wx::BitmapDataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class ImageDataObject < CustomDataObject
   
     # Constructor, optionally passing an image (otherwise use {Wx::ImageDataObject#set_image} later).
@@ -385,15 +384,18 @@ module Wx
   #   Wx::Clipboard.open { |clip| clip.place(Wx::URLDataObject.new(url))
   # ```
   # 
-  # The actual base class of this class is not always {Wx::DataObject} itself, but rather either {Wx::DataObjectComposite} in wxMSW and wxGTK or {Wx::TextDataObject} in the other ports. Please don't rely on the exact base class, it is not guaranteed that it won't change in the future.
-  # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>The actual base class of this class is not always {Wx::DataObject} itself, but rather either {Wx::DataObjectComposite} in WXMSW and WXGTK or {Wx::TextDataObject} in the other ports. Please don't rely on the exact base class, it is not guaranteed that it won't change in the future.
+  # </p>
+  # </div>
   # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
   # @see  Wx::DataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class URLDataObject < DataObject
   
     # Constructor, may be used to initialize the URL.

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

@@ -16,10 +16,10 @@ module Wx
   
   # This event class holds information about a date change and is used together with {Wx::DatePickerCtrl}.
   # It also serves as a base class for {Wx::CalendarEvent}.
-  # === 
   # 
   # Category:  {Wx::Events}
   # 
+  # @wxrb_require USE_DATETIME
   class DateEvent < CommandEvent
   
     # @overload initialize()
@@ -27,7 +27,7 @@ module Wx
     # @overload initialize(win, dt, type)
     #   @param win [Wx::Window] 
     #   @param dt [Time,Date,DateTime] 
-    #   @param type [Wx::CommandLinkButton::EventType] 
+    #   @param type [Wx::Slider::EventType] 
     #   @return [Wx::DateEvent]
     def initialize(*args) end
     

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

@@ -29,7 +29,7 @@ module Wx
   # This control allows the user to select a date.
   # Unlike {Wx::CalendarCtrl}, which is a relatively big control, {Wx::DatePickerCtrl} is implemented as a small window showing the currently selected date. The control can be edited using the keyboard, and can also display a popup window for more user-friendly date selection, depending on the styles used and the platform.
   # It is only available if {Wx::Setup::USE_DATEPICKCTRL} is set to 1.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -44,30 +44,29 @@ module Wx
   # - {Wx::DP_SHOWCENTURY}: Forces display of the century in the default date format. Without this style the century could be displayed, or not, depending on the default date representation in the system. This style is not supported in OSX/Cocoa native version currently. 
   # 
   # As can be seen from the remarks above, most of the control style are only supported in the native MSW implementation. In portable code it's recommended to use {Wx::DP_DEFAULT} style only, possibly combined with {Wx::DP_SHOWCENTURY} (this is also the style used by default if none is specified).
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DateEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_date_changed}(id, meth = nil, &block): Process a {Wx::EVT_DATE_CHANGED} event, which fires when the user changes the current selection in the control. 
   # 
-  # === 
-  # 
-  # Category:  Picker Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  Picker 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::TimePickerCtrl
   # @see  Wx::CalendarCtrl
   # @see  Wx::DateEvent 
   # 
   # 
+  # @wxrb_require USE_DATEPICKCTRL
   class DatePickerCtrl < Control
   
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::DatePickerCtrl]
-    # @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"))
+    # @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] 
@@ -93,7 +92,7 @@ module Wx
     # @param validator [Wx::Validator]  Validator which can be used for additional data checks.
     # @param name [String]  Control name.
     # @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
+    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.
@@ -112,7 +111,12 @@ module Wx
     # Sets the valid range for the date selection.
     # If dt1 is valid, it becomes the earliest date (inclusive) accepted by the control. If dt2 is valid, it becomes the latest possible date.
     # Notice that if the current value is not inside the new range, it will be adjusted to lie inside it, i.e. calling this method can change the control value, however no events are generated by it.
-    # If the current value of the control is outside of the newly set range bounds, the behaviour is undefined.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If the current value of the control is outside of the newly set range bounds, the behaviour is undefined. 
+    # </p>
+    # </div>>
     # @param dt1 [Time,Date,DateTime] 
     # @param dt2 [Time,Date,DateTime] 
     # @return [void]