Trait arcdps_imgui::InputTextCallbackHandler

source ·

pub trait InputTextCallbackHandler {
    // Provided methods
    fn char_filter(&mut self, c: u16) -> Option<u16> { ... }
    fn on_completion(&mut self, _: TextCallbackData) { ... }
    fn on_edit(&mut self, _: TextCallbackData) { ... }
    fn on_history(&mut self, _: HistoryDirection, _: TextCallbackData) { ... }
    fn on_always(&mut self, _: TextCallbackData) { ... }
}

Expand description

This trait provides an interface which ImGui will call on InputText and InputTextMultiline callbacks.

Each method is called if and only if the corresponding flag for each method is passed to ImGui in the callback builder.

Each method here lists the flag required to call it, and this module begins with an example of callbacks being used.

Provided Methods§

source

fn char_filter(&mut self, c: u16) -> Option<u16>

Filters a char – returning a None means that the char is removed, and returning another char substitutes it out.

Because of upstream ImGui choices, you do not have access to the buffer during this callback (for some reason).

To make ImGui run this callback, use InputTextCallback::CHAR_FILTER or InputTextMultilineCallback::CHAR_FILTER.

§arcdps compatibility note

arcdps uses ImGui compiled without support for 32bit characters. For this reason, we changed this API from Rust chars to underlying raw characters (16bit).

source