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 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
// 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 in the LICENSE-APACHE file or at:
// https://www.apache.org/licenses/LICENSE-2.0
//! Fixed text widgets
use super::adapt::MapAny;
use kas::prelude::*;
use kas::text::format::{EditableText, FormattableText};
use kas::text::Text;
use kas::theme::TextClass;
/// Construct a [`Label`] which accepts any data
///
/// This is just a shortcut for `Label::new(text).map_any()`.
#[inline]
pub fn label_any<A, T: FormattableText + 'static>(label: T) -> MapAny<A, Label<T>> {
MapAny::new(Label::new(label))
}
impl_scope! {
/// A text label
///
/// `Label` derives its contents from input data. Use [`Text`](crate::Text)
/// instead for fixed contents.
///
/// A text label. Vertical alignment defaults to centred, horizontal
/// alignment depends on the script direction if not specified.
/// Line-wrapping is enabled by default.
///
/// This type is generic over the text type.
/// See also: [`StrLabel`], [`StringLabel`], [`AccessLabel`].
#[impl_default(where T: Default)]
#[derive(Clone, Debug)]
#[widget {
Data = ();
}]
pub struct Label<T: FormattableText + 'static> {
core: widget_core!(),
class: TextClass = TextClass::Label(true),
label: Text<T>,
}
impl Self {
/// Construct from `label`
#[inline]
pub fn new(label: T) -> Self {
Label {
core: Default::default(),
class: TextClass::Label(true),
label: Text::new(label),
}
}
/// Get text class
#[inline]
pub fn class(&self) -> TextClass {
self.class
}
/// Set text class
///
/// Default: `TextClass::Label(true)`
#[inline]
pub fn set_class(&mut self, class: TextClass) {
self.class = class;
}
/// Set text class (inline)
///
/// Default: `TextClass::Label(true)`
#[inline]
pub fn with_class(mut self, class: TextClass) -> Self {
self.class = class;
self
}
/// Get whether line-wrapping is enabled
#[inline]
pub fn wrap(&self) -> bool {
self.class.multi_line()
}
/// Enable/disable line wrapping
///
/// This is equivalent to `label.set_class(TextClass::Label(wrap))`.
///
/// By default this is enabled.
#[inline]
pub fn set_wrap(&mut self, wrap: bool) {
self.class = TextClass::Label(wrap);
}
/// Enable/disable line wrapping (inline)
#[inline]
pub fn with_wrap(mut self, wrap: bool) -> Self {
self.class = TextClass::Label(wrap);
self
}
/// Get read access to the text object
#[inline]
pub fn text(&self) -> &Text<T> {
&self.label
}
/// Set text in an existing `Label`
///
/// Note: this must not be called before fonts have been initialised
/// (usually done by the theme when the main loop starts).
pub fn set_text(&mut self, text: T) -> Action {
match self.label.set_and_try_prepare(text) {
Ok(true) => Action::RESIZE,
_ => Action::REDRAW,
}
}
}
impl Layout for Self {
#[inline]
fn size_rules(&mut self, sizer: SizeCx, mut axis: AxisInfo) -> SizeRules {
axis.set_default_align_hv(Align::Default, Align::Center);
sizer.text_rules(&mut self.label, self.class, axis)
}
fn set_rect(&mut self, cx: &mut ConfigCx, rect: Rect) {
self.core.rect = rect;
cx.text_set_size(&mut self.label, self.class, rect.size, None);
}
#[cfg(feature = "min_spec")]
default fn draw(&mut self, mut draw: DrawCx) {
draw.text_effects(self.rect(), &self.label, self.class);
}
#[cfg(not(feature = "min_spec"))]
fn draw(&mut self, mut draw: DrawCx) {
draw.text_effects(self.rect(), &self.label, self.class);
}
}
impl HasStr for Self {
fn get_str(&self) -> &str {
self.label.as_str()
}
}
impl HasString for Self
where
T: EditableText,
{
fn set_string(&mut self, string: String) -> Action {
self.label.set_string(string);
match self.label.try_prepare() {
Ok(true) => Action::RESIZE,
_ => Action::REDRAW,
}
}
}
}
// Str/String representations have no effects, so use simpler draw call
#[cfg(feature = "min_spec")]
impl<'a> Layout for Label<&'a str> {
fn draw(&mut self, mut draw: DrawCx) {
draw.text(self.rect(), &self.label, self.class);
}
}
#[cfg(feature = "min_spec")]
impl Layout for StringLabel {
fn draw(&mut self, mut draw: DrawCx) {
draw.text(self.rect(), &self.label, self.class);
}
}
/* TODO(specialization): can we support this? min_specialization is not enough.
impl<U, T: From<U> + FormattableText + 'static> From<U> for Label<T> {
default fn from(text: U) -> Self {
let text = T::from(text);
Label::new(text)
}
}*/
impl<T: FormattableText + 'static> From<T> for Label<T> {
fn from(label: T) -> Self {
Label::new(label)
}
}
impl<'a> From<&'a str> for Label<String> {
fn from(label: &'a str) -> Self {
Label::new(label.to_string())
}
}
/// Label with `&'static str` as backing type
///
/// Warning: this type does not support [`HasString`]. Assignment is possible
/// via [`Label::set_text`], but only for `&'static str`, so most of the time
/// [`StringLabel`] will be preferred when assignment is required.
/// (Also note that the overhead of allocating and copying a `String` is
/// irrelevant considering those used for text layout and drawing.)
pub type StrLabel = Label<&'static str>;
/// Label with `String` as backing type
pub type StringLabel = Label<String>;
// NOTE: AccessLabel requires a different text class. Once specialization is
// stable we can simply replace the `draw` method, but for now we use a whole
// new type.
impl_scope! {
/// A label supporting an access key
///
/// An `AccessLabel` is a variant of [`Label`] supporting [`AccessString`],
/// for example "&Edit" binds an action to <kbd>Alt+E</kbd>. When the
/// corresponding key-sequence is pressed this widget sends the message
/// [`kas::messages::Activate`] which should be handled by a parent.
///
/// A text label. Vertical alignment defaults to centred, horizontal
/// alignment depends on the script direction if not specified.
/// Line-wrapping is enabled by default.
#[impl_default]
#[derive(Clone, Debug)]
#[widget]
pub struct AccessLabel {
core: widget_core!(),
class: TextClass = TextClass::Label(true),
label: Text<AccessString>,
}
impl Self {
/// Construct from `label`
#[inline]
pub fn new(label: impl Into<AccessString>) -> Self {
AccessLabel {
core: Default::default(),
class: TextClass::AccessLabel(true),
label: Text::new(label.into()),
}
}
/// Get text class
#[inline]
pub fn class(&self) -> TextClass {
self.class
}
/// Set text class
///
/// Default: `AccessLabel::Label(true)`
#[inline]
pub fn set_class(&mut self, class: TextClass) {
self.class = class;
}
/// Set text class (inline)
///
/// Default: `AccessLabel::Label(true)`
#[inline]
pub fn with_class(mut self, class: TextClass) -> Self {
self.class = class;
self
}
/// Get whether line-wrapping is enabled
#[inline]
pub fn wrap(&self) -> bool {
self.class.multi_line()
}
/// Enable/disable line wrapping
///
/// This is equivalent to `label.set_class(TextClass::AccessLabel(wrap))`.
///
/// By default this is enabled.
#[inline]
pub fn set_wrap(&mut self, wrap: bool) {
self.class = TextClass::AccessLabel(wrap);
}
/// Enable/disable line wrapping (inline)
#[inline]
pub fn with_wrap(mut self, wrap: bool) -> Self {
self.class = TextClass::Label(wrap);
self
}
/// Get read access to the text object
#[inline]
pub fn text(&self) -> &Text<AccessString> {
&self.label
}
/// Set text in an existing `Label`
///
/// Note: this must not be called before fonts have been initialised
/// (usually done by the theme when the main loop starts).
pub fn set_text(&mut self, text: AccessString) -> Action {
match self.label.set_and_try_prepare(text) {
Ok(true) => Action::RESIZE,
_ => Action::REDRAW,
}
}
}
impl Layout for Self {
#[inline]
fn size_rules(&mut self, sizer: SizeCx, mut axis: AxisInfo) -> SizeRules {
axis.set_default_align_hv(Align::Default, Align::Center);
sizer.text_rules(&mut self.label, self.class, axis)
}
fn set_rect(&mut self, cx: &mut ConfigCx, rect: Rect) {
self.core.rect = rect;
cx.text_set_size(&mut self.label, self.class, rect.size, None);
}
fn draw(&mut self, mut draw: DrawCx) {
draw.text_effects(self.rect(), &self.label, self.class);
}
}
impl Events for Self {
type Data = ();
fn configure(&mut self, cx: &mut ConfigCx) {
if let Some(key) = self.label.text().key() {
cx.add_access_key(self.id_ref(), key.clone());
}
}
fn handle_event(&mut self, cx: &mut EventCx, _: &Self::Data, event: Event) -> IsUsed {
match event {
Event::Command(cmd, code) if cmd.is_activate() => {
cx.push(kas::messages::Activate(code));
Used
}
_ => Unused
}
}
}
impl HasStr for Self {
fn get_str(&self) -> &str {
self.label.as_str()
}
}
}