Class: Wx::RTC::RichTextImage

Inherits:

RichTextObject

• Object
• Object
• RichTextObject
• Wx::RTC::RichTextImage

Defined in:

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

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

This class implements a graphic object.

Category: Rich Text

See Also:

• RichTextBuffer
• RichTextCtrl
• RichTextImageBlock

Requires:

• USE_RICHTEXT

Instance Method Summary

• #can_edit_properties ⇒ Boolean (also: #can_edit_properties?)

  Returns true if we can edit the object’s properties via a GUI.

• #clone ⇒ Wx::RTC::RichTextObject

  Clones the image object.

• #copy(obj) ⇒ void

  Copies the image object.

• #draw(dc, context, range, selection, rect, descent, style) ⇒ Boolean

  Draw the item, within the given range.

• #edit_properties(parent, buffer) ⇒ Boolean

  Edits the object’s properties via a GUI.

• #get_image_block ⇒ Wx::RTC::RichTextImageBlock (also: #image_block)

  Returns the image block containing the raw data.

• #get_image_cache ⇒ Wx::Bitmap (also: #image_cache)

  Returns the image cache (a scaled bitmap).

• #get_image_state ⇒ Integer (also: #image_state)

  Gets the image state.

• #get_natural_size ⇒ Wx::RTC::TextAttrSize (also: #natural_size)

  Returns the ‘natural’ size for this object - the image size.

• #get_original_image_size ⇒ Wx::Size (also: #original_image_size)

  Gets the original image size.

• #get_properties_menu_label ⇒ String (also: #properties_menu_label)

  Returns the label to be used for the properties context menu item.

• #get_range_size(range, size, descent, dc, context, flags, position = (Wx::Point.new(0, 0)), parentSize = Wx::DEFAULT_SIZE, partialExtents = nil) ⇒ Boolean (also: #range_size)

  Returns the object size for the given range.

• #get_xml_node_name ⇒ String (also: #xml_node_name)

  Returns the XML node name of this object.

• #import_from_xml(buffer, node, handler, recurse) ⇒ Array(Boolean,Boolean)

  Imports this object from XML.

• #initialize(*args) ⇒ RichTextImage constructor

  A new instance of RichTextImage.

• #is_empty ⇒ Boolean (also: #empty?)

  Returns true if the object is empty.

• #is_floatable ⇒ Boolean (also: #floatable?)

  Returns true if this class of object is floatable.

• #layout(dc, context, rect, parentRect, style) ⇒ Boolean

  Lay the item out at the specified position with the given size constraint.

• #load_and_scale_image_cache(image, sz, context) ⇒ Array(Boolean,Boolean)

  Do the loading and scaling.

• #load_image_cache(dc, context, retImageSize, resetCache = false, parentSize = Wx::DEFAULT_SIZE) ⇒ Boolean

  Creates a cached image at the required size.

• #reset_image_cache ⇒ void

  Resets the image cache.

• #set_image_cache(bitmap) ⇒ void (also: #image_cache=)

  Sets the image cache.

• #set_image_state(state) ⇒ void (also: #image_state=)

  Sets the image state.

• #set_original_image_size(sz) ⇒ void (also: #original_image_size=)

  Sets the original image size.

• #uses_paragraph_attributes ⇒ Boolean

  Returns true if this object takes note of paragraph attributes (text and image objects don’t).

Methods inherited from RichTextObject

#accepts_focus, #adjust_attributes, adjust_available_space, #calculate_range, #can_merge, #can_split, #convert_pixels_to_tenths_mm, convert_pixels_to_tenths_mm, #convert_tenths_mm_to_pixels, convert_tenths_mm_to_pixels, #delete_range, #dereference, #do_split, draw_border, draw_box_attributes, #dump, #find_position, #get_absolute_position, #get_attributes, #get_available_content_area, #get_best_size, #get_bottom_margin, get_box_rects, #get_buffer, #get_cached_size, #get_container, #get_descent, #get_float_direction, #get_left_margin, #get_max_size, #get_min_size, #get_name, #get_own_range, #get_own_range_if_top_level, #get_parent, #get_parent_container, #get_position, #get_properties, #get_range, #get_rect, #get_right_margin, #get_selection, #get_text_for_range, #get_top_margin, get_total_margin, #handles_child_selections, #hit_test, #invalidate, #is_atomic, #is_composite, #is_floating, #is_shown, #is_top_level, #layout_to_best_size, #merge, #move, #reference, #set_attributes, #set_cached_size, #set_descent, #set_margins, #set_max_size, #set_min_size, #set_name, #set_own_range, #set_parent, #set_position, #set_properties, #set_range, #show, #split

