Guide API
Skip to main content

tvision_rs/window/
mod.rs

1//! The framed, selectable, movable [`Window`].
2//!
3//! A [`Window`] is the thing a user actually sees and drives: a [`Group`](crate::view::Group) that
4//! builds a [`Frame`](crate::frame::Frame) around itself, owns a window number /
5//! title / decoration flags ([`WindowFlags`]), can hold standard scroll bars,
6//! and zooms, moves, resizes, and closes. It sits on the
7//! [`Desktop`](crate::desktop::Desktop) and is the base type that
8//! [`Dialog`](crate::dialog::Dialog) and editor windows build on.
9//!
10//! Its colour scheme is recorded as a [`WindowPalette`] (`Blue` for plain
11//! windows, `Cyan` and `Gray` for the alternate schemes dialogs use), which the
12//! frame turns into the matching [`Role`](crate::theme::Role) styles.
13//!
14//! **Guide:** [Windows & the desktop](../../../apps/windows.html).
15//!
16//! # Turbo Vision heritage
17//!
18//! Ports `TWindow` (`twindow.cpp`). The base-class container becomes an embedded
19//! [`Group`](crate::view::Group) that the [`View`](crate::view::View) trait forwards to (deviation
20//! D2); frame title/flags/number are pushed down to the child instead of reached
21//! up for (deviation D3); the decoration flag word becomes [`WindowFlags`]
22//! (deviation D5); and the palette indirection becomes a [`WindowPalette`] →
23//! [`Role`](crate::theme::Role) mapping (deviation D7).
24
25#[allow(clippy::module_inception)]
26mod window;
27
28pub use window::{Fullscreen, ScrollBarOptions, Window, WindowFlags, WindowPalette};