Class: Wx::RTC::RichTextEvent

Inherits:

NotifyEvent

• Object
• Object
• Event
• CommandEvent
• NotifyEvent
• Wx::RTC::RichTextEvent

Defined in:

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

Overview

This is the event class for RichTextCtrl notifications.

Events using this class

The following event-handler methods redirect the events to member method or handler blocks for RichTextEvent events. Event handler methods:

• EvtHandler#evt_richtext_left_click(id, meth = nil, &block): Process a EVT_RICHTEXT_LEFT_CLICK event, generated when the user releases the left mouse button over an object.

• EvtHandler#evt_richtext_right_click(id, meth = nil, &block): Process a EVT_RICHTEXT_RIGHT_CLICK event, generated when the user releases the right mouse button over an object.

• EvtHandler#evt_richtext_middle_click(id, meth = nil, &block): Process a EVT_RICHTEXT_MIDDLE_CLICK event, generated when the user releases the middle mouse button over an object.

• EvtHandler#evt_richtext_left_dclick(id, meth = nil, &block): Process a EVT_RICHTEXT_LEFT_DCLICK event, generated when the user double-clicks an object.

• EvtHandler#evt_richtext_return(id, meth = nil, &block): Process a EVT_RICHTEXT_RETURN event, generated when the user presses the return key. Valid event functions: GetFlags, GetPosition.

• EvtHandler#evt_richtext_character(id, meth = nil, &block): Process a EVT_RICHTEXT_CHARACTER event, generated when the user presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter.

• EvtHandler#evt_richtext_consuming_character(id, meth = nil, &block): Process a EVT_RICHTEXT_CONSUMING_CHARACTER event, generated when the user presses a character key but before it is processed and inserted into the control. Call Veto to prevent normal processing. Valid event functions: GetFlags, GetPosition, GetCharacter, Veto.

• EvtHandler#evt_richtext_delete(id, meth = nil, &block): Process a EVT_RICHTEXT_DELETE event, generated when the user presses the backspace or delete key. Valid event functions: GetFlags, GetPosition.

• EvtHandler#evt_richtext_return(id, meth = nil, &block): Process a EVT_RICHTEXT_RETURN event, generated when the user presses the return key. Valid event functions: GetFlags, GetPosition.

• EvtHandler#evt_richtext_style_changed(id, meth = nil, &block): Process a EVT_RICHTEXT_STYLE_CHANGED event, generated when styling has been applied to the control. Valid event functions: GetPosition, GetRange.

• EvtHandler#evt_richtext_stylesheet_changed(id, meth = nil, &block): Process a EVT_RICHTEXT_STYLESHEET_CHANGING event, generated when the control's stylesheet has changed, for example the user added, edited or deleted a style. Valid event functions: GetRange, GetPosition.

• EvtHandler#evt_richtext_stylesheet_replacing(id, meth = nil, &block): Process a EVT_RICHTEXT_STYLESHEET_REPLACING event, generated when the control's stylesheet is about to be replaced, for example when a file is loaded into the control. Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet.

• EvtHandler#evt_richtext_stylesheet_replaced(id, meth = nil, &block): Process a EVT_RICHTEXT_STYLESHEET_REPLACED event, generated when the control's stylesheet has been replaced, for example when a file is loaded into the control. Valid event functions: GetOldStyleSheet, GetNewStyleSheet.

• EvtHandler#evt_richtext_properties_changed(id, meth = nil, &block): Process a EVT_RICHTEXT_PROPERTIES_CHANGED event, generated when properties have been applied to the control. Valid event functions: GetPosition, GetRange.

• EvtHandler#evt_richtext_content_inserted(id, meth = nil, &block): Process a EVT_RICHTEXT_CONTENT_INSERTED event, generated when content has been inserted into the control. Valid event functions: GetPosition, GetRange.

• EvtHandler#evt_richtext_content_deleted(id, meth = nil, &block): Process a EVT_RICHTEXT_CONTENT_DELETED event, generated when content has been deleted from the control. Valid event functions: GetPosition, GetRange.

