API  0.9.7
 All Classes Files Functions Variables Macros Groups Pages
CPPasteboard Class Reference

#import <CPPasteboard.h>

+ Inheritance diagram for CPPasteboard:

Instance Methods

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

Class Methods

(id) + generalPasteboard
 
(void) + initialize
 
(id) + pasteboardWithName:
 

Detailed Description

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

Definition at line 2 of file CPPasteboard.h.

Method Documentation

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

Adds supported data types to the pasteboard

Parameters
typesthe data types
anOwnerthe object that contains the data types
Returns
the pasteboard's change count

Definition at line 140 of file CPPasteboard.j.

- (CPString) availableTypeFromArray: (CPArray)  anArray
implementation

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

Parameters
anArrayan 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 258 of file CPPasteboard.j.

- (unsigned) changeCount
implementation

Returns the number of changes that have occurred to this pasteboard

Definition at line 276 of file CPPasteboard.j.

- (CPData) dataForType: (CPString aType
implementation

Returns the pasteboard data for the specified data type

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

Definition at line 286 of file CPPasteboard.j.

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

Sets the data types that this pasteboard will contain.

Parameters
typethe data types it will support
anOwnerthe object that contains the the data
Returns
the pasteboard's change count

Definition at line 176 of file CPPasteboard.j.

+ (id) generalPasteboard
implementation

Returns a new instance of a pasteboard

Definition at line 86 of file CPPasteboard.j.

+ (void) initialize
implementation

Definition at line 70 of file CPPasteboard.j.

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

method provided for integration with native pasteboard

Definition at line 324 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
aNamethe name of the pasteboard
Returns
the requested pasteboard

Definition at line 96 of file CPPasteboard.j.

- (id) propertyListForType: (CPString aType
implementation

Returns the property list for the specified data type

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

Definition at line 342 of file CPPasteboard.j.

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

Sets the pasteboard data for the specified type

Parameters
aDatathe data
aTypethe data type being set
Returns
YES if the data was successfully written to the pasteboard

Definition at line 215 of file CPPasteboard.j.

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

Writes the specified property list as data for the specified type

Parameters
aPropertyListthe property list to write
aTypethe data type
Returns
YES if the property list was successfully written to the pasteboard

Definition at line 231 of file CPPasteboard.j.

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

Sets the specified string as data for the specified type

Parameters
aStringthe string to write
aTypethe data type
Returns
YES if the string was successfully written to the pasteboard

Definition at line 242 of file CPPasteboard.j.

- (CPString) stringForType: (CPString aType
implementation

Returns the string for the specified data type

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

Definition at line 357 of file CPPasteboard.j.

- (CPArray) types
implementation

Returns the pasteboards supported types

Definition at line 266 of file CPPasteboard.j.


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