Platforms to show: All Mac Windows Linux Cross-Platform
Back to DesktopScintillaControlMBS control.
DesktopScintillaControlMBS.ModifyAttemptReadOnly
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No |
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 |
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 |
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 |
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 |
DesktopScintillaControlMBS.SavePointReached
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Field | Usage |
listType | This is set to the listType parameter from the UserListShow message that initiated the list. |
text | The text of the selection. |
position | The position the list was displayed at. |
Character | If a fillup character was the method of selection, the used character, otherwise 0. |
listCompletionMethod | A 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 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.