wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

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

@@ -0,0 +1,127 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  NULL_CURSOR = nil
+  
+  # A cursor is a small bitmap usually used for denoting where the mouse pointer is, with a picture that might indicate the interpretation of a mouse click.
+  # As with icons, cursors in X and MS Windows are created in a different manner. Therefore, separate cursors will be created for the different environments. Platform-specific methods for creating a {Wx::Cursor} object are catered for, and this is an occasion where conditional compilation will probably be required (see {Wx::Icon} for an example).
+  # A single cursor object may be used in many windows (any subwindow type). The wxWidgets convention is to set 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.
+  # 
+  # == Creating a Custom Cursor
+  # 
+  # The following is an example of creating a cursor from 32x32 bitmap data (down_bits) and a mask (down_mask) where 1 is black and 0 is white for the bits, and 1 is opaque and 0 is transparent for the mask. It works on Windows and GTK+.
+  # 
+  #   static char down_bits[] = { 255, 255, 255, 255, 31,
+  #       255, 255, 255, 31, 255, 255, 255, 31, 255, 255, 255,
+  #       31, 255, 255, 255, 31, 255, 255, 255, 31, 255, 255,
+  #       255, 31, 255, 255, 255, 31, 255, 255, 255, 25, 243,
+  #       255, 255, 19, 249, 255, 255, 7, 252, 255, 255, 15, 254,
+  #       255, 255, 31, 255, 255, 255, 191, 255, 255, 255, 255,
+  #       255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  #       255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  #       255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  #       255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  #       255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  #       255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+  #       255 };
+  #   
+  #   static char down_mask[] = { 240, 1, 0, 0, 240, 1,
+  #       0, 0, 240, 1, 0, 0, 240, 1, 0, 0, 240, 1, 0, 0, 240, 1,
+  #       0, 0, 240, 1, 0, 0, 240, 1, 0, 0, 255, 31, 0, 0, 255,
+  #       31, 0, 0, 254, 15, 0, 0, 252, 7, 0, 0, 248, 3, 0, 0,
+  #       240, 1, 0, 0, 224, 0, 0, 0, 64, 0, 0, 0, 0, 0, 0, 0, 0,
+  #       0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  #       0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  #       0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  #       0, 0, 0, 0, 0 };
+  #   
+  #   #ifdef __WXMSW__
+  #       wxBitmap down_bitmap(down_bits, 32, 32);
+  #       wxBitmap down_mask_bitmap(down_mask, 32, 32);
+  #   
+  #       down_bitmap.SetMask(new wxMask(down_mask_bitmap));
+  #       wxImage down_image = down_bitmap.ConvertToImage();
+  #       down_image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, 6);
+  #       down_image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, 14);
+  #       wxCursor down_cursor = wxCursor(down_image);
+  #   #elif defined(__WXGTK__) or defined(__WXMOTIF__)
+  #       wxCursor down_cursor = wxCursor(down_bits, 32, 32, 6, 14,
+  #                                       down_mask, wxWHITE, wxBLACK);
+  #   #endif
+  # 
+  # === 
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # Predefined objects/pointers:
+  # - {Wx::NULL_CURSOR}- {Wx::STANDARD_CURSOR}- {Wx::HOURGLASS_CURSOR}- {Wx::CROSS_CURSOR}
+  # @see Wx::Bitmap
+  # @see  Wx::Icon
+  # @see  Wx::Window#set_cursor
+  # @see  set_cursor
+  # @see  Wx::StockCursor 
+  # 
+  # 
+  class Cursor < GDIObject
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [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 {Wx::MSW} or {Wx::BitmapType::BITMAP_TYPE_XPM} under {Wx::GTK}).
+    #   @param cursorName [String]  The name of the resource or the image file to load.
+    #   @param type [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.- under GTK, it defaults to {Wx::BitmapType::BITMAP_TYPE_XPM}. See the wxCursor(const wxImage& image) ctor for more info.- under X11, it defaults to {Wx::BitmapType::BITMAP_TYPE_XPM}.- under Motif, it defaults to {Wx::BitmapType::BITMAP_TYPE_XBM}.
+    #   @param hotSpotX [Integer]  Hotspot x coordinate (relative to the top left of the image).
+    #   @param hotSpotY [Integer]  Hotspot y coordinate (relative to the top left of the image).
+    #   @return [Cursor]
+    # @overload initialize(cursorId)
+    #   Constructs a cursor using a cursor identifier.
+    #   @param cursorId [StockCursor]  A stock cursor identifier. See {Wx::StockCursor}.
+    #   @return [Cursor]
+    # @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 {Wx::MSW} the foreground will be white and the background black. If the cursor is larger than 32x32 it is resized.
+    #   In {Wx::GTK}, 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.
+    #   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. 
+    #   
+    #     image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotSpotX);
+    #     image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotSpotY);
+    #   @param image [Wx::Image] 
+    #   @return [Cursor]
+    # @overload initialize(xpmData)
+    #   Constructs a cursor from XPM data.
+    #   In versions of wxWidgets until 3.1.6 constructing {Wx::Cursor} from XPM data implicitly used {Wx::Image} constructor from XPM data and {Wx::Cursor} constructor from {Wx::Image}. Since 3.1.6 this constructor overload is available to allow constructing {Wx::Cursor} from XPM to still work, even though {Wx::Image} constructor from XPM is now explicit.
+    #   @param xpmData [char] 
+    #   @return [Cursor]
+    # @overload initialize(cursor)
+    #   Copy constructor, uses reference counting.
+    #   @param cursor [Wx::Cursor]  Pointer or reference to a cursor to copy.
+    #   @return [Cursor]
+    def initialize(*args) end
+    
+    # Returns true if cursor data is present.
+    # @return [true,false]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # 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 {Wx::MSW} and {Wx::GTK2}+ 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
+    
+  end # Cursor
+  
+
+end

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

