sipXcallLib home page

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

#include <PtPhoneTextDisplay.h>

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

Public Member Functions

virtual PtStatus setDisplay (char *displayInfo, int x, int y)
 
virtual PtStatus getDisplay (char *&rpContents, int maxLen, int x, int y)
 param: (in) displayInfo - the string to be displayed param: (in) x,y - The starting coordinates for displaying the string retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getDisplayColumns (int &rNumColumns)
 param: (in) rpContents - A pointer to the copy of the displayed string param: (in) maxLen - Size of the rpContents character array param: (in) x,y - The starting coordinates for displaying the string retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getDisplayRows (int &rNumRows)
 param: (out) rNumColumns - The number of display columns retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
- Public Member Functions inherited from PtPhoneDisplay
 PtPhoneDisplay (TaoClientTask *pClient, int type=PtComponent::DISPLAY)
 
 PtPhoneDisplay (int type=PtComponent::DISPLAY)
 
 PtPhoneDisplay (const PtPhoneDisplay &rPtPhoneDisplay)
 
PtPhoneDisplay & operator= (const PtPhoneDisplay &rhs)
 
virtual ~PtPhoneDisplay ()
 
PtStatus setContrast (int level)
 
PtStatus getContrast (int &rLevel, int &rLow, int &rHigh, int &rNominal)
 
- Public Member Functions inherited from PtComponent
 PtComponent ()
 
 PtComponent (const PtComponent &rPtComponent)
 
PtComponent & operator= (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 Member Functions

 PtPhoneTextDisplay ()
 
virtual ~PtPhoneTextDisplay ()
 

Protected Attributes

int mType
 param: (out) rNumRows - The number of display rows retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
char * mpName
 
- Protected Attributes inherited from PtPhoneDisplay
TaoClientTask * mpClient
 
OsTime mTimeOut
 
- Protected Attributes inherited from PtComponent
int mType
 
char mpName [21]
 

Private Member Functions

 PtPhoneTextDisplay (const PtPhoneTextDisplay &rPtPhoneTextDisplay)
 
PtPhoneTextDisplay & operator= (const PtPhoneTextDisplay &rhs)
 

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

PtPhoneTextDisplay ( )
protected
~PtPhoneTextDisplay ( )
protectedvirtual
PtPhoneTextDisplay ( const PtPhoneTextDisplay &  rPtPhoneTextDisplay)
private

Member Function Documentation

PtStatus getDisplay ( char *&  rpContents,
int  maxLen,
int  x,
int  y 
)
virtual

param: (in) displayInfo - the string to be displayed param: (in) x,y - The starting coordinates for displaying the string retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getDisplayColumns ( int &  rNumColumns)
virtual

param: (in) rpContents - A pointer to the copy of the displayed string param: (in) maxLen - Size of the rpContents character array param: (in) x,y - The starting coordinates for displaying the string retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getDisplayRows ( int &  rNumRows)
virtual

param: (out) rNumColumns - The number of display columns retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtPhoneTextDisplay & operator= ( const PtPhoneTextDisplay &  rhs)
private
PtStatus setDisplay ( char *  displayInfo,
int  x,
int  y 
)
virtual

Member Data Documentation

char* mpName
protected
int mType
protected

param: (out) rNumRows - The number of display rows retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

param: (out) rpName - The reference used to return the name retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available param: (out) rType - The reference used to return the component type retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available