Class: Wx::RTC::RichTextBuffer

Inherits:
RichTextParagraphLayoutBox show all
Defined in:
lib/wx/doc/gen/rtc/rich_text_buffer.rb,
lib/wx/doc/rtc/richtext_buffer.rb

Overview

Note:

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

This is a kind of paragraph layout box, used to represent the whole buffer.

Category: Rich Text

See Also:

Requires:

  • USE_RICHTEXT

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RichTextParagraphLayoutBox

#accepts_focus, #add_image, #add_paragraphs, #apply_style_sheet, #clear, #clear_list_style, #collect_style, #copy_fragment, #delete_range, #do_get_style, #do_invalidate, #do_number_list, #draw, #draw_floats, #find_next_paragraph_number, #get_basic_style, #get_default_style, #get_float_collector, #get_floating_object_count, #get_floating_objects, #get_invalid_range, #get_leaf_object_at_position, #get_line_at_position, #get_line_at_y_position, #get_line_count, #get_line_for_visible_line_number, #get_line_size_at_position, #get_paragraph_at_line, #get_paragraph_at_position, #get_paragraph_count, #get_paragraph_for_line, #get_paragraph_length, #get_paragraph_text, #get_partial_paragraph, #get_range_size, #get_rich_text_ctrl, #get_style, #get_style_for_new_paragraph, #get_style_for_range, #get_text, #get_text_for_range, #get_uncombined_style, #get_visible_line_number, #get_xml_node_name, #has_character_attributes, #has_paragraph_attributes, #import_from_xml, #insert_field_with_undo, #insert_fragment, #invalidate, #invalidate_hierarchy, #is_dirty, #is_top_level, #layout, #move_anchored_object_to_paragraph, #number_list, #position_to_xy, #prepare_content, #promote_list, #reset, #set_basic_style, #set_default_style, #set_list_style, #set_object_properties_with_undo, #set_partial_paragraph, #set_properties, #set_rich_text_ctrl, #set_style, #update_floating_objects, #update_ranges, #xy_to_position

Methods inherited from RichTextCompositeObject

#append_child, #calculate_range, #defragment, #delete_children, #delete_range, #each_child, #find_position, #get_child, #get_child_at_position, #get_child_count, #get_children, #get_range_size, #get_text_for_range, #insert_child, #invalidate, #is_atomic, #is_composite, #is_empty, #move, #remove_child

Methods inherited from RichTextObject

#accepts_focus, #adjust_attributes, adjust_available_space, #calculate_range, #can_edit_properties, #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, draw_border, draw_box_attributes, #edit_properties, #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_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_range_size, #get_rect, #get_right_margin, #get_selection, #get_text_for_range, #get_top_margin, get_total_margin, #get_xml_node_name, #handles_child_selections, #import_from_xml, #invalidate, #is_atomic, #is_composite, #is_empty, #is_floatable, #is_floating, #is_shown, #is_top_level, #layout, #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, #uses_paragraph_attributes

Methods inherited from Object

#dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::RTC::RichTextBuffer #initialize(obj) ⇒ Wx::RTC::RichTextBuffer

Returns a new instance of RichTextBuffer.

Overloads:



30
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 30

def initialize(*args) end

Class Method Details

.add_drawing_handler(handler) ⇒ void

This method returns an undefined value.

Adds a drawing handler to the end.

Parameters:



587
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 587

def self.add_drawing_handler(handler) end

.add_field_type(fieldType) ⇒ void

This method returns an undefined value.

Adds a field type.

Parameters:

See Also:



618
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 618

def self.add_field_type(fieldType) end

.add_handler(handler) ⇒ void

This method returns an undefined value.

Adds a file handler to the end.

Parameters:



532
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 532

def self.add_handler(handler) end

.clean_up_drawing_handlers ⇒ void

This method returns an undefined value.

Clean up drawing handlers.



606
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 606

def self.clean_up_drawing_handlers; end

.clean_up_field_types ⇒ void

This method returns an undefined value.

Cleans up field types.



646
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 646

def self.clean_up_field_types; end

.clean_up_handlers ⇒ void

This method returns an undefined value.

Clean up file handlers.



576
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 576

def self.clean_up_handlers; end

.each_drawing_handler {|handler| ... } ⇒ Object, Enumerator

