Struct nannou::ui::widget::FileNavigator

pub struct FileNavigator<'a> {
    pub style: Style,
    pub starting_directory: &'a Path,
    pub types: Types<'a>,
    // some fields omitted
}

A widget for navigating and interacting with a file system.

Fields

style: Style

Unique styling for the widget.

starting_directory: &'a Path

The first directory shown for the FileNavigator.

types: Types<'a>

Only display files of the given type.

Implementations

impl<'a> FileNavigator<'a>

pub fn new(starting_directory: &'a Path, types: Types<'a>) -> FileNavigator<'a>

Begin building a FileNavigator widget that displays only files of the given types.

pub fn all(starting_directory: &'a Path) -> FileNavigator<'a>

Begin building a FileNavigator that will display all file types.

pub fn with_extension(
    starting_directory: &'a Path,
    exts: &'a [&'a str]
) -> FileNavigator<'a>

Begin building a FileNavigator that will only display files whose extensions match one of those within the given extension list.

i.e. A FileNavigator used for navigating lossless audio files might use the following list of extensions: &["wav", "wave", "aiff"].

pub fn directories(starting_directory: &'a Path) -> FileNavigator<'a>

Begin building a FileNavigator that only displays directories.

pub fn unselected_color(self, color: Color) -> FileNavigator<'a>

The color of the unselected entries within each DirectoryView.

pub fn text_color(self, color: Color) -> FileNavigator<'a>

The color of the Text used to display the file names.

pub fn show_hidden_files(self, show_hidden: bool) -> FileNavigator<'a>

Whether to show hidden files and directories.

pub fn font_size(self, font_size: u32) -> FileNavigator<'a>

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

Trait Implementations

impl<'a> Colorable for FileNavigator<'a>

pub fn color(self, color: Color) -> FileNavigator<'a>

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

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

Set the color of the widget from rgba values.

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

Set the color of the widget from rgb values.

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

Set the color of the widget from hsla values.

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

Set the color of the widget from hsl values.

impl<'a> Common for FileNavigator<'a>

pub fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

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

Mutably borrows the CommonBuilder field.

impl<'a> Widget for FileNavigator<'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.

type Event = Vec<Event, Global>

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

pub fn init_state(
    &self,
    id_gen: Generator<'_>
) -> <FileNavigator<'a> as Widget>::State

Return the initial State of the Widget.

pub fn style(&self) -> <FileNavigator<'a> as Widget>::Style

Return the styling of the widget.

pub fn update(
    self,
    args: UpdateArgs<'_, '_, '_, '_, FileNavigator<'a>>
) -> <FileNavigator<'a> as Widget>::Event

Update the state of the Button.

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

The default Position for the widget along the x axis.

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

The default Position for the widget along the y axis.

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

The default width for the Widget.

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

The default height of the widget.

pub 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.

pub fn kid_area(&self, args: KidAreaArgs<'_, Self>) -> KidArea

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

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

Returns either of the following:

pub fn parent(self, parent_id: NodeIndex<u32>) -> Self

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

pub fn no_parent(self) -> Self

Specify that this widget has no parent widgets.

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

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

pub fn graphics_for(self, id: NodeIndex<u32>) -> Self

Indicates that the Widget is used as a non-interactive graphical element for some other widget.

pub 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.

pub 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.

pub fn scroll_kids(self) -> Self

Makes the widget’s KidArea scrollable.

pub fn scroll_kids_vertically(self) -> Self

Makes the widget’s KidArea scrollable.

pub fn scroll_kids_horizontally(self) -> Self

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

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

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

pub 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.

pub 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.

pub 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.

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

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