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
107
108
109
110
111
112
113
114
|
//
// 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 _PsTaoButton_h_
#define _PsTaoButton_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "ps/PsTaoComponent.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class PsTaoLamp;
//:The PsTaoButton class models the keypad and feature buttons.
class PsTaoButton : public PsTaoComponent
{
friend class PsPhoneTask;
// The PsPhoneTask is responsible for creating and destroying
// all objects derived from the PsTaoComponent class. No other entity
// should invoke the constructors or destructors for these classes.
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
enum ButtonState
{
UP,
DOWN
};
/* ============================ CREATORS ================================== */
/* ============================ MANIPULATORS ============================== */
void buttonDown(void);
//:Press (and hold) the button down.
void buttonUp(void);
//:Release the button.
void buttonPress(void);
//:Press the button, effectively buttonDown() followed by buttonUp().
UtlBoolean setInfo(const UtlString& rInfo);
//:Sets the information associated with this button.
/* ============================ ACCESSORS ================================= */
PsTaoLamp* getAssociatedPhoneLamp(void);
//:Returns a pointer to the lamp associated with this button or NULL if
//:there is no associated lamp.
void getInfo(UtlString& rInfo);
//:Returns the information associated with this button.
/* ============================ INQUIRY =================================== */
UtlBoolean isButtonDown(void);
//:Returns TRUE if the button is down, otherwise FALSE.
UtlBoolean isButtonRepeating(void);
//:Returns TRUE if the button is repeating (and down), otherwise FALSE.
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
PsTaoButton(const UtlString& rComponentName, int componentType);
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
int mButtonState; // button state (up or down)
UtlString mButtonInfo; // button info
UtlBoolean mIsRepeating; // TRUE if button is repeating
UtlBoolean mbNotSetBefore; // TRUE if button info is not yet set
PsTaoLamp* mpAssocLamp; // pointer to the associated lamp
PsTaoButton(const UtlString& rName, const UtlString& rInfo);
//:Constructor
virtual
~PsTaoButton();
//:Destructor
void setAssociatedPhoneLamp(PsTaoLamp& rLamp);
PsTaoButton();
//:Default constructor (not implemented for this class)
PsTaoButton(const PsTaoButton& rPsTaoButton);
//:Copy constructor (not implemented for this class)
PsTaoButton& operator=(const PsTaoButton& rhs);
//:Assignment operator (not implemented for this class)
};
/* ============================ INLINE METHODS ============================ */
#endif // _PsTaoButton_h_
|
