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

CP_Event< kEventClassControl, kEventControlInitialize > Class Template Reference

Inheritance diagram for CP_Event< kEventClassControl, kEventControlInitialize >:

CP_Event_Base CP_Event_Imp List of all members.

Public Member Functions

Constructor / Destructor
 CP_Event (CP_Event_Base &inEvent)
 Constructor.
Event Info
void ReturnInfo ()

Public Attributes

UInt32 fFeatures

Protected Attributes

OSStatus fStatus

template<>
class CP_Event< kEventClassControl, kEventControlInitialize >

Member Function Documentation

CP_Event< kEventClassControl, kEventControlInitialize >::CP_Event (  CP_Event_Base &  inEvent  ) 
 

Carbon Event handler for the kEventControlInitialize event.

Extracts the following fields:

  • none

Parameters:
inEvent The base event that contains the Carbon Event information for this event.
Exceptions:
none 
Returns:
void

void CP_Event< kEventClassControl, kEventControlInitialize >::ReturnInfo (   ) 
 

Returns information for this initialization event.

Returns the following fields to the sender:

  • typeUInt32 Control features of the control this event was sent to.

Parameters:
inEvent The base event that contains the Carbon Event information for this event.
Exceptions:
none 
Returns:
void

OSStatus CP_Event_Base::GetStatus (   )  [inherited]
 

Returns the status of the event. This will be the status returned to the underlying OS.

Exceptions:
none 
Returns:
OSStatus The OSStatus code returned to the OS.

void CP_Event_Base::SetStatus (  OSStatus  inStatus  )  [inherited]
 

Sets the status of the event. This will be the status returned to the underlying OS.

Parameters:
inStatus The status thats going to be returned to the underlying OS.
Exceptions:
none 
Returns:
void

CP_Event_Imp::operator EventRef & (   )  [inherited]
 

operator EventRef for returning the EventRef for this event.

Returns:
EventRef Returns a reference to the EventRef for this event.

EventRef CP_Event_Imp::GetEventRef (   )  [inherited]
 

Returns the EventRef for this event.

Returns:
EventRef Returns a reference to the EventRef for this event.

CP_Event_Imp::operator EventHandlerCallRef & (   )  [inherited]
 

operator EventHanlerCallRef for returning the EventHandlerCallRef for this event.

Returns:
EventHandlerCallRef Returns a reference to the EventHandlerCallRef for this event.

EventHandlerCallRef CP_Event_Imp::GetEventHandlerCallRef (   )  [inherited]
 

Returns the EventHandlerCallRef for this event.

Returns:
EventHandlerCallRef Returns a reference to the EventHandlerCallRef for this event.

void CP_Event_Imp::StoreExceptionInfo (  EventRef  inEvent,
const std::exception &  inEx
)  throw () [static, inherited]
 

Not yet implemented.

Parameters:
inEvent Not yet implemented.
inHandlerCallRef Not yet implemented.
Exceptions:
none 

void CP_Event_Imp::RethrowException (  EventRef  inEvent,
OSStatus  inStatus
)  [static, inherited]
 

Not yet implemented.

Parameters:
inEvent Not yet implemented.
inStatus Not yet implemented.
Exceptions:
none 

UInt32 CP_Event_Imp::GetClass (   )  const [virtual, inherited]
 

Return the event class for this CarbonEvent.

Exceptions:
none 
Returns:
UInt32 const The event class for this event.

UInt32 CP_Event_Imp::GetKind (   )  const [virtual, inherited]
 

Return the event kind for this CarbonEvent.

Exceptions:
none 
Returns:
UInt32 const The event kind for this event.

OSStatus CP_Event_Imp::GetParameter (  EventParamName  inName,
EventParamType  inType,
UInt32  inBufferSize,
void *  outData
)  [inherited]
 

Generic method to return a parameter from this CarbonEvent. There are many template version that can be used to retrieve specific types, and are prefererred over calling this directly.

This will return a CP_paramErr if the passed in buffer is NULL.

Parameters:
inName Name of the parameter to get.
inType Type of the parameter to get.
inBufferSize Size of the buffer to hold the returned result in.
outData Buffer to hold the returned result in.
Exceptions:
none 
Returns:
OSStatus Result code from the CarbonEvent Manager.

OSStatus CP_Event_Imp::GetParameter (  EventParamName  inName,
HICommand *  outValue
)  [inherited]
 

Method to return an HICommand parameter

Parameters:
inName Name of the parameter to get.
outValue Buffer to hold the returned HICommand
Exceptions:
none 
Returns:
OSStatus Result code from the CarbonEvent Manager.

template<class T>
OSStatus CP_Event_Imp::GetParameter (  EventParamName  inName,
EventParamType  inType,
T *  outValue
)  [inherited]
 

Template method for getting a parameter out of the CarbonEvent. This method is used by the specific parametter getters to return a specific type of parameter from this event.

Parameters:
inName EventParamName of the parameter to return.
inType EventParamType of the parameter to return.
Returns:
OSStatus CarbonEvent Manager result of the operation.

void CP_Event_Imp::Retain (   )  [inherited]
 

Retain this event. Calls on the CarbonEvent Manager to perform the retain.

Exceptions:
none 
Returns:
void

void CP_Event_Imp::Release (   )  [inherited]
 

Release this event. Calls on the CarbonEvent Manager to perform the release.

Exceptions:
none 
Returns:
void

void CP_Event_Imp::Send (  EventTargetRef  inTarget,
OptionBits  inOptionBits = 0
)  [inherited]
 

Sends the event to the passed in target reference.

Parameters:
inTarget Event target to send the event to.
inOptionBits Options to be sent for the event.
Exceptions:
none 
Returns:
void

OSStatus CP_Event_Imp::Send (  EventTargetRef  inTarget,
const std::nothrow_t &  ,
OptionBits  inOptionBits = 0
)  throw () [inherited]
 

Sends the event to the passed in target reference.

Parameters:
inTarget Event target to send the event to.
nothrow 
inOptionBits Options to be sent for the event.
Exceptions:
none 
Returns:
void

void CP_Event_Imp::Set (  EventRef  inEvent,
EventHandlerCallRef  inHandlerCallRef
)  [inherited]
 

Sets the event reference information for this event, and then calls Retain().

Parameters:
inEvent MacOS CarbonEvent EventRef for this event.
inHandlerCallRef MacOS CarbonEvent EventHandlerCallRef for this event.
Exceptions:
none 
Returns:
void

void CP_Event_Imp::CopyImpFields (  const CP_Event_Imp &  inEventImp  )  [protected, inherited]
 

Copyies the CP_Event_Imp fields for this class.

Parameters:
inEventImp The CP_Event_Imp fields to copy.
Exceptions:
none 
Returns:
void

Member Data Documentation

UInt32 CP_Event< kEventClassControl, kEventControlInitialize >::fFeatures
 

OSStatus CP_Event_Base::fStatus [protected, inherited]
 

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