Symbian3/SDK/Source/GUID-A5756C5F-9C93-4949-8B60-03DCA1BAF683.dita
changeset 8 ae94777fff8f
parent 7 51a74ef9ed63
child 13 48780e181b38
equal deleted inserted replaced
7:51a74ef9ed63 8:ae94777fff8f
     7     Nokia Corporation - initial contribution.
     7     Nokia Corporation - initial contribution.
     8 Contributors: 
     8 Contributors: 
     9 -->
     9 -->
    10 <!DOCTYPE concept
    10 <!DOCTYPE concept
    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
    12 <concept id="GUID-A5756C5F-9C93-4949-8B60-03DCA1BAF683" xml:lang="en"><title>Form
    12 <concept id="GUID-A5756C5F-9C93-4949-8B60-03DCA1BAF683" xml:lang="en"><title>Form items</title><prolog><metadata><keywords/></metadata></prolog><conbody>
    13 items</title><prolog><metadata><keywords/></metadata></prolog><conbody>
    13 <p>Form items can either be displayed or hidden (for empty items that
    14 <p>Empty items (that contain no data) can be hidden in a form's View state.
    14 contain no data) in a form's View state. </p>
    15 However, this is not a requirement; forms can be designed either way, whichever
    15 <p>Unlike ordinary list items, the form items may have different sizes
    16 is better for the given application.</p>
    16 in the layout but only in the Edit state. A long data field may occupy
    17 <p>Unlike ordinary list items, the form items may have different sizes in
    17 more than one line in the Edit state, but in the View state it is
    18 the layout but only in the Edit state. A long data field may occupy more than
    18 truncated to the first line.</p>
    19 one line in the Edit state, but in the View state it is truncated to the first
    19 <p>The user may be able to add and remove form items. This is done
    20 line.</p>
    20 with commands in the <uicontrol>Options</uicontrol> menu.</p>
    21 <p>The user may be able to add and remove form items. This is done with commands
    21 <p>Form items always have a label. The label has a text part, or a
    22 in the Options menu.</p>
    22 text and a graphical part; however, all items in one form must have
    23 <p>Form items always have a label. The label has a text part, or a text and
    23 the same column layout (see <xref href="GUID-CB548959-A1D6-4585-B8E3-B09E37E0CB43.dita">List layouts</xref> for detailed information about layouts). Field label cannot be directly
    24 a graphical part; however, all items in one form must have the same column
    24 edited even if the form is in Edit state. However, it is possible
    25 layout (see <xref href="GUID-CB548959-A1D6-4585-B8E3-B09E37E0CB43.dita">List layouts</xref> for
    25 to let the user edit the label text when the form is in edit state.
    26 detailed information about layouts). Field label cannot be directly edited
    26 User can choose to edit the label with an option, which can be found
    27 even if the form is in Edit state. However, it is possible to let the user
    27 in the <b>Options</b> menu.</p>
    28 edit the label text when the form is in edit state. User can choose to edit
    28 <p>The form field types that can be used are described in the following
    29 the label with an option, which can be found in the <b>Options</b> menu.</p>
    29 table:</p>
    30 <p>The form field types that can be used are described in the following table:</p>
    30 <table id="GUID-A22394D3-9C39-4DC2-8A65-255F985F97E9"><title> Form
    31 <table id="GUID-A22394D3-9C39-4DC2-8A65-255F985F97E9"><title> Form field types</title>
    31 field types</title>
    32 <tgroup cols="2"><colspec colname="col1" colwidth="0.30*"/><colspec colname="col2" colwidth="1.70*"/>
    32 <tgroup cols="2"><colspec colname="col1" colwidth="0.30*"/><colspec colname="col2" colwidth="1.70*"/>
    33 <thead>
    33 <thead>
    34 <row>
    34 <row>
    35 <entry>Field</entry>
    35 <entry>Field</entry>
    36 <entry>Description</entry>
    36 <entry>Description</entry>
    37 </row>
    37 </row>
    38 </thead>
    38 </thead>
    39 <tbody>
    39 <tbody>
    40 <row>
    40 <row>
    41 <entry><p>Text field (alphanumeric or numeric content)</p></entry>
    41 <entry><p>Text field (alphanumeric or numeric content)</p></entry>
    42 <entry><p>A text field contains some type of numeric or alphanumeric data.
    42 <entry><p>A text field contains some type of numeric or alphanumeric
    43 It can be edited directly using the usual editing functions when the form
    43 data. It can be edited directly using the usual editing functions
    44 is in the Edit state. The text field can expand to more than one lines if
    44 when the form is in the Edit state. The text field can expand to more
    45 necessary.</p><p>In the View state, a text field looks identical to a corresponding
    45 than one lines if necessary.</p><p>In the View state, a text field
    46 list item.</p></entry>
    46 looks identical to a corresponding list item.</p></entry>
    47 </row>
    47 </row>
    48 <row>
    48 <row>
    49 <entry><p>Pop-up field</p></entry>
    49 <entry><p>Pop-up field</p></entry>
    50 <entry><p>A pop-up field offers the possibility to choose one value from a
    50 <entry><p>A pop-up field offers the possibility to choose one value
    51 pre-defined list. In the View state, a pop-up field looks identical to a list
    51 from a pre-defined list. In the View state, a pop-up field looks identical
    52 item; the text is the current value of the field. In the Edit state, it has
    52 to a list item; the text is the current value of the field. In the
    53 a distinct look that identifies the field as a pop-up list.</p><p>To edit
    53 Edit state, it has a distinct look that identifies the field as a
    54 an item in the Edit state, the user can press the Selection key or with single
    54 pop-up list.</p><p>To edit an item in the Edit state, the user can
    55 click (in tap enabled devices), which opens a menu list that contains the
    55 press the Selection key or with single tap (in devices supporting
    56 available values. The highlight is on the current value. When the list is
    56 touch), which opens a menu list that contains the available values.
    57 open, the softkeys are <b>OK</b> and <b>Cancel</b>, as usual with a menu list.
    57 The highlight is on the current value. When the list is open, the
    58 Both the softkeys return to the Edit state in the form.</p><p>A pop-up field
    58 softkeys are <b>OK</b> and <b>Cancel</b>, as usual with a menu list.
    59 may also allow the user to enter a textual value in addition to the pre-defined
    59 Both the softkeys return to the Edit state in the form.</p><p>A pop-up
    60 values. In this case, the last option is named for example <b>Other</b>, and
    60 field may also allow the user to enter a textual value in addition
    61 selecting it opens a Data query.</p><p>See figure below.</p></entry>
    61 to the pre-defined values. In this case, the last option is named
       
    62 for example <b>Other</b>, and selecting it opens a Data query.</p><p>See figure below.</p></entry>
    62 </row>
    63 </row>
    63 <row>
    64 <row>
    64 <entry><p>Slider</p></entry>
    65 <entry><p>Slider</p></entry>
    65 <entry><p>With a slider, the user can adjust a numeric value (although it
    66 <entry><p>With a slider, the user can adjust a numeric value (although
    66 is not necessary to present the actual value to the user as a number). In
    67 it is not necessary to present the actual value to the user as a number).
    67 the View state, the item is presented as a textual item. In the Edit state,
    68 In the View state, the item is presented as a textual item. In the
    68 the value of the slider is immediately adjustable using the Arrow left and
    69 Edit state, the value of the slider is immediately adjustable using
    69 Arrow right keys.</p></entry>
    70 the Arrow left and Arrow right keys.</p></entry>
    70 </row>
    71 </row>
    71 </tbody>
    72 </tbody>
    72 </tgroup>
    73 </tgroup>
    73 </table>
    74 </table>
    74 <fig id="GUID-AA0170E3-BBB2-478A-A9A1-24C48BCF917F">
    75 <fig id="GUID-AA0170E3-BBB2-478A-A9A1-24C48BCF917F">
    75 <title>Pop-up field</title>
    76 <title>Pop-up field</title>
    76 <image href="GUID-DC4E42CA-2A65-44D7-8DBE-386F60F998A0_d0e64122_href.png" scale="40" placement="inline"/>
    77 <image href="GUID-DC4E42CA-2A65-44D7-8DBE-386F60F998A0_d0e56400_href.png" scale="40" placement="inline">
       
    78 </image>
    77 </fig>
    79 </fig>
    78 <p>Any combination of these types is possible within one form.</p>
    80 <p>Any combination of these types is possible within one form.</p>
    79 <p>When a form is in the Edit state, the user can move the focus up and down
    81 <p>When a form is in the Edit state, the user can move the focus up
    80 like in a list. The highlight in the Edit state is different from the highlight
    82 and down like in a list. The highlight in the Edit state is different
    81 in the View state, acting as a visual cue. The cursor blinks in the text field
    83 from the highlight in the View state, acting as a visual cue. The
    82 that is in focus. There is no need to save each field separately; the user
    84 cursor blinks in the text field that is in focus. There is no need
    83 can browse and modify the fields in any order and then accept all modifications.
    85 to save each field separately; the user can browse and modify the
    84 During the browsing of a form in the Edit state, the keypad functions are
    86 fields in any order and then accept all modifications. During the
    85 as follows:</p>
    87 browsing of a form in the Edit state, the keypad functions are as
       
    88 follows:</p>
    86 <p>The field types are described in the following table:</p>
    89 <p>The field types are described in the following table:</p>
    87 <table id="GUID-437191CE-D3E0-4CFB-875C-9C308B18F7E9"><title>Default key events
    90 <table id="GUID-437191CE-D3E0-4CFB-875C-9C308B18F7E9"><title>Default
    88 in editing state of a form</title>
    91 key events in editing state of a form</title>
    89 <tgroup cols="2"><colspec colname="col1" colwidth="0.30*"/><colspec colname="col2" colwidth="1.70*"/>
    92 <tgroup cols="2"><colspec colname="col1" colwidth="0.30*"/><colspec colname="col2" colwidth="1.70*"/>
    90 <thead>
    93 <thead>
    91 <row>
    94 <row>
    92 <entry>Key</entry>
    95 <entry>Key</entry>
    93 <entry>Action</entry>
    96 <entry>Action</entry>
    94 </row>
    97 </row>
    95 </thead>
    98 </thead>
    96 <tbody>
    99 <tbody>
    97 <row>
   100 <row>
    98 <entry><p>Arrow up / down</p></entry>
   101 <entry><p>Arrow up / down</p></entry>
    99 <entry><p>Move the focus between form items (when in a text field, move the
   102 <entry><p>Move the focus between form items (when in a text field,
   100 cursor within an item line by line).</p></entry>
   103 move the cursor within an item line by line).</p></entry>
   101 </row>
   104 </row>
   102 <row>
   105 <row>
   103 <entry><p>Arrow left / right</p></entry>
   106 <entry><p>Arrow left / right</p></entry>
   104 <entry><ul>
   107 <entry><ul>
   105 <li><p>In a pop-up field: change the value without opening the list. </p></li>
   108 <li><p>In a pop-up field: change the value without opening the list. </p></li>
   109 </row>
   112 </row>
   110 <row>
   113 <row>
   111 <entry><p>Selection key</p></entry>
   114 <entry><p>Selection key</p></entry>
   112 <entry><ul>
   115 <entry><ul>
   113 <li><p>In a pop-up field: opens the list. </p></li>
   116 <li><p>In a pop-up field: opens the list. </p></li>
   114 <li><p>In a text field: opens the context sensitive <b>Options</b> menu or
   117 <li><p>In a text field: opens the context sensitive <b>Options</b> menu or no action.</p></li>
   115 no action.</p></li>
       
   116 </ul></entry>
   118 </ul></entry>
   117 </row>
   119 </row>
   118 <row>
   120 <row>
   119 <entry><p>Left softkey (Options)</p></entry>
   121 <entry><p>Left softkey (Options)</p></entry>
   120 <entry><p>Opens the <b>Options</b> menu (in a form without the <b>Options</b> menu,
   122 <entry><p>Opens the <b>Options</b> menu (in a form without the <b>Options</b> menu, the left softkey is <b>Done</b>).</p></entry>
   121 the left softkey is <b>Done</b>).</p></entry>
       
   122 </row>
   123 </row>
   123 <row>
   124 <row>
   124 <entry><p>Right softkey (Done)</p></entry>
   125 <entry><p>Right softkey (Done)</p></entry>
   125 <entry><p>Accepts the contents and returns to the previous state (in a form
   126 <entry><p>Accepts the contents and returns to the previous state (in
   126 without the Options menu, the right softkey is Cancel.)</p></entry>
   127 a form without the Options menu, the right softkey is Cancel.)</p></entry>
   127 </row>
   128 </row>
   128 <row>
   129 <row>
   129 <entry><p>Clear</p></entry>
   130 <entry><p>Clear</p></entry>
   130 <entry><ul>
   131 <entry><ul>
   131 <li><p>Pop-up: ignored. </p></li>
   132 <li><p>Pop-up: ignored. </p></li>
   154 <entry><p>The default action of the key.</p></entry>
   155 <entry><p>The default action of the key.</p></entry>
   155 </row>
   156 </row>
   156 </tbody>
   157 </tbody>
   157 </tgroup>
   158 </tgroup>
   158 </table>
   159 </table>
   159 <section id="GUID-E6A426E6-FC7E-4620-9CAE-BA9214AC17F8"><title>Using
   160 <section id="GUID-E6A426E6-FC7E-4620-9CAE-BA9214AC17F8"><title>Using forms in applications</title><p>The API to use for creating forms is the <xref format="html" href="specs/guides/Form_API_Specification/Form_API_Specification.html" scope="peer">Form API</xref>. For implementation information, see <xref format="html" href="specs/guides/Form_API_Specification/Form_API_Specification.html#Form_API_Specification.topic3" scope="peer">Using the Form API</xref>.</p></section>
   160 forms in C++ applications</title><p>The API to use for creating forms is the <xref format="html" href="specs/guides/Form_API_Specification/Form_API_Specification.html" scope="peer">Form API</xref>. For implementation information,
       
   161 see <xref format="html" href="specs/guides/Form_API_Specification/Form_API_Specification.html#Form_API_Specification.topic3" scope="peer">Using the Form API</xref>.</p></section>
       
   162 </conbody></concept>
   161 </conbody></concept>