Monkeybread Xojo plugin - NSTextViewMBS class

Platforms to show: All Mac Windows Linux Cross-Platform

NSTextViewMBS class

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
class	Cocoa Controls	MBS MacCocoa Plugin	7.8	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Function: The cocoa text view class.
Notes:
Like the editfield in Xojo.
Should be placed in a scrollview.

You can embed this view in a CustomNSViewMBS to get more events for mouse and keyboard.
Subclass of the NSTextMBS class.

2 events
- event shouldChangeTextInRange(affectedCharRange as NSRangeMBS, replacementString as string) as boolean
- event textViewDidChangeSelection
38 properties
- property acceptsGlyphInfo as boolean
- property allowsDocumentBackgroundColorChange as boolean
- property allowsImageEditing as boolean
- property allowsUndo as boolean
- property AutomaticDashSubstitutionEnabled as boolean
- property AutomaticDataDetectionEnabled as boolean
- property AutomaticLinkDetectionEnabled as boolean
- property AutomaticQuoteSubstitutionEnabled as boolean
- property AutomaticSpellingCorrectionEnabled as boolean
- property AutomaticTextReplacementEnabled as boolean
- property backgroundColor as NSColorMBS
- property Bold as Boolean
- property ContinuousSpellCheckingEnabled as boolean
- property defaultParagraphStyle as Variant
- property displaysLinkToolTips as boolean
- property enabledTextCheckingTypes as Int64
- property GrammarCheckingEnabled as boolean
- property insertionPointColor as NSColorMBS
- property isCoalescingUndo as boolean
- property Italic as Boolean
- property layoutManager as NSLayoutManagerMBS
- property linkTextAttributes as dictionary
- property markedTextAttributes as dictionary
- property RTFData as Memoryblock
- property RulerVisible as boolean
- property selectedTextAttributes as dictionary
- property smartInsertDeleteEnabled as boolean
- property spellCheckerDocumentTag as Integer
- property textContainer as NSTextContainerMBS
- property textContainerInset as NSSizeMBS
- property textContainerOrigin as NSPointMBS
- property textStorage as NSTextStorageMBS
- property typingAttributes as dictionary
- property usesFindBar as Boolean
- property usesFindPanel as boolean
- property usesFontPanel as boolean
- property usesInspectorBar as Boolean
- property usesRuler as boolean
54 methods
- method alignJustified
- method breakUndoCoalescing
- method changeAttributes
- method changeColor
- method changeDocumentBackgroundColor
- method checkTextInDocument
- method checkTextInSelection
- method complete
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method didChangeText
- method insertText(attributedString as NSAttributedStringMBS)
- method insertText(text as string)
- method invalidateTextContainerOrigin
- method loosenKerning
- method lowerBaseline
- method orderFrontLinkPanel
- method orderFrontListPanel
- method orderFrontSpacingPanel
- method orderFrontSubstitutionsPanel
- method orderFrontTablePanel
- method outline
- method pasteAsPlainText
- method pasteAsRichText
- method performFindPanelAction(FindAction as Integer)
- method performFindPanelAction(sender as object)
- method raiseBaseline
- method replaceTextContainer(textContainer as NSTextContainerMBS)
- method shouldChangeTextInRange(affectedCharRange as NSRangeMBS, replacementString as string = "") as Boolean
- method showFindIndicatorForRange(charRange as NSRangeMBS)
- method startSpeaking
- method stopSpeaking
- method tightenKerning
- method toggleAutomaticDashSubstitution
- method toggleAutomaticDataDetection
- method toggleAutomaticLinkDetection
- method toggleAutomaticQuoteSubstitution
- method toggleAutomaticSpellingCorrection
- method toggleAutomaticTextReplacement
- method toggleBold
- method toggleContinuousSpellChecking
- method toggleGrammarChecking
- method toggleItalic
- method toggleSmartInsertDelete
- method toggleTraditionalCharacterShape
- method turnOffKerning
- method turnOffLigatures
- method updateDragTypeRegistration
- method updateFontPanel
- method updateRuler
- method useAllLigatures
- method useStandardKerning
- method useStandardLigatures
9 constants
- const NSFindPanelSubstringMatchTypeContains=0
- const NSFindPanelSubstringMatchTypeEndsWith=3
- const NSFindPanelSubstringMatchTypeFullWord=2
- const NSFindPanelSubstringMatchTypeStartsWith=1
- const NSSelectByCharacter=0
- const NSSelectByParagraph=2
- const NSSelectByWord=1
- const NSSelectionAffinityDownstream=1
- const NSSelectionAffinityUpstream=0

Super class NSTextMBS