@@ -0,0 +1,94 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A {Wx::DataFormat} is an encapsulation of a platform-specific format handle which is used by the system for the clipboard and drag and drop operations.
+  # The applications are usually only interested in, for example, pasting data from the clipboard only if the data is in a format the program understands and a data format is something which uniquely identifies this format.
+  # On the system level, a data format is usually just a number (CLIPFORMAT under Windows or Atom under X11, for example) and the standard formats are, indeed, just numbers which can be implicitly converted to {Wx::DataFormat}. The standard formats are:
+  # 
+  # {Wx::DataFormatId::DF_INVALID} 
+  # An invalid format - used as default argument for functions taking a {Wx::DataFormat} argument sometimes. 
+  # 
+  # {Wx::DF_TEXT} 
+  # Text format ({Wx::String}). 
+  # 
+  # {Wx::DF_BITMAP} 
+  # A bitmap ({Wx::Bitmap}). 
+  # 
+  # {Wx::DF_METAFILE} 
+  # A metafile ({Wx::Metafile}, Windows only). 
+  # 
+  # {Wx::DF_UNICODETEXT} 
+  # Unicode text format ({Wx::String}). 
+  # 
+  # {Wx::DF_FILENAME} 
+  # A list of filenames. 
+  # 
+  # {Wx::DataFormatId::DF_HTML} 
+  # An HTML string. This is currently only valid on Mac and MSW. 
+  # 
+  # {Wx::DataFormatId::DF_PNG} 
+  # A PNG file. This is valid only on MSW. This constant is available since wxWidgets 3.1.5. 
+  # 
+  # 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
+  # @see  Drag & Drop Sample
+  # @see  Wx::DataObject 
+  # 
+  # 
+  class DataFormat < ::Object
+  
+    # @overload initialize(format=Wx::DF_INVALID)
+    #   Constructs a data format object for one of the standard data formats or an empty data object (use {Wx::DataFormat#set_type} or {Wx::DataFormat#set_id} later in this case).
+    #   <b>{Wx::Perl} Note:</b> In {Wx::Perl} use Wx::Bitmap->newNative(format).
+    #   @param format [DataFormatId] 
+    #   @return [DataFormat]
+    # @overload initialize(format)
+    #   Constructs a data format object for a custom format identified by its name format.
+    #   <b>{Wx::Perl} Note:</b> In {Wx::Perl} use Wx::Bitmap->newUser(format).
+    #   @param format [String] 
+    #   @return [DataFormat]
+    def initialize(*args) end
+    
+    # Returns the name of a custom format (this function will fail for a standard format).
+    # @return [String]
+    def get_id; end
+    alias_method :id, :get_id
+    
+    # Sets the format to be the custom format identified by the given name.
+    # @param format [String] 
+    # @return [void]
+    def set_id(format) end
+    alias_method :id=, :set_id
+    
+    # Sets the format to the given value, which should be one of {Wx::DF_XXX} constants.
+    # @param type [DataFormatId] 
+    # @return [void]
+    def set_type(type) end
+    alias_method :type=, :set_type
+    
+    # Returns true if the formats are equal.
+    # @param format [Wx::DataFormat] 
+    # @return [true,false]
+    def ==(format) end
+    
+    # 
+    # @return [typedef unsigned short]
+    def native_format; end
+    # 
+    # @param val [typedef unsigned short]
+    # @return [void]
+    def native_format=(val); end
+    
+  end # DataFormat
+  
+
+end

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

