Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

NSTokenFieldControlMBS.BoundsChanged
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 17.1 Yes No No No No
Function: The event called when the bounds, but not the frame, changed.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.completionsForSubstring(substring as string, tokenIndex as Integer, byref selectedIndex as Integer) as Variant()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Allows the delegate to provide an array of appropriate completions for the contents of the receiver.
Notes:
substring: The partial string that is to be completed.
tokenIndex: The index of the token being edited.
selectedIndex: Optionally, you can return by-reference an index into the returned array that specifies which of the completions should be initially selected. If none are to be selected, return by reference -1.

Returns an array of strings that are possible completions.

If the delegate does not implement this method, no completions are provided.
Available in OS X v10.4 and later.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.displayStringForRepresentedObject(representedObject as Variant) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Allows the delegate to provide a string to be displayed as a proxy for the given represented object.
Notes:
representedObject: A represented object of the token field.

Returns the string to be used as a proxy for representedObject. If you return nil or do not implement this method, then representedObject is displayed as the string.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.editingStringForRepresentedObject(representedObject as Variant) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Allows the delegate to provide a string to be edited as a proxy for a represented object.
Notes:
representedObject: A represented object of the token field.

Returns a string that's an editable proxy of the represented object, or nil if the token should not be editable.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.EnableMenuItems
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 17.1 Yes Yes Yes No No
Function: The event where you can enable menu items.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.FrameChanged
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 17.1 Yes No No No No
Function: The event called when the frame changed.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.GotFocus
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 16.5 Yes No No No No
Function: The control itself got focus.
Notes: This only fires if the control itself got focus and not a sub control.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.hasMenuForRepresentedObject(representedObject as Variant) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Allows the delegate to specify whether the given represented object provides a menu.
Notes:
representedObject: A represented object of the token field.

Returns true if the represented object has a menu, false otherwise.
By default tokens in a token field have no menus.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.LostFocus
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 16.5 Yes No No No No
Function: The control lost focus.
Notes: This only fires if the control itself lost focus and not a sub control.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.MenuAction(HitItem as MenuItem) As Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 17.1 Yes No No No No
Function: Called when a menuitem is choosen.
Notes: 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.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.menuForRepresentedObject(representedObject as Variant) as NSMenuMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Allows the delegate to provide a menu for the specified represented object.
Notes:
representedObject: A represented object of the token field.

Returns the menu associated with the represented object.
By default tokens in a token field do not return menus.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 17.1 Yes No No No No
Function: The mouse button was pressed inside the control’s region at the location passed in to x, y.
Notes:
The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the Control.
Return True if you are going to handle the MouseDown. In such a case:
  • The Action event, if any, will not execute and the state of the object will not change.
  • You will receive the MouseDrag and MouseUp events.
