summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLTemplateColorScheme.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLTemplateColorScheme.html')
-rw-r--r--docs/Classes/SDLTemplateColorScheme.html47
1 files changed, 39 insertions, 8 deletions
diff --git a/docs/Classes/SDLTemplateColorScheme.html b/docs/Classes/SDLTemplateColorScheme.html
index fa6aeea1a..d884c5fcc 100644
--- a/docs/Classes/SDLTemplateColorScheme.html
+++ b/docs/Classes/SDLTemplateColorScheme.html
@@ -12,7 +12,7 @@
<h3>Overview</h3>
-<p>Undocumented</p>
+<p>A color scheme for all display layout templates.</p>
<section class="section task-group-section">
@@ -20,12 +20,15 @@
-initWithPrimaryRGBColor:secondaryRGBColor:backgroundRGBColor:
</h3>
- <p>Undocumented</p>
+ <p>Convenience init</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPrimaryRGBColor</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">primaryColor</span> <span class="nf">secondaryRGBColor</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryColor</span> <span class="nf">backgroundRGBColor</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">backgroundColor</span><span class="p">;</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
+ <span class="nf">initWithPrimaryRGBColor</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">primaryColor</span>
+ <span class="nf">secondaryRGBColor</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryColor</span>
+ <span class="nf">backgroundRGBColor</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">backgroundColor</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -33,17 +36,32 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>primaryColor</dt>
+ <dd><p>This must always be your primary brand color</p></dd>
+ <dt>secondaryColor</dt>
+ <dd><p>This may be an accent or complimentary color to your primary brand color</p></dd>
+ <dt>backgroundColor</dt>
+ <dd><p>he background color to be used on the template</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>An SDLTemplateColorScheme</p>
+ </div>
<h3 id="section--initWithPrimaryColor:secondaryColor:backgroundColor:">
-initWithPrimaryColor:secondaryColor:backgroundColor:
</h3>
- <p>Undocumented</p>
+ <p>Convenience init</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPrimaryColor</span><span class="p">:(</span><span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">primaryColor</span> <span class="nf">secondaryColor</span><span class="p">:(</span><span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryColor</span> <span class="nf">backgroundColor</span><span class="p">:(</span><span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">backgroundColor</span><span class="p">;</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPrimaryColor</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">primaryColor</span>
+ <span class="nf">secondaryColor</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryColor</span>
+ <span class="nf">backgroundColor</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">backgroundColor</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -51,12 +69,25 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>primaryColor</dt>
+ <dd><p>This must always be your primary brand color</p></dd>
+ <dt>secondaryColor</dt>
+ <dd><p>This may be an accent or complimentary color to your primary brand color</p></dd>
+ <dt>backgroundColor</dt>
+ <dd><p>he background color to be used on the template</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>An SDLTemplateColorScheme</p>
+ </div>
<h3 id="section-primaryColor">
primaryColor
</h3>
- <p>The <q>primary</q> color. This must always be your primary brand color. If the OEM only uses one color, this will be the color. It is recommended to the OEMs that the primaryColor should change the <code>mediaClockTimer</code> bar and the highlight color of soft buttons.</p>
+ <p>The &ldquo;primary&rdquo; color. This must always be your primary brand color. If the OEM only uses one color, this will be the color. It is recommended to the OEMs that the primaryColor should change the <code>mediaClockTimer</code> bar and the highlight color of soft buttons.</p>
@@ -74,7 +105,7 @@
secondaryColor
</h3>
- <p>The <q>secondary</q> color. This may be an accent or complimentary color to your primary brand color. If the OEM uses this color, they must also use the primary color. It is recommended to the OEMs that the secondaryColor should change the background color of buttons, such as soft buttons.</p>
+ <p>The &ldquo;secondary&rdquo; color. This may be an accent or complimentary color to your primary brand color. If the OEM uses this color, they must also use the primary color. It is recommended to the OEMs that the secondaryColor should change the background color of buttons, such as soft buttons.</p>
@@ -92,7 +123,7 @@
backgroundColor
</h3>
- <p>The background color to be used on the template. If the OEM does not support this parameter, assume on <q>dayColorScheme</q> that this will be a light color, and on <q>nightColorScheme</q> a dark color. You should do the same for your custom schemes.</p>
+ <p>The background color to be used on the template. If the OEM does not support this parameter, assume on &ldquo;dayColorScheme&rdquo; that this will be a light color, and on &ldquo;nightColorScheme&rdquo; a dark color. You should do the same for your custom schemes.</p>