diff -r 89d6a7a84779 -r 25a17d01db0c Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_user_interface.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_user_interface.html Fri Jan 22 18:26:19 2010 +0000 @@ -0,0 +1,288 @@ + + +TB10.1 Example Applications: CUserInterface Class Reference + + + + +

CUserInterface Class Reference

+

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

void Initialize (CConsoleBase *aConsole, CTimerEntry *aTimerEntry)
void RunL ()
void DoCancel ()
 ~CUserInterface ()
void ReadFunc ()
void Initialize (CConsoleBase *aConsole, CProducer *aProducer)
+void RunL ()
+void DoCancel ()
+void ReadFunc ()

Static Public Member Functions

static CUserInterface * NewL (CConsoleBase *aConsole, CTimerEntry *aTimerEntry)
static CUserInterface * NewL (CConsoleBase *aConsole, CProducer *aProducer)
+

Detailed Description

+This class processes key press events from the console. The example prints a menu and waits for the user to select an option from the menu. The CUserInterface::RunL() function handles the asynchronous key press event. +

Definition at line 32 of file userinterface.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
CUserInterface::~CUserInterface (  ) 
+
+
+ +

+Destructor. +

Definition at line 99 of file userinterface.cpp.

+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
CUserInterface * CUserInterface::NewL (CConsoleBase *  aConsole,
CTimerEntry *  aTimerEntry 
) [static]
+
+
+ +

+The static function to create an object of the CUserInterface class.

Parameters:
+ + + +
aConsole The console object.
aTimerEntry A pointer to an object of the CTimerEntry class.
+
+
Returns:
A CUserInterface object.
+ +

Definition at line 30 of file userinterface.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void CUserInterface::Initialize (CConsoleBase *  aConsole,
CTimerEntry *  aTimerEntry 
)
+
+
+ +

+Initialize the data members of the CUserInterface class.

Parameters:
+ + + +
aConsole The console object.
aTimerEntry A pointer to an object of the CTimerEntry class.
+
+ +

Definition at line 42 of file userinterface.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CUserInterface::RunL (  ) 
+
+
+ +

+Handles the key press events from the console. It stops the active scheduler if any key is pressed.

+Handles the key press events from the console. The following actions are defined for a key press event:

+ +

Definition at line 61 of file userinterface.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CUserInterface::DoCancel (  ) 
+
+
+ +

+Cancel any outstanding request. +

Definition at line 87 of file userinterface.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CUserInterface::ReadFunc (  ) 
+
+
+ +

+Issues an outstanding request to get a keystroke from the console. +

Definition at line 74 of file userinterface.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
CUserInterface * CUserInterface::NewL (CConsoleBase *  aConsole,
CProducer *  aProducer 
) [static]
+
+
+ +

+The static function to create an object of the CUserInterface class.

Parameters:
+ + + + +
aConsole The console object.
aProducer A pointer to an object of the CProducer class.
aConsumer A pointer to an object of the CConsumer class.
+
+
Returns:
A CUserInterface object.
+ +

Definition at line 32 of file userinterface.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void CUserInterface::Initialize (CConsoleBase *  aConsole,
CProducer *  aProducer 
)
+
+
+ +

+Initialize the data members of the CUserInterface class.

Parameters:
+ + + + +
aConsole The console object.
aProducer A pointer to an object of the CProducer class.
aConsumer A pointer to an object of the CConsumer class.
+
+ +

Definition at line 45 of file userinterface.cpp.

+ +
+

+

Generated on Thu Jan 21 10:33:08 2010 for TB10.1 Example Applications by  + +doxygen 1.5.3
+ +