If you return False, the system handles the MouseDown so the above event handlers do not get called.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.MouseDrag(x as Integer, y as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 17.1 Yes No No No No
Function: This event fires continuously after the mouse button was pressed inside the Control.
Notes:
Mouse location is local to the control passed in to x, y.
As this event is fired continuously (hundreds of time per second), it is your responsibility to determine if the mouse has really moved.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.MouseUp(x as Integer, y as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 17.1 Yes No No No No
Function: The mouse button was released.
Notes: Use the x and y parameters to determine if the mouse button was released within the control's boundaries.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.readFromPasteboard(pboard as NSPasteboardMBS) as Variant()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Allows the delegate to return an array of objects representing the data read from the specified pasteboard.
Notes:
pboard: The pasteboard from which to read the represented objects.

Returns an array of represented objects created from the pasteboard data.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.representedObjectForEditingString(editingString as string) as Variant
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Allows the delegate to provide a represented object for the given editing string.
Notes:
editingString: The edited string representation of a represented object.

Returns a represented object that is displayed rather than the editing string.

Note: In OS X v10.4, NSTokenField trims whitespace around tokens but it does not trim whitespace in OS X versions 10.5.0 and 10.5.1. In OS X v10.5.2, you get whitespace-trimming behavior by either linking against the v10.4 binary or linking against the v10.5 binary and not implementing the this method. If you do not want the whitespace-trimming behavior, link against the v10.5 binary and implement this method, returning the editing string if you have no represented object.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.ScaleFactorChanged(NewFactor as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 17.1 Yes No No No No
Function: The backing store scale factor has changed.
Notes: Please invalidate any cached bitmaps or other relevant state.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.shouldAddObjects(tokens() as Variant, index as Integer) as Variant()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Allows to validate the tokens to be added to the receiver at a particular location.
Notes:
tokens: An array of tokens to be inserted in the receiver at index.
index: The index of the receiver in which the array of tokens to be validated (tokens) will be inserted.

Returns an array of validated tokens.

The event can return the array unchanged or return a modified array of tokens. To reject the add completely, return an empty array. Returning nil causes an error.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.styleForRepresentedObject(representedObject as Variant) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Allows the delegate to return the token style for editing the specified represented object.
Notes:
representedObject: A represented object of the token field.

Returns the style that should be used to display the representedObject. Possible values are shown in NSTokenStyle Values.

If the event implements this method and returns an NSTokenStyle that differs from the style set by setTokenStyle:, the value the event returns is preferred.

If you don't implement this method, the token field's tokenStyle is used.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.TextDidBeginEditing(fieldEditor as NSTextMBS, notification as NSNotificationMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Sent when a control with editable text begins an editing session.
Notes:
Notification: The notification object. The name of the notification is always NSControlTextDidBeginEditingNotification.

This event is invoked when the user begins editing text in a control such as a text field or a form field. The control posts a NSControlTextDidBeginEditingNotification notification, and if the control's subclass implements this event, it is automatically registered to receive the notification. The field editor is also delivered for inspection.

See TextDidEndEditing for an explanation of why you may not always get one invocation of TextDidBeginEditing for each invocation of TextDidEndEditing.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.TextDidChange(fieldEditor as NSTextMBS, notification as NSNotificationMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Sent when the text in the receiving control changes.
Notes:
Notification: The notification object. The name of the notification is always NSControlTextDidChangeNotification.

This event is invoked when text in a control such as a text field or form changes. The control posts a NSControlTextDidChangeNotification notification, and if the control's subclass implements this event, it is automatically registered to receive the notification. The field editor is provided as parameter for inspection.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.TextDidEndEditing(fieldEditor as NSTextMBS, notification as NSNotificationMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Sent when a control with editable text ends an editing session.
Notes:
Notification: The notification object. The name of the notification is always NSControlTextDidEndEditingNotification.

This event is invoked when the user stops editing text in a control such as a text field or form. The control posts a NSControlTextDidEndEditingNotification notification, and if the control' subclass implements this event, it is automatically registered to receive the notification. The field editor is also provided for inspection.

Warning: In some cases, such as when editing within an instance of NSOutlineView, this method may be invoked without a previous invocation of TextDidBeginEditing. You will only get the TextDidBeginEditing: notification if the user actually types something, but you can get the TextDidEndEditing notification if the user just double-clicks the field and then clicks outside the field, without typing.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.textShouldBeginEditing(fieldEditor as NSTextMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: The event called to decide whether text editing should be allowed.
Notes:
Return true to allow text editing or false to deny.
Be aware that an event in Xojo without return will cause false to be returned.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.textShouldEndEditing(fieldEditor as NSTextMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: The event called to decide whether ending text editing should be allowed.
Notes:
Return true to allow end of text editing or false to deny.
Be aware that an event in Xojo without return will cause false to be returned.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.tokenFieldAction
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: The control's action was triggered.
Notes: For a button if it was pressed.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.tokenFieldTextShouldBeginEditing(fieldEditor as NSTextMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: The event called to decide whether text editing should be allowed.
Notes: Return true to allow text editing.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.tokenFieldTextShouldEndEditing(fieldEditor as NSTextMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: The event called to decide whether ending text editing should be allowed.
Notes: Return true to allow text editing.

Feedback, Comments & Corrections

NSTokenFieldControlMBS.writeRepresentedObjects(objects() as Variant, pboard as NSPasteboardMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.4 Yes No No No No
Function: Sent so the delegate can write represented objects to the pasteboard corresponding to a given array of display strings.
Notes:
objects: An array of represented objects associated with the token field.
pboard: The pasteboard to which to write the represented objects.

Return true if you writes the represented objects to the pasteboard, false otherwise. If false, the token field writes the display strings to the NSStringPboardType pasteboard.

Feedback, Comments & Corrections

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




Links
MBS FileMaker blog