docs/Classes/SDLSetDisplayLayout.html


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

<h1>SDLSetDisplayLayout Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithPredefinedLayout:">-initWithPredefinedLayout:</a></li>
  <li><a href="#section--initWithLayout:">-initWithLayout:</a></li>
  <li><a href="#section--initWithPredefinedLayout:dayColorScheme:nightColorScheme:">-initWithPredefinedLayout:dayColorScheme:nightColorScheme:</a></li>
  <li><a href="#section-displayLayout">displayLayout</a></li>
  <li><a href="#section-dayColorScheme">dayColorScheme</a></li>
  <li><a href="#section-nightColorScheme">nightColorScheme</a></li>
</ul>

<h3>Overview</h3>

<p>Used to set an alternate display layout. If not sent, default screen for
 given platform will be shown</p>

<p>Since SmartDeviceLink 2.0</p>


<section class="section task-group-section">
  <h3 id="section--initWithPredefinedLayout:">
      -initWithPredefinedLayout:
  </h3>
  
  <p>Convenience init to set a display layout</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">initWithPredefinedLayout</span><span class="p">:</span>
    <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span><span class="p">)</span><span class="nv">predefinedLayout</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">predefinedLayout</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span><span class="p">)</span></code></pre>

  
  <h4>Parameters</h4>
  <dl>
      <dt>predefinedLayout</dt>
      <dd><p>A template layout an app uses to display information</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLSetDisplayLayout object</p>
  </div>
  
  <h3 id="section--initWithLayout:">
      -initWithLayout:
  </h3>
  
  <p>Convenience init to set a display layout</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">initWithLayout</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">displayLayout</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="n">layout</span> <span class="nv">displayLayout</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

  
  <h4>Parameters</h4>
  <dl>
      <dt>displayLayout</dt>
      <dd><p>A display layout name</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLSetDisplayLayout object</p>
  </div>
  
  <h3 id="section--initWithPredefinedLayout:dayColorScheme:nightColorScheme:">
      -initWithPredefinedLayout:dayColorScheme:nightColorScheme:
  </h3>
  
  <p>Convenience init to set a display layout</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">initWithPredefinedLayout</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span><span class="p">)</span><span class="nv">predefinedLayout</span>
              <span class="nf">dayColorScheme</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLTemplateColorScheme.html">SDLTemplateColorScheme</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">dayColorScheme</span>
            <span class="nf">nightColorScheme</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLTemplateColorScheme.html">SDLTemplateColorScheme</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">nightColorScheme</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">predefinedLayout</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span><span class="p">,</span> <span class="nv">dayColorScheme</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTemplateColorScheme.html">SDLTemplateColorScheme</a></span><span class="p">,</span> <span class="nv">nightColorScheme</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTemplateColorScheme.html">SDLTemplateColorScheme</a></span><span class="p">)</span></code></pre>

  
  <h4>Parameters</h4>
  <dl>
      <dt>predefinedLayout</dt>
      <dd><p>A display layout. Predefined or dynamically created screen layout</p></dd>
      <dt>dayColorScheme</dt>
      <dd><p>The color scheme to be used on a head unit using a &ldquo;light&rdquo; or &ldquo;day&rdquo; color scheme</p></dd>
      <dt>nightColorScheme</dt>
      <dd><p>The color scheme to be used on a head unit using a &ldquo;dark&rdquo; or &ldquo;night&rdquo; color scheme</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLSetDisplayLayout object</p>
  </div>
  
  <h3 id="section-displayLayout">
      displayLayout
  </h3>
  
  <p>A display layout. Predefined or dynamically created screen layout.
Currently only predefined screen layouts are defined. Predefined layouts
include: &ldquo;ONSCREEN_PRESETS&rdquo; Custom screen containing app-defined onscreen
presets. Currently defined for GEN2</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">displayLayout</span><span class="p">;</span></code></pre>

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

  
  <h3 id="section-dayColorScheme">
      dayColorScheme
  </h3>
  
  <p>The color scheme to be used on a head unit using a &ldquo;light&rdquo; or &ldquo;day&rdquo; color scheme. The OEM may only support this theme if their head unit only has a light color scheme.</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">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTemplateColorScheme.html">SDLTemplateColorScheme</a></span> <span class="o">*</span><span class="n">dayColorScheme</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">dayColorScheme</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTemplateColorScheme.html">SDLTemplateColorScheme</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-nightColorScheme">
      nightColorScheme
  </h3>
  
  <p>The color scheme to be used on a head unit using a &ldquo;dark&rdquo; or &ldquo;night&rdquo; color scheme. The OEM may only support this theme if their head unit only has a dark color scheme.</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">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTemplateColorScheme.html">SDLTemplateColorScheme</a></span> <span class="o">*</span><span class="n">nightColorScheme</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">nightColorScheme</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTemplateColorScheme.html">SDLTemplateColorScheme</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>