Skip to content

Commit

Permalink
deploy: 95ba90b
Browse files Browse the repository at this point in the history
  • Loading branch information
@glopesdev
glopesdev committed Apr 11, 2024
0 parents commit 34f51c6
Show file tree
Hide file tree
Showing 230 changed files with 32,138 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
271 changes: 271 additions & 0 deletions api/Bonsai.Gui.ButtonBuilder.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,271 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ButtonBuilder | Bonsai.Gui </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ButtonBuilder | Bonsai.Gui ">

<meta name="description" content="Represents an operator that interfaces with a button control and generates a sequence of notifications whenever the button is clicked.">
<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">

<meta name="docfx:rel" content="../">


<meta name="docfx:docurl" content="https://github.com/bonsai-rx/gui/new/main/docs/apidoc/new?filename=Bonsai_Gui_ButtonBuilder.md&amp;value=---%0Auid%3A%20Bonsai.Gui.ButtonBuilder%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">

<script type="module" src="./../public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>

</head>

<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="Bonsai - GUI">
Bonsai - GUI
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="Bonsai.Gui.ButtonBuilder">



<h1 id="Bonsai_Gui_ButtonBuilder" data-uid="Bonsai.Gui.ButtonBuilder" class="text-break">
Class ButtonBuilder <a class="header-action link-secondary" title="View source" href="https://github.com/bonsai-rx/gui/blob/main/src/Bonsai.Gui/ButtonBuilder.cs/#L11"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Bonsai.html">Bonsai</a>.<a class="xref" href="Bonsai.Gui.html">Gui</a></dd></dl>
<dl><dt>Assembly</dt><dd>Bonsai.Gui.dll</dd></dl>
</div>

<div class="markdown summary"><p>Represents an operator that interfaces with a button control and generates
a sequence of notifications whenever the button is clicked.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[TypeVisualizer(typeof(ButtonVisualizer))]
public class ButtonBuilder : ButtonBuilderBase&lt;string&gt;, IExpressionBuilder, INamedElement</code></pre>
</div>




<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><a class="xref" href="api/Bonsai.Expressions.ExpressionBuilder.html">ExpressionBuilder</a></div>
<div><a class="xref" href="api/Bonsai.Expressions.ZeroArgumentExpressionBuilder.html">ZeroArgumentExpressionBuilder</a></div>
<div><a class="xref" href="Bonsai.Gui.ControlBuilderBase.html">ControlBuilderBase</a></div>
<div><a class="xref" href="Bonsai.Gui.TextControlBuilderBase.html">TextControlBuilderBase</a></div>
<div><a class="xref" href="Bonsai.Gui.TextControlBuilderBase-1.html">TextControlBuilderBase</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</div>
<div><a class="xref" href="Bonsai.Gui.ButtonBuilderBase-1.html">ButtonBuilderBase</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</div>
<div><span class="xref">ButtonBuilder</span></div>
</dd>
</dl>

<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="api/Bonsai.Expressions.IExpressionBuilder.html">IExpressionBuilder</a></div>
<div><a class="xref" href="api/Bonsai.INamedElement.html">INamedElement</a></div>
</dd>
</dl>


<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="Bonsai.Gui.TextControlBuilderBase-1.html#Bonsai_Gui_TextControlBuilderBase_1_Build_System_Collections_Generic_IEnumerable_System_Linq_Expressions_Expression__">TextControlBuilderBase&lt;string&gt;.Build(IEnumerable&lt;Expression&gt;)</a>
</div>
<div>
<a class="xref" href="Bonsai.Gui.TextControlBuilderBase.html#Bonsai_Gui_TextControlBuilderBase_Text">TextControlBuilderBase.Text</a>
</div>
<div>
<a class="xref" href="Bonsai.Gui.ControlBuilderBase.html#Bonsai_Gui_ControlBuilderBase_Name">ControlBuilderBase.Name</a>
</div>
<div>
<a class="xref" href="Bonsai.Gui.ControlBuilderBase.html#Bonsai_Gui_ControlBuilderBase_Enabled">ControlBuilderBase.Enabled</a>
</div>
<div>
<a class="xref" href="Bonsai.Gui.ControlBuilderBase.html#Bonsai_Gui_ControlBuilderBase_Visible">ControlBuilderBase.Visible</a>
</div>
<div>
<a class="xref" href="Bonsai.Gui.ControlBuilderBase.html#Bonsai_Gui_ControlBuilderBase_Font">ControlBuilderBase.Font</a>
</div>
<div>
<a class="xref" href="api/Bonsai.Expressions.ZeroArgumentExpressionBuilder.html#Bonsai_Expressions_ZeroArgumentExpressionBuilder_ArgumentRange">ZeroArgumentExpressionBuilder.ArgumentRange</a>
</div>
<div>
<a class="xref" href="api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_ToString">ExpressionBuilder.ToString()</a>
</div>
<div>
<a class="xref" href="api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_Unwrap_Bonsai_Expressions_ExpressionBuilder_">ExpressionBuilder.Unwrap(ExpressionBuilder)</a>
</div>
<div>
<a class="xref" href="api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_GetWorkflowElement_Bonsai_Expressions_ExpressionBuilder_">ExpressionBuilder.GetWorkflowElement(ExpressionBuilder)</a>
</div>
<div>
<a class="xref" href="api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_GetVisualizerElement_Bonsai_Expressions_ExpressionBuilder_">ExpressionBuilder.GetVisualizerElement(ExpressionBuilder)</a>
</div>
<div>
<a class="xref" href="api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_GetVisualizerMappings_Bonsai_Expressions_ExpressionBuilder_">ExpressionBuilder.GetVisualizerMappings(ExpressionBuilder)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">ExpressionBuilder.FromWorkflowElement(object, ElementCategory)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">ExpressionBuilder.GetElementDisplayName(Type)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">ExpressionBuilder.GetElementDisplayName(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
</dd></dl>






<h2 class="section" id="methods">Methods
</h2>


<a id="Bonsai_Gui_ButtonBuilder_Generate_" data-uid="Bonsai.Gui.ButtonBuilder.Generate*"></a>

<h3 id="Bonsai_Gui_ButtonBuilder_Generate" data-uid="Bonsai.Gui.ButtonBuilder.Generate">
Generate()
<a class="header-action link-secondary" title="View source" href="https://github.com/bonsai-rx/gui/blob/main/src/Bonsai.Gui/ButtonBuilder.cs/#L18"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Generates an observable sequence of event notifications from the UI control.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected override IObservable&lt;string&gt; Generate()</code></pre>
</div>


<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>An observable sequence of events of type <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>.</p>
</dd>
</dl>












</article>

<div class="contribution d-print-none">
<a href="https://github.com/bonsai-rx/gui/blob/main/src/Bonsai.Gui/ButtonBuilder.cs/#L11" class="edit-link">Edit this page</a>
</div>


</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>

<div class="container-xxl search-results" id="search-results"></div>

<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
&copy; 2024 Bonsai Foundation CIC and Contributors. Made with <a href="https://dotnet.github.io/docfx">docfx</a>
</div>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit 34f51c6

Please sign in to comment.