Struct newt::widgets::form::Form

pub struct Form<'a> { /* fields omitted */ }

Displays Components and accepts user input.

Implementations

impl<'a> Form<'a>

pub fn new(scrollbar: Option<&VerticalScrollbar>, flags: i32) -> Form<'a>

Creates a new Form.

pub fn new_with_help_callback<FN, T>(
    scrollbar: Option<&VerticalScrollbar>,
    flags: i32,
    function: FN,
    data: Option<T>
) -> (Form<'a>, Box<HelpCallback<'a, FN, T>>) where
    FN: Fn(&Form, Option<&T>), 

Creates a new Form with an associated help HelpCallback. See HelpCallback for additional information.

pub fn add_component(
    &mut self,
    component: &'a dyn Component
) -> Result<(), &'static str>

Add a Component to the Form to be displayed when the Form is run.

pub fn add_components<'t>(
    &mut self,
    components: &'t [&'a dyn Component]
) -> Result<(), &'static str>

Add multiple Components to the Form.

pub fn take_component<T>(&mut self, component: T) -> Result<(), &'static str> where
    T: Component, 

Add a Component to the Form, taking ownership.

pub fn set_height(&self, height: i32)

Set the height of the Form.

pub fn set_width(&self, width: i32)

Set the width of the Form.

pub fn set_size(&self)

Tell the Form to resize itself.

pub fn add_hot_key(&self, key: i32)

Add an exit hot key to the Form. The Form will stop running when the key is pressed.

pub fn set_timer(&self, millisecs: i32)

Add an exit timer to the Form. The Form will stop running when the timer times out.

• millisecs - The timer countdown in milliseconds.

pub fn watch_fd(&self, fd: RawFd, flags: FDFlags)

Add a file descriptor for the Form to watch. The Form will stop running when the specified activity occurs on the file descriptor.

• fd - The file descriptor to watch.
• flags - Flags specifying the activity to watch for.

pub fn get_current(&self) -> Box<dyn Component>

Get the Form's currently focused Component.

pub fn set_current(&self, subcomponent: &dyn Component)

Set the Form's currently focused Component.

pub fn set_background(&self, color: i32)

Set the Form's background color.

pub fn get_scroll_position(&self) -> i32

pub fn set_scroll_position(&self, position: i32)

pub fn run(&self) -> Result<ExitReason, ()>

Run the form displaying all added components and accepting input from the user.

pub fn draw(&self)

Redraw the Form.

Trait Implementations

impl<'a> Component for Form<'a>

fn co(&self) -> newtComponent

Return newtComponent pointer.

impl<'a> Drop for Form<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> PartialEq<Box<dyn Component + 'static>> for Form<'a>

fn eq(&self, other: &Box<dyn Component>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<ExitReason> for Form<'a>

fn eq(&self, other: &ExitReason) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, Rhs: Component> PartialEq<Rhs> for Form<'a>

fn eq(&self, other: &Rhs) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> WidgetFns for Form<'a>

fn takes_focus(&self, value: bool)

Allow the Widget to be focused when its parent [Form][form] is run.

fn get_position(&self) -> (i32, i32)

Get the position of the Widget's top left corner.

fn get_size(&self) -> (i32, i32)

Get the Widget's width and height.