sipXcallLib home page


Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
PtTerminalComponentListener Class Reference

#include <PtTerminalComponentListener.h>

Inheritance diagram for PtTerminalComponentListener:
Inheritance graph
[legend]
Collaboration diagram for PtTerminalComponentListener:
Collaboration graph
[legend]

Public Member Functions

PT_CLASS_INFO_MEMBERS PtTerminalComponentListener (const char *name=NULL, PtEventMask *pMask=NULL)
 
virtual ~PtTerminalComponentListener ()
 param: (in) pMask - Event mask defining events the listener is interested in. This must be a subset of the events that the listener supports. The mask may be NULL where it is assumed that all events applicable to the derived listener are of interest. More...
 
virtual void phoneRingerVolumeChanged (const PtComponentIntChangeEvent &rEvent)
 
virtual void phoneRingerPatternChanged (const PtComponentIntChangeEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneRingerInfoChanged (const PtComponentStringChangeEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneSpeakerVolumeChanged (const PtComponentIntChangeEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneMicrophoneGainChanged (const PtComponentIntChangeEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneLampModeChanged (const PtComponentIntChangeEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneButtonInfoChanged (const PtComponentStringChangeEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneButtonUp (const PtTerminalComponentEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneButtonDown (const PtTerminalComponentEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneButtonRepeat (const PtTerminalComponentEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneHookswitchOffhook (const PtTerminalComponentEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneHookswitchOnhook (const PtTerminalComponentEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneDisplayChanged (const PtTerminalComponentEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneHandsetVolumeChanged (const PtComponentIntChangeEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneExtSpeakerConnected (const PtTerminalComponentEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual void phoneExtSpeakerDisconnected (const PtTerminalComponentEvent &rEvent)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
virtual PtBoolean isClass (const char *pClassName)
 returns: Returns the string representation of the name of this class More...
 
virtual PtBoolean isInstanceOf (const char *pClassName)
 param: (in) pClassName - the string to compare with the name of this class. retcode: TRUE - if the given string contains the class name of this class. retcode: FALSE - if the given string does not match that of this class More...
 
- Public Member Functions inherited from PtTerminalListener
PT_CLASS_INFO_MEMBERS PtTerminalListener (const char *pTerminalName=NULL, PtEventMask *pMask=NULL)
 
virtual ~PtTerminalListener ()
 param: (in) pMask - Event mask defining events the listener is interested. This must be a subset of the events that the listener supports. The mask may be NULL where it is assumed that all events applicable to the derived listener are of interest. More...
 
void terminalEventTransmissionEnded (const PtTerminalEvent &rEvent)
 
PtStatus setTerminalName (const char *name)
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
PtStatus getTerminalName (char *name, int len)
 
- Public Member Functions inherited from PtEventListener
PT_CLASS_INFO_MEMBERS PtEventListener (PtEventMask *pMask=NULL)
 
virtual ~PtEventListener ()
 param: (in) pMask - Event mask defining events the listener is interested in. This must be a subset of the events that the listener supports. The mask may be NULL where it is assumed that all events applicable to the derived listener are of interest. More...
 
PtStatus getEventMask (const PtEventMask *&rpMask) const
 
PtBoolean isEventEnabled (PtEvent::PtEventId &eventId)
 param: (in) pClassName - The string to compare with the name of this class retcode: TRUE - If this object is either an instance of or is derived from the specified class retcode: FALSE - If this object is not an instance of the specified class More...
 

Static Public Member Functions

static const char * className ()
 param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
 
- Static Public Member Functions inherited from PtTerminalListener
static const char * className ()
 
- Static Public Member Functions inherited from PtEventListener
static const char * className ()
 param: (out) rpMask - Reference to a pointer to the PtEventMask. retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 

Protected Member Functions

 PtTerminalComponentListener (const PtTerminalComponentListener &rPtTerminalComponentListener)
 param: (in) pClassName - the string to compare with the name of this class. retcode: TRUE - if this object is either an instance of or is derived from the specified class. retcode: FALSE - if this object is not an instance of the specified class. More...
 
PtTerminalComponentListeneroperator= (const PtTerminalComponentListener &rhs)
 

Additional Inherited Members

- Protected Attributes inherited from PtTerminalListener
char * mpTerminalName
 param: (in) pClassName - the string to compare with the name of this class. retcode: TRUE - if this object is either an instance of or is derived from the specified class. retcode: FALSE - if this object is not an instance of the specified class. More...
 
- Protected Attributes inherited from PtEventListener
PtEventMaskmpMask
 param: (in) eventId - The event id corresponding to the event type retcode: TRUE - If the given event type is of interest to this listener retcode: FALSE - If the given event type is NOT of interest to this listener More...
 

Constructor & Destructor Documentation

PtTerminalComponentListener ( const char *  name = NULL,
PtEventMask pMask = NULL 
)

param: (in) pMask - Event mask defining events the listener is interested in. This must be a subset of the events that the listener supports. The mask may be NULL where it is assumed that all events applicable to the derived listener are of interest.

PtTerminalComponentListener ( const PtTerminalComponentListener rPtTerminalComponentListener)
protected

param: (in) pClassName - the string to compare with the name of this class. retcode: TRUE - if this object is either an instance of or is derived from the specified class. retcode: FALSE - if this object is not an instance of the specified class.

Member Function Documentation

static const char* className ( )
static

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

virtual PtBoolean isClass ( const char *  pClassName)
virtual

returns: Returns the string representation of the name of this class

Reimplemented from PtTerminalListener.

virtual PtBoolean isInstanceOf ( const char *  pClassName)
virtual

param: (in) pClassName - the string to compare with the name of this class. retcode: TRUE - if the given string contains the class name of this class. retcode: FALSE - if the given string does not match that of this class

Reimplemented from PtTerminalListener.

PtTerminalComponentListener & operator= ( const PtTerminalComponentListener rhs)
protected
void phoneButtonDown ( const PtTerminalComponentEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneButtonInfoChanged ( const PtComponentStringChangeEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneButtonRepeat ( const PtTerminalComponentEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneButtonUp ( const PtTerminalComponentEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneDisplayChanged ( const PtTerminalComponentEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneExtSpeakerConnected ( const PtTerminalComponentEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneExtSpeakerDisconnected ( const PtTerminalComponentEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneHandsetVolumeChanged ( const PtComponentIntChangeEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneHookswitchOffhook ( const PtTerminalComponentEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneHookswitchOnhook ( const PtTerminalComponentEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneLampModeChanged ( const PtComponentIntChangeEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneMicrophoneGainChanged ( const PtComponentIntChangeEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneRingerInfoChanged ( const PtComponentStringChangeEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneRingerPatternChanged ( const PtComponentIntChangeEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void phoneRingerVolumeChanged ( const PtComponentIntChangeEvent rEvent)
virtual
void phoneSpeakerVolumeChanged ( const PtComponentIntChangeEvent rEvent)
virtual

param: (in) rEvent - Reference to the PtEvent containing the specific event information.