50 lines
No EOL
8.2 KiB
HTML
50 lines
No EOL
8.2 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="`MenuAction` is a trait that represents an action in a menu."><title>MenuAction in cosmic::widget::menu::action - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../../../static.files/storage-68b7e25d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Menu<wbr>Action</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Message" title="Message">Message</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.message" title="message">message</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cosmic::<wbr>widget::<wbr>menu::<wbr>action</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">cosmic</a>::<wbr><a href="../../index.html">widget</a>::<wbr><a href="../index.html">menu</a>::<wbr><a href="index.html">action</a></div><h1>Trait <span class="trait">MenuAction</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../../src/cosmic/widget/menu/action.rs.html#41-51">Source</a> </span></div><pre class="rust item-decl"><code>pub trait MenuAction:
|
|
<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> {
|
|
type <a href="#associatedtype.Message" class="associatedtype">Message</a>;
|
|
|
|
// Required method
|
|
fn <a href="#tymethod.message" class="fn">message</a>(&self) -> Self::<a class="associatedtype" href="trait.MenuAction.html#associatedtype.Message" title="type cosmic::widget::menu::action::MenuAction::Message">Message</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>MenuAction</code> is a trait that represents an action in a menu.</p>
|
|
<p>It is used to define the behavior of menu items when they are activated.
|
|
Each menu item can have a unique action associated with it.</p>
|
|
<p>This trait is generic over a type <code>Message</code> which is the type of message
|
|
that will be produced when the action is triggered.</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>cosmic::widget::menu::action::MenuAction;
|
|
<span class="kw">use </span>cosmic::widget::segmented_button::Entity;
|
|
|
|
<span class="attr">#[derive(Clone, Copy, Eq, PartialEq)]
|
|
</span><span class="kw">enum </span>MyMessage {
|
|
Open,
|
|
Save,
|
|
Quit,
|
|
}
|
|
|
|
<span class="attr">#[derive(Clone, Copy, Eq, PartialEq)]
|
|
</span><span class="kw">enum </span>MyAction {
|
|
Open,
|
|
Save,
|
|
Quit,
|
|
}
|
|
|
|
<span class="kw">impl </span>MenuAction <span class="kw">for </span>MyAction {
|
|
<span class="kw">type </span>Message = MyMessage;
|
|
|
|
<span class="kw">fn </span>message(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self</span>::Message {
|
|
<span class="kw">match </span><span class="self">self </span>{
|
|
MyAction::Open => MyMessage::Open,
|
|
MyAction::Save => MyMessage::Save,
|
|
MyAction::Quit => MyMessage::Quit,
|
|
}
|
|
}
|
|
}</code></pre></div>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Message" class="method"><a class="src rightside" href="../../../../src/cosmic/widget/menu/action.rs.html#43">Source</a><h4 class="code-header">type <a href="#associatedtype.Message" class="associatedtype">Message</a></h4></section></summary><div class="docblock"><p>The type of message that will be produced when the action is triggered.</p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.message" class="method"><a class="src rightside" href="../../../../src/cosmic/widget/menu/action.rs.html#50">Source</a><h4 class="code-header">fn <a href="#tymethod.message" class="fn">message</a>(&self) -> Self::<a class="associatedtype" href="trait.MenuAction.html#associatedtype.Message" title="type cosmic::widget::menu::action::MenuAction::Message">Message</a></h4></section></summary><div class="docblock"><p>Returns a message of type <code>Self::Message</code> when the action is triggered.</p>
|
|
<h5 id="returns"><a class="doc-anchor" href="#returns">§</a>Returns</h5>
|
|
<ul>
|
|
<li><code>Self::Message</code> - The message that is produced when the action is triggered.</li>
|
|
</ul>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../../trait.impl/cosmic/widget/menu/action/trait.MenuAction.js" async></script></section></div></main></body></html> |