Refer wxSTC documnentation to wxStyledTextEvent page

The current wxSTC documentation page currently has a bare listing of the
event types defined for wxStyledTextEvent. These event types are
completely documented on the wxStyledTextEvent page. However the bare
listing on the wxSTC page can lead to the conclusion that there is no
documentation for the event types.

Remove the bare listing from the wxSTC page and replace it with a
referral to the wxStyledTextEvent page. This is consistent with other
large classes such as wxGrid and wxRichTextCtrl that separate the
documentation for their methods and events.
This commit is contained in:
New Pagodi
2019-07-13 12:56:21 -05:00
parent 67825e42f7
commit 3ce4a89c06
2 changed files with 6 additions and 160 deletions

View File

@@ -2777,6 +2777,9 @@
wxStyledTextCtrl is a 1 to 1 mapping of "raw" scintilla interface, whose
documentation can be found in the Scintilla website (http://www.scintilla.org/).
Please see wxStyledTextEvent for the documentation of all event types you
can use with wxStyledTextCtrl.
@section stc_index Index of the member groups
@@ -2830,86 +2833,6 @@
- @ref_member_group{text_entry, Text entry methods}
- @ref_member_group{text_area, Text area methods}
@section event_list Events
@beginEventEmissionTable{wxStyledTextEvent}
@event{EVT_STC_AUTOCOMP_CANCELLED(id, fn)}
Process a @c wxEVT_STC_AUTOCOMP_CANCELLED event.
@event{EVT_STC_AUTOCOMP_CHAR_DELETED(id, fn)}
Process a @c wxEVT_STC_AUTOCOMP_CHAR_DELETED event.
@event{EVT_STC_AUTOCOMP_COMPLETED(id, fn)}
Process a @c wxEVT_STC_AUTOCOMP_COMPLETED event.
@since 3.1.1
@event{EVT_STC_AUTOCOMP_SELECTION(id, fn)}
Process a @c wxEVT_STC_AUTOCOMP_SELECTION event.
@event{EVT_STC_CALLTIP_CLICK(id, fn)}
Process a @c wxEVT_STC_CALLTIP_CLICK event.
@event{EVT_STC_CHANGE(id, fn)}
Process a @c wxEVT_STC_CHANGE event.
@event{EVT_STC_CHARADDED(id, fn)}
Process a @c wxEVT_STC_CHARADDED event.
@event{EVT_STC_CLIPBOARD_COPY(id, fn)}
Process a @c wxEVT_STC_CLIPBOARD_COPY event.
@since 3.1.0
@event{EVT_STC_CLIPBOARD_PASTE(id, fn)}
Process a @c wxEVT_STC_CLIPBOARD_PASTE event.
@since 3.1.0
@event{EVT_STC_DO_DROP(id, fn)}
Process a @c wxEVT_STC_DO_DROP event.
@event{EVT_STC_DOUBLECLICK(id, fn)}
Process a @c wxEVT_STC_DOUBLECLICK event.
@event{EVT_STC_DRAG_OVER(id, fn)}
Process a @c wxEVT_STC_DRAG_OVER event.
@event{EVT_STC_DWELLEND(id, fn)}
Process a @c wxEVT_STC_DWELLEND event.
@event{EVT_STC_DWELLSTART(id, fn)}
Process a @c wxEVT_STC_DWELLSTART event.
@event{EVT_STC_HOTSPOT_CLICK(id, fn)}
Process a @c wxEVT_STC_HOTSPOT_CLICK event.
@event{EVT_STC_HOTSPOT_DCLICK(id, fn)}
Process a @c wxEVT_STC_HOTSPOT_DCLICK event.
@event{EVT_STC_HOTSPOT_RELEASE_CLICK(id, fn)}
Process a @c wxEVT_STC_HOTSPOT_RELEASE_CLICK event.
@event{EVT_STC_INDICATOR_CLICK(id, fn)}
Process a @c wxEVT_STC_INDICATOR_CLICK event.
@event{EVT_STC_INDICATOR_RELEASE(id, fn)}
Process a @c wxEVT_STC_INDICATOR_RELEASE event.
@event{EVT_STC_MACRORECORD(id, fn)}
Process a @c wxEVT_STC_MACRORECORD event.
@event{EVT_STC_MARGIN_RIGHT_CLICK(id, fn)}
Process a @c wxEVT_STC_MARGIN_RIGHT_CLICK event.
@since 3.1.1
@event{EVT_STC_MARGINCLICK(id, fn)}
Process a @c wxEVT_STC_MARGINCLICK event.
@event{EVT_STC_MODIFIED(id, fn)}
Process a @c wxEVT_STC_MODIFIED event.
@event{EVT_STC_NEEDSHOWN(id, fn)}
Process a @c wxEVT_STC_NEEDSHOWN event.
@event{EVT_STC_PAINTED(id, fn)}
Process a @c wxEVT_STC_PAINTED event.
@event{EVT_STC_ROMODIFYATTEMPT(id, fn)}
Process a @c wxEVT_STC_ROMODIFYATTEMPT event.
@event{EVT_STC_SAVEPOINTLEFT(id, fn)}
Process a @c wxEVT_STC_SAVEPOINTLEFT event.
@event{EVT_STC_SAVEPOINTREACHED(id, fn)}
Process a @c wxEVT_STC_SAVEPOINTREACHED event.
@event{EVT_STC_START_DRAG(id, fn)}
Process a @c wxEVT_STC_START_DRAG event.
@event{EVT_STC_STYLENEEDED(id, fn)}
Process a @c wxEVT_STC_STYLENEEDED event.
@event{EVT_STC_UPDATEUI(id, fn)}
Process a @c wxEVT_STC_UPDATEUI event.
@event{EVT_STC_USERLISTSELECTION(id, fn)}
Process a @c wxEVT_STC_USERLISTSELECTION event.
@event{EVT_STC_ZOOM(id, fn)}
Process a @c wxEVT_STC_ZOOM event.
@endEventTable
@library{wxstc}
@category{stc}