5 events
- event textDidBeginEditing
- event textDidChange
- event textDidEndEditing
- event textShouldBeginEditing as boolean
- event textShouldEndEditing as boolean
17 properties
- property alignment as Integer
- property backgroundColor as NSColorMBS
- property baseWritingDirection as Integer
- property drawsBackground as boolean
- property Enabled as boolean
- property font as NSFontMBS
- property importsGraphics as boolean
- property isEditable as boolean
- property isFieldEditor as boolean
- property isHorizontallyResizable as boolean
- property isRichText as boolean
- property isSelectable as boolean
- property isVerticallyResizable as boolean
- property selectedRange as NSRangeMBS
- property text as string
- property textColor as NSColorMBS
- property usesFontPanel as boolean
42 methods
- method alignCenter
- method alignLeft
- method alignRight
- method changeFont
- method checkSpelling
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method copy
- method copyFont
- method copyRuler
- method cut
- method delete
- method isRulerVisible as boolean
- method maxSizeHeight as Double
- method maxSizeWidth as Double
- method minSizeHeight as Double
- method minSizeWidth as Double
- method paste
- method pasteFont
- method pasteRuler
- method readRTFDFromFile(file as folderitem) as boolean
- method replaceCharactersInRangeWithRTF(start as Integer, length as Integer, rtfData as MemoryBlock)
- method replaceCharactersInRangeWithRTFD(start as Integer, length as Integer, rtfdData as MemoryBlock)
- method replaceCharactersInRangeWithString(start as Integer, length as Integer, text as string)
- method RTFDFromRange(start as Integer, length as Integer) as MemoryBlock
- method RTFFromRange(start as Integer, length as Integer) as MemoryBlock
- method scrollRangeToVisible(start as Integer, length as Integer)
- method selectAll
- method setFontForRange(font as NSFontMBS, start as Integer, length as Integer)
- method setMaxSize(width as Double, height as Double)
- method setMinSize(width as Double, height as Double)
- method setTextColorForRange(colorValue as NSColorMBS, start as Integer, length as Integer)
- method showGuessPanel
- method sizeToFit
- method subscript
- method superscript
- method textLength as Integer
- method toggleRuler
- method underline
- method unscript
- method writeRTFDToFile(file as folderitem, atomically as boolean) as boolean
2 shared methods
- shared method NSCenterTextAlignment as Integer
- shared method NSRightTextAlignment as Integer
28 constants
- const NSBackspaceCharacter = 8
- const NSBackTabCharacter = &h19
- const NSBacktabTextMovement = &h12
- const NSCancelTextMovement = &h17
- const NSCarriageReturnCharacter = 13
- const NSDeleteCharacter = &h7F
- const NSDownTextMovement = &h16
- const NSEnterCharacter = 3
- const NSFormFeedCharacter = 12
- const NSIllegalTextMovement = 0
- const NSLeftTextMovement = &h13
- const NSLineSeparatorCharacter = &h2028
- const NSNewlineCharacter = 10
- const NSOtherTextMovement = 0
- const NSParagraphSeparatorCharacter = &h2029
- const NSReturnTextMovement = &h10
- const NSRightTextMovement = &h14
- const NSTabCharacter = 9
- const NSTabTextMovement = &h11
- const NSTextWritingDirectionEmbedding = 0
- const NSTextWritingDirectionOverride = 1
- const NSUpTextMovement = &h15

Alignment Modes

Constant	Value	Description
NSJustifiedTextAlignment	3	Fully-justified. The last line in a paragraph is natural-aligned.
NSLeftTextAlignment	0	Visually left aligned
NSNaturalTextAlignment	4	Indicates the default alignment for script.

Writing Direction

Constant	Value	Description
NSWritingDirectionLeftToRight	0	The writing direction is left to right. Available in Mac OS X v10.2 and later.
NSWritingDirectionNatural	-1	The writing direction is determined using the Unicode Bidi Algorithm rules P2 and P3. Default. Available in Mac OS X v10.4 and later.
NSWritingDirectionRightToLeft	1	The writing direction is right to left. Available in Mac OS X v10.2 and later.

Super class NSViewMBS

