blob: 16bc5c5221b01e1e6d639611725b3953e3f54a40 (
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
|
<h1>SDLImageField Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-name">name</a></li>
<li><a href="#section-imageTypeSupported">imageTypeSupported</a></li>
<li><a href="#section-imageResolution">imageResolution</a></li>
<li><a href="#section--initWithName:imageTypeSupported:imageResolution:">-initWithName:imageTypeSupported:imageResolution:</a></li>
</ul>
<h3>Overview</h3>
<p>A struct used in DisplayCapabilities describing the capability of an image field</p>
<section class="section task-group-section">
<h3 id="section-name">
name
</h3>
<p>The name that identifies the field.</p>
<p>Required</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"><a href="../Type%20Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span> <span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-imageTypeSupported">
imageTypeSupported
</h3>
<p>The image types that are supported in this field.</p>
<p>Required</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">NSArray</span><span class="o"><</span><span class="n"><a href="../Type%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">imageTypeSupported</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">imageTypeSupported</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</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-imageResolution">
imageResolution
</h3>
<p>The image resolution of this field</p>
<p>Optional</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/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">imageResolution</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">imageResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</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--initWithName:imageTypeSupported:imageResolution:">
-initWithName:imageTypeSupported:imageResolution:
</h3>
<p>Convenience initializer for the ImageField RPC struct</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">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span><span class="p">)</span><span class="nv">name</span>
<span class="nf">imageTypeSupported</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">imageTypeSupported</span>
<span class="nf">imageResolution</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">imageResolution</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">name</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span><span class="p">,</span> <span class="nv">imageTypeSupported</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">],</span> <span class="nv">imageResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">?)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>name</dt>
<dd><p>The name identifying this image field</p></dd>
<dt>imageTypeSupported</dt>
<dd><p>The image data types this field supports</p></dd>
<dt>imageResolution</dt>
<dd><p>The native resolution of this image field</p></dd>
</dl>
</section>
|
