Struct conrod::widget::file_navigator::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.

Methods

impl<'a> FileNavigator<'a>

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

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

fn all(starting_directory: &'a Path) -> Self

Begin building a FileNavigator that will display all file types.

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

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"].

fn directories(starting_directory: &'a Path) -> Self

Begin building a FileNavigator that only displays directories.

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

The color of the unselected entries within each DirectoryView.

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

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

fn show_hidden_files(self, show_hidden: bool) -> Self

Whether to show hidden files and directories.

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

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

Trait Implementations

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>

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

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>) -> Self::Event

Update the state of the Button.

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 default_x_dimension(&self, ui: &Ui) -> Dimension

The default width for the Widget.

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

The default height of 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(&self, args: KidAreaArgs<Self>) -> KidArea

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

fn is_over(&self) -> IsOverFn

Returns either of the following:

fn parent(self, parent_id: Id) -> 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: Id) -> 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: Id, ui_cell: &'a mut UiCell<'b>) -> Self::Event

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

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