1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _PtPhoneTextDisplay_h_
#define _PtPhoneTextDisplay_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "ptapi/PtPhoneDisplay.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
//:The PtPhoneTextDisplay class models a character display.
class PtPhoneTextDisplay : public PtPhoneDisplay
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/* ============================ CREATORS ================================== */
/* ============================ MANIPULATORS ============================== */
virtual PtStatus setDisplay(char* displayInfo, int x, int y);
//:Display the indicated information starting at coordinates (x, 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
/* ============================ ACCESSORS ================================= */
virtual PtStatus getDisplay(char*& rpContents, int maxLen, int x, int y);
//:Returns a copy of the displayed string starting at coordinates (x, y).
//!param: (in) rpContents - A pointer to the copy of the displayed string
//!param: (in) maxLen - Size of the <i>rpContents</i> 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
virtual PtStatus getDisplayColumns(int& rNumColumns);
//:Returns the number of display columns.
//!param: (out) rNumColumns - The number of display columns
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
virtual PtStatus getDisplayRows(int& rNumRows);
//:Returns the number of display rows.
//!param: (out) rNumRows - The number of display rows
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
// virtual PtStatus getName(char*& rpName);
//:Returns the name associated with this component.
//!param: (out) rpName - The reference used to return the name
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
// virtual PtStatus getType(int& rType);
//:Returns the type associated with this component.
//!param: (out) rType - The reference used to return the component type
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
/* ============================ INQUIRY =================================== */
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
int mType;
char* mpName;
PtPhoneTextDisplay();
//:Default constructor
virtual
~PtPhoneTextDisplay();
//:Destructor
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
PtPhoneTextDisplay(const PtPhoneTextDisplay& rPtPhoneTextDisplay);
//:Copy constructor (not implemented for this class)
PtPhoneTextDisplay& operator=(const PtPhoneTextDisplay& rhs);
//:Assignment operator (not implemented for this class)
};
/* ============================ INLINE METHODS ============================ */
#endif // _PtPhoneTextDisplay_h_
|
