Struct mogwai::gizmo::Gizmo

pub struct Gizmo<T: JsCast> { /* fields omitted */ }

A widget that may contain a bundled network of html elements, callback closures and receivers.

Implementations

impl<T: JsCast + AsRef<EventTarget>> Gizmo<T>

pub fn tx_on(self, ev_name: &str, tx: Transmitter<Event>) -> Gizmo<T>

Sends an event into the given transmitter when the given dom event happens.

pub fn tx_on_window(self, ev_name: &str, tx: Transmitter<Event>) -> Gizmo<T>

Sends an event into the given transmitter when the given dom event happens on window.

pub fn tx_on_document(self, ev_name: &str, tx: Transmitter<Event>) -> Gizmo<T>

Sends an event into the given transmitter when the given dom event happens.

impl<T: JsCast + AsRef<Node>> Gizmo<T>

pub fn text(self, s: &str) -> Gizmo<T>

Create a text node and insert it into the Gizmo being built.

pub fn rx_text(self, init: &str, rx: Receiver<String>) -> Gizmo<T>

Create a text node that changes its text to anything that is sent on the given receiver and insert it into the Gizmo being built.

pub fn with<Child>(self, child: Child) -> Gizmo<T> where
    Child: SubGizmo, 

Append a child that implements SubGizmo to this Gizmo.

impl<T: JsCast + AsRef<Element>> Gizmo<T>

pub fn attribute(self, name: &str, value: &str) -> Gizmo<T>

Create a static attribute on the Gizmo being built.

pub fn boolean_attribute(self, name: &str, condition: bool) -> Gizmo<T>

If condition is true, create a static boolean attribute on the Gizmo being built.

For background on condition See https://github.com/schell/mogwai/issues/19

pub fn class(self, value: &str) -> Gizmo<T>

Create a class attribute on the Gizmo being built.

This represents all the classes for this gizmo. If you'd like to specify more than one class call this as:

extern crate mogwai;
use mogwai::prelude::*;

let gizmo_the_long_way =
  Gizmo::element("div")
  .downcast::<HtmlElement>().ok().unwrap()
  .class("class1 class2 class3 etc");

let gizmo =
  div()
  .class("class1 class2 class3 etc");

pub fn id(self, value: &str) -> Gizmo<T>

Create an id attribute on the Gizmo being built.

pub fn rx_attribute(
    self,
    name: &str,
    init: Option<&str>,
    rx: Receiver<Option<String>>
) -> Gizmo<T>

Create an attribute on the Gizmo being built that changes its value every time the given receiver receives a message. If the receiver receives None it will respond by removing the attribute until it receives Some(...).

pub fn rx_boolean_attribute(
    self,
    name: &str,
    init: bool,
    rx: Receiver<bool>
) -> Gizmo<T>

Create a boolean attribute on the Gizmo being built that changes its value every time the given receiver receives a message. If the receiver receives None it will respond by removing the attribute until it receives Some(...).

pub fn rx_class(self, init: &str, rx: Receiver<String>) -> Gizmo<T>

Create a class attribute on the Gizmo being built that changes its value every time the given receiver receives a message.

impl<T: JsCast + AsRef<HtmlElement>> Gizmo<T>

pub fn style(self, name: &str, value: &str) -> Gizmo<T>

Set a CSS property in the style attribute of the Gizmo being built.

pub fn rx_style(self, s: &str, init: &str, rx: Receiver<String>) -> Gizmo<T>

Set a CSS property in the style attribute of the Gizmo being built that updates its value every time a message is received on the given Receiver.

impl<T: JsCast + AsRef<HtmlInputElement>> Gizmo<T>

pub fn value(self, s: &str) -> Gizmo<T>

Set the value of the Gizmo input.

pub fn rx_value(self, init: &str, rx: Receiver<String>) -> Gizmo<T>

Set the value of the Gizmo input that updates every time a message is received on the given Receiver.

pub fn checked(self, checked: bool) -> Gizmo<T>

Set the checked value of the Gizmo input.

pub fn rx_checked(self, checked: bool, rx: Receiver<bool>) -> Gizmo<T>

Set the value of the Gizmo input that updates every time a message is received on the given Receiver.

impl<T: JsCast> Gizmo<T>

pub fn wrapping(element: T) -> Gizmo<T>

Create a new Gizmo wrapping a T that can be dereferenced to a Node.

impl<T: JsCast + Clone> Gizmo<T>

pub fn upcast<D>(self) -> Gizmo<D> where
    T: AsRef<D>,
    D: JsCast, 

Cast the given Gizmo to contain the inner DOM node of another type. That type must be dereferencable from the given Gizmo.

pub fn downcast<To: JsCast + AsRef<Node>>(self) -> Result<Gizmo<To>, Gizmo<T>>

Attempt to downcast the inner element.

impl<T: JsCast + 'static> Gizmo<T>

pub fn forget(self) -> Result<(), JsValue>

Run this gizmo forever without appending it to anything.

impl<T: JsCast + AsRef<Node> + Clone + 'static> Gizmo<T>

pub fn run_in_container(self, container: &Node) -> Result<(), JsValue>

Run this gizmo in a parent container forever, never dropping it.

pub fn run(self) -> Result<(), JsValue>

Run this gizmo in the document body forever, never dropping it.

pub fn tx_post_build(self, tx: Transmitter<T>) -> Gizmo<T>

After the gizmo is built, send a clone of T on the given transmitter. This allows you to construct component behaviors that operate on the T directly, while still keeping the Gizmo in its place within your view function. For example, you may want to use input.focus() within the update function of your component. This method allows you to store the input's HtmlInputElement once it is built.

impl Gizmo<Element>

pub fn element(tag: &str) -> Self

Create a new gizmo with the given element tag.

Gizmo::element("div")

pub fn element_ns(tag: &str, ns: &str) -> Self

Create a new gizmo with the given element tag.

Gizmo::element("div")

pub fn from_element_by_id(id: &str) -> Option<Gizmo<Element>>

Create a new Gizmo from an existing Element with the given id. Returns None if it cannot be found.

Trait Implementations

impl<T, S> AsRef<S> for Gizmo<T> where
    T: JsCast + AsRef<S>,
    S: JsCast, 

fn as_ref(&self) -> &S

Performs the conversion.

impl<T: JsCast + Clone> Clone for Gizmo<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: JsCast> Deref for Gizmo<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: JsCast> Drop for Gizmo<T>

Gizmo's Drop implementation insures that responders no longer attempt to update the gizmo. It also removes its element from the DOM.

fn drop(&mut self)

Executes the destructor for this type.

impl<T, D> From<T> for Gizmo<D> where
    T: Component,
    T::DomNode: AsRef<D>,
    D: JsCast + 'static, 

fn from(component: T) -> Gizmo<D>

Performs the conversion.

impl<T: JsCast + AsRef<Node> + Clone> SubGizmo for Gizmo<T>

fn into_sub_gizmo(self) -> Result<Gizmo<Node>, Node>

Attempts to turn the Gizmo into a child gizmo who's inner element is a Node, if possible. Otherwise this will return a Node.

impl<'_, T: JsCast + AsRef<Node> + Clone> SubGizmo for &'_ Gizmo<T>

fn into_sub_gizmo(self) -> Result<Gizmo<Node>, Node>

Attempts to turn the Gizmo into a child gizmo who's inner element is a Node, if possible. Otherwise this will return a Node.