• EvtHandler#evt_richtext_buffer_reset(id, meth = nil, &block): Process a EVT_RICHTEXT_BUFFER_RESET event, generated when the buffer has been reset by deleting all content. You can use this to set a default style for the first new paragraph.

• EvtHandler#evt_richtext_selection_changed(id, meth = nil, &block): Process a EVT_RICHTEXT_SELECTION_CHANGED event, generated when the selection range has changed.

• EvtHandler#evt_richtext_focus_object_changed(id, meth = nil, &block): Process a EVT_RICHTEXT_FOCUS_OBJECT_CHANGED event, generated when the current focus object has changed.

Category: Events, Rich Text

Requires:

• USE_RICHTEXT

Instance Method Summary

• #get_character ⇒ String (also: #character)

  Returns the character pressed, within a EVT_RICHTEXT_CHARACTER event.

• #get_container ⇒ Wx::RTC::RichTextParagraphLayoutBox (also: #container)

  Returns the container for which the event is relevant.

• #get_flags ⇒ Integer (also: #flags)

  Returns flags indicating modifier keys pressed.

• #get_new_style_sheet ⇒ Wx::RTC::RichTextStyleSheet (also: #new_style_sheet)

  Returns the new style sheet.

• #get_old_container ⇒ Wx::RTC::RichTextParagraphLayoutBox (also: #old_container)

  Returns the old container, for a focus change event.

• #get_old_style_sheet ⇒ Wx::RTC::RichTextStyleSheet (also: #old_style_sheet)

  Returns the old style sheet.

• #get_position ⇒ Integer (also: #position)

  Returns the buffer position at which the event occurred.

• #get_range ⇒ Range (also: #range)

  Gets the range for the current operation.

• #initialize(*args) ⇒ RichTextEvent constructor

  A new instance of RichTextEvent.

• #set_character(ch) ⇒ void (also: #character=)

  Sets the character variable.

• #set_container(container) ⇒ void (also: #container=)

  Sets the container for which the event is relevant.

• #set_flags(flags) ⇒ void (also: #flags=)

  Sets flags indicating modifier keys pressed.

• #set_new_style_sheet(sheet) ⇒ void (also: #new_style_sheet=)

  Sets the new style sheet variable.

• #set_old_container(container) ⇒ void (also: #old_container=)

  Sets the old container, for a focus change event.

• #set_old_style_sheet(sheet) ⇒ void (also: #old_style_sheet=)

  Sets the old style sheet variable.

• #set_position(pos) ⇒ void (also: #position=)

  Sets the buffer position variable.

• #set_range(range) ⇒ void (also: #range=)

  Sets the range variable.

Methods inherited from NotifyEvent

#allow, #is_allowed, #veto

Methods inherited from CommandEvent

#client_data, #client_data=, #get_client_data, #get_client_object, #get_int, #get_selection, #get_string, #is_checked, #is_selection, #set_client_data, #set_client_object, #set_extra_long, #set_int, #set_string

Methods inherited from Event

#clone, #get_event_category, #get_event_object, #get_event_type, #get_id, #get_skipped, #get_timestamp, #is_command_event, #resume_propagation, #set_event_object, #set_event_type, #set_id, #set_timestamp, #should_propagate, #skip, #stop_propagation

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(commandType = Wx::EVT_NULL, winid = 0) ⇒ Wx::RTC::RichTextEvent #initialize(event) ⇒ Wx::RTC::RichTextEvent

Returns a new instance of RichTextEvent.

Overloads:

• #initialize(commandType = Wx::EVT_NULL, winid = 0) ⇒ Wx::RTC::RichTextEvent

  Constructor.

  Parameters:

  • commandType (Wx::GenericCollapsiblePane::EventType) (defaults to: Wx::EVT_NULL) —

    The type of the event.

  • winid (Integer) (defaults to: 0) —

    Window identifier. The value StandardID::ID_ANY indicates a default value.

• #initialize(event) ⇒ Wx::RTC::RichTextEvent

  Copy constructor.

  Parameters:

  • event (Wx::RTC::RichTextEvent)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 70

def initialize(*args) end

Instance Method Details

