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

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

@@ -11,6 +11,7 @@ module Wx
   FORMAT_INVALID = nil
   
   # A {Wx::DataObject} represents data that can be copied to or from the clipboard, or dragged and dropped.
+  # 
   # The important thing about {Wx::DataObject} is that this is a 'smart' piece of data unlike 'dumb' data containers such as memory buffers or files. Being 'smart' here means that the data object itself should know what data formats it supports and how to render itself in each of its supported formats.
   # A supported format, incidentally, is exactly the format in which the data can be requested from a data object or from which the data object may be set. In the general case, an object may support different formats on 'input' and 'output', i.e. it may be able to render itself in a given format but not be created from data on this format or vice versa. {Wx::DataObject} defines the {Wx::DataObject::Direction} enumeration type which distinguishes between them.
   # See {Wx::DataFormat} documentation for more about formats.
@@ -36,8 +37,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 +50,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}
@@ -78,13 +79,15 @@ module Wx
     def initialize; end
     
     # Copies all formats supported in the given direction dir to the array pointed to by formats.
+    # 
     # There must be enough space for GetFormatCount(dir) formats in it.
-    # @param dir [Wx::wxDataObject::Direction] 
+    # @param dir [Wx::DataObject::Direction] 
     # @return [Array<Wx::DataFormat>]
     def get_all_formats(dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
     alias_method :all_formats, :get_all_formats
     
     # The method will write the data of the format format to the buffer buf.
+    # 
     # In other words, copy the data from this object in the given format to the supplied buffer. Returns true on success, false on failure.
     # @param format [Wx::DataFormat] 
     # @return [String]
@@ -92,19 +95,21 @@ module Wx
     alias_method :data_here, :get_data_here
     
     # Returns the number of available formats for rendering or setting the data.
-    # @param dir [Wx::wxDataObject::Direction] 
+    # @param dir [Wx::DataObject::Direction] 
     # @return [Integer]
     def get_format_count(dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
     alias_method :format_count, :get_format_count
     
     # Returns the preferred format for either rendering the data (if dir is Get, its default value) or for setting it.
+    # 
     # Usually this will be the native format of the {Wx::DataObject}.
-    # @param dir [Wx::wxDataObject::Direction] 
+    # @param dir [Wx::DataObject::Direction] 
     # @return [Wx::DataFormat]
     def get_preferred_format(dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
     alias_method :preferred_format, :get_preferred_format
     
     # Set the data in the format format of the length len provided in the buffer buf.
+    # 
     # In other words, copy length bytes of data from the buffer to this data object.
     # 
     # true on success, false on failure.
@@ -115,13 +120,14 @@ module Wx
     
     # Returns true if this format is supported.
     # @param format [Wx::DataFormat] 
-    # @param dir [Wx::wxDataObject::Direction] 
+    # @param dir [Wx::DataObject::Direction] 
     # @return [Boolean]
     def is_supported(format, dir=Wx::RTC::RichTextBufferDataObject::Direction::Get) end
     alias_method :supported?, :is_supported
     
   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}.
@@ -130,6 +136,7 @@ module Wx
     def initialize(format=Wx::FORMAT_INVALID) end
     
     # Returns the (one and only one) format supported by this object.
+    # 
     # It is assumed that the format is supported in both directions.
     # @return [Wx::DataFormat]
     def get_format; end
@@ -138,6 +145,7 @@ module Wx
   end # DataObjectSimple
   
   # {Wx::DataObjectComposite} is the simplest {Wx::DataObject} derivation which may be used to support multiple formats.
+  # 
   # It contains several {Wx::DataObjectSimple} objects and supports any format supported by at least one of them. Only one of these data objects is preferred (the first one if not explicitly changed by using the second parameter of {Wx::DataObjectComposite#add}) and its format determines the preferred format of the composite data object as well.
   # See {Wx::DataObject} documentation for the reasons why you might prefer to use {Wx::DataObject} directly instead of {Wx::DataObjectComposite} for efficiency reasons.
   # This example shows how a composite data object capable of storing either bitmaps or file names (presumably of bitmap files) can be initialized and used:
@@ -180,8 +188,6 @@ module Wx
   #   end
   # ```
   # 
-  # === 
-  # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
   # @see  Wx::DataObject
@@ -191,6 +197,7 @@ module Wx
   # @see  Wx::BitmapDataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class DataObjectComposite < DataObject
   
     # The default constructor.
@@ -204,15 +211,17 @@ module Wx
     def add(dataObject, preferred=false) end
     
     # Report the format passed to the {Wx::DataObjectComposite#set_data} method.
+    # 
     # This should be the format of the data object within the composite that received data from the clipboard or the DnD operation. You can use this method to find out what kind of data object was received.
     # @return [Wx::DataFormat]
     def get_received_format; end
     alias_method :received_format, :get_received_format
     
     # Returns the pointer to the object which supports the passed format for the specified direction.
+    # 
     # NULL is returned if the specified format is not supported for this direction dir. The returned pointer is owned by {Wx::DataObjectComposite} itself and shouldn't be deleted by caller.
     # @param format [Wx::DataFormat] 
-    # @param dir [Wx::wxDataObject::Direction] 
+    # @param dir [Wx::DataObject::Direction] 
     # @return [Wx::DataObjectSimple]
     def get_object(format, dir=DataObject::Get) end
     alias_method :object, :get_object
@@ -220,9 +229,9 @@ module Wx
   end # DataObjectComposite
   
   # {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 +242,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).
@@ -241,12 +251,14 @@ module Wx
     def initialize(bitmap=Wx::NULL_BITMAP) end
     
     # Returns the bitmap associated with the data object.
+    # 
     # You may wish to override this method when offering data on-demand, but this is not required by wxWidgets' internals. Use this method to get data in bitmap form from the {Wx::Clipboard}.
     # @return [Wx::Bitmap]
     def get_bitmap; end
     alias_method :bitmap, :get_bitmap
     
     # Sets the bitmap associated with the data object.
+    # 
     # This method is called when the data object receives data. Usually there will be no reason to override this function.
     # @param bitmap [Wx::Bitmap] 
     # @return [void]
@@ -256,8 +268,8 @@ module Wx
   end # BitmapDataObject
   
   # {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 +279,7 @@ module Wx
   # @see  Wx::DataObject 
   # 
   # 
+  # @wxrb_require USE_CLIPBOARD
   class FileDataObject < DataObjectSimple
   
     # Constructor.
@@ -286,9 +299,9 @@ module Wx
   end # FileDataObject
   
   # {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 +311,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).
@@ -306,18 +320,21 @@ module Wx
     def initialize(text=('')) end
     
     # Returns the text associated with the data object.
+    # 
     # You may wish to override this method when offering data on-demand, but this is not required by wxWidgets' internals. Use this method to get data in text form from the {Wx::Clipboard}.
     # @return [String]
     def get_text; end
     alias_method :text, :get_text
     
     # Returns the data size.
+    # 
     # By default, returns the size of the text data set in the constructor or using {Wx::TextDataObject#set_text}. This can be overridden to provide text size data on-demand. It is recommended to return the text length plus 1 for a trailing zero, but this is not strictly required.
     # @return [Integer]
     def get_text_length; end
     alias_method :text_length, :get_text_length
     
     # Sets the text associated with the data object.
+    # 
     # This method is called when the data object receives the data and, by default, copies the text into the member variable. If you want to process the text on the fly you may wish to override this function.
     # @param strText [String] 
     # @return [void]
@@ -327,18 +344,20 @@ module Wx
   end # TextDataObject
   
   # {Wx::CustomDataObject} is a specialization of {Wx::DataObjectSimple} for some application-specific data in arbitrary (either custom or one of the standard ones).
+  # 
   # 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.
+    # 
     # If it isn't set here, {Wx::DataObjectSimple#set_format} should be used.
     # @param format [Wx::DataFormat] 
     # @return [Wx::CustomDataObject]
@@ -347,9 +366,8 @@ module Wx
   end # CustomDataObject
   
   # {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).
   # 
-  # === 
+  # 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
@@ -358,6 +376,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).
@@ -379,24 +398,29 @@ module Wx
   end # ImageDataObject
   
   # {Wx::URLDataObject} is a {Wx::DataObject} containing an URL and can be used e.g.
+  # 
   # when you need to put an URL on or retrieve it from the clipboard:
   # 
   # ```ruby
   #   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.
+    # 
     # If url is empty, {Wx::URLDataObject#set_url} can be used later.
     # @param url [String] 
     # @return [Wx::URLDataObject]

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

@@ -15,11 +15,12 @@ module Wx
   EVT_TIME_CHANGED = 10077
   
   # 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 +28,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::StaticLine::EventType] 
     #   @return [Wx::DateEvent]
     def initialize(*args) end
     

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

@@ -27,9 +27,10 @@ module Wx
   DP_ALLOWNONE = 8
   
   # 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,24 +45,23 @@ 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()
@@ -81,6 +81,7 @@ module Wx
     def initialize(*args) end
     
     # Create the control window.
+    # 
     # This method should only be used for objects created using default constructor.
     # 
     # true if the control was successfully created or false if creation failed.
@@ -96,12 +97,14 @@ module Wx
     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.
     # @return [Time,Date,DateTime]
     def get_value; end
     alias_method :value, :get_value
     
     # Set the text to show when there is no valid value.
+    # 
     # For the controls with {Wx::DP_ALLOWNONE} style, set the string displayed when the control doesn't have any valid value. Currently this is only actually used under MSW, where it can be used to override the previous value which is still displayed by the control in this case, and ignored elsewhere.
     # Notably, text can be empty to completely hide the date if no valid date is specified.
     # @param text [String] 
@@ -110,15 +113,22 @@ module Wx
     alias_method :null_text=, :set_null_text
     
     # 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]
     def set_range(dt1, dt2) end
     
     # Changes the current value of the control.
+    # 
     # The date should be valid unless the control was created with {Wx::DP_ALLOWNONE} style and included in the currently selected range, if any.
     # Calling this method does not result in a date change event.
     # @param dt [Time,Date,DateTime]