Platforms to show: All Mac Windows Linux Cross-Platform

Back to DesktopScintillaControlMBS control.

DesktopScintillaControlMBS.AutoCompleteCancelled

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Auto complete was cancelled.

DesktopScintillaControlMBS.AutoCompleteCharacterDeleted

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
The user deleted a character while autocompletion list was active.

DesktopScintillaControlMBS.AutoCompleteCompleted(Position as Integer, Character as Integer, Text as String, listCompletionMethod as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This event is generated after an autocompletion has inserted its text.

ParameterDescription
positionThe start position of the word being completed.
textThe text of the selection.
CharacterIf a fillup character was the method of selection, the used character, otherwise 0.
listCompletionMethodA value indicating the way in which the completion occurred. See the table below.

SymbolValueMeaning
kCompletionMethodsFillUp1A fillup character triggered the completion. The character used is in Character.
kCompletionMethodsDoubleClick2A double-click triggered the completion. Character is 0.
kCompletionMethodsTab3The tab key or Tab method triggered the completion. Character is 0.
kCompletionMethodsNewline4A new line or Newline method triggered the completion. Character is 0.
kCompletionMethodsCommand5The AutoCSelect method triggered the completion. Character is 0.

DesktopScintillaControlMBS.AutoCompleteSelection(Position as Integer, Character as Integer, Text as String, listCompletionMethod as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
The user has selected an item in an autocompletion list.

The event is sent before the selection is inserted. Automatic insertion can be cancelled by calling AutoCCancel method before returning from the event.

ParameterDescription
positionThe start position of the word being completed.
textThe text of the selection.
CharacterIf a fillup character was the method of selection, the used character, otherwise 0.
listCompletionMethodA value indicating the way in which the completion occurred. See the table below.

SymbolValueMeaning
kCompletionMethodsFillUp1A fillup character triggered the completion. The character used is in Character.
kCompletionMethodsDoubleClick2A double-click triggered the completion. Character is 0.
kCompletionMethodsTab3The tab key or Tab method triggered the completion. Character is 0.
kCompletionMethodsNewline4A new line or Newline method triggered the completion. Character is 0.
kCompletionMethodsCommand5The AutoCSelect method triggered the completion. Character is 0.

DesktopScintillaControlMBS.AutoCompleteSelectionChange(Position as Integer, Text as String, listType as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This event is sent when items are highlighted in an autocompletion or user list.

FieldUsage
listTypeThis is set to the listType parameter from the SCI_USERLISTSHOW message or 0 for an autocompletion.
textThe text of the selection.
positionThe position the list was displayed at.

DesktopScintillaControlMBS.CallTipClick(Position as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This event is generated when the user clicks on a calltip.

This event can be used to display the next function prototype when a function name is overloaded with different arguments. The position field is set to 1 if the click is in an up arrow, 2 if in a down arrow, and 0 if elsewhere.

DesktopScintillaControlMBS.CharacterAdded(Character as Integer, CharacterSource as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This is sent when the user types an ordinary text character (as opposed to a command character) that is entered into the text.

The container can use this to decide to display a call tip or an auto completion list.
For single byte character sets, this is the byte value of the character; for UTF-8, it is the Unicode code point; for DBCS, it is (first byte * 256 + second byte) for 2 byte characters and the byte value for 1 byte characters. This notification is sent before the character has been styled so processing that depends on styling should instead be performed in the UpdateUI event.

SymbolValueMeaning
kCharacterSourceDirectInput0Direct input characters, including characters generated by calling keyboard commands like NewLine method.
kCharacterSourceTentativeInput1Tentative input characters. They are used by IME (inline mode, see IMEInteraction) to composite final string, normally different from final composited string (which is the string that has been truly added into current document), and may be withdrawn when the user cancels typing (e.g. by pressing Esc key). Some system (at least Cocoa) also use tentative input for non-IME features like using dead key to composite diacritical marks (grave accent, etc.). These characters are not added to macro recording. Most applications can simply ignore the notification when this value is set.
kCharacterSourceImeResult2IME (either inline or windowed mode) full composited string. Modern IME is able to composite English word or sentence, when this value is set, current character may not a Chinese, Japanese or Korean character. Currently, this is only set on Windows.

DesktopScintillaControlMBS.Closing

Type Topic Version
event Scintilla 22.0

The control is about to close.
In older Xojo versions, this event is named Close.

DesktopScintillaControlMBS.ConstructContextualMenu(base as DesktopMenuItem, x as Integer, y as Integer) As Boolean

Type Topic Version
event Scintilla 22.1
This event is called when it is appropriate to display a contextual menu for the control.

DesktopScintillaControlMBS.ContextualMenuItemSelected(selectedItem As DesktopMenuItem) As Boolean

Type Topic Version
event Scintilla 22.0
Called when a menuitem is choosen.

This allows the control to react on its relevant menu items. Please return true if you handled it or false to give others a chance.

You can use UsePopUp(kPopUpNever) to disable the contextual menu from Scintilla and use Xojo menus.

DesktopScintillaControlMBS.DoubleClick(Position as Integer, line as integer, modifiers as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
The mouse button was double clicked in editor.

The position parameter is set to the text position of the double click, the line parameter is set to the line of the double click, and the modifiers parameter is set to the key modifiers held down in a similar manner to Key event.

DesktopScintillaControlMBS.DWellEnd(Position as Integer, X as Integer, Y as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
DWellEnd is generated after a DWellStart and the mouse is moved or other activity such as key press indicates the dwell is over.

DesktopScintillaControlMBS.DWellStart(Position as Integer, X as Integer, Y as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
DWellStart is generated when the user keeps the mouse in one position for the dwell period (see MouseDwellTime).

DesktopScintillaControlMBS.FocusIn

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This event is raised when Scintilla receives focus.

While the control can have a focus from the Xojo point of view, this event informs you that the actual text control part got focus.

So the Xojo wrapper control can have a focus and within it the text control can than have a focus and there are two different states.

DesktopScintillaControlMBS.FocusLost

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No

The control lost focus.
In older Xojo versions, this event is named LostFocus.

DesktopScintillaControlMBS.FocusOut

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This event is raised when it loses focus.

DesktopScintillaControlMBS.FocusReceived

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No

The control got focus.
In older Xojo versions, this event is named GotFocus.

DesktopScintillaControlMBS.FolderToggled(Line as Integer, Position as Integer, Margin as ScintillaMarginMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
A folder was toggled due to a mouse click.

THis is called when a folder is hit.
MarginClicked event will also be raised.

DesktopScintillaControlMBS.HotSpotClick(Position as Integer, modifiers as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
These event are generated when the user clicks on text that is in a style with the hotspot attribute set.

This event can be used to link to variable definitions or web pages. In the notification handler, you should avoid calling any function that modifies the current selection or caret position. The position parameter is set the text position of the click or double click and the modifiers field set to the key modifiers held down in a similar manner to Key event. Only the state of the Ctrl key is reported for HotspotReleaseClick.

DesktopScintillaControlMBS.HotSpotDoubleCLick(Position as Integer, modifiers as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
These event are generated when the user double clicks on text that is in a style with the hotspot attribute set.

This event can be used to link to variable definitions or web pages. In the notification handler, you should avoid calling any function that modifies the current selection or caret position. The position parameter is set the text position of the double click and the modifiers field set to the key modifiers held down in a similar manner to Key event. Only the state of the Ctrl key is reported for HotspotReleaseClick.

DesktopScintillaControlMBS.HotspotReleaseClick(Position as Integer, modifiers as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
These event are generated when the user clicks on text that is in a style with the hotspot attribute set.

DesktopScintillaControlMBS.IndicatorClick(Position as Integer, modifiers as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
These event is generated when the user clicks the mouse on text that has an indicator.

The position parameter is set the text position of the click or double click and the modifiers field set to the key modifiers held down in a similar manner to Key.

DesktopScintillaControlMBS.IndicatorRelease(Position as Integer, modifiers as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
These event is generated when the user releases the mouse on text that has an indicator.

The position parameter is set the text position of the click or double click and the modifiers field set to the key modifiers held down in a similar manner to Key.

DesktopScintillaControlMBS.Key(Character as Integer, modifiers as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Reports all keys pressed but not consumed by Scintilla.

Used on GTK because of some problems with keyboard focus and is not sent by the Windows version. Character holds the key code and modifiers holds the modifier flags. This notification is sent if the modifiers include kKeyModAlt or kKeyModCtrl and the key code is less than 256.

DesktopScintillaControlMBS.MacroRecord(Message as Integer, wParam as Integer, lParam as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
The event for a new macro step to record.

The StartRecord and StopRecord method enable and disable macro recording. When enabled, each time a recordable change occurs, the MacroRecord event is sent to the container. It is up to the container to record the action. To see the complete list of SCI_* messages that are recordable, search the Scintilla source Editor.cxx for Editor::NotifyMacroRecord.

FieldUsage
messageThe SCI_* message that caused the notification.
wParamThe value of wParam in the SCI_* message.
lParamThe value of lParam in the SCI_* message.

DesktopScintillaControlMBS.MarginClick(Position as Integer, modifiers as Integer, margin as ScintillaMarginMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This event tell the container that the mouse was left clicked inside a margin that was marked as sensitive.

This can be used to perform folding or to place breakpoints.

FieldUsage
modifiersThe appropriate combination of kKeyModShift, kKeyModCtrl and kKeyModAlt to indicate the keys that were held down at the time of the margin click.
positionThe position of the start of the line in the document that corresponds to the margin click.
marginThe margin number that was clicked.

DesktopScintillaControlMBS.MarginRightClick(Position as Integer, modifiers as Integer, margin as ScintillaMarginMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This event tell the container that the mouse was right clicked inside a margin that was marked as sensitive.

This can be used to perform folding or to place breakpoints.

FieldUsage
modifiersThe appropriate combination of kKeyModShift, kKeyModCtrl and kKeyModAlt to indicate the keys that were held down at the time of the margin click.
positionThe position of the start of the line in the document that corresponds to the margin click.
marginThe margin number that was clicked.

DesktopScintillaControlMBS.MenuBarSelected

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No

The event where you can enable menu items.
In older Xojo versions, this event is named EnableMenuItems.

DesktopScintillaControlMBS.Modified(Position as Integer, modificationType as Integer, Text as String, length as Integer, linesAdded as Integer, line as Integer, foldLevelNow as Integer, foldLevelPrev as Integer, token as Integer, annotationLinesAdded as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This notification is sent when the text or styling of the document changes or is about to change.

You can set a mask for the notifications that are sent to the container with ModEventMask. The parameters contains information about what changed, how the change occurred and whether this changed the number of lines in the document. No modifications may be performed while in a Modified event.

ParameterUsage
modificationTypeA set of flags that identify the change(s) made. See the next table.
positionStart position of a text or styling change. Set to 0 if not used.
lengthLength of the change in bytes when the text or styling changes. Set to 0 if not used.
linesAddedNumber of added lines. If negative, the number of deleted lines. Set to 0 if not used or no lines added or deleted.
textValid for text changes, not for style changes. If we are collecting undo information this holds a pointer to the text that is handed to the Undo system, otherwise it is zero. For user performed SC_MOD_BEFOREDELETE the text field is 0.
lineThe line number at which a fold level or marker change occurred. This is 0 if unused and may be -1 if more than one line changed.
foldLevelNowThe new fold level applied to the line or 0 if this parameter is unused.
foldLevelPrevThe previous folding level of the line or 0 if this parameter is unused.

The modificationType field has bits set to tell you what has been done. The kModificationFlags* constants bits correspond to actions. They tell you if the action was done by the user, or the result of Undo or Redo of a previous action.

SymbolValueMeaningParameters
kModificationFlagsNone0Base value with no fields valid. Will not occur but is useful in tests.
kModificationFlagsInsertText1Text has been inserted into the document.position, length, text, linesAdded
kModificationFlagsDeleteText2Text has been removed from the document.position, length, text, linesAdded
kModificationFlagsChangeStyle4A style change has occurred.position, length
kModificationFlagsChangeFold8A folding change has occurred.line, foldLevelNow, foldLevelPrev
kModificationFlagsUser&h10Information: the operation was done by the user.None
kModificationFlagsUndo&h20Information: this was the result of an Undo.None
kModificationFlagsRedo&h40Information: this was the result of a Redo.None
kModificationFlagsMultiStepUndoRedo&h80This is part of a multi-step Undo or Redo transaction.None
kModificationFlagsLastStepInUndoRedo&h100This is the final step in an Undo or Redo transaction.None
kModificationFlagsChangeMarker&h200One or more markers has changed in a line.line
kModificationFlagsBeforeInsert&h400Text is about to be inserted into the document.position, if performed by user then text in bytes, length in bytes
kModificationFlagsBeforeDelete&h800Text is about to be deleted from the document.position, length
kModificationFlagsChangeIndicator&h4000An indicator has been added or removed from a range of text.position, length
kModificationFlagsChangeLineState&h8000A line state has changed because LineState was set.line
kModificationFlagsChangeTabStops&h200000The explicit tab stops on a line have changed because ClearTabstops or AddTabStop was called.line
kModificationFlagsLexerState&h80000The internal state of a lexer has changed over a range.position, length
kModificationFlagsChangeMargin&h10000A text margin has changed.line
kModificationFlagsChangeAnnotation&h20000An annotation has changed.line
kModificationFlagsInsertCheck&h100000Text is about to be inserted. The handler may change the text being inserted by calling SCI_CHANGEINSERTION. No other modifications may be made in this handler.position, length, text
kModificationFlagsMultilineUndoRedo&h1000This is part of an Undo or Redo with multi-line changes.None
kModificationFlagsStartAction&h2000This is set on a SC_PERFORMED_USER action when it is the first or only step in an undo transaction. This can be used to integrate the Scintilla undo stack with an undo stack in the container application by adding a Scintilla action to the container's stack for the currently opened container transaction or to open a new container transaction if there is no open container transaction.None
KModificationFlagsContainer&h40000This is set on for actions that the container stored into the undo stack with AddUndoAction.token
kModificationFlagsEventMaskAll&h1FFFFFThis is a mask for all valid flags. This is the default mask state set by ModEventMask.None

DesktopScintillaControlMBS.ModifyAttemptReadOnly

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
When in read-only mode, this notification is sent to the container if the user tries to change the text.

This can be used to check the document out of a version control system. You can set the read-only state of a document with ReadOnly property.

DesktopScintillaControlMBS.NeedsShown(Position as Integer, length as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Scintilla has determined that a range of lines that is currently invisible should be made visible.
Example
sub NeedsShown(Position as Integer)
dim firstLine as Integer = LineFromPosition(me.position)
dim lastLine as Integer = LineFromPosition(me.position+me.length-1)
for line as integer = firstLine to lastLine
me.EnsureVisible(line)
next
end sub

An example of where this may be needed is if the end of line of a contracted fold point is deleted. This message is sent to the container in case it wants to make the line visible in some unusual way such as making the whole document visible. Most containers will just ensure each line in the range is visible by calling EnsureVisible. The position and length fields of SCNotification indicate the range of the document that should be made visible.

The container code will be similar to the following code skeleton in the example above.
If the event is not implemented, we do similar automatically.

DesktopScintillaControlMBS.Opening

Type Topic Version
event Scintilla 22.0

The control is about to was created and you can initialize it.
In older Xojo versions, this event is named Open.

DesktopScintillaControlMBS.Painted

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Painting has just been done.

Useful when you want to update some other widgets based on a change in Scintilla, but want to have the paint occur first to appear more responsive.

DesktopScintillaControlMBS.Prepare

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.4 ✅ Yes ✅ Yes ✅ Yes ❌ No
The prepare event.

Called before we create the control, so you can change properties like HasBorder.

DesktopScintillaControlMBS.SavePointLeft

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Sent to the container when the save point is entered or left, allowing the container to display a "document dirty" indicator and change its menus.

DesktopScintillaControlMBS.SavePointReached

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Sent to the container when the save point is entered or left, allowing the container to display a "document dirty" indicator and change its menus.

DesktopScintillaControlMBS.ScaleFactorChanged(NewFactor as double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
The backing store scale factor has changed.

Please invalidate any cached bitmaps or other relevant state.

DesktopScintillaControlMBS.SelectionChanged(updated as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Selection changed.

If content is changed or selection, this event is fired.

The UpdateUI event will also be called.

DesktopScintillaControlMBS.StyleNeeded(Position as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Queries you to provide style information.
Example
// sample event to color digits

Sub StyleNeeded(Position as Integer) Handles StyleNeeded
#pragma BackgroundTasks false

Dim startPos As Integer = Me.EndStyled
Dim lineNumber As Integer = Me.LineFromPosition(startPos)
Dim LineStartPos As Integer = Me.PositionFromLine(lineNumber)

System.DebugLog "Style at "+Position.ToString+" from "+LineStartPos.ToString+" to "+position.ToString

Dim t As String = Me.Text
Dim pos As Integer = LineStartPos

While pos < position

Dim ch As Integer = t.Middle(pos, 1).Asc

If ch >= 48 And ch <= 57 Then
// digit
Me.SetStyling(pos, 1, Me.Style(2))
end if

pos = pos + 1
Wend
End Sub

If you used no explicit lexer to make the container act as the lexer, you will receive this notification when Scintilla is about to display or print text that requires styling.

You are required to style the text from the line that contains the position returned by EndStyled up to the position passed in position. Symbolically, you need code of the form:

startPos = me.EndStyled
lineNumber = LineFromPosition(startPos)
startPos = PositionFromLine(lineNumber)
ApplyStyles(startPos, position)

DesktopScintillaControlMBS.TextChanged(Position as Integer, modificationType as Integer, Text as String, length as Integer, linesAdded as Integer, line as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Text changed.

Our plugin calls this to inform you about a text change.
No modifications may be performed while in a Modified event.
Modified event will also be raised.

DesktopScintillaControlMBS.UpdateUI(updated as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Either the text or styling of the document has changed or the selection range or scroll position may have changed.

Now would be a good time to update any container UI elements that depend on document or view state. As it is sometimes difficult to determine whether a change has occurred, these events may also fire when there has been no actual change. The updated field is set to the bit set of things changed since the previous notification.

See kUpdate* constants.

DesktopScintillaControlMBS.URIDropped(text as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
Indicates that the user has dragged a URI such as a file name or Web address onto Scintilla.

The container could interpret this as a request to open the file.

DesktopScintillaControlMBS.UserListSelection(Position as Integer, Character as Integer, Text as String, listType as Integer, listCompletionMethod as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
The user has selected an item in a user list.

FieldUsage
listTypeThis is set to the listType parameter from the UserListShow message that initiated the list.
textThe text of the selection.
positionThe position the list was displayed at.
CharacterIf a fillup character was the method of selection, the used character, otherwise 0.
listCompletionMethodA value indicating the way in which the completion occurred.

DesktopScintillaControlMBS.Zoom

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No
This event is generated when the user zooms the display using the keyboard or the Zoom method is called.

This event can be used to recalculate positions, such as the width of the line number margin to maintain sizes in terms of characters rather than pixels.

See also:

The items on this page are in the following plugins: MBS Scintilla Plugin.


The biggest plugin in space...