#widgets #relm #attributes #elm #gui #gtk-based

relm-attributes

简化使用relm crate的属性

22个版本 (11个破坏性更新)

使用旧Rust 2015

0.16.0 2019年4月14日
0.15.3 2019年3月25日
0.15.2 2019年1月15日
0.15.0 2018年9月12日
0.9.0 2017年4月27日

#1934 in 过程宏

Download history 1/week @ 2024-02-19 131/week @ 2024-02-26 9/week @ 2024-03-04 3/week @ 2024-03-11

每月144次下载
2 crate 使用

MIT 协议

105KB
2.5K SLoC

Relm

异步、基于GTK+的GUI库,受Elm启发,用Rust编写。

此库处于beta阶段:尚未经过彻底测试,其API可能随时更改。

link link link link link link link link

需求

由于relm基于GTK+,您需要在该系统上安装此库才能使用它。

有关如何安装GTK+的信息,请参阅此页面

用法

首先,将以下内容添加到您的 Cargo.toml

[source,toml]

gtk = "^0.16.0"
relm = "^0.24.0"
relm-derive = "^0.24.0"

然后,将以下内容添加到您的crate

[source,rust]

use relm::{connect, Relm, Update, Widget};
use gtk::prelude::*;
use gtk::{Window, Inhibit, WindowType};
use relm_derive::Msg;

然后,创建您的模型

[source,rust]

struct Model {
    //
}

模型包含与Widget相关的数据。它可能由Widget::update函数更新。

创建您的消息 enum

[source,rust]

#[derive(Msg)]
enum Msg {
    //
    Quit,
}

消息被发送到Widget::update以指示发生了事件。当收到事件时,模型可以被更新。

创建一个代表包含GTK+小部件(在本例中为应用程序的主窗口)和模型的struct

[source,rust]

struct Win {
    //
    model: Model,
    window: Window,
}

为了使此struct成为库可以显示的relm Widget,实现UpdateWidget特质

[source,rust]

impl Update for Win {
    // Specify the model used for this widget.
    type Model = Model;
    // Specify the model parameter used to init the model.
    type ModelParam = ();
    // Specify the type of the messages sent to the update function.
    type Msg = Msg;

    // Return the initial model.
    fn model(_: &Relm<Self>, _: ()) -> Model {
        Model {
        }
    }

    // The model may be updated when a message is received.
    // Widgets may also be updated in this function.
    fn update(&mut self, event: Msg) {
        match event {
            Msg::Quit => gtk::main_quit(),
        }
    }
}

impl Widget for Win {
    // Specify the type of the root widget.
    type Root = Window;

    // Return the root widget.
    fn root(&self) -> Self::Root {
        self.window.clone()
    }

    // Create the widgets.
    fn view(relm: &Relm<Self>, model: Self::Model) -> Self {
        // GTK+ widgets are used normally within a `Widget`.
        let window = Window::new(WindowType::Toplevel);

        // Connect the signal `delete_event` to send the `Quit` message.
        connect!(relm, window, connect_delete_event(_, _), return (Some(Msg::Quit), Inhibit(false)));
        // There is also a `connect!()` macro for GTK+ events that do not need a
        // value to be returned in the callback.

        window.show_all();

        Win {
            model,
            window,
        }
    }
}

最后,通过调用Win::run()显示此Widget

[source,rust]

fn main() {
    Win::run(()).unwrap();
}

#[widget] 属性

提供 #[widget] 属性以简化小部件的创建。

该属性执行以下操作

  • 提供一个 view! 宏,以声明性语法创建小部件。
  • 自动创建 fn root()type Msgtype Modeltype ModelParamtype Root 项目。
  • 在将属性分配给模型时,自动在 update() 函数中插入对 Widget::set_property() 的调用。
  • 自动创建 Widget 结构。
  • UpdateWidget 特性可以一次实现。

要使用此属性,请添加以下代码

[source,rust]

