mainpage.dox

国内著名嵌入式培训机构内部资料,内含一些实例代码,包括技术专题书籍

/*! \mainpage Editor Example
 *
 * \ref Intro_sec
 * \n\ref UI_sec
 * \n\ref Implementation_sec
 *
 * <HR>
 *
 * \section Intro_sec 1. About this Example
 *
 * This tutorial explains how to use the editor window in Avkon
 * applications. The example application consists of a multiline text editor.
 *
 * In the editor example application, the following features are provided.
 *
 * - Clearing the text
 * - Changing the font
 * - Using clipboard (copying, cutting and pasting)
 * - Saving the text in a file and opening the file
 *
 * \subsection Sub11 1.1 APIs demonstrated
 *
 * The key classes of the Editor example are CEikEdwin and CEikGlobalTextEditor.
 *
 * <HR>
 *
 * \section UI_sec 2. User Interface
 *
 * This section shows how the editor window is displayed to users and
 * explains how to use its features with the Editor example application.
 *
 * The features are accessed from the \b Options menu. To display the
 * \b Options menu, press the left soft key in initial view.
 *
 * The main screen of the Editor example is below.
 *
 * \image html image_editor01.gif
 *
 * \subsection Sub21 2.1 Clearing text
 *
 * To clear the text, select <B>Clear text</B> in the <B>Options</B> menu.
 *
 * \subsection Sub22 2.2 Scrolling text
 *
 * To scroll the text, select <B>Scroll text</B> in the <B>Options</B> menu and
 * choose <B>Scroll up</B> or <B>Scroll down</B>.
 *
 * \image html image_editor02.gif
 *
 * \subsection Sub23 2.3 Changing font
 *
 * To change the font of the text, select <B>Set font</B> in the <B>Options</B>
 * menu and choose the new font.
 *
 * \image html image_editor03.gif
 *
 * \subsection Sub24 2.4 Cliboard operations
 *
 * To perform clipboard operations such as selecting text, copying and pasting,
 * select <B>Clipboard</B> in the <B>Options</B> menu and choose the appropriate
 * command.
 *
 * \image html image_editor04.gif
 *
 * \subsection Sub25 2.5 File operations
 *
 * To save the text to a file or to open a file, select <B>File</B> in the
 * <B>Options</B> menu and choose <B>Save text to a file</B> or <B>Open a
 * file</B>. A text file must be saved, before it can be opened.
 *
 * \image html image_editor05.gif
 *
 *
 * \section Implementation_sec 3. Implementation
 *
 * \subsection Sub31 3.1 Resources
 *
 * The example application defines the editing window by using the following
 * resource definition:
 *
 * \code
 * RESOURCE GTXTED r_aknexeditor_view_gtexted
 *     {
 *     flags = EAknEditorFlagDefault;
 *     avkon_flags = EAknEditorFlagEnableScrollBars;
 *     width = qnn_aknexeditor_view_gtexted_width;
 *     height = qnn_aknexeditor_view_gtexted_height;
 *     numlines = qnn_aknexeditor_view_gtexted_numlines;
 *     textlimit= qnn_aknexeditor_view_gtexted_textlimit;
 *     fontcontrolflags = EGulFontControlAll;
 *     fontnameflags = EGulNoSymbolFonts;
 *     }
 * \endcode
 *
 * The Avkon flag EAknEditorFlagEnableScrollBars enables the vertical scrollbar.
 *
 * \subsection Sub32 3.2 Constructing the editor window
 *
 * To construct an editor from a resouce, the first-phase constructor must be
 * called. After that, the editor can be constructed by using
 * ConstructFromResourceL function. Because the container does not perform any
 * drawing, SetBlank function is called. This is done in
 * CAknExEditorContainer::ConstructL.
 *
 * \subsection Sub33 3.3 Implementation of other features
 *
 * Clipboard functions are implemented by calling function
 * CEikEdwin::EnableCcpuSupportL( ETrue ) in the ConstructL function. After
 * that, the cut, copy and paste functions are accessible. The scrolling feature
 * is done by using MoveCursorL function. Saving to a file uses
 * CPlainText::ExportAsTextL and opening a file uses
 * CEikEdwin::InsertFromTextFileL.

 * The example application handles resolution change while the application is
 * running. This is achieved by implementing function
 * \link CAknExEditorAppUi::HandleResourceChangeL HandleResourceChangeL \endlink
 * in application UI class. In case the resolution changes, it calls function
 * \link CAknExEditorView::HandleViewRectChange HandleViewRectChange \endlink
 * in the view class. Finally, the view calls container's
 * SetRect function, which results in a call to container's
 * CAknExEditorContainer::SizeChanged
 * function, in which the logic is implemented.
 *
 *
 */