summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLTemplateColorScheme.html
blob: b48650704c0bdc2a4f72b068a4fcb55dcfffe248 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<h1>SDLTemplateColorScheme Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithPrimaryRGBColor:secondaryRGBColor:backgroundRGBColor:">-initWithPrimaryRGBColor:secondaryRGBColor:backgroundRGBColor:</a></li>
  <li><a href="#section--initWithPrimaryColor:secondaryColor:backgroundColor:">-initWithPrimaryColor:secondaryColor:backgroundColor:</a></li>
  <li><a href="#section-primaryColor">primaryColor</a></li>
  <li><a href="#section-secondaryColor">secondaryColor</a></li>
  <li><a href="#section-backgroundColor">backgroundColor</a></li>
</ul>

<h3>Overview</h3>

<p>A color scheme for all display layout templates.</p>


<section class="section task-group-section">
  <h3 id="section--initWithPrimaryRGBColor:secondaryRGBColor:backgroundRGBColor:">
      -initWithPrimaryRGBColor:secondaryRGBColor:backgroundRGBColor:
  </h3>
  
  <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">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>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n">primaryRGBColor</span> <span class="nv">primaryColor</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span><span class="p">,</span> <span class="n">secondaryRGBColor</span> <span class="nv">secondaryColor</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span><span class="p">,</span> <span class="n">backgroundRGBColor</span> <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span><span class="p">)</span></code></pre>

  
  
  <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>Convenience init</p>

  
  
  <h4>Objective-C</h4>
  <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>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">primaryColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">,</span> <span class="nv">secondaryColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">,</span> <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">)</span></code></pre>

  
  
  <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 &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>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="n">primaryColor</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">primaryColor</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-secondaryColor">
      secondaryColor
  </h3>
  
  <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>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="n">secondaryColor</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">secondaryColor</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-backgroundColor">
      backgroundColor
  </h3>
  
  <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>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="n">backgroundColor</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRGBColor.html">SDLRGBColor</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>