Class: Wx::RTC::RichTextImageBlock

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/rtc/rich_text_image.rb

Overview

This class stores information about an image, in binary in-memory form.

Category: Rich Text

See Also:

Requires:

  • USE_RICHTEXT

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::RTC::RichTextImageBlock #initialize(block) ⇒ Wx::RTC::RichTextImageBlock

Returns a new instance of RichTextImageBlock.

Overloads:



222
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 222

def initialize(*args) end

Instance Method Details

#clear ⇒ void

This method returns an undefined value.

Clears the block.



230
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 230

def clear; end

#copy(block) ⇒ void

This method returns an undefined value.

Copy from block.

Parameters:



281
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 281

def copy(block) end

#do_make_image_block(image, imageType) ⇒ Boolean

Makes the image block.

Parameters:

Returns:

  • (Boolean) 


259
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 259

def do_make_image_block(image, imageType) end

#get_data ⇒ String Also known as: data

Returns the raw data.

Returns:

  • (String) 


289
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 289

def get_data; end

#get_data_size ⇒ Integer Also known as: data_size

Returns the data size in bytes.

Returns:

  • (Integer) 


294
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 294

def get_data_size; end

#get_extension ⇒ String Also known as: extension

Gets the extension for the block’s type.

Returns:

  • (String) 


329
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 329

def get_extension; end

#get_image_type ⇒ Wx::BitmapType Also known as: image_type

Returns the image type.

Returns:



299
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 299

def get_image_type; end

#init ⇒ void

This method returns an undefined value.

Initialises the block.



226
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 226

def init; end

#is_ok ⇒ Boolean Also known as: ok?

Returns true if the data is non-NULL.

Returns:

  • (Boolean) 


321
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 321

def is_ok; end

#load(image) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


285
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 285

def load(image) end

#make_image_block(filename, imageType, image, convertToJPEG = true) ⇒ Boolean #make_image_block(image, imageType, quality = 80) ⇒ Boolean

Overloads:

  • #make_image_block(filename, imageType, image, convertToJPEG = true) ⇒ Boolean

    Load the original image into a memory block.

    If the image is not a JPEG, we must convert it into a JPEG to conserve space. If it’s not a JPEG we can make use of image, already scaled, so we don’t have to load the image a second time.

    Parameters:

    Returns:

    • (Boolean)
  • #make_image_block(image, imageType, quality = 80) ⇒ Boolean

    Make an image block from the Image in the given format.

    Parameters:

    Returns:

    • (Boolean) 


247
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 247

def make_image_block(*args) end

#make_image_block_default_quality(image, imageType) ⇒ Boolean

Uses a const Image for efficiency, but can’t set quality (only relevant for JPEG)

Parameters:

Returns:

  • (Boolean) 


253
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 253

def make_image_block_default_quality(image, imageType) end

#ok ⇒ Boolean

Returns:

  • (Boolean) 


325
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 325

def ok; end

#read_hex(stream, length, imageType) ⇒ Boolean

Reads the data in hex from a stream.

Parameters:

Returns:

  • (Boolean) 


276
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 276

def read_hex(stream, length, imageType) end

#set_data(image) ⇒ void Also known as: data=

This method returns an undefined value.

Parameters:

  • image (String) 


304
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 304

def set_data(image) end

#set_data_size(size) ⇒ void Also known as: data_size=

This method returns an undefined value.

Sets the data size.

Parameters:

  • size (Integer) 


310
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 310

def set_data_size(size) end

#set_image_type(imageType) ⇒ void Also known as: image_type=

This method returns an undefined value.

Sets the image type.

Parameters:



316
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 316

def set_image_type(imageType) end

#write(filename) ⇒ Boolean

Writes the block to a file.

Parameters:

  • filename (String)

Returns:

  • (Boolean) 


264
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 264

def write(filename) end

#write_hex(stream) ⇒ Boolean

Writes the data in hex to a stream.

Parameters:

Returns:

  • (Boolean) 


269
 
# File 'lib/wx/doc/gen/rtc/rich_text_image.rb', line 269

def write_hex(stream) end