diff -r f345bda72bc4 -r 43e37759235e Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_user_interface.html --- a/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_user_interface.html Tue Mar 30 11:56:28 2010 +0100 +++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_user_interface.html Tue Mar 30 16:16:55 2010 +0100 @@ -1,74 +1,66 @@ - - -TB10.1 Example Applications: CUserInterface Class Reference - - - - + + + + +TB9.2 Example Applications: CUserInterface Class Reference + + + + + +

CUserInterface Class Reference

-

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

List of all members.

+

Public Member Functions

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

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.

-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

- +

Definition at line 32 of file userinterface.h.

+

Constructor & Destructor Documentation

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

Destructor.

-

-Destructor. -

Definition at line 99 of file userinterface.cpp.

+

Definition at line 99 of file userinterface.cpp.

-

-

Member Function Documentation

- +
+

Member Function Documentation

+
- + @@ -82,31 +74,31 @@ - +
CUserInterface * CUserInterface::NewL CUserInterface * CUserInterface::NewL ( CConsoleBase *  aConsole,
) [static] [static]
- -

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

Parameters:
+

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.
+
Returns:
A CUserInterface object.
-

Definition at line 30 of file userinterface.cpp.

+

Definition at line 30 of file userinterface.cpp.

-

- + +

- + @@ -120,96 +112,96 @@ - +
void CUserInterface::Initialize void CUserInterface::Initialize ( CConsoleBase *  aConsole,
)
- -

-Initialize the data members of the CUserInterface class.

Parameters:
+

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.

+

Definition at line 42 of file userinterface.cpp.

-

- + +

- + - + - +
void CUserInterface::RunL 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:

+ -

-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.

+

Definition at line 61 of file userinterface.cpp.

-

- + +

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

Cancel any outstanding request.

-

-Cancel any outstanding request. -

Definition at line 87 of file userinterface.cpp.

+

Definition at line 87 of file userinterface.cpp.

-

- + +

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

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

-

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

Definition at line 74 of file userinterface.cpp.

+

Definition at line 74 of file userinterface.cpp.

-

- + +

- + @@ -223,32 +215,32 @@ - +
CUserInterface * CUserInterface::NewL CUserInterface * CUserInterface::NewL ( CConsoleBase *  aConsole,
) [static] [static]
- -

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

Parameters:
+

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.
+
Returns:
A CUserInterface object.
-

Definition at line 32 of file userinterface.cpp.

+

Definition at line 32 of file userinterface.cpp.

-

- + +

- + @@ -262,27 +254,28 @@ - +
void CUserInterface::Initialize void CUserInterface::Initialize ( CConsoleBase *  aConsole,
)
- -

-Initialize the data members of the CUserInterface class.

Parameters:
+

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.

+

Definition at line 45 of file userinterface.cpp.

-

-

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