Relm4-macros

一个用于轻松为Relm4应用程序生成UI的宏库。

安装

在项目目录中运行以下Cargo命令：

cargo add relm4-macros

或者在Cargo.toml中添加以下行：

relm4-macros = "0.9.1"

示例代码

下面是一个使用relm4-macros创建简单GTK4应用的完整示例：

use relm4::*;
use gtk::prelude::*;

// 定义应用结构体
pub struct App {
    counter: u8,
}

// 定义消息类型
#[derive(Debug)]
pub enum AppMsg {
    Increment,
    Decrement,
}

// 使用relm4_macros宏定义组件
#[relm4_macros::component]
impl SimpleComponent for App {
    // 初始化模型
    fn init(
        _counter: u8,
        _root: &Self::Root,
        _sender: Sender<AppMsg>,
    ) -> ComponentParts<Self> {
        let model = App { counter: 0 };
        
        // 创建UI widgets
        let widgets = view! {
            gtk::ApplicationWindow {
                set_title: Some("Simple app"),
                set_default_size: (300, 100),
                
                gtk::Box {
                    set_orientation: gtk::Orientation::Vertical,
                    set_spacing: 5,
                    set_margin_all: 5,
                    
                    append: &gtk::Button {
                        set_label: "Increment",
                        connect_clicked => AppMsg::Increment,
                    },
                    
                    append: &gtk::Button {
                        set_label: "Decrement",
                        connect_clicked => AppMsg::Decrement,
                    },
                    
                    append: &gtk::Label {
                        set_margin_all: 5,
                        #[watch]
                        set_label: &format!("Counter: {}", model.counter),
                    },
                },
            }
        };
        
        ComponentParts { model, widgets }
    }

    // 更新模型逻辑
    fn update(&mut self, msg: AppMsg, _sender: Sender<AppMsg>) {
        match msg {
            AppMsg::Increment => {
                self.counter = self.counter.wrapping_add(1);
            }
            AppMsg::Decrement => {
                self.counter = self.counter.wrapping_sub(1);
            }
        }
    }
}

// 运行应用
fn main() {
    let app = RelmApp::new("relm4.example.simple");
    app.run::<App>(0);
}

完整示例demo

以下是一个更完整的计数器应用示例，添加了更多功能和UI元素：

use relm4::*;
use gtk::prelude::*;
use gtk::{glib, ApplicationWindow};

// 定义应用模型
pub struct AppModel {
    counter: i32,
    max_value: i32,
    min_value: i32,
}

// 定义消息类型
#[derive(Debug)]
pub enum AppMsg {
    Increment,
    Decrement,
    Reset,
    SetMax(i32),
    SetMin(i32),
}

// 定义组件部件
#[relm4_macros::component]
impl SimpleComponent for AppModel {
    // 初始化模型
    fn init(
        _params: (),
        _root: &Self::Root,
        sender: Sender<AppMsg>,
    ) -> ComponentParts<Self> {
        let model = AppModel {
            counter: 0,
            max_value: 10,
            min_value: -10,
        };

        // 创建UI widgets
        let widgets = view! {
            gtk::ApplicationWindow {
                set_title: Some("Advanced Counter"),
                set_default_size: (400, 200),
                
                gtk::Box {
                    set_orientation: gtk::Orientation::Vertical,
                    set_spacing: 10,
                    set_margin_all: 10,
                    
                    // 计数器显示
                    append: &gtk::Label {
                        set_margin_all: 10,
                        #[watch]
                        set_label: &format!("当前值: {}", model.counter),
                        set_css_classes: &["title-1"],
                    },
                    
                    // 按钮区域
                    append: &gtk::Box {
                        set_orientation: gtk::Orientation::Horizontal,
                        set_spacing: 5,
                        set_halign: gtk::Align::Center,
                        
                        append: &gtk::Button {
                            set_label: "-",
                            connect_clicked => AppMsg::Decrement,
                            set_tooltip_text: Some("减少计数器"),
                        },
                        
                        append: &gtk::Button {
                            set_label: "重置",
                            connect_clicked => AppMsg::Reset,
                        },
                        
                        append: &gtk::Button {
                            set_label: "+",
                            connect_clicked => AppMsg::Increment,
                            set_tooltip_text: Some("增加计数器"),
                        },
                    },
                    
                    // 设置区域
                    append: &gtk::Frame {
                        set_label: Some("设置"),
                        set_margin_top: 10,
                        
                        gtk::Box {
                            set_orientation: gtk::Orientation::Vertical,
                            set_spacing: 5,
                            set_margin_all: 5,
                            
                            append: &gtk::SpinButton {
                                set_range: (i32::MIN as f64, i32::MAX as f64),
                                set_value: model.max_value as f64,
                                set_increments: (1.0, 10.0),
                                set_digits: 0,
                                connect_value_changed => move |spin| {
                                    sender.send(AppMsg::SetMax(spin.value_as_int())).unwrap();
                                },
                            },
                            
                            append: &gtk::Label {
                                set_label: "最大值限制",
                            },
                            
                            append: &gtk::SpinButton {
                                set_range: (i32::MIN as f64, i32::MAX as f64),
                                set_value: model.min_value as f64,
                                set_increments: (1.0, 10.0),
                                set_digits: 0,
                                connect_value_changed => move |spin| {
                                    sender.send(AppMsg::SetMin(spin.value_as_int())).unwrap();
                                },
                            },
                            
                            append: &gtk::Label {
                                set_label: "最小值限制",
                            },
                        },
                    },
                },
            }
        };

        ComponentParts { model, widgets }
    }