use relm_derive::widget;

以下是一个使用此属性的示例

[source,rust]

#[derive(Msg)]
pub enum Msg {
    Decrement,
    Increment,
    Quit,
}

pub struct Model {
    counter: u32,
}

#[widget]
impl Widget for Win {
    fn model() -> Model {
        Model {
            counter: 0,
        }
    }

    fn update(&mut self, event: Msg) {
        match event {
            // A call to self.label1.set_text() is automatically inserted by the
            // attribute every time the model.counter attribute is updated.
            Msg::Decrement => self.model.counter -= 1,
            Msg::Increment => self.model.counter += 1,
            Msg::Quit => gtk::main_quit(),
        }
    }

    view! {
        gtk::Window {
            gtk::Box {
                orientation: Vertical,
                gtk::Button {
                    // By default, an event with one paramater is assumed.
                    clicked => Msg::Increment,
                    // Hence, the previous line is equivalent to:
                    // clicked(_) => Increment,
                    label: "+",
                },
                gtk::Label {
                    // Bind the text property of this Label to the counter attribute
                    // of the model.
                    // Every time the counter attribute is updated, the text property
                    // will be updated too.
                    text: &self.model.counter.to_string(),
                },
                gtk::Button {
                    clicked => Msg::Decrement,
                    label: "-",
                },
            },
            // Use a tuple when you want to both send a message and return a value to
            // the GTK+ callback.
            delete_event(_, _) => (Msg::Quit, Inhibit(false)),
        }
    }
}

注意:现在,struct Win 由属性自动创建,以及函数 root() 和相关的类型 ModelModelParamMsg 以及 Container。如果需要,您还可以提供方法和相关类型,但您不能创建 struct

警告:#[widget] 使生成的 struct 公开:因此,相应的模型和消息类型也必须是公开的。

[警告]

使用此属性时,由于代码生成简单,您的程序可能会变慢。例如,以下代码 [source,rust]

fn update(&mut self, event: Msg) {
    for _ in 0..100 {
        self.model.counter += 1;
    }
}

将生成此函数:[source,rust]

fn update(&mut self, event: Msg) {
    for _ in 0..100 {
        self.model.counter += 1;
        self.label1.set_text(&self.model.counter.to_string());
    }
}

[警告]

此外,set_property() 调用目前仅在将属性分配给模型时插入。例如,以下代码 [source,rust]

fn update(&mut self, event: Msg) {
    self.model.text.push_str("Text");
}

将不会按预期工作。

如果需要,请使用以下变体。 [source,rust]

fn update(&mut self, event: Msg) {
    self.model.text += "Text";
}

有关如何使用 relm 的更多信息,您可以查看 示例

捐赠

如果您喜欢这个项目并且希望实现新功能,请在我所在的 Patreon 上支持我。

link

使用 relm 的项目

  • Yellow Pitaya:用于 redpitaya 硬件示波器的桌面界面。
  • Game of Life:康威生命游戏模拟器
  • 国家解析器:解析谷歌位置历史并显示访问过的国家的时间线
  • Chessground:一个实验性的棋盘小部件
  • Effitask:基于todo.txt格式的图形任务管理器
  • KS 曲线追踪器:AD2曲线追踪器的配套应用程序
  • Cigale:准备你在工作中完成的任务的时间表的工具
  • Projectpad:作为软件开发人员或系统管理员管理秘密凭证和服务器信息。
  • TimezoneRS:一个GUI应用程序,可以直观地看到不同时区的时间
  • Tubefeeder / Pipeline:在一个地方观看YouTube、LBRY和PeerTube视频。
  • Hotwire:以简单的方式研究一些流行协议的网络流量
  • gue:控制飞利浦 hue 灯的GUI
  • MyCitadel 钱包:MyCitadel 比特币钱包应用程序

如果您想将您的项目添加到此列表中,请创建一个拉取请求

依赖关系

~2MB
~45K SLoC