wxStyledTextEvent(3)

📦
version 29.0.6 · 3 versions
, in ubuntu stonking

💅 NAME 💅

okay bestie, meet wxStyledTextEvent — the type of events sent from wxStyledTextCtrl. that's it, that's the whole vibe. this is an Erlang module definition page (yes, the (3) in the corner, iykyk) 🦋

✨ DESCRIPTION ✨

so this class is derived, which means it can use functions from its ancestors too. the nepo baby lineage is:

  • wxCommandEvent
  • wxEvent

also, wxWidgets docs have a whole page for wxStyledTextEvent if you want to go read the source material 📚

🎀 Events 🎀

use wxEvtHandler:connect/3 with wxStyledTextEventType to subscribe to events of this type. that's your whole subscription situation, no cap 🔔

🧁 DATA TYPES 🧁

wxStyledText() :: #wxStyledText{}.

wxStyledTextEvent() :: wx:wx_object().

wxStyledTextEventType() ::
          stc_autocomp_cancelled | stc_autocomp_char_deleted |
          stc_autocomp_selection | stc_calltip_click | stc_change |
          stc_charadded | stc_do_drop | stc_doubleclick |
          stc_drag_over | stc_dwellend | stc_dwellstart |
          stc_hotspot_click | stc_hotspot_dclick |
          stc_hotspot_release_click | stc_indicator_click |
          stc_indicator_release | stc_macrorecord | stc_marginclick |
          stc_modified | stc_needshown | stc_painted |
          stc_romodifyattempt | stc_savepointleft |
          stc_savepointreached | stc_start_drag | stc_styleneeded |
          stc_updateui | stc_userlistselection | stc_zoom.

👑 FUNCTIONS 👑

  • getAlt(This) -> boolean() when This :: wxStyledTextEvent().

returns true if the Alt key is pressed. alt girl behavior honestly.

this method is valid for the following event types:

  • wxEVT_STC_DOUBLECLICK
  • wxEVT_STC_MARGINCLICK
  • wxEVT_STC_HOTSPOT_CLICK
  • wxEVT_STC_HOTSPOT_DCLICK
  • wxEVT_STC_HOTSPOT_RELEASE_CLICK
  • wxEVT_STC_INDICATOR_CLICK
  • wxEVT_STC_INDICATOR_RELEASE
  • wxEVT_STC_MARGIN_RIGHT_CLICK
  • getControl(This) -> boolean() when This :: wxStyledTextEvent().

returns true if the Ctrl key is pressed. control freak (affectionate) 💅

this method is valid for the following event types:

  • wxEVT_STC_DOUBLECLICK
  • wxEVT_STC_MARGINCLICK
  • wxEVT_STC_HOTSPOT_CLICK
  • wxEVT_STC_HOTSPOT_DCLICK
  • wxEVT_STC_HOTSPOT_RELEASE_CLICK
  • wxEVT_STC_INDICATOR_CLICK
  • wxEVT_STC_INDICATOR_RELEASE
  • wxEVT_STC_MARGIN_RIGHT_CLICK
  • getDragAllowMove(This) -> boolean() when This :: wxStyledTextEvent().

basic question, basic answer — no description in the original, so no lore from me either 🙈

  • getDragResult(This) -> wx:wx_enum() when This :: wxStyledTextEvent().

returns the drag result for this event.

this method is valid for wxEVT_STC_DRAG_OVER and wxEVT_STC_DO_DROP events.

  • getDragText(This) -> unicode:charlist() when This :: wxStyledTextEvent().
Deprecated: use wxCommandEvent:getString/1 instead. the old one is giving 2019, we moved on 🫶
  • getFoldLevelNow(This) -> integer() when This :: wxStyledTextEvent().

returns the current fold level for the line.

this method is valid for wxEVT_STC_MODIFIED events when the result of getModificationType/1 includes ?wxSTC_MOD_CHANGEFOLD.

  • getFoldLevelPrev(This) -> integer() when This :: wxStyledTextEvent().

returns the previous fold level for the line. the before picture 📸

this method is valid for wxEVT_STC_MODIFIED events when the result of getModificationType/1 includes ?wxSTC_MOD_CHANGEFOLD.

  • getKey(This) -> integer() when This :: wxStyledTextEvent().

