Class: Wx::RTC::RichTextBufferDataObject

Inherits:

DataObjectSimple

• Object
• DataObject
• DataObjectSimple
• Wx::RTC::RichTextBufferDataObject

Defined in:

lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb

Overview

Implements a rich text data object for clipboard transfer.

Category: Rich Text

See Also:

• DataObjectSimple
• RichTextBuffer
• RichTextCtrl

Requires:

• USE_RICHTEXT

Class Method Summary

• .get_rich_text_buffer_format_id ⇒ String

  Returns the id for the new data format.

Instance Method Summary

• #get_rich_text_buffer ⇒ Wx::RTC::RichTextBuffer (also: #rich_text_buffer)

  After a call to this function, the buffer is owned by the caller and it is responsible for deleting it.

• #initialize(richTextBuffer = nil) ⇒ Wx::RTC::RichTextBufferDataObject constructor

  The constructor doesn’t copy the pointer, so it shouldn’t go away while this object is alive.

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(richTextBuffer = nil) ⇒ Wx::RTC::RichTextBufferDataObject

The constructor doesn’t copy the pointer, so it shouldn’t go away while this object is alive.

Parameters:

• richTextBuffer (Wx::RTC::RichTextBuffer) (defaults to: nil)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb', line 25

def initialize(richTextBuffer=nil) end

Class Method Details

.get_rich_text_buffer_format_id ⇒ String

Returns the id for the new data format.

Returns:

• (String)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb', line 34

def self.get_rich_text_buffer_format_id; end

Instance Method Details

#get_rich_text_buffer ⇒ Wx::RTC::RichTextBuffer Also known as: rich_text_buffer

After a call to this function, the buffer is owned by the caller and it is responsible for deleting it.

Returns:

• (Wx::RTC::RichTextBuffer)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb', line 29

def get_rich_text_buffer; end