summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLWindowState.html
blob: ef02a1c7f4e6b66a0d0fc094630b4496e69f79a7 (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
<h1>SDLWindowState Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithApproximatePosition:deviation:">-initWithApproximatePosition:deviation:</a></li>
  <li><a href="#section-approximatePosition">approximatePosition</a></li>
  <li><a href="#section-deviation">deviation</a></li>
</ul>

<h3>Overview</h3>

<p>@since SDL 7.0.0</p>


<section class="section task-group-section">
  <h3 id="section--initWithApproximatePosition:deviation:">
      -initWithApproximatePosition:deviation:
  </h3>
  
  
  
  
  <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">initWithApproximatePosition</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">approximatePosition</span>
                                          <span class="nf">deviation</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">deviation</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">approximatePosition</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">deviation</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>approximatePosition</dt>
      <dd><p>- The approximate percentage that the window is open - 0 being fully closed, 100 being fully open</p></dd>
      <dt>deviation</dt>
      <dd><p>- The percentage deviation of the approximatePosition. e.g. If the approximatePosition is 50 and the deviation is 10, then the window&rsquo;s location is somewhere between 40 and 60.</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A SDLWindowState object</p>
  </div>
  
  <h3 id="section-approximatePosition">
      approximatePosition
  </h3>
  
  <p>The approximate percentage that the window is open - 0 being fully closed, 100 being fully open</p>

<p>Mandatory, Integer, 0 - 100</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">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">approximatePosition</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">approximatePosition</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</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-deviation">
      deviation
  </h3>
  
  <p>The percentage deviation of the approximatePosition. e.g. If the approximatePosition is 50 and the deviation is 10, then the window&rsquo;s location is somewhere between 40 and 60.</p>

<p>Mandatory, Integer, 0 - 100</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">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">deviation</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">deviation</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>