Class: Wx::DataObjectSimple

Inherits:

DataObject

• Object
• DataObject
• Wx::DataObjectSimple

Defined in:

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

Overview

Requires:

• USE_CLIPBOARD

Direct Known Subclasses

BitmapDataObject, CustomDataObject, DataObjectSimpleBase, FileDataObject, RTC::RichTextBufferDataObject, TextDataObject

Instance Method Summary

• #get_data_here ⇒ Object
• #get_data_size ⇒ Object
• #get_format ⇒ Wx::DataFormat (also: #format)

  Returns the (one and only one) format supported by this object.

• #initialize(format = Wx::FORMAT_INVALID) ⇒ Wx::DataObjectSimple constructor

  Constructor accepts the supported format (none by default) which may also be set later with set_format.

• #set_data ⇒ Object

Methods inherited from DataObject

#get_all_formats, #get_format_count, #get_preferred_format, #is_supported

Constructor Details

#initialize(format = Wx::FORMAT_INVALID) ⇒ Wx::DataObjectSimple

Constructor accepts the supported format (none by default) which may also be set later with set_format.

Parameters:

• format (Wx::DataFormat) (defaults to: Wx::FORMAT_INVALID)

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

def initialize(format=Wx::FORMAT_INVALID) end

Instance Method Details

#get_data_here(format) ⇒ String^? #get_data_here ⇒ String^?

Overloads:

• #get_data_here(format) ⇒ String^?

  Returns the data of this object.

  Parameters:

  • format (Wx::DataFormat) —

    ignored for this class

  Returns:

  • (String, nil) —

    data of this object

• #get_data_here ⇒ String^?

  Returns the data of this object.

  Returns:

  • (String, nil) —

    data of this object

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

def get_data_here(*) end

#get_data_size(format) ⇒ Integer #get_data_size ⇒ Integer

Overloads:

• #get_data_size(format) ⇒ Integer

  Returns the data size of the format for this object.

  Parameters:

  • format (Wx::DataFormat) —

    ignored for this class

  Returns:

  • (Integer) —

    default always returns 0

• #get_data_size ⇒ Integer

  Returns the data size of the format for this object.

  Returns:

  • (Integer) —

    default always returns 0

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

def get_data_size(*) end

#get_format ⇒ Wx::DataFormat Also known as: format

Returns the (one and only one) format supported by this object.

It is assumed that the format is supported in both directions.

Returns:

• (Wx::DataFormat)

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

def get_format; end

#set_data(format, buf) ⇒ Boolean #set_data(buf) ⇒ Boolean

Overloads:

• #set_data(format, buf) ⇒ Boolean

  Sets the data for this object and returns true if successful, false otherwise.

  Parameters:

  • format (Wx::DataFormat) —

    ignored for this class

  • buf (String) —

    non-nil data

  Returns:

  • (Boolean) —

    default always returns false.

• #set_data(buf) ⇒ Boolean

  Sets the data for this object and returns true if successful, false otherwise.

  Parameters:

  • buf (String) —

    non-nil data

  Returns:

  • (Boolean) —

    default always returns false.

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

def set_data(*) end