diff options
Diffstat (limited to 'docs/Classes/SDLScrollableMessage.html')
-rw-r--r-- | docs/Classes/SDLScrollableMessage.html | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/docs/Classes/SDLScrollableMessage.html b/docs/Classes/SDLScrollableMessage.html new file mode 100644 index 000000000..072a415c3 --- /dev/null +++ b/docs/Classes/SDLScrollableMessage.html @@ -0,0 +1,136 @@ +<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-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> + -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> + -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> + 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> + 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> + 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> |