File: PsButtonInfo.h

package info (click to toggle)
sipxtapi 3.3.0~test18%2Bdfsg.1-0.1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 55,892 kB
  • sloc: cpp: 435,979; ansic: 14,207; makefile: 2,491; java: 2,264; sh: 1,310; perl: 844; xml: 225; awk: 5
file content (110 lines) | stat: -rw-r--r-- 2,683 bytes parent folder | download | duplicates (5)
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
//
// 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 _PsButtonInfo_h_
#define _PsButtonInfo_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsTime.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

//:Phone set button information
class PsButtonInfo
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   enum EventTypes
   {
      UNSPECIFIED   = 0,
      BUTTON_DOWN   = 0x1,
      BUTTON_UP     = 0x2,
      KEY_DOWN      = 0x4,  //a key hit on NT
      KEY_UP        = 0x8,
      BUTTON_REPEAT = 0x16
   };

   enum ButtonState
   {
      UP,
      DOWN
   };

/* ============================ CREATORS ================================== */

   PsButtonInfo(int buttonId=-1,
                                const char* name="",
                                int eventMask=BUTTON_DOWN|BUTTON_UP,
                const OsTime& repeatInterval=OsTime::OS_INFINITY);
     //:Constructor

   PsButtonInfo(const PsButtonInfo& rPsButtonInfo);
     //:Copy constructor

   virtual
   ~PsButtonInfo();
     //:Destructor

/* ============================ MANIPULATORS ============================== */

   PsButtonInfo& operator=(const PsButtonInfo& rhs);
     //:Assignment operator

   virtual void setState(int buttonState);
     //:Set the button state to either UP or DOWN

/* ============================ ACCESSORS ================================= */

   virtual int getEventMask(void) const;
     //:Return the set of event types that are being handled for this button

   virtual int getId(void) const;
     //:Return the button ID

   virtual char* getName(void) const;
     //:Return the button name

   virtual void getRepInterval(OsTime& repeatIntvl) const;
     //:Get the repeat interval for this button

   virtual int getState(void) const;
     //:Return the button state (UP or DOWN)

/* ============================ INQUIRY =================================== */

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   char*  mpButtonName;
   int    mButtonId;
   int    mButtonState;
   int    mEventMask;
   OsTime mRepeatInterval;


};

/* ============================ INLINE METHODS ============================ */

#endif  // _PsButtonInfo_h_