Class: Wx::RTC::RichTextBox
- Inherits:
-
RichTextParagraphLayoutBox
- Object
- Object
- RichTextObject
- RichTextCompositeObject
- RichTextParagraphLayoutBox
- Wx::RTC::RichTextBox
- Defined in:
- lib/wx/doc/gen/rtc/rich_text_box.rb
Overview
This class is untracked and should not be derived from nor instances extended!
This class implements a floating or inline text box, containing paragraphs.
Category: Rich Text
Direct Known Subclasses
Instance Method Summary collapse
-
#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 object.
- #copy(obj) ⇒ void
-
#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_properties_menu_label ⇒ String
(also: #properties_menu_label)
Returns the label to be used for the properties context menu item.
-
#get_xml_node_name ⇒ String
(also: #xml_node_name)
Returns the XML node name of this object.
-
#initialize(*args) ⇒ RichTextBox
constructor
A new instance of RichTextBox.
Methods inherited from RichTextParagraphLayoutBox
#accepts_focus, #add_image, #add_paragraph, #add_paragraphs, #apply_style_sheet, #clear, #clear_list_style, #collect_style, #copy_fragment, #delete_range, #delete_range_with_undo, #do_get_style, #do_invalidate, #do_number_list, #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_style_sheet, #get_text, #get_text_for_range, #get_uncombined_style, #get_visible_line_number, #has_character_attributes, #has_paragraph_attributes, #hit_test, #import_from_xml, #init, #insert_field_with_undo, #insert_fragment, #insert_image_with_undo, #insert_newline_with_undo, #insert_object_with_undo, #insert_paragraphs_with_undo, #insert_text_with_undo, #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, #dump, #each_child, #find_position, #get_child, #get_child_at_position, #get_child_count, #get_children, #get_range_size, #get_text_for_range, #hit_test, #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_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_natural_size, #get_own_range, #get_own_range_if_top_level, #get_parent, #get_parent_container, #get_position, #get_properties, #get_range, #get_range_size, #get_rect, #get_right_margin, #get_selection, #get_text_for_range, #get_top_margin, get_total_margin, #handles_child_selections, #hit_test, #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
Constructor Details
#initialize(parent = nil) ⇒ Wx::RTC::RichTextBox #initialize(obj) ⇒ Wx::RTC::RichTextBox
Returns a new instance of RichTextBox.
33 |
# File 'lib/wx/doc/gen/rtc/rich_text_box.rb', line 33 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.
57 |
# File 'lib/wx/doc/gen/rtc/rich_text_box.rb', line 57 def can_edit_properties; end |
#clone ⇒ Wx::RTC::RichTextObject
Clones the object.
73 |
# File 'lib/wx/doc/gen/rtc/rich_text_box.rb', line 73 def clone; end |
#copy(obj) ⇒ void
This method returns an undefined value.
77 |
# File 'lib/wx/doc/gen/rtc/rich_text_box.rb', line 77 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)
46 |
# File 'lib/wx/doc/gen/rtc/rich_text_box.rb', line 46 def draw(dc, context, range, selection, rect, descent, style) end |
#edit_properties(parent, buffer) ⇒ Boolean
Edits the object’s properties via a GUI.
64 |
# File 'lib/wx/doc/gen/rtc/rich_text_box.rb', line 64 def edit_properties(parent, buffer) end |
#get_properties_menu_label ⇒ String Also known as:
Returns the label to be used for the properties context menu item.
68 |
# File 'lib/wx/doc/gen/rtc/rich_text_box.rb', line 68 def ; 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.
52 |
# File 'lib/wx/doc/gen/rtc/rich_text_box.rb', line 52 def get_xml_node_name; end |