Struct veloren_voxygen::ui::ItemTooltip

pub struct ItemTooltip<'a> {

    common: CommonBuilder,
    item: &'a dyn ItemDesc,
    msm: &'a MaterialStatManifest,
    rbm: &'a RecipeBookManifest,
    inventory: Option<&'a Inventory>,
    prices: &'a Option<SitePrices>,
    image: Option<Id>,
    image_dims: Option<(f64, f64)>,
    style: Style,
    transparency: f32,
    image_frame: ImageFrame,
    client: &'a Client,
    info: &'a HudInfo,
    imgs: &'a Imgs,
    item_imgs: &'a ItemImgs,
    pulse: f32,
    localized_strings: &'a Localization,
    item_i18n: &'a ItemI18n,
}

A widget for displaying tooltips

Fields

common: CommonBuilder

item: &'a dyn ItemDesc

msm: &'a MaterialStatManifest

rbm: &'a RecipeBookManifest

inventory: Option<&'a Inventory>

Inventory is optional because not all clients have an inventory (spectator)

prices: &'a Option<SitePrices>

image: Option<Id>

image_dims: Option<(f64, f64)>

style: Style

transparency: f32

image_frame: ImageFrame

client: &'a Client

info: &'a HudInfo

imgs: &'a Imgs

item_imgs: &'a ItemImgs

pulse: f32

localized_strings: &'a Localization

item_i18n: &'a ItemI18n

Implementations

impl<'a> ItemTooltip<'a>

pub fn desc_text_color(self, desc_text_color: Color) -> Self

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

pub fn title_font_size(self, title_font_size: FontSize) -> Self

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

pub fn desc_font_size(self, desc_font_size: FontSize) -> Self

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

pub fn title_justify(self, title_justify: Justify) -> Self

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

pub fn desc_justify(self, desc_justify: Justify) -> Self

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

pub fn title_line_spacing(self, title_line_spacing: Scalar) -> Self

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

pub fn desc_line_spacing(self, desc_line_spacing: Scalar) -> Self

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

fn image(self, image: Option<Id>) -> Self

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

fn item(self, item: &'a dyn ItemDesc) -> Self

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

fn prices(self, prices: &'a Option<SitePrices>) -> Self

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

fn msm(self, msm: &'a MaterialStatManifest) -> Self

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

fn rbm(self, rbm: &'a RecipeBookManifest) -> Self

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

fn image_dims(self, image_dims: Option<(f64, f64)>) -> Self

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

fn transparency(self, transparency: f32) -> Self

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

pub fn new( image_frame: ImageFrame, client: &'a Client, info: &'a HudInfo, imgs: &'a Imgs, item_imgs: &'a ItemImgs, pulse: f32, msm: &'a MaterialStatManifest, rbm: &'a RecipeBookManifest, inventory: Option<&'a Inventory>, localized_strings: &'a Localization, item_i18n: &'a ItemI18n, ) -> Self

fn text_image_width(&self, total_width: f64) -> (f64, f64)

Align the text to the left of its bounding Rect’s x axis range. Align the text to the middle of its bounding Rect’s x axis range. Align the text to the right of its bounding Rect’s x axis range.

pub fn font_id(self, font_id: Id) -> Self

Specify the font used for displaying the text.

Trait Implementations

impl<'a> Clone for ItemTooltip<'a>

fn clone(&self) -> ItemTooltip<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Colorable for ItemTooltip<'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> Common for ItemTooltip<'a>

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

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

Mutably borrows the CommonBuilder field.

impl<'a> Widget for ItemTooltip<'a>

fn default_x_dimension(&self, _ui: &Ui) -> Dimension

Default width is based on the description font size unless the text is small enough to fit on a single line

type Event = ()

The type of event yielded by the widget, returned via the Widget::set function.

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 init_state(&self, id_gen: Generator<'_>) -> Self::State

Return the initial State of the Widget.

fn style(&self) -> Self::Style

Return the styling of the widget.

fn update(self, args: UpdateArgs<'_, '_, '_, '_, Self>)

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

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

The default height of the widget.

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

The default Position for the widget along the x axis.

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

The default Position for the widget along the y axis.

fn drag_area( &self, _dim: [f64; 2], _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(&self, args: KidAreaArgs<'_, Self>) -> KidArea

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

fn is_over(&self) -> fn(_: &Container, _: [f64; 2], _: &Theme) -> IsOver

Returns either of the following:

fn parent(self, parent_id: NodeIndex) -> 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(self, id: NodeIndex) -> 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 Widget with the given build function.

fn set<'a, 'b>(self, id: NodeIndex, ui_cell: &'a mut UiCell<'b>) -> Self::Event

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