CPPasteboard Class Reference
[AppKit]

List of all members.

Public Member Functions

(unsigned) - addTypes:owner: [implementation]
(CPString- availableTypeFromArray: [implementation]
(unsigned) - changeCount [implementation]
(CPData- dataForType: [implementation]
(unsigned) - declareTypes:owner: [implementation]
(void) - pasteboard:provideDataForType: [implementation]
(id) - propertyListForType: [implementation]
(BOOL) - setData:forType: [implementation]
(BOOL) - setPropertyList:forType: [implementation]
(void) - setString:forType: [implementation]
(CPString- stringForType: [implementation]
(CPArray- types [implementation]

Static Public Member Functions

(id) + generalPasteboard [implementation]
(void) + initialize [implementation]
(id) + pasteboardWithName: [implementation]

Detailed Description

CPPasteBoard is the object responsible for cut/copy/paste and drag&drop operations.

Definition at line 61 of file CPPasteboard.j.


Member Function Documentation

- (unsigned) addTypes: (CPArray types
owner: (id)  anOwner 
[implementation]

Adds supported data types to the pasteboard

Parameters:
types the data types
anOwner the object that contains the data types
Returns:
the pasteboard's change count

Definition at line 146 of file CPPasteboard.j.

- (CPString) availableTypeFromArray: (CPArray anArray   [implementation]

Checks the pasteboard's types for a match with the types listen in the specified array. The array should be ordered by the requestor's most preferred data type first.

Parameters:
anArray an array of requested types ordered by preference
Returns:
the highest match with the pasteboard's supported types or nil if no match was found

Definition at line 257 of file CPPasteboard.j.

- (unsigned) changeCount   [implementation]

Returns the number of changes that have occurred to this pasteboard

Definition at line 275 of file CPPasteboard.j.

- (CPData) dataForType: (CPString aType   [implementation]

Returns the pasteboard data for the specified data type

Parameters:
aType the requested data type
Returns:
the requested data or nil if the data doesn't exist

Definition at line 285 of file CPPasteboard.j.

- (unsigned) declareTypes: (CPArray types
owner: (id)  anOwner 
[implementation]

Sets the data types that this pasteboard will contain.

Parameters:
type the data types it will support
anOwner the object that contains the the data
Returns:
the pasteboard's change count

Definition at line 182 of file CPPasteboard.j.

+ (id) generalPasteboard   [implementation]

Returns a new instance of a pasteboard

Definition at line 92 of file CPPasteboard.j.

+ (void) initialize   [implementation]

Definition at line 76 of file CPPasteboard.j.

- (void) pasteboard: (CPPasteboard aPasteboard
provideDataForType: (CPString aType 
[implementation]

method provided for integration with native pasteboard

Definition at line 323 of file CPPasteboard.j.

+ (id) pasteboardWithName: (CPString aName   [implementation]

Returns a pasteboard with the specified name. If the pasteboard doesn't exist, it will be created.

Parameters:
aName the name of the pasteboard
Returns:
the requested pasteboard

Definition at line 102 of file CPPasteboard.j.

- (id) propertyListForType: (CPString aType   [implementation]

Returns the property list for the specified data type

Parameters:
aType the requested data type
Returns:
the property list or nil if the list was not found

Definition at line 341 of file CPPasteboard.j.

- (BOOL) setData: (CPData aData
forType: (CPString aType 
[implementation]

Sets the pasteboard data for the specified type

Parameters:
aData the data
aType the data type being set
Returns:
YES if the data was successfully written to the pasteboard

Definition at line 218 of file CPPasteboard.j.

- (BOOL) setPropertyList: (id)  aPropertyList
forType: (CPString aType 
[implementation]

Writes the specified property list as data for the specified type

Parameters:
aPropertyList the property list to write
aType the data type
Returns:
YES if the property list was successfully written to the pasteboard

Definition at line 234 of file CPPasteboard.j.

- (void) setString: (CPString aString
forType: (CPString aType 
[implementation]

Sets the specified string as data for the specified type

Parameters:
aString the string to write
aType the data type
Returns:
YES if the string was successfully written to the pasteboard

Definition at line 245 of file CPPasteboard.j.

- (CPString) stringForType: (CPString aType   [implementation]

Returns the string for the specified data type

Parameters:
aType the requested data type
Returns:
the string or nil if the string was not found

Definition at line 356 of file CPPasteboard.j.

- (CPArray) types   [implementation]

Returns the pasteboards supported types

Definition at line 265 of file CPPasteboard.j.


The documentation for this class was generated from the following file:

Generated on Fri Apr 9 11:04:21 2010 for Cappuccino API by  doxygen 1.6.1