documentation more consistent
This commit is contained in:
@@ -5,7 +5,7 @@
|
||||
@title[#:tag "rktwebview-process"]{Racket Process Interface for @tt{rktwebview_prg}}
|
||||
@author[@author+email["Hans Dijkema" "hans@dijkewijk.nl"]]
|
||||
|
||||
@section{Overview}
|
||||
@section[#:tag "racket-webview-qt-overview"]{Overview}
|
||||
|
||||
The module @tt{racket-webview-qt.rkt} provides the low-level Racket interface to
|
||||
the Qt helper process @tt{rktwebview_prg}. It keeps the existing command numbers,
|
||||
@@ -33,7 +33,7 @@ The module provides:
|
||||
@item{asynchronous event delivery}
|
||||
@item{version and cleanup utilities}]
|
||||
|
||||
@section{Backend Availability}
|
||||
@section[#:tag "racket-webview-qt-backend-availability"]{Backend Availability}
|
||||
|
||||
The environment variable @tt{RKT_WEBVIEW_PRG} may name an explicit backend
|
||||
executable. This is useful during development and testing.
|
||||
@@ -43,7 +43,7 @@ directory. Availability is checked when the first backend operation is made,
|
||||
not while the module is loaded. If the configured backend cannot be found or
|
||||
downloaded, that operation raises an exception with the reason.
|
||||
|
||||
@section{Module Initialization}
|
||||
@section[#:tag "racket-webview-qt-module-initialization"]{Module Initialization}
|
||||
|
||||
Starting the backend performs the following steps:
|
||||
|
||||
@@ -61,9 +61,9 @@ written only to stderr.
|
||||
|
||||
Currently the wrapper supports @tt{'linux} and @tt{'windows} release layouts.
|
||||
|
||||
@section{Data Model}
|
||||
@section[#:tag "racket-webview-qt-data-model"]{Data Model}
|
||||
|
||||
@subsection{The @tt{rkt-wv} Structure}
|
||||
@subsection[#:tag "racket-webview-qt-rkt-wv-structure"]{The @tt{rkt-wv} Structure}
|
||||
|
||||
Each webview window is represented by a transparent Racket structure.
|
||||
|
||||
@@ -95,7 +95,7 @@ an opaque handle.
|
||||
@;Returns the native window handle associated with @racket[wv].
|
||||
@;}
|
||||
|
||||
@section{HTTP(S) Contexts}
|
||||
@section[#:tag "racket-webview-qt-http-s-contexts"]{HTTP(S) Contexts}
|
||||
|
||||
A context represents the shared HTTP(S) environment used by webviews.
|
||||
|
||||
@@ -126,7 +126,7 @@ The returned context identifier can be passed to
|
||||
@racket[rkt-webview-create] to create webviews within that context.
|
||||
}
|
||||
|
||||
@section{Creating Webviews}
|
||||
@section[#:tag "racket-webview-qt-creating-webviews"]{Creating Webviews}
|
||||
|
||||
@defproc[(rkt-webview-create
|
||||
[context exact-integer?]
|
||||
@@ -153,7 +153,7 @@ Events generated by the native layer are delivered asynchronously through
|
||||
@racket[evt-callback].
|
||||
}
|
||||
|
||||
@section{Window Lifecycle}
|
||||
@section[#:tag "racket-webview-qt-window-lifecycle"]{Window Lifecycle}
|
||||
|
||||
@defproc[(rkt-webview-close [wv rkt-wv?]) boolean?]{
|
||||
|
||||
@@ -182,7 +182,7 @@ This function is also registered with the Racket plumber so that cleanup occurs
|
||||
automatically when the process exits.
|
||||
}
|
||||
|
||||
@section{Window Configuration}
|
||||
@section[#:tag "racket-webview-qt-window-configuration"]{Window Configuration}
|
||||
|
||||
@defproc[(rkt-webview-set-title! [wv rkt-wv?] [title string?])
|
||||
symbol?]{
|
||||
@@ -206,7 +206,7 @@ This token may be used by the native layer when accepting certain
|
||||
self-signed certificates.
|
||||
}
|
||||
|
||||
@section{Navigation}
|
||||
@section[#:tag "racket-webview-qt-navigation"]{Navigation}
|
||||
|
||||
@defproc[(rkt-webview-set-url! [wv rkt-wv?] [url string?]) symbol?]{
|
||||
|
||||
@@ -232,7 +232,7 @@ Returns a result symbol such as:
|
||||
]
|
||||
}
|
||||
|
||||
@section{JavaScript Execution}
|
||||
@section[#:tag "racket-webview-qt-javascript-execution"]{JavaScript Execution}
|
||||
|
||||
@defproc[(rkt-webview-run-js [wv rkt-wv?] [js string?]) symbol?]{
|
||||
|
||||
@@ -265,7 +265,7 @@ where:
|
||||
The JSON structure is generated by the native backend.
|
||||
}
|
||||
|
||||
@section{Window Geometry}
|
||||
@section[#:tag "racket-webview-qt-window-geometry"]{Window Geometry}
|
||||
|
||||
@defproc[(rkt-webview-move [wv rkt-wv?] [x exact-integer?] [y exact-integer?])
|
||||
symbol?]{
|
||||
@@ -322,13 +322,13 @@ Possible results:
|
||||
]
|
||||
}
|
||||
|
||||
@section{Developer Tools}
|
||||
@section[#:tag "racket-webview-qt-developer-tools"]{Developer Tools}
|
||||
|
||||
@defproc[(rkt-webview-open-devtools [wv rkt-wv?]) symbol?]{
|
||||
Opens the browser developer tools window.
|
||||
}
|
||||
|
||||
@section{Native Dialogs}
|
||||
@section[#:tag "racket-webview-qt-native-dialogs"]{Native Dialogs}
|
||||
|
||||
Dialog functions return immediately with a status code.
|
||||
The user’s choice is delivered asynchronously through the event callback.
|
||||
@@ -373,7 +373,7 @@ Requests a file-save dialog.
|
||||
Shows a native message box.
|
||||
}
|
||||
|
||||
@section{Event Delivery}
|
||||
@section[#:tag "racket-webview-qt-event-delivery"]{Event Delivery}
|
||||
|
||||
Each webview has an associated event callback.
|
||||
|
||||
@@ -405,7 +405,7 @@ Typical event types include:
|
||||
|
||||
The wrapper does not parse the JSON payload.
|
||||
|
||||
@section{Version Information}
|
||||
@section[#:tag "racket-webview-qt-version-information"]{Version Information}
|
||||
|
||||
@defproc[(rkt-webview-version)
|
||||
(list/c list? list?)]{
|
||||
@@ -421,7 +421,7 @@ Example result:
|
||||
]
|
||||
}
|
||||
|
||||
@section{Example}
|
||||
@section[#:tag "racket-webview-qt-example"]{Example}
|
||||
|
||||
@racketblock[
|
||||
(define ctx
|
||||
@@ -440,7 +440,7 @@ Example result:
|
||||
(rkt-webview-set-url! wv "https://example.org")
|
||||
]
|
||||
|
||||
@section{Summary}
|
||||
@section[#:tag "racket-webview-qt-summary"]{Summary}
|
||||
|
||||
The module provides a thin Racket interface to the separate
|
||||
@tt{rktwebview_prg} process.
|
||||
|
||||
Reference in New Issue
Block a user