diff options
Diffstat (limited to 'docs/Classes/SDLButtonName.html')
| -rw-r--r-- | docs/Classes/SDLButtonName.html | 474 |
1 files changed, 474 insertions, 0 deletions
diff --git a/docs/Classes/SDLButtonName.html b/docs/Classes/SDLButtonName.html new file mode 100644 index 000000000..b65b9a942 --- /dev/null +++ b/docs/Classes/SDLButtonName.html @@ -0,0 +1,474 @@ +<h1>SDLButtonName 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-+OK">+OK</a></li> + <li><a href="#section-+SEEKLEFT">+SEEKLEFT</a></li> + <li><a href="#section-+SEEKRIGHT">+SEEKRIGHT</a></li> + <li><a href="#section-+TUNEUP">+TUNEUP</a></li> + <li><a href="#section-+TUNEDOWN">+TUNEDOWN</a></li> + <li><a href="#section-+PRESET_0">+PRESET_0</a></li> + <li><a href="#section-+PRESET_1">+PRESET_1</a></li> + <li><a href="#section-+PRESET_2">+PRESET_2</a></li> + <li><a href="#section-+PRESET_3">+PRESET_3</a></li> + <li><a href="#section-+PRESET_4">+PRESET_4</a></li> + <li><a href="#section-+PRESET_5">+PRESET_5</a></li> + <li><a href="#section-+PRESET_6">+PRESET_6</a></li> + <li><a href="#section-+PRESET_7">+PRESET_7</a></li> + <li><a href="#section-+PRESET_8">+PRESET_8</a></li> + <li><a href="#section-+PRESET_9">+PRESET_9</a></li> + <li><a href="#section-+CUSTOM_BUTTON">+CUSTOM_BUTTON</a></li> + <li><a href="#section-+SEARCH">+SEARCH</a></li> +</ul> + +<h3>Overview</h3> + +<p>Defines logical buttons which, on a given SDL unit, would correspond to + either physical or soft (touchscreen) buttons. These logical buttons present + a standard functional abstraction which the developer can rely upon, + independent of the SDL unit. For example, the developer can rely upon the OK + button having the same meaning to the user across SDL platforms.</p> + +<p>The preset buttons (0-9) can typically be interpreted by the application as + corresponding to some user-configured choices, though the application is free + to interpret these button presses as it sees fit.</p> + +<p>The application can discover which buttons a given SDL unit implements by + interrogating the ButtonCapabilities parameter of the + RegisterAppInterface response.</p> + +<p>@since SDL 1.0</p> + + +<section class="section task-group-section"> + <h3> + +valueOf: + </h3> + + <p>@abstract Convert String to SDLButtonName</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</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">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>value</dt> + <dd><p>String value to retrieve the object for</p> +</dd> + </dl> + <div> + <h4>Return Value</h4> + <p>SDLButtonName</p> + + </div> + + <h3> + +values + </h3> + + <p>@abstract Store the enumeration of all possible SDLButtonName</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 SDLButtonName</p> + + </div> + + <h3> + +OK + </h3> + + <p>@abstract Represents the button usually labeled <q>OK</q>. A typical use of this button is for the user to press it to make a selection.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">OK</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">OK</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>OK</em></p> + + </div> + + <h3> + +SEEKLEFT + </h3> + + <p>@abstract Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">SEEKLEFT</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">SEEKLEFT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>SEEKLEFT</em></p> + + </div> + + <h3> + +SEEKRIGHT + </h3> + + <p>@abstract Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">SEEKRIGHT</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">SEEKRIGHT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>SEEKRIGHT</em></p> + + </div> + + <h3> + +TUNEUP + </h3> + + <p>@abstract Represents a turn of the tuner knob in the clockwise direction one tick.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">TUNEUP</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">TUNEUP</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>TUNEUP</em></p> + + </div> + + <h3> + +TUNEDOWN + </h3> + + <p>@abstract Represents a turn of the tuner knob in the counter-clockwise direction one tick.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">TUNEDOWN</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">TUNEDOWN</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>TUNEDOWN</em></p> + + </div> + + <h3> + +PRESET_0 + </h3> + + <p>@abstract Represents the preset 0 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_0</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">PRESET_0</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_0</em></p> + + </div> + + <h3> + +PRESET_1 + </h3> + + <p>@abstract Represents the preset 1 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_1</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">PRESET_1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_1</em></p> + + </div> + + <h3> + +PRESET_2 + </h3> + + <p>@abstract Represents the preset 2 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_2</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">PRESET_2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_2</em></p> + + </div> + + <h3> + +PRESET_3 + </h3> + + <p>@abstract Represents the preset 3 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_3</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">PRESET_3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_3</em></p> + + </div> + + <h3> + +PRESET_4 + </h3> + + <p>@abstract Represents the preset 4 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_4</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">PRESET_4</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_4</em></p> + + </div> + + <h3> + +PRESET_5 + </h3> + + <p>@abstract Represents the preset 5 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_5</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">PRESET_5</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_5</em></p> + + </div> + + <h3> + +PRESET_6 + </h3> + + <p>@abstract Represents the preset 6 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_6</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">PRESET_6</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_6</em></p> + + </div> + + <h3> + +PRESET_7 + </h3> + + <p>@abstract Represents the preset 7 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_7</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">PRESET_7</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_7</em></p> + + </div> + + <h3> + +PRESET_8 + </h3> + + <p>@abstract Represents the preset 8 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_8</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">PRESET_8</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_8</em></p> + + </div> + + <h3> + +PRESET_9 + </h3> + + <p>@abstract Represents the preset 9 button.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_9</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">PRESET_9</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>a SDLButtonName with the value of <em>PRESET_9</em></p> + + </div> + + <h3> + +CUSTOM_BUTTON + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLButtonName</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + + + + + + <h3> + +SEARCH + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLButtonName</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + + + + + +</section> |