wxStyledTextEvent - Functions for wxStyledTextEvent class

wxStyledTextEvent() = wx:wx_object()

       wxStyledText() =
           #wxStyledText{type =
                             wxStyledTextEvent:wxStyledTextEventType(),
                         position = integer(),
                         key = integer(),
                         modifiers = integer(),
                         modificationType = integer(),
                         text = unicode:chardata(),
                         length = integer(),
                         linesAdded = integer(),
                         line = integer(),
                         foldLevelNow = integer(),
                         foldLevelPrev = integer(),
                         margin = integer(),
                         message = integer(),
                         wParam = integer(),
                         lParam = integer(),
                         listType = integer(),
                         x = integer(),
                         y = integer(),
                         dragText = unicode:chardata(),
                         dragAllowMove = boolean(),
                         dragResult = wx:wx_enum()}

       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

       The type of events sent from wxStyledTextCtrl.

       This class is derived (and can use functions) from: wxCommandEventwxEvent

       wxWidgets docs: wxStyledTextEvent

       Use wxEvtHandler:connect/3 with wxStyledTextEventType to subscribe to events of this type.

getPosition(This)->integer()

              Types:

                 This = wxStyledTextEvent()

              Returns the zero-based text position associated this event.

              This method is valid for the following event types:

       getKey(This)->integer()

              Types:

                 This = wxStyledTextEvent()

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

              This method is valid for the following event types:

       getModifiers(This)->integer()

              Types:

                 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:

              In addition, the value can be checked for equality with ?wxSTC_KEYMOD_NORM to test if no modifiers
              are present.

              This method is valid for the following event types:

       getModificationType(This)->integer()

              Types:

                 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:

              This method is valid for wxEVT_STC_MODIFIED events.

       getText(This)->unicode:charlist()

              Types:

                 This = wxStyledTextEvent()

              Deprecated: Use wxCommandEvent:getString/1 instead.

       getLength(This)->integer()

              Types:

                 This = wxStyledTextEvent()

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

              This method is valid for wxEVT_STC_MODIFIED and wxEVT_STC_NEEDSHOWN events.

       getLinesAdded(This)->integer()

              Types:

                 This = wxStyledTextEvent()

              Returns the number of lines added or deleted with this event.

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

       getLine(This)->integer()

              Types:

                 This = wxStyledTextEvent()

              Returns zero-based line number for this event.

              This method is valid for wxEVT_STC_DOUBLECLICK and wxEVT_STC_MODIFIED events.

       getFoldLevelNow(This)->integer()

              Types:

                 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()

              Types:

                 This = wxStyledTextEvent()

              Returns previous fold level for the line.

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

       getMargin(This)->integer()

              Types:

                 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()

              Types:

                 This = wxStyledTextEvent()

              Returns a message number while a macro is being recorded.

              Many    of    the    wxStyledTextCtrl    methods   such   as   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 that the macro can be played back later.

              This method is valid for wxEVT_STC_MACRORECORD events.

       getWParam(This)->integer()

              Types:

                 This = wxStyledTextEvent()

              Returns value of the WParam field for this event.

              This method is valid for wxEVT_STC_MACRORECORD events.

       getLParam(This)->integer()

              Types:

                 This = wxStyledTextEvent()

              Returns the value of the LParam field for this event.

              This method is valid for wxEVT_STC_MACRORECORD events.

       getListType(This)->integer()

              Types:

                 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 can be used to distinguish lists if more  than  one  is
              used.

              This  method  is  valid  for  wxEVT_STC_AUTOCOMP_SELECTION_CHANGE  and wxEVT_STC_USERLISTSELECTION
              events.

       getX(This)->integer()

              Types:

                 This = wxStyledTextEvent()

              Returns the X coordinate of the mouse for this event.

              This method is valid for the following event types:

       getY(This)->integer()

              Types:

                 This = wxStyledTextEvent()

              Returns the Y coordinate of the mouse for this event.

              This method is valid for the following event types:

       getDragText(This)->unicode:charlist()

              Types:

                 This = wxStyledTextEvent()

              Deprecated: Use wxCommandEvent:getString/1 instead.

       getDragAllowMove(This)->boolean()

              Types:

                 This = wxStyledTextEvent()

       getDragResult(This)->wx:wx_enum()

              Types:

                 This = wxStyledTextEvent()

              Returns drag result for this event.

              This method is valid for wxEVT_STC_DRAG_OVER and wxEVT_STC_DO_DROP events.

       getShift(This)->boolean()

              Types:

                 This = wxStyledTextEvent()

              Returns true if the Shift key is pressed.

              This method is valid for the following event types:

       getControl(This)->boolean()

              Types:

                 This = wxStyledTextEvent()

              Returns true if the Control key is pressed.

              This method is valid for the following event types:

       getAlt(This)->boolean()

              Types:

                 This = wxStyledTextEvent()

              Returns true if the Alt key is pressed.

              This method is valid for the following event types:

wxWidgets team.                                     wx 2.1.1                             wxStyledTextEvent(3erl)

       wxStyledTextEvent - Functions for wxStyledTextEvent class