1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//! _BrowserWindow_ is a Rust crate that allows you to utilize a browser engine
//! to build graphical interfaces, similar to Electron.js.
//! You create your user interface with HTML, CSS and JavaScript.
//! Then, you can communicate information to JavaScript and back to Rust.
//!
//! Pick the underlying browser framework by setting feature `cef`, `webkitgtk`
//! or `edge2`. For more info on which on you should choose and how to set them
//! up, check [this guide](https://github.com/bamidev/browser-window/tree/master/docs/GETTING-STARTED.md).

//! # Getting Started
//! To start building apps with Browser Window, take a look at the
//! [`application`](application/index.html) module, or this quick example:
//! ```no_run
//! use browser_window::{application::*, browser::*, prelude::*};
//! 
//! fn main() {
//! 	let app = Application::initialize(&ApplicationSettings::default()).unwrap();
//! 	let runtime = app.start();
//! 	runtime.run_async(|app| async move {
//! 		let mut bwb = BrowserWindowBuilder::new(Source::File("file:///my-file.html".into()));
//! 		bwb.dev_tools(true);
//! 		bwb.size(800, 600);
//! 		bwb.title("Example");
//! 		let bw = bwb.build_async(&app).await;
//!         bw.on_message().register_async(|h, e| async move {
//!             match e.cmd.as_str() {
//!                 "command_one" => {
//!                     h.eval_js(&format!(
//!                         "js_function({}, {}, {})",
//!                         1,
//!                         "'two'",
//!                         JsValue::String("𝟛\n".into()) // Gets properly formatted to a JS string
//!                                                       // literal
//!                     ));
//!                 }
//!                 "command_two" => {
//!                     // ... do something else here ...
//!                 }
//!                 _ => {}
//!             }
//!         });
//! 
//!         bw.show();
//! 	});
//! 	app.finish();
//! }
//! ```
//!
//! For more detailed example code, see [this example code](https://github.com/bamidev/browser-window/tree/master/examples).
//!
//! # Thread safety
//! To use the threadsafe version of _BrowserWindow_, enable feature
//! `threadsafe`. This will use [`Arc`](https://doc.rust-lang.org/std/sync/struct.Arc.html)
//! instead of [`Rc`](https://doc.rust-lang.org/std/rc/struct.Rc.html)
//! internally, and will enable the
//! [`BrowserWindowThreaded`](browser/struct.BrowserWindow.html) and
//! [`ApplicationHandleThreaded`](browser/struct.BrowserWindowThreaded.html)
//! handles. It will also require closures to be `Send`. Docs.rs will show the
//! threadsafe versions of everything. If you need to know how everything is
//! compiled in the non-threadsafe version, you need to invoke `cargo doc
//! --open` in the git repo yourself.
//!
//! # Events
//! To learn how to use events, take a quick look at the
//! [`event`](event/index.html) module.

mod core;
#[cfg(test)]
mod tests;

pub mod application;
pub mod browser;
pub mod cookie;
pub mod error;
pub mod event;
pub mod javascript;
pub mod prelude;
pub(crate) mod rc;
pub mod window;

#[cfg(feature = "threadsafe")]
mod delegate;
#[cfg(feature = "threadsafe")]
pub use delegate::{DelegateError, DelegateFuture, DelegateFutureFuture};

mod common;
pub use common::*;