Platforms to show: All Mac Windows Linux Cross-Platform
Back to QCViewMBS class.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
On success the handle property is not zero.
See also:
QCViewMBS.Constructor(Handle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The handle is casted to a QCView and the plugin retains this handle.
See also:
QCViewMBS.Constructor(left as Double, top as Double, width as Double, height as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
On success the handle property is not zero.
See also:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
QCViewMBS.getAttributes as dictionary
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns a dictionary that contains the attributes that describe the composition, including the input and output ports of the root patch.
The dictionary can define any of the attributes that are specified by the composition attribute keys. See QCCompositionAttributeNameKey, QCCompositionAttributeDescriptionKey, and QCCompositionAttributeCopyrightKey.
The dictionary can also contain dictionaries that correspond to the keys that identify the input and output ports of the root patch of the composition. See QCPortAttributeTypeKey, QCPortAttributeNameKey, QCPortAttributeMinimumValueKey, QCPortAttributeMaximumValueKey, and QCPortAttributeMenuItemsKey.
Available in Mac OS X v10.4 and later.
QCViewMBS.inputKeys as string()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
QCViewMBS.loadComposition(composition as QCCompositionMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns true if successful; otherwise false.
If unsuccessful, any composition that's already loaded in the view remains loaded.
QCViewMBS.loadCompositionFromData(data as MemoryBlock) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
If unsuccessful, returns false; any composition that's already loaded in the view remains loaded.
Available in Mac OS X v10.4 and later.
See also:
QCViewMBS.loadCompositionFromData(data as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
If unsuccessful, returns false; any composition that's already loaded in the view remains loaded.
Available in Mac OS X v10.4 and later.
See also:
QCViewMBS.loadCompositionFromFile(file as folderitem) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
file: A folderitem that specifies the location of a Quartz Composer composition file.
If unsuccessful, returns false; any composition that's already loaded in the view remains loaded.
Available in Mac OS X v10.4 and later.
See also:
Some examples using this method:
QCViewMBS.loadCompositionFromFile(filepath as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
filepath: A string that specifies the location of a Quartz Composer composition file.
If unsuccessful, returns false; any composition that's already loaded in the view remains loaded.
Available in Mac OS X v10.4 and later.
See also:
QCViewMBS.outputKeys as string()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
You can nest calls to this method.
Available in Mac OS X v10.5 and later.
Some examples using this method:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
You can nest calls to this method.
Available in Mac OS X v10.5 and later.
Some examples using this method:
QCViewMBS.setValueForInputKey(value as Variant, key as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
value: The value to set for the input port. The input port must be at the root patch of the composition. The data type of the value argument must match the input port.
key: The key associated with the input port of the composition. This method throws an exception if key is invalid.
Returns false if it cannot set the value.
Available in Mac OS X v10.4 and later.
Some examples using this method:
QCViewMBS.startRendering as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns false if the composition fails to start rendering; true otherwise.
Available in Mac OS X v10.4 and later.
Some examples using this method:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Available in Mac OS X v10.4 and later.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
If necessary, this method calls stopRendering prior to unloading the composition.
Available in Mac OS X v10.5 and later.
Some examples using this method:
QCViewMBS.valueForInputKey(key as string) as Variant
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
key: The key associated with an input port for the root patch of a composition. This method throws an exception if key is invalid.
Returns the value. The data type of returned value depends on the type of the input port.
Available in Mac OS X v10.4 and later.
QCViewMBS.valueForOutputKey(key as string) as Variant
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Quartz Composer | MBS MacControls Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
key
The key associated with an output port for the root patch of a composition. This method throws an exception if key is invalid.
Returns the value as Xojo variant. The data type of returned value depends on the type of the output port.
Some examples using this method:
The items on this page are in the following plugins: MBS MacControls Plugin.