RedWizardsLab/EchoHub
1
0
Fork 0
mirror of https://github.com/RedWizardsLab/EchoHub.git synced 2026-09-04 08:36:11 +02:00
Code Issues 2 Packages Projects Releases 10 Wiki Activity

deploy: 17e64293b5

Browse Source
This commit is contained in:
HueByte
2026-02-22 04:57:18 +00:00
parent fca77ea92f
commit 03bcf194d6
63 changed files with 8871 additions and 743 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/client/EchoHub.Client.AppOrchestrator.html
+1 -1
View File
@@ -173,7 +173,7 @@ Owns session state and wires UI events to service calls.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <span class="xref">IApplication</span></dt>
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>config</code> <a class="xref" href="EchoHub.Client.Config.ClientConfig.html">ClientConfig</a></dt>
<dd></dd>
api/client/EchoHub.Client.AsyncRunner.html
+1 -1
View File
@@ -170,7 +170,7 @@ Runs async work on a background thread and routes exceptions to the UI.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <span class="xref">IApplication</span></dt>
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>work</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a>&lt;<span class="xref">Task</span>&gt;</dt>
<dd></dd>
api/client/EchoHub.Client.Config.SavedServer.html
+35 -4
View File
@@ -244,10 +244,10 @@ Class SavedServer <a class="header-action link-secondary" title="View source" h
<a id="EchoHub_Client_Config_SavedServer_Token_" data-uid="EchoHub.Client.Config.SavedServer.Token*"></a>
<a id="EchoHub_Client_Config_SavedServer_RefreshToken_" data-uid="EchoHub.Client.Config.SavedServer.RefreshToken*"></a>
<h3 id="EchoHub_Client_Config_SavedServer_Token" data-uid="EchoHub.Client.Config.SavedServer.Token">
Token
<h3 id="EchoHub_Client_Config_SavedServer_RefreshToken" data-uid="EchoHub.Client.Config.SavedServer.RefreshToken">
RefreshToken
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Config/ClientConfig.cs"><i class="bi bi-code-slash"></i></a>
</h3>
@@ -255,7 +255,7 @@ Class SavedServer <a class="header-action link-secondary" title="View source" h
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? Token { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public string? RefreshToken { get; set; }</code></pre>
</div>
@@ -275,6 +275,37 @@ Class SavedServer <a class="header-action link-secondary" title="View source" h
<a id="EchoHub_Client_Config_SavedServer_RememberMe_" data-uid="EchoHub.Client.Config.SavedServer.RememberMe*"></a>
<h3 id="EchoHub_Client_Config_SavedServer_RememberMe" data-uid="EchoHub.Client.Config.SavedServer.RememberMe">
RememberMe
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Config/ClientConfig.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool RememberMe { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_Config_SavedServer_Url_" data-uid="EchoHub.Client.Config.SavedServer.Url*"></a>
<h3 id="EchoHub_Client_Config_SavedServer_Url" data-uid="EchoHub.Client.Config.SavedServer.Url">
api/client/EchoHub.Client.Services.ApiClient.html
+108
View File
@@ -501,6 +501,44 @@ Class ApiClient <a class="header-action link-secondary" title="View source" hre
<a id="EchoHub_Client_Services_ApiClient_DownloadFileToTempAsync_" data-uid="EchoHub.Client.Services.ApiClient.DownloadFileToTempAsync*"></a>
<h3 id="EchoHub_Client_Services_ApiClient_DownloadFileToTempAsync_System_String_System_String_" data-uid="EchoHub.Client.Services.ApiClient.DownloadFileToTempAsync(System.String,System.String)">
DownloadFileToTempAsync(string, string)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/ApiClient.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;string&gt; DownloadFileToTempAsync(string relativeUrl, string fileName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relativeUrl</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>fileName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_Services_ApiClient_GetChannelsAsync_" data-uid="EchoHub.Client.Services.ApiClient.GetChannelsAsync*"></a>
<h3 id="EchoHub_Client_Services_ApiClient_GetChannelsAsync" data-uid="EchoHub.Client.Services.ApiClient.GetChannelsAsync">
@@ -739,6 +777,42 @@ Used by EchoHubConnection for SignalR token provider.</p>
<a id="EchoHub_Client_Services_ApiClient_LoginWithRefreshTokenAsync_" data-uid="EchoHub.Client.Services.ApiClient.LoginWithRefreshTokenAsync*"></a>
<h3 id="EchoHub_Client_Services_ApiClient_LoginWithRefreshTokenAsync_System_String_" data-uid="EchoHub.Client.Services.ApiClient.LoginWithRefreshTokenAsync(System.String)">
LoginWithRefreshTokenAsync(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/ApiClient.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;LoginResponse&gt; LoginWithRefreshTokenAsync(string refreshToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>refreshToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span>&lt;<a class="xref" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AuthDtos.cs">LoginResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_Services_ApiClient_LogoutAsync_" data-uid="EchoHub.Client.Services.ApiClient.LogoutAsync*"></a>
<h3 id="EchoHub_Client_Services_ApiClient_LogoutAsync" data-uid="EchoHub.Client.Services.ApiClient.LogoutAsync">
@@ -1183,6 +1257,40 @@ Used by EchoHubConnection for SignalR token provider.</p>
<h2 class="section" id="events">Events
</h2>
<h3 id="EchoHub_Client_Services_ApiClient_OnTokensRefreshed" data-uid="EchoHub.Client.Services.ApiClient.OnTokensRefreshed">
OnTokensRefreshed
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/ApiClient.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action? OnTokensRefreshed</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a></dt>
<dd></dd>
</dl>
</article>
api/client/EchoHub.Client.Services.AudioPlaybackService.html
+475
View File
@@ -0,0 +1,475 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class AudioPlaybackService | EchoHub Documentation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AudioPlaybackService | EchoHub Documentation ">
<link rel="icon" href="../../images/hue_icon.svg">
<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/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Client_Services_AudioPlaybackService.md&amp;value=---%0Auid%3A%20EchoHub.Client.Services.AudioPlaybackService%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="../../images/hue_icon.svg" alt="EchoHub">
EchoHub
</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" 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="EchoHub.Client.Services.AudioPlaybackService">
<h1 id="EchoHub_Client_Services_AudioPlaybackService" data-uid="EchoHub.Client.Services.AudioPlaybackService" class="text-break">
Class AudioPlaybackService <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Client.html">Client</a>.<a class="xref" href="EchoHub.Client.Services.html">Services</a></dd></dl>
<dl><dt>Assembly</dt><dd>EchoHub.Client.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class AudioPlaybackService</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><span class="xref">AudioPlaybackService</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</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>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="EchoHub_Client_Services_AudioPlaybackService__ctor_" data-uid="EchoHub.Client.Services.AudioPlaybackService.#ctor*"></a>
<h3 id="EchoHub_Client_Services_AudioPlaybackService__ctor" data-uid="EchoHub.Client.Services.AudioPlaybackService.#ctor">
AudioPlaybackService()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AudioPlaybackService()</code></pre>
</div>
<h2 class="section" id="properties">Properties
</h2>
<a id="EchoHub_Client_Services_AudioPlaybackService_IsPaused_" data-uid="EchoHub.Client.Services.AudioPlaybackService.IsPaused*"></a>
<h3 id="EchoHub_Client_Services_AudioPlaybackService_IsPaused" data-uid="EchoHub.Client.Services.AudioPlaybackService.IsPaused">
IsPaused
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsPaused { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_Services_AudioPlaybackService_IsPlaying_" data-uid="EchoHub.Client.Services.AudioPlaybackService.IsPlaying*"></a>
<h3 id="EchoHub_Client_Services_AudioPlaybackService_IsPlaying" data-uid="EchoHub.Client.Services.AudioPlaybackService.IsPlaying">
IsPlaying
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsPlaying { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="EchoHub_Client_Services_AudioPlaybackService_PauseAsync_" data-uid="EchoHub.Client.Services.AudioPlaybackService.PauseAsync*"></a>
<h3 id="EchoHub_Client_Services_AudioPlaybackService_PauseAsync" data-uid="EchoHub.Client.Services.AudioPlaybackService.PauseAsync">
PauseAsync()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task PauseAsync()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_Services_AudioPlaybackService_PlayAsync_" data-uid="EchoHub.Client.Services.AudioPlaybackService.PlayAsync*"></a>
<h3 id="EchoHub_Client_Services_AudioPlaybackService_PlayAsync_System_String_" data-uid="EchoHub.Client.Services.AudioPlaybackService.PlayAsync(System.String)">
PlayAsync(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task PlayAsync(string filePath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>filePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_Services_AudioPlaybackService_ResumeAsync_" data-uid="EchoHub.Client.Services.AudioPlaybackService.ResumeAsync*"></a>
<h3 id="EchoHub_Client_Services_AudioPlaybackService_ResumeAsync" data-uid="EchoHub.Client.Services.AudioPlaybackService.ResumeAsync">
ResumeAsync()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task ResumeAsync()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_Services_AudioPlaybackService_SetVolumeAsync_" data-uid="EchoHub.Client.Services.AudioPlaybackService.SetVolumeAsync*"></a>
<h3 id="EchoHub_Client_Services_AudioPlaybackService_SetVolumeAsync_System_Byte_" data-uid="EchoHub.Client.Services.AudioPlaybackService.SetVolumeAsync(System.Byte)">
SetVolumeAsync(byte)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task SetVolumeAsync(byte volume)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>volume</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_Services_AudioPlaybackService_StopAsync_" data-uid="EchoHub.Client.Services.AudioPlaybackService.StopAsync*"></a>
<h3 id="EchoHub_Client_Services_AudioPlaybackService_StopAsync" data-uid="EchoHub.Client.Services.AudioPlaybackService.StopAsync">
StopAsync()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task StopAsync()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span></dt>
<dd></dd>
</dl>
<h2 class="section" id="events">Events
</h2>
<h3 id="EchoHub_Client_Services_AudioPlaybackService_PlaybackFinished" data-uid="EchoHub.Client.Services.AudioPlaybackService.PlaybackFinished">
PlaybackFinished
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler? PlaybackFinished</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler">EventHandler</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/AudioPlaybackService.cs" 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">
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>&middot;</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>&middot;</span><a href='https://echohub.voidcube.cloud'>Website</a><span class='footer-sep'>&middot;</span><span class='footer-credit'>Built with <a href='https://dotnet.github.io/docfx'>DocFX</a></span></div></div>
</div>
</div>
</footer>
</body>
</html>
api/client/EchoHub.Client.Services.UpdateChecker.html
+108 -16
View File
@@ -101,7 +101,7 @@ Class UpdateChecker <a class="header-action link-secondary" title="View source"
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class UpdateChecker</code></pre>
<pre><code class="lang-csharp hljs">public sealed class UpdateChecker : IDisposable</code></pre>
</div>
@@ -115,6 +115,12 @@ Class UpdateChecker <a class="header-action link-secondary" title="View source"
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
@@ -123,9 +129,6 @@ Class UpdateChecker <a class="header-action link-secondary" title="View source"
<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>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
@@ -148,32 +151,121 @@ Class UpdateChecker <a class="header-action link-secondary" title="View source"
<h2 class="section" id="constructors">Constructors
</h2>
<a id="EchoHub_Client_Services_UpdateChecker__ctor_" data-uid="EchoHub.Client.Services.UpdateChecker.#ctor*"></a>
<h3 id="EchoHub_Client_Services_UpdateChecker__ctor_Terminal_Gui_App_IApplication_" data-uid="EchoHub.Client.Services.UpdateChecker.#ctor(Terminal.Gui.App.IApplication)">
UpdateChecker(IApplication)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/UpdateChecker.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UpdateChecker(IApplication app)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="EchoHub_Client_Services_UpdateChecker_CurrentVersion_" data-uid="EchoHub.Client.Services.UpdateChecker.CurrentVersion*"></a>
<h3 id="EchoHub_Client_Services_UpdateChecker_CurrentVersion" data-uid="EchoHub.Client.Services.UpdateChecker.CurrentVersion">
CurrentVersion
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/UpdateChecker.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string CurrentVersion { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="EchoHub_Client_Services_UpdateChecker_CheckForUpdateAsync_" data-uid="EchoHub.Client.Services.UpdateChecker.CheckForUpdateAsync*"></a>
<a id="EchoHub_Client_Services_UpdateChecker_Dispose_" data-uid="EchoHub.Client.Services.UpdateChecker.Dispose*"></a>
<h3 id="EchoHub_Client_Services_UpdateChecker_CheckForUpdateAsync" data-uid="EchoHub.Client.Services.UpdateChecker.CheckForUpdateAsync">
CheckForUpdateAsync()
<h3 id="EchoHub_Client_Services_UpdateChecker_Dispose" data-uid="EchoHub.Client.Services.UpdateChecker.Dispose">
Dispose()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/UpdateChecker.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Checks GitHub for a newer release. Returns the new version string if one exists, or null.
Never throws — all errors are silently swallowed.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Task&lt;string?&gt; CheckForUpdateAsync()</code></pre>
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</div>
<a id="EchoHub_Client_Services_UpdateChecker_Start_" data-uid="EchoHub.Client.Services.UpdateChecker.Start*"></a>
<h3 id="EchoHub_Client_Services_UpdateChecker_Start" data-uid="EchoHub.Client.Services.UpdateChecker.Start">
Start()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/UpdateChecker.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Start()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
api/client/EchoHub.Client.Services.html
+4
View File
@@ -98,6 +98,10 @@ Classes
<dt><a class="xref" href="EchoHub.Client.Services.ApiClient.html">ApiClient</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="EchoHub.Client.Services.AudioPlaybackService.html">AudioPlaybackService</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="EchoHub.Client.Services.ClientEncryptionService.html">ClientEncryptionService</a></dt>
<dd><p>Client-side encryption service. Uses the same AES-256-GCM format as the server
api/client/EchoHub.Client.UI.AudioPlayerDialog.html
+244
View File
@@ -0,0 +1,244 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class AudioPlayerDialog | EchoHub Documentation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AudioPlayerDialog | EchoHub Documentation ">
<link rel="icon" href="../../images/hue_icon.svg">
<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/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Client_UI_AudioPlayerDialog.md&amp;value=---%0Auid%3A%20EchoHub.Client.UI.AudioPlayerDialog%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="../../images/hue_icon.svg" alt="EchoHub">
EchoHub
</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" 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="EchoHub.Client.UI.AudioPlayerDialog">
<h1 id="EchoHub_Client_UI_AudioPlayerDialog" data-uid="EchoHub.Client.UI.AudioPlayerDialog" class="text-break">
Class AudioPlayerDialog <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/AudioPlayerDialog.cs"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Client.html">Client</a>.<a class="xref" href="EchoHub.Client.UI.html">UI</a></dd></dl>
<dl><dt>Assembly</dt><dd>EchoHub.Client.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class AudioPlayerDialog</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><span class="xref">AudioPlayerDialog</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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.tostring">object.ToString()</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>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="EchoHub_Client_UI_AudioPlayerDialog__ctor_" data-uid="EchoHub.Client.UI.AudioPlayerDialog.#ctor*"></a>
<h3 id="EchoHub_Client_UI_AudioPlayerDialog__ctor" data-uid="EchoHub.Client.UI.AudioPlayerDialog.#ctor">
AudioPlayerDialog()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/AudioPlayerDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AudioPlayerDialog()</code></pre>
</div>
<h2 class="section" id="methods">Methods
</h2>
<a id="EchoHub_Client_UI_AudioPlayerDialog_Show_" data-uid="EchoHub.Client.UI.AudioPlayerDialog.Show*"></a>
<h3 id="EchoHub_Client_UI_AudioPlayerDialog_Show_Terminal_Gui_App_IApplication_EchoHub_Client_Services_AudioPlaybackService_System_String_System_String_" data-uid="EchoHub.Client.UI.AudioPlayerDialog.Show(Terminal.Gui.App.IApplication,EchoHub.Client.Services.AudioPlaybackService,System.String,System.String)">
Show(IApplication, AudioPlaybackService, string, string)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/AudioPlayerDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Show(IApplication app, AudioPlaybackService audioService, string filePath, string fileName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>audioService</code> <a class="xref" href="EchoHub.Client.Services.AudioPlaybackService.html">AudioPlaybackService</a></dt>
<dd></dd>
<dt><code>filePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>fileName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/AudioPlayerDialog.cs" 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">
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>&middot;</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>&middot;</span><a href='https://echohub.voidcube.cloud'>Website</a><span class='footer-sep'>&middot;</span><span class='footer-credit'>Built with <a href='https://dotnet.github.io/docfx'>DocFX</a></span></div></div>
</div>
</div>
</footer>
</body>
</html>
api/client/EchoHub.Client.UI.ChannelListSource.html
+76 -22
View File
@@ -120,7 +120,7 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><span class="xref">IListDataSource</span></div>
<div><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">IListDataSource</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
</dd>
</dl>
@@ -198,7 +198,8 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the number of items in the data source.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -229,7 +230,8 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the width in columns of the widest item in the data source.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -249,6 +251,9 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section" id="EchoHub_Client_UI_ChannelListSource_MaxItemLength_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> uses this value to set its horizontal content size for scrolling.</p>
</div>
@@ -260,7 +265,8 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether the <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">CollectionChanged</a> event should be suppressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -280,6 +286,10 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section" id="EchoHub_Client_UI_ChannelListSource_SuspendCollectionChangedEvent_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Set to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> to prevent <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">CollectionChanged</a> from being raised during bulk
operations. Set back to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> to resume event notifications.</p>
</div>
@@ -321,7 +331,8 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Determines whether the specified item is marked.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -331,13 +342,15 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The zero-based index of the item.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is marked; otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
@@ -346,6 +359,10 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section" id="EchoHub_Client_UI_ChannelListSource_IsMarked_System_Int32__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> calls this method to determine whether to render the item with a mark indicator when
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Selection.cs">ShowMarks</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</div>
@@ -357,7 +374,8 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Renders the specified item to the <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -366,20 +384,27 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>listView</code> <span class="xref">ListView</span></dt>
<dd></dd>
<dt><code>listView</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a></dt>
<dd><p>The <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> to render to.</p>
</dd>
<dt><code>selected</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is currently selected; otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The zero-based index of the item to render.</p>
</dd>
<dt><code>col</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The column in <code class="paramref">listView</code> Viewport where rendering starts.</p>
</dd>
<dt><code>row</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The row in <code class="paramref">listView</code> Viewport where rendering starts.</p>
</dd>
<dt><code>width</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The width available for rendering.</p>
</dd>
<dt><code>viewportX</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The horizontal scroll offset.</p>
</dd>
</dl>
@@ -389,6 +414,15 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section" id="EchoHub_Client_UI_ChannelListSource_Render_Terminal_Gui_Views_ListView_System_Boolean_System_Int32_System_Int32_System_Int32_System_Int32_System_Int32__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> calls this method for each visible item during rendering. The color scheme will be
set based on selection state before this method is called.
</p>
<p>
Implementations must fill the entire <code class="paramref">width</code> to avoid rendering artifacts.
</p>
</div>
@@ -400,7 +434,8 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Sets the marked state of the specified item.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -410,9 +445,11 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The zero-based index of the item.</p>
</dd>
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> to mark the item; <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> to unmark it.</p>
</dd>
</dl>
@@ -422,6 +459,10 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section" id="EchoHub_Client_UI_ChannelListSource_SetMark_System_Int32_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> calls this method when the user toggles marking (e.g., via the SPACE key) if
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Selection.cs">ShowMarks</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</div>
@@ -433,7 +474,8 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Returns the underlying data source as an <span class="xref">System.Collections.IList</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -444,7 +486,8 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">IList</span></dt>
<dd></dd>
<dd><p>The data source as an <span class="xref">System.Collections.IList</span>.</p>
</dd>
</dl>
@@ -453,6 +496,11 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section" id="EchoHub_Client_UI_ChannelListSource_ToList_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> uses this method to access individual items for events like
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ValueChanged</a> and to enable keyboard search via
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.cs">KeystrokeNavigator</a>.</p>
</div>
@@ -502,7 +550,8 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Raised when items are added, removed, moved, or the entire collection is refreshed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -522,6 +571,11 @@ Active channel gets a &gt; indicator, unread channels are bright with a count ba
<h4 class="section" id="EchoHub_Client_UI_ChannelListSource_CollectionChanged_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> subscribes to this event to update its display and content size when the data
changes. Implementations should raise this event whenever the underlying collection changes, unless
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">SuspendCollectionChangedEvent</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</div>
api/client/EchoHub.Client.UI.ChatColors.html
+69 -9
View File
@@ -154,6 +154,36 @@ Class ChatColors <a class="header-action link-secondary" title="View source" hr
<h3 id="EchoHub_Client_UI_ChatColors_AudioAttr" data-uid="EchoHub.Client.UI.ChatColors.AudioAttr">
AudioAttr
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly Attribute AudioAttr</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
<h3 id="EchoHub_Client_UI_ChatColors_EmbedBorderAttr" data-uid="EchoHub.Client.UI.ChatColors.EmbedBorderAttr">
EmbedBorderAttr
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
@@ -171,7 +201,7 @@ Class ChatColors <a class="header-action link-secondary" title="View source" hr
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span></dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
@@ -201,7 +231,7 @@ Class ChatColors <a class="header-action link-secondary" title="View source" hr
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span></dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
@@ -231,7 +261,7 @@ Class ChatColors <a class="header-action link-secondary" title="View source" hr
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span></dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
@@ -261,7 +291,37 @@ Class ChatColors <a class="header-action link-secondary" title="View source" hr
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span></dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
<h3 id="EchoHub_Client_UI_ChatColors_FileAttr" data-uid="EchoHub.Client.UI.ChatColors.FileAttr">
FileAttr
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly Attribute FileAttr</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
@@ -291,7 +351,7 @@ Class ChatColors <a class="header-action link-secondary" title="View source" hr
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span></dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
@@ -321,7 +381,7 @@ Class ChatColors <a class="header-action link-secondary" title="View source" hr
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span></dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
@@ -351,7 +411,7 @@ Class ChatColors <a class="header-action link-secondary" title="View source" hr
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span></dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
@@ -381,7 +441,7 @@ Class ChatColors <a class="header-action link-secondary" title="View source" hr
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span></dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a></dt>
<dd></dd>
</dl>
@@ -417,7 +477,7 @@ Non-mention text uses the provided default color.</p>
<dl class="parameters">
<dt><code>text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>defaultColor</code> <span class="xref">Attribute</span>?</dt>
<dt><code>defaultColor</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a>?</dt>
<dd></dd>
</dl>
api/client/EchoHub.Client.UI.ChatLine.html
+94 -1
View File
@@ -216,6 +216,68 @@ Class ChatLine <a class="header-action link-secondary" title="View source" href
</h2>
<a id="EchoHub_Client_UI_ChatLine_AttachmentFileName_" data-uid="EchoHub.Client.UI.ChatLine.AttachmentFileName*"></a>
<h3 id="EchoHub_Client_UI_ChatLine_AttachmentFileName" data-uid="EchoHub.Client.UI.ChatLine.AttachmentFileName">
AttachmentFileName
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? AttachmentFileName { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_UI_ChatLine_AttachmentUrl_" data-uid="EchoHub.Client.UI.ChatLine.AttachmentUrl*"></a>
<h3 id="EchoHub_Client_UI_ChatLine_AttachmentUrl" data-uid="EchoHub.Client.UI.ChatLine.AttachmentUrl">
AttachmentUrl
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? AttachmentUrl { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_UI_ChatLine_IsMention_" data-uid="EchoHub.Client.UI.ChatLine.IsMention*"></a>
<h3 id="EchoHub_Client_UI_ChatLine_IsMention" data-uid="EchoHub.Client.UI.ChatLine.IsMention">
@@ -340,6 +402,37 @@ Class ChatLine <a class="header-action link-secondary" title="View source" href
<a id="EchoHub_Client_UI_ChatLine_Type_" data-uid="EchoHub.Client.UI.ChatLine.Type*"></a>
<h3 id="EchoHub_Client_UI_ChatLine_Type" data-uid="EchoHub.Client.UI.ChatLine.Type">
Type
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MessageType? Type { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/MessageType.cs">MessageType</a>?</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
@@ -364,7 +457,7 @@ Format: {F:RRGGBB} (foreground), {B:RRGGBB} (background), {X} (reset).</p>
<dl class="parameters">
<dt><code>text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>defaultAttr</code> <span class="xref">Attribute</span>?</dt>
<dt><code>defaultAttr</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a>?</dt>
<dd></dd>
</dl>
api/client/EchoHub.Client.UI.ChatListSource.html
+112 -22
View File
@@ -119,7 +119,7 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><span class="xref">IListDataSource</span></div>
<div><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">IListDataSource</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
</dd>
</dl>
@@ -197,7 +197,8 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the number of items in the data source.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -228,7 +229,8 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the width in columns of the widest item in the data source.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -248,6 +250,9 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_ChatListSource_MaxItemLength_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> uses this value to set its horizontal content size for scrolling.</p>
</div>
@@ -259,7 +264,8 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether the <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">CollectionChanged</a> event should be suppressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -279,6 +285,10 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_ChatListSource_SuspendCollectionChangedEvent_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Set to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> to prevent <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">CollectionChanged</a> from being raised during bulk
operations. Set back to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> to resume event notifications.</p>
</div>
@@ -401,6 +411,42 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<a id="EchoHub_Client_UI_ChatListSource_GetLine_" data-uid="EchoHub.Client.UI.ChatListSource.GetLine*"></a>
<h3 id="EchoHub_Client_UI_ChatListSource_GetLine_System_Int32_" data-uid="EchoHub.Client.UI.ChatListSource.GetLine(System.Int32)">
GetLine(int)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ChatLine? GetLine(int index)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>index</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="EchoHub.Client.UI.ChatLine.html">ChatLine</a></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_UI_ChatListSource_InsertRange_" data-uid="EchoHub.Client.UI.ChatListSource.InsertRange*"></a>
<h3 id="EchoHub_Client_UI_ChatListSource_InsertRange_System_Int32_System_Collections_Generic_IEnumerable_EchoHub_Client_UI_ChatLine__" data-uid="EchoHub.Client.UI.ChatListSource.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{EchoHub.Client.UI.ChatLine})">
@@ -441,7 +487,8 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Determines whether the specified item is marked.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -451,13 +498,15 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The zero-based index of the item.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is marked; otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
@@ -466,6 +515,10 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_ChatListSource_IsMarked_System_Int32__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> calls this method to determine whether to render the item with a mark indicator when
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Selection.cs">ShowMarks</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</div>
@@ -477,7 +530,8 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Renders the specified item to the <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -486,20 +540,27 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>listView</code> <span class="xref">ListView</span></dt>
<dd></dd>
<dt><code>listView</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a></dt>
<dd><p>The <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> to render to.</p>
</dd>
<dt><code>selected</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is currently selected; otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The zero-based index of the item to render.</p>
</dd>
<dt><code>col</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The column in <code class="paramref">listView</code> Viewport where rendering starts.</p>
</dd>
<dt><code>row</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The row in <code class="paramref">listView</code> Viewport where rendering starts.</p>
</dd>
<dt><code>width</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The width available for rendering.</p>
</dd>
<dt><code>viewportX</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The horizontal scroll offset.</p>
</dd>
</dl>
@@ -509,6 +570,15 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_ChatListSource_Render_Terminal_Gui_Views_ListView_System_Boolean_System_Int32_System_Int32_System_Int32_System_Int32_System_Int32__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> calls this method for each visible item during rendering. The color scheme will be
set based on selection state before this method is called.
</p>
<p>
Implementations must fill the entire <code class="paramref">width</code> to avoid rendering artifacts.
</p>
</div>
@@ -520,7 +590,8 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Sets the marked state of the specified item.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -530,9 +601,11 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The zero-based index of the item.</p>
</dd>
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> to mark the item; <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> to unmark it.</p>
</dd>
</dl>
@@ -542,6 +615,10 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_ChatListSource_SetMark_System_Int32_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> calls this method when the user toggles marking (e.g., via the SPACE key) if
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Selection.cs">ShowMarks</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</div>
@@ -553,7 +630,8 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Returns the underlying data source as an <span class="xref">System.Collections.IList</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -564,7 +642,8 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">IList</span></dt>
<dd></dd>
<dd><p>The data source as an <span class="xref">System.Collections.IList</span>.</p>
</dd>
</dl>
@@ -573,6 +652,11 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_ChatListSource_ToList_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> uses this method to access individual items for events like
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ValueChanged</a> and to enable keyboard search via
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.cs">KeystrokeNavigator</a>.</p>
</div>
@@ -587,7 +671,8 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Raised when items are added, removed, moved, or the entire collection is refreshed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -607,6 +692,11 @@ Class ChatListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_ChatListSource_CollectionChanged_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> subscribes to this event to update its display and content size when the data
changes. Implementations should raise this event whenever the underlying collection changes, unless
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">SuspendCollectionChangedEvent</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</div>
api/client/EchoHub.Client.UI.ChatSegment.html
+3 -3
View File
@@ -200,7 +200,7 @@ Class ChatSegment <a class="header-action link-secondary" title="View source" h
<dl class="parameters">
<dt><code>Text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>Color</code> <span class="xref">Attribute</span>?</dt>
<dt><code>Color</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a>?</dt>
<dd></dd>
</dl>
@@ -239,7 +239,7 @@ Class ChatSegment <a class="header-action link-secondary" title="View source" h
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span>?</dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a>?</dt>
<dd></dd>
</dl>
@@ -334,7 +334,7 @@ Class ChatSegment <a class="header-action link-secondary" title="View source" h
<dl class="parameters">
<dt><code>Text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>Color</code> <span class="xref">Attribute</span>?</dt>
<dt><code>Color</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a>?</dt>
<dd></dd>
</dl>
api/client/EchoHub.Client.UI.ColorHelper.html
+1 -1
View File
@@ -175,7 +175,7 @@ Class ColorHelper <a class="header-action link-secondary" title="View source" h
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Attribute</span>?</dt>
<dt><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a>?</dt>
<dd></dd>
</dl>
api/client/EchoHub.Client.UI.ConnectDialog.html
+1 -1
View File
@@ -199,7 +199,7 @@ Returns the result, or null if cancelled.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <span class="xref">IApplication</span></dt>
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>savedServers</code> <span class="xref">List</span>&lt;<a class="xref" href="EchoHub.Client.Config.SavedServer.html">SavedServer</a>&gt;</dt>
<dd></dd>
api/client/EchoHub.Client.UI.ConnectDialogResult.html
+76 -6
View File
@@ -183,8 +183,8 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
<a id="EchoHub_Client_UI_ConnectDialogResult__ctor_" data-uid="EchoHub.Client.UI.ConnectDialogResult.#ctor*"></a>
<h3 id="EchoHub_Client_UI_ConnectDialogResult__ctor_System_String_System_String_System_String_System_Boolean_" data-uid="EchoHub.Client.UI.ConnectDialogResult.#ctor(System.String,System.String,System.String,System.Boolean)">
ConnectDialogResult(string, string, string, bool)
<h3 id="EchoHub_Client_UI_ConnectDialogResult__ctor_System_String_System_String_System_String_System_Boolean_System_Boolean_System_String_" data-uid="EchoHub.Client.UI.ConnectDialogResult.#ctor(System.String,System.String,System.String,System.Boolean,System.Boolean,System.String)">
ConnectDialogResult(string, string, string, bool, bool, string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ConnectDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
@@ -193,7 +193,7 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ConnectDialogResult(string ServerUrl, string Username, string Password, bool IsRegister)</code></pre>
<pre><code class="lang-csharp hljs">public ConnectDialogResult(string ServerUrl, string Username, string Password, bool IsRegister, bool RememberMe, string? SavedRefreshToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -206,6 +206,10 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
<dd></dd>
<dt><code>IsRegister</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>RememberMe</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>SavedRefreshToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
@@ -316,6 +320,68 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
<a id="EchoHub_Client_UI_ConnectDialogResult_RememberMe_" data-uid="EchoHub.Client.UI.ConnectDialogResult.RememberMe*"></a>
<h3 id="EchoHub_Client_UI_ConnectDialogResult_RememberMe" data-uid="EchoHub.Client.UI.ConnectDialogResult.RememberMe">
RememberMe
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ConnectDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool RememberMe { get; init; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_UI_ConnectDialogResult_SavedRefreshToken_" data-uid="EchoHub.Client.UI.ConnectDialogResult.SavedRefreshToken*"></a>
<h3 id="EchoHub_Client_UI_ConnectDialogResult_SavedRefreshToken" data-uid="EchoHub.Client.UI.ConnectDialogResult.SavedRefreshToken">
SavedRefreshToken
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ConnectDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? SavedRefreshToken { get; init; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="EchoHub_Client_UI_ConnectDialogResult_ServerUrl_" data-uid="EchoHub.Client.UI.ConnectDialogResult.ServerUrl*"></a>
<h3 id="EchoHub_Client_UI_ConnectDialogResult_ServerUrl" data-uid="EchoHub.Client.UI.ConnectDialogResult.ServerUrl">
@@ -384,8 +450,8 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
<a id="EchoHub_Client_UI_ConnectDialogResult_Deconstruct_" data-uid="EchoHub.Client.UI.ConnectDialogResult.Deconstruct*"></a>
<h3 id="EchoHub_Client_UI_ConnectDialogResult_Deconstruct_System_String__System_String__System_String__System_Boolean__" data-uid="EchoHub.Client.UI.ConnectDialogResult.Deconstruct(System.String@,System.String@,System.String@,System.Boolean@)">
Deconstruct(out string, out string, out string, out bool)
<h3 id="EchoHub_Client_UI_ConnectDialogResult_Deconstruct_System_String__System_String__System_String__System_Boolean__System_Boolean__System_String__" data-uid="EchoHub.Client.UI.ConnectDialogResult.Deconstruct(System.String@,System.String@,System.String@,System.Boolean@,System.Boolean@,System.String@)">
Deconstruct(out string, out string, out string, out bool, out bool, out string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ConnectDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
@@ -393,7 +459,7 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Deconstruct(out string ServerUrl, out string Username, out string Password, out bool IsRegister)</code></pre>
<pre><code class="lang-csharp hljs">public void Deconstruct(out string ServerUrl, out string Username, out string Password, out bool IsRegister, out bool RememberMe, out string? SavedRefreshToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -406,6 +472,10 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
<dd></dd>
<dt><code>IsRegister</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>RememberMe</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>SavedRefreshToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
api/client/EchoHub.Client.UI.CreateChannelDialog.html
+1 -1
View File
@@ -195,7 +195,7 @@ Class CreateChannelDialog <a class="header-action link-secondary" title="View s
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <span class="xref">IApplication</span></dt>
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
</dl>
api/client/EchoHub.Client.UI.MainWindow.html
+331 -221
View File
File diff suppressed because it is too large Load Diff
api/client/EchoHub.Client.UI.ProfileEditDialog.html
+1 -1
View File
@@ -197,7 +197,7 @@ Class ProfileEditDialog <a class="header-action link-secondary" title="View sou
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <span class="xref">IApplication</span></dt>
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>currentDisplayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
api/client/EchoHub.Client.UI.ProfileViewDialog.html
+2 -2
View File
@@ -198,7 +198,7 @@ Shows Edit Profile / Set Status buttons when viewing own profile.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <span class="xref">IApplication</span></dt>
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>profile</code> <a class="xref" href="../core/EchoHub.Core.DTOs.UserProfileDto.html">UserProfileDto</a></dt>
<dd></dd>
@@ -233,7 +233,7 @@ Returns the action the user selected.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <span class="xref">IApplication</span></dt>
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>profile</code> <a class="xref" href="../core/EchoHub.Core.DTOs.UserProfileDto.html">UserProfileDto</a></dt>
<dd></dd>
api/client/EchoHub.Client.UI.StatusDialog.html
+1 -1
View File
@@ -197,7 +197,7 @@ Class StatusDialog <a class="header-action link-secondary" title="View source"
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <span class="xref">IApplication</span></dt>
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>currentStatus</code> <a class="xref" href="../core/EchoHub.Core.Models.UserStatus.html">UserStatus</a></dt>
<dd></dd>
api/client/EchoHub.Client.UI.UpdateConfirmDialog.html
+247
View File
@@ -0,0 +1,247 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class UpdateConfirmDialog | EchoHub Documentation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class UpdateConfirmDialog | EchoHub Documentation ">
<link rel="icon" href="../../images/hue_icon.svg">
<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/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Client_UI_UpdateConfirmDialog.md&amp;value=---%0Auid%3A%20EchoHub.Client.UI.UpdateConfirmDialog%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="../../images/hue_icon.svg" alt="EchoHub">
EchoHub
</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" 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="EchoHub.Client.UI.UpdateConfirmDialog">
<h1 id="EchoHub_Client_UI_UpdateConfirmDialog" data-uid="EchoHub.Client.UI.UpdateConfirmDialog" class="text-break">
Class UpdateConfirmDialog <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateConfirmDialog.cs"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Client.html">Client</a>.<a class="xref" href="EchoHub.Client.UI.html">UI</a></dd></dl>
<dl><dt>Assembly</dt><dd>EchoHub.Client.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class UpdateConfirmDialog</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><span class="xref">UpdateConfirmDialog</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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.tostring">object.ToString()</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>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="EchoHub_Client_UI_UpdateConfirmDialog__ctor_" data-uid="EchoHub.Client.UI.UpdateConfirmDialog.#ctor*"></a>
<h3 id="EchoHub_Client_UI_UpdateConfirmDialog__ctor" data-uid="EchoHub.Client.UI.UpdateConfirmDialog.#ctor">
UpdateConfirmDialog()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateConfirmDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UpdateConfirmDialog()</code></pre>
</div>
<h2 class="section" id="methods">Methods
</h2>
<a id="EchoHub_Client_UI_UpdateConfirmDialog_Show_" data-uid="EchoHub.Client.UI.UpdateConfirmDialog.Show*"></a>
<h3 id="EchoHub_Client_UI_UpdateConfirmDialog_Show_Terminal_Gui_App_IApplication_System_String_System_String_" data-uid="EchoHub.Client.UI.UpdateConfirmDialog.Show(Terminal.Gui.App.IApplication,System.String,System.String)">
Show(IApplication, string, string)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateConfirmDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool Show(IApplication app, string currentVersion, string newVersion)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>currentVersion</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>newVersion</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateConfirmDialog.cs" 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">
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>&middot;</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>&middot;</span><a href='https://echohub.voidcube.cloud'>Website</a><span class='footer-sep'>&middot;</span><span class='footer-credit'>Built with <a href='https://dotnet.github.io/docfx'>DocFX</a></span></div></div>
</div>
</div>
</footer>
</body>
</html>
api/client/EchoHub.Client.UI.UpdateProgressDialog.html
+299
View File
@@ -0,0 +1,299 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class UpdateProgressDialog | EchoHub Documentation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class UpdateProgressDialog | EchoHub Documentation ">
<link rel="icon" href="../../images/hue_icon.svg">
<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/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Client_UI_UpdateProgressDialog.md&amp;value=---%0Auid%3A%20EchoHub.Client.UI.UpdateProgressDialog%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="../../images/hue_icon.svg" alt="EchoHub">
EchoHub
</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" 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="EchoHub.Client.UI.UpdateProgressDialog">
<h1 id="EchoHub_Client_UI_UpdateProgressDialog" data-uid="EchoHub.Client.UI.UpdateProgressDialog" class="text-break">
Class UpdateProgressDialog <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateProgressDialog.cs"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Client.html">Client</a>.<a class="xref" href="EchoHub.Client.UI.html">UI</a></dd></dl>
<dl><dt>Assembly</dt><dd>EchoHub.Client.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class UpdateProgressDialog</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><span class="xref">UpdateProgressDialog</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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.tostring">object.ToString()</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>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="EchoHub_Client_UI_UpdateProgressDialog__ctor_" data-uid="EchoHub.Client.UI.UpdateProgressDialog.#ctor*"></a>
<h3 id="EchoHub_Client_UI_UpdateProgressDialog__ctor_Terminal_Gui_App_IApplication_System_String_" data-uid="EchoHub.Client.UI.UpdateProgressDialog.#ctor(Terminal.Gui.App.IApplication,System.String)">
UpdateProgressDialog(IApplication, string)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateProgressDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UpdateProgressDialog(IApplication app, string newVersion)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>app</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/App/IApplication.cs">IApplication</a></dt>
<dd></dd>
<dt><code>newVersion</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="EchoHub_Client_UI_UpdateProgressDialog_Close_" data-uid="EchoHub.Client.UI.UpdateProgressDialog.Close*"></a>
<h3 id="EchoHub_Client_UI_UpdateProgressDialog_Close" data-uid="EchoHub.Client.UI.UpdateProgressDialog.Close">
Close()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateProgressDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Close()</code></pre>
</div>
<a id="EchoHub_Client_UI_UpdateProgressDialog_Show_" data-uid="EchoHub.Client.UI.UpdateProgressDialog.Show*"></a>
<h3 id="EchoHub_Client_UI_UpdateProgressDialog_Show" data-uid="EchoHub.Client.UI.UpdateProgressDialog.Show">
Show()
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateProgressDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Show()</code></pre>
</div>
<a id="EchoHub_Client_UI_UpdateProgressDialog_UpdateProgress_" data-uid="EchoHub.Client.UI.UpdateProgressDialog.UpdateProgress*"></a>
<h3 id="EchoHub_Client_UI_UpdateProgressDialog_UpdateProgress_System_Single_System_String_" data-uid="EchoHub.Client.UI.UpdateProgressDialog.UpdateProgress(System.Single,System.String)">
UpdateProgress(float, string)
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateProgressDialog.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void UpdateProgress(float fraction, string statusText)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>fraction</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a></dt>
<dd></dd>
<dt><code>statusText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/UpdateProgressDialog.cs" 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">
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>&middot;</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>&middot;</span><a href='https://echohub.voidcube.cloud'>Website</a><span class='footer-sep'>&middot;</span><span class='footer-credit'>Built with <a href='https://dotnet.github.io/docfx'>DocFX</a></span></div></div>
</div>
</div>
</footer>
</body>
</html>
api/client/EchoHub.Client.UI.UserListSource.html
+77 -23
View File
@@ -119,7 +119,7 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><span class="xref">IListDataSource</span></div>
<div><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">IListDataSource</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
</dd>
</dl>
@@ -197,7 +197,8 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the number of items in the data source.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -228,7 +229,8 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the width in columns of the widest item in the data source.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -248,6 +250,9 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_UserListSource_MaxItemLength_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> uses this value to set its horizontal content size for scrolling.</p>
</div>
@@ -259,7 +264,8 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether the <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">CollectionChanged</a> event should be suppressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -279,6 +285,10 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_UserListSource_SuspendCollectionChangedEvent_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Set to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> to prevent <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">CollectionChanged</a> from being raised during bulk
operations. Set back to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> to resume event notifications.</p>
</div>
@@ -320,7 +330,8 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Determines whether the specified item is marked.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -330,13 +341,15 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The zero-based index of the item.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is marked; otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
@@ -345,6 +358,10 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_UserListSource_IsMarked_System_Int32__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> calls this method to determine whether to render the item with a mark indicator when
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Selection.cs">ShowMarks</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</div>
@@ -356,7 +373,8 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Renders the specified item to the <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -365,20 +383,27 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>listView</code> <span class="xref">ListView</span></dt>
<dd></dd>
<dt><code>listView</code> <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a></dt>
<dd><p>The <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> to render to.</p>
</dd>
<dt><code>selected</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is currently selected; otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The zero-based index of the item to render.</p>
</dd>
<dt><code>col</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The column in <code class="paramref">listView</code> Viewport where rendering starts.</p>
</dd>
<dt><code>row</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The row in <code class="paramref">listView</code> Viewport where rendering starts.</p>
</dd>
<dt><code>width</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The width available for rendering.</p>
</dd>
<dt><code>viewportX</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The horizontal scroll offset.</p>
</dd>
</dl>
@@ -388,6 +413,15 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_UserListSource_Render_Terminal_Gui_Views_ListView_System_Boolean_System_Int32_System_Int32_System_Int32_System_Int32_System_Int32__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> calls this method for each visible item during rendering. The color scheme will be
set based on selection state before this method is called.
</p>
<p>
Implementations must fill the entire <code class="paramref">width</code> to avoid rendering artifacts.
</p>
</div>
@@ -399,7 +433,8 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Sets the marked state of the specified item.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -409,9 +444,11 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The zero-based index of the item.</p>
</dd>
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> to mark the item; <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> to unmark it.</p>
</dd>
</dl>
@@ -421,6 +458,10 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_UserListSource_SetMark_System_Int32_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> calls this method when the user toggles marking (e.g., via the SPACE key) if
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Selection.cs">ShowMarks</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</div>
@@ -432,7 +473,8 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Returns the underlying data source as an <span class="xref">System.Collections.IList</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -443,7 +485,8 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">IList</span></dt>
<dd></dd>
<dd><p>The data source as an <span class="xref">System.Collections.IList</span>.</p>
</dd>
</dl>
@@ -452,6 +495,11 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_UserListSource_ToList_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> uses this method to access individual items for events like
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ValueChanged</a> and to enable keyboard search via
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.cs">KeystrokeNavigator</a>.</p>
</div>
@@ -472,7 +520,7 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>users</code> <span class="xref">List</span>&lt;(<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetuple-system.string,system.nullable-terminal.gui.drawing.attribute--.text">Text</a>, <span class="xref">Attribute</span>? <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetuple-system.string,system.nullable-terminal.gui.drawing.attribute--.namecolor">NameColor</a>)&gt;</dt>
<dt><code>users</code> <span class="xref">List</span>&lt;(<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetuple-system.string,system.nullable-terminal.gui.drawing.attribute--.text">Text</a>, <a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Drawing/Attribute.cs">Attribute</a>? <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetuple-system.string,system.nullable-terminal.gui.drawing.attribute--.namecolor">NameColor</a>)&gt;</dt>
<dd></dd>
</dl>
@@ -497,7 +545,8 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ChatRenderer.cs"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Raised when items are added, removed, moved, or the entire collection is refreshed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -517,6 +566,11 @@ Class UserListSource <a class="header-action link-secondary" title="View source
<h4 class="section" id="EchoHub_Client_UI_UserListSource_CollectionChanged_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p><a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/ListView.Commands.cs">ListView</a> subscribes to this event to update its display and content size when the data
changes. Implementations should raise this event whenever the underlying collection changes, unless
<a class="xref" href="https://github.com/HueByte/Terminal.Gui/blob/master/Terminal.Gui/Views/ListView/IListDataSource.cs">SuspendCollectionChangedEvent</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</div>
api/client/EchoHub.Client.UI.html
+12
View File
@@ -94,6 +94,10 @@
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="EchoHub.Client.UI.AudioPlayerDialog.html">AudioPlayerDialog</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="EchoHub.Client.UI.ChannelListSource.html">ChannelListSource</a></dt>
<dd><p>Custom list data source for colored channel list rendering.
@@ -182,6 +186,14 @@ Shows Edit Profile / Set Status buttons when viewing own profile.</p>
<dd><p>Result returned from the status dialog.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="EchoHub.Client.UI.UpdateConfirmDialog.html">UpdateConfirmDialog</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="EchoHub.Client.UI.UpdateProgressDialog.html">UpdateProgressDialog</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="EchoHub.Client.UI.UserListSource.html">UserListSource</a></dt>
<dd><p>Custom list data source for the online users panel with per-user nickname colors.</p>