diff options
Diffstat (limited to 'docs/Classes/SDLFileType.html')
| -rw-r--r-- | docs/Classes/SDLFileType.html | 262 |
1 files changed, 262 insertions, 0 deletions
diff --git a/docs/Classes/SDLFileType.html b/docs/Classes/SDLFileType.html new file mode 100644 index 000000000..54b3fb99e --- /dev/null +++ b/docs/Classes/SDLFileType.html @@ -0,0 +1,262 @@ +<h1>SDLFileType 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-+GRAPHIC_BMP">+GRAPHIC_BMP</a></li> + <li><a href="#section-+GRAPHIC_JPEG">+GRAPHIC_JPEG</a></li> + <li><a href="#section-+GRAPHIC_PNG">+GRAPHIC_PNG</a></li> + <li><a href="#section-+AUDIO_WAVE">+AUDIO_WAVE</a></li> + <li><a href="#section-+AUDIO_MP3">+AUDIO_MP3</a></li> + <li><a href="#section-+AUDIO_AAC">+AUDIO_AAC</a></li> + <li><a href="#section-+BINARY">+BINARY</a></li> + <li><a href="#section-+JSON">+JSON</a></li> +</ul> + +<h3>Overview</h3> + +<p>Enumeration listing possible file types.</p> + +<p>@since SDL 2.0</p> + + +<section class="section task-group-section"> + <h3> + +valueOf: + </h3> + + <p>@abstract Convert String to SDLFileType</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</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">SDLFileType</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>SDLFileType</p> + + </div> + + <h3> + +values + </h3> + + <p>@abstract Store the enumeration of all possible SDLFileType</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 SDLFileType</p> + + </div> + + <h3> + +GRAPHIC_BMP + </h3> + + <p>@abstract file type: Bitmap (BMP)</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">GRAPHIC_BMP</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">GRAPHIC_BMP</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLFileType with value of <em>GRAPHIC_BMP</em></p> + + </div> + + <h3> + +GRAPHIC_JPEG + </h3> + + <p>@abstract file type: JPEG</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">GRAPHIC_JPEG</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">GRAPHIC_JPEG</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLFileType with value of <em>GRAPHIC_JPEG</em></p> + + </div> + + <h3> + +GRAPHIC_PNG + </h3> + + <p>@abstract file type: PNG</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">GRAPHIC_PNG</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">GRAPHIC_PNG</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLFileType with value of <em>GRAPHIC_PNG</em></p> + + </div> + + <h3> + +AUDIO_WAVE + </h3> + + <p>@abstract file type: WAVE (WAV)</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">AUDIO_WAVE</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">AUDIO_WAVE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLFileType with value of <em>AUDIO_WAVE</em></p> + + </div> + + <h3> + +AUDIO_MP3 + </h3> + + <p>@abstract file type: MP3</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">AUDIO_MP3</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">AUDIO_MP3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLFileType with value of <em>AUDIO_MP3</em></p> + + </div> + + <h3> + +AUDIO_AAC + </h3> + + <p>@abstract file type: AAC</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">AUDIO_AAC</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">AUDIO_AAC</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLFileType with value of <em>AUDIO_AAC</em></p> + + </div> + + <h3> + +BINARY + </h3> + + <p>@abstract file type: BINARY</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">BINARY</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">BINARY</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLFileType with value of <em>BINARY</em></p> + + </div> + + <h3> + +JSON + </h3> + + <p>@abstract file type: JSON</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">JSON</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">JSON</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLFileType with value of <em>JSON</em></p> + + </div> + +</section> |