summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLTextAlignment.html
blob: 926c7bb7eb0cc295a4761228092832732a43329e (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
141
142
<h1>SDLTextAlignment 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-+LEFT_ALIGNED">+LEFT_ALIGNED</a></li>
  <li><a href="#section-+RIGHT_ALIGNED">+RIGHT_ALIGNED</a></li>
  <li><a href="#section-+CENTERED">+CENTERED</a></li>
</ul>

<h3>Overview</h3>

<p>The list of possible alignments of text in a field. May only work on some display types.</p>

<p>@since SDL 1.0</p>


<section class="section task-group-section">
  <h3 id="section-+valueOf:">
      +valueOf:
  </h3>
  
  <p>Convert String to SDLTextAlignment</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextAlignment</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">value</span><span class="p">(</span><span class="n">of</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">-&gt;</span> <span class="kt">SDLTextAlignment</span><span class="o">!</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>value</dt>
      <dd><p>The value of the string to get an object for</p>
</dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>SDLTextAlignment</p>

  </div>
  
  <h3 id="section-+values">
      +values
  </h3>
  
  <p>@abstract Store the enumeration of all possible SDLTextAlignment</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">-&gt;</span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span><span class="o">!</span></code></pre>

  
  
  <div>
    <h4>Return Value</h4>
    <p>an array that store all possible SDLTextAlignment</p>

  </div>
  
  <h3 id="section-+LEFT_ALIGNED">
      +LEFT_ALIGNED
  </h3>
  
  <p>@abstract Text aligned left.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextAlignment</span> <span class="o">*</span><span class="p">)</span><span class="n">LEFT_ALIGNED</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">left_ALIGNED</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SDLTextAlignment</span><span class="o">!</span></code></pre>

  
  
  <div>
    <h4>Return Value</h4>
    <p>A SDLTextAlignment object with value of <em>LEFT_ALIGNED</em></p>

  </div>
  
  <h3 id="section-+RIGHT_ALIGNED">
      +RIGHT_ALIGNED
  </h3>
  
  <p>@abstract Text aligned right.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextAlignment</span> <span class="o">*</span><span class="p">)</span><span class="n">RIGHT_ALIGNED</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">right_ALIGNED</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SDLTextAlignment</span><span class="o">!</span></code></pre>

  
  
  <div>
    <h4>Return Value</h4>
    <p>A SDLTextAlignment object with value of <em>RIGHT_ALIGNED</em></p>

  </div>
  
  <h3 id="section-+CENTERED">
      +CENTERED
  </h3>
  
  <p>@abstract Text aligned centered.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextAlignment</span> <span class="o">*</span><span class="p">)</span><span class="n">CENTERED</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">centered</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SDLTextAlignment</span><span class="o">!</span></code></pre>

  
  
  <div>
    <h4>Return Value</h4>
    <p>A SDLTextAlignment object with value of <em>CENTERED</em></p>

  </div>
  
</section>