Skip to content

Commit 864bdb9

Browse files
committed
Add main window documentation
1 parent 130eafa commit 864bdb9

File tree

2 files changed

+29
-6
lines changed

2 files changed

+29
-6
lines changed

Writerside/cfg/glossary.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
<terms>
44
<term name="FQN">Fully Qualified Name</term>
55
<term name="TODO">This functionality or documentation is not implemented at the moment</term>
6-
<term name="optional class">Can be created without requiring any mandatory arguments.</term>
6+
<term name="optional class">Can be created without requiring any mandatory arguments</term>
7+
<term name="facade">The property or method is defined elsewhere, and working with it simply delegates all calls</term>
78
</terms>

Writerside/topics/application.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,15 +126,35 @@ if ($app->isRunning === false) {
126126
}
127127
</code-block>
128128

129-
<!--
130129
## Main Window
131130

132-
<tooltip term="TODO">TODO</tooltip>
131+
The `Application::$window` property provides convenient access to the main
132+
(default) window of the application.
133133

134-
## Main WebView
134+
<tip>This is a <tooltip term="facade">facade property</tooltip> that internally
135+
accesses the default window inside the window manager</tip>
135136

136-
<tooltip term="TODO">TODO</tooltip>
137-
-->
137+
<code-block lang="PHP">
138+
$app = new Boson\Application();
139+
140+
// Access the main window
141+
$window = $app->window;
142+
</code-block>
143+
144+
The main window is automatically created when the application starts.
145+
146+
<warning>
147+
If the <b>main</b> window is closed, the next available window from window
148+
manager will become the <b>main</b> window.
149+
150+
If you try to access the `$window` property after the all windows has been
151+
closed, a `NoDefaultWindowException` will be thrown.
152+
</warning>
153+
154+
<note>
155+
More information about windows can be found in the
156+
<tooltip term="TODO">window documentation</tooltip>.
157+
</note>
138158

139159
## Application Events
140160

@@ -157,5 +177,7 @@ during its lifecycle:
157177
<tip>This is an <b>event</b>: Tells you that the application has already stopped.
158178
You cannot influence this in any way.</tip>
159179

180+
<note>
160181
More information about events can be found in the
161182
<tooltip term="TODO">events documentation</tooltip>.
183+
</note>

0 commit comments

Comments
 (0)