Struct WindowConfigBuilder
pub struct WindowConfigBuilder(WindowConfig);Tuple Fields§
§0: WindowConfigImplementations§
§impl WindowConfigBuilder
impl WindowConfigBuilder
pub fn anchor(&mut self, anchor: WindowAnchor) -> &mut WindowConfigBuilder
pub fn anchor(&mut self, anchor: WindowAnchor) -> &mut WindowConfigBuilder
Decides which corner of the window to place at (row, col).
pub fn border(&mut self, border: WindowBorder) -> &mut WindowConfigBuilder
pub fn border(&mut self, border: WindowBorder) -> &mut WindowConfigBuilder
Style of the optional window border.
pub fn bufpos(&mut self, line: usize, column: usize) -> &mut WindowConfigBuilder
pub fn bufpos(&mut self, line: usize, column: usize) -> &mut WindowConfigBuilder
Places window relative to buffer text (only when
relative is set to
WindowRelativeTo::Window(win)). Takes a zero
indexed (line, column) tuple, with row and col being placed
relative to this position if specified.
pub fn col(&mut self, col: impl Into<f64>) -> &mut WindowConfigBuilder
pub fn col(&mut self, col: impl Into<f64>) -> &mut WindowConfigBuilder
Column position in units of screen cell width. May be fractional
pub fn external(&mut self, external: bool) -> &mut WindowConfigBuilder
pub fn external(&mut self, external: bool) -> &mut WindowConfigBuilder
Whether an attached GUI should display the window as an external top-level window.
pub fn fixed(&mut self, fixed: bool) -> &mut WindowConfigBuilder
pub fn focusable(&mut self, focusable: bool) -> &mut WindowConfigBuilder
pub fn focusable(&mut self, focusable: bool) -> &mut WindowConfigBuilder
Enable focus by user actions like mouse events. Non-focusable windows
can be entered by set_current_win.
pub fn hide(&mut self, hide: bool) -> &mut WindowConfigBuilder
pub fn height(&mut self, height: u32) -> &mut WindowConfigBuilder
pub fn height(&mut self, height: u32) -> &mut WindowConfigBuilder
Window height in character cells. Minimum of 1.
pub fn noautocmd(&mut self, noautocmd: bool) -> &mut WindowConfigBuilder
pub fn noautocmd(&mut self, noautocmd: bool) -> &mut WindowConfigBuilder
If true then no buffer-related autocommand events such as BufEnter
or BufLeave are fired when calling open_win.
pub fn relative(
&mut self,
relative: WindowRelativeTo,
) -> &mut WindowConfigBuilder
pub fn relative( &mut self, relative: WindowRelativeTo, ) -> &mut WindowConfigBuilder
Sets the window layout to floating
Decides what the window is positioned relatively to.
pub fn split(&mut self, direction: SplitDirection) -> &mut WindowConfigBuilder
pub fn split(&mut self, direction: SplitDirection) -> &mut WindowConfigBuilder
Configures where a split window is opened.
pub fn vertical(&mut self, vertical: bool) -> &mut WindowConfigBuilder
pub fn vertical(&mut self, vertical: bool) -> &mut WindowConfigBuilder
Should the split window be opened as vertical.
pub fn row(&mut self, row: impl Into<f64>) -> &mut WindowConfigBuilder
pub fn row(&mut self, row: impl Into<f64>) -> &mut WindowConfigBuilder
Row position in units of screen cell height. May be fractional.
pub fn style(&mut self, style: WindowStyle) -> &mut WindowConfigBuilder
pub fn style(&mut self, style: WindowStyle) -> &mut WindowConfigBuilder
Configures the appearance of the window.
pub fn width(&mut self, width: u32) -> &mut WindowConfigBuilder
pub fn width(&mut self, width: u32) -> &mut WindowConfigBuilder
Window width in character cells. Minimum of 1.
pub fn zindex(&mut self, zindex: u32) -> &mut WindowConfigBuilder
pub fn zindex(&mut self, zindex: u32) -> &mut WindowConfigBuilder
Stacking order. Windows with higher zindex go in front of windows
with lower indices.
pub fn title(&mut self, title: WindowTitle) -> &mut WindowConfigBuilder
pub fn title_pos( &mut self, title_pos: WindowTitlePosition, ) -> &mut WindowConfigBuilder
pub fn build(&mut self) -> WindowConfig
Trait Implementations§
§impl Clone for WindowConfigBuilder
impl Clone for WindowConfigBuilder
§fn clone(&self) -> WindowConfigBuilder
fn clone(&self) -> WindowConfigBuilder
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read more§impl Default for WindowConfigBuilder
impl Default for WindowConfigBuilder
§fn default() -> WindowConfigBuilder
fn default() -> WindowConfigBuilder
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for WindowConfigBuilder
impl RefUnwindSafe for WindowConfigBuilder
impl !Send for WindowConfigBuilder
impl !Sync for WindowConfigBuilder
impl Unpin for WindowConfigBuilder
impl UnwindSafe for WindowConfigBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
§type Error = Infallible
type Error = Infallible
The error type in the returned
Result.§fn into_result(self) -> Result<T, <T as IntoResult<T>>::Error>
fn into_result(self) -> Result<T, <T as IntoResult<T>>::Error>
Converts the value into a
Result.§impl<D> OwoColorize for D
impl<D> OwoColorize for D
§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Set the foreground color generically Read more
§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Set the background color generically. Read more
§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Change the background color to magenta
§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Change the foreground color to the terminal default
§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Change the background color to the terminal default
§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Change the foreground color to bright black
§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Change the background color to bright black
§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Change the foreground color to bright red
§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Change the background color to bright red
§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Change the foreground color to bright green
§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Change the background color to bright green
§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Change the foreground color to bright yellow
§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Change the background color to bright yellow
§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Change the foreground color to bright blue
§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Change the background color to bright blue
§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright magenta
§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright magenta
§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright purple
§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright purple
§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Change the foreground color to bright cyan
§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Change the background color to bright cyan
§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Change the foreground color to bright white
§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Change the background color to bright white
§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Make the text blink (but fast!)
Hide the text
§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Cross out the text
§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the foreground color at runtime. Only use if you do not know which color will be used at
compile-time. If the color is constant, use either [
OwoColorize::fg] or
a color-specific method, such as [OwoColorize::green], Read more§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the background color at runtime. Only use if you do not know what color to use at
compile-time. If the color is constant, use either [
OwoColorize::bg] or
a color-specific method, such as [OwoColorize::on_yellow], Read more§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the foreground color to a specific RGB value.
§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the background color to a specific RGB value.
§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
Sets the foreground color to an RGB value.
§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
Sets the background color to an RGB value.