#get_character ⇒ String Also known as: character

Returns the character pressed, within a EVT_RICHTEXT_CHARACTER event.

Returns:

• (String)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 137

def get_character; end

#get_container ⇒ Wx::RTC::RichTextParagraphLayoutBox Also known as: container

Returns the container for which the event is relevant.

Returns:

• (Wx::RTC::RichTextParagraphLayoutBox)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 148

def get_container; end

#get_flags ⇒ Integer Also known as: flags

Returns flags indicating modifier keys pressed.

Possible values are Wx::RTC::RICHTEXT_CTRL_DOWN, Wx::RTC::RICHTEXT_SHIFT_DOWN, and Wx::RTC::RICHTEXT_ALT_DOWN.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 87

def get_flags; end

#get_new_style_sheet ⇒ Wx::RTC::RichTextStyleSheet Also known as: new_style_sheet

Returns the new style sheet.

Can be used in a EVT_RICHTEXT_STYLESHEET_CHANGING or EVT_RICHTEXT_STYLESHEET_CHANGED event handler.

Returns:

• (Wx::RTC::RichTextStyleSheet)

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

def get_new_style_sheet; end

#get_old_container ⇒ Wx::RTC::RichTextParagraphLayoutBox Also known as: old_container

Returns the old container, for a focus change event.

Returns:

• (Wx::RTC::RichTextParagraphLayoutBox)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 159

def get_old_container; end

#get_old_style_sheet ⇒ Wx::RTC::RichTextStyleSheet Also known as: old_style_sheet

Returns the old style sheet.

Can be used in a EVT_RICHTEXT_STYLESHEET_CHANGING or EVT_RICHTEXT_STYLESHEET_CHANGED event handler.

Returns:

• (Wx::RTC::RichTextStyleSheet)

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

def get_old_style_sheet; end

#get_position ⇒ Integer Also known as: position

Returns the buffer position at which the event occurred.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 74

def get_position; end

#get_range ⇒ Range Also known as: range

Gets the range for the current operation.

Returns:

• (Range)

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

def get_range; end

#set_character(ch) ⇒ void Also known as: character=

This method returns an undefined value.

Sets the character variable.

Parameters:

• ch (String)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 143

def set_character(ch) end

#set_container(container) ⇒ void Also known as: container=

This method returns an undefined value.

Sets the container for which the event is relevant.

Parameters:

• container (Wx::RTC::RichTextParagraphLayoutBox)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 154

def set_container(container) end

#set_flags(flags) ⇒ void Also known as: flags=

This method returns an undefined value.

Sets flags indicating modifier keys pressed.

Possible values are Wx::RTC::RICHTEXT_CTRL_DOWN, Wx::RTC::RICHTEXT_SHIFT_DOWN, and Wx::RTC::RICHTEXT_ALT_DOWN.

Parameters:

• flags (Integer)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 95

def set_flags(flags) end

#set_new_style_sheet(sheet) ⇒ void Also known as: new_style_sheet=

This method returns an undefined value.

Sets the new style sheet variable.

Parameters:

• sheet (Wx::RTC::RichTextStyleSheet)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 121

def set_new_style_sheet(sheet) end

#set_old_container(container) ⇒ void Also known as: old_container=

This method returns an undefined value.

Sets the old container, for a focus change event.

Parameters:

• container (Wx::RTC::RichTextParagraphLayoutBox)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 165

def set_old_container(container) end

#set_old_style_sheet(sheet) ⇒ void Also known as: old_style_sheet=

This method returns an undefined value.

Sets the old style sheet variable.

Parameters:

• sheet (Wx::RTC::RichTextStyleSheet)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 108

def set_old_style_sheet(sheet) end

#set_position(pos) ⇒ void Also known as: position=

This method returns an undefined value.

Sets the buffer position variable.

Parameters:

• pos (Integer)

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

def set_position(pos) end

#set_range(range) ⇒ void Also known as: range=

This method returns an undefined value.

Sets the range variable.

Parameters:

• range (Range)

# File 'lib/wx/doc/gen/rtc/rich_text_event.rb', line 132

def set_range(range) end