diff options
author | Joel Fischer <joeljfischer@gmail.com> | 2016-06-02 13:40:32 -0400 |
---|---|---|
committer | Joel Fischer <joeljfischer@gmail.com> | 2016-06-02 13:40:32 -0400 |
commit | dcebff15a8c743a8ee652c1e5c91d2c59a6129cf (patch) | |
tree | d0e9b549e9f4ee09de78901213200353d28b7034 /docs/Classes/SDLGlobalProperty.html | |
parent | 3099a23fceb1bf717cd683893e0f6a759e02d5cb (diff) | |
download | sdl_ios-dcebff15a8c743a8ee652c1e5c91d2c59a6129cf.tar.gz |
Add Jazzy theme, scripts, initial documentation, and an updated gitignore
Diffstat (limited to 'docs/Classes/SDLGlobalProperty.html')
-rw-r--r-- | docs/Classes/SDLGlobalProperty.html | 203 |
1 files changed, 203 insertions, 0 deletions
diff --git a/docs/Classes/SDLGlobalProperty.html b/docs/Classes/SDLGlobalProperty.html new file mode 100644 index 000000000..242acebcc --- /dev/null +++ b/docs/Classes/SDLGlobalProperty.html @@ -0,0 +1,203 @@ +<h1>SDLGlobalProperty 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-+HELPPROMPT">+HELPPROMPT</a></li> + <li><a href="#section-+TIMEOUTPROMPT">+TIMEOUTPROMPT</a></li> + <li><a href="#section-+VRHELPTITLE">+VRHELPTITLE</a></li> + <li><a href="#section-+VRHELPITEMS">+VRHELPITEMS</a></li> + <li><a href="#section-+MENUNAME">+MENUNAME</a></li> + <li><a href="#section-+MENUICON">+MENUICON</a></li> + <li><a href="#section-+KEYBOARDPROPERTIES">+KEYBOARDPROPERTIES</a></li> +</ul> + +<h3>Overview</h3> + +<p>Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button).</p> + +<p>@since SDL 1.0</p> + + +<section class="section task-group-section"> + <h3> + +valueOf: + </h3> + + <p>Convert String to SDLGlobalProperty +- parameter: value The value of the string to get an object for +- returns: SDLGlobalProperty</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLGlobalProperty</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">SDLGlobalProperty</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>SDLGlobalProperty</p> + + </div> + + <h3> + +values + </h3> + + <p>@abstract Store the enumeration of all possible SDLGlobalProperty +- returns: An array that store all possible SDLGlobalProperty</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 SDLGlobalProperty</p> + + </div> + + <h3> + +HELPPROMPT + </h3> + + <p>@abstract The help prompt to be spoken if the user needs assistance during a user-initiated interaction. +- returns: A SDLGlobalProperty with value of <em>HELPPROMPT</em></p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLGlobalProperty</span> <span class="o">*</span><span class="p">)</span><span class="n">HELPPROMPT</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">HELPPROMPT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLGlobalProperty</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLGlobalProperty with value of <em>HELPPROMPT</em></p> + + </div> + + <h3> + +TIMEOUTPROMPT + </h3> + + <p>@abstract The prompt to be spoken if the user-initiated interaction times out waiting for the user’s verbal input. +- returns: A SDLGlobalProperty with value of <em>TIMEOUTPROMPT</em></p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLGlobalProperty</span> <span class="o">*</span><span class="p">)</span><span class="n">TIMEOUTPROMPT</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">TIMEOUTPROMPT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLGlobalProperty</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLGlobalProperty with value of <em>TIMEOUTPROMPT</em></p> + + </div> + + <h3> + +VRHELPTITLE + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + + + + + + <h3> + +VRHELPITEMS + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + + + + + + <h3> + +MENUNAME + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + + + + + + <h3> + +MENUICON + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + + + + + + <h3> + +KEYBOARDPROPERTIES + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + + + + + +</section> |