diff options
Diffstat (limited to 'docs/Classes/SDLTriggerSource.html')
-rw-r--r-- | docs/Classes/SDLTriggerSource.html | 148 |
1 files changed, 148 insertions, 0 deletions
diff --git a/docs/Classes/SDLTriggerSource.html b/docs/Classes/SDLTriggerSource.html new file mode 100644 index 000000000..5d27addd8 --- /dev/null +++ b/docs/Classes/SDLTriggerSource.html @@ -0,0 +1,148 @@ +<h1>SDLTriggerSource Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-+valueOf:">+valueOf:</a></li> + <li><a href="#section-+values">+values</a></li> + <li><a href="#section-+MENU">+MENU</a></li> + <li><a href="#section-+VR">+VR</a></li> + <li><a href="#section-+KEYBOARD">+KEYBOARD</a></li> +</ul> + +<h3>Overview</h3> + +<p>Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons)</p> + +<p>@since SDL 1.0</p> + + +<section class="section task-group-section"> + <h3> + +valueOf: + </h3> + + <p>Convert String to SDLTriggerSource +- parameter: value The value of the string to get an object for +- returns: SDLTriggerSource</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTriggerSource</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">valueOf</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLTriggerSource</span><span class="o">!</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>value</dt> + <dd><p>The value of the string to get an object for</p> +</dd> + </dl> + <div> + <h4>Return Value</h4> + <p>SDLTriggerSource</p> + + </div> + + <h3> + +values + </h3> + + <p>@abstract Store the enumeration of all possible SDLTriggerSource +- returns: an array that store all possible SDLTriggerSource</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">AnyObject</span><span class="p">]</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>an array that store all possible SDLTriggerSource</p> + + </div> + + <h3> + +MENU + </h3> + + <p>@abstract Selection made via menu +- returns: SDLTriggerSource with value of <em>MENU</em></p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTriggerSource</span> <span class="o">*</span><span class="p">)</span><span class="n">MENU</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">MENU</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTriggerSource</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLTriggerSource with value of <em>MENU</em></p> + + </div> + + <h3> + +VR + </h3> + + <p>@abstract Selection made via Voice session +- returns: SDLTriggerSource with value of <em>VR</em></p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTriggerSource</span> <span class="o">*</span><span class="p">)</span><span class="n">VR</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">VR</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTriggerSource</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLTriggerSource with value of <em>VR</em></p> + + </div> + + <h3> + +KEYBOARD + </h3> + + <p>@abstract Selection made via Keyboard +- returns: SDLTriggerSource with value of <em>KEYBOARD</em></p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTriggerSource</span> <span class="o">*</span><span class="p">)</span><span class="n">KEYBOARD</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">KEYBOARD</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTriggerSource</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLTriggerSource with value of <em>KEYBOARD</em></p> + + </div> + +</section> |