Struct conrod::Tabs

pub struct Tabs<'a> {
    // some fields omitted
}

A wrapper around a list of canvasses that displays thema s a list of selectable tabs.

Methods

impl<'a> Tabs<'a>

fn new(tabs: &'a [(WidgetId, &'a str)]) -> Tabs<'a>

Construct some new Canvas Tabs.

fn bar_width(self, width: Scalar) -> Self

Set the exact width of the tab bar.

fn starting_tab_idx(self, idx: usize) -> Self

Set the initially selected tab with an index for our tab list.

fn starting_canvas(self, canvas_id: WidgetId) -> Self

Set the initially selected tab with a Canvas via its WidgetId.

fn layout_horizontally(self) -> Self

Layout the tabs horizontally.

fn layout_vertically(self) -> Self

Layout the tabs vertically.

fn label_color(self, color: Color) -> Self

The color of the tab labels.

fn label_font_size(self, size: FontSize) -> Self

The font size for the tab labels.

fn canvas_style(self, canvas_style: Style) -> Self

The style that will be used for the selected Canvas.

fn pad_left(self, pad: Scalar) -> Tabs<'a>

Set the padding from the left edge.

fn pad_right(self, pad: Scalar) -> Tabs<'a>

Set the padding from the right edge.

fn pad_top(self, pad: Scalar) -> Tabs<'a>

Set the padding from the top edge.

fn pad_bottom(self, pad: Scalar) -> Tabs<'a>

Set the padding from the bottom edge.

fn pad(self, pad: Scalar) -> Tabs<'a>

Set the padding for all edges.

fn margin_left(self, mgn: Scalar) -> Tabs<'a>

Set the margin from the left edge.

fn margin_right(self, mgn: Scalar) -> Tabs<'a>

Set the margin from the right edge.

fn margin_top(self, mgn: Scalar) -> Tabs<'a>

Set the margin from the top edge.

fn margin_bottom(self, mgn: Scalar) -> Tabs<'a>

Set the margin from the bottom edge.

fn margin(self, mgn: Scalar) -> Tabs<'a>

Set the margin for all edges.

Trait Implementations

impl<'a> Widget for Tabs<'a>

type State = State

State to be stored within the Uis widget cache. Take advantage of this type for any large allocations that you would like to avoid repeating between updates, or any calculations that you'd like to avoid repeating between calls to update and draw. Conrod will never clone the state, it will only ever be moved.

type Style = Style

Styling used by the widget to construct an Element. Styling is useful to have in its own abstraction in order to making Theme serializing easier. Conrod doesn't yet support serializing non-internal widget styling with the Theme type, but we hope to soon.

fn common(&self) -> &CommonBuilder

Return a reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget.

fn common_mut(&mut self) -> &mut CommonBuilder

Return a mutable reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget.

fn unique_kind(&self) -> &'static str

Return the kind of the widget as a &'static str. Note that this must be unique from all other widgets' "unique kinds". This is used by conrod to help avoid WidgetId errors and to provide better messages for those that do occur.

fn init_state(&self) -> State

Return the initial State of the Widget. The Ui will only call this once.

fn style(&self) -> Style

Return the styling of the widget. The Ui will call this once prior to each update. It does this so that it can check for differences in Style in case a new Element needs to be constructed.

fn kid_area(state: &State<State>, style: &Style, theme: &Theme) -> KidArea

The area on which child widgets will be placed when using the Place Position methods.

fn update<'b, 'c, C>(self, args: UpdateArgs<'b, 'c, Self, C>) -> Option<State> where C: CharacterCache

Update the state of the Tabs.

fn draw<'b, C>(args: DrawArgs<'b, Self, C>) -> Element where C: CharacterCache

Construct an Element from the given Button State.

fn set_children<C>(id: WidgetId, state: &State<State>, style: &Style, ui: &mut Ui<C>) where C: CharacterCache

Set the currently active canvas as a child (called directly after update).

fn default_position(&self, _theme: &Theme) -> Position

The default Position for the widget. This is used when no Position is explicitly given when instantiating the Widget.

fn default_h_align(&self, theme: &Theme) -> HorizontalAlign

The default horizontal alignment for the widget. This is used when no HorizontalAlign is explicitly given when instantiating a Widget.

fn default_v_align(&self, theme: &Theme) -> VerticalAlign

The default vertical alignment for the widget. This is used when no VerticalAlign is explicitly given when instantiating a Widget.

fn default_width<C: CharacterCache>(&self, _theme: &Theme, _: &GlyphCache<C>) -> Scalar

The default width of the widget. A reference to the GlyphCache is provided in case the width should adjust to some text len. This method is only used if no width or dimensions are given.

fn default_height(&self, _theme: &Theme) -> Scalar

The default height of the widget. This method is only used if no height or dimensions are given.

fn capture_mouse(_prev: &Self::State, _new: &Self::State) -> bool

Optionally override with the case that the widget should capture the mouse.

fn uncapture_mouse(_prev: &Self::State, _new: &Self::State) -> bool

Optionally override with the case that the widget should capture the mouse.

fn capture_keyboard(_prev: &Self::State, _new: &Self::State) -> bool

Optionally override with the case that the widget should capture the mouse.

fn uncapture_keyboard(_prev: &Self::State, _new: &Self::State) -> bool

Optionally override with the case that the widget should capture the mouse.

fn drag_area(&self, _dim: Dimensions, _style: &Self::Style, _theme: &Theme) -> Option<Area>

If the widget is draggable, implement this method and return the position an dimensions of the draggable space. The position should be relative to the center of the widget.

fn parent(self, maybe_parent_id: Option<WidgetId>) -> Self

Set the parent widget for this Widget by passing the WidgetId of the parent. This will attach this Widget to the parent widget.

fn floating(self, is_floating: bool) -> Self

Set whether or not the widget is floating (the default is false). A typical example of a floating widget would be a pop-up or alert window.

fn set<C>(self, id: WidgetId, ui: &mut Ui<C>) where C: CharacterCache

Note: There should be no need to override this method.

impl<'a> Colorable for Tabs<'a>

fn color(self, color: Color) -> Self

Set the color of the widget.

fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self

Set the color of the widget from rgba values.

fn rgb(self, r: f32, g: f32, b: f32) -> Self

Set the color of the widget from rgb values.

fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self

Set the color of the widget from hsla values.

fn hsl(self, h: f32, s: f32, l: f32) -> Self

Set the color of the widget from hsl values.

impl<'a> Frameable for Tabs<'a>

fn frame(self, width: f64) -> Self

Set the width of the widget's frame.

fn frame_color(self, color: Color) -> Self

Set the color of the widget's frame.

fn frame_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self

Set the color of the widget's frame with rgba values.

fn frame_rgb(self, r: f32, g: f32, b: f32) -> Self

Set the color of the widget's frame with rgb values.

fn frame_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self

Set the color of the widget's frame with hsla values.

fn frame_hsl(self, h: f32, s: f32, l: f32) -> Self

Set the color of the widget's frame with hsl values.