Struct sctk_adwaita::AdwaitaFrame

pub struct AdwaitaFrame<State> {

    pub(crate) base_surface: WlTyped<WlSurface, SurfaceData>,
    pub(crate) compositor: Arc<CompositorState>,
    pub(crate) subcompositor: Arc<SubcompositorState>,
    pub(crate) queue_handle: QueueHandle<State>,
    pub(crate) decorations: Option<DecorationParts>,
    pub(crate) pool: SlotPool,
    pub(crate) dirty: bool,
    pub(crate) should_sync: bool,
    pub(crate) scale_factor: u32,
    pub(crate) resizable: bool,
    pub(crate) buttons: Buttons,
    pub(crate) state: WindowState,
    pub(crate) wm_capabilities: WindowManagerCapabilities,
    pub(crate) mouse: MouseState,
    pub(crate) theme: ColorTheme,
    pub(crate) title: Option<String>,
    pub(crate) title_text: Option<TitleText>,
    pub(crate) shadow: Shadow,
}

A simple set of decorations

Fields

base_surface: WlTyped<WlSurface, SurfaceData>

The base surface used to create the window.

compositor: Arc<CompositorState>

subcompositor: Arc<SubcompositorState>

Subcompositor to create/drop subsurfaces ondemand.

queue_handle: QueueHandle<State>

Queue handle to perform object creation.

decorations: Option<DecorationParts>

The drawable decorations, None when hidden.

pool: SlotPool

Memory pool to allocate the buffers for the decorations.

dirty: bool

Whether the frame should be redrawn.

should_sync: bool

Whether the drawing should be synced with the main surface.

scale_factor: u32

Scale factor used for the surface.

resizable: bool

Wether the frame is resizable.

buttons: Buttons

state: WindowState

wm_capabilities: WindowManagerCapabilities

mouse: MouseState

theme: ColorTheme

title: Option<String>

title_text: Option<TitleText>

shadow: Shadow

Implementations

impl<State> AdwaitaFrame<State>

where State: Dispatch<WlSurface, SurfaceData> + Dispatch<WlSubsurface, SubsurfaceData> + 'static,

pub fn new( base_surface: &impl WaylandSurface, shm: &Shm, compositor: Arc<CompositorState>, subcompositor: Arc<SubcompositorState>, queue_handle: QueueHandle<State>, frame_config: FrameConfig, ) -> Result<Self, Box<dyn Error>>

pub fn set_config(&mut self, config: FrameConfig)

Update the current frame config.

pub(crate) fn precise_location( &self, location: Location, decoration: &DecorationParts, x: f64, y: f64, ) -> Location

pub(crate) fn redraw_inner(&mut self) -> Option<bool>

Trait Implementations

impl<State: Debug> Debug for AdwaitaFrame<State>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<State> DecorationsFrame for AdwaitaFrame<State>

where State: Dispatch<WlSurface, SurfaceData> + Dispatch<WlSubsurface, SubsurfaceData> + 'static,

fn update_state(&mut self, state: WindowState)

Update the state of the frame.

fn update_wm_capabilities(&mut self, wm_capabilities: WindowManagerCapabilities)

Update the window manager capabilites.

fn set_hidden(&mut self, hidden: bool)

Set the frame as hidden.

fn set_resizable(&mut self, resizable: bool)

Mark the frame as resizable.

fn resize(&mut self, width: NonZeroU32, height: NonZeroU32)

Resize the window to the new size.

fn draw(&mut self) -> bool

Draw the decorations frame.

fn subtract_borders( &self, width: NonZeroU32, height: NonZeroU32, ) -> (Option<NonZeroU32>, Option<NonZeroU32>)

Subtract the borders from the given width and height.

fn add_borders(&self, width: u32, height: u32) -> (u32, u32)

Add the borders to the given width and height.

fn location(&self) -> (i32, i32)

Return the coordinates of the top-left corner of the borders relative to the content.

fn set_title(&mut self, title: impl Into<String>)

Set the frames title.

fn on_click( &mut self, timestamp: Duration, click: FrameClick, pressed: bool, ) -> Option<FrameAction>

Emulate click on the decorations.

fn set_scaling_factor(&mut self, scale_factor: f64)

Set the scaling of the decorations frame.

fn click_point_moved( &mut self, _timestamp: Duration, surface: &ObjectId, x: f64, y: f64, ) -> Option<CursorIcon>

Emulate pointer moved event on the decorations frame.

fn click_point_left(&mut self)

All clicks left the decorations.

fn is_dirty(&self) -> bool

Whether the given frame is dirty and should be redrawn.

fn is_hidden(&self) -> bool

Get the frame hidden state.