summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLDisplayCapabilities.html
blob: 39a5a9371cefbed7db042ea99ce553dfbd373cc0 (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
201
202
203
204
205
206
207
208
209
210
211
212
213
<h1>SDLDisplayCapabilities Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-displayType">displayType</a></li>
  <li><a href="#section-textFields">textFields</a></li>
  <li><a href="#section-imageFields">imageFields</a></li>
  <li><a href="#section-mediaClockFormats">mediaClockFormats</a></li>
  <li><a href="#section-graphicSupported">graphicSupported</a></li>
  <li><a href="#section-templatesAvailable">templatesAvailable</a></li>
  <li><a href="#section-screenParams">screenParams</a></li>
  <li><a href="#section-numCustomPresetsAvailable">numCustomPresetsAvailable</a></li>
</ul>

<h3>Overview</h3>

<p>Contains information about the display for the SDL system to which the application is currently connected.</p>

<p>@since SDL 1.0</p>


<section class="section task-group-section">
  <h3 id="section-displayType">
      displayType
  </h3>
  
  <p>The type of display</p>

<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">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">_Nonnull</span> <span class="n">displayType</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">displayType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</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-textFields">
      textFields
  </h3>
  
  <p>An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as <em>SDLShow</em>, <em>SDLSetMediaClockTimer</em>, etc.</p>

<p>@discussion This array of SDLTextField structures identify all the text fields to which the application can write on the current display (identified by SDLDisplayType).</p>
<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLTextField

</div>

<p>Required, Array of SDLTextField, 1 - 100 objects</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><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">nonatomic</span><span class="p">)</span>
    <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLTextField.html">SDLTextField</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">textFields</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">textFields</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTextField.html">SDLTextField</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-imageFields">
      imageFields
  </h3>
  
  <p>An array of SDLImageField elements</p>

<p>@discussion A set of all fields that support images.</p>
<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLImageField

</div>

<p>Optional, Array of SDLImageField, 1 - 100 objects</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><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">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
    <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLImageField.html">SDLImageField</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">imageFields</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">imageFields</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLImageField.html">SDLImageField</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-mediaClockFormats">
      mediaClockFormats
  </h3>
  
  <p>An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</p>
<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLMediaClockFormat

</div>

<p>Required, Array of SDLMediaClockFormats, 0 - 100 objects</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><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">nonatomic</span><span class="p">)</span>
    <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Type Definitions.html#/c:SDLMediaClockFormat.h@T@SDLMediaClockFormat">SDLMediaClockFormat</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">mediaClockFormats</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">mediaClockFormats</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLMediaClockFormat.h@T@SDLMediaClockFormat">SDLMediaClockFormat</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-graphicSupported">
      graphicSupported
  </h3>
  
  <p>The display&rsquo;s persistent screen supports.</p>

<p>@since SDL 2.0</p>

<p>Required, Boolean</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><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">nonatomic</span><span class="p">)</span>
    <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">graphicSupported</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">graphicSupported</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</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-templatesAvailable">
      templatesAvailable
  </h3>
  
  <p>Number of presets the screen supports</p>

<p>@discussion The number of on-screen custom presets available (if any)</p>

<p>Optional, Array of String, max string size 100, 0 - 100 objects</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><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">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
    <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">templatesAvailable</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">templatesAvailable</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-screenParams">
      screenParams
  </h3>
  
  <p>A set of all parameters related to a prescribed screen area (e.g. for video / touch input)</p>

<p>Optional</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><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">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLScreenParams.html">SDLScreenParams</a></span> <span class="o">*</span><span class="n">screenParams</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">screenParams</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLScreenParams.html">SDLScreenParams</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-numCustomPresetsAvailable">
      numCustomPresetsAvailable
  </h3>
  
  <p>The number of on-screen custom presets available (if any); otherwise omitted</p>

<p>Optional, Integer 1 - 100</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><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">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
    <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">numCustomPresetsAvailable</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">numCustomPresetsAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>