Iterates all RichTextDrawingHandler-s and passes each handler to the given block or returns an enumerator if no block given.

Yield Parameters:

Returns:

  • (Object, Enumerator) —

    last result of given block or enumerator



30
 
# File 'lib/wx/doc/rtc/richtext_buffer.rb', line 30

def self.each_drawing_handler; end

.each_field_type {|field| ... } ⇒ Object, Enumerator

Iterates all RichTextFieldType-s and passes each field type to the given block or returns an enumerator if no block given.

Yield Parameters:

Returns:

  • (Object, Enumerator) —

    last result of given block or enumerator



24
 
# File 'lib/wx/doc/rtc/richtext_buffer.rb', line 24

def self.each_field_type; end

.each_handler {|handler| ... } ⇒ Object, Enumerator

Iterates all RichTextFileHandler-s and passes each handler to the given block or returns an enumerator if no block given.

Yield Parameters:

Returns:

  • (Object, Enumerator) —

    last result of given block or enumerator



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

def self.each_handler; end

.find_drawing_handler(name) ⇒ Wx::RTC::RichTextDrawingHandler

Finds a drawing handler by name.

Parameters:

  • name (String)

Returns:



602
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 602

def self.find_drawing_handler(name) end

.find_field_type(name) ⇒ Wx::RTC::RichTextFieldType

Finds a field type by name.

Parameters:

  • name (String)

Returns:

See Also:



642
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 642

def self.find_field_type(name) end

.self.find_handler(name) ⇒ Wx::RTC::RichTextFileHandler .self.find_handler(extension, imageType) ⇒ Wx::RTC::RichTextFileHandler .self.find_handler(imageType) ⇒ Wx::RTC::RichTextFileHandler

Overloads:



557
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 557

def self.find_handler(*args) end

.find_handler_filename_or_type(filename, imageType) ⇒ Wx::RTC::RichTextFileHandler

Finds a handler by filename or, if supplied, type.

Parameters:

  • filename (String)
  • imageType (Wx::RichTextFileType)

Returns:



563
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 563

def self.find_handler_filename_or_type(filename, imageType) end

.get_bullet_proportion ⇒ Float

Returns the factor to multiply by character height to get a reasonable bullet size.

Returns:

  • (Float) 


659
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 659

def self.get_bullet_proportion; end

.get_bullet_right_margin ⇒ Integer

Returns the minimum margin between bullet and paragraph in 10ths of a mm.

Returns:

  • (Integer) 


650
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 650

def self.get_bullet_right_margin; end

.get_ext_wildcard(combine = false, save = false, types = nil) ⇒ String

Gets a wildcard incorporating all visible handlers.

If types is present, it will be filled with the file type corresponding to each filter. This can be used to determine the type to pass to LoadFile given a selected filter.

Parameters:

  • combine (Boolean) (defaults to: false)
  • save (Boolean) (defaults to: false)
  • types (Array, nil) (defaults to: nil)

Returns:

  • (String) 


572
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 572

def self.get_ext_wildcard(combine=false, save=false, types=nil) end

.get_floating_layout_mode ⇒ Boolean

Returns the floating layout mode.

The default is true, where objects are laid out according to their floating status.

Returns:

  • (Boolean) 


670
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 670

def self.get_floating_layout_mode; end

.init_standard_handlers ⇒ void

This method returns an undefined value.

Initialise the standard file handlers.

Currently, only the plain text loading/saving handler is initialised by default.



582
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 582

def self.init_standard_handlers; end

.insert_drawing_handler(handler) ⇒ void

This method returns an undefined value.

Inserts a drawing handler at the front.

Parameters:



592
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 592

def self.insert_drawing_handler(handler) end

.insert_handler(handler) ⇒ void

This method returns an undefined value.

Inserts a file handler at the front.

Parameters:



537
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 537

def self.insert_handler(handler) end

.remove_drawing_handler(name) ⇒ Boolean

Removes a drawing handler.

Parameters:

  • name (String)

Returns:

  • (Boolean) 


597
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 597

def self.remove_drawing_handler(name) end

.remove_field_type(name) ⇒ Boolean

Removes a field type by name.

Parameters:

  • name (String)

Returns:

  • (Boolean)

See Also:



630
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 630

def self.remove_field_type(name) end

.remove_handler(name) ⇒ Boolean

Removes a file handler.

