Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_AE_AppleEvent Class Reference
[AppleEvents]

Wrapper class for the MacOS AppleEvent. More...

Inheritance diagram for CP_AE_AppleEvent:

CP_AE_Descriptor List of all members.

Public Member Functions

 operator AEDesc * ()
 operator const AEDesc * () const
 operator AEDesc & ()
 operator const AEDesc & () const
void swap (CP_AE_Descriptor &inOutDescriptor) throw ()
Constructor / Destructor
 CP_AE_AppleEvent ()
 Constructor.
 CP_AE_AppleEvent (AppleEvent *inAppleEvent)
virtual ~CP_AE_AppleEvent ()
 Destructor.
Getters
void GetParams (const AEKeyword inKeyword, const DescType inDesiredType, AEDesc &inOutOptionalParams) const
void GetOptionalParams (const AEKeyword inKeyword, const DescType inDesiredType, AEDesc &inOutOptionalParams) const
void GetParamPtr (const AEKeyword inKeyword, const DescType inDesiredType, DescType *inTypeCode, void *inDataPtr, const Size inMaximumSize, Size *inOutActualSize) const
AEDesc GetAttribute (const AEKeyword inKey, const DescType inDesiredType)
SInt32 GetSInt32Attribute (const AEKeyword inKey)
Event makers
void MakeAppleEvent (const AEEventClass inEventClass, const AEEventID inEventID, const AEDesc &inTarget, const SInt16 inReturnID=kAutoGenerateReturnID, const SInt32 inTransactionID=kAnyTransactionID)
void MakeAppleEvent (const AEEventClass inEventClass, const AEEventID inEventID, const ProcessSerialNumber &inPSN, const SInt16 inReturnID=kAutoGenerateReturnID, const SInt32 inTransactionID=kAnyTransactionID)
void MakeEventSelf (const AEEventClass inEventClass, const AEEventID inEventID, const SInt16 inReturnID=kAutoGenerateReturnID, const SInt32 inTransactionID=kAnyTransactionID)
void MakeEventSystem (const AEEventClass inEventClass, const AEEventID inEventID, const SInt16 inReturnID=kAutoGenerateReturnID, const SInt32 inTransactionID=kAnyTransactionID)
Senders
void Send (AppleEvent *inOutReply, const AESendMode inSendMode, const AESendPriority inSendPriority=kAENormalPriority, const SInt32 inTimeOutInTicks=kAEDefaultTimeout, AEIdleUPP inIdleProc=NULL, AEFilterUPP inFilterProc=NULL)
void Send (AppleEvent *inFuture)
void Send_NoExecute ()
void Send_NoReply ()
void Suspend ()
void Resume (AppleEvent *inReply, AEEventHandlerUPP inDispatcher, SInt32 inRefCon)
void SetCurrentEvent ()
Setters
void PutDescriptor (const AEKeyword inKey, AEDesc &inData)
void PutReturnDescriptor (AEDesc &inData)
void PutOptionalDescriptor (const AEKeyword inKey, AEDesc &inData)
void PutPtr (const AEKeyword inKey, const DescType inTypeCode, const void *inDataPtr, Size inDataSize)
void PutAttribute (const AEKeyword inKey, AEDesc &inAttribute)
void CheckRequiredParams () const
void SpecifyThatParameterIsOptional (const AEKeyword inOptionalKeyword)

Public Attributes

AEDesc fAEDesc

Protected Attributes

SInt16 fCanUseSelfSend

Detailed Description

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_AE_AppleEvent::CP_AE_AppleEvent (   ) 
 

Constructor.

Exceptions:
none 

CP_AE_AppleEvent::CP_AE_AppleEvent (  AppleEvent *  inAppleEvent  ) 
 

Constructor.

Parameters:
inAppleEvent The AppleEvent for &fAEDesc class.
Exceptions:
none 

CP_AE_AppleEvent::~CP_AE_AppleEvent (   )  [virtual]
 

Destructor.

Exceptions:
none 

Member Function Documentation

void CP_AE_AppleEvent::GetParams (  const AEKeyword  inKeyword,
const DescType  inDesiredType,
AEDesc &  inOutOptionalParams
)  const
 

Get the parameters of the event. &fAEDesc method will fail (throw an OSErr exception) if there is an error. Use the GetOptionalParams if the parameter your getting is considered optional.

