Struct Frame

pub struct Frame { /* private fields */ }

Frame main data structure.

Implementations

impl Frame

Public constructors and destructor.

pub fn new( sid: SurfaceId, geometry: Geometry, mobility: Mobility, mode: Mode, pos: Position, size: Size, title: String, ) -> Self

Creates new generic frame.

pub fn new_root() -> Self

Creates new root frame.

pub fn new_display(id: i32, area: Area, title: String) -> Self

Creates new display frame.

pub fn new_workspace(title: String, geometry: Geometry, active: bool) -> Self

Creates new workspace frame.

pub fn new_container(geometry: Geometry) -> Self

Creates new container frame.

pub fn new_leaf(sid: SurfaceId, geometry: Geometry) -> Self

Creates new leaf frame.

pub fn destroy(&self)

Destroys frame recursively and deallocate memory.

impl Frame

Getting iterators.

pub fn time_iter(&self) -> FrameTimeIterator

Gets iterator over children in time order.

pub fn time_rev_iter(&self) -> FrameTimeReveresedIterator

Gets iterator over children in time reversed order.

pub fn space_iter(&self) -> FrameSpaceIterator

Gets iterator over children in space order.

pub fn space_rev_iter(&self) -> FrameSpaceReveresedIterator

Gets iterator over children in space reversed order.

impl Frame

Public getters for frame internals.

pub fn get_sid(&self) -> SurfaceId

Gets ID of assigned surface.

pub fn get_mode(&self) -> Mode

Gets mode.

pub fn get_geometry(&self) -> Geometry

Gets geometry.

pub fn get_mobility(&self) -> Mobility

Gets mobility.

pub fn get_position(&self) -> Position

Gets position.

pub fn get_size(&self) -> Size

Gets size.

pub fn get_area(&self) -> Area

Gets area.

pub fn get_title(&self) -> String

Gets title.

pub fn is_top(&self) -> bool

Check if frame is spacial and should be ignored while normal surface management.

pub fn is_reanchorizable(&self) -> bool

Returns true if frame with this mode can be reanchorized, false otherwise.

NOTE: Display must be floating. Otherwise it could be relaxed. For the same reason workspace must be anchored.

pub fn is_reorientable(&self) -> bool

Check if it should be possible to reorient or resize contents of frame.

pub fn make_active(&self, active: bool)

Activates or deactivates the frame.

This method has effect only on workspaces. Not active workspace should not be drawn on screen.

impl Frame

Public setters for frame internals.

pub fn set_plumbing_sid(&mut self, sid: SurfaceId)

Sets surface id without informing other parts of application.

pub fn set_plumbing_position(&mut self, pos: Position)

Sets size without informing other parts of application.

pub fn set_plumbing_size(&mut self, size: Size)

Sets size without informing other parts of application.

pub fn set_plumbing_geometry(&mut self, geometry: Geometry)

Sets geometry without adjusting any sizes an positions.

pub fn set_plumbing_mobility(&mut self, mobility: Mobility)

Sets mobility without any checks.

pub fn set_plumbing_mode(&mut self, mode: Mode)

Sets mode without any checks.

pub fn set_plumbing_position_and_size(&mut self, pos: Position, size: Size)

Sets position and size without informing other parts of application.

impl Frame

Public getters for neighbouring frames.

pub fn has_parent(&self) -> bool

Checks if frame has parent.

pub fn has_children(&self) -> bool

Checks if frame has children.

pub fn get_parent(&self) -> Option<Frame>

Optionally returns frames parent.

pub fn get_first_time(&self) -> Option<Frame>

Optionally returns child first in time order.

pub fn get_last_time(&self) -> Option<Frame>

Optionally returns child last in time order.

pub fn get_prev_time(&self) -> Option<Frame>

Optionally returns sibling previous in time order.

pub fn get_next_time(&self) -> Option<Frame>

Optionally returns sibling next in time order.

pub fn get_first_space(&self) -> Option<Frame>

Optionally returns child first in space order.

pub fn get_last_space(&self) -> Option<Frame>

Optionally returns child last in space order.

pub fn get_prev_space(&self) -> Option<Frame>

Optionally returns sibling previous in space order.

pub fn get_next_space(&self) -> Option<Frame>

Optionally returns sibling next in space order.

impl Frame

Public manipulators. Allow to change order relations between frames.

pub fn prepend(&mut self, frame: &mut Frame)

Prepends in spatial order and appends in time order given frame to self children.

pub fn append(&mut self, frame: &mut Frame)

Appends in spatial order and appends in time order given frame to self children.

pub fn prejoin(&mut self, frame: &mut Frame)

Inserts given frame as previous in spatial order sibling of self. Frame becomes last sibling in time order.

pub fn adjoin(&mut self, frame: &mut Frame)

