git.maemo.org Git - hildon/blob - doc/tmpl/hildon-telephone-editor.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 HildonTelephoneEditor
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A widget which allows a user to enter a telephone number
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A Single Line Editor widget which allows user to enter a telephone number. There are two modes to choose from (corce/free format). Coerce format has three fields which are placed horizontally. Fields are country code, area code and number. When nothing is inputted to the fields assisting text is displayed in a field. Tapping on the field highlights the field and allows user to input numbers.
  10 </para>
  11
  12 <para>
  13 The widget is used where a user should enter a phone number. Free format should be used wherever possible as it enables the user to enter the phone number in the format she likes in addition to entering DTMF strings as a part of the phone number. The format can not be changed at runtime.
  14 </para>
  15
  16 <para>
  17 <informalexample>
  18 <programlisting>
  19         editor[0] =
  20                 hildon_telephone_editor_new( HILDON_TELEPHONE_EDITOR_FORMAT_COERCE );
  21 </programlisting>
  22 </informalexample>
  23 </para>
  24
  25 <!-- ##### SECTION See_Also ##### -->
  26 <para>
  27
  28 </para>
  29
  30 <!-- ##### MACRO HILDON_TELEPHONE_EDITOR_TYPE ##### -->
  31 <para>
  32
  33 </para>
  34
  35
  36
  37 <!-- ##### ENUM HildonTelephoneEditorFormat ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @HILDON_TELEPHONE_EDITOR_FORMAT_FREE:
  43 @HILDON_TELEPHONE_EDITOR_FORMAT_COERCE:
  44 @HILDON_TELEPHONE_EDITOR_FORMAT_COERCE_COUNTRY:
  45 @HILDON_TELEPHONE_EDITOR_FORMAT_COERCE_AREA:
  46
  47 <!-- ##### STRUCT HildonTelephoneEditor ##### -->
  48 <para>
  49
  50 </para>
  51
  52
  53 <!-- ##### FUNCTION hildon_telephone_editor_new ##### -->
  54 <para>
  55
  56 </para>
  57
  58 @format:
  59 @Returns:
  60
  61
  62 <!-- ##### FUNCTION hildon_telephone_editor_set_editable ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @hte:
  68 @country:
  69 @area:
  70 @number:
  71
  72
  73 <!-- ##### FUNCTION hildon_telephone_editor_set_show_plus ##### -->
  74 <para>
  75
  76 </para>
  77
  78 @hte:
  79 @show:
  80
  81
  82 <!-- ##### FUNCTION hildon_telephone_editor_get_show_plus ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @hte:
  88 @Returns:
  89
  90
  91 <!-- ##### FUNCTION hildon_telephone_editor_set_show_border ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @hte:
  97 @show:
  98
  99
 100 <!-- ##### FUNCTION hildon_telephone_editor_get_show_border ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @hte:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION hildon_telephone_editor_set_widths ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @hte:
 115 @country:
 116 @area:
 117 @number:
 118
 119
 120 <!-- ##### FUNCTION hildon_telephone_editor_get_country ##### -->
 121 <para>
 122
 123 </para>
 124
 125 @hte:
 126 @Returns:
 127
 128
 129 <!-- ##### FUNCTION hildon_telephone_editor_set_country ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @hte:
 135 @country:
 136
 137
 138 <!-- ##### FUNCTION hildon_telephone_editor_get_area ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @hte:
 144 @Returns:
 145
 146
 147 <!-- ##### FUNCTION hildon_telephone_editor_set_area ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @hte:
 153 @area:
 154
 155
 156 <!-- ##### FUNCTION hildon_telephone_editor_get_number ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @hte:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION hildon_telephone_editor_set_number ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @hte:
 171 @number:
 172
 173
 174 <!-- ##### ARG HildonTelephoneEditor:set-area ##### -->
 175 <para>
 176
 177 </para>
 178
 179 <!-- ##### ARG HildonTelephoneEditor:set-country ##### -->
 180 <para>
 181
 182 </para>
 183
 184 <!-- ##### ARG HildonTelephoneEditor:set-format ##### -->
 185 <para>
 186
 187 </para>
 188
 189 <!-- ##### ARG HildonTelephoneEditor:set-number ##### -->
 190 <para>
 191
 192 </para>
 193