@@ -0,0 +1,439 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+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.
+  # Not surprisingly, being 'smart' comes at a price of added complexity. This is reasonable for the situations when you really need to support multiple formats, but may be annoying if you only want to do something simple like cut and paste text.
+  # To provide a solution for both cases, wxWidgets has two predefined classes which derive from {Wx::DataObject}: {Wx::DataObjectSimple} and {Wx::DataObjectComposite}. {Wx::DataObjectSimple} is the simplest {Wx::DataObject} possible and only holds data in a single format (such as HTML or text) and {Wx::DataObjectComposite} is the simplest way to implement a {Wx::DataObject} that does support multiple formats because it achieves this by simply holding several {Wx::DataObjectSimple} objects.
+  # So, you have several solutions when you need a {Wx::DataObject} class (and you need one as soon as you want to transfer data via the clipboard or drag and drop):
+  # 
+  # - Use one of the built-in classes.
+  # - You may use {Wx::TextDataObject}, {Wx::BitmapDataObject} {Wx::FileDataObject}, {Wx::URLDataObject} in the simplest cases when you only need to support one format and your data is either text, bitmap or list of files.- Use {Wx::DataObjectSimple}
+  # - Deriving from {Wx::DataObjectSimple} is the simplest solution for custom data - you will only support one format and so probably won't be able to communicate with other programs, but data transfer will work in your program (or between different instances of it).- Use {Wx::DataObjectComposite}
+  # - This is a simple but powerful solution which allows you to support any number of formats (either standard or custom if you combine it with the previous solution).- Use {Wx::DataObject} directly
+  # - This is the solution for maximum flexibility and efficiency, but it is also the most difficult to implement.
+  # 
+  # Please note that the easiest way to use drag and drop and the clipboard with multiple formats is by using {Wx::DataObjectComposite}, but it is not the most efficient one as each {Wx::DataObjectSimple} would contain the whole data in its respective formats. Now imagine that you want to paste 200 pages of text in your proprietary format, as well as Word, RTF, HTML, Unicode and plain text to the clipboard and even today's computers are in trouble. For this case, you will have to derive from {Wx::DataObject} directly and make it enumerate its formats and provide the data in the requested format on demand.
+  # Note that neither the GTK+ data transfer mechanisms for clipboard and drag and drop, nor OLE data transfer, copies any data until another application actually requests the data. This is in contrast to the 'feel' offered to the user of a program who would normally think that the data resides in the clipboard after having pressed 'Copy' - in reality it is only declared to be available.
+  # 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}.
+  # <b>{Wx::Perl} Note:</b> This class is not currently usable from {Wx::Perl}; you may use Wx::PlDataObjectSimple instead. 
+  # === 
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  Drag & Drop Sample
+  # @see  Wx::FileDataObject
+  # @see  Wx::TextDataObject
+  # @see  Wx::BitmapDataObject
+  # @see  Wx::CustomDataObject
+  # @see  Wx::DropTarget
+  # @see  Wx::DropSource
+  # @see  Wx::TextDropTarget
+  # @see  Wx::FileDropTarget 
+  # 
+  # 
+  class DataObject < ::Object
+  
+    # 
+    # 
+    # 
+    # 
+    class Direction < Wx::Enum
+    
+      # Format is supported by {Wx::DataObject#get_data_here}
+      # 
+      Get = Wx::DataObject::Direction.new(1)
+      
+      # Format is supported by {Wx::DataObject#set_data}
+      # 
+      Set = Wx::DataObject::Direction.new(2)
+      
+      # Format is supported by both {Wx::DataObject#get_data_here} and {Wx::DataObject#set_data} (unused currently)
+      # 
+      Both = Wx::DataObject::Direction.new(3)
+      
+    end # Direction
+    
+    # Constructor.
+    # @return [DataObject]
+    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.
+    # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method only takes the dir parameter. In scalar context it returns the first format in the list, in list context it returns a list containing all the supported formats.
+    # @param dir [Direction] 
+    # @return [Array<Wx::DataFormat>]
+    def get_all_formats(dir=Wx::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]
+    def get_data_here(format) end
+    alias_method :data_here, :get_data_here
+    
+    # Returns the data size of the given format format.
+    # @param format [Wx::DataFormat] 
+    # @return [Integer]
+    def get_data_size(format) end
+    alias_method :data_size, :get_data_size
+    
+    # Returns the number of available formats for rendering or setting the data.
+    # @param dir [Direction] 
+    # @return [Integer]
+    def get_format_count(dir=Wx::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 [Direction] 
+    # @return [Wx::DataFormat]
+    def get_preferred_format(dir=Wx::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.
+    # @param format [Wx::DataFormat]  The format for which to set the data.
+    # @param buf [String]  Non-NULL pointer to the data.
+    # @return [void]
+    def set_data(format, buf) end
+    
+    # Returns true if this format is supported.
+    # @param format [Wx::DataFormat] 
+    # @param dir [Direction] 
+    # @return [void]
+    def is_supported(format, dir=Wx::GET) end
+    alias_method :supported?, :is_supported
+    
+  end # DataObject
+  
+  # This is the simplest possible implementation of the {Wx::DataObject} class.
+  # The data object of (a class derived from) this class only supports <b>one format</b>, so the number of virtual functions to be implemented is reduced.
+  # Notice that this is still an abstract base class and cannot be used directly, it must be derived. The objects supporting rendering the data must override {Wx::DataObjectSimple#get_data_size} and {Wx::DataObjectSimple#get_data_here} while the objects which may be set must override {Wx::DataObjectSimple#set_data}. Of course, the objects supporting both operations must override all three methods.
+  # <b>{Wx::Perl} Note:</b> In {Wx::Perl}, you need to derive your data object class from Wx::PlDataObjectSimple. 
+  # === 
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  Drag & Drop Sample
+  # @see  Wx::FileDataObject
+  # @see  Wx::TextDataObject
+  # @see  Wx::BitmapDataObject 
+  # 
+  # 
+  class DataObjectSimple < DataObject
+  
+    # Constructor accepts the supported format (none by default) which may also be set later with {Wx::DataObjectSimple#set_format}.
+    # @param format [Wx::DataFormat] 
+    # @return [DataObjectSimple]
+    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
+    alias_method :format, :get_format
+    
+  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:
+  # 
+  #   MyDropTarget::MyDropTarget()
+  #   {
+  #       wxDataObjectComposite* dataobj = new wxDataObjectComposite();
+  #       dataobj->Add(new wxBitmapDataObject(), true);
+  #       dataobj->Add(new wxFileDataObject());
+  #       SetDataObject(dataobj);
+  #   }
+  #   
+  #   wxDragResult MyDropTarget::OnData(wxCoord x, wxCoord y,
+  #                                     wxDragResult defaultDragResult)
+  #   {
+  #       if ( !GetData() )
+  #           return wxDragNone;
+  #   
+  #       wxDataObjectComposite *
+  #           dataobjComp = static_cast<wxDataObjectComposite *>(GetDataObject());
+  #   
+  #       wxDataFormat format = dataobjComp->GetReceivedFormat();
+  #       wxDataObject *dataobj = dataobjComp->GetObject(format);
+  #       switch ( format.GetType() )
+  #       {
+  #           case wxDF_BITMAP:
+  #               {
+  #                   wxBitmapDataObject *
+  #                       dataobjBitmap = static_cast<wxBitmapDataObject *>(dataobj);
+  #   
+  #                   ... use dataobj->GetBitmap() ...
+  #               }
+  #               break;
+  #   
+  #           case wxDF_FILENAME:
+  #               {
+  #                   wxFileDataObject *
+  #                       dataobjFile = static_cast<wxFileDataObject *>(dataobj);
+  #   
+  #                   ... use dataobj->GetFilenames() ...
+  #               }
+  #               break;
+  #   
+  #           default:
+  #               wxFAIL_MSG( "unexpected data object format" );
+  #       }
+  #   
+  #       return defaultDragResult;
+  #   }
+  # 
+  # === 
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  Wx::DataObject
+  # @see  Wx::DataObjectSimple
+  # @see  Wx::FileDataObject
+  # @see  Wx::TextDataObject
+  # @see  Wx::BitmapDataObject 
+  # 
+  # 
+  class DataObjectComposite < DataObject
+  
+    # The default constructor.
+    # @return [DataObjectComposite]
+    def initialize; end
+    
+    # Adds the dataObject to the list of supported objects and it becomes the preferred object if preferred is true.
+    # @param dataObject [Wx::DataObjectSimple] 
+    # @param preferred [true,false] 
+    # @return [void]
+    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 [Direction] 
+    # @return [Wx::DataObjectSimple]
+    def get_object(format, dir=Wx::DataObject::Get) end
+    alias_method :object, :get_object
+    
+  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
+  # @see  Wx::DataObject
+  # @see  Wx::DataObjectSimple
+  # @see  Wx::FileDataObject
+  # @see  Wx::TextDataObject
+  # @see  Wx::DataObject 
+  # 
+  # 
+  class BitmapDataObject < DataObjectSimple
+  
+    # Constructor, optionally passing a bitmap (otherwise use {Wx::BitmapDataObject#set_bitmap} later).
+    # @param bitmap [Wx::Bitmap] 
+    # @return [BitmapDataObject]
+    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]
+    def set_bitmap(bitmap) end
+    alias_method :bitmap=, :set_bitmap
+    
+  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
+  # @see  Wx::DataObjectSimple
+  # @see  Wx::TextDataObject
+  # @see  Wx::BitmapDataObject
+  # @see  Wx::DataObject 
+  # 
+  # 
+  class FileDataObject < DataObjectSimple
+  
+    # Constructor.
+    # @return [FileDataObject]
+    def initialize; end
+    
+    # Adds a file to the file list represented by this data object (Windows only).
+    # @param file [String] 
+    # @return [void]
+    def add_file(file) end
+    
+    # Returns the array of file names.
+    # @return [Wx::ArrayString]
+    def get_filenames; end
+    alias_method :filenames, :get_filenames
+    
+  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
+  # @see  Wx::DataObject
+  # @see  Wx::DataObjectSimple
+  # @see  Wx::FileDataObject
+  # @see  Wx::BitmapDataObject 
+  # 
+  # 
+  class TextDataObject < DataObjectSimple
+  
+    # Constructor, may be used to initialise the text (otherwise {Wx::TextDataObject#set_text} should be used later).
+    # @param text [String] 
+    # @return [TextDataObject]
+    def initialize(text=Wx::EMPTY_STRING) 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]
+    def set_text(strText) end
+    alias_method :text=, :set_text
+    
+  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 
+  # 
+  # 
+  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 [CustomDataObject]
+    def initialize(format=Wx::FORMAT_INVALID) end
+    
+  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).
+  # 
+  # === 
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  Wx::DataObject
+  # @see  Wx::CustomDataObject
+  # @see  Wx::BitmapDataObject 
+  # 
+  # 
+  class ImageDataObject < CustomDataObject
+  
+    # Constructor, optionally passing an image (otherwise use {Wx::ImageDataObject#set_image} later).
+    # @param image [Wx::Image] 
+    # @return [ImageDataObject]
+    def initialize(image=Wx::NULL_IMAGE) end
+    
+    # Returns the image associated with the data object.
+    # @return [Wx::Image]
+    def get_image; end
+    alias_method :image, :get_image
+    
+    # Sets the image stored by the data object.
+    # @param image [Wx::Image] 
+    # @return [void]
+    def set_image(image) end
+    alias_method :image=, :set_image
+    
+  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:
+  # 
+  #   wxTheClipboard->SetData(new wxURLDataObject(url));
+  # 
+  # The actual base class of this class is not always {Wx::DataObject} itself, but rather either {Wx::DataObjectComposite} in {Wx::MSW} and {Wx::GTK} 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.
+  # 
+  # === 
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  Wx::DataObject 
+  # 
+  # 
+  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 [URLDataObject]
+    def initialize(url=Wx::EMPTY_STRING) end
+    
+    # Returns the URL stored by this object, as a string.
+    # @return [String]
+    def get_url; end
+    alias_method :url, :get_url
+    
+    # Sets the URL stored by this object.
+    # @param url [String] 
+    # @return [void]
+    def set_url(url) end
+    alias_method :url=, :set_url
+    
+  end # URLDataObject
+  
+
+end