blob: d2b48284e7bba54d837e014cc077c36e8a799a12 (
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
|
<h1>SDLTextField Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<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>
<li><a href="#section--initWithName:characterSet:width:rows:">-initWithName:characterSet:width:rows:</a></li>
</ul>
<h3>Overview</h3>
<p>Struct defining the characteristics of a displayed field on the HMI.</p>
<p>@since SDL 1.0</p>
<section class="section task-group-section">
<h3 id="section-name">
name
</h3>
<p>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 objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLTextFieldName.h@T@SDLTextFieldName">SDLTextFieldName</a></span> <span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLTextFieldName.h@T@SDLTextFieldName">SDLTextFieldName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-characterSet">
characterSet
</h3>
<p>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 objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="n">_Nonnull</span> <span class="n">characterSet</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">characterSet</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-width">
width
</h3>
<p>The number of characters in one row of this field.</p>
<p>Required, Integer 1 - 500</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">width</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><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="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-rows">
rows
</h3>
<p>The number of rows for this text field.</p>
<p>Required, Integer 1 - 8</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rows</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><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="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section--initWithName:characterSet:width:rows:">
-initWithName:characterSet:width:rows:
</h3>
<p>Convenience initializer for the TextField RPC struct.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLTextFieldName.h@T@SDLTextFieldName">SDLTextFieldName</a></span><span class="p">)</span><span class="nv">name</span>
<span class="nf">characterSet</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span><span class="p">)</span><span class="nv">characterSet</span>
<span class="nf">width</span><span class="p">:(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="nv">width</span>
<span class="nf">rows</span><span class="p">:(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="nv">rows</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLTextFieldName.h@T@SDLTextFieldName">SDLTextFieldName</a></span><span class="p">,</span> <span class="nv">characterSet</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span><span class="p">,</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">UInt</span><span class="p">,</span> <span class="nv">rows</span><span class="p">:</span> <span class="kt">UInt</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>name</dt>
<dd><p>The name identifying this text field</p></dd>
<dt>characterSet</dt>
<dd><p>The character set of this text field</p></dd>
<dt>width</dt>
<dd><p>The number of characters per row allowed in this text field</p></dd>
<dt>rows</dt>
<dd><p>The number of rows allowed in this text field</p></dd>
</dl>
</section>
|
