documentation more consistent
This commit is contained in:
+17
-17
@@ -3,7 +3,7 @@
|
||||
@(require racket/base
|
||||
scribble/core)
|
||||
|
||||
@title{racket-webview}
|
||||
@title[#:tag "racket-webview"]{racket-webview}
|
||||
@author[@author+email["Hans Dijkema" "hans@dijkewijk.nl"]]
|
||||
|
||||
@defmodule[racket-webview/racket-webview]
|
||||
@@ -14,7 +14,7 @@ This module provides a structured programming model around the lower-level
|
||||
webview bindings. It introduces contexts, a local HTTPS server, JSON-based
|
||||
event handling, and DOM and JavaScript utilities.
|
||||
|
||||
@section{Architecture}
|
||||
@section[#:tag "racket-webview-architecture"]{Architecture}
|
||||
|
||||
The module builds on the lower-level bindings from
|
||||
@racketmodname[racket-webview/racket-webview-qt]. It adds:
|
||||
@@ -31,7 +31,7 @@ JavaScript calls. When an HTML file is
|
||||
served, the context's CSS boilerplate is injected immediately before the
|
||||
closing @tt{</head>} tag.
|
||||
|
||||
@section{Contexts}
|
||||
@section[#:tag "racket-webview-contexts"]{Contexts}
|
||||
|
||||
|
||||
@defproc[(webview-new-context
|
||||
@@ -76,7 +76,7 @@ This URL can be used to construct URLs from relative path information.
|
||||
Recognizes context values.
|
||||
}
|
||||
|
||||
@section{Windows}
|
||||
@section[#:tag "racket-webview-windows"]{Windows}
|
||||
|
||||
@defproc[(webview-create
|
||||
[context wv-context?]
|
||||
@@ -136,7 +136,7 @@ Resizes the window.
|
||||
Returns the current window state.
|
||||
}
|
||||
|
||||
@section{Navigation and Content}
|
||||
@section[#:tag "racket-webview-navigation-and-content"]{Navigation and Content}
|
||||
|
||||
@defproc[(webview-set-url! [wv wv-win?] [url (or/c string? url?)])
|
||||
symbol?]{
|
||||
@@ -176,7 +176,7 @@ The result is the symbol returned by @racket[webview-run-js].
|
||||
Sets the window title.
|
||||
}
|
||||
|
||||
@section{JavaScript}
|
||||
@section[#:tag "racket-webview-javascript"]{JavaScript}
|
||||
|
||||
@defproc[(webview-run-js [wv wv-win?] [js string?]) symbol?]{
|
||||
Evaluates JavaScript.
|
||||
@@ -196,7 +196,7 @@ structure, an exception is raised.
|
||||
}
|
||||
|
||||
|
||||
@section{Dialogs}
|
||||
@section[#:tag "racket-webview-dialogs"]{Dialogs}
|
||||
|
||||
Dialog functions return immediately. Results are delivered asynchronously via
|
||||
events.
|
||||
@@ -254,9 +254,9 @@ is indicated through the event.
|
||||
}
|
||||
|
||||
|
||||
@section{DOM Interaction}
|
||||
@section[#:tag "racket-webview-dom-interaction"]{DOM Interaction}
|
||||
|
||||
@subsection{Selectors and Element Identifiers}
|
||||
@subsection[#:tag "racket-webview-selectors-and-element-identifiers"]{Selectors and Element Identifiers}
|
||||
|
||||
Many functions accept either an element identifier or a CSS selector.
|
||||
|
||||
@@ -272,7 +272,7 @@ If a string is provided, it is used directly as a CSS selector.
|
||||
|
||||
Functions apply their effect to all matched elements.
|
||||
|
||||
@subsection{Event Binding}
|
||||
@subsection[#:tag "racket-webview-event-binding"]{Event Binding}
|
||||
|
||||
@defproc[(webview-bind!
|
||||
[wv wv-win?]
|
||||
@@ -300,7 +300,7 @@ Selector handling is the same as for @racket[webview-bind!]. The result is a
|
||||
list describing the removed bindings.
|
||||
}
|
||||
|
||||
@subsection{DOM Values}
|
||||
@subsection[#:tag "racket-webview-dom-values"]{DOM Values}
|
||||
|
||||
@defproc[(webview-set-value!
|
||||
[wv wv-win?]
|
||||
@@ -367,7 +367,7 @@ Returns the value converted to a datetime.
|
||||
Returns the value converted to a color.
|
||||
}
|
||||
|
||||
@subsection{Classes, Styles}
|
||||
@subsection[#:tag "racket-webview-classes-styles"]{Classes, Styles}
|
||||
|
||||
@defproc[(webview-add-class!
|
||||
[wv wv-win?]
|
||||
@@ -428,7 +428,7 @@ If @racket[selector] is a symbol, the result for that single element is returned
|
||||
directly. Otherwise the result covers all matched elements.
|
||||
}
|
||||
|
||||
@subsection{Attributes}
|
||||
@subsection[#:tag "racket-webview-attributes"]{Attributes}
|
||||
|
||||
@defproc[(webview-set-attr!
|
||||
[wv wv-win?]
|
||||
@@ -517,7 +517,7 @@ Returns the attribute value converted to a datetime.
|
||||
Returns the attribute value converted to a color.
|
||||
}
|
||||
|
||||
@subsection{Inner HTML}
|
||||
@subsection[#:tag "racket-webview-inner-html"]{Inner HTML}
|
||||
|
||||
@defproc[(webview-set-innerHTML!
|
||||
[wv wv-win?]
|
||||
@@ -531,7 +531,7 @@ Returns @racket['oke] if the injected JavaScript yields a true value, and
|
||||
@racket['failed] otherwise.
|
||||
}
|
||||
|
||||
@section{File Filters}
|
||||
@section[#:tag "racket-webview-file-filters"]{File Filters}
|
||||
|
||||
@defstruct*[wv-permitted-exts ([name string?]
|
||||
[exts (listof symbol?)])]{
|
||||
@@ -548,7 +548,7 @@ Represents a file dialog filter entry.
|
||||
Recognizes lists of filter entries.
|
||||
}
|
||||
|
||||
@section{Utilities}
|
||||
@section[#:tag "racket-webview-utilities"]{Utilities}
|
||||
|
||||
@defproc[(webview-default-boilerplate-js [custom-js procedure?] ...)
|
||||
string?]{
|
||||
@@ -576,7 +576,7 @@ If an additional procedure is supplied, its returned string is appended to that
|
||||
Creates a standard file getter.
|
||||
}
|
||||
|
||||
@section{Diagnostics}
|
||||
@section[#:tag "racket-webview-diagnostics"]{Diagnostics}
|
||||
|
||||
@defproc[(webview-version) list?]{
|
||||
Returns version information.
|
||||
|
||||
Reference in New Issue
Block a user