returns the key code of the key that generated this event.

this method is valid for the following event types:

  • wxEVT_STC_CHARADDED
  • wxEVT_STC_USERLISTSELECTION
  • wxEVT_STC_AUTOCOMP_SELECTION
  • wxEVT_STC_AUTOCOMP_COMPLETED
  • getLParam(This) -> integer() when This :: wxStyledTextEvent().

returns the value of the LParam field for this event.

this method is valid for wxEVT_STC_MACRORECORD events.

  • getLength(This) -> integer() when This :: wxStyledTextEvent().

returns the length (number of characters) of this event.

this method is valid for wxEVT_STC_MODIFIED and wxEVT_STC_NEEDSHOWN events.

  • getLine(This) -> integer() when This :: wxStyledTextEvent().

returns the zero-based line number for this event. zero-based, because of course it is 💀

this method is valid for wxEVT_STC_DOUBLECLICK and wxEVT_STC_MODIFIED events.

  • getLinesAdded(This) -> integer() when This :: wxStyledTextEvent().

returns the number of lines added or deleted with this event. yes, it can go negative in spirit, it counts both directions bestie.

this method is valid for wxEVT_STC_MODIFIED events when the result of getModificationType/1 includes ?wxSTC_MOD_INSERTTEXT or ?wxSTC_MOD_DELETETEXT.

  • getListType(This) -> integer() when This :: wxStyledTextEvent().

returns the list type for this event.

the list type is an integer passed to a list when it is created with the wxStyledTextCtrl:userListShow/3 method, and it can be used to distinguish lists if more than one is used. like name tags at a party, but for lists 🎀

this method is valid for wxEVT_STC_AUTOCOMP_SELECTION_CHANGE and wxEVT_STC_USERLISTSELECTION events.

  • getMargin(This) -> integer() when This :: wxStyledTextEvent().

returns the zero-based index of the margin that generated this event.

this method is valid for wxEVT_STC_MARGINCLICK and wxEVT_STC_MARGIN_RIGHT_CLICK events.

  • getMessage(This) -> integer() when This :: wxStyledTextEvent().

returns a message number while a macro is being recorded.

a lot of the wxStyledTextCtrl methods — like wxStyledTextCtrl:insertText/3 and wxStyledTextCtrl:paste/1 — have an event number associated with them. this method returns that number while a macro is being recorded, so the macro can be played back later. it's giving diary entry for future you 📓

this method is valid for wxEVT_STC_MACRORECORD events.

  • getModificationType(This) -> integer() when This :: wxStyledTextEvent().

returns the modification type for this event.

the modification type is a bit list that describes the change that generated this event. it may contain one or more of the following values:

  • ?wxSTC_MOD_INSERTTEXT
  • ?wxSTC_MOD_DELETETEXT
  • ?wxSTC_MOD_CHANGESTYLE
  • ?wxSTC_MOD_CHANGEFOLD
  • ?wxSTC_PERFORMED_USER
  • ?wxSTC_PERFORMED_UNDO
  • ?wxSTC_PERFORMED_REDO
  • ?wxSTC_MULTISTEPUNDOREDO
  • ?wxSTC_LASTSTEPINUNDOREDO
  • ?wxSTC_MOD_CHANGEMARKER
  • ?wxSTC_MOD_BEFOREINSERT
  • ?wxSTC_MOD_BEFOREDELETE
  • ?wxSTC_MULTILINEUNDOREDO
  • ?wxSTC_STARTACTION
  • ?wxSTC_MOD_CHANGEINDICATOR
  • ?wxSTC_MOD_CHANGELINESTATE
  • ?wxSTC_MOD_CHANGEMARGIN
  • ?wxSTC_MOD_CHANGEANNOTATION
  • ?wxSTC_MOD_CONTAINER
  • ?wxSTC_MOD_LEXERSTATE
  • ?wxSTC_MOD_INSERTCHECK
  • ?wxSTC_MOD_CHANGETABSTOPS

this method is valid for wxEVT_STC_MODIFIED events.

  • getModifiers(This) -> integer() when This :: wxStyledTextEvent().

returns the modifiers of the key press or mouse click for this event.