Parameters:
inKeyword The keyword for the event.
inDesiredType The desired type for the event.
inOutOptionalParams Location to return/add any optional params.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::GetOptionalParams (  const AEKeyword  inKeyword,
const DescType  inDesiredType,
AEDesc &  inOutOptionalParams
)  const
 

Get the optional parameters of the event. It is ok if the descriptor was not found, since we want optional params.

Parameters:
inKeyword The keyword for the event.
inDesiredType The desired type for the event.
inOutOptionalParams Location to return/add any optional params.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::GetParamPtr (  const AEKeyword  inKeyword,
const DescType  inDesiredType,
DescType *  inTypeCode,
void *  inDataPtr,
const Size  inMaximumSize,
Size *  inOutActualSize
)  const
 

Return the desired param ptr from the Apple Event.

Parameters:
inKeyword The keyword of the event.
inDesiredType The desired type of the information.
inTypeCode The type code of the information we want.
inDataPtr The location where the information will be placed.
inMaximumSize The maximum size we can hold for the return data.
inOutActualSize A Size * to hold the actual size of the data returned.
Exceptions:
OSError exceptions.
Returns:
void

AEDesc CP_AE_AppleEvent::GetAttribute (  const AEKeyword  inKey,
const DescType  inDesiredType
) 
 

Return an attribute for the event.

Parameters:
inKey The AEKeyword for the attribute.
inDesiredType The desired type.
Exceptions:
OSError exceptions.
Returns:
void

SInt32 CP_AE_AppleEvent::GetSInt32Attribute (  const AEKeyword  inKey  ) 
 

Return an attribute for the event with the key passed in inKey.

Parameters:
inKey The AEKeyword for the attribute.
Exceptions:
OSError exceptions.
Returns:
SInt32 The attribute as a SInt32.

void CP_AE_AppleEvent::MakeAppleEvent (  const AEEventClass  inEventClass,
const AEEventID  inEventID,
const AEDesc &  inTarget,
const SInt16  inReturnID = kAutoGenerateReturnID,
const SInt32  inTransactionID = kAnyTransactionID
) 
 

Make a MacOS AppleEvent.

Parameters:
inEventClass The AEEventClas of the event.
inEventID The AEEventID of the event.
inTarget AEDesc describing the target of &fAEDesc event.
inReturnID Identifier for the created event.
inTransactionID Transaction identifier for the created event.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::MakeAppleEvent (  const AEEventClass  inEventClass,
const AEEventID  inEventID,
const ProcessSerialNumber &  inPSN,
const SInt16  inReturnID = kAutoGenerateReturnID,
const SInt32  inTransactionID = kAnyTransactionID
) 
 

Make a MacOS AppleEvent.

Parameters:
inEventClass The AEEventClas of the event.
inEventID The AEEventID of the event.
inPSN ProcessSerialNumber for the event.
inReturnID Identifier for the created event.
inTransactionID Transaction identifier for the created event.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::MakeEventSelf (  const AEEventClass  inEventClass,
const AEEventID  inEventID,
const SInt16  inReturnID = kAutoGenerateReturnID,
const SInt32  inTransactionID = kAnyTransactionID
) 
 

Create an Apple Event of inEventClass and send the event to ourselves. NOTE: Some early version of the Apple Event Manager had a memory leak when sending events, so if we are running on that version of the Apple Event Manager, we will not send the event.

Parameters:
inEventClass The AEEventClas of the event.
inEventID The AEEventID of the event.
inReturnID Identifier for the created event.
inTransactionID Transaction identifier for the created event.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::MakeEventSystem (  const AEEventClass  inEventClass,
const AEEventID  inEventID,
const SInt16  inReturnID = kAutoGenerateReturnID,
const SInt32  inTransactionID = kAnyTransactionID
) 
 

Create an Apple Event of inEventClass and send it to the MacOS operating system.

Parameters:
inEventClass The AEEventClas of the event.
inEventID The AEEventID of the event.
inReturnID Identifier for the created event.
inTransactionID Transaction identifier for the created event.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::Send (  AppleEvent *  inOutReply,
const AESendMode  inSendMode,
const AESendPriority  inSendPriority = kAENormalPriority,
const SInt32  inTimeOutInTicks = kAEDefaultTimeout,
AEIdleUPP  inIdleProc = NULL,
AEFilterUPP  inFilterProc = NULL
) 
 

Send the Apple Event. The reply will be returned in the inOutReply parameter.

