daniel/MontaukOS
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

wip: docs wip

Browse Source
This commit is contained in:
Daniel Hammer
2026-05-27 18:04:08 +02:00
parent f2ca3956b0
commit 190b0f9364
6 changed files with 179 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
montaukos.org/docs/dtinternals/assets/files.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

montaukos.org/docs/dtinternals/assets/files_apps_view.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

montaukos.org/docs/dtinternals/dialogslib.html
+13 -13
View File
@@ -115,7 +115,7 @@
<h2>Overview</h2> <h2>Overview</h2>
<p> <p>
The dialogs library provides the following system dialogs across apps: The dialogs library (at 0:/os/libdialogs.lib) provides the following system dialogs across apps:
</p> </p>
<ul> <ul>
@@ -127,7 +127,7 @@ The dialogs library provides the following system dialogs across apps:
<h2>Message Box</h2> <h2>Message Box</h2>
<p> <p>
<code>message_box</code> displays a popup window with text and buttons. <i>message_box</i> displays a popup window with text and buttons.
</p> </p>
<pre><code>gui::dialogs::MessageBoxResult message_box( <pre><code>gui::dialogs::MessageBoxResult message_box(
@@ -140,20 +140,20 @@ The dialogs library provides the following system dialogs across apps:
<h3>Button Sets</h3> <h3>Button Sets</h3>
<table> <table>
<tr><th>Value</th><th>Buttons</th></tr> <tr><th>Value</th><th>Buttons</th></tr>
<tr><td><code>MESSAGE_BOX_OK</code></td><td>OK</td></tr> <tr><td>MESSAGE_BOX_OK</td><td>OK</td></tr>
<tr><td><code>MESSAGE_BOX_OK_CANCEL</code></td><td>OK, Cancel</td></tr> <tr><td>MESSAGE_BOX_OK_CANCEL</td><td>OK, Cancel</td></tr>
<tr><td><code>MESSAGE_BOX_YES_NO</code></td><td>Yes, No</td></tr> <tr><td>MESSAGE_BOX_YES_NO</td><td>Yes, No</td></tr>
<tr><td><code>MESSAGE_BOX_YES_NO_CANCEL</code></td><td>Yes, No, Cancel</td></tr> <tr><td>MESSAGE_BOX_YES_NO_CANCEL</td><td>Yes, No, Cancel</td></tr>
</table> </table>
<h3>Results</h3> <h3>Results</h3>
<table> <table>
<tr><th>Value</th><th>Meaning</th></tr> <tr><th>Value</th><th>Meaning</th></tr>
<tr><td><code>MESSAGE_BOX_RESULT_OK</code></td><td>The user selected OK.</td></tr> <tr><td>MESSAGE_BOX_RESULT_OK</td><td>The user selected OK.</td></tr>
<tr><td><code>MESSAGE_BOX_RESULT_CANCEL</code></td><td>The user selected Cancel or closed a cancelable dialog.</td></tr> <tr><td>MESSAGE_BOX_RESULT_CANCEL</td><td>The user selected Cancel or closed a cancelable dialog.</td></tr>
<tr><td><code>MESSAGE_BOX_RESULT_YES</code></td><td>The user selected Yes.</td></tr> <tr><td>MESSAGE_BOX_RESULT_YES</td><td>The user selected Yes.</td></tr>
<tr><td><code>MESSAGE_BOX_RESULT_NO</code></td><td>The user selected No, or closed a Yes/No dialog.</td></tr> <tr><td>MESSAGE_BOX_RESULT_NO</td><td>The user selected No, or closed a Yes/No dialog.</td></tr>
<tr><td><code>MESSAGE_BOX_RESULT_NONE</code></td><td>The dialog could not be loaded or invoked.</td></tr> <tr><td>MESSAGE_BOX_RESULT_NONE</td><td>The dialog could not be loaded or invoked.</td></tr>
</table> </table>
<h3>Example</h3> <h3>Example</h3>
@@ -172,7 +172,7 @@ void show_confirm() {
<div class="figure"> <div class="figure">
<img src="assets/discard_dialog.png" width="337" height="181" alt="Message box asking whether to discard unsaved changes"> <img src="assets/discard_dialog.png" width="337" height="181" alt="Message box asking whether to discard unsaved changes">
<p>Example <code>MESSAGE_BOX_YES_NO_CANCEL</code> dialog.</p> <p>Example <i>MESSAGE_BOX_YES_NO_CANCEL</i> dialog.</p>
</div> </div>
<h2>File Dialogs</h2> <h2>File Dialogs</h2>
@@ -256,7 +256,7 @@ bool print_file(
<pre><code>#include &lt;gui/dialogs.hpp&gt;</code></pre><br> <pre><code>#include &lt;gui/dialogs.hpp&gt;</code></pre><br>
<hr> <hr>
<p class="center">Copyright &copy; 2026 Montauk Operating System. All rights reserved.<br><br>Page last revised 22 April 2026.</p> <p class="center">Copyright &copy; 2026 Montauk Operating System. All rights reserved.<br><br>Page last revised 26 May 2026.</p>
<hr> <hr>
montaukos.org/docs/dtinternals/files.html
+163
View File
@@ -0,0 +1,163 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="MontaukOS dialogs library API">
<title>Dialogs Library - MontaukOS</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600&display=swap" rel="stylesheet">
<style>
body {
font-family: 'Open Sans', Arial, sans-serif;
max-width: 960px;
margin: 0 auto;
padding: 1em;
line-height: 1.5;
display: flex;
gap: 2em;
}
p { margin: 0 0 0.5em; }
h2 { margin: 0.5em 0; }
h3 { margin: 0.75em 0 0.35em; }
.sidebar {
width: 160px;
flex-shrink: 0;
}
.sidebar ul {
list-style: none;
padding: 0;
}
.sidebar li {
margin: 0.5em 0;
}
.sidebar a {
color: #0066CC;
text-decoration: none;
font-weight: 600;
}
.sidebar a:hover {
color: #004499;
text-decoration: underline;
}
.sidebar .current {
color: #004499;
}
.sidebar hr {
border: none;
border-top: 1px solid #999;
margin: 0.75em 0;
}
.main {
flex: 1;
min-width: 0;
}
a { color: #0000EE; }
a:visited { color: #0066CC; }
hr { border-style: solid; border-width: 1px 0 0 0; border-color: #999; }
pre { background: #f0f0f0; padding: 0.5em; overflow-x: auto; }
code { background: #f0f0f0; padding: 0 0.15em; }
pre code { padding: 0; }
table {
border-collapse: collapse;
width: 100%;
margin: 0.5em 0;
}
th, td {
border: 1px solid #999;
padding: 0.35em 0.5em;
text-align: left;
vertical-align: top;
}
th { background: #f0f0f0; }
.center { text-align: center; }
.box {
border: 1px solid #999;
padding: 0.5em;
margin: 0.5em 0;
}
.figure {
margin: 0.75em 0;
}
.figure img {
display: block;
max-width: 100%;
height: auto;
border: 1px solid #999;
}
.figure p {
color: #555;
font-size: 0.9em;
margin: 0.25em 0 0;
}
</style>
</head>
<body>
<div class="sidebar">
<ul>
<li><a href="../../index.html">Home</a></li>
<li><a href="../index.html">Documentation</a></li>
</ul>
<hr>
<ul>
<li><a href="../introduction.html">Introduction</a></li>
</ul>
</div>
<div class="main">
<div class="center">
<h1>File Manager</h1>
</div>
<hr>
<h2>Overview</h2>
<p>
The Files app provides an interface that allows users of MontaukOS to:
</p>
<ul>
<li>Navigate and manage files on available volumes</li>
<li>View and access user libraries</li>
<li>View and access installed applications (see &sect; Apps folder)</li>
<li>View and access installed applications (see &sect; Settings/System Configuration folder)</li>
</ul>
<br>
<div class="figure">
<img src="assets/files.png" alt="Files app displaying Computer view with user libraries, ramdisk volume, Settings, and Apps folder.">
<p>Files app displaying Computer view with user libraries, ramdisk volume, Settings, and Apps folder.</p>
</div>
<hr>
<h2>Technical notes</h2>
<ul>
<li>The Files app is one of two windowed applications (the other being the Desktop Settings applet) compiled directly into the desktop's binary (<i>0:/os/desktop.elf</i>) rather than being a separate application. Crashes of the Files app may therefore cause the entire desktop process to crash, kicking the user back to the login screen (<i>0:/os/login.elf</i>).</li>
<br>
<li>Most of the Files app does not use the MTK toolkit, relying on custom GUI views to render complex file views; however, Properties and delete confirmation windows within the Files app do rely on the MTK toolkit.</li>
</ul>
<br>
<hr>
<h2>Apps folder</h2>
<div class="figure">
<img src="assets/files_apps_view.png" alt="Apps folder in the Files app displaying installed applications on a MontaukOS development build.">
<p>Apps folder in the Files app displaying installed applications on a MontaukOS development build.</p>
</div>
<br>
<hr>
<p class="center">Copyright &copy; 2026 Montauk Operating System. All rights reserved.<br><br>Page last revised 26 May 2026.</p>
<hr>
<div class="center">
<a href="../index.html">Back to Documentation Index</a>
</div>
</div>
</body>
</html>
montaukos.org/docs/dtinternals/index.html
+3 -8
View File
@@ -86,10 +86,6 @@
<li><a href="index.html" class="current">Desktop Internals</a></li> <li><a href="index.html" class="current">Desktop Internals</a></li>
</ul> </ul>
<hr> <hr>
<ul>
<li><a href="dialogslib.html">Dialogs Library</a></li>
<li><a href="systemconfiguration.html">System Configuration Virtual Folder</a></li>
</ul>
</div> </div>
<div class="main"> <div class="main">
@@ -100,8 +96,7 @@
<hr> <hr>
<p> <p>
This volume documents the internal architecture of the MontaukOS desktop environment, Internals of the MontaukOS desktop.
including the dialogs library, virtual folder system, and system configuration applets.
</p> </p>
<h2>Pages</h2> <h2>Pages</h2>
@@ -111,8 +106,8 @@ including the dialogs library, virtual folder system, and system configuration a
<p>File, print, and message box dialogs exposed through the shared dialogs library.</p> <p>File, print, and message box dialogs exposed through the shared dialogs library.</p>
</li> </li>
<li> <li>
<a href="systemconfiguration.html">System Configuration Virtual Folder</a> <a href="files.html">Files app</a>
<p>Virtual view used for built-in configuration applets.</p> <p>The File Manager application.</p>
</li> </li>
</ul> </ul>
montaukos.org/docs/dtinternals/systemconfiguration.html
-11
View File
@@ -1,11 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
</body>
</html>