wxRichTextEvent Class Reference
[EventsRich Text]

#include <wx/richtext/richtextctrl.h>

Inheritance diagram for wxRichTextEvent:
Inheritance graph
[legend]

Detailed Description

This is the event class for wxRichTextCtrl notifications.

Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxRichTextEvent& event)

Event macros:

Library:  wxRichText
Category:  Events, Rich Text

Public Member Functions

 wxRichTextEvent (const wxRichTextEvent &event)
 Copy constructor.
 wxRichTextEvent (wxEventType commandType=wxEVT_NULL, int id=0)
 Constructor.
wxChar GetCharacter () const
 Returns the character pressed, within a wxEVT_COMMAND_RICHTEXT_CHARACTER event.
int GetFlags () const
 Returns flags indicating modifier keys pressed.
wxRichTextStyleSheetGetNewStyleSheet () const
 Returns the new style sheet.
wxRichTextStyleSheetGetOldStyleSheet () const
 Returns the old style sheet.
long GetPosition () const
 Returns the buffer position at which the event occured.
const wxRichTextRangeGetRange () const
 Gets the range for the current operation.
void SetCharacter (wxChar ch)
 Sets the character variable.
void SetFlags (int flags)
 Sets flags indicating modifier keys pressed.
void SetNewStyleSheet (wxRichTextStyleSheet *sheet)
 Sets the new style sheet variable.
void SetOldStyleSheet (wxRichTextStyleSheet *sheet)
 Sets the old style sheet variable.
void SetPosition (long pos)
 Sets the buffer position variable.
void SetRange (const wxRichTextRange &range)
 Sets the range variable.

List of all members.


Constructor & Destructor Documentation

wxRichTextEvent::wxRichTextEvent ( const wxRichTextEvent event  ) 

Copy constructor.

wxRichTextEvent::wxRichTextEvent ( wxEventType  commandType = wxEVT_NULL,
int  id = 0 
)

Constructor.

Parameters:
commandType The type of the event.
id Window identifier. The value wxID_ANY indicates a default value.

Member Function Documentation

wxChar wxRichTextEvent::GetCharacter (  )  const

Returns the character pressed, within a wxEVT_COMMAND_RICHTEXT_CHARACTER event.

int wxRichTextEvent::GetFlags (  )  const

Returns flags indicating modifier keys pressed.

Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN.

wxRichTextStyleSheet* wxRichTextEvent::GetNewStyleSheet (  )  const

Returns the new style sheet.

Can be used in a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.

wxRichTextStyleSheet* wxRichTextEvent::GetOldStyleSheet (  )  const

Returns the old style sheet.

Can be used in a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.

long wxRichTextEvent::GetPosition (  )  const

Returns the buffer position at which the event occured.

const wxRichTextRange& wxRichTextEvent::GetRange (  )  const

Gets the range for the current operation.

void wxRichTextEvent::SetCharacter ( wxChar  ch  ) 

Sets the character variable.

void wxRichTextEvent::SetFlags ( int  flags  ) 

Sets flags indicating modifier keys pressed.

Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN.

void wxRichTextEvent::SetNewStyleSheet ( wxRichTextStyleSheet sheet  ) 

Sets the new style sheet variable.

void wxRichTextEvent::SetOldStyleSheet ( wxRichTextStyleSheet sheet  ) 

Sets the old style sheet variable.

void wxRichTextEvent::SetPosition ( long  pos  ) 

Sets the buffer position variable.

void wxRichTextEvent::SetRange ( const wxRichTextRange range  ) 

Sets the range variable.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]