Parameters:
inOutReply The location where the reply to the event will be placed.
inSendMode The desired AESendMode for the event.
inSendPriority The desired AESendPriority for the event.
inTimeOutInTicks The amount of time allowed for a reply before the event times out.
inIdleProc An AEIdleUPP routine for &fAEDesc event.
inSendPriority An AEFilterUPP routine for &fAEDesc event.
Exceptions:
OSError exceptions.
Returns:
SInt32 The attribute as a SInt32.

void CP_AE_AppleEvent::Send (  AppleEvent *  inFuture  ) 
 

Send the Apple Event, placing the result in the passed in parameter.

Parameters:
inFuture A CP_AE_AppleEvent to place the result in.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::Send_NoExecute (   ) 
 

Send the Apple Event, but don't execute it. &fAEDesc used for recording purposes.

Exceptions:
none 
Returns:
void

void CP_AE_AppleEvent::Send_NoReply (   ) 
 

Send the Apple Event, but don't wait for a reply.

Exceptions:
none 
Returns:
void

void CP_AE_AppleEvent::Suspend (   ) 
 

Suspend the current event.

Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::Resume (  AppleEvent *  inReply,
AEEventHandlerUPP  inDispatcher,
SInt32  inRefCon
) 
 

Resume the current event.

Parameters:
inReply The location to return the reply in.
inDispatcher The AppleEvent dispatcher.
inRefCon RefCon value supplied to the event.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::SetCurrentEvent (   ) 
 

Sets the current event to ourselves.

Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::PutDescriptor (  const AEKeyword  inKey,
AEDesc &  inData
) 
 

Place the passed in descriptor into &fAEDesc event.

Parameters:
inKey Keyword for the descriptor.
inData The descriptor for the event.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::PutReturnDescriptor (  AEDesc &  inData  ) 
 

Place a return descriptor into &fAEDesc event.

Parameters:
inData The descriptor to add to the event.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::PutOptionalDescriptor (  const AEKeyword  inKey,
AEDesc &  inData
) 
 

Place an optional descriptor into &fAEDesc event.

Parameters:
inKey Keyword for the descriptor.
inData Descriptor to add to the event.
Exceptions:
none 
Returns:
void

void CP_AE_AppleEvent::PutPtr (  const AEKeyword  inKey,
const DescType  inTypeCode,
const void *  inDataPtr,
Size  inDataSize
) 
 

Place the data pointer to by inDataPtr into &fAEDesc event.

Parameters:
inKey Keyword for the data.
inTypeCode Type code for the data.
inDataPtr Pointer to the data buffer to include in &fAEDesc event.
inDataSize Number of bytes to copy from the buffer.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::PutAttribute (  const AEKeyword  inKey,
AEDesc &  inAttribute
) 
 

Place the passed in attribute into &fAEDesc event.

Parameters:
inKey Keyword for the attribute.
inAttribute The attribute for the event.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_AppleEvent::CheckRequiredParams (   )  const
 

Check if we have gotten all of the required parameters for &fAEDesc event.

Exceptions:
OSError exceptions
Returns:
void

void CP_AE_AppleEvent::SpecifyThatParameterIsOptional (  const AEKeyword  inOptionalKeyword  ) 
 

Notify the Apple Event that the passed in AEKeyword is considered an optional.

Parameters:
inOptionalKeyword The keyword that is considered optional for the event.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_Descriptor::Dispose (   )  [inherited]
 

Dispose of the memory allocated for &fAEDesc object.

Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_Descriptor::CreateDescriptor (  const DescType  inTypeCode,
const Ptr  inData,
const Size  inLength
)  [inherited]
 

Create a new descriptor ffrom the passed in data and data type code.

Parameters:
inTypeCode The DescType type code.
inData Pointer to the data to be used.
inLength Length of the data to be used.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_Descriptor::MakeNULL (   )  [inherited]
 

Make &fAEDesc descriptor into a NULL descriptor.

Exceptions:
none 
Returns:
void

OSErr CP_AE_Descriptor::AttemptCoercion (  DescType  typeToCoerceTo  )  [inherited]
 

Try to coerce the type of the descriptor to something else. &fAEDesc method will NOT fail if the coercion could not be done. NOTE: &fAEDesc method does not throw an exception, but returns the error code, as it is ok for &fAEDesc routine to fail.

Parameters:
typetoCoerceTo The desired type we want.
Exceptions:
none 
Returns:
OSErr The result of the coercion.

void CP_AE_Descriptor::CoerceInPlace (  DescType  typeToCoerceTo  )  [inherited]
 

Require that &fAEDesc object be coerced to the specified data type. &fAEDesc method will fail if the coercion does not work.