Parameters:

  • name (String)

Returns:

  • (Boolean) 


542
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 542

def self.remove_handler(name) end

.set_bullet_proportion(prop) ⇒ void

This method returns an undefined value.

Sets the factor to multiply by character height to get a reasonable bullet size.

Parameters:

  • prop (Float) 


664
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 664

def self.set_bullet_proportion(prop) end

.set_bullet_right_margin(margin) ⇒ void

This method returns an undefined value.

Sets the minimum margin between bullet and paragraph in 10ths of a mm.

Parameters:

  • margin (Integer) 


655
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 655

def self.set_bullet_right_margin(margin) end

.set_floating_layout_mode(mode) ⇒ void

This method returns an undefined value.

Sets the floating layout mode.

Pass false to speed up editing by not performing floating layout. This setting affects all buffers.

Parameters:

  • mode (Boolean) 


677
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 677

def self.set_floating_layout_mode(mode) end

Instance Method Details

#add_event_handler(handler) ⇒ Boolean

Adds an event handler.

A buffer associated with a control has the control as the only event handler, but the application is free to add more if further notification is required. All handlers are notified of an event originating from the buffer, such as the replacement of a style sheet during loading. The buffer never deletes any of the event handlers, unless #remove_event_handler is called with true as the second argument.

Parameters:

Returns:

  • (Boolean) 


411
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 411

def add_event_handler(handler) end

#add_paragraph(text, paraStyle = nil) ⇒ Range

Convenience function to add a paragraph of text.

Parameters:

Returns:

  • (Range) 


145
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 145

def add_paragraph(text, paraStyle=nil) end

#batching_undo ⇒ Boolean

Returns true if we are collapsing commands.

Returns:

  • (Boolean) 


161
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 161

def batching_undo; end

#begin_alignment(alignment) ⇒ Boolean

Begins using alignment.

Parameters:

Returns:

  • (Boolean) 


268
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 268

def begin_alignment(alignment) end

#begin_batch_undo(cmdName) ⇒ Boolean

Begin collapsing undo/redo commands.

Note that this may not work properly if combining commands that delete or insert content, changing ranges for subsequent actions. cmdName should be the name of the combined command that will appear next to Undo and Redo in the edit menu.

Parameters:

  • cmdName (String)

Returns:

  • (Boolean) 


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

def begin_batch_undo(cmdName) end

#begin_bold ⇒ Boolean

Begins using bold.

Returns:

  • (Boolean) 


216
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 216

def begin_bold; end

#begin_character_style(characterStyle) ⇒ Boolean

Begins named character style.

Parameters:

  • characterStyle (String)

Returns:

  • (Boolean) 


365
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 365

def begin_character_style(characterStyle) end

#begin_font(font) ⇒ Boolean

Begins using this font.

Parameters:

Returns:

  • (Boolean) 


250
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 250

def begin_font(font) end

#begin_font_size(pointSize) ⇒ Boolean

Begins using point size.

Parameters:

  • pointSize (Integer)

Returns:

  • (Boolean) 


241
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 241

def begin_font_size(pointSize) end

#begin_italic ⇒ Boolean

Begins using italic.

Returns:

  • (Boolean) 


224
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 224

def begin_italic; end

#begin_left_indent(leftIndent, leftSubIndent = 0) ⇒ Boolean

Begins using leftIndent for the left indent, and optionally leftSubIndent for the sub-indent.

Both are expressed in tenths of a millimetre. The sub-indent is an offset from the left of the paragraph, and is used for all but the first line in a paragraph. A positive value will cause the first line to appear to the left of the subsequent lines, and a negative value will cause the first line to be indented relative to the subsequent lines.

Parameters:

  • leftIndent (Integer)
  • leftSubIndent (Integer) (defaults to: 0)

Returns:

  • (Boolean) 


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

def begin_left_indent(leftIndent, leftSubIndent=0) end

#begin_line_spacing(lineSpacing) ⇒ Boolean

Begins line spacing using the specified value.

spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing. The TextAttrLineSpacing enumeration values are defined for convenience.

Parameters:

  • lineSpacing (Integer)

Returns:

  • (Boolean) 


312
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 312

def begin_line_spacing(lineSpacing) end

#begin_list_style(listStyle, level = 1, number = 1) ⇒ Boolean

Begins named list style.

