Overte C++ Documentation
TextVerticalAlignment.h
1 //
2 // Created by HifiExperiments on 8/17/24
3 // Copyright 2024 Overte e.V 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_TextVerticalAlignment_h
10 #define hifi_TextVerticalAlignment_h
11 
12 #include "QString"
13 
14 /*@jsdoc
15  * <p>A {@link Entities.EntityProperties-Text|Text} entity may use one of the following vertical alignments:</p>
16  * <table>
17  * <thead>
18  * <tr><th>Value</th><th>Description</th></tr>
19  * </thead>
20  * <tbody>
21  * <tr><td><code>"top"</code></td><td>Text is aligned to the top.</td></tr>
22  * <tr><td><code>"bottom"</code></td><td>Text is aligned to the bottom.</td></tr>
23  * <tr><td><code>"center"</code></td><td>Text is centered vertically.</td></tr>
24  * </tbody>
25  * </table>
26  * @typedef {string} Entities.TextVerticalAlignment
27  */
28 
29 enum class TextVerticalAlignment : uint8_t {
30  TOP = 0,
31  BOTTOM,
32  CENTER,
33 };
34 
35 class TextVerticalAlignmentHelpers {
36 public:
37  static QString getNameForTextVerticalAlignment(TextVerticalAlignment alignment);
38 };
39 
40 #endif // hifi_TextVerticalAlignment_h