Parameters:
typetoCoerceTo The desired type we want.
Exceptions:
OSError exception.
Returns:
OSErr The result of the coercion.

CP_AE_Descriptor CP_AE_Descriptor::Coerce (  DescType  typeToCoerceTo  )  const [inherited]
 

Require that &fAEDesc object be coerced to the specified data type. &fAEDesc method will fail if the coercion does not work.

Parameters:
typetoCoerceTo The desired type we want.
Exceptions:
OSError exception.
Returns:
CP_AE_Descriptor The result of the coecion.

void CP_AE_Descriptor::CoerceToStandardType (   )  [inherited]
 

&fAEDesc method attempts to coerce its data into some form of standard type (e.g. typeChar or typeLongInteger). The following conversions are tried: From: typeAEText, typeIntlText or typeStyledText to typeChar, and typeLongInteger to typeLongInteger.

Exceptions:
OSError exception.
Returns:
void

void CP_AE_Descriptor::CopyDesc (  const CP_AE_Descriptor &  inDescriptor  )  [inherited]
 

Duplicate the information from the passed in descriptor.

Parameters:
inDescriptor The object to copy the data from.
Exceptions:
OSError exceptions.
Returns:
void

DescType CP_AE_Descriptor::DescriptorType (   )  const [inherited]
 

Return a DescType that describes the type of descriptor this is.

Exceptions:
none 
Returns:
DescType const The DescType for this descriptor.

Handle CP_AE_Descriptor::GetData (   )  [inherited]
 

Return a Handle to our data. &fAEDesc handle is a copy of the data and must be deleted by the caller.

Exceptions:
OSError exceptions.
Returns:
Handle The returned handle.

void CP_AE_Descriptor::GetDescriptor (  const AEDesc &  inDescriptor,
AEKeyword  inKey,
DescType  inDesiredType = typeWildCard
)  [inherited]
 

Get the descriptor from an event. If the desired type is not specified, it is assumed to be typeWildCard.

Parameters:
inDescriptor The descriptor to retrieve the paramDesc from.
inKey The key of the descriptor.
inDesiredType The desired type we want.
Exceptions:
OSError exception.
Returns:
void

OSErr CP_AE_Descriptor::GetOptionalDescriptor (  const AEDesc &  inDescriptor,
AEKeyword  inKey,
DescType  inDesiredType = typeWildCard
)  [inherited]
 

Get the descriptor from an event. If the desired type is not specified, it is assumed to be typeWildCard. NOTE: &fAEDesc method is used for retrieving optional descriptors, so we will just return the err code and let the called do with the result as it sees fit.

Parameters:
inDescriptor The descriptor to retrieve the paramDesc from.
inKey The key of the descriptor.
inDesiredType The desired type we want.
Exceptions:
none 
Returns:
OSErr Result of the operation.

void CP_AE_Descriptor::GetNthPtr (  SInt32  inIndex,
DescType  inDesiredType,
AEKeyword *  inAEKeyword,
DescType *  inTypeCode,
void *  inDataPtr,
Size  inMaximumSize,
Size *  inOutActualSize
)  [inherited]
 

Retrurns a pointer to the nth item in &fAEDesc descriptor.

Parameters:
inIndex Index of the item we want.
inDesiredType The type we want converted to.
inAEKeyword Keyword for item.
inTypeCode TypeCode for item.
inDataPtr Pointer to the location to return the items data.
inMaximumSize Maximum size of the data to be returned.
inOutActualSize Actual size of the returned data.
Exceptions:
none 
Returns:
OSErr Result of the operation.

void CP_AE_Descriptor::GetBlock (  Ptr  inData,
Size  inLength,
DescType  inDesiredType
)  const [inherited]
 

Get a block of data of the inDesiredType.

Parameters:
inData Ptr to the data.
inLength Size of the data length.
inDesiredType The desired type of data.
Exceptions:
none 
Returns:
void

