Struct kas_widgets::Image

pub struct Image { /* private fields */ }

An image with margins

May be default constructed (result is empty).

Implementations

impl Image

pub fn new(handle: ImageHandle, draw: &mut dyn DrawShared) -> Option<Self>

Construct from a pre-allocated image

The image may be allocated through the DrawShared interface.

pub fn set( &mut self, handle: ImageHandle, draw: &mut dyn DrawShared ) -> Option<Action>

Assign a pre-allocated image

Returns Action::RESIZE on success. On error, self is unchanged.

pub fn clear(&mut self, draw: &mut dyn DrawShared) -> Action

Remove image (set empty)

pub fn with_scaling(self, f: impl FnOnce(&mut PixmapScaling)) -> Self

Adjust scaling

By default, this is PixmapScaling::default except with fix_aspect: true.

pub fn set_scaling(&mut self, f: impl FnOnce(&mut PixmapScaling)) -> Action

Adjust scaling

By default, this is PixmapScaling::default except with fix_aspect: true.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl Default for Image

fn default() -> Image

Returns the “default value” for a type.

impl Layout for Image

fn size_rules(&mut self, size_mgr: SizeMgr<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

fn draw(&mut self, draw: DrawMgr<'_>)

Draw a widget and its children

fn find_id(&mut self, coord: Coord) -> Option<WidgetId>

Translate a coordinate to a WidgetId

impl Widget for Image

fn pre_configure(&mut self, _: &mut ConfigMgr<'_>, id: WidgetId)

Pre-configuration

fn configure(&mut self, mgr: &mut ConfigMgr<'_>)

Configure widget

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn translation(&self) -> Offset

Get translation of children relative to this widget

fn nav_next( &mut self, mgr: &mut ConfigMgr<'_>, reverse: bool, from: Option<usize> ) -> Option<usize>

Navigation in spatial order

fn handle_event(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an Event sent to this widget

fn steal_event( &mut self, mgr: &mut EventMgr<'_>, id: &WidgetId, event: &Event ) -> Response

Potentially steal an event before it reaches a child

fn handle_unused(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an event sent to child index but left unhandled

fn handle_message(&mut self, mgr: &mut EventMgr<'_>)

Handler for messages from children/descendants

fn handle_scroll(&mut self, mgr: &mut EventMgr<'_>, scroll: Scroll)

Handler for scrolling

impl WidgetChildren for Image

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn Widget>

Get a reference to a child widget by index, or None if the index is out of bounds.

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn Widget>

Mutable variant of get

fn find_child_index(&self, id: &WidgetId) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn make_child_id(&mut self, index: usize) -> WidgetId

Make an identifier for a child

impl WidgetCore for Image

fn id_ref(&self) -> &WidgetId

Get the widget’s identifier

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

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

Get the name of the widget struct

fn as_widget(&self) -> &dyn Widget

Erase type

fn as_widget_mut(&mut self) -> &mut dyn Widget

Erase type