<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `browser_window` crate."><meta name="keywords" content="rust, rustlang, rust-lang, browser_window"><title>browser_window - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../browser_window/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate browser_window</p><div class='block version'><p>Version 0.5.2</p></div><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all browser_window's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'browser_window', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/browser_window/lib.rs.html#1-41' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>browser_window</a></span></h1><div class='docblock'><p>Browser Window is a Rust crate that allows you to utilize a browser engine to build graphical interfaces.
The idea is similar to Electron.</p>
<h1 id="warning" class="section-header"><a href="#warning">Warning</a></h1>
<p><em>Browser Window</em> is still in alpha stage of development.
The API is bound to have breaking changes every minor version increment.
Once version 1.0.0 is released, minor version increments will be backwards-compatible.</p>
<h1 id="warning-1" class="section-header"><a href="#warning-1">Warning</a></h1>
<p>At the moment only Windows is suppored, but Linux support is on the way.</p>
<p>Moreover, the only supported browser engine right now is Chromium's Blink.
Therefore, the Chromium Embedding Framework (CEF) is used as a dependency.
To get CEF set up properly, enable feature <code>cef</code>, and take a look <a href="https://github.com/bamilab/browser-window/tree/master/docs/getting-started">here</a>.</p>
<h1 id="getting-started" class="section-header"><a href="#getting-started">Getting Started</a></h1>
<p>To start building apps with Browser Window, take a quick look at the <a href="application/index.html"><code>application</code></a> module.</p>
<p>For a rich example, see <a href="https://github.com/bamilab/browser-window/blob/master/example/">this example code</a>.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="application/index.html" title='browser_window::application mod'>application</a></td><td class='docblock-short'><p>This module contains runtime and application related handles.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="browser/index.html" title='browser_window::browser mod'>browser</a></td><td class='docblock-short'><p>This module contains all browser related handles and stuff.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="event/index.html" title='browser_window::event mod'>event</a></td><td class='docblock-short'><p>This module contains all event related types.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="prelude/index.html" title='browser_window::prelude mod'>prelude</a></td><td class='docblock-short'><p>Some common traits that need to be often available.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="window/index.html" title='browser_window::window mod'>window</a></td><td class='docblock-short'><p>This module contains all window related functionality.</p>
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.DelegateFuture.html" title='browser_window::DelegateFuture struct'>DelegateFuture</a></td><td class='docblock-short'><p>This future executes a closure on the GUI thread and returns the result.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DelegateFutureFuture.html" title='browser_window::DelegateFutureFuture struct'>DelegateFutureFuture</a></td><td class='docblock-short'><p>This future runs a future on the GUI thread and returns its output.</p>
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.DelegateError.html" title='browser_window::DelegateError enum'>DelegateError</a></td><td class='docblock-short'><p>The error that occurs when you're delegating work to the GUI thread, but it fails to finish and/or return a result.</p>
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.Property.html" title='browser_window::Property trait'>Property</a></td><td class='docblock-short'><p>A property is something that has a setter and a getter.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "browser_window";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>