SInt16 CP_AE_Descriptor::GetSInt16 (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a SInt16.

Exceptions:
none 
Returns:
SInt16 const The data as a SInt16.

SInt32 CP_AE_Descriptor::GetSInt32 (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a SInt32.

Exceptions:
none 
Returns:
SInt32 const The data as a SInt32.

bool CP_AE_Descriptor::GetBoolean (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a bool.

Exceptions:
none 
Returns:
bool const The data as a bool.

DescType CP_AE_Descriptor::GetDescType (   )  const [inherited]
 

Return the type of information contained in &fAEDesc object as a DescType.

Exceptions:
none 
Returns:
DescType const The data as a DescType.

AEKeyword CP_AE_Descriptor::GetKeyword (   )  const [inherited]
 

Return the type of information contained in &fAEDesc object as a AEKeyword.

Exceptions:
none 
Returns:
AEKeyword const The data as a AEKeyword.

DescType CP_AE_Descriptor::GetEnumeration (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a DescType enumeration.

Exceptions:
none 
Returns:
DescType const The data as a Desctype enumeration.

DescType CP_AE_Descriptor::GetOrdinal (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a DescType typeAbsoluteOrdinal.

Exceptions:
none 
Returns:
DescType const The data as a Desctype ordinal.

CP_Point CP_AE_Descriptor::GetPoint (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a CP_Point object.

Exceptions:
none 
Returns:
CP_Point const The converted CP_Point object.

CP_Rect CP_AE_Descriptor::GetRect (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a CP_Rect object.

Exceptions:
none 
Returns:
CP_Rect const The converted CP_Rect object.

void CP_AE_Descriptor::GetPString (  Str255  result  )  const [inherited]
 

Return the data from &fAEDesc descriptor as a Str255 object.

Parameters:
result Location to return the result in.
Exceptions:
none 
Returns:
void

CP_String CP_AE_Descriptor::GetString (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a CP_String object.

Exceptions:
none 
Returns:
CP_String const The converted CP_String object.

CP_FileSystemSpec CP_AE_Descriptor::GetFileSpec (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a CP_FileSystemSpec.

Exceptions:
none 
Returns:
CP_FileSystemSpec const The converted file system spec.

SInt32 CP_AE_Descriptor::GetItemCount (   )  [inherited]
 

Return the number of items in &fAEDesc descriptor.

Exceptions:
none 
Returns:
SInt32 The number of items in &fAEDesc descriptor.

OSErr CP_AE_Descriptor::GetNthItem (  SInt32  inItemIndex,
DescType *  inOutDescType,
CP_AE_Descriptor *  inOutItem
)  [inherited]
 

Return the nth item from &fAEDesc descriptor.

Parameters:
inItemIndex Index of the item to return.
inOutDescType Location to return the DescType of the item.
inOutItem Location to return the item.
Exceptions:
none 
Returns:
OSErr Result of the operation.

CP_AE_Descriptor::operator AEDesc * (   )  [inherited]
 

CP_AE_Descriptor::operator const AEDesc * (   )  const [inherited]
 

CP_AE_Descriptor::operator AEDesc & (   )  [inherited]
 

CP_AE_Descriptor::operator const AEDesc & (   )  const [inherited]
 

void CP_AE_Descriptor::CopyData (  const DescType  inTypeCode,
const Ptr  inData,
const Size  inLength
)  [inherited]
 

Make a new descriptor from the passed in data and data type code.

Parameters:
inTypeCode The DescType type code.
inData Pointer to the data to be used.
inLength Length of the data to be used.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_Descriptor::MakeBoolean (  const Boolean  inData  )  [inherited]
 

Make &fAEDesc into a Boolean descriptor from the passed in Boolean data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeBoolean (  const bool  inData  )  [inherited]
 

Make &fAEDesc into a Boolean descriptor from the passed in bool data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeSInt16 (  const SInt16  inData  )  [inherited]
 

Make &fAEDesc into a SInt16 descriptor from the passed in data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeSInt32 (  const SInt32  inData  )  [inherited]
 

Make &fAEDesc into a SInt32 descriptor from the passed in data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeUInt32 (  const UInt32  inData  )  [inherited]
 

Make &fAEDesc into a UInt32 descriptor from the passed in data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakePoint (  const CP_Point &  inPoint  )  [inherited]
 

Make &fAEDesc into a point descriptor from the passed in data.

Parameters:
inPoint CP_Point data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeRect (  const CP_Rect &  inRect  )  [inherited]
 

Make &fAEDesc into a rect descriptor from the passed in data.

Parameters:
inPoint CP_Rect data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeString (  Str255  inData  )  [inherited]
 

Make &fAEDesc into a p-style string descriptor from the passed in data.

Parameters:
inPoint Str255 data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeString (  const CP_String  inData  )  [inherited]
 

Make &fAEDesc into a string descriptor from the passed in data.

Parameters:
inPoint CP_String data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeFileSpec (  const FSSpec &  inFileSpec  )  [inherited]
 

Make &fAEDesc into a file spec descriptor from the passed in data.

Parameters:
inPoint FSSpec data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeFileSpec (  const CP_FileSystemSpec &  inFileSpec  )  [inherited]
 

Make &fAEDesc into a file spec descriptor from the passed in data.

Parameters:
inPoint CP_FileSystemSpec data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::AdoptAlias (  Handle  inAlias  )  [inherited]
 

Takes the provided alias handle and uses it to set the data for &fAEDesc descriptor.

Parameters:
Handle Alias to the data to be converted.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeAlias (  const CP_FileSystemSpec &  inFileSpec  )  [inherited]
 

Make a descriptor for the passed in CP_FileSystemSpec inData as a MacOS Alias.

Parameters:
inFileSpec CP_FileSystemSpec to convert.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_Descriptor::MakeProcessSerialNumber (  ProcessSerialNumber  inPSN  )  [inherited]
 

Make a descriptor for the passed in MacOS ProcessSerialNumber.

Parameters:
inPSN The process serial number to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeObjectSpecifier (  DescType  inDesiredClass,
CP_AE_Descriptor  inContainer,
DescType  inKeyForm,
CP_AE_Descriptor  inKeyData,
bool  inDisposeInputs
)  [inherited]
 

Make an object specifier from the passed in data.

Parameters:
inDesirecClass The DescType type of class we are trying to create.
inContainer The CP_AE_Descriptor that is the container of ourselves.
inKeyForm The DescType inKeyForm of the specifier.
inKeyData The CP_AE_Descriptor of the key data.
inDisposeInputs If true, the memory for the input data is disposed of.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeCompDescriptor (  DescType  inComparisonOperator,
DescType  inPropertyIdentifier,
CP_AE_Descriptor  inCompareWith,
bool  inDisposeInputs
)  [inherited]
 

Make an comp descriptor.

Parameters:
inComparisonOperator The DescType of the comparison operator.
inPropertyIdentifier The property identifier.
inCompareWith Objecct to compare with &fAEDesc objecct.
inDisposeInputs Flag to indicate the input objects should be disposed of.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeEnumeration (  const DescType  inEnumeration  )  [inherited]
 

Make an enumeration for &fAEDesc descriptor.

Parameters:
inEnumeration The enumeration to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeDescType (  const DescType  inData  )  [inherited]
 

Make a DescType descriptor.

Parameters:
inData DescType to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeKeyword (  const AEKeyword  inKeyword  )  [inherited]
 

Make an an AEKeyword for &fAEDesc descriptor.

Parameters:
inKeyword The keyword to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeOrdinal (  const DescType  inData  )  [inherited]
 

Make an an ordinal for &fAEDesc descriptor.

Parameters:
inData The data to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeTypeOrInteger (  const DescType  inData  )  [inherited]
 

Make &fAEDesc object either a type or an integer based upon inData. &fAEDesc is useful for debugging; it makes a 'type' if the data appears to consist of printable characters (e.g. 'ABCD'), but otherwise it makes an integer (e.g. -12).

Parameters:
inData The DescType of the type we want to become.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::AdoptHandle (  DescType  inDataType,
Handle  inHandle
)  [inherited]
 

Assign the inDataType and inHandle to &fAEDesc object.

Parameters:
inDataType The type of data we want.
inHandle The data to convert.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::AdoptDesc (  const AEDesc &  inDescriptor  )  [inherited]
 

Adopt the passed in CP_AE_Descriptor object.

Parameters:
inDescriptor The descriptor to use in the conversion.
Exceptions:
none. 
Returns:
void

bool CP_AE_Descriptor::IsNullDescriptor (   )  const [inherited]
 

Return true if this is a NULL descriptor, ie doesn't describe anything.

Exceptions:
none 
Returns:
bool const True if this is a NULL desciptor.

bool CP_AE_Descriptor::IsNullDataHandle (   )  const [inherited]
 

Return true if the data handle is NULL.

Exceptions:
none 
Returns:
bool const True if the data handle is NULL.

void CP_AE_Descriptor::swap (  CP_AE_Descriptor &  inOutDescriptor  )  throw () [inherited]
 

Member Data Documentation

SInt16 CP_AE_AppleEvent::fCanUseSelfSend [protected]
 

AEDesc CP_AE_Descriptor::fAEDesc [inherited]
 

The documentation for this class was generated from the following files:
Generated on Tue Sep 20 20:21:31 2005 for CPLAT_MacOS by  doxygen 1.4.0