summaryrefslogtreecommitdiffstats
path: root/graphics
diff options
context:
space:
mode:
authorLibravatar Jhanny Jimenez <jhannyj03@gmail.com>2022-06-22 17:32:55 -0400
committerLibravatar Jhanny Jimenez <jhannyj03@gmail.com>2022-06-22 17:32:55 -0400
commita983c0c15b8d92e24adbeda45879260de50687fc (patch)
tree3cdce61b51747c015c911ea7ba7d74a1f85063a5 /graphics
parent9b46176b2677c51ff025e8a7c3bdd5c094baa4d6 (diff)
downloadiced-a983c0c15b8d92e24adbeda45879260de50687fc.tar.gz
iced-a983c0c15b8d92e24adbeda45879260de50687fc.tar.bz2
iced-a983c0c15b8d92e24adbeda45879260de50687fc.zip
Added more clarification as to how the position and alignment of the Canvas Text structure interact
Diffstat (limited to 'graphics')
-rw-r--r--graphics/src/widget/canvas/text.rs9
1 files changed, 8 insertions, 1 deletions
diff --git a/graphics/src/widget/canvas/text.rs b/graphics/src/widget/canvas/text.rs
index ab070a70..056f8204 100644
--- a/graphics/src/widget/canvas/text.rs
+++ b/graphics/src/widget/canvas/text.rs
@@ -6,7 +6,14 @@ use crate::{Color, Font, Point};
pub struct Text {
/// The contents of the text
pub content: String,
- /// The position where to begin drawing the text (top-left corner coordinates)
+ /// The position of the text relative to the alignment properties.
+ /// By default, this position will be relative to the top-left corner coordinate meaning that
+ /// if the horizontal and vertical alignments are unchanged, this property will tell where the
+ /// top-left corner of the text should be placed.
+ /// By changing the horizontal_alignment and vertical_alignment properties, you are are able to
+ /// change what part of text is placed at this positions.
+ /// For example, when the horizontal_alignment and vertical_alignment are set to Center, the
+ /// center of the text will be placed at the given position NOT the top-left coordinate.
pub position: Point,
/// The color of the text
pub color: Color,