Class: Wx::RTC::RichTextCompositeObject

Inherits:
RichTextObject show all
Defined in:
lib/wx/doc/gen/rtc/rich_text_composite_object.rb,
lib/wx/doc/rtc/rich_text_composite_object.rb

Overview

Note:

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

Objects of this class can contain other objects.

Category: Rich Text

See Also:

Requires:

  • USE_RICHTEXT

Instance Method Summary collapse

Methods inherited from RichTextObject

#accepts_focus, #adjust_attributes, adjust_available_space, #can_edit_properties, #can_merge, #can_split, #clone, #convert_pixels_to_tenths_mm, convert_pixels_to_tenths_mm, #convert_tenths_mm_to_pixels, convert_tenths_mm_to_pixels, #dereference, #do_split, #draw, draw_border, draw_box_attributes, #edit_properties, #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_natural_size, #get_own_range, #get_own_range_if_top_level, #get_parent, #get_parent_container, #get_position, #get_properties, #get_properties_menu_label, #get_range, #get_rect, #get_right_margin, #get_selection, #get_top_margin, get_total_margin, #get_xml_node_name, #handles_child_selections, #import_from_xml, #is_floatable, #is_floating, #is_shown, #is_top_level, #layout, #layout_to_best_size, #merge, #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, #uses_paragraph_attributes

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(parent = nil) ⇒ Wx::RTC::RichTextCompositeObject

Parameters:



26
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 26

def initialize(parent=nil) end

Instance Method Details

#append_child(child) ⇒ Integer

Appends a child, returning the position.

Parameters:

Returns:

  • (Integer) 


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

def append_child(child) end

#calculate_range(start, end_) ⇒ Integer

Calculates the range of the object.

By default, guess that the object is 1 unit long.

Parameters:

  • start (Integer)
  • end_ (Integer)

Returns:

  • (Integer) 


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

def calculate_range(start, end_) end

#copy(obj) ⇒ void

This method returns an undefined value.

Parameters:



139
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 139

def copy(obj) end

#defragment(context, range = Wx::RICHTEXT_ALL) ⇒ Boolean

Recursively merges all pieces that can be merged.

Parameters:

Returns:

  • (Boolean) 


166
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 166

def defragment(context, range=Wx::RICHTEXT_ALL) end

#delete_children ⇒ Boolean

Deletes all the children.

Returns:

  • (Boolean) 


160
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 160

def delete_children; end

#delete_range(range) ⇒ Boolean

Deletes the given range.

Parameters:

  • range (Range)

Returns:

  • (Boolean) 


62
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 62

def delete_range(range) end

#dump(stream) ⇒ void

This method returns an undefined value.

Dump object data to the given output stream for debugging.

Parameters:

  • stream (Wx::TextOutputStream) 


89
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 89

def dump(stream) end

#each_child {|child| ... } ⇒ Object, Enumerator

Yield each child object to the given block. Returns an Enumerator if no block given.

Yield Parameters:

Returns:

  • (Object, Enumerator) —

    last result of block or Enumerator if no block given.



18
 
# File 'lib/wx/doc/rtc/rich_text_composite_object.rb', line 18

def each_child; end

#find_position(dc, context, index, pt, height, forceLineStart) ⇒ Boolean

Finds the absolute position and row height for the given character position.

Parameters:

Returns:

  • (Boolean) 


49
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 49

def find_position(dc, context, index, pt, height, forceLineStart) end

#get_child(n) ⇒ Wx::RTC::RichTextObject Also known as: child

Returns the nth child.

Parameters:

  • n (Integer)

Returns:



111
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 111

def get_child(n) end

#get_child_at_position(pos) ⇒ Wx::RTC::RichTextObject Also known as: child_at_position

Returns the child object at the given character position.

Parameters:

  • pos (Integer)

Returns:



134
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 134

def get_child_at_position(pos) end

#get_child_count ⇒ Integer Also known as: child_count

Returns the number of children.

Returns:

  • (Integer) 


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

def get_child_count; end

#get_children ⇒ Array<Wx::RTC::RichTextObject> Also known as: children

Returns the children.

Returns:



100
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 100

def get_children; 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) 


83
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.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_text_for_range(range) ⇒ String Also known as: text_for_range

Returns any text in this object for the given range.

Parameters:

  • range (Range)

Returns:

  • (String) 


67
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 67

def get_text_for_range(range) end

#hit_test(dc, context, pt, textPosition, flags = 0) ⇒ Array(Integer,Integer,Wx::RTC::RichTextObject,Wx::RTC::RichTextObject)

Hit-testing: returns a flag indicating hit test details, plus information about position.

contextObj is returned to specify what object position is relevant to, since otherwise there’s an ambiguity. @ obj might not be a child of contextObj, since we may be referring to the container itself if we have no hit on a child - for example if we click outside an object. The function puts the position in textPosition if one is found. pt is in logical units (a zero y position is at the beginning of the buffer). One of the Wx::RTC::RichTextHitTestFlags values.

Parameters:

Returns:



39
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 39

def hit_test(dc, context, pt, textPosition, flags=0) end

#insert_child(child, inFrontOf) ⇒ Boolean

Inserts the child in front of the given object, or at the beginning.

Parameters:

Returns:

  • (Boolean) 


150
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 150

def insert_child(child, inFrontOf) end

#invalidate(invalidRange = Wx::RICHTEXT_ALL) ⇒ void

This method returns an undefined value.

Invalidates the object at the given range.

With no argument, invalidates the whole object.

Parameters:

  • invalidRange (Range) (defaults to: Wx::RICHTEXT_ALL) 


96
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 96

def invalidate(invalidRange=Wx::RICHTEXT_ALL) end

#is_atomic ⇒ Boolean Also known as: atomic?

Returns true if no user editing can be done inside the object.

This returns true for simple objects, false for most composite objects, but true for fields, which if composite, should not be user-edited.

Returns:

  • (Boolean) 


123
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 123

def is_atomic; end

#is_composite ⇒ Boolean Also known as: composite?

Returns true if this object is composite.

Returns:

  • (Boolean) 


116
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 116

def is_composite; end

#is_empty ⇒ Boolean Also known as: empty?

Returns true if the buffer is empty.

Returns:

  • (Boolean) 


128
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 128

def is_empty; end

#move(pt) ⇒ void

This method returns an undefined value.

Moves the object recursively, by adding the offset from old to new.

Parameters:



171
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 171

def move(pt) end

#remove_child(child, deleteChild = false) ⇒ Boolean

Removes and optionally deletes the specified child.

Parameters:

Returns:

  • (Boolean) 


156
 
# File 'lib/wx/doc/gen/rtc/rich_text_composite_object.rb', line 156

def remove_child(child, deleteChild=false) end