Dialogs API: API description

Dialogs API allows creating and using application-specific dialogs.

Dialogs use the dialog resource, defined in the application resource file (RSS). The runtime representations of dialogs are instances of the CEikDialog and CAknDialog classes, or any custom class deriving from the above. Derivation is used to add custom functionality, controls or behavior to standard dialogs.

Use cases

1. Defining the resource
   • Defining the dialog resource
   • Defining the dialog line resource
   • Defining the softkeys
   • Defining single-page dialog resource
   • Defining multi-page dialog resource
2. Creating and launching dialog
   • Creating dialog without menu
   • Creating dialog with menu
   • Launching the dialog
3. Accessing control in dialog
4. Implementing custom dialog
   • Providing the factory function
   • Initializing controls
   • Checking the exit condition
   • Adding custom control to dialog
   • Handling commands
   • Handling key events

API class structure

Many methods of CEikDialog can be overridden to provide custom behavior. If standard behavior and built-in components are sufficient, CEikDialog or CAknDialog can be used directly.

CAknDialog adds Options menu handling to CEikDialog.