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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
// Copyright 2019 The xi-editor Authors. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! A label widget. use crate::piet::{ Color, FontBuilder, PietText, PietTextLayout, RenderContext, Text, TextLayout, TextLayoutBuilder, UnitPoint, }; use crate::{ theme, BoxConstraints, Data, Env, Event, EventCtx, KeyOrValue, LayoutCtx, LifeCycle, LifeCycleCtx, LocalizedString, PaintCtx, Point, Size, UpdateCtx, Widget, }; // a fudgey way to get an approximate line height from a font size const LINE_HEIGHT_FACTOR: f64 = 1.2; // a fudgey way of figuring out where to put the baseline, relative to line height const BASELINE_GUESS_FACTOR: f64 = 0.8; // added padding between the edges of the widget and the text. const LABEL_X_PADDING: f64 = 2.0; /// The text for the label. /// /// This can be one of three things; either a `String`, a [`LocalizedString`], /// or a closure with the signature, `Fn(&T, &Env) -> String`, where `T` is /// the `Data` at this point in the tree. /// /// [`LocalizedString`]: ../struct.LocalizedString.html pub enum LabelText<T> { /// Localized string that will be resolved through `Env`. Localized(LocalizedString<T>), /// Specific text Specific(String), /// The provided closure is called on update, and its return /// value is used as the text for the label. Dynamic(Dynamic<T>), } /// Text that is computed dynamically. #[doc(hidden)] pub struct Dynamic<T> { f: Box<dyn Fn(&T, &Env) -> String>, resolved: String, } /// A label that displays some text. pub struct Label<T> { text: LabelText<T>, color: KeyOrValue<Color>, size: KeyOrValue<f64>, font: KeyOrValue<&'static str>, } impl<T: Data> Label<T> { /// Construct a new `Label` widget. /// /// ``` /// use druid::LocalizedString; /// use druid::widget::Label; /// /// // Construct a new Label using static string. /// let _: Label<u32> = Label::new("Hello world"); /// /// // Construct a new Label using localized string. /// let text = LocalizedString::new("hello-counter").with_arg("count", |data: &u32, _env| (*data).into()); /// let _: Label<u32> = Label::new(text); /// /// // Construct a new dynamic Label. Text will be updated when data changes. /// let _: Label<u32> = Label::new(|data: &u32, _env: &_| format!("Hello world: {}", data)); /// ``` pub fn new(text: impl Into<LabelText<T>>) -> Self { let text = text.into(); Self { text, color: theme::LABEL_COLOR.into(), size: theme::TEXT_SIZE_NORMAL.into(), font: theme::FONT_NAME.into(), } } /// Construct a new dynamic label. /// /// The contents of this label are generated from the data using a closure. /// /// This is provided as a convenience; a closure can also be passed to [`new`], /// but due to limitations of the implementation of that method, the types in /// the closure need to be annotated, which is not true for this method. /// /// # Examples /// /// The following are equivalent. /// /// ``` /// use druid::Env; /// use druid::widget::Label; /// let label1: Label<u32> = Label::new(|data: &u32, _: &Env| format!("total is {}", data)); /// let label2: Label<u32> = Label::dynamic(|data, _| format!("total is {}", data)); /// ``` /// /// [`new`]: #method.new pub fn dynamic(text: impl Fn(&T, &Env) -> String + 'static) -> Self { let text: LabelText<T> = text.into(); Label::new(text) } /// Set text alignment. #[deprecated(since = "0.5.0", note = "Use an Align widget instead")] pub fn text_align(self, _align: UnitPoint) -> Self { self } /// Builder-style method for setting the text color. /// /// The argument can be either a `Color` or a [`Key<Color>`]. /// /// [`Key<Color>`]: ../struct.Key.html pub fn with_text_color(mut self, color: impl Into<KeyOrValue<Color>>) -> Self { self.color = color.into(); self } /// Builder-style method for setting the text size. /// /// The argument can be either an `f64` or a [`Key<f64>`]. /// /// [`Key<f64>`]: ../struct.Key.html pub fn with_text_size(mut self, size: impl Into<KeyOrValue<f64>>) -> Self { self.size = size.into(); self } /// Builder-style method for setting the font. /// /// The argument can be a `&str`, `String`, or [`Key<&str>`]. /// /// [`Key<&str>`]: ../struct.Key.html pub fn with_font(mut self, font: impl Into<KeyOrValue<&'static str>>) -> Self { self.font = font.into(); self } /// Set a new text. /// /// Takes an already resolved string as input. /// /// If you're looking for full [`LabelText`] support, /// then you need to create a new [`Label`]. /// /// [`Label`]: #method.new /// [`LabelText`]: enum.LabelText.html pub fn set_text(&mut self, text: impl Into<String>) { self.text = LabelText::Specific(text.into()); } /// Returns this label's current text. pub fn text(&self) -> &str { self.text.display_text() } /// Set the text color. /// /// The argument can be either a `Color` or a [`Key<Color>`]. /// /// [`Key<Color>`]: ../struct.Key.html pub fn set_text_color(&mut self, color: impl Into<KeyOrValue<Color>>) { self.color = color.into(); } /// Set the text size. /// /// The argument can be either an `f64` or a [`Key<f64>`]. /// /// [`Key<f64>`]: ../struct.Key.html pub fn set_text_size(&mut self, size: impl Into<KeyOrValue<f64>>) { self.size = size.into(); } /// Set the font. /// /// The argument can be a `&str`, `String`, or [`Key<&str>`]. /// /// [`Key<&str>`]: ../struct.Key.html pub fn set_font(&mut self, font: impl Into<KeyOrValue<&'static str>>) { self.font = font.into(); } fn get_layout(&mut self, t: &mut PietText, env: &Env) -> PietTextLayout { let font_name = self.font.resolve(env); let font_size = self.size.resolve(env); // TODO: caching of both the format and the layout let font = t.new_font_by_name(font_name, font_size).build().unwrap(); self.text.with_display_text(|text| { t.new_text_layout(&font, &text, std::f64::INFINITY) .build() .unwrap() }) } } impl<T> Dynamic<T> { fn resolve(&mut self, data: &T, env: &Env) -> bool { let new = (self.f)(data, env); let changed = new != self.resolved; self.resolved = new; changed } } impl<T: Data> LabelText<T> { /// Call callback with the text that should be displayed. pub fn with_display_text<V>(&self, mut cb: impl FnMut(&str) -> V) -> V { match self { LabelText::Specific(s) => cb(s.as_str()), LabelText::Localized(s) => cb(s.localized_str()), LabelText::Dynamic(s) => cb(s.resolved.as_str()), } } /// Return the current resolved text. pub fn display_text(&self) -> &str { match self { LabelText::Specific(s) => s.as_str(), LabelText::Localized(s) => s.localized_str(), LabelText::Dynamic(s) => s.resolved.as_str(), } } /// Update the localization, if necessary. /// This ensures that localized strings are up to date. /// /// Returns `true` if the string has changed. pub fn resolve(&mut self, data: &T, env: &Env) -> bool { match self { LabelText::Specific(_) => false, LabelText::Localized(s) => s.resolve(data, env), LabelText::Dynamic(s) => s.resolve(data, env), } } } impl<T: Data> Widget<T> for Label<T> { fn event(&mut self, _ctx: &mut EventCtx, _event: &Event, _data: &mut T, _env: &Env) {} fn lifecycle(&mut self, _ctx: &mut LifeCycleCtx, event: &LifeCycle, data: &T, env: &Env) { if let LifeCycle::WidgetAdded = event { self.text.resolve(data, env); } } fn update(&mut self, ctx: &mut UpdateCtx, old_data: &T, data: &T, env: &Env) { if !old_data.same(data) && self.text.resolve(data, env) { ctx.request_layout(); } } fn layout(&mut self, ctx: &mut LayoutCtx, bc: &BoxConstraints, _data: &T, env: &Env) -> Size { bc.debug_check("Label"); let font_size = self.size.resolve(env); let text_layout = self.get_layout(&mut ctx.text(), env); bc.constrain(Size::new( text_layout.width() + 2. * LABEL_X_PADDING, font_size * LINE_HEIGHT_FACTOR, )) } fn paint(&mut self, ctx: &mut PaintCtx, _data: &T, env: &Env) { let font_size = self.size.resolve(env); let text_layout = self.get_layout(&mut ctx.text(), env); let line_height = font_size * LINE_HEIGHT_FACTOR; // Find the origin for the text let origin = Point::new(LABEL_X_PADDING, line_height * BASELINE_GUESS_FACTOR); let color = self.color.resolve(env); ctx.draw_text(&text_layout, origin, &color); } } impl<T> From<String> for LabelText<T> { fn from(src: String) -> LabelText<T> { LabelText::Specific(src) } } impl<T> From<&str> for LabelText<T> { fn from(src: &str) -> LabelText<T> { LabelText::Specific(src.to_string()) } } impl<T> From<LocalizedString<T>> for LabelText<T> { fn from(src: LocalizedString<T>) -> LabelText<T> { LabelText::Localized(src) } } impl<T, F: Fn(&T, &Env) -> String + 'static> From<F> for LabelText<T> { fn from(src: F) -> LabelText<T> { let f = Box::new(src); LabelText::Dynamic(Dynamic { f, resolved: String::default(), }) } }