Platforms to show: All Mac Windows Linux Cross-Platform

Back to QCViewMBS class.

QCViewMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Quartz Composer MBS MacControls Plugin 10.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Creates a new Quartz composer view with size 100/100 and position 0/0
Example
dim t as new QCViewMBS

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
Creates an object based on the given QCView handle.
Example
dim t as new QCViewMBS(0, 0, 100, 100)
dim v as new QCViewMBS(t.handle)

MsgBox str(v.Bounds.Width)+" x "+str(v.Bounds.Height)

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
Creates a new Quartz composer view with the given size and position.
Example
dim x as new QCViewMBS(0, 0, 100, 100)

On success the handle property is not zero.

See also:

QCViewMBS.erase

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Quartz Composer MBS MacControls Plugin 10.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Clears the view using the current erase color.

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 the attributes of the composition associated with the renderer.

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
Returns an array that contains the keys that identify the input ports of the root patch of the composition.

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
Loads a QCComposition object into the view.

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
Loads the composition from memoryblock.

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
Loads the composition from data string.

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
Loads the composition file located at the specified path.

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
Loads the composition file located at the specified path.

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
Returns an array that contains the keys that identify the output ports of the root patch of the composition.

QCViewMBS.pauseRendering

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Quartz Composer MBS MacControls Plugin 10.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Pauses rendering in the view.

You can nest calls to this method.
Available in Mac OS X v10.5 and later.

Some examples using this method:

QCViewMBS.resumeRendering

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Quartz Composer MBS MacControls Plugin 10.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Resumes rendering a paused composition.

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
Sets the value for an input port of a composition.

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
Starts rendering the composition that is in the view.

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:

QCViewMBS.stopRendering

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Quartz Composer MBS MacControls Plugin 10.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Stops rendering the composition that is in the view.

Available in Mac OS X v10.4 and later.

QCViewMBS.unloadComposition

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Quartz Composer MBS MacControls Plugin 10.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Unloads the composition from the view.

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
Returns the value for an input port of a composition.

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
Returns the value for an output port of a composition.

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.


The biggest plugin in space...