Methods inherited from Object

#dup, #is_same_as, #un_share

Constructor Details

#initialize(parent = nil) ⇒ Wx::RTC::RichTextImage #initialize(image, parent = nil, charStyle = nil) ⇒ Wx::RTC::RichTextImage #initialize(imageBlock, parent = nil, charStyle = nil) ⇒ Wx::RTC::RichTextImage #initialize(obj) ⇒ Wx::RTC::RichTextImage

Returns a new instance of RichTextImage.

Overloads:

• #initialize(parent = nil) ⇒ Wx::RTC::RichTextImage

  Default constructor.

  Parameters:

  • parent (Wx::RTC::RichTextObject) (defaults to: nil)
• #initialize(image, parent = nil, charStyle = nil) ⇒ Wx::RTC::RichTextImage

  Creates a Wx::RTC::RichTextImage from a Image.

  Parameters:

  • image (Wx::Image)
  • parent (Wx::RTC::RichTextObject) (defaults to: nil)
  • charStyle (Wx::RTC::RichTextAttr) (defaults to: nil)
• #initialize(imageBlock, parent = nil, charStyle = nil) ⇒ Wx::RTC::RichTextImage

  Creates a Wx::RTC::RichTextImage from an image block.

  Parameters:

  • imageBlock (Wx::RTC::RichTextImageBlock)
  • parent (Wx::RTC::RichTextObject) (defaults to: nil)
  • charStyle (Wx::RTC::RichTextAttr) (defaults to: nil)
• #initialize(obj) ⇒ Wx::RTC::RichTextImage

  Copy constructor.

  Parameters:

  • obj (Wx::RTC::RichTextImage)

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

def initialize(*args) end

Instance Method Details

#can_edit_properties ⇒ Boolean Also known as: can_edit_properties?

Returns true if we can edit the object’s properties via a GUI.

Returns:

• (Boolean)

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

def can_edit_properties; end

#clone ⇒ Wx::RTC::RichTextObject

Clones the image object.

Returns:

• (Wx::RTC::RichTextObject)

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

def clone; end

#copy(obj) ⇒ void

This method returns an undefined value.

Copies the image object.

Parameters:

• obj (Wx::RTC::RichTextImage)

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

def copy(obj) end

#draw(dc, context, range, selection, rect, descent, style) ⇒ Boolean

Draw the item, within the given range.

Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)

Parameters:

• dc (Wx::DC)
• context (Wx::RTC::RichTextDrawingContext)
• range (Range)
• selection (Wx::RTC::RichTextSelection)
• rect (Wx::Rect)
• descent (Integer)
• style (Integer)

Returns:

• (Boolean)

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

def draw(dc, context, range, selection, rect, descent, style) end

#edit_properties(parent, buffer) ⇒ Boolean

Edits the object’s properties via a GUI.

Parameters:

• parent (Wx::Window)
• buffer (Wx::RTC::RichTextBuffer)

Returns:

• (Boolean)

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

def edit_properties(parent, buffer) end

#get_image_block ⇒ Wx::RTC::RichTextImageBlock Also known as: image_block

Returns the image block containing the raw data.

Returns:

• (Wx::RTC::RichTextImageBlock)

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

def get_image_block; end

#get_image_cache ⇒ Wx::Bitmap Also known as: image_cache

Returns the image cache (a scaled bitmap).

Returns:

• (Wx::Bitmap)

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

def get_image_cache; end

#get_image_state ⇒ Integer Also known as: image_state

Gets the image state.

Returns:

• (Integer)

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

def get_image_state; end

#get_natural_size ⇒ Wx::RTC::TextAttrSize Also known as: natural_size

Returns the ‘natural’ size for this object - the image size.

Returns:

• (Wx::RTC::TextAttrSize)

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

def get_natural_size; end

#get_original_image_size ⇒ Wx::Size Also known as: original_image_size

Gets the original image size.

Returns:

• (Wx::Size)

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

