summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLButtonCapabilities.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLButtonCapabilities.html')
-rw-r--r--docs/Classes/SDLButtonCapabilities.html143
1 files changed, 143 insertions, 0 deletions
diff --git a/docs/Classes/SDLButtonCapabilities.html b/docs/Classes/SDLButtonCapabilities.html
new file mode 100644
index 000000000..3465ee30b
--- /dev/null
+++ b/docs/Classes/SDLButtonCapabilities.html
@@ -0,0 +1,143 @@
+<h1>SDLButtonCapabilities 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-name">name</a></li>
+ <li><a href="#section-shortPressAvailable">shortPressAvailable</a></li>
+ <li><a href="#section-longPressAvailable">longPressAvailable</a></li>
+ <li><a href="#section-upDownAvailable">upDownAvailable</a></li>
+</ul>
+
+<h3>Overview</h3>
+
+<p>Provides information about the capabilities of a SDL HMI button.</p>
+
+<p>@since SDL 1.0</p>
+
+
+<section class="section task-group-section">
+ <h3>
+ -init
+ </h3>
+
+ <p>Constructs a newly allocated SDLButtonCapabilities 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>Constructs a newly allocated SDLButtonCapabilities object indicated by the Hashtable 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>
+ name
+ </h3>
+
+ <p>@abstract The name of the SDL HMI button.</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">SDLButtonName</span> <span class="o">*</span><span class="n">name</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">SDLButtonName</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>
+ shortPressAvailable
+ </h3>
+
+ <p>@abstract A NSNumber value indicates whether the button supports a SHORT press</p>
+
+<p>Required, Boolean</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">shortPressAvailable</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="k">var</span> <span class="nv">shortPressAvailable</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>
+ longPressAvailable
+ </h3>
+
+ <p>@abstract A NSNumber value indicates whether the button supports a LONG press</p>
+
+<p>Required, Boolean</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">longPressAvailable</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="k">var</span> <span class="nv">longPressAvailable</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>
+ upDownAvailable
+ </h3>
+
+ <p>@abstract A NSNumber value indicates whether the button supports <q>button down</q> and <q>button up</q></p>
+
+<p>Required, Boolean</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">upDownAvailable</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="k">var</span> <span class="nv">upDownAvailable</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>
+
+
+
+
+</section>