# Native Windows GUI
Welcome to Native Windows GUI (aka NWG). A rust library to develop native GUI applications on the desktop for Microsoft Windows.
NWG is a very light wrapper over WINAPI. It allows you, the developer, to handle
the quirks and rough edges of the API by providing a simple, safe and rust-like interface.
Native Windows GUI keeps things simple. This means small compile times, minimal resource usage,
less time searching the documentation and more time for you to develop your application.
Of course, you don't have to take my word for it, check out the [showcase](../showcase) and the
[examples](examples).
This is the 3rd and final version of NWG. It is considered "mature" or, as I would say
"the backlog is empty, and it will most likely stay that way". This version implements pretty much
everything required to develop applications on Windows. Don't bother using the older versions as they
have "irreconcilable design decisions" and cannot support some key features. Future development will be done
in other libraries.
If you've managed to read through this introduction, you should know that my twitter handle
is [#gdube_dev](https://twitter.com/gdube_dev) and you can support this project with [*GitHub Sponsors*](https://github.com/sponsors/gabdube).
Any support is greatly appreciated.
## Installation
To use NWG in your project add it to cargo.toml:
```toml
[dependencies]
native-windows-gui = "1.0.12"
native-windows-derive = "1.0.3" # Optional. Only if the derive macro is used.
```
And then, in main.rs or lib.rs :
```rust
extern crate native_windows_gui as nwg;
extern crate native_windows_derive as nwd; // Optional. Only if the derive macro is used.
```
### Rust 2018 aliasing
You can skip the `extern crate` define in your source code by adding the following code in `Cargo.toml`
Note that procedural macros still require an `extern crate` definition, so this wont work with `native-windows-derive`
```toml
[dependencies]
nwg = {version = "^1.0.12", package = "native-windows-gui"}
```
## Trying it out
See it for yourself. NWG has plenty of examples and a fully interactive test suite. The only thing you need to do is:
```bash
git clone git@github.com:gabdube/native-windows-gui.git
cd native-windows-gui/native-windows-gui # Running the tests from the workspace screws up the features
cargo test everything --features "all" # For the test suite
cargo run --example basic
cargo run --example calculator
cargo run --example message_bank
cargo run --example image_decoder_d --features "extern-canvas"
cargo run --example partials --features "listbox frame combobox"
cargo run --example system_tray --features "tray-notification message-window menu cursor"
cargo run --example dialog_multithreading_d --features "notice"
cargo run --example image_decoder_d --features "image-decoder file-dialog"
cargo run --example month_name_d --features "winnls textbox"
cargo run --example splash_screen_d --features "image-decoder"
cargo run --example drop_files_d --features "textbox"
cd examples/opengl_canvas
cargo run
# The closest thing to a real application in the examples
cd ../examples/sync-draw
cargo run
# Requires the console to be run as Admin because of the embed resource
cd ../examples/embed_resources
cargo run
```
### Cross-compiling from Ubuntu
Requirement: MinGW compiler
sudo apt install gcc-mingw-w64-x86-64
Requirement: Rust support
rustup target add x86_64-pc-windows-gnu
Compiling and running basic example:
cargo build --release --target=x86_64-pc-windows-gnu
cargo build --release --target=x86_64-pc-windows-gnu --example basic
wine target/x86_64-pc-windows-gnu/release/examples/basic.exe
## Supported features
- The WHOLE winapi control library [(reference)](https://docs.microsoft.com/en-us/windows/win32/controls/individual-control-info)
- Some very niche controls are not supported: flat scroll bar, ip control, rebar, and pager.
- Menus and menu bar
- Image and font resource
- BMP
- ICO
- CUR
- PNG*
- GIF*
- JPG*
- TIFF*
- DDS*
- *: Extended image formats with the Windows Imaging Component (WIC).
- Localization support
- Uses Windows National Language Support internally [(reference)](https://docs.microsoft.com/en-us/windows/win32/intl/national-language-support)
- Tooltip
- System tray notification
- Cursor handling
- A full clipboard wrapper
- Partial templates support
- Split large application into chunks
- Dynamic controls support
- Add/Remove controls at runtime
- Bind or unbind new events at runtime
- Multithreaded application support
- Communicate to the GUI thread from another thread
- Run multiple windows on different threads
- Simple layout configurations
- FlexboxLayout
- GridLayout
- Drag and drop
- Drop files from the desktop to a window
- The most common dialog boxes
- File dialog (save, open, open folder)
- Font dialog
- Color dialog
- A canvas that can be used by external rendering APIs
- High-DPI aware
- Support for accessibility functions
- Tab navigation
- Support for low level system message capture (HWND, MSG, WPARAM, LPARAM)
- Cross compiling and testing from Linux to Windows with Wine and mingw.
- Not all features are supported (but the majority are, thanks WINE!)
- See `https://zork.net/~st/jottings/rust-windows-and-debian.html` for the steps to follow
## Performance
This was measured on a `Intel(R) Core(TM) i7-3770 CPU @ 3.40GHz, 3401 Mhz, 4 Core(s), 8 Logical Processor(s)`
In release mode, the `basic` example weighs **163kb** on disk and takes **900kb** in memory. Launch time is instantaneous.
The interactive test suite (with every feature and 100s of tests) weighs **931 kb** on disk and takes **8MB** in memory. Launch time is still instantaneous.
Initial build time takes around **22 seconds** for a basic application. This is mainly due to `winapi-rs` initial compile time. Subsequent compile time takes around **0.7 seconds**.
## Development
The development of this library is considered "done". By that, I mean that
there won't be any change to the API. Issues can be raised if a bug is found or
if some area in the documentation is unclear. If I overlooked a very important feature,
it will most likely be added.
## License
NWG uses the MIT license
## Code example
### With native windows derive
```rust
#![windows_subsystem = "windows"]
/*!
A very simple application that shows your name in a message box.
Unlike `basic_d`, this example uses layout to position the controls in the window
*/
extern crate native_windows_gui as nwg;
extern crate native_windows_derive as nwd;
use nwd::NwgUi;
use nwg::NativeUi;
#[derive(Default, NwgUi)]
pub struct BasicApp {
#[nwg_control(size: (300, 115), position: (300, 300), title: "Basic example", flags: "WINDOW|VISIBLE")]
#[nwg_events( OnWindowClose: [BasicApp::say_goodbye] )]
window: nwg::Window,
#[nwg_layout(parent: window, spacing: 1)]
grid: nwg::GridLayout,
#[nwg_control(text: "Heisenberg", focus: true)]
#[nwg_layout_item(layout: grid, row: 0, col: 0)]
name_edit: nwg::TextInput,
#[nwg_control(text: "Say my name")]
#[nwg_layout_item(layout: grid, col: 0, row: 1, row_span: 2)]
#[nwg_events( OnButtonClick: [BasicApp::say_hello] )]
hello_button: nwg::Button
}
impl BasicApp {
fn say_hello(&self) {
nwg::modal_info_message(&self.window, "Hello", &format!("Hello {}", self.name_edit.text()));
}
fn say_goodbye(&self) {
nwg::modal_info_message(&self.window, "Goodbye", &format!("Goodbye {}", self.name_edit.text()));
nwg::stop_thread_dispatch();
}
}
fn main() {
nwg::init().expect("Failed to init Native Windows GUI");
nwg::Font::set_global_family("Segoe UI").expect("Failed to
hyzixue
- 粉丝: 42
- 资源: 167
最新资源
- 基于springboot-vue的毕业论文管理系统-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.rar
- 基于SpringBoot+Vue疫情物资捐赠和分配系统--论文pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 基于Springboot宠物商城网站系统--论文pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 社区养老服务系统-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.rar
- 基于springboot搭建的疫情管理系统-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 基于springboot的毕业设计系统的开发-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.rar
- 社区物资交易互助平台pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 基于springboot的城市垃圾分类管理系统--论文pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 基于springboot的车辆违章信息管理系统pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 社区疫情返乡管控系统--论文pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 社区疫情防控平台-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 基于SpringBoot的宠物爱心组织管理系统--论文pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 社团服务系统的设计与实现-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 基于SpringBoot的动物领养平台设计与开发代码pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.rar
- 基于springboot的宠物健康顾问系统pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
- 社区疫情管理系统pf-springboot毕业项目,适合计算机毕-设、实训项目、大作业学习.zip
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