Struct conrod::TitleBar

pub struct TitleBar<'a> {
    pub common: CommonBuilder,
    pub style: Style,
    pub label: &'a str,
}

A simple title bar widget that automatically sizes itself to the top of some other widget.

Fields

common: CommonBuilder

Data necessary and common for all widget builder types.

style: Style

Unique styling for the FramedRectangle.

label: &'a str

A label displayed in the middle of the TitleBar.

Methods

impl<'a> TitleBar<'a>

fn new<I>(label: &'a str, idx: I) -> Self where I: Into<Index> + Copy

Construct a new TitleBar widget and attach it to the widget at the given index.

fn align_text_left(self) -> Self

Align the text to the left of its bounding Rect's x axis range.

fn align_text_middle(self) -> Self

Align the text to the middle of its bounding Rect's x axis range.

fn align_text_right(self) -> Self

Align the text to the right of its bounding Rect's x axis range.

fn line_spacing(self, line_spacing: Scalar) -> Self

Build the type's self.$($assignee).+ with the given $Type.

Trait Implementations

impl<'a> Widget for TitleBar<'a>

type State = State

State to be stored within the Uis widget cache.

type Style = Style

Every widget is required to have its own associated Style type. This type is intended to contain high-level styling information for the widget that can be optionally specified by a user of the widget.

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.

fn init_state(&self) -> State

Return the initial State of the Widget.

fn style(&self) -> Style

Return the styling of the widget.

fn default_y_dimension<B: Backend>(&self, ui: &Ui<B>) -> Dimension

The default height of the widget.

fn update<B: Backend>(self, args: UpdateArgs<Self, B>)

Update our Widget's unique Widget::State via the State wrapper type (the state field within the UpdateArgs).

fn default_x_position<B: Backend>(&self, ui: &Ui<B>) -> Position

The default Position for the widget along the x axis.

fn default_y_position<B: Backend>(&self, ui: &Ui<B>) -> Position

The default Position for the widget along the y axis.

fn default_x_dimension<B: Backend>(&self, ui: &Ui<B>) -> Dimension

The default width for the Widget.

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

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

fn kid_area<C: CharacterCache>(&self, args: KidAreaArgs<Self, C>) -> KidArea

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

fn parent<I: Into<Index>>(self, parent_idx: I) -> Self

Set the parent widget for this Widget by passing the WidgetId of the parent.

fn no_parent(self) -> Self

Specify that this widget has no parent widgets.

fn place_on_kid_area(self, b: bool) -> Self

Set whether or not the Widget should be placed on the kid_area.

fn graphics_for<I: Into<Index>>(self, idx: I) -> Self

Indicates that the Widget is used as a non-interactive graphical element for some other 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 crop_kids(self) -> Self

Indicates that all widgets who are children of this widget should be cropped to the kid_area of this widget.

fn scroll_kids(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_vertically(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_horizontally(self) -> Self

Set whether or not the widget's KidArea is scrollable (the default is false).

fn and<F>(self, build: F) -> Self where F: FnOnce(Self) -> Self

A builder method that "lifts" the Widget through the given build function.

fn and_mut<F>(self, mutate: F) -> Self where F: FnOnce(&mut Self)

A builder method that mutates the Widget with the given mutate function.

fn and_if<F>(self, cond: bool, build: F) -> Self where F: FnOnce(Self) -> Self

A method that conditionally builds the Widget with the given build function.

fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where F: FnOnce(Self, T) -> Self

A method that optionally builds the the Widget with the given build function.

fn set<'a, 'b, I, B>(self, idx: I, ui_cell: &'a mut UiCell<'b, B>) where I: Into<Index>, B: Backend

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

impl<'a> Colorable for TitleBar<'a>

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

Build the type's self.$($assignee).+ with the given $Type.

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 TitleBar<'a>

fn frame(self, frame: Scalar) -> Self

Build the type's self.$($assignee).+ with the given $Type.

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

Build the type's self.$($assignee).+ with the given $Type.

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.

impl<'a> Labelable<'a> for TitleBar<'a>

fn label(self, label: &'a str) -> Self

Build the type's self.$($assignee).+ with the given $Type.

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

Build the type's self.$($assignee).+ with the given $Type.

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

Build the type's self.$($assignee).+ with the given $Type.

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

Set the color of the widget's label from rgba values.

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

Set the color of the widget's label from rgb values.

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

Set the color of the widget's label from hsla values.

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

Set the color of the widget's label from hsl values.

fn small_font<B: Backend>(self, ui: &Ui<B>) -> Self

Set a "small" font size for the widget's label.

fn medium_font<B: Backend>(self, ui: &Ui<B>) -> Self

Set a "medium" font size for the widget's label.

fn large_font<B: Backend>(self, ui: &Ui<B>) -> Self

Set a "large" font size for the widget's label.