the returned value is a bit list that may contain one or more of the following values:

  • ?wxSTC_KEYMOD_SHIFT
  • ?wxSTC_KEYMOD_CTRL
  • ?wxSTC_KEYMOD_ALT
  • ?wxSTC_KEYMOD_SUPER
  • ?wxSTC_KEYMOD_META

in addition, the value can be checked for equality with ?wxSTC_KEYMOD_NORM to test if no modifiers are present. the clean girl aesthetic of modifiers ✨

this method is valid for the following event types:

  • wxEVT_STC_DOUBLECLICK
  • wxEVT_STC_MARGINCLICK
  • wxEVT_STC_HOTSPOT_CLICK
  • wxEVT_STC_HOTSPOT_DCLICK
  • wxEVT_STC_HOTSPOT_RELEASE_CLICK
  • wxEVT_STC_INDICATOR_CLICK
  • wxEVT_STC_INDICATOR_RELEASE
  • wxEVT_STC_MARGIN_RIGHT_CLICK
  • getPosition(This) -> integer() when This :: wxStyledTextEvent().

returns the zero-based text position associated with this event.

this method is valid for the following event types:

  • wxEVT_STC_STYLENEEDED
  • wxEVT_STC_DOUBLECLICK
  • wxEVT_STC_MODIFIED
  • wxEVT_STC_MARGINCLICK
  • wxEVT_STC_NEEDSHOWN
  • wxEVT_STC_USERLISTSELECTION
  • wxEVT_STC_DWELLSTART
  • wxEVT_STC_DWELLEND
  • wxEVT_STC_HOTSPOT_CLICK
  • wxEVT_STC_HOTSPOT_DCLICK
  • wxEVT_STC_HOTSPOT_RELEASE_CLICK
  • wxEVT_STC_INDICATOR_CLICK
  • wxEVT_STC_INDICATOR_RELEASE
  • wxEVT_STC_CALLTIP_CLICK
  • wxEVT_STC_AUTOCOMP_SELECTION
  • wxEVT_STC_AUTOCOMP_SELECTION_CHANGE
  • wxEVT_STC_AUTOCOMP_COMPLETED
  • wxEVT_STC_MARGIN_RIGHT_CLICK

(yes that's a long list, she's popular, let her cook 👑)

  • getShift(This) -> boolean() when This :: wxStyledTextEvent().

returns true if the Shift key is pressed.

this method is valid for the following event types:

  • wxEVT_STC_DOUBLECLICK
  • wxEVT_STC_MARGINCLICK
  • wxEVT_STC_HOTSPOT_CLICK
  • wxEVT_STC_HOTSPOT_DCLICK
  • wxEVT_STC_HOTSPOT_RELEASE_CLICK
  • wxEVT_STC_INDICATOR_CLICK
  • wxEVT_STC_INDICATOR_RELEASE
  • wxEVT_STC_MARGIN_RIGHT_CLICK
  • getText(This) -> unicode:charlist() when This :: wxStyledTextEvent().
Deprecated: use wxCommandEvent:getString/1 instead. same energy, newer fit. don't @ me, @ the docs 💜
  • getWParam(This) -> integer() when This :: wxStyledTextEvent().

returns the value of the WParam field for this event.

this method is valid for wxEVT_STC_MACRORECORD events.

  • getX(This) -> integer() when This :: wxStyledTextEvent().

returns the X coordinate of the mouse for this event. the horizontal one, for the record.

this method is valid for the following event types:

  • wxEVT_STC_DWELLSTART
  • wxEVT_STC_DWELLEND
  • wxEVT_STC_START_DRAG
  • wxEVT_STC_DRAG_OVER
  • wxEVT_STC_DO_DROP
  • getY(This) -> integer() when This :: wxStyledTextEvent().

returns the Y coordinate of the mouse for this event. vertical bestie, they come as a pair 🫶

this method is valid for the following event types:

  • wxEVT_STC_DWELLSTART
  • wxEVT_STC_DWELLEND
  • wxEVT_STC_START_DRAG
  • wxEVT_STC_DRAG_OVER
  • wxEVT_STC_DO_DROP

and that's the whole page, no notes 💖 this lil manual page comes to you from Ericsson AB, for wx 2.6, and it lives at section wxStyledTextEvent(3) — go forth and subscribe to events, main character 🌈⭐

📦 where this page comes from