Class: Wx::ImageDataObject

Inherits:

CustomDataObject

• Object
• DataObject
• DataObjectSimple
• CustomDataObject
• Wx::ImageDataObject

Defined in:

lib/wx/doc/gen/data_object.rb

Overview

ImageDataObject is a specialization of DataObject for image data.

It can be used e.g. when you need to put on and retrieve from the clipboard a Image with its metadata (like image resolution).

Category: Clipboard and Drag & Drop

See Also:

• and Drop Overview
• DataObject
• CustomDataObject
• BitmapDataObject

Requires:

• USE_CLIPBOARD

Instance Method Summary

• #get_image ⇒ Wx::Image (also: #image)

  Returns the image associated with the data object.

• #initialize(image = Wx::NULL_IMAGE) ⇒ Wx::ImageDataObject constructor

  Constructor, optionally passing an image (otherwise use #set_image later).

• #set_image(image) ⇒ void (also: #image=)

  Sets the image stored by the data object.

Methods inherited from DataObjectSimple

#get_data_here, #get_data_size, #get_format, #set_data

Methods inherited from DataObject

#get_all_formats, #get_data_here, #get_data_size, #get_format_count, #get_preferred_format, #is_supported, #set_data

Constructor Details

#initialize(image = Wx::NULL_IMAGE) ⇒ Wx::ImageDataObject

Constructor, optionally passing an image (otherwise use #set_image later).

Parameters:

• image (Wx::Image) (defaults to: Wx::NULL_IMAGE)

# File 'lib/wx/doc/gen/data_object.rb', line 385

def initialize(image=Wx::NULL_IMAGE) end

Instance Method Details

#get_image ⇒ Wx::Image Also known as: image

Returns the image associated with the data object.

Returns:

• (Wx::Image)

# File 'lib/wx/doc/gen/data_object.rb', line 389

def get_image; end

#set_image(image) ⇒ void Also known as: image=

This method returns an undefined value.

Sets the image stored by the data object.

Parameters:

• image (Wx::Image)

# File 'lib/wx/doc/gen/data_object.rb', line 395

def set_image(image) end