PsMsg Class Reference

#include <PsMsg.h>

Inheritance diagram for PsMsg:

Collaboration diagram for PsMsg:

Public Types
enum	PsMsgType {   BUTTON_DOWN, BUTTON_REPEAT, BUTTON_UP, KEY_DOWN,   KEY_UP, HOOKSW_STATE, KEYPAD_STATE, SCROLL_CHANGE,   SCROLL_STATE, TOUCHSCREEN_CHANGE, TOUCHSCREEN_STATE, BUTTON_PRESS,   BUTTON_GET_INFO, BUTTON_SET_INFO, BUTTON_GET_PHONELAMP, HOOKSW_GET_STATE,   HOOKSW_SET_STATE, HOOKSW_GET_CALL, LAMP_GET_MODE, LAMP_GET_SUPPORTED_MODES,   LAMP_GET_BUTTON, LAMP_SET_MODE, DISPLAY_GET_DISPLAY, DISPLAY_GET_ROWS,   DISPLAY_GET_COLS, DISPLAY_SET_DISPLAY, MIC_GET_GAIN, MIC_SET_GAIN,   RINGER_SET_INFO, RINGER_SET_PATTERN, RINGER_SET_VOLUME, RINGER_GET_INFO,   RINGER_GET_PATTERN, RINGER_GET_VOLUME, RINGER_GET_MAX_PATTERN_INDEX, RINGER_GET_NUMBER_OF_RINGS,   RINGER_IS_ON, SPEAKER_SET_VOLUME, SPEAKER_GET_VOLUME, EXTSPEAKER_CONNECT,   EXTSPEAKER_DISCONNECT, PHONECOMPONENT_GET_TYPE, PHONECOMPONENT_GET_NAME, HANDSET_SET_VOLUME,   HANDSET_SET_GAIN, PHONEGROUP_ACTIVATE, PHONEGROUP_DEACTIVATE, PHONEGROUP_GET_COMPONENTS,   PHONEGROUP_GET_DESCRIPTION, PHONEGROUP_GET_TYPE, PHONEGROUP_IS_ACTIVATED, TERMINAL_GET_COMPONENT,   TERMINAL_GET_COMPONENTS, TERMINAL_GET_COMPONENTGROUPS }

Public Member Functions
	PsMsg (int msg, void *source, const int param1, const int param2)
	PsMsg (const PsMsg &rPsMsg)
virtual OsMsg *	createCopy (void) const
virtual	~PsMsg ()
PsMsg &	operator= (const PsMsg &rhs)
void	setMsgSource (void *source)
void	setParam1 (int param1)
void	setParam2 (int param2)
void	setStringParam1 (const char *str)
void	setStringParam2 (const char *str)
void	setInUse (UtlBoolean isInUse)
virtual int	getMsg (void) const
virtual void *	getMsgSource (void) const
virtual int	getParam1 (void) const
virtual int	getParam2 (void) const
void	getStringParam1 (UtlString &stringData)
void	getStringParam2 (UtlString &stringData)
UtlBoolean	isInUse (void)

Private Attributes
UtlBoolean	mInUse
void *	mMsgSource
int	mParam1
int	mParam2
char	mStringParam1 [PSMSG_MAX_STRINGPARAM_LENGTH+1]
char	mStringParam2 [PSMSG_MAX_STRINGPARAM_LENGTH+1]

Member Enumeration Documentation

enum PsMsgType

Enumerator
BUTTON_DOWN
BUTTON_REPEAT
BUTTON_UP
KEY_DOWN
KEY_UP
HOOKSW_STATE
KEYPAD_STATE
SCROLL_CHANGE
SCROLL_STATE
TOUCHSCREEN_CHANGE
TOUCHSCREEN_STATE
BUTTON_PRESS
BUTTON_GET_INFO
BUTTON_SET_INFO
BUTTON_GET_PHONELAMP
HOOKSW_GET_STATE
HOOKSW_SET_STATE
HOOKSW_GET_CALL
LAMP_GET_MODE
LAMP_GET_SUPPORTED_MODES
LAMP_GET_BUTTON
LAMP_SET_MODE
DISPLAY_GET_DISPLAY
DISPLAY_GET_ROWS
DISPLAY_GET_COLS
DISPLAY_SET_DISPLAY
MIC_GET_GAIN
MIC_SET_GAIN
RINGER_SET_INFO
RINGER_SET_PATTERN
RINGER_SET_VOLUME
RINGER_GET_INFO
RINGER_GET_PATTERN
RINGER_GET_VOLUME
RINGER_GET_MAX_PATTERN_INDEX
RINGER_GET_NUMBER_OF_RINGS
RINGER_IS_ON
SPEAKER_SET_VOLUME
SPEAKER_GET_VOLUME
EXTSPEAKER_CONNECT
EXTSPEAKER_DISCONNECT
PHONECOMPONENT_GET_TYPE
PHONECOMPONENT_GET_NAME
HANDSET_SET_VOLUME
HANDSET_SET_GAIN
PHONEGROUP_ACTIVATE
PHONEGROUP_DEACTIVATE
PHONEGROUP_GET_COMPONENTS
PHONEGROUP_GET_DESCRIPTION
PHONEGROUP_GET_TYPE
PHONEGROUP_IS_ACTIVATED
TERMINAL_GET_COMPONENT
TERMINAL_GET_COMPONENTS
TERMINAL_GET_COMPONENTGROUPS

Constructor & Destructor Documentation

PsMsg	(	int	msg,
		void *	source,
		const int	param1,
		const int	param2
	)

PsMsg

(

const PsMsg &

rPsMsg

)

~PsMsg ( )

virtual

Member Function Documentation

OsMsg * createCopy ( void  ) const

virtual

int getMsg ( void  ) const

virtual

void * getMsgSource ( void  ) const

virtual

int getParam1 ( void  ) const

virtual

int getParam2 ( void  ) const

virtual

void getStringParam1

(

UtlString &

stringData

)

void getStringParam2

(

UtlString &

stringData

)

UtlBoolean isInUse

(

void

)

PsMsg & operator=

(

const PsMsg &

rhs

)

void setInUse

(

UtlBoolean

isInUse

)

void setMsgSource

(

void *

source

)

void setParam1

(

int

param1

)

void setParam2

(

int

param2

)

void setStringParam1

(

const char *

str

)

void setStringParam2

(

const char *

str

)

Member Data Documentation

UtlBoolean mInUse

private

void* mMsgSource

private

int mParam1

private

int mParam2

private

char mStringParam1[PSMSG_MAX_STRINGPARAM_LENGTH+1]

private

char mStringParam2[PSMSG_MAX_STRINGPARAM_LENGTH+1]

private