Optionally, you can also pass a level and a number.

Parameters:

  • listStyle (String)
  • level (Integer) (defaults to: 1)
  • number (Integer) (defaults to: 1)

Returns:

  • (Boolean) 


387
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 387

def begin_list_style(listStyle, level=1, number=1) end

#begin_numbered_bullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle = (Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_ARABIC|Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_PERIOD)) ⇒ Boolean

Begins numbered bullet.

This call will be needed for each item in the list, and the application should take care of incrementing the numbering. bulletNumber is a number, usually starting with 1. leftIndent and leftSubIndent are values in tenths of a millimetre. bulletStyle is a bitlist of the following values: Wx::RTC::RichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between the margin and the bullet. The content of the paragraph, including the first line, starts at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the left of the actual paragraph is leftSubIndent.

Parameters:

  • bulletNumber (Integer)
  • leftIndent (Integer)
  • leftSubIndent (Integer)
  • bulletStyle (Integer) (defaults to: (Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_ARABIC|Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_PERIOD))

Returns:

  • (Boolean) 


328
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 328

def begin_numbered_bullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle=(Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_ARABIC|Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_PERIOD)) end

#begin_paragraph_spacing(before, after) ⇒ Boolean

Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre.

Parameters:

  • before (Integer)
  • after (Integer)

Returns:

  • (Boolean) 


300
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 300

def begin_paragraph_spacing(before, after) end

#begin_paragraph_style(paragraphStyle) ⇒ Boolean

Begins named paragraph style.

Parameters:

  • paragraphStyle (String)

Returns:

  • (Boolean) 


374
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 374

def begin_paragraph_style(paragraphStyle) end

#begin_right_indent(rightIndent) ⇒ Boolean

Begins a right indent, specified in tenths of a millimetre.

Parameters:

  • rightIndent (Integer)

Returns:

  • (Boolean) 


290
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 290

def begin_right_indent(rightIndent) end

#begin_standard_bullet(bulletName, leftIndent, leftSubIndent, bulletStyle = Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_STANDARD) ⇒ Boolean

