mirror of
https://github.com/encounter/rust-sdl2.git
synced 2026-07-10 21:18:41 -07:00
7 lines
5.7 KiB
HTML
7 lines
5.7 KiB
HTML
<!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 `show_message_box` fn in crate `sdl2`."><meta name="keywords" content="rust, rustlang, rust-lang, show_message_box"><title>sdl2::messagebox::show_message_box - 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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[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='../../sdl2/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../index.html'>sdl2</a>::<wbr><a href='index.html'>messagebox</a></p><script>window.sidebarCurrent = {name: 'show_message_box', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></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><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/sdl2/messagebox.rs.html#183-249' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../index.html'>sdl2</a>::<wbr><a href='index.html'>messagebox</a>::<wbr><a class="fn" href=''>show_message_box</a></span></h1><pre class='rust fn'>pub fn show_message_box<'a, 'b, W, M>(<br> flags: <a class="struct" href="../../sdl2/messagebox/struct.MessageBoxFlag.html" title="struct sdl2::messagebox::MessageBoxFlag">MessageBoxFlag</a>, <br> buttons: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="struct" href="../../sdl2/messagebox/struct.ButtonData.html" title="struct sdl2::messagebox::ButtonData">ButtonData</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> title: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> window: W, <br> scheme: M<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../sdl2/messagebox/enum.ClickedButton.html" title="enum sdl2::messagebox::ClickedButton">ClickedButton</a><'a>, <a class="enum" href="../../sdl2/messagebox/enum.ShowMessageError.html" title="enum sdl2::messagebox::ShowMessageError">ShowMessageError</a>> <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'b <a class="struct" href="../../sdl2/video/struct.Window.html" title="struct sdl2::video::Window">Window</a>>>,<br> M: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../sdl2/messagebox/struct.MessageBoxColorScheme.html" title="struct sdl2::messagebox::MessageBoxColorScheme">MessageBoxColorScheme</a>>>, </span></pre><div class='docblock'><p>Show a customizable message box.</p>
|
||
<p>An array of buttons is required for it to work. The array can be empty,
|
||
but it will have no button beside the close button.</p>
|
||
<p>On success, it will return either the button clicked or the close button.
|
||
Note that the variant of the <code>ClickedButton</code> enum will also be returned if the message box
|
||
has been forcefully closed (Alt-F4, ...)</p>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "sdl2";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |