Struct DrawCx 

pub struct DrawCx<'a> { /* private fields */ }

Draw interface

This interface is provided to widgets in Layout::draw. Lower-level interfaces may be accessed through Self::draw.

DrawCx is not a Copy or Clone type; instead it may be “reborrowed” via Self::re.

• draw.check_box(&*self, self.state); — note &*self to convert from to &W from &mut W, since the latter would cause borrow conflicts

Implementations

impl<'a> DrawCx<'a>

pub fn re<'b>(&'b mut self) -> DrawCx<'b>

where 'a: 'b,

Reborrow with a new lifetime

Rust allows references like &T or &mut T to be “reborrowed” through coercion: essentially, the pointer is copied under a new, shorter, lifetime. Until rfcs#1403 lands, reborrows on user types require a method call.

pub fn set_id(&mut self, id: Id)

Set the identity of the current widget

This struct tracks the Id of the calling widget to allow evaluation of widget state (e.g. is disabled, is under the mouse, has key focus). Usually you don’t need to worry about this since the #[widget] macro injects a call to this method at the start of Layout::draw.

pub fn ev_state(&mut self) -> &mut EventState

Access event-management state

pub fn size_cx(&mut self) -> SizeCx<'_>

Access a SizeCx

(This also allows access to EventState.)

pub fn colors(&self) -> &ColorsLinear

Access theme colors

pub fn draw_shared(&mut self) -> &mut dyn DrawShared

Access a DrawShared

pub fn draw(&mut self) -> &mut dyn Draw

Access the low-level draw device

Note: this drawing API is modular, with limited functionality in the base trait Draw. To access further functionality, it is necessary to downcast with crate::draw::DrawIface::downcast_from.

pub fn draw_rounded(&mut self) -> Option<&mut dyn DrawRounded>

Access the draw device as a DrawRounded implementation, if possible

Warning: this does not reflect whether the underlying draw device supports DrawRounded (which would require specialization) but whether the theme in question requires DrawRounded. As such, this method is only useful with a theme requiring this extension such as FlatTheme.

pub fn draw_iface<DS: DrawSharedImpl>(&mut self) -> Option<DrawIface<'_, DS>>

Access the low-level draw device (implementation type)

The implementing type must be specified. See DrawIface::downcast_from.

