From 254d1ef1542195d6bbd795a3114364929941b363 Mon Sep 17 00:00:00 2001 From: Thomas Churchman Date: Wed, 11 Dec 2024 15:30:31 +0100 Subject: [PATCH] Docs --- masonry/src/contexts.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/masonry/src/contexts.rs b/masonry/src/contexts.rs index ed809006b..81f94b3c7 100644 --- a/masonry/src/contexts.rs +++ b/masonry/src/contexts.rs @@ -198,8 +198,12 @@ impl_context_method!( /// Set the IME cursor area. /// - /// The reported IME area can be used by the platform to, for example, place a candidate - /// box near that area, while ensuring the area is not obscured. + /// When this widget is [focused] and [accepts text input], the reported IME area is sent + /// to the platform. The area can be used by the platform to, for example, place a + /// candidate box near that area, while ensuring the area is not obscured. + /// + /// [focused]: EventCtx::request_focus + /// [accepts text input]: Widget::accepts_text_input pub fn set_ime_area(&mut self, ime_area: Rect) { self.widget_state.ime_area = Some(ime_area); }