API.h

Classes
struct	AttachOptions
	Options for API::AttachTo(). More...
struct	APIOptions
	Options for creating an API. More...
struct	Param
	A parameter name for a registration (shown in API::schema() and in error messages). More...
struct	Doc
	A documentation string for a registration (shown in API::schema()). More...
class	API
	A global JavaScript namespace for native functions and data. More...
class	API::Binder
	The assignable path that operator[] returns (see Binding Functions and Values in the class overview). More...
class	BindingGuard
	A binding tied to a C++ object's lifetime. More...
struct	InjectionRequest
	The details an API injection filter decides on (see SetInjectionFilter()). More...

Functions
constexpr AttachFlags	operator| (AttachFlags a, AttachFlags b)
	Combine attach flags.
constexpr AttachFlags &	operator|= (AttachFlags &a, AttachFlags b)
	Add attach flags to a.
template<typename F>
void	SetInjectionFilter (View *view, F &&filter)
	Set a View's API filter with a C++ callable (the typed form of View::SetJSAPIInjectionFilter()).
void	ClearInjectionFilter (View *view)
	Remove a View's API filter, so the origin rules alone decide which pages get the bindings.
template<typename T, typename M> requires std::is_member_function_pointer_v<M>
auto	Bind (T *instance, M method)
	Bind a member function to an instance without writing a lambda.
template<typename H, typename M> requires ((Holder<H> || LockableHolder<H>) && std::is_member_function_pointer_v<M>)
auto	Bind (H holder, M method)
	Bind a member function to an instance kept by a holder.

Variables
constexpr AttachFlags	AllFrames = AttachFlags::AllFrames
	Shorthand for AttachFlags::AllFrames.
constexpr AttachFlags	Mutable = AttachFlags::Mutable
	Shorthand for AttachFlags::Mutable.

Namespaces
namespace	ultralight
	Root namespace for every public Ultralight type, function, and enumeration.
namespace	ultralight::js
	Type-checked JavaScript bridge between C++ and web pages.

Typedefs
using	Diagnostics = DiagnosticsLevel
	The diagnostics levels for an API.

Enumerations
enum class	AttachFlags : unsigned { None = 0 , AllFrames = 1u << 1 , Mutable = 1u << 2 }
	The flags for API::AttachTo() (the C++ form of ULJSAPIAttachFlags). More...

Go to the source code of this file.