📄 mainpage.dox
字号:
/*! \mainpage Setting List Example
*
* \ref intro_sec
* \n\ref Pre_sec
* \n\ref Design_sec
* \n\ref Hierarchy_sec
*
* <HR>
*
* \section intro_sec 1. About this Example
*
* This tutorial explains how to use the setting list control for Avkon applications. With a setting list, users can display and modify properties of a device. For programmers, an understanding of the following is required:
*
* - Functions of the setting item list class
* - Resources
*
* In the setting list example application, the following functions are introduced:
*
* <b>Text</b> - Text is used as an item of the setting list
*
* <b>Slider</b> - The slider gauge is used as an item of the setting list
*
* <b>Volume</b> - The volume gauge is used as an item of the setting list
*
* <b>Enumerated text</b> - The options list is used as an item of the setting list
*
* <b>Date</b> - The date is used as an item of setting list
*
* <b>Time</b> - Time is used as an item of the setting list
*
* <b>Binary</b> - On/Off is used as an item of the setting list
*
* <b>Alphabetic password</b> - The alphabetic password is used as an item of the setting list
*
* <b>Numeric password</b> - The numeric password is used as an item of the setting list
*
* <b>IP address</b> - IP address style is used as an item of the setting list
*
* <HR>
*
* \section Pre_sec 2. Prerequisites
*
* This example makes use of the standard Symbian OS application framework, comprising the Application, Document, UI, and View classes. The reader should be aware of this architecture before attempting to understand this example.
*
* <HR>
*
* \section Design_sec 3. Design and Implementation
*
* \subsection Sub1 3.1 Capabilities
*
* The program capabilities are defined in aknexsettinglist.mmp file: CAPABILITY NONE.
*
* \subsection Sub2 3.2 ScalabaleUI
*
* The program takes screen parameters in the start of the application. The program does not support changing the screen layout while the program is running.
*
* \subsection Sub3 3.3 Design
*
* \subsection Sub4 3.3.1 Key classes
* To understand setting list functions, an understanding of many classes is required.
*
* The following shows the classes that an application programmer needs to know. These are the classes that are used to display and edit in the application.
* - CAknTextSettingItem
* - CAknIntegerSettingItem
* - CAknIntegerEdwinSettingItem
* - CAknPasswordSettingItem
* - CAknVolumeSettingItem
* - CAknSliderSettingItem
* - CAknTimeOrDateSettingItem
* - CAknIpFieldSettingItem
* - CAknEnumeratedItem
*
* When an application programmer wants to create another type of setting list control, it is necessary to derive it from the CAknSettingItem class.
*
* The application programmer must understand the following class that is used to manage the setting list controls:
*
* - CAknSettingItemList
*
* \subsection Sub5 3.3.2 Setting list classes
*
<table cellspacing=0 width=90% border=1>
<tr>
<td style="width:25%;" align="center" valign="top" width="25%" class="hcp14">
<p class=TableText
style="font-weight: bold; font-style: normal;"><i><span class="hcp15">Class</span></i></td>
<td style="width:25%;" align="center" valign="top" width="25%" class="hcp14">
<p class=TableText
style="font-weight: bold; font-style: normal;"><i><span class="hcp15">Definition</span></i></td>
<td style="width:50%;" align="center" valign="top" width="50%" class="hcp14">
<p class=TableText
style="font-weight: bold; font-style: normal;"><i><span class="hcp15">Description</span></i></td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined common interface for item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknTextSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for text item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknIntegerSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for integer item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknIntegerEdwinSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for edwin item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknPasswordSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for password item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknVolumeSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for volume item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknSliderSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for slider item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknTimeOrDateSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for time/date item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknIpFieldSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for IpField item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknEnumeratedItemBase</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined common interface for enumerated item in setting
list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknEnumeratedText</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for EnumeratedText in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknEnumeratedTextPopupSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknBinaryPopupSettingItem</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for On/Off item in setting list</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknBigSettingItemBase</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for BigSettingItemBase</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknSettingItemArray</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for SettingItemArray</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknSettingItemList</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingItemList.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for setting item listbox</td></tr>
<tr>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=CodeInTable><span class=CodeInText>CAknSettingPage</span></td>
<td style="width:25%;" valign="top" width="25%" class="hcp16">
<p class=TableText><span class=CodeInText>AknSettingPage.h</span></td>
<td style="width:50%;" valign="top" width="50%" class="hcp16">
<p class=TableText>defined interface for setting page</td></tr>
</table>
*
* \subsection Sub6 3.3.3 Using the Setting List
*
* To program the setting list, the following must be coded:
*
* - Defining resource data
* - Selecting the specific control to be used
* - Handling setting data that is set by an application user
*
* \subsection Sub7 3.3.3.1 Resource definition of the setting list
*
* \subsection Sub8 3.3.3.1.1 Resource structure
*
* The following is the resource structure to be defined in the resource file for the setting list:
*
<tr>
<td style="width:100%;" width="100%" class="hcp18"><span class=CodeInText>AVKON_SETTING_ITEM_LIST</span> <span
class=CodeInText>RESOURCE STRUCTURE</span></td></tr>
<tr>
<td style="width:100%;" width="100%" class="hcp18">
<table style="width:100%;" cellspacing="0" width="100%" border="1" class="hcp19">
<tr>
<td style="width:15%;" align="center" width="15%" class="hcp20">
<p class=TableText
style="font-style: normal;"><i><span class="hcp15">Type</span></i></td>
<td style="width:20%;" align="center" width="20%" class="hcp20">
<p class=TableText
style="font-style: normal;"><i><span class="hcp15">Signature</span></i></td>
<td style="width:65%;" align="center" width="65%" class="hcp20">
<p class=TableText
style="font-style: normal;"><i><span class="hcp15">Contents</span></i></td></tr>
<tr>
<td style="width:15%;" width="15%" class="hcp18">
<p class=TableText>WORD</td>
<td style="width:20%;" width="20%" class="hcp18">
<p class=TableText>flags=0</td>
<td style="width:65%;" width="65%" class="hcp18">
<p class=TableText>Allowed value:<span class=CodeInText>EAknSettingItemListNumberedStyle</span></td></tr>
<tr>
<td style="width:15%;" width="15%" class="hcp18">
<p class=TableText>LTEXT</td>
<td style="width:20%;" width="20%" class="hcp18">
<p class=TableText>title=""</td>
<td style="width:65%;" width="65%" class="hcp18">
<p class=TableText>Title text</td></tr>
<tr>
<td style="width:15%;" width="15%" class="hcp18">
<p class=TableText>WORD</td>
<td style="width:20%;" width="20%" class="hcp18">
<p class=TableText>initial_number=1</td>
<td style="width:65%;" width="65%" class="hcp18">
<p class=TableText>Set the ordinal value</td></tr>
<tr>
<td style="width:15%;" width="15%" class="hcp18">
<p class=TableText>STRUCT</td>
<td style="width:20%;" width="20%" class="hcp18">
<p class=TableText>items[]</td>
<td style="width:65%;" width="65%" class="hcp18">
<p class=TableText>item can be <span class=CodeInText>AVKON_SETTING_ITEM</span>
resource</td></tr>
</table></td></tr>
*
*
*
*
*
<tr>
<td style="width:100%;" width="100%" class="hcp18"><span class=CodeInText>REAVKON_SETTING_ITEM</span> <span
class=CodeInText>RESOURCE STRUCTUREPLACE</span></td></tr>
<tr>
<td style="width:100%;" width="100%" class="hcp18">
<table style="width:100%;" cellspacing="0" width="100%" border="1" class="hcp19">
<tr>
<td style="width:15%;" align="center" width="15%" class="hcp20">
<p class=TableText><i><span class="hcp15">Type</span></i></td>
<td style="width:20%;" align="center" width="20%" class="hcp20">
<p class=TableText><i><span class="hcp15">Signature</span></i></td>
<td style="width:65%;" align="center" width="65%" class="hcp20">
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -