Skip to content

Commit d2ea06b

Browse files
committed
Improve readme
1 parent 56ed688 commit d2ea06b

4 files changed

Lines changed: 48 additions & 2 deletions

File tree

Writerside/topics/configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,12 @@ $windowConfig = new Boson\Window\WindowCreateInfo(
300300
);
301301
```
302302

303+
<warning>
304+
MacOS/WebKit: Does not allow to control hardware-acceleration.
305+
306+
This configuration option has no effect.
307+
</warning>
308+
303309
<warning>
304310
The value cannot be changed after the application is created.
305311
</warning>

Writerside/topics/getting-started/installation.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,8 +243,17 @@ Make sure that GTK4 is installed.
243243
<tabs>
244244
<tab title="Linux (Debian)">
245245
<code-block lang="bash">
246-
sudo apt update
247-
sudo apt install libwebkitgtk-6.0-4
246+
apt install libgtk-4-1 libwebkitgtk-6.0-4
247+
</code-block>
248+
</tab>
249+
<tab title="Linux (Fedora)">
250+
<code-block lang="bash">
251+
dnf install gtk4 webkitgtk6.0
252+
</code-block>
253+
</tab>
254+
<tab title="Linux (FreeBSD)">
255+
<code-block lang="bash">
256+
pkg install webkit2-gtk4
248257
</code-block>
249258
</tab>
250259
</tabs>

Writerside/topics/webview.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,18 @@ class WebViewDomReady<WebView>
171171
An `Boson\WebView\Event\WebViewFaviconChanging` intention to change the
172172
window's icon from loaded HTML content.
173173

174+
<warning>
175+
Linux/GTK4: An intention does not change the windows icon.
176+
177+
Icon change intention has no effect.
178+
</warning>
179+
180+
<warning>
181+
MacOS/WebKit: Provides no way to access favicons.
182+
183+
Icon change intention has no effect.
184+
</warning>
185+
174186
```php
175187
class WebViewFaviconChanging<WebView>
176188
```

Writerside/topics/window.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,13 @@ The maximum size is typically limited by the screen resolution. Setting a value
475475
larger than the screen size may not have the desired effect.
476476
</note>
477477

478+
<warning>
479+
Linux/GTK4: Not supported because X11-specific functions such as
480+
<code>gtk_window_set_geometry_hints</code> were removed.
481+
482+
This option has no effect.
483+
</warning>
484+
478485
<warning>
479486
Window max size must be non-negative <code>int32</code> (an integer value
480487
between 0 and 2147483647).
@@ -640,6 +647,12 @@ Windows can be given input focus and brought to the front with
640647
$window->focus();
641648
```
642649

650+
<warning>
651+
Linux/GTK4: There is no way to artificially focus the window.
652+
653+
This method has no effect.
654+
</warning>
655+
643656
<warning>
644657
Keep in mind that it can be very disruptive to the user when a window is
645658
forced to the top. Please use this feature judiciously.
@@ -672,6 +685,12 @@ $window->isAlwaysOnTop = true;
672685
$window->isAlwaysOnTop = false;
673686
```
674687

688+
<warning>
689+
Linux/GTK4: There is no way to artificially set window always on top.
690+
691+
This method has no effect.
692+
</warning>
693+
675694
<warning>
676695
Windows that are always on top may interfere with normal window management
677696
and user interaction. Please use this feature judiciously.

0 commit comments

Comments
 (0)