summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLHMISettingsControlCapabilities.html
blob: 73ec0422b3e82edbd6114ad6ecdca31b921dc8be (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
<h1>SDLHMISettingsControlCapabilities Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithModuleName:">-initWithModuleName:</a></li>
  <li><a href="#section--initWithModuleName:distanceUnitAvailable:temperatureUnitAvailable:displayModeUnitAvailable:">-initWithModuleName:distanceUnitAvailable:temperatureUnitAvailable:displayModeUnitAvailable:</a></li>
  <li><a href="#section-moduleName">moduleName</a></li>
  <li><a href="#section-distanceUnitAvailable">distanceUnitAvailable</a></li>
  <li><a href="#section-temperatureUnitAvailable">temperatureUnitAvailable</a></li>
  <li><a href="#section-displayModeUnitAvailable">displayModeUnitAvailable</a></li>
</ul>

<h3>Overview</h3>

<p>Undocumented</p>


<section class="section task-group-section">
  <h3 id="section--initWithModuleName:">
      -initWithModuleName:
  </h3>
  
  <p>Constructs a newly allocated SDLHMISettingsControlCapabilities object with moduleName</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">initWithModuleName</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">moduleName</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">moduleName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>moduleName</dt>
      <dd><p>The short friendly name of the hmi setting module</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLHMISettingsControlCapabilities class</p>
  </div>
  
  <h3 id="section--initWithModuleName:distanceUnitAvailable:temperatureUnitAvailable:displayModeUnitAvailable:">
      -initWithModuleName:distanceUnitAvailable:temperatureUnitAvailable:displayModeUnitAvailable:
  </h3>
  
  <p>Constructs a newly allocated SDLHMISettingsControlCapabilities object with given parameters</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">initWithModuleName</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">moduleName</span>
                     <span class="nf">distanceUnitAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">distanceUnitAvailable</span>
                  <span class="nf">temperatureUnitAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">temperatureUnitAvailable</span>
                  <span class="nf">displayModeUnitAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">displayModeUnitAvailable</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">moduleName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">distanceUnitAvailable</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">temperatureUnitAvailable</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">displayModeUnitAvailable</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>moduleName</dt>
      <dd><p>The short friendly name of the hmi setting module</p></dd>
      <dt>distanceUnitAvailable</dt>
      <dd><p>Availability of the control of distance unit.</p></dd>
      <dt>temperatureUnitAvailable</dt>
      <dd><p>Availability of the control of temperature unit.</p></dd>
      <dt>displayModeUnitAvailable</dt>
      <dd><p>Availability of the control of displayMode unit.</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLHMISettingsControlCapabilities class</p>
  </div>
  
  <h3 id="section-moduleName">
      moduleName
  </h3>
  
  <p>@abstract The short friendly name of the hmi setting module.
 It should not be used to identify a module by mobile application.</p>

<p>Required, Max String length 100 chars</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">moduleName</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-distanceUnitAvailable">
      distanceUnitAvailable
  </h3>
  
  <p>@abstract Availability of the control of distance unit.</p>

<p>Optional, 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">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)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">distanceUnitAvailable</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">distanceUnitAvailable</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)SDLBool">SDLBool</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-temperatureUnitAvailable">
      temperatureUnitAvailable
  </h3>
  
  <p>@abstract Availability of the control of temperature unit.</p>

<p>Optional, 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">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)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">temperatureUnitAvailable</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">temperatureUnitAvailable</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)SDLBool">SDLBool</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-displayModeUnitAvailable">
      displayModeUnitAvailable
  </h3>
  
  <p>@abstract  Availability of the control of HMI display mode.</p>

<p>Optional, 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">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)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">displayModeUnitAvailable</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">displayModeUnitAvailable</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)SDLBool">SDLBool</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>