def get_original_image_size; end

#get_properties_menu_label ⇒ String Also known as: properties_menu_label

Returns the label to be used for the properties context menu item.

Returns:

• (String)

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

def get_properties_menu_label; end

#get_range_size(range, size, descent, dc, context, flags, position = (Wx::Point.new(0, 0)), parentSize = Wx::DEFAULT_SIZE, partialExtents = nil) ⇒ Boolean Also known as: range_size

Returns the object size for the given range.

Returns false if the range is invalid for this object.

Parameters:

• range (Range)
• size (Array(Integer, Integer), Wx::Size)
• descent (int)
• dc (Wx::DC)
• context (Wx::RTC::RichTextDrawingContext)
• flags (Integer)
• position (Array(Integer, Integer), Wx::Point) (defaults to: (Wx::Point.new(0, 0)))
• parentSize (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
• partialExtents (Array, nil) (defaults to: nil)

Returns:

• (Boolean)

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

def get_range_size(range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end

#get_xml_node_name ⇒ String Also known as: xml_node_name

Returns the XML node name of this object.

This must be overridden for XmlNode-base XML export to work.

Returns:

• (String)

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

def get_xml_node_name; end

#import_from_xml(buffer, node, handler, recurse) ⇒ Array(Boolean,Boolean)

Imports this object from XML.

Parameters:

• buffer (Wx::RTC::RichTextBuffer)
• node (Wx::XmlNode)
• handler (Wx::RTC::RichTextXMLHandler)
• recurse (Boolean)

Returns:

• (Array(Boolean,Boolean))

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

def import_from_xml(buffer, node, handler, recurse) end

#is_empty ⇒ Boolean Also known as: empty?

Returns true if the object is empty.

Returns:

• (Boolean)

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

def is_empty; end

#is_floatable ⇒ Boolean Also known as: floatable?

Returns true if this class of object is floatable.

Returns:

• (Boolean)

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

def is_floatable; end

#layout(dc, context, rect, parentRect, style) ⇒ Boolean

Lay the item out at the specified position with the given size constraint.

Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).

Parameters:

• dc (Wx::DC)
• context (Wx::RTC::RichTextDrawingContext)
• rect (Wx::Rect)
• parentRect (Wx::Rect)
• style (Integer)

Returns:

• (Boolean)

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

def layout(dc, context, rect, parentRect, style) end

#load_and_scale_image_cache(image, sz, context) ⇒ Array(Boolean,Boolean)

Do the loading and scaling.

Parameters:

• image (Wx::Image)
• sz (Array(Integer, Integer), Wx::Size)
• context (Wx::RTC::RichTextDrawingContext)

Returns:

• (Array(Boolean,Boolean))

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

def load_and_scale_image_cache(image, sz, context) end

#load_image_cache(dc, context, retImageSize, resetCache = false, parentSize = Wx::DEFAULT_SIZE) ⇒ Boolean

Creates a cached image at the required size.

Parameters:

• dc (Wx::DC)
• context (Wx::RTC::RichTextDrawingContext)
• retImageSize (Array(Integer, Integer), Wx::Size)
• resetCache (Boolean) (defaults to: false)
• parentSize (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)

Returns:

• (Boolean)

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

def load_image_cache(dc, context, retImageSize, resetCache=false, parentSize=Wx::DEFAULT_SIZE) end

#reset_image_cache ⇒ void

This method returns an undefined value.

Resets the image cache.

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

def reset_image_cache; end

#set_image_cache(bitmap) ⇒ void Also known as: image_cache=

This method returns an undefined value.

Sets the image cache.

Parameters:

• bitmap (Wx::Bitmap)

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

def set_image_cache(bitmap) end

#set_image_state(state) ⇒ void Also known as: image_state=

This method returns an undefined value.

Sets the image state.

Parameters:

• state (Integer)

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

def set_image_state(state) end

#set_original_image_size(sz) ⇒ void Also known as: original_image_size=

This method returns an undefined value.

Sets the original image size.

Parameters:

• sz (Array(Integer, Integer), Wx::Size)

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

def set_original_image_size(sz) end

#uses_paragraph_attributes ⇒ Boolean

Returns true if this object takes note of paragraph attributes (text and image objects don’t).

Returns:

• (Boolean)

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

def uses_paragraph_attributes; end