aylis_core/window.rs
1//! Comandos à janela de um form (minimizar, maximizar, arrastar...): o que uma barra de
2//! título própria precisa. O `Ui` só enfileira; a plataforma executa no laço dela.
3
4use crate::component::ComponentId;
5use crate::ui::Ui;
6
7/// A borda (ou canto) por onde a janela é redimensionada.
8#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
9pub enum ResizeEdge {
10 Left,
11 Right,
12 Top,
13 Bottom,
14 TopLeft,
15 TopRight,
16 BottomLeft,
17 BottomRight,
18}
19
20/// Um pedido à janela do form.
21#[derive(Clone, Copy, Debug, PartialEq, Eq)]
22pub enum WindowCommand {
23 Minimize,
24 Maximize,
25 Restore,
26 /// Maximiza ou volta (o duplo clique na barra de título).
27 ToggleMaximize,
28 /// Fecha o form (passa pelo `on_close_query`, como o X).
29 Close,
30 /// Começa a arrastar a janela com o botão do mouse (chame no `pointer_down`).
31 StartDrag,
32 /// Começa a redimensionar pela borda (chame no `pointer_down`).
33 StartResize(ResizeEdge),
34 /// Sempre por cima das outras janelas.
35 SetTopmost(bool),
36 /// Esconde a janela sem fechar o form (o app continua, como ir para a bandeja).
37 Hide,
38 /// Mostra a janela escondida (ou minimizada) e a traz para a frente.
39 Show,
40 /// Tela cheia (sem bordas, no monitor da janela) ou de volta.
41 SetFullscreen(bool),
42 /// Leva a janela para o monitor (índice em [`Ui::monitors`](crate::Ui::monitors)), no meio
43 /// da área útil dele.
44 MoveToMonitor(usize),
45 /// Põe o canto da janela (com a moldura) neste ponto da tela, em pixels físicos (a janela
46 /// arrastada pela aba que vai para outro lugar).
47 MoveTo(i32, i32),
48 /// A propriedade `gpu` do form mudou: a janela confere em que placa de vídeo desenha
49 /// (veja [`crate::gpu`]).
50 UpdateGpu,
51 /// A janela fica com a área cliente do tamanho do form (`width`/`height`, ou
52 /// `client_width`/`client_height`, mudados com o app rodando): a moldura do sistema fica
53 /// por fora, sem o app descontar a borda (o relatório do Tabernáculo, J11).
54 ApplySize,
55 /// A propriedade `window_corners` (ou a `border_style`) do form mudou: a janela pede ao
56 /// sistema os cantos dela de novo.
57 UpdateCorners,
58 /// A propriedade `span_monitors` do form mudou: a janela confere se o form vira uma
59 /// janela por monitor (veja [`crate::span`]).
60 UpdateSpan,
61 /// A propriedade `physical_pixels` do form mudou: a janela (ou os pedaços dela) passa a
62 /// desenhar com 1 unidade = 1 pixel físico, ou volta à escala do monitor (veja
63 /// [`Ui::physical_pixels`]).
64 UpdateScale,
65 /// O `WindowSettings` do form (ou o do app) mudou: a janela aplica as opções de novo
66 /// (veja [`WindowOptions`]).
67 UpdateOptions,
68 /// Chama a atenção para a janela sem tomar o foco: no Windows, o botão dela pisca na barra
69 /// de tarefas até o usuário ativá-la (`true`, urgente: a janela pisca também); no macOS, o
70 /// ícone pula no Dock (urgente: até ativar); no Linux, a dica de urgência do gerenciador.
71 RequestAttention(bool),
72 /// O `topmost` ou o `bottommost` do form mudou: a janela fica por cima de todas, por baixo
73 /// de todas ou normal.
74 UpdateLevel,
75 /// O `keep_awake` de um form mudou (ou um form abriu ou fechou): a plataforma junta o de
76 /// todos os forms abertos e pede ao sistema.
77 UpdateKeepAwake,
78 /// O `confine_cursor` do form mudou: o mouse fica preso na janela, no monitor dela ou solto.
79 UpdateCursorConfine,
80 /// O `window_opacity` do form mudou: a janela inteira (com a moldura) fica translúcida.
81 UpdateOpacity,
82}
83
84impl Ui {
85 /// Pede algo à janela do form `form` (ou do form de um controle dentro dele).
86 pub fn window_command(&mut self, form: ComponentId, command: WindowCommand) {
87 let form = self.root_of(form);
88 if command == WindowCommand::Close {
89 self.pending_closes_from_window(form);
90 return;
91 }
92 self.window_commands.push((form, command));
93 self.request_repaint();
94 }
95
96 /// A janela do form (ou do form de um controle) vem para a frente pelo caminho forçado
97 /// (a propriedade `force_foreground`): no Windows, só o processo que recebeu a última
98 /// entrada pode pôr uma janela em primeiro plano, e o form aberto por um atalho global
99 /// (o hook de teclado), por um timer ou pela bandeja apareceria atrás, sem o teclado. A
100 /// plataforma usa ao mostrar ([`WindowCommand::Show`], ao abrir) e ao ativar. No designer,
101 /// nunca.
102 pub fn forces_foreground(&self, form: ComponentId) -> bool {
103 let form = self.root_of(form);
104 !self.design_mode() && matches!(self.get_prop(form, "force_foreground"), Ok(crate::PropValue::Bool(true)))
105 }
106
107 /// Os pedidos à janela desde a última vez (a plataforma chama a cada volta do laço).
108 pub fn take_window_commands(&mut self) -> Vec<(ComponentId, WindowCommand)> {
109 std::mem::take(&mut self.window_commands)
110 }
111
112 /// A janela do form está maximizada (a plataforma informa; ver
113 /// [`WindowPlacement`](crate::forms::WindowPlacement)).
114 pub fn is_maximized(&self, form: ComponentId) -> bool {
115 self.window_placement(self.root_of(form)).is_some_and(|p| p.maximized)
116 }
117
118 /// O botão maximizar de uma barra de título própria (`owner`, a barra), no lugar dela
119 /// (`None`: não há mais). A plataforma o entrega ao sistema como o botão maximizar da
120 /// janela: no Windows 11, o mouse parado nele abre o menu de layouts do sistema (Snap).
121 pub fn set_maximize_button(&mut self, owner: ComponentId, rect: Option<crate::geometry::RectF>) {
122 let form = self.root_of(owner);
123 match rect {
124 Some(r) => {
125 self.maximize_buttons.insert(form, (owner, r));
126 }
127 None => {
128 if self.maximize_buttons.get(&form).is_some_and(|(o, _)| *o == owner) {
129 self.maximize_buttons.remove(&form);
130 }
131 }
132 }
133 }
134
135 /// Onde fica o botão maximizar do form `form` (relativo ao form, do último layout): o da
136 /// barra própria que o informou, se ela continua no form e à vista.
137 pub fn maximize_button(&self, form: ComponentId) -> Option<crate::geometry::RectF> {
138 let (owner, local) = *self.maximize_buttons.get(&form)?;
139 let shown = self.cb(owner).is_some_and(|cb| cb.visible()) && self.shown_rect(owner).is_some();
140 if !self.contains(owner) || self.root_of(owner) != form || !shown {
141 return None;
142 }
143 let at = self.absolute_rect(owner)?;
144 Some(local.offset(at.x, at.y))
145 }
146
147 fn pending_closes_from_window(&mut self, form: ComponentId) {
148 // Como o X da janela: o form principal encerra o app.
149 if self.main_form() == Some(form) && self.open_forms().len() <= 1 {
150 self.request_close();
151 } else {
152 self.close(form);
153 }
154 }
155}
156
157/// O fundo da janela que o sistema desenha por trás do conteúdo (Windows 11): o do sistema, sem
158/// fundo, o Mica, o Acrylic ou o Mica das janelas com abas.
159#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
160pub enum WindowBackdrop {
161 #[default]
162 System,
163 None,
164 Mica,
165 Acrylic,
166 Tabbed,
167}
168
169impl crate::prop::PropEnum for WindowBackdrop {
170 const NAMES: &'static [&'static str] = &["system", "none", "mica", "acrylic", "tabbed"];
171 fn from_index(i: usize) -> Option<Self> {
172 [WindowBackdrop::System, WindowBackdrop::None, WindowBackdrop::Mica, WindowBackdrop::Acrylic, WindowBackdrop::Tabbed].get(i).copied()
173 }
174 fn index(self) -> usize {
175 self as usize
176 }
177}
178
179/// O nome da classe do componente que configura a janela ([`WindowOptions`]).
180pub const WINDOW_SETTINGS_CLASS: &str = "WindowSettings";
181
182/// O que o componente `WindowSettings` configura na janela de um form: os recursos que só
183/// alguns sistemas têm, num lugar só (pedido do autor em 16/11). Onde o sistema não tem o
184/// recurso, o valor não faz nada.
185#[derive(Clone, Debug, PartialEq)]
186pub struct WindowOptions {
187 /// A animação do sistema ao abrir, minimizar e restaurar (Windows).
188 pub animation: bool,
189 /// Fora das capturas de tela e das gravações (Windows e macOS).
190 pub capture_excluded: bool,
191 /// O mouse atravessa a janela (os cliques vão para o que está atrás).
192 pub click_through: bool,
193 /// Os botões minimizar e maximizar da barra do sistema (Windows e macOS).
194 pub minimize_button: bool,
195 pub maximize_button: bool,
196 /// O fundo do sistema por trás do conteúdo (Windows 11).
197 pub backdrop: WindowBackdrop,
198 /// As cores da barra de título do sistema, do texto dela e da borda (Windows 11; `None`:
199 /// as do sistema).
200 pub title_color: Option<crate::Color>,
201 pub title_text_color: Option<crate::Color>,
202 pub border_color: Option<crate::Color>,
203 /// A sombra do sistema na janela sem borda (Windows).
204 pub shadow: bool,
205 /// O que está atrás da janela sai desfocado (Windows, macOS e Linux com KDE). Com o form
206 /// transparente (`transparent`, `window_shape`) e o fundo com alfa, é o vidro fosco; no Windows,
207 /// o desfoque segue a forma do form, com a borda suave.
208 pub blur: bool,
209 /// Clicar na janela não tira o foco de onde ele está (Windows).
210 pub no_activate: bool,
211 /// A janela aparece no Alt+Tab (Windows; `false` também a tira da barra de tarefas).
212 pub alt_tab: bool,
213}
214
215impl Default for WindowOptions {
216 fn default() -> Self {
217 Self {
218 animation: true,
219 capture_excluded: false,
220 click_through: false,
221 minimize_button: true,
222 maximize_button: true,
223 backdrop: WindowBackdrop::System,
224 title_color: None,
225 title_text_color: None,
226 border_color: None,
227 shadow: false,
228 blur: false,
229 no_activate: false,
230 alt_tab: true,
231 }
232 }
233}
234
235impl Ui {
236 /// O `WindowSettings` que vale para a janela do form `form`: o que está no próprio form
237 /// (`scope` = `form`) ou, sem ele, um com `scope` = `app` em qualquer form ou DataModule.
238 pub fn window_settings_of(&self, form: ComponentId) -> Option<ComponentId> {
239 let is_settings = |id: &&ComponentId| self.class_name(**id) == Some(WINDOW_SETTINGS_CLASS);
240 let app_scope = |id: ComponentId| matches!(self.get_prop(id, "scope"), Ok(crate::PropValue::Enum(s)) if s == "app");
241 self.children(form)
242 .iter()
243 .filter(is_settings)
244 .find(|id| !app_scope(**id))
245 .or_else(|| self.roots().iter().flat_map(|r| self.children(*r).iter()).filter(is_settings).find(|id| app_scope(**id)))
246 .copied()
247 }
248
249 /// As opções da janela do form `form` ([`Ui::window_settings_of`]; sem componente, o padrão
250 /// do sistema).
251 pub fn window_options(&self, form: ComponentId) -> WindowOptions {
252 let Some(id) = self.window_settings_of(form) else { return WindowOptions::default() };
253 let d = WindowOptions::default();
254 let flag = |name: &str, default: bool| match self.get_prop(id, name) {
255 Ok(crate::PropValue::Bool(b)) => b,
256 _ => default,
257 };
258 let color = |name: &str| match self.get_prop(id, name) {
259 Ok(crate::PropValue::Color(c)) => Some(c),
260 _ => None,
261 };
262 let backdrop = match self.get_prop(id, "backdrop") {
263 Ok(crate::PropValue::Enum(name)) => <WindowBackdrop as crate::prop::PropEnum>::from_name(&name).unwrap_or_default(),
264 _ => WindowBackdrop::System,
265 };
266 WindowOptions {
267 animation: flag("animation", d.animation),
268 capture_excluded: flag("capture_excluded", d.capture_excluded),
269 click_through: flag("click_through", d.click_through),
270 minimize_button: flag("minimize_button", d.minimize_button),
271 maximize_button: flag("maximize_button", d.maximize_button),
272 backdrop,
273 title_color: color("title_color"),
274 title_text_color: color("title_text_color"),
275 border_color: color("border_color"),
276 shadow: flag("shadow", d.shadow),
277 blur: flag("blur", d.blur),
278 no_activate: flag("no_activate", d.no_activate),
279 alt_tab: flag("alt_tab", d.alt_tab),
280 }
281 }
282}