summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLTextField.html
blob: 72deedee87f12e6a03c038c20634bf9d8deac462 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<h1>SDLTextField Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--init">-init</a></li>
  <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li>
  <li><a href="#section-name">name</a></li>
  <li><a href="#section-characterSet">characterSet</a></li>
  <li><a href="#section-width">width</a></li>
  <li><a href="#section-rows">rows</a></li>
</ul>

<h3>Overview</h3>

<p>Struct defining the characteristics of a displayed field on the HMI.</p>

<p>Parameter List
 <table border="1" rules="all">
        <tr>
            <th>Name</th>
            <th>Type</th>
            <th>Description</th>
            <th>SmartDeviceLink Ver. Available</th>
        </tr>
        <tr>
            <td>name</td>
            <td>TextFieldName</td>
            <td>Enumeration identifying the field.  </td>
            <td>SDL 1.0</td>
        </tr>
        <tr>
            <td>characterSet</td>
            <td>CharacterSet</td>
            <td>The character set that is supported in this field.  </td>
            <td>SDL 1.0</td>
        </tr>
        <tr>
            <td>width</td>
            <td>Int16</td>
            <td>The number of characters in one row of this field.
                    <ul>
                    <li>Minvalue=<q>1</q></li>
                    <li>maxvalue=<q>500</q></li>
                    </ul>
            </td>
            <td>SDL 1.0</td>
        </tr>
        <tr>
            <td>rows</td>
            <td>Int16</td>
            <td>The number of rows for this text field.
                    <ul>
                    <li>Minvalue=<q>1</q></li>
                    <li>maxvalue=<q>3</q></li>
                    </ul>
            </td>
            <td>SDL 1.0</td>
        </tr>
 </table></p>

<p>@since SDL 1.0</p>


<section class="section task-group-section">
  <h3>
      -init
  </h3>
  
  <p>@abstract Constructs a newly allocated SDLTextField object</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre>

  
  
  
  <h3>
      -initWithDictionary:
  </h3>
  
  <p>@abstract Constructs a newly allocated SDLTextField object indicated by the dictionary parameter</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>dict</dt>
      <dd><p>The dictionary to use to construct the object</p>
</dd>
  </dl>
  
  <h3>
      name
  </h3>
  
  <p>@abstract The enumeration identifying the field.</p>

<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLTextFieldName

</div>

<p>Required</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="n">name</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">SDLTextFieldName</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3>
      characterSet
  </h3>
  
  <p>@abstract The character set that is supported in this field.</p>

<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLCharacterSet

</div>

<p>Required</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">SDLCharacterSet</span> <span class="o">*</span><span class="n">characterSet</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">characterSet</span><span class="p">:</span> <span class="kt">SDLCharacterSet</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3>
      width
  </h3>
  
  <p>@abstract The number of characters in one row of this field.</p>

<p>Required, Integer 1 - 500</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">width</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3>
      rows
  </h3>
  
  <p>@abstract The number of rows for this text field.</p>

<p>Required, Integer 1 - 8</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">rows</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">rows</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>