Struct conrod::CommonBuilder

pub struct CommonBuilder {
    pub style: CommonStyle,
    pub maybe_parent_idx: MaybeParent,
    pub is_floating: bool,
    pub scrolling: Scrolling,
    pub picking_passthrough: bool,
    pub place_on_kid_area: bool,
    pub maybe_graphics_for: Option<Index>,
}

A struct containing builder data common to all Widget types.

This type also allows us to do a blanket impl of Positionable and Sizeable for T: Widget.

When Rust gets some sort of field inheritance feature, this will most likely be refactored to take advantage of that.

Fields

style: CommonStyle

Styling and positioning data that is common between all widget types.

maybe_parent_idx: MaybeParent

The parent widget of the Widget.

is_floating: bool

Whether or not the Widget is a "floating" Widget.

scrolling: Scrolling

Builder data for scrollable widgets.

picking_passthrough: bool

Whether or not the widget should be considered when picking the topmost widget at a position.

This also stops the widget from being included within bounding box calculations.

This is useful to indicate whether or not the widget should block the mouse from interacting with widgets underneath it.

place_on_kid_area: bool

Whether or not the Widget should be placed on the kid_area.

If true, the Widget will be placed on the kid_area of the parent Widget if the Widget is given a Place variant for its Position.

If false, the Widget will be placed on the parent Widget's total area.

maybe_graphics_for: Option<Index>

Describes whether or not the Widget is instantiated as a graphical element for some other Widget.

When adding an edge a -> b where b is considered to be a graphical element of a, several things are implied about b:

• If b is picked within either Graph::pick_widget or Graph::pick_top_scrollable_widget, it will instead return the index for a.
• When determining the Graph::scroll_offset for b, a's scrolling (if it is scrollable, that is) will be skipped.
• b will always be placed upon a's total area, rather than its kid_area which is the default.
• Any Graphic child of b will be considered as a Graphic child of a.

Methods

impl CommonBuilder

fn new() -> CommonBuilder

Construct an empty, initialised CommonBuilder.

Trait Implementations

impl Debug for CommonBuilder

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Copy for CommonBuilder

impl Clone for CommonBuilder

fn clone(&self) -> CommonBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.