pub fn with_pass<F: FnOnce(DrawCx<'_>)>(&mut self, f: F)

Draw to a new pass

Adds a new draw pass for purposes of enforcing draw order. Content of the new pass will be drawn after content in the parent pass.

Warning: the number of passes used can have a substantial performance impact, potentially more on GPU communication than CPU usage.

pub fn with_clip_region<F: FnOnce(DrawCx<'_>)>( &mut self, rect: Rect, offset: Offset, f: F, )

Draw to a new pass with clipping and offset (e.g. for scrolling)

Adds a new draw pass of type PassType::Clip, with draw operations clipped to rect and translated by `offset.

Warning: the number of passes used can have a substantial performance impact, potentially more on GPU communication than CPU usage.

pub fn with_overlay<F: FnOnce(DrawCx<'_>)>( &mut self, rect: Rect, offset: Offset, f: F, )

Draw to a new pass as an overlay (e.g. for pop-up menus)

Adds a new draw pass of type PassType::Overlay, with draw operations clipped to rect.

The theme is permitted to enlarge the rect for the purpose of drawing a frame or shadow around this overlay, thus the Self::get_clip_rect may be larger than expected.

Warning: the number of passes used can have a substantial performance impact, potentially more on GPU communication than CPU usage.

pub fn get_clip_rect(&mut self) -> Rect

Target area for drawing

Drawing is restricted to this Rect, which may be the whole window, a clip region or an overlay. This may be used to cull hidden items from lists inside a scrollable view.

pub fn access_key(&mut self, id: &Id, key: &Key) -> bool

Register widget id as handler of an access key

An access key (also known as mnemonic) is a shortcut key able to directly open menus, activate buttons, etc. Usually this requires that the Alt is held, though alt-bypass mode is available.

The widget id is bound to the given key, if available. When the access key is pressed (assuming that this binding succeeds), widget id will receive navigation focus (if supported; otherwise an ancestor may receive focus) and is sent Command::Activate (likewise, an ancestor may handle this if widget id does not).

If multiple widgets attempt to register themselves as handlers of the same key, then only the first succeeds.

Returns true when the key should be underlined.

pub fn frame(&mut self, rect: Rect, style: FrameStyle, bg: Background)

Draw a frame inside the given rect

The frame dimensions are given by SizeCx::frame.

pub fn separator(&mut self, rect: Rect)

Draw a separator in the given rect

pub fn selection(&mut self, rect: Rect, style: SelectionStyle)

Draw a selection highlight / frame

Adjusts the background color and/or draws a line around the given rect. In the latter case, a margin of size SizeCx::inner_margins around rect is expected.

pub fn text<T: FormattableText>(&mut self, rect: Rect, text: &Text<T>)

Draw text

Text is clipped to rect.

This is a convenience method over Self::text_with_effects.

The text should be prepared before calling this method.

pub fn text_with_color<T: FormattableText>( &mut self, rect: Rect, text: &Text<T>, color: Rgba, )

Draw text with specified color

Text is clipped to rect and drawn using color.

This is a convenience method over Self::text_with_effects.

The text should be prepared before calling this method.

pub fn text_with_position<T: FormattableText>( &mut self, pos: Coord, rect: Rect, text: &Text<T>, )

Draw text with effects and an offset

Text is clipped to rect, drawing from pos; use pos = rect.pos if the text is not scrolled.

This is a convenience method over Self::text_with_effects.

The text should be prepared before calling this method.

pub fn text_with_effects<T: FormattableText>( &mut self, pos: Coord, rect: Rect, text: &Text<T>, colors: &[Rgba], effects: &[Effect], )

Draw text with a given effect list

Text is clipped to rect, drawing from pos; use pos = rect.pos if the text is not scrolled.

If colors is empty, it is replaced with a single theme-defined color. Text is then drawn using colors[0] except as specified by effects.

The list of effects (if not empty) controls render effects: Effect::e is an index into colors while Effect::flags controls underline and strikethrough. Effect::start is the text index at which this effect first takes effect, and must effects must be ordered such that the sequence of Effect::start values is strictly increasing. Effect::default() is used if effects is empty or while index < effects.first().unwrap().start.

Text objects may embed their own list of effects, accessible using Text::effect_tokens. It is always valid to disregard these and use a custom effects list or empty list.

pub fn text_with_selection<T: FormattableText>( &mut self, pos: Coord, rect: Rect, text: &Text<T>, range: Range<usize>, )

Draw some text with a selection

Text is drawn like Self::text_with_position except that the subset identified by range is highlighted using theme-defined colors.

pub fn text_cursor<T: FormattableText>( &mut self, pos: Coord, rect: Rect, text: &Text<T>, byte: usize, )

Draw an edit marker at the given byte index on this text

The text cursor is draw from rect.pos and clipped to rect.

The text should be prepared before calling this method.

pub fn check_box( &mut self, rect: Rect, checked: bool, last_change: Option<Instant>, )

Draw UI element: check box (without label)

The check box is a small visual element, typically a distinctive square box with or without a “check” selection mark.

The theme may animate transitions. To achieve this, last_change should be the time of the last state change caused by the user, or none when the last state change was programmatic.

pub fn radio_box( &mut self, rect: Rect, checked: bool, last_change: Option<Instant>, )

Draw UI element: radio box (without label)

The radio box is a small visual element, typically a disinctive circular box with or without a “radio” selection mark.

The theme may animate transitions. To achieve this, last_change should be the time of the last state change caused by the user, or none when the last state change was programmatic.

pub fn mark(&mut self, rect: Rect, style: MarkStyle)

Draw UI element: mark

If rect is larger than required, the mark will be centered.

pub fn scroll_bar<W: Tile>( &mut self, track_rect: Rect, grip: &W, dir: Direction, )

Draw UI element: scroll bar

pub fn slider<W: Tile>(&mut self, track_rect: Rect, grip: &W, dir: Direction)

Draw UI element: slider

pub fn progress_bar(&mut self, rect: Rect, dir: Direction, value: f32)

Draw UI element: progress bar

• rect: area of whole widget
• dir: direction of progress bar
• state: highlighting information
• value: progress value, between 0.0 and 1.0

pub fn image(&mut self, rect: Rect, id: ImageId)

Draw an image

Trait Implementations

impl<'a> Debug for DrawCx<'a>

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

Formats the value using the given formatter.