Overte C++ Documentation
TextAlignment.h
1 //
2 // Created by HifiExperiments on 2/9/21
3 // Copyright 2021 Vircadia contributors.
4 //
5 // Distributed under the Apache License, Version 2.0.
6 // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
7 //
8 
9 #ifndef hifi_TextAlignment_h
10 #define hifi_TextAlignment_h
11 
12 #include "QString"
13 
14 /*@jsdoc
15  * <p>A {@link Entities.EntityProperties-Text|Text} entity may use one of the following alignments:</p>
16  * <table>
17  * <thead>
18  * <tr><th>Value</th><th>Description</th></tr>
19  * </thead>
20  * <tbody>
21  * <tr><td><code>"left"</code></td><td>Text is aligned to the left side.</td></tr>
22  * <tr><td><code>"center"</code></td><td>Text is centered.</td></tr>
23  * <tr><td><code>"right"</code></td><td>Text is aligned to the right side.</td></tr>
24  * </tbody>
25  * </table>
26  * @typedef {string} Entities.TextAlignment
27  */
28 
29 enum class TextAlignment {
30  LEFT = 0,
31  CENTER,
32  RIGHT
33 };
34 
35 class TextAlignmentHelpers {
36 public:
37  static QString getNameForTextAlignment(TextAlignment alignment);
38 };
39 
40 #endif // hifi_TextAlignment_h