43 properties
- property acceptsTouchEvents as boolean
- property allowsVibrancy as Boolean
- property alphaValue as Double
- property autoresizesSubviews as boolean
- property autoresizingMask as Integer
- property bounds as NSRectMBS
- property boundsRotation as Double
- property canBecomeKeyView as boolean
- property canDraw as boolean
- property canDrawConcurrently as boolean
- property className as string
- property classPath as string
- property clipsToBounds as Boolean New in 23.4
- property focusRingType as Integer
- property frame as NSRectMBS
- property frameCenterRotation as Double
- property frameHeight as Double
- property frameLeft as Double
- property frameRotation as Double
- property frameTop as Double
- property frameWidth as Double
- property identifier as string
- property isFlipped as Boolean
- property isHidden as Boolean
- property isHiddenOrHasHiddenAncestor as Boolean
- property isOpaque as Boolean
- property isRotatedFromBase as Boolean
- property isRotatedOrScaledFromBase as Boolean
- property layer as Variant
- property layerUsesCoreImageFilters as Boolean
- property needsDisplay as Boolean
- property nextKeyView as NSViewMBS
- property opaqueAncestor as NSViewMBS
- property RetainCount as Integer
- property superview as NSViewMBS
- property toolTip as string
- property userInteractionEnabled as Boolean
- property visibleRect as NSRectMBS
- property wantsDefaultClipping as boolean
- property wantsLayer as Boolean
- property wantsRestingTouches as boolean
- property window as NSWindowMBS
- property compositingFilter as variant
57 methods
- method addSubview(subview as NSViewMBS)
- method addSubview(subview as NSViewMBS, positioned as Integer, relativeToView as NSViewMBS)
- method addToolTipRect(rect as NSRectMBS, tooltip as NSViewTooltipMBS)
- method ancestorSharedWithView(view as NSViewMBS) as NSViewMBS
- method animator as NSViewMBS
- method backgroundFilters as variant()
- method beginDraggingSessionWithItems(items() as Variant, e as NSEventMBS, source as NSViewMBS) as Variant
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method contentFilters as variant()
- method convertPointFromView(point as NSPointMBS, View as NSViewMBS) as NSPointMBS
- method convertPointToView(point as NSPointMBS, View as NSViewMBS) as NSPointMBS
- method convertRectFromView(rect as NSRectMBS, View as NSViewMBS) as NSRectMBS
- method convertRectToView(rect as NSRectMBS, View as NSViewMBS) as NSRectMBS
- method convertSizeFromView(Size as NSSizeMBS, View as NSViewMBS) as NSSizeMBS
- method convertSizeToView(Size as NSSizeMBS, View as NSViewMBS) as NSSizeMBS
- method dataWithEPSInsideRect(left as Double, top as Double, width as Double, height as Double) as Memoryblock
- method dataWithPDFInsideRect(left as Double, top as Double, width as Double, height as Double) as Memoryblock
- method dataWithPDFInsideRect(r as NSRectMBS) as Memoryblock
- method dragImage(image as NSImageMBS, viewLocation as NSPointMBS, offset as NSSizeMBS, NSEvent as NSEventMBS, pboard as NSPasteboardMBS, source as NSViewMBS, slideFlag as boolean)
- method drawFocusRingMask
- method enclosingMenuItem as Variant
- method enclosingScrollView as Variant
- method focusRingMaskBounds as NSRectMBS
- method isDescendantOf(view as NSViewMBS) as boolean
- method makeBackingLayer as Variant
- method nextValidKeyView as NSViewMBS
- method noteFocusRingMaskChanged
- method pageFooter as NSAttributedStringMBS
- method pageHeader as NSAttributedStringMBS
- method previousKeyView as NSViewMBS
- method previousValidKeyView as NSViewMBS
- method print
- method registeredDraggedTypes as string()
- method registerForDraggedTypes(Types() as string)
- method removeAllToolTips
- method removeFromSuperview
- method removeFromSuperviewWithoutNeedingDisplay
- method RenderImage(subviews as boolean = false, flipped as boolean = false) as variant
- method replaceSubview(oldView as NSViewMBS, newView as NSViewMBS)
- method rotateByAngle(angle as Double)
- method scaleUnitSquareToSize(size as NSSizeMBS)
- method Screenshot as Picture
- method setBackgroundFilters(Filters() as variant)
- method setBoundsOrigin(origin as NSPointMBS)
- method setBoundsOrigin(x as Double, y as Double)
- method setBoundsSize(size as NSSizeMBS)
- method setBoundsSize(width as Double, height as Double)
- method setContentFilters(Filters() as variant)
- method setFocus
- method setFrameOrigin(origin as NSPointMBS)
- method setFrameOrigin(x as Double, y as Double)
- method setFrameSize(size as NSSizeMBS)
- method setFrameSize(width as Double, height as Double)
- method subviews(recursive as boolean = false) as NSViewMBS()
- method unregisterDraggedTypes
5 shared methods
- shared method NSViewBoundsDidChangeNotification as string
- shared method NSViewDidUpdateTrackingAreasNotification as string
- shared method NSViewFocusDidChangeNotification as string
- shared method NSViewFrameDidChangeNotification as string
- shared method NSViewGlobalFrameDidChangeNotification as string
21 constants
- const NSBezelBorder = 2
- const NSFocusRingTypeDefault = 0
- const NSFocusRingTypeExterior = 2
- const NSFocusRingTypeNone = 1
- const NSGrooveBorder = 3
- const NSLineBorder = 1
- const NSNoBorder = 0
- const NSViewHeightSizable = 16
- const NSViewLayerContentsRedrawBeforeViewResize = 3
- const NSViewLayerContentsRedrawDuringViewResize = 2
- const NSViewLayerContentsRedrawNever = 0
- const NSViewLayerContentsRedrawOnSetNeedsDisplay = 1
- const NSViewMaxXMargin = 4
- const NSViewMaxYMargin = 32
- const NSViewMinXMargin = 1
- const NSViewMinYMargin = 8
- const NSViewNotSizable = 0
- const NSViewWidthSizable = 2

Window Order Constants

Constant	Value	Description
NSWindowAbove	1	Moves the window above the indicated window.
NSWindowBelow	-1	Moves the window below the indicated window.
NSWindowOut	0	Moves the window off the screen.