Struct Area

pub struct Area {
    pub id: AreaId,
    /* private fields */
}

Fields

id: AreaId

Implementations

impl Area

pub fn new(id: AreaId, layouts: Arc<Mutex<Vec<Layout>>>) -> Self

Trait Implementations

impl Clone for Area

fn clone(&self) -> Area

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for Area

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RawArea for Area

type Cache = PrintInfo

Something to be kept between app instances/reloads

type PrintInfo = PrintInfo

Information about what parts of a Text should be printed

type Ui = Ui

The Ui this RawArea belongs to

fn bisect( area: MutArea<'_, Self>, specs: PushSpecs, cluster: bool, on_files: bool, cache: PrintInfo, ) -> (Area, Option<Area>)

Bisects the RawArea with the given index into two.

fn delete(area: MutArea<'_, Self>) -> Option<Self>

Deletes this RawArea, signaling the closing of a Widget

fn swap(lhs: MutArea<'_, Self>, rhs: &Self)

Swaps this RawArea with another one

fn spawn_floating( area: MutArea<'_, Self>, specs: SpawnSpecs, ) -> Result<Self, Text>

Spawns a floating area on this RawArea

fn spawn_floating_at( _area: MutArea<'_, Self>, _specs: SpawnSpecs, _at: impl TwoPoints, _text: &Text, _cfg: PrintCfg, ) -> Result<Self, Text>

Spawns a floating area

fn constrain_hor( &self, cons: impl IntoIterator<Item = Constraint>, ) -> Result<(), Text>

Changes the horizontal constraint of the area

fn constrain_ver( &self, cons: impl IntoIterator<Item = Constraint>, ) -> Result<(), Text>

Changes the vertical constraint of the area

fn restore_constraints(&self) -> Result<(), Text>

Restores the original constraints of the widget

fn request_width_to_fit(&self, _text: &str) -> Result<(), Text>

Requests that the width be enough to fit a certain piece of text.

fn scroll_around_point(&self, text: &Text, point: Point, cfg: PrintCfg)

Scrolls the Text (up or down) until the main cursor is within the ScrollOff range.

fn set_as_active(&self)

Tells the Ui that this RawArea is the one that is currently focused.

fn print(&self, text: &mut Text, cfg: PrintCfg, painter: Painter)

Prints the Text via an Iterator

fn print_with<'a>( &self, text: &mut Text, cfg: PrintCfg, painter: Painter, f: impl FnMut(&Caret, &Item) + 'a, )

Prints the Text with a callback function

fn set_print_info(&self, info: Self::PrintInfo)

Sets a previously acquired PrintInfo to the area

fn print_iter<'a>( &self, iter: FwdIter<'a>, cfg: PrintCfg, ) -> impl Iterator<Item = (Caret, Item)> + Clone + 'a

Returns a printing iterator

fn rev_print_iter<'a>( &self, iter: RevIter<'a>, cfg: PrintCfg, ) -> impl Iterator<Item = (Caret, Item)> + Clone + 'a

Returns a reversed printing iterator

fn has_changed(&self) -> bool

Whether or not self has changed

fn is_master_of(&self, other: &Self) -> bool

Whether or not self is the “master” of other

fn get_cluster_master(&self) -> Option<Self>

Returns the clustered master of self, if there is one

fn cache(&self) -> Option<Self::Cache>

Returns the statics from self

fn width(&self) -> u32

Gets the width of the area

fn height(&self) -> u32

Gets the height of the area

fn first_points(&self, _text: &Text, _cfg: PrintCfg) -> (Point, Option<Point>)

The first point that should be printed

fn last_points(&self, text: &Text, cfg: PrintCfg) -> (Point, Option<Point>)

The last point that should be printed

fn print_info(&self) -> Self::PrintInfo

The current printing information of the area

fn is_active(&self) -> bool

Returns true if this is the currently active RawArea