Crate relm

source ·
Expand description

Asynchronous GUI library based on GTK+.

This library provides a Widget trait that you can use to create asynchronous GUI components. This is the trait you will need to implement for your application. It helps you to implement MVC (Model, View, Controller) in an elegant way.

Installation

Add this to your Cargo.toml:

[dependencies]
gtk = "^0.6.0"
relm = "^0.16.0"
relm-derive = "^0.16.0"

More info can be found in the readme.

Macros

  • Connect events to sending a message.
  • Connect an asynchronous method call to send a message. The variants with $fail_msg will send this message when there’s an error. Those without this argument will ignore the error.
  • Like connect_async!, but also return a Cancellable to control the asynchronous request.
  • Connect an asynchronous function call to send a message. The variants with $fail_msg will send this message when there’s an error. Those without this argument will ignore the error.
  • Like connect_async_func!, but also return a Cancellable to control the asynchronous request.
  • Connect events to sending a message. Similar to connect! but wants a stream instead of a component.
  • Dummy macro to be used with #[derive(Widget)].

Structs

  • A channel to send a message to a relm widget from another thread.
  • Widget that was added by the ContainerWidget::add_widget() method.
  • Struct for relm containers to add GTK+ and relm Widgets.
  • Manager for drawing operations.
  • A stream of messages to be used for widget/signal communication and inter-widget communication. EventStream cannot be send to another thread. Use a Channel Sender instead.
  • Handle event stream to send messages to the update() method.
  • A wrapper over a std::sync::mpsc::Sender to wakeup the glib event loop when sending a message.
  • Handle to a EventStream to emit messages.

Traits

  • Trait to implement relm container widget.
  • Extension trait for GTK+ containers to add and remove relm Widgets.
  • Format trait for enum variants.
  • Trait for a basic (non-widget) component. A component has a model (data) associated with it and can mutate it when it receives a message (in the update() method).
  • Trait for an Update object that can be created directly. This is useful for non-widget component.
  • Trait to implement to manage widget’s events.
  • Trait implemented by the generator to ease the creation of tests of relm widgets using the view! macro.

Functions

  • Create a new relm widget without adding it to an existing widget. This is useful when a relm widget is at the root of another relm widget.
  • Create a new relm container widget without adding it to an existing widget. This is useful when a relm widget is at the root of another relm widget.
  • Create a bare component, i.e. a component only implementing the Update trait, not the Widget trait.
  • Initialize a widget.
  • Initialize a widget for a test.
  • Emit the msg every duration ms.
  • Create the specified relm Widget and run the main event loops.
  • After duration ms, emit msg.