MonobjcMonobjc Documented Class Library
QCPlugIn Class
NamespacesMonobjc.QuartzQCPlugIn

[Missing <summary> documentation for "T:Monobjc.Quartz.QCPlugIn"]

Declaration Syntax
C#Visual BasicVisual C++
public class QCPlugIn : NSObject
Public Class QCPlugIn _
	Inherits NSObject
public ref class QCPlugIn : public NSObject
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
QCPlugIn()()()()
Initializes a new instance of the QCPlugIn class.

QCPlugIn(IntPtr)
Initializes a new instance of the QCPlugIn class.

QCPlugIn(String, Object, array<Object>[]()[][])
Initializes a new instance of the QCPlugIn class.

AddInputPortWithTypeForKeyWithAttributes(NSString, NSString, NSDictionary)

Adds an input port of the specified type and associates a key and attributes with the port.

Original signature is '- (void) addInputPortWithType:(NSString*)type forKey:(NSString*)key withAttributes:(NSDictionary*)attributes'

Available in Mac OS X v10.5 and later.


AddObserverForKeyPathOptionsContext(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers anObserver to receive KVO notifications for the specified key-path relative to the receiver.

Original signature is '- (void)addObserver:(NSObject *)anObserver forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(void *)context'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
AddOutputPortWithTypeForKeyWithAttributes(NSString, NSString, NSDictionary)

Adds an output port of the specified type and associates a key and attributes with the port.

Original signature is '- (void) addOutputPortWithType:(NSString*)type forKey:(NSString*)key withAttributes:(NSDictionary*)attributes'

Available in Mac OS X v10.5 and later.


Alloc()()()()
Allocates a new native instance.
(Inherited from Id.)
AttributeKeys

Returns an array of NSString objects containing the names of immutable values that instances of the receiver's class contain.

Original signature is '- (NSArray *)attributeKeys'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
Attributes

Returns a dictionary that contains strings for the user interface that describe the custom patch.

Original signature is '+ (NSDictionary*) attributes'

Available in Mac OS X v10.5 and later.


AttributesForPropertyPortWithKey(NSString)

Returns a dictionary that contains strings for the user interface that describe the optional attributes for ports created from properties.

Original signature is '+ (NSDictionary*) attributesForPropertyPortWithKey:(NSString*)key'

Available in Mac OS X v10.5 and later.


AutoContentAccessingProxy

Creates and returns an autoreleased proxy for the receiving object

Original signature is '- (id)autoContentAccessingProxy'

Available in Mac OS X v10.6 and later.

(Inherited from NSObject.)
Autorelease()()()()

Adds the receiver to the current autorelease pool.

Original signature is '- (id)autorelease'

Available in Mac OS X v10.0 and later.

(Inherited from Id.)
AwakeAfterUsingCoder(NSCoder)

Overridden by subclasses to substitute another object in place of the object that was decoded and subsequently received this message.

Original signature is '- (id)awakeAfterUsingCoder:(NSCoder *)aDecoder'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
BindToObjectWithKeyPathOptions(NSString, Id, NSString, NSDictionary)

Establishes a binding between a given property of the receiver and the property of a given object specified by a given key path.

Original signature is '- (void)bind:(NSString *)binding toObject:(id)observableController withKeyPath:(NSString *)keyPath options:(NSDictionary *)options'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
CastAs<(Of <<'(T>)>>)()()()()
Try to cast the current instance to the given type. The cast is dynamically tested for safety.
(Inherited from Id.)
CastTo<(Of <<'(T>)>>)()()()()
Cast the current instance to the given type. The cast is dynamically tested for safety.
(Inherited from Id.)
Class

Gets the class of the underlying instance.

(Inherited from Id.)
ClassCode

Returns the receiver's Apple event type code, as stored in the NSScriptClassDescription object for the object’s class.

Original signature is '- (FourCharCode)classCode'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ClassDescription

Returns an object containing information about the attributes and relationships of the receiver’s class.

Original signature is '- (NSClassDescription *)classDescription'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ClassForArchiver

Overridden by subclasses to substitute a class other than its own during archiving.

Original signature is '- (Class)classForArchiver'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ClassForCoder

Overridden by subclasses to substitute a class other than its own during coding.

Original signature is '- (Class)classForCoder'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ClassForKeyedArchiver

Overridden by subclasses to substitute a new class for instances during keyed archiving.

Original signature is '- (Class)classForKeyedArchiver'

Available in Mac OS X v10.2 and later.

(Inherited from NSObject.)
ClassForPortCoder

Overridden by subclasses to substitute a class other than its own for distribution encoding.

Original signature is '- (Class)classForPortCoder'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ClassName

Returns a string containing the name of the class.

Original signature is '- (NSString *)className'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
CoerceValueForKey(Id, NSString)

Uses type info from the class description and NSScriptCoercionHandler to attempt to convert value for key to the proper type, if necessary.

Original signature is '- (id)coerceValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ConformsToProtocol(IntPtr)

Returns a Boolean value that indicates whether the receiver conforms to a given protocol. (required)

Original signature is '- (BOOL)conformsToProtocol:(Protocol *)aProtocol'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
Copy()()()()

Returns the object returned by copyWithZone:, where the zone is nil.

Original signature is '- (id)copy'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
CopyScriptingValueForKeyWithProperties(Id, NSString, NSDictionary)

Creates and returns one or more scripting objects to be inserted into the specified relationship by copying the passed-in value and setting the properties in the copied object or objects.

Original signature is '- (id)copyScriptingValue:(id)value forKey:(NSString *)key withProperties:(NSDictionary *)properties'

Available in Mac OS X v10.5 and later.

(Inherited from NSObject.)
CreateViewController()()()()

Creates and returns a view controller for the Settings pane of a custom patch.

Original signature is '- (QCPlugInViewController*) createViewController'

Available in Mac OS X v10.5 and later.


Dealloc()()()()

Deallocates the memory occupied by the receiver.

Original signature is '- (void)dealloc'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
Description

Returns a string that describes the contents of the receiver. (required)

Original signature is '- (NSString *)description'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
DictionaryWithValuesForKeys(NSArray)

Returns a dictionary containing the property values identified by each of the keys in a given array.

Original signature is '- (NSDictionary *)dictionaryWithValuesForKeys:(NSArray *)keys'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
DidChangeValueForKey(NSString)

Invoked to inform the receiver that the value of a given property has changed.

Original signature is '- (void)didChangeValueForKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
DidChangeValueForKeyWithSetMutationUsingObjects(NSString, NSKeyValueSetMutationKind, NSSet)

Invoked to inform the receiver that the specified change was made to a specified unordered to-many relationship.

Original signature is '- (void)didChangeValueForKey:(NSString *)key withSetMutation:(NSKeyValueSetMutationKind)mutationKind usingObjects:(NSSet *)objects'

Available in Mac OS X v10.4 and later.

(Inherited from NSObject.)
DidChangeValuesAtIndexesForKey(NSKeyValueChange, NSIndexSet, NSString)

Invoked to inform the receiver that the specified change has occurred on the indexes for a specified ordered to-many relationship.

Original signature is '- (void)didChange:(NSKeyValueChange)change valuesAtIndexes:(NSIndexSet *)indexes forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
DidValueForInputKeyChange(NSString)

Returns whether the input port value changed since the last execution of the custom patch.

Original signature is '- (BOOL) didValueForInputKeyChange:(NSString*)key'

Available in Mac OS X v10.5 and later.


DisableExecution(IQCPlugInContext)

Allows you to perform custom tasks when the execution of the QCPlugIn object is paused.

Original signature is '- (void) disableExecution:(id<QCPlugInContext>)context'

Available in Mac OS X v10.5 and later.


Dispose()()()()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from Id.)
Dispose(Boolean)
Releases unmanaged and - optionally - managed resources
(Inherited from Id.)
DoesNotRecognizeSelector(IntPtr)

Handles messages the receiver doesn’t recognize.

Original signature is '- (void)doesNotRecognizeSelector:(SEL)aSelector'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
EnableExecution(IQCPlugInContext)

Allows you to perform custom tasks when the execution of the QCPlugIn object is resumed.

Original signature is '- (void) enableExecution:(id<QCPlugInContext>)context'

Available in Mac OS X v10.5 and later.


Equals(Id)
Indicates whether the current object is equal to another object of the same type.
(Inherited from Id.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Id.)
ExecuteAtTimeWithArguments(IQCPlugInContext, Double, NSDictionary)

Performs the processing or rendering tasks appropriate for the custom patch.

Original signature is '- (BOOL) execute:(id<QCPlugInContext>)context atTime:(NSTimeInterval)time withArguments:(NSDictionary*)arguments'

Available in Mac OS X v10.5 and later.


ExecutionMode

Returns the execution mode of the custom patch.

Original signature is '+ (QCPlugInExecutionMode) executionMode'

Available in Mac OS X v10.5 and later.


ExposedBindings

Returns an array containing the bindings exposed by the receiver.

Original signature is '- (NSArray *)exposedBindings'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
Finalize()()()()
Releases unmanaged resources and performs other cleanup operations before the Id is reclaimed by garbage collection.
(Inherited from Id.)
ForwardingTargetForSelector(IntPtr)

Returns the object to which unrecognized messages should first be directed.

Original signature is '- (id)forwardingTargetForSelector:(SEL)aSelector'

Available in Mac OS X v10.6 and later.

(Inherited from NSObject.)
ForwardInvocation(NSInvocation)

Overridden by subclasses to forward messages to other objects.

Original signature is '- (void)forwardInvocation:(NSInvocation *)anInvocation'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Id.)
GetInstanceVariable<(Of <<'(T>)>>)(String)
Gets the instance variable of the specified name.
(Inherited from Id.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
Hash

Returns an integer that can be used as a table address in a hash table structure. (required)

Original signature is '- (NSUInteger)hash'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
InfoForBinding(NSString)

Returns a dictionary describing the receiver’s binding.

Original signature is '- (NSDictionary *)infoForBinding:(NSString *)binding'

Available in Mac OS X v10.4 and later.

(Inherited from NSObject.)
Init()()()()

Implemented by subclasses to initialize a new object (the receiver) immediately after memory for it has been allocated.

Original signature is '- (id)init'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
InsertValueAtIndexInPropertyWithKey(Id, NSUInteger, NSString)

Inserts an object at the specified index in the collection specified by the passed key.

Original signature is '- (void)insertValue:(id)value atIndex:(NSUInteger)index inPropertyWithKey:(NSString *)key'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
InsertValueInPropertyWithKey(Id, NSString)

Inserts an object in the collection specified by the passed key.

Original signature is '- (void)insertValue:(id)value inPropertyWithKey:(NSString *)key'

Available in Mac OS X v10.2 and later.

(Inherited from NSObject.)
InverseForRelationshipKey(NSString)

For a given key that defines the name of the relationship from the receiver’s class to another class, returns the name of the relationship from the other class to the receiver’s class.

Original signature is '- (NSString *)inverseForRelationshipKey:(NSString *)relationshipKey'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
IsEqual(Id)

Returns a Boolean value that indicates whether the receiver and a given object are equal. (required)

Original signature is '- (BOOL)isEqual:(id)anObject'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
IsKindOfClass(Class)

Returns a Boolean value that indicates whether the receiver is an instance of given class or an instance of any class that inherits from that class. (required)

Original signature is '- (BOOL)isKindOfClass:(Class)aClass'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
IsMemberOfClass(Class)

Returns a Boolean value that indicates whether the receiver is an instance of a given class. (required)

Original signature is '- (BOOL)isMemberOfClass:(Class)aClass'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
IsProxy

Returns a Boolean value that indicates whether the receiver does not descend from NSObject. (required)

Original signature is '- (BOOL)isProxy'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
LoadPlugInAtPath(NSString)

Loads a Quartz Composer plug-in bundle from the specified path.

Original signature is '+ (BOOL) loadPlugInAtPath:(NSString*)path'

Available in Mac OS X v10.5 and later.


MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MethodForSelector(IntPtr)

Locates and returns the address of the receiver’s implementation of a method so it can be called as a function.

Original signature is '- (IMP)methodForSelector:(SEL)aSelector'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
MethodSignatureForSelector(IntPtr)

Returns an NSMethodSignature object that contains a description of the method identified by a given selector.

Original signature is '- (NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
MutableArrayValueForKey(NSString)

Returns a mutable array proxy that provides read-write access to an ordered to-many relationship specified by a given key.

Original signature is '- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
MutableArrayValueForKeyPath(NSString)

Returns a mutable array that provides read-write access to the ordered to-many relationship specified by a given key path.

Original signature is '- (NSMutableArray *)mutableArrayValueForKeyPath:(NSString *)keyPath'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
MutableCopy()()()()

Returns the object returned by mutableCopyWithZone: where the zone is nil.

Original signature is '- (id)mutableCopy'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
MutableSetValueForKey(NSString)

Returns a mutable set proxy that provides read-write access to the unordered to-many relationship specified by a given key.

Original signature is '- (NSMutableSet *)mutableSetValueForKey:(NSString *)key'

Available in Mac OS X v10.4 and later.

(Inherited from NSObject.)
MutableSetValueForKeyPath(NSString)

Returns a mutable set that provides read-write access to the unordered to-many relationship specified by a given key path.

Original signature is '- (NSMutableSet *)mutableSetValueForKeyPath:(NSString *)keyPath'

Available in Mac OS X v10.4 and later.

(Inherited from NSObject.)
NativePointer
Gets or sets the native pointer.
(Inherited from Id.)
NewScriptingObjectOfClassForValueForKeyWithContentsValueProperties(Class, NSString, Id, NSDictionary)

Creates and returns an instance of a scriptable class, setting its contents and properties, for insertion into the relationship identified by the key.

Original signature is '- (id)newScriptingObjectOfClass:(Class)class forValueForKey:(NSString *)key withContentsValue:(id)contentsValue properties:(NSDictionary *)properties'

Available in Mac OS X v10.5 and later.

(Inherited from NSObject.)
ObservationInfo

Returns a pointer that identifies information about all of the observers that are registered with the receiver.

Original signature is '- (void *)observationInfo'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
ObserveValueForKeyPathOfObjectChangeContext(NSString, Id, NSDictionary, IntPtr)

This message is sent to the receiver when the value at the specified key path relative to the given object has changed.

Original signature is '- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
OptionDescriptionsForBinding(NSString)

Returns an array describing the options for the specified binding.

Original signature is '- (NSArray *)optionDescriptionsForBinding:(NSString *)binding'

Available in Mac OS X v10.5 and later.

(Inherited from NSObject.)
PerformSelector(IntPtr)

Sends a specified message to the receiver and returns the result of the message. (required)

Original signature is '- (id)performSelector:(SEL)aSelector'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
PerformSelectorInBackgroundWithObject(IntPtr, Id)

Invokes a method of the receiver on a new background thread.

Original signature is '- (void)performSelectorInBackground:(SEL)aSelector withObject:(id)arg'

Available in Mac OS X v10.5 and later.

(Inherited from NSObject.)
PerformSelectorOnMainThreadWithObjectWaitUntilDone(IntPtr, Id, Boolean)

Invokes a method of the receiver on the main thread using the default mode.

Original signature is '- (void)performSelectorOnMainThread:(SEL)aSelector withObject:(id)arg waitUntilDone:(BOOL)wait'

Available in Mac OS X v10.2 and later.

(Inherited from NSObject.)
PerformSelectorOnMainThreadWithObjectWaitUntilDoneModes(IntPtr, Id, Boolean, NSArray)

Invokes a method of the receiver on the main thread using the specified modes.

Original signature is '- (void)performSelectorOnMainThread:(SEL)aSelector withObject:(id)arg waitUntilDone:(BOOL)wait modes:(NSArray *)array'

Available in Mac OS X v10.2 and later.

(Inherited from NSObject.)
PerformSelectorOnThreadWithObjectWaitUntilDone(IntPtr, NSThread, Id, Boolean)

Invokes a method of the receiver on the specified thread using the default mode.

Original signature is '- (void)performSelector:(SEL)aSelector onThread:(NSThread *)thr withObject:(id)arg waitUntilDone:(BOOL)wait'

Available in Mac OS X v10.5 and later.

(Inherited from NSObject.)
PerformSelectorOnThreadWithObjectWaitUntilDoneModes(IntPtr, NSThread, Id, Boolean, NSArray)

Invokes a method of the receiver on the specified thread using the specified modes.

Original signature is '- (void)performSelector:(SEL)aSelector onThread:(NSThread *)thr withObject:(id)arg waitUntilDone:(BOOL)wait modes:(NSArray *)array'

Available in Mac OS X v10.5 and later.

(Inherited from NSObject.)
PerformSelectorWithObject(IntPtr, Id)

Sends a message to the receiver with an object as the argument. (required)

Original signature is '- (id)performSelector:(SEL)aSelector withObject:(id)anObject'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
PerformSelectorWithObjectAfterDelay(IntPtr, Id, Double)

Invokes a method of the receiver on the current thread using the default mode after a delay.

Original signature is '- (void)performSelector:(SEL)aSelector withObject:(id)anArgument afterDelay:(NSTimeInterval)delay'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
PerformSelectorWithObjectAfterDelayInModes(IntPtr, Id, Double, NSArray)

Invokes a method of the receiver on the current thread using the specified modes after a delay.

Original signature is '- (void)performSelector:(SEL)aSelector withObject:(id)anArgument afterDelay:(NSTimeInterval)delay inModes:(NSArray *)modes'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
PerformSelectorWithObjectWithObject(IntPtr, Id, Id)

Sends a message to the receiver with two objects as arguments. (required)

Original signature is '- (id)performSelector:(SEL)aSelector withObject:(id)anObject withObject:(id)anotherObject'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
PlugInKeys

Returns the keys for the internal settings of a custom patch.

Original signature is '+ (NSArray*) plugInKeys'

Available in Mac OS X v10.5 and later.


QCPlugInAttributeCopyrightKey

QCPlugInAttributeDescriptionKey

The key for the custom patch description. The associated value is an NSString object.

Available in Mac OS X v10.5 and later.


QCPlugInAttributeNameKey

The key for the custom patch name. The associated value is an NSString object.

Available in Mac OS X v10.5 and later.


QCPlugInClass
Static field for a quick access to the QCPlugIn class.

QCPlugInExecutionArgumentEventKey

The current NSEvent if available.

Available in Mac OS X v10.5 and later.


QCPlugInExecutionArgumentMouseLocationKey

The current location of the mouse (as an NSPoint object stored in an NSValue object) in normalized coordinates relative to the OpenGL context viewport ([0,1]x[0,1] with the origin (0,0) at the lower-left corner).

Available in Mac OS X v10.5 and later.


QCPlugInPixelFormatARGB8

An ARGB8 format. The alpha component is stored in the most significant bits of each pixel. Each pixel component is 8 bits. For best performance, use this format on PowerPC-based Macintosh computers, as it represents of the order of the data in memory.

Available in Mac OS X v10.5 and later.


QCPlugInPixelFormatBGRA8

A BGRA8 format. The alpha component is stored in the least significant bits of each pixel. Each pixel component is 8 bits. For best performance, use this format on Intel-PC-based Macintosh computers, as it represents of the order of the data in memory.

Available in Mac OS X v10.5 and later.


QCPlugInPixelFormatI8

An I8 format. Intensity information is represented as an 8-bit value.

Available in Mac OS X v10.5 and later.


QCPlugInPixelFormatIf

An If format. Intensity information is represented as a floating-point value.

Available in Mac OS X v10.5 and later.


QCPlugInPixelFormatRGBAf

An RGBAf format. Pixel components are represented as floating-point values.

Available in Mac OS X v10.5 and later.


QCPortAttributeDefaultValueKey

The key for the port default value. You can use this key only for value ports (Boolean, Index, Number, Color and String).

Available in Mac OS X v10.5 and later.


QCPortAttributeMaximumValueKey

The key for the port maximum value. The associated value is an NSNumber object that specifies the maximum numerical value accepted by the port.

Available in Mac OS X v10.4 and later.


QCPortAttributeMenuItemsKey

The key for the menu items. The associated value is an array of strings that are displayed in the user interface as a pop-up menu when the user double-clicks a port, as shown for the Blending input port of the Billboard patch. You can use this key only for an index port.

Available in Mac OS X v10.5 and later.


QCPortAttributeMinimumValueKey

The key for the port minimum value. The associated value is an NSNumber object that specifies the minimum numerical value accepted by the port.

Available in Mac OS X v10.4 and later.


QCPortAttributeNameKey

The key for the port name. The associated value is an NSString object.

Available in Mac OS X v10.4 and later.


QCPortAttributeTypeKey

The key for the port type. The associated value can be of any of the following constants: QCPortTypeBoolean, QCPortTypeIndex, QCPortTypeNumber, QCPortTypeString, QCPortTypeColor, QCPortTypeImage, or QCPortTypeStructure.

Available in Mac OS X v10.4 and later.


QCPortTypeBoolean

The port type for a Boolean value. The associated value can be an NSNumber object or any object that responds to the -intValue, -floatValue, or -doubleValue methods.

Available in Mac OS X v10.4 and later.


QCPortTypeColor

The port type for a color value. The associated value must be an NSColor object.

Available in Mac OS X v10.4 and later.


QCPortTypeImage

The port type for an image. The associated value can be an NSImage object or a CIImage object.

Available in Mac OS X v10.4 and later.


QCPortTypeIndex

The port type for an index value. The associated value can be an NSNumber object or any object that responds to the -intValue, -floatValue, or -doubleValue methods.

Available in Mac OS X v10.4 and later.


QCPortTypeNumber

The port type for a number value. The associated value can be an NSNumber object or any object that responds to the -intValue, -floatValue, or -doubleValue methods.

Available in Mac OS X v10.4 and later.


QCPortTypeString

The port type for a string. The associated value can be an NSString object or any object that responds to the -stringValue or -description methods.

Available in Mac OS X v10.4 and later.


QCPortTypeStructure

The port type for an array, dictionary, or other structure, such as an NSArray or NSDictionary object.

Available in Mac OS X v10.4 and later.


RegisterPlugInClass(Class)

Registers a QCPlugIn subclass.

Original signature is '+ (void) registerPlugInClass:(Class)aClass'

Available in Mac OS X v10.5 and later.


Release()()()()

Decrements the receiver�s reference count.

Original signature is '- (oneway void)release'

Available in Mac OS X v10.0 and later.

(Inherited from Id.)
RemoveInputPortForKey(NSString)

Removes the input port for a given key.

Original signature is '- (void) removeInputPortForKey:(NSString*)key'

Available in Mac OS X v10.5 and later.


RemoveObserverForKeyPath(NSObject, NSString)

Stops a given object from receiving change notifications for the property specified by a given key-path relative to the receiver.

Original signature is '- (void)removeObserver:(NSObject *)anObserver forKeyPath:(NSString *)keyPath'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
RemoveOutputPortForKey(NSString)

Removes the output port for a given key.

Original signature is '- (void) removeOutputPortForKey:(NSString*)key'

Available in Mac OS X v10.5 and later.


RemoveValueAtIndexFromPropertyWithKey(NSUInteger, NSString)

Removes the object at the specified index from the collection specified by the passed key.

Original signature is '- (void)removeValueAtIndex:(NSUInteger)index fromPropertyWithKey:(NSString *)key'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ReplacementObjectForArchiver(NSArchiver)

Overridden by subclasses to substitute another object for itself during archiving.

Original signature is '- (id)replacementObjectForArchiver:(NSArchiver *)anArchiver'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ReplacementObjectForCoder(NSCoder)

Overridden by subclasses to substitute another object for itself during encoding.

Original signature is '- (id)replacementObjectForCoder:(NSCoder *)aCoder'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ReplacementObjectForKeyedArchiver(NSKeyedArchiver)

Overridden by subclasses to substitute another object for itself during keyed archiving.

Original signature is '- (id)replacementObjectForKeyedArchiver:(NSKeyedArchiver *)archiver'

Available in Mac OS X v10.2 and later.

(Inherited from NSObject.)
ReplacementObjectForPortCoder(NSPortCoder)

Overridden by subclasses to substitute another object or a copy for itself during distribution encoding.

Original signature is '- (id)replacementObjectForPortCoder:(NSPortCoder *)aCoder'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ReplaceValueAtIndexInPropertyWithKeyWithValue(NSUInteger, NSString, Id)

Replaces the object at the specified index in the collection specified by the passed key.

Original signature is '- (void)replaceValueAtIndex:(NSUInteger)index inPropertyWithKey:(NSString *)key withValue:(id)value'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
RespondsToSelector(IntPtr)

Returns a Boolean value that indicates whether the receiver implements or inherits a method that can respond to a specified message. (required)

Original signature is '- (BOOL)respondsToSelector:(SEL)aSelector'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
RespondsToSelector(String)

Returns a Boolean value that indicates whether the receiver implements or inherits a method that can respond to a specified message.

Original signature is '- (BOOL)respondsToSelector:(SEL)aSelector'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
Retain()()()()

Increments the receiver�s reference count.

Original signature is '- (id)retain'

Available in Mac OS X v10.0 and later.

(Inherited from Id.)
RetainCount

Returns the receiver’s reference count. (required)

Original signature is '- (NSUInteger)retainCount'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
SafeCastAs<(Of <<'(TInstance>)>>)(Id)
Try to cast the current instance to the given type. The cast is dynamically tested for safety.
(Inherited from IdExtensions.)
SafeCastTo<(Of <<'(TInstance>)>>)(Id)
Cast the current instance to the given type. the cast is dynamically tested for safety
(Inherited from IdExtensions.)
SafeRelease(Id)

Performs a safe release operation on the given instance.

The equivalent code is:

CopyC#
if (instance != null) instance.Release();
(Inherited from IdExtensions.)
ScriptingProperties

Returns an NSString-keyed dictionary of the receiver's scriptable properties.

Original signature is '- (NSDictionary *)scriptingProperties'

Available in Mac OS X v10.2 and later.

(Inherited from NSObject.)
ScriptingValueForSpecifier(NSScriptObjectSpecifier)

Given an object specifier, returns the specified object or objects in the receiving container.

Original signature is '- (id)scriptingValueForSpecifier:(NSScriptObjectSpecifier *)objectSpecifier'

Available in Mac OS X v10.5 and later.

(Inherited from NSObject.)
Self

Returns the receiver. (required)

Original signature is '- (id)self'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
SendMessage(String, array<Object>[]()[][])
Sends a message to this receiver (either a Class or an object instance).
(Inherited from Id.)
SendMessageSuper(Class, String, array<Object>[]()[][])

Sends a message to the super instance of this receiver.

(Inherited from Id.)
SendMessageSuperVarArgs(Class, String, array<Object>[]()[][])

Sends a message to the super instance of this receiver.

The last parameter passed must be an object array that contains the variable list of arguments

(Inherited from Id.)
SendMessageVarArgs(String, array<Object>[]()[][])

Sends a message to this receiver (either a Class or an object instance).

The last parameter passed must be an object array that contains the variable list of arguments

(Inherited from Id.)
SerializedValueForKey(NSString)

Provides custom serialization for patch internal settings that do not comply to the NSCoding protocol.

Original signature is '- (id) serializedValueForKey:(NSString*)key'

Available in Mac OS X v10.5 and later.


SetInstanceVariable<(Of <<'(T>)>>)(String, T)
Sets the instance variable of the specified name.
(Inherited from Id.)
SetNilValueForKey(NSString)

Invoked by setValue:forKey: when it’s given a nil value for a scalar value (such as an int or float).

Original signature is '- (void)setNilValueForKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetSerializedValueForKey(Id, NSString)

Provides custom deserialization for patch internal settings that were previously serialized using the method serializedValueForKey:.

Original signature is '- (void) setSerializedValue:(id)serializedValue forKey:(NSString*)key'

Available in Mac OS X v10.5 and later.


SetValueForKey(Id, NSString)

Sets the property of the receiver specified by a given key to a given value.

Original signature is '- (void)setValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForKey(String, String)

Sets the property of the receiver specified by a given key to a given value.

Original signature is '- (void)setValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForKey(Int16, String)

Sets the property of the receiver specified by a given key to a given value.

Original signature is '- (void)setValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForKey(Int64, String)

Sets the property of the receiver specified by a given key to a given value.

Original signature is '- (void)setValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForKey(Int32, String)

Sets the property of the receiver specified by a given key to a given value.

Original signature is '- (void)setValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForKey(Single, String)

Sets the property of the receiver specified by a given key to a given value.

Original signature is '- (void)setValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForKey(Double, String)

Sets the property of the receiver specified by a given key to a given value.

Original signature is '- (void)setValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForKey(Char, String)

Sets the property of the receiver specified by a given key to a given value.

Original signature is '- (void)setValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForKey(Boolean, String)

Sets the property of the receiver specified by a given key to a given value.

Original signature is '- (void)setValue:(id)value forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForKeyPath(Id, NSString)

Sets the value for the property identified by a given key path to a given value.

Original signature is '- (void)setValue:(id)value forKeyPath:(NSString *)keyPath'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValueForOutputKey(Id, NSString)

Sets the value of an output port.

Original signature is '- (BOOL) setValue:(id)value forOutputKey:(NSString*)key'

Available in Mac OS X v10.5 and later.


SetValueForUndefinedKey(Id, NSString)

Invoked by setValue:forKey: when it finds no property for a given key.

Original signature is '- (void)setValue:(id)value forUndefinedKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SetValuesForKeysWithDictionary(NSDictionary)

Sets properties of the receiver with values from a given dictionary, using its keys to identify the properties.

Original signature is '- (void)setValuesForKeysWithDictionary:(NSDictionary *)keyedValues'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
SortedPropertyPortKeys

Returns and array of property port keys in the order you want them to appear in the user interface.

Original signature is '+ (NSArray*) sortedPropertyPortKeys'

Available in Mac OS X v10.5 and later.


StartExecution(IQCPlugInContext)

Allows you to perform custom setup tasks before the Quartz Composer engine starts rendering.

Original signature is '- (BOOL) startExecution:(id<QCPlugInContext>)context'

Available in Mac OS X v10.5 and later.


StopExecution(IQCPlugInContext)

Allows you to perform custom tasks when the QCPlugIn object stops executing.

Original signature is '- (void) stopExecution:(id<QCPlugInContext>)context'

Available in Mac OS X v10.5 and later.


Superclass

Returns the class object for the receiver’s superclass. (required)

Original signature is '- (Class)superclass'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
TimeMode

Returns the time mode for the custom patch.

Original signature is '+ (QCPlugInTimeMode) timeMode'

Available in Mac OS X v10.5 and later.


ToManyRelationshipKeys

Returns array containing the keys for the to-many relationship properties of the receiver.

Original signature is '- (NSArray *)toManyRelationshipKeys'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ToOneRelationshipKeys

Returns the keys for the to-one relationship properties of the receiver, if any.

Original signature is '- (NSArray *)toOneRelationshipKeys'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ToString()()()()
Returns a String that represents this instance.
(Inherited from NSObject.)
Unbind(NSString)

Removes a given binding between the receiver and a controller.

Original signature is '- (void)unbind:(NSString *)binding'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
ValidateValueForKeyError(Id%, NSString, NSError%)

Returns a Boolean value that indicates whether the value specified by a given pointer is valid for the property identified by a given key.

Original signature is '- (BOOL)validateValue:(id *)ioValue forKey:(NSString *)key error:(NSError **)outError'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
ValidateValueForKeyPathError(Id%, NSString, NSError%)

Returns a Boolean value that indicates whether the value specified by a given pointer is valid for a given key path relative to the receiver.

Original signature is '- (BOOL)validateValue:(id *)ioValue forKeyPath:(NSString *)inKeyPath error:(NSError **)outError'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
ValueAtIndexInPropertyWithKey(NSUInteger, NSString)

Retrieves an indexed object from the collection specified by the passed key.

Original signature is '- (id)valueAtIndex:(NSUInteger)index inPropertyWithKey:(NSString *)key'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ValueClassForBinding(NSString)

Returns the class of the value that will be returned for the specified binding.

Original signature is '- (Class)valueClassForBinding:(NSString *)binding'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
ValueForInputKey(NSString)

Returns the current value for an input port.

Original signature is '- (id) valueForInputKey:(NSString*)key'

Available in Mac OS X v10.5 and later.


ValueForKey(NSString)

Returns the value for the property identified by a given key.

Original signature is '- (id)valueForKey:(NSString *)key'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ValueForKeyPath(NSString)

Returns the value for the derived property identified by a given key path.

Original signature is '- (id)valueForKeyPath:(NSString *)keyPath'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
ValueForUndefinedKey(NSString)

Invoked by valueForKey: when it finds no property corresponding to a given key.

Original signature is '- (id)valueForUndefinedKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
ValueWithNameInPropertyWithKey(NSString, NSString)

Retrieves a named object from the collection specified by the passed key.

Original signature is '- (id)valueWithName:(NSString *)name inPropertyWithKey:(NSString *)key'

Available in Mac OS X v10.2 and later.

(Inherited from NSObject.)
ValueWithUniqueIDInPropertyWithKey(Id, NSString)

Retrieves an object by ID from the collection specified by the passed key.

Original signature is '- (id)valueWithUniqueID:(id)uniqueID inPropertyWithKey:(NSString *)key'

Available in Mac OS X v10.2 and later.

(Inherited from NSObject.)
WillChangeValueForKey(NSString)

Invoked to inform the receiver that the value of a given property is about to change.

Original signature is '- (void)willChangeValueForKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
WillChangeValueForKeyWithSetMutationUsingObjects(NSString, NSKeyValueSetMutationKind, NSSet)

Invoked to inform the receiver that the specified change is about to be made to a specified unordered to-many relationship.

Original signature is '- (void)willChangeValueForKey:(NSString *)key withSetMutation:(NSKeyValueSetMutationKind)mutationKind usingObjects:(NSSet *)objects'

Available in Mac OS X v10.4 and later.

(Inherited from NSObject.)
WillChangeValuesAtIndexesForKey(NSKeyValueChange, NSIndexSet, NSString)

Invoked to inform the receiver that the specified change is about to be executed at given indexes for a specified ordered to-many relationship.

Original signature is '- (void)willChange:(NSKeyValueChange)change valuesAtIndexes:(NSIndexSet *)indexes forKey:(NSString *)key'

Available in Mac OS X v10.3 and later.

(Inherited from NSObject.)
Zone

Returns a pointer to the zone from which the receiver was allocated. (required)

Original signature is '- (NSZone *)zone'

Available in Mac OS X v10.0 and later.

(Inherited from NSObject.)
Inheritance Hierarchy
Object
Id
 NSObject
  QCPlugIn
Version Information
  • Available in Monobjc Bridge: 10.6 (For Mac OS X 10.6 and later), 10.5 (For Mac OS X 10.5 and later)

Assembly: Monobjc.Quartz (Module: Monobjc.Quartz)