blob: 18b0a9fc8115eb339fd613ba1d8b2f7022573338 (
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
|
<h1>SDLScrollableMessage 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--initWithMessage:">-initWithMessage:</a></li>
<li><a href="#section--initWithMessage:timeout:softButtons:">-initWithMessage:timeout:softButtons:</a></li>
<li><a href="#section-scrollableMessageBody">scrollableMessageBody</a></li>
<li><a href="#section-timeout">timeout</a></li>
<li><a href="#section-softButtons">softButtons</a></li>
</ul>
<h3>Overview</h3>
<p>Creates a full screen overlay containing a large block of formatted text that
can be scrolled with up to 8 SoftButtons defined
<p>
Function Group: ScrollableMessage
<p>
<b>HMILevel needs to be FULL</b>
<p></p>
<section class="section task-group-section">
<h3 id="section--init">
-init
</h3>
<p>@abstract Constructs a new SDLScrollableMessage 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 id="section--initWithDictionary:">
-initWithDictionary:
</h3>
<p>@abstract Constructs a new SDLScrollableMessage object indicated by the NSMutableDictionary
parameter
- parameter: dict The dictionary to use</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</p>
</dd>
</dl>
<h3 id="section--initWithMessage:">
-initWithMessage:
</h3>
<p>Undocumented</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLScrollableMessage</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre>
<h3 id="section--initWithMessage:timeout:softButtons:">
-initWithMessage:timeout:softButtons:
</h3>
<p>Undocumented</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLScrollableMessage</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre>
<h3 id="section-scrollableMessageBody">
scrollableMessageBody
</h3>
<p>@abstract A Body of text that can include newlines and tabs
@discussion A String value representing the Body of text that can include
newlines and tabs
<p>
<b>Notes: </b>Maxlength=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">NSString</span> <span class="o">*</span><span class="n">scrollableMessageBody</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight"><code><span class="k">var</span> <span class="nv">scrollableMessageBody</span><span class="p">:</span> <span class="kt">String</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 id="section-timeout">
timeout
</h3>
<p>@abstract Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the
last action
@discussion An Integer value representing an App defined timeout in milliseconds
<p>
<b>Notes</b>:Minval=0; Maxval=65535;Default=30000</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">timeout</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight"><code><span class="k">var</span> <span class="nv">timeout</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 id="section-softButtons">
softButtons
</h3>
<p>@abstract Gets/Sets App defined SoftButtons.If omitted on supported displays, only the
system defined <q>Close</q> SoftButton will be displayed
@discussion A Vector<SoftButton> value representing App defined
SoftButtons
<p>
<b>Notes: </b>Minsize=0, Maxsize=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">NSMutableArray</span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="kt">NSMutableArray</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>
|