Inserts given frame as next in spatial order sibling of self. Frame becomes last sibling in time order.

pub fn pop(&mut self)

Make given frame first in time order of all its siblings. Spatial order is untouched.

pub fn remove(&mut self)

Remove given frame from its parent children.

impl Frame

Miscellaneous other methods.

pub fn equals_exact(&self, other: &Frame) -> bool

Compares frame internals for check if frames are not only same but the same.

pub fn count_children(&self) -> usize

Counts children and returns their number.

pub fn count_anchored_children(&self) -> usize

Counts anchored children and returns their number.

pub fn calculate_global_position(&self) -> Position

Calculates global position of the frame.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Converting for Frame

fn to_array( &self, relative_position: Position, listing: &dyn SurfaceListing, ) -> Vec<SurfaceContext>

Converts frame three to list of SurfaceContext suitable for drawing by renderer.

fn to_workspace_state(&self) -> WorkspaceState

Converts frame tree to structure describing state of workspaces.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Packing for Frame

fn relax(&mut self, sa: &mut dyn SurfaceAccess)

TODO: Implement relaxing. Currently relaxing is equivalent to homogenizing.

fn homogenize(&mut self, sa: &mut dyn SurfaceAccess)

Make all subsurfaces have the same size and proper layout. Homogenizing works only on directed frames.

fn change_size(&mut self, vector: Vector, sa: &mut dyn SurfaceAccess)

Set size of the frame and resize its subframe accordingly.

fn set_size(&mut self, size: Size, sa: &mut dyn SurfaceAccess)

Set size of the frame and resize its subframe accordingly.

fn remove_self(&mut self, sa: &mut dyn SurfaceAccess)

Remove given frame and relax old parent.

impl Searching for Frame

fn find(&self, matcher: &dyn Fn(&Frame) -> bool) -> Option<Frame>

Returns first found frame upon which matcher returned true.

fn find_buildable(&self) -> Option<Frame>

Finds first frame suitable for building. Returns self if self has no surface ID set, its parent otherwise.

fn find_top(&self) -> Option<Frame>

Finds first trunk which is Workspace.

fn find_with_sid(&self, sid: SurfaceId) -> Option<Frame>

Finds frame with given surface ID.

fn find_pointed(&self, point: Position) -> Frame

Finds leaf frame contained in frame self containing point or the closest one if point lies outside self.

fn find_neighbouring(&self, direction: Direction) -> Option<Frame>

Returns neighbour in given planar direction. If parent is not aligned in the direction or neighbour is not found returns None.

fn find_contiguous(&self, direction: Direction, distance: u32) -> Option<Frame>

Finds top-most frame bordering with frame self in given direction.

fn find_adjacent(&self, direction: Direction, distance: u32) -> Option<Frame>

Find find bottom-most frame bordering with frame self in given direction.

impl Settling for Frame

fn settle( &mut self, target: &mut Frame, area: Option<Area>, sa: &mut dyn SurfaceAccess, )

Settle self in buildable of target and relax it.

fn resettle( &mut self, target: &mut Frame, position: Option<Position>, sa: &mut dyn SurfaceAccess, )

Remove given frame, relax old parent and settle the frame on given target.

fn pop_recursively(&mut self, pop: &mut Frame)

Pop the surface pop and its parents inside surface self.

fn change_geometry(&mut self, geometry: Geometry, sa: &mut dyn SurfaceAccess)

Changes frames geometry and resizes all subframe accordingly.

fn ramify(&mut self, geometry: Geometry) -> Frame

Adds another container into given place in frame layout if needed.

fn deramify(&mut self)

Removes unnecessary layers of container frames containing only one container or leaf frame.

fn jumpin(&mut self, side: Side, target: &mut Frame, sa: &mut dyn SurfaceAccess)

Places frame self on given side of target frame.

fn jump(&mut self, side: Side, target: &mut Frame, sa: &mut dyn SurfaceAccess)

Removes frame self from frame layout and then places it using jumpin method.

fn dock(&mut self, target: &mut Frame, size: Size, sa: &mut dyn SurfaceAccess)

Places frame self in target frame as dock.

fn anchorize(&mut self, sa: &mut dyn SurfaceAccess)

Anchorizes floating frame.

fn deanchorize(&mut self, area: Area, sa: &mut dyn SurfaceAccess)

Deanchorizes frame. Floating frame must be attached to workspace so it will be resettled if necessary.

fn resize( &mut self, direction: Direction, magnitude: isize, sa: &mut dyn SurfaceAccess, )

Resize the frame. direction indicates the border which will be moved and magnitude is move distance in pixels.

fn move_with_contents(&mut self, vector: Vector)

Move the frame and all subframes by given vector.

fn destroy_self(&mut self, sa: &mut dyn SurfaceAccess)

Removes frame self, relaxes old parent and destroys the frame.