    // 更新模型逻辑
    fn update(&mut self, msg: AppMsg, _sender: Sender<AppMsg>) {
        match msg {
            AppMsg::Increment => {
                if self.counter < self.max_value {
                    self.counter += 1;
                }
            }
            AppMsg::Decrement => {
                if self.counter > self.min_value {
                    self.counter -= 1;
                }
            }
            AppMsg::Reset => {
                self.counter = 0;
            }
            AppMsg::SetMax(value) => {
                self.max_value = value;
                if self.counter > value {
                    self.counter = value;
                }
            }
            AppMsg::SetMin(value) => {
                self.min_value = value;
                if self.counter < value {
                    self.counter = value;
                }
            }
        }
    }
}

// 运行应用
fn main() {
    let app = RelmApp::new("relm4.example.advanced");
    app.run::<AppModel>(());
}

特性

声明式UI语法，类似React的JSX
自动处理GTK widget的创建和配置
响应式数据绑定
简洁的消息处理机制
编译时类型检查

许可证

Apache-2.0 OR MIT

itying888 1楼

Rust GUI框架Relm4宏库relm4-macros的使用指南

介绍

relm4-macros是Relm4框架提供的声明式宏工具包，旨在简化基于GTK4的GUI应用开发。它提供了一种类似React的声明式语法来构建用户界面，同时保持了Rust的类型安全和所有权模型优势。

Relm4结合了GTK4的强大功能和Rust的现代特性，而relm4-macros则通过宏进一步简化了开发流程，让开发者可以用更少的代码实现复杂的GUI功能。

主要特性

声明式UI构建方式
自动化的组件管理
简化的消息传递机制
类型安全的绑定系统
与GTK4无缝集成

完整示例代码

下面是一个完整的Relm4应用示例，演示了计数器功能：

use relm4::*;
use gtk::prelude::*;

// 定义消息枚举
#[derive(Debug)]
enum CounterMsg {
    Increment,
    Decrement,
    Reset,
}

// 定义应用结构体
struct CounterApp {
    count: i32,
}

// 实现组件
#[relm4::component]
impl SimpleComponent for CounterApp {
    // 初始化函数
    fn init(
        _: (),
        root: &Self::Root,
        sender: ComponentSender<Self>,
    ) -> ComponentParts<Self> {
        let model = CounterApp { count: 0 };
        
        // 构建UI
        let widgets = view_output!();
        
        ComponentParts { model, widgets }
    }

    // UI定义
    view! {
        gtk::ApplicationWindow {
            set_title: Some("Counter App"),
            set_default_size: (300, 200),
            
            gtk::Box {
                set_orientation: gtk::Orientation::Vertical,
                set_spacing: 5,
                set_margin_all: 5,
                
                // 增加按钮
                gtk::Button {
                    set_label: "+",
                    connect_clicked => CounterMsg::Increment,
                },
                
                // 显示计数
                gtk::Label {
                    set_label: watch! { &format!("Count: {}", self.count) },
                    set_margin_all: 10,
                },
                
                // 减少按钮
                gtk::Button {
                    set_label: "-",
                    connect_clicked => CounterMsg::Decrement,
                },
                
                // 重置按钮
                gtk::Button {
                    set_label: "Reset",
                    connect_clicked => CounterMsg::Reset,
                }
            }
        }
    }

    // 消息处理
    fn update(&mut self, msg: CounterMsg, _: ComponentSender<Self>) {
        match msg {
            CounterMsg::Increment => self.count += 1,
            CounterMsg::Decrement => self.count -= 1,
            CounterMsg::Reset => self.count = 0,
        }
    }
}

// 应用入口
fn main() {
    let app = RelmApp::new("com.example.counter");
    app.run::<CounterApp>(());
}

代码说明

消息枚举：定义了三种操作消息(Increment, Decrement, Reset)
应用结构体：包含一个计数器字段count
UI定义：
- 使用view!宏声明式定义界面
- 包含三个按钮和一个显示计数的标签
- watch!宏使标签能够自动响应数据变化
消息处理：实现update方法处理各种消息
应用启动：在main函数中创建并运行应用

这个示例展示了Relm4的核心特性：

声明式UI构建
消息传递机制
响应式数据绑定
组件化开发

您可以通过扩展这个基础示例，添加更多功能和组件来构建更复杂的应用程序。

Rust GUI框架Relm4宏库relm4-macros的使用：简化GTK4应用开发的声明式宏工具