Struct ClientFramePreview 

pub struct ClientFramePreview {
    pub title: SharedString,
    pub options: ShellOptions,
    pub appearance: WindowAppearance,
    pub active: bool,
    pub maximized: bool,
    pub fullscreen: bool,
    pub tiling: Tiling,
    pub button_layout: Option<WindowButtonLayout>,
    pub show_focus: bool,
    pub show_hover: bool,
    /* private fields */
}

A visual-only client-frame preview inside an application’s content area.

Uses the production frame renderer and resolver, but attaches no window actions, drag/resize regions or focusable frame buttons. It never changes the host window’s decorations, insets or state. Simulated state is not detected desktop information.

Fields

title: SharedString

Displayed preview title.

options: ShellOptions

Per-window overrides to preview against the current desktop snapshot.

appearance: WindowAppearance

Simulated appearance, independent of native window appearance.

active: bool

Simulated activation state.

maximized: bool

Simulated maximization state.

fullscreen: bool

Hide preview chrome, as a real fullscreen client frame does.

tiling: Tiling

Simulated tiled edges.

button_layout: Option<WindowButtonLayout>

Preview button layout; None uses the current platform layout or the shell fallback.

show_focus: bool

Visually simulate keyboard focus on the close button without making it actionable.

show_hover: bool

Visually simulate hovering over close, without a native window action.

Implementations

impl ClientFramePreview

pub fn new( title: impl Into<SharedString>, options: ShellOptions, content: impl IntoElement, ) -> Self

Construct an active, floating, light preview. Give its parent a bounded size.

Trait Implementations

impl IntoElement for ClientFramePreview

type Element = ViewElement<ClientFramePreview>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for ClientFramePreview

fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.