Begins applying a standard bullet, using one of the standard bullet names (currently standard/circle or standard/square.

See #begin_numbered_bullet for an explanation of how indentation is used to render the bulleted paragraph.

Parameters:

  • bulletName (String)
  • leftIndent (Integer)
  • leftSubIndent (Integer)
  • bulletStyle (Integer) (defaults to: Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_STANDARD)

Returns:

  • (Boolean) 


356
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 356

def begin_standard_bullet(bulletName, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_STANDARD) end

#begin_style(style) ⇒ Boolean

Begin using a style.

Parameters:

Returns:

  • (Boolean) 


195
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 195

def begin_style(style) end

#begin_suppress_undo ⇒ Boolean

Begin suppressing undo/redo commands.

The way undo is suppressed may be implemented differently by each command. If not dealt with by a command implementation, then it will be implemented automatically by not storing the command in the undo history when the action is submitted to the command processor.

Returns:

  • (Boolean) 


167
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 167

def begin_suppress_undo; end

#begin_symbol_bullet(symbol, leftIndent, leftSubIndent, bulletStyle = Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_SYMBOL) ⇒ Boolean

Begins applying a symbol bullet, using a character from the current font.

See #begin_numbered_bullet for an explanation of how indentation is used to render the bulleted paragraph.

Parameters:

  • symbol (String)
  • leftIndent (Integer)
  • leftSubIndent (Integer)
  • bulletStyle (Integer) (defaults to: Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_SYMBOL)

Returns:

  • (Boolean) 


342
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 342

def begin_symbol_bullet(symbol, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_SYMBOL) end

#begin_text_colour(colour) ⇒ Boolean

Begins using this colour.

Parameters:

Returns:

  • (Boolean) 


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

def begin_text_colour(colour) end

#begin_underline ⇒ Boolean

Begins using underline.

Returns:

  • (Boolean) 


232
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 232

def begin_underline; end

#begin_url(url, characterStyle = ('')) ⇒ Boolean

Begins applying TextAttrFlags::TEXT_ATTR_URL to the content.

Pass a URL and optionally, a character style to apply, since it is common to mark a URL with a familiar style such as blue text with underlining.

Parameters:

  • url (String)
  • characterStyle (String) (defaults to: (''))

Returns:

  • (Boolean) 


399
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 399

def begin_url(url, characterStyle=('')) end

#can_paste_from_clipboard ⇒ Boolean Also known as: can_paste_from_clipboard?

Returns true if we can paste from the clipboard.

Returns:

  • (Boolean) 


189
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 189

def can_paste_from_clipboard; end

#clear_event_handlers ⇒ void

This method returns an undefined value.

Clear event handlers.



421
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 421

def clear_event_handlers; end

#clear_style_stack ⇒ void

This method returns an undefined value.

Clears the style stack.



207
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 207

def clear_style_stack; end

#clone ⇒ Wx::RTC::RichTextObject

Clones the buffer.

Returns:



451
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 451

def clone; end

#copy(obj) ⇒ void

This method returns an undefined value.

Copies the buffer.

Parameters:



447
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 447

def copy(obj) end

#copy_to_clipboard(range) ⇒ Boolean

Copy the range to the clipboard.

Parameters:

  • range (Range)

Returns:

  • (Boolean) 


180
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 180

def copy_to_clipboard(range) end

#delete_range_with_undo(range, ctrl) ⇒ Boolean

Submits a command to delete this range.

Parameters:

Returns:

  • (Boolean) 


497
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 497

def delete_range_with_undo(range, ctrl) end

#dump ⇒ void #dump(stream) ⇒ void

Overloads:

  • #dump ⇒ void

    This method returns an undefined value.

    Dumps contents of buffer for debugging purposes.

  • #dump(stream) ⇒ void

    This method returns an undefined value.

    Dump object data to the given output stream for debugging.

    Parameters:

    • stream (Wx::TextOutputStream) 


516
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 516

def dump(*args) end

#end_alignment ⇒ Boolean

Ends alignment.

Returns:

  • (Boolean) 


272
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 272

def end_alignment; end

#end_all_styles ⇒ Boolean

End all styles.

Returns:

  • (Boolean) 


203
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 203

def end_all_styles; end

#end_batch_undo ⇒ Boolean

End collapsing undo/redo commands.

Returns:

  • (Boolean) 


157
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 157

def end_batch_undo; end

#end_bold ⇒ Boolean

Ends using bold.

Returns:

  • (Boolean) 


220
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 220

def end_bold; end

#end_character_style ⇒ Boolean

Ends named character style.

Returns:

  • (Boolean) 


369
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 369

def end_character_style; end

#end_font ⇒ Boolean

Ends using a font.

Returns:

  • (Boolean) 


254
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 254

def end_font; end

#end_font_size ⇒ Boolean

Ends using point size.

Returns:

  • (Boolean) 


245
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 245

def end_font_size; end

#end_italic ⇒ Boolean

Ends using italic.

Returns:

  • (Boolean) 


228
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 228

def end_italic; end

#end_left_indent ⇒ Boolean

Ends left indent.

Returns:

  • (Boolean) 


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

def end_left_indent; end

#end_line_spacing ⇒ Boolean

Ends line spacing.

Returns:

  • (Boolean) 


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

def end_line_spacing; end

#end_list_style ⇒ Boolean

Ends named character style.

Returns:

  • (Boolean) 


391
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 391

def end_list_style; end

#end_numbered_bullet ⇒ Boolean

Ends numbered bullet.

Returns:

  • (Boolean) 


332
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 332

def end_numbered_bullet; end

#end_paragraph_spacing ⇒ Boolean

Ends paragraph spacing.

Returns:

  • (Boolean) 


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

def end_paragraph_spacing; end

#end_paragraph_style ⇒ Boolean

Ends named character style.

Returns:

  • (Boolean) 


378
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 378

def end_paragraph_style; end

#end_right_indent ⇒ Boolean

Ends right indent.

Returns:

  • (Boolean) 


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

def end_right_indent; end

#end_standard_bullet ⇒ Boolean

Ends standard bullet.

Returns:

  • (Boolean) 


360
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 360

def end_standard_bullet; end

#end_style ⇒ Boolean

End the style.

Returns:

  • (Boolean) 


199
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 199

def end_style; end

#end_suppress_undo ⇒ Boolean

End suppressing undo/redo commands.

Returns:

  • (Boolean) 


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

def end_suppress_undo; end

#end_symbol_bullet ⇒ Boolean

Ends symbol bullet.

Returns:

  • (Boolean) 


346
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 346

def end_symbol_bullet; end

#end_text_colour ⇒ Boolean

Ends using a colour.

Returns:

  • (Boolean) 


263
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 263

def end_text_colour; end

#end_underline ⇒ Boolean

Ends using underline.

Returns:

  • (Boolean) 


236
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 236

def end_underline; end

#end_url ⇒ Boolean

Ends URL.

Returns:

  • (Boolean) 


403
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 403

def end_url; end

#get_dimension_scale ⇒ Float Also known as: dimension_scale

Returns the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.

Returns:

  • (Float) 


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

def get_dimension_scale; end

#get_font_scale ⇒ Float Also known as: font_scale

Returns the scale factor for displaying fonts, for example for more comfortable editing.

Returns:

  • (Float) 


80
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 80

def get_font_scale; end

#get_font_table ⇒ Wx::RTC::RichTextFontTable Also known as: font_table

Returns the table storing fonts, for quick access and font reuse.

Returns:



63
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 63

def get_font_table; end

#get_handler_flags ⇒ Integer Also known as: handler_flags

Gets the handler flags, controlling loading and saving.

Returns:

  • (Integer) 


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

def get_handler_flags; end

#get_scale ⇒ Float Also known as: scale

Returns the scale factor for calculating dimensions.

Returns:

  • (Float) 


520
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 520

def get_scale; end

#get_style_sheet ⇒ Wx::RTC::RichTextStyleSheet Also known as: style_sheet

Returns the style sheet.

Returns:



43
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 43

def get_style_sheet; end

#get_style_stack_size ⇒ Integer Also known as: style_stack_size

Returns the size of the style stack, for example to check correct nesting.

Returns:

  • (Integer) 


211
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 211

def get_style_stack_size; 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:



442
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 442

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

#init ⇒ void

This method returns an undefined value.

Initialisation.



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

def init; end

#insert_image_with_undo(pos, imageBlock, ctrl, flags = 0, textAttr = (Wx::RichTextAttr.new())) ⇒ Boolean

Submits a command to insert the given image.

Parameters:

Returns:

  • (Boolean) 


483
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 483

def insert_image_with_undo(pos, imageBlock, ctrl, flags=0, textAttr=(Wx::RichTextAttr.new())) end

#insert_newline_with_undo(pos, ctrl, flags = 0) ⇒ Boolean

Submits a command to insert a newline.

Parameters:

Returns:

  • (Boolean) 


474
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 474

def insert_newline_with_undo(pos, ctrl, flags=0) end

#insert_object_with_undo(pos, object, ctrl, flags) ⇒ Wx::RTC::RichTextObject

Submits a command to insert an object.

Parameters:

Returns:



491
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 491

def insert_object_with_undo(pos, object, ctrl, flags) end

#insert_paragraphs_with_undo(pos, paragraphs, ctrl, flags = 0) ⇒ Boolean

Submits a command to insert paragraphs.

Parameters:

Returns:

  • (Boolean) 


459
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 459

def insert_paragraphs_with_undo(pos, paragraphs, ctrl, flags=0) end

#insert_text_with_undo(pos, text, ctrl, flags = 0) ⇒ Boolean

Submits a command to insert the given text.

Parameters:

Returns:

  • (Boolean) 


467
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 467

def insert_text_with_undo(pos, text, ctrl, flags=0) end

#is_modified ⇒ Boolean Also known as: modified?

Returns true if the buffer was modified.

Returns:

  • (Boolean) 


506
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 506

def is_modified; end

#load_file(filename, type = Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) ⇒ Boolean #load_file(stream, type = Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) ⇒ Boolean

Overloads:

  • #load_file(filename, type = Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) ⇒ Boolean

    Loads content from a stream or file.

    Not all handlers will implement file loading.

    Parameters:

    • filename (String)
    • type (Wx::RichTextFileType) (defaults to: Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)

    Returns:

    • (Boolean)
  • #load_file(stream, type = Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) ⇒ Boolean

    Parameters:

    • stream (Wx::InputStream)
    • type (Wx::RichTextFileType) (defaults to: Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)

    Returns:

    • (Boolean) 


115
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 115

def load_file(*args) end

#modify(modify = true) ⇒ void

This method returns an undefined value.

Mark modified.

Parameters:

  • modify (Boolean) (defaults to: true) 


502
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 502

def modify(modify=true) end

#paste_from_clipboard(position) ⇒ Boolean

Paste the clipboard content to the buffer.

Parameters:

  • position (Integer)

Returns:

  • (Boolean) 


185
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 185

def paste_from_clipboard(position) end

#pop_style_sheet ⇒ Wx::RTC::RichTextStyleSheet

Pops the style sheet from the top of the style sheet stack.

Returns:



59
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 59

def pop_style_sheet; end

#push_style_sheet(styleSheet) ⇒ Boolean

Pushes the style sheet to the top of the style sheet stack.

Parameters:

Returns:

  • (Boolean) 


55
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 55

def push_style_sheet(styleSheet) end

#remove_event_handler(handler, deleteHandler = false) ⇒ Boolean

Removes an event handler from the buffer’s list of handlers, deleting the object if deleteHandler is true.

Parameters:

  • handler (Wx::EvtHandler)
  • deleteHandler (Boolean) (defaults to: false)

Returns:

  • (Boolean) 


417
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 417

def remove_event_handler(handler, deleteHandler=false) end

#reset_and_clear_commands ⇒ void

This method returns an undefined value.

Clears the buffer, adds an empty paragraph, and clears the command processor.



102
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 102

def reset_and_clear_commands; end

#save_file(filename, type = Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) ⇒ Boolean #save_file(stream, type = Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) ⇒ Boolean

Overloads:

  • #save_file(filename, type = Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) ⇒ Boolean

    Saves content to a stream or file.

    Not all handlers will implement file saving.

    Parameters:

    • filename (String)
    • type (Wx::RichTextFileType) (defaults to: Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)

    Returns:

    • (Boolean)
  • #save_file(stream, type = Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) ⇒ Boolean

    Parameters:

    • stream (Wx::OutputStream)
    • type (Wx::RichTextFileType) (defaults to: Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)

    Returns:

    • (Boolean) 


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

def save_file(*args) end

#send_event(event, sendToAll = true) ⇒ Boolean

Send event to event handlers.

If sendToAll is true, will send to all event handlers, otherwise will stop at the first successful one.

Parameters:

  • event (Wx::Event)
  • sendToAll (Boolean) (defaults to: true)

Returns:

  • (Boolean) 


429
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 429

def send_event(event, sendToAll=true) end

#set_dimension_scale(dimScale) ⇒ void Also known as: dimension_scale=

This method returns an undefined value.

Sets the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.

This can be useful when editing in a small control where you still want legible text, but a minimum of wasted white space.

Parameters:

  • dimScale (Float) 


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

def set_dimension_scale(dimScale) end

#set_font_scale(fontScale) ⇒ void Also known as: font_scale=

This method returns an undefined value.

Sets the scale factor for displaying fonts, for example for more comfortable editing.

Parameters:

  • fontScale (Float) 


75
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 75

def set_font_scale(fontScale) end

#set_font_table(table) ⇒ void Also known as: font_table=

This method returns an undefined value.

Sets table storing fonts, for quick access and font reuse.

Parameters:



69
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 69

def set_font_table(table) end

#set_handler_flags(flags) ⇒ void Also known as: handler_flags=

This method returns an undefined value.

Sets the handler flags, controlling loading and saving.

Parameters:

  • flags (Integer) 


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

def set_handler_flags(flags) end

#set_scale(scale) ⇒ void Also known as: scale=

This method returns an undefined value.

Sets the scale factor for calculating dimensions.

Parameters:

  • scale (Float) 


526
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 526

def set_scale(scale) end

#set_style_sheet(styleSheet) ⇒ void Also known as: style_sheet=

This method returns an undefined value.

Sets style sheet, if any.

This will allow the application to use named character and paragraph styles found in the style sheet. Neither the buffer nor the control owns the style sheet so must be deleted by the application.

Parameters:



38
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 38

def set_style_sheet(styleSheet) end

#set_style_sheet_and_notify(sheet) ⇒ Boolean Also known as: style_sheet_and_notify=

Sets the style sheet and sends a notification of the change.

Parameters:

Returns:

  • (Boolean) 


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

def set_style_sheet_and_notify(sheet) end

#suppressing_undo ⇒ Boolean

Are we suppressing undo??

Returns:

  • (Boolean) 


175
 
# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 175

def suppressing_undo; end