sipXcallLib home page


Public Member Functions | Protected Attributes | Private Attributes | List of all members
PtPhoneButton Class Reference

#include <PtPhoneButton.h>

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

Public Member Functions

 PtPhoneButton ()
 
 PtPhoneButton (TaoClientTask *pClient, const char *name=0)
 
 PtPhoneButton (const PtPhoneButton &rPtPhoneButton)
 
PtPhoneButtonoperator= (const PtPhoneButton &rhs)
 
virtual ~PtPhoneButton ()
 
virtual PtStatus buttonPress (void)
 
virtual PtStatus setInfo (char *buttonInfo)
 retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
PtStatus setInfo2 (char *buttonInfo)
 param: (in) buttonInfo - The string to associate with this button retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getAssociatedPhoneLamp (PtPhoneLamp &rLamp)
 
PtStatus getInfo (char *pInfo, int maxLen)
 param: (out) rpLamp - The pointer to the associated lamp object retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
- Public Member Functions inherited from PtComponent
 PtComponent ()
 
 PtComponent (const PtComponent &rPtComponent)
 
PtComponentoperator= (const PtComponent &rhs)
 
 PtComponent (int componentType)
 
 PtComponent (const char *&rName)
 param: componentType - The type of telephone hardware modeled by this component More...
 
virtual ~PtComponent ()
 param: rName - The name of telephone hardware modeled by this component name: button name: hookswitch name: display name: graphic_display name: text_display name: lamp name: microphone name: ringer name: speaker name: unknown More...
 
void setGroupType (int groupType)
 
virtual PtStatus getName (char *rpName, int maxLen)
 
virtual PtStatus getType (int &rType)
 param: (out) rpName - The reference used to return the name retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 

Protected Attributes

char mpInfo [MAX_NAME_LENGTH+1]
 param: (out) pInfo - A pointer to the string associated with this button More...
 
TaoClientTaskmpClient
 
PtPhoneLampmpLamp
 
OsTime mTimeOut
 
- Protected Attributes inherited from PtComponent
int mType
 
char mpName [21]
 

Private Attributes

OsProtectEventMgr * mpEventMgr
 

Additional Inherited Members

- Public Types inherited from PtComponent
enum  ComponentType {
  BUTTON, DISPLAY, GRAPHIC_DISPLAY, HOOKSWITCH,
  LAMP, MICROPHONE, RINGER, SPEAKER,
  TEXT_DISPLAY, EXTERNAL_SPEAKER, UNKNOWN
}
 
- Public Attributes inherited from PtComponent
int mGroupType
 

Constructor & Destructor Documentation

PtPhoneButton ( TaoClientTask pClient,
const char *  name = 0 
)
PtPhoneButton ( const PtPhoneButton rPtPhoneButton)
~PtPhoneButton ( )
virtual

Member Function Documentation

PtStatus buttonPress ( void  )
virtual
PtStatus getAssociatedPhoneLamp ( PtPhoneLamp rLamp)
virtual
PtStatus getInfo ( char *  pInfo,
int  maxLen 
)

param: (out) rpLamp - The pointer to the associated lamp object retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtPhoneButton & operator= ( const PtPhoneButton rhs)
PtStatus setInfo ( char *  buttonInfo)
virtual

retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus setInfo2 ( char *  buttonInfo)

param: (in) buttonInfo - The string to associate with this button retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

Member Data Documentation

TaoClientTask* mpClient
protected
OsProtectEventMgr* mpEventMgr
private
char mpInfo[MAX_NAME_LENGTH+1]
protected

param: (out) pInfo - A pointer to the string associated with this button

PtPhoneLamp* mpLamp
protected
OsTime mTimeOut
protected