Namespaces
namespace	Attributes

namespace	Components

namespace	ContainerWrapUtility

namespace	Detail

namespace	detail

namespace	Dom

namespace	Elements

namespace	FileDialog

namespace	Impl

namespace	MacOs

namespace	Materializers

namespace	WebApi

Classes
class	AsyncFile
	Do note that the use of this class is inefficient. More...

class	Attribute

struct	ChildrenRenderer

struct	CustomEventContextFlag_t

class	DefaultEventEngine

class	Delocalized
	A delocalized element can switch positions in several slots. More...

class	Display

class	Event

class	EventContext
	This object can be copied with low cost. More...

class	EventEngine

struct	EventImpl

class	EventRegistry

struct	ExtractValueType

struct	FetchOptions

struct	FetchResponse

class	FixedString
	Utilitarian class to store and modify strings in compile time. More...

struct	FixToLowerFlag

struct	functor_t

class	GObjectReference

struct	HostNameMappingInfo

class	HtmlElement

struct	HtmlElementBridge

struct	IsTuple

struct	IsTuple< std::tuple< Ts... > >

class	IteratorAccessor

class	IteratorAccessor< std::shared_ptr< ContainerT > >

class	IteratorAccessor< std::weak_ptr< ContainerT > >

class	JSON

class	Lazy

class	ModifiableObserved

class	MoveDetector
	Utility class to detect if an object was moved. More...

class	Observed

class	Observed< std::basic_string< Parameters... > >

class	Observed< std::deque< Parameters... > >

class	Observed< std::list< Parameters... > >

class	Observed< std::set< Parameters... > >

class	Observed< std::vector< Parameters... > >

class	Observed< void >

class	ObservedBase

class	ObservedContainer

class	ObservedRange

class	ObservedValueCombinator

class	ObservedValueCombinatorBase

class	ObservedValueCombinatorWithGenerator

class	ObservedValueCombinatorWithPropertyGenerator

class	OnDestroy

struct	overloaded

class	RangeEventContext

struct	Renderer

class	reverse_view

class	RpcClient

class	RpcHub

class	ScopeExit

class	Screen

class	SelectablesRegistry
	This container associates items with an id and allows for individual items to be "selected", which removes them from the container and stores them in a separate container. More...

class	StableElement

class	ThrottledFunction

class	TimerHandle

struct	TrivialRenderer

struct	TwoFunctorEventImpl

class	UnoptimizedRange

struct	UnpackObserved

struct	UnpackObserved< Observed< T > >

struct	UnpackObserved< std::shared_ptr< const Observed< T > > >

struct	UnpackObserved< std::shared_ptr< Observed< T > > >

struct	UnpackObserved< std::weak_ptr< const Observed< T > > >

struct	UnpackObserved< std::weak_ptr< Observed< T > > >

class	ValWrapper
	Common base class for classes that are just wrapping around val into js world. More...

class	Window
	This class encapsulates the webview. More...

struct	WindowOptions

Concepts
concept	Numerical

concept	Fundamental

concept	Incrementable

concept	Decrementable

concept	PlusAssignable

concept	MinusAssignable

concept	InvocableReturns

concept	Range

concept	IsObserved

concept	IsSharedObserved

concept	IsWeakObserved

concept	IsObservedLike

Typedefs
using	Url = Roar::Url

using	Console = WebApi::Console

template<typename T >
using	UnpackObserved_t = typename UnpackObserved< T >::type

using	ElementRenderer = std::function< std::shared_ptr< Dom::Element >(Dom::Element &, Renderer const &)>

using	val = emscripten::val

template<typename T >
using	ExtractValueType_t = typename ExtractValueType< T >::type

Enumerations
enum	RangeOperationType { Keep = 0b0001 , Modify = 0b0010 , Insert = 0b0100 , Erase = 0b1000 }

enum class	RendererType { Append , Fragment , Insert , Replace , Inplace , Emplace }

enum class	ResizeableEdge { Right , Bottom , Top }

enum class	WebViewHint : int { WEBVIEW_HINT_NONE , WEBVIEW_HINT_MIN , WEBVIEW_HINT_MAX , WEBVIEW_HINT_FIXED }

enum class	HostResourceAccessKind { Deny , Allow , DenyCors }

enum class	NuiCoreWebView2WebResourceContext { All , Document , Stylesheet , Image , Media , Font , Script , XmlHttpRequest , Fetch , TextTrack , EventSource , WebSocket , Manifest , SignedExchange , Ping , CspViolationReport , Other }

Functions
std::filesystem::path	resolvePath (std::filesystem::path const &path)
	Will replace prefixes like "~" and "%appdata%" with actual directories on linux and windows.

void	getEnvironmentVariables (std::function< void(std::unordered_map< std::string, std::string > &&)> callback)

template<typename ValueT >
void	listen (EventContext &eventContext, Observed< ValueT > const &obs, std::function< bool(ValueT const &)> onEvent)

template<typename ValueT > requires std::is_scalar_v<ValueT>
void	listen (EventContext &eventContext, Observed< ValueT > const &obs, std::function< bool(ValueT)> onEvent)

template<typename ValueT >
void	listen (EventContext &eventContext, Observed< ValueT > const &obs, std::function< void(ValueT const &)> onEvent)

template<typename ValueT > requires std::is_scalar_v<ValueT>
void	listen (EventContext &eventContext, Observed< ValueT > const &obs, std::function< void(ValueT)> onEvent)

template<typename ValueT , typename FunctionT > requires ( (std::invocable<FunctionT, ValueT const&> \|\| std::invocable<FunctionT, ValueT>) && !Detail::IsStdFunction<FunctionT>::value)
void	listen (EventContext &eventContext, Observed< ValueT > const &obs, FunctionT &&onEvent)

template<typename ValueT >
void	listen (EventContext &eventContext, std::shared_ptr< Observed< ValueT > > const &obs, std::function< bool(ValueT const &)> onEvent)

template<typename ValueT > requires std::is_scalar_v<ValueT>
void	listen (EventContext &eventContext, std::shared_ptr< Observed< ValueT > > const &obs, std::function< bool(ValueT)> onEvent)

template<typename ValueT >
void	listen (EventContext &eventContext, std::shared_ptr< Observed< ValueT > > const &obs, std::function< void(ValueT const &)> onEvent)

template<typename ValueT > requires std::is_scalar_v<ValueT>
void	listen (EventContext &eventContext, std::shared_ptr< Observed< ValueT > > const &obs, std::function< void(ValueT)> onEvent)

template<typename ValueT , typename FunctionT > requires ( (std::invocable<FunctionT, ValueT const&> \|\| std::invocable<FunctionT, ValueT>) && !Detail::IsStdFunction<FunctionT>::value)
void	listen (EventContext &eventContext, std::shared_ptr< Observed< ValueT > > const &obs, FunctionT &&onEvent)

template<typename ValueT , typename FunctionT > requires ( (std::invocable<FunctionT, ValueT const&> \|\| std::invocable<FunctionT, ValueT>) && !Detail::IsStdFunction<FunctionT>::value)
void	listen (std::shared_ptr< Observed< ValueT > > const &obs, FunctionT &&onEvent)

template<typename ValueT , typename FunctionT > requires ( (std::invocable<FunctionT, ValueT const&> \|\| std::invocable<FunctionT, ValueT>) && !Detail::IsStdFunction<FunctionT>::value)
void	listen (Observed< ValueT > const &obs, FunctionT &&onEvent)

template<typename T > requires Incrementable<T>
ModifiableObserved< T > &	operator++ (ModifiableObserved< T > &observedValue)

template<typename T > requires Incrementable<T>
T	operator++ (ModifiableObserved< T > &observedValue, int)

template<typename T >
auto	operator-- (ModifiableObserved< T > &observedValue) -> ModifiableObserved< Detail::PickFirst_t< T, decltype(--std::declval< T >())> > &

template<typename T >
auto	operator-- (ModifiableObserved< T > &observedValue, int) -> Detail::PickFirst_t< T, decltype(std::declval< T >() --)>

template<typename... ObservedValues>
	ObservedValueCombinator (ObservedValues &&...) -> ObservedValueCombinator< std::decay_t< Detail::ObservedAddReference_t< ObservedValues > >... >

template<typename... ObservedValues>
	ObservedValueCombinator (std::tuple< Detail::ObservedAddReference_t< ObservedValues >... >) -> ObservedValueCombinator< std::decay_t< Detail::ObservedAddReference_t< ObservedValues > >... >

template<typename... ObservedValues> requires (IsObservedLike<ObservedValues> && ...)
ObservedValueCombinator< std::decay_t< Detail::ObservedAddReference_t< ObservedValues > >... >	observe (ObservedValues &&... observedValues)

template<typename ObservedValue > requires (IsObserved<ObservedValue>)
ObservedRange< ObservedValue >	range (ObservedValue &observedValues)

template<typename ObservedValue > requires (IsObserved<ObservedValue>)
ObservedRange< const ObservedValue >	range (ObservedValue const &observedValues)

template<typename ContainerT , typename... Observed>
UnoptimizedRange< IteratorAccessor< ContainerT const >, std::decay_t< Detail::ObservedAddReference_t< Observed > >... >	range (ContainerT const &container, Observed &&... observed)

template<typename ContainerT , typename... Observed>
UnoptimizedRange< IteratorAccessor< ContainerT >, std::decay_t< Detail::ObservedAddReference_t< Observed > >... >	range (ContainerT &container, Observed &&... observed)

template<typename ContainerT >
UnoptimizedRange< IteratorAccessor< ContainerT > >	range (ContainerT &container)

template<typename ContainerT >
UnoptimizedRange< IteratorAccessor< ContainerT const > >	range (ContainerT const &container)

void	throttle (int milliseconds, std::function< void()> toWrap, std::function< void(ThrottledFunction &&)> callback, bool callWhenReady=false)
	Creates a function that can be used to call a function at most once during the specified interval.

void	setInterval (int milliseconds, std::function< void()> toWrap, std::function< void(TimerHandle &&)> callback)
	Creates a new timer that calls "toWrap" every "milliseconds" milliseconds.

void	setTimeout (int milliseconds, std::function< void()> toWrap, std::function< void(TimerHandle)> callback)
	Creates a new delayed function that calls "toWrap" after "milliseconds" milliseconds.

Attribute &&	operator! (Attribute &&attribute)

auto	renderElement (Renderer const &gen, auto &element, auto const &htmlElement)

static auto	nil ()

void	makeResizeable (Nui::val const &element, ResizeableEdge edge=ResizeableEdge::Right)

void	openFile (char const *filename, std::ios_base::openmode mode, std::function< void(std::optional< AsyncFile > &&)> onOpen)

void	openFile (std::string const &filename, std::ios_base::openmode mode, std::function< void(std::optional< AsyncFile > &&)> onOpen)

void	openFile (std::filesystem::path const &filename, std::ios_base::openmode mode, std::function< void(std::optional< AsyncFile > &&)> onOpen)

template<typename U > requires (IsObserved<std::decay_t<U>>)
Detail::Property< std::decay_t< U > >	property (U &val)

template<typename U > requires (IsWeakObserved<std::decay_t<U>>)
Detail::Property< std::decay_t< U > >	property (U &&val)

template<typename U > requires (IsSharedObserved<std::decay_t<U>>)
Detail::Property< typename std::decay_t< U >::weak_type >	property (U const &val)

template<typename U > requires (std::invocable<U, Nui::val>)
Detail::Property< std::function< void(Nui::val)> >	property (U val)

template<typename U > requires (std::invocable<U>)
Detail::Property< std::function< void()> >	property (U val)

template<typename U > requires (!IsObservedLike<std::decay_t<U>> && !std::invocable<U> && !std::invocable<U, Nui::val>)
Detail::Property< std::decay_t< U > >	property (U val)

template<typename RendererType , typename... ObservedValues>
ObservedValueCombinatorWithPropertyGenerator< RendererType, ObservedValues... >	property (ObservedValueCombinatorWithGenerator< RendererType, ObservedValues... > combinator)

template<typename SlotId >
ElementRenderer	delocalizedSlot (SlotId slot, Delocalized< SlotId > &delocalizedElement, std::vector< Attribute > wrapperAttributes={}, ElementRenderer alternative=Elements::div{Attributes::style="display: none"}())

ElementRenderer	delocalizedSlot (char const *slot, Delocalized< std::string > &delocalizedElement, std::vector< Attribute > wrapperAttributes={}, ElementRenderer alternative=Elements::div{Attributes::style="display: none"}())

void	listenToFragmentChanges (Observed< std::string > &fragment)
	Listens to fragment changes and changes the attached observed.

template<class F , class... Args>
emscripten::val	bind (F &&f, Args &&... args)
	Equivalent of std::bind returning a javascript functor.

	JS_BIND_FUNCTION_TYPES ()

ElementRenderer	stabilize (StableElement &stableElement, ElementRenderer const &encapsulatedRenderer)
	Stabilizes an element, so that it is not re-rendered on every render.

template<typename T , class Bases = boost::describe::describe_bases<T, boost::describe::mod_any_access>, class Members = boost::describe::describe_members<T, boost::describe::mod_any_access>, class Enable = std::enable_if_t<!std::is_union_v<T>>>
Nui::val	convertToVal (T const &obj)
	Converts a boost described class/struct to a Nui::val object.

template<typename T >
Nui::val	convertToVal (std::optional< T > const &option)
	Converts an optional<T> to a Nui::val.

template<typename T > requires Fundamental<T>
Nui::val	convertToVal (T const &value)
	Converts fundamental types to Nui::val.

Nui::val	convertToVal (std::string const &value)
	Converts string to Nui::val.

Nui::val	convertToVal (std::filesystem::path const &value)
	Converts a filesystem path to Nui::val.

Nui::val	convertToVal (Nui::val value)
	Copy for val.

Nui::val	convertToVal (char const *value)
	Converts a C-style string to Nui::val.

Nui::val	convertToVal (std::string_view value)
	Converts a string_view to Nui::val.

template<typename T >
Nui::val	convertToVal (std::vector< T > const &vector)
	Converts a vector to Nui::val.

template<typename T >
Nui::val	convertToVal (Observed< T > const &observed)
	Converts an Observed<T> to Nui::val.

template<typename T >
Nui::val	convertToVal (std::unordered_map< std::string, T > const &map)
	Converts an unordered_map to Nui::val.

template<typename T >
Nui::val	convertToVal (std::map< std::string, T > const &map)
	Converts a map to Nui::val.

template<typename T >
Nui::val	convertToVal (std::unique_ptr< T > const &ptr)
	Converts a unique pointer to Nui::val.

template<typename T >
Nui::val	convertToVal (std::shared_ptr< T > const &ptr)
	Converts a shared pointer to Nui::val.

template<typename T > requires Detail::HasToVal<T>
Nui::val	convertToVal (T const &value)
	Converts anything that a "to_val" function is provided for found by ADL.

Nui::val	convertToVal (long long)

Nui::val	convertToVal (unsigned long long)

Nui::val	convertToVal (std::monostate)
	Converts a monostate to Nui::val (interpreted as undefined)

template<typename... Ts>
Nui::val	convertToVal (std::variant< Ts... > const &variant)
	Converts a variant to Nui::val by converting the currently held type.

template<typename T , class Bases , class Members > requires (!std::is_union_v<T>)
void	convertFromVal (Nui::val const &val, T &obj)
	Converts a Nui::val to a class/struct object.

template<typename T , class Members > requires (!std::is_union_v<T> && !boost::describe::has_describe_bases<T>::value)
void	convertFromVal (Nui::val const &val, T &obj)
	Converts a Nui::val to a class/struct object.

template<typename T > requires Fundamental<T>
void	convertFromVal (Nui::val const &val, T &value)
	Converts a Nui::val to a fundamental type.

void	convertFromVal (Nui::val const &val, std::string &str)
	Converts a Nui::val to a std::string.

template<typename T >
void	convertFromVal (Nui::val const &val, std::optional< T > &option)
	Converts a Nui::val to a std::optional.

void	convertFromVal (Nui::val const &val, std::filesystem::path &value)
	Converts a Nui::val to a std::filesystem::path.

void	convertFromVal (Nui::val const &val, Nui::val &value)
	Converts a Nui::val to a Nui::val (copy).

template<typename T >
void	convertFromVal (Nui::val const &val, std::vector< T > &vector)
	Converts a Nui::val to a std::vector.

template<typename T > requires Fundamental<T>
void	convertFromVal (Nui::val const &val, std::vector< T > &vector)
	Converts a Nui::val to a std::vector of fundamentals.

template<typename T >
void	convertFromVal (Nui::val const &val, Observed< T > &observed)
	Converts a Nui::val to an Observed<T>.

template<typename T >
void	convertFromVal (Nui::val const &val, std::unordered_map< std::string, T > &map)
	Converts a Nui::val to a std::unordered_map.

template<typename T > requires Detail::HasFromVal<T>
void	convertFromVal (Nui::val const &val, T &value)
	Converts a Nui::val to a type that has a "from_val" function provided found by ADL.

void	convertFromVal (Nui::val const &, long long)

void	convertFromVal (Nui::val const &val, unsigned long long &value)

template<typename T , class Bases = boost::describe::describe_bases<T, boost::describe::mod_any_access>, class Members = boost::describe::describe_members<T, boost::describe::mod_any_access>> requires (!std::is_union_v<T> && boost::describe::has_describe_bases<T>::value)
void	convertFromVal (Nui::val const &val, T &obj)
	Converts a Nui::val to a class/struct object.

	BOOST_DESCRIBE_STRUCT (FetchOptions,(),(method, headers, body, verbose, followRedirects, maxRedirects, autoReferer, dontDecodeBody, verifyPeer, verifyHost))

	BOOST_DESCRIBE_STRUCT (FetchResponse,(),(curlCode, status, proxyStatus, downloadSize, redirectUrl, body, headers))

void	assertImpl (bool condition, const char *message)

template<unsigned N>
	FixedString (char const (&)[N]) -> FixedString< N - 1 >

template<unsigned... Length>
constexpr auto	fixConcat (const char(&... strings)[Length])
	Allows for compile-time string concatenation.

template<unsigned N>
constexpr auto	fixToLower (FixedString< N > base)

template<unsigned N>
constexpr auto	fixToLower (char const (&str)[N])

template<typename ContainerT >
	IteratorAccessor (ContainerT const &) -> IteratorAccessor< const ContainerT >

template<typename ContainerT >
	IteratorAccessor (ContainerT &) -> IteratorAccessor< ContainerT >

template<typename... Ts>
	overloaded (Ts...) -> overloaded< Ts... >

template<typename FuncT , typename... Types>
void	tupleForEach (std::tuple< Types... > &t, FuncT &&func)

template<typename FuncT , typename... Types>
void	tupleForEach (std::tuple< Types... > const &t, FuncT &&func)

template<typename Utf16StringType , typename Utf8StringType > requires (Detail::IsStringCharTypeUtf16Compatible<Utf16StringType>) && (Detail::IsStringCharTypeUtf8Compatible<Utf8StringType>)
Utf16StringType	utf8ToUtf16 (Utf8StringType const &str)

template<typename Utf16StringType , typename Utf8StringType > requires (Detail::IsStringCharTypeUtf16Compatible<Utf16StringType>) && (Detail::IsStringCharTypeUtf8Compatible<Utf8StringType>)
Utf8StringType	utf16ToUtf8 (Utf16StringType const &str)

template<typename... VariantTypes, typename... VisitFunctionTypes>
auto	visitOverloaded (std::variant< VariantTypes... > const &variant, VisitFunctionTypes &&... visitFunctions)

template<typename... VariantTypes, typename... VisitFunctionTypes>
auto	visitOverloaded (std::variant< VariantTypes... > &&variant, VisitFunctionTypes &&... visitFunctions)

Microsoft::WRL::ComPtr< ICoreWebView2EnvironmentOptions >	webView2EnvironmentOptionsFromOptions (WindowOptions const &options)

std::unordered_map< std::string, std::string >	getEnvironmentVariables ()

template<typename T >
void	swap (GObjectReference< T > &lhs, GObjectReference< T > &rhs)

template<typename T , typename U >
bool	operator== (GObjectReference< T > const &lhs, GObjectReference< U > const &rhs)

template<typename T , typename U >
bool	operator== (GObjectReference< T > const &lhs, T *rhs)

template<typename T , typename U >
bool	operator== (T *lhs, GObjectReference< U > const &rhs)

template<typename T , typename U >
bool	operator!= (GObjectReference< T > const &lhs, GObjectReference< U > const &rhs)

template<typename T , typename U >
bool	operator!= (GObjectReference< T > const &lhs, T *rhs)

template<typename T , typename U >
bool	operator!= (T *lhs, GObjectReference< U > const &rhs)

template<typename T , typename U >
GObjectReference< T >	static_pointer_cast (GObjectReference< U > const &ptr)

template<typename T , typename U >
GObjectReference< T >	dynamic_pointer_cast (GObjectReference< U > const &ptr)

void	registerEnvironmentVariables (Nui::RpcHub const &hub)

	NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE (FetchOptions, method, headers, body, verbose, followRedirects, maxRedirects, autoReferer, dontDecodeBody, verifyPeer, verifyHost)

	NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE (FetchResponse, curlCode, status, proxyStatus, downloadSize, redirectUrl, body, headers) void registerFetch(Nui

void	registerFetch (Nui::RpcHub const &hub)

void	registerFile (Nui::RpcHub &hub)

void	registerScreen (Nui::RpcHub const &hub)

void	registerThrottle (Nui::RpcHub &hub)

void	registerTimer (Nui::RpcHub &hub)

CustomSchemeResponse	folderMappingResponseFromRequest (CustomSchemeRequest const &req, HostNameMappingInfo const &hostNameMappingInfo)

Variables
thread_local EventContext	globalEventContext

constexpr CustomEventContextFlag_t	CustomEventContextFlag {}

constexpr auto	RegularHtmlElementBridge

constexpr auto	SvgElementBridge

constexpr auto	TextElementBridge

constexpr auto	CommentElementBridge

template<typename T >
constexpr bool	IsTuple_v = IsTuple<std::decay_t<T>>::value

Typedef Documentation

◆ Console

using Nui::Console = typedef WebApi::Console

◆ ElementRenderer

using Nui::ElementRenderer = typedef std::function<std::shared_ptr<Dom::Element>(Dom::Element&, Renderer const&)>

◆ ExtractValueType_t

template<typename T >

using Nui::ExtractValueType_t = typedef typename ExtractValueType<T>::type

◆ UnpackObserved_t

template<typename T >

using Nui::UnpackObserved_t = typedef typename UnpackObserved<T>::type

◆ Url

using Nui::Url = typedef Roar::Url

◆ val

using Nui::val = typedef emscripten::val

Enumeration Type Documentation

◆ HostResourceAccessKind

enum class Nui::HostResourceAccessKind

strong

Enumerator
Deny
Allow
DenyCors

◆ NuiCoreWebView2WebResourceContext

enum class Nui::NuiCoreWebView2WebResourceContext

strong

Enumerator
All
Document
Stylesheet
Image
Media
Font
Script
XmlHttpRequest
Fetch
TextTrack
EventSource
WebSocket
Manifest
SignedExchange
Ping
CspViolationReport
Other

◆ RangeOperationType

enum Nui::RangeOperationType

Enumerator
Keep
Modify
Insert
Erase

◆ RendererType

enum class Nui::RendererType

strong

Enumerator
Append
Fragment
Insert
Replace
Inplace
Emplace

◆ ResizeableEdge

enum class Nui::ResizeableEdge

strong

Enumerator
Right
Bottom
Top

◆ WebViewHint

enum class Nui::WebViewHint : int

strong

Enumerator
WEBVIEW_HINT_NONE
WEBVIEW_HINT_MIN
WEBVIEW_HINT_MAX
WEBVIEW_HINT_FIXED

Function Documentation

◆ assertImpl()

void Nui::assertImpl	(	bool	condition,
		const char *	message
	)

inline

◆ bind()

template<class F , class... Args>

emscripten::val Nui::bind	(	F &&	f,
		Args &&...	args
	)

Equivalent of std::bind returning a javascript functor.

Parameters

f	The lambda, function, member function to bind
args

Returns: An emscripten::val representing a javascript functor with it's this-scope bound correctly. It can be called from js or c++ with the call operator ( i.e. operator() ).

◆ BOOST_DESCRIBE_STRUCT() [1/2]

Nui::BOOST_DESCRIBE_STRUCT	(	FetchOptions	,
		()	,
		(method, headers, body, verbose, followRedirects, maxRedirects, autoReferer, dontDecodeBody, verifyPeer, verifyHost)
	)

◆ BOOST_DESCRIBE_STRUCT() [2/2]

Nui::BOOST_DESCRIBE_STRUCT	(	FetchResponse	,
		()	,
		(curlCode, status, proxyStatus, downloadSize, redirectUrl, body, headers)
	)

◆ convertFromVal() [1/15]

void Nui::convertFromVal	(	Nui::val const &	,
		long long
	)

inline

◆ convertFromVal() [2/15]

void Nui::convertFromVal	(	Nui::val const &	val,
		Nui::val &	value
	)

inline

Converts a Nui::val to a Nui::val (copy).

Parameters

val	The val to convert.
value	The variable to store the converted value.

◆ convertFromVal() [3/15]

template<typename T >

void Nui::convertFromVal	(	Nui::val const &	val,
		Observed< T > &	observed
	)

Converts a Nui::val to an Observed<T>.

Template Parameters

T	The type of the observed value.

Parameters

val	The val to convert.
observed	The variable to store the converted value.

◆ convertFromVal() [4/15]

void Nui::convertFromVal	(	Nui::val const &	val,
		std::filesystem::path &	value
	)

inline

Converts a Nui::val to a std::filesystem::path.

Parameters

val	The val to convert.
value	The variable to store the converted value.

◆ convertFromVal() [5/15]

template<typename T >

void Nui::convertFromVal	(	Nui::val const &	val,
		std::optional< T > &	option
	)

Converts a Nui::val to a std::optional.

Template Parameters

T	The wrapped type of the optional.

Parameters

val	The val to convert.
option	The variable to store the converted value.

◆ convertFromVal() [6/15]

void Nui::convertFromVal	(	Nui::val const &	val,
		std::string &	str
	)

inline

Converts a Nui::val to a std::string.

Parameters

val	The val to convert.
str	The variable to store the converted value.

◆ convertFromVal() [7/15]

template<typename T >

void Nui::convertFromVal	(	Nui::val const &	val,
		std::unordered_map< std::string, T > &	map
	)

Converts a Nui::val to a std::unordered_map.

Template Parameters

T	The type of the map values.

Parameters

val	The val to convert.
map	The variable to store the converted value.

◆ convertFromVal() [8/15]

template<typename T >

void Nui::convertFromVal	(	Nui::val const &	val,
		std::vector< T > &	vector
	)

Converts a Nui::val to a std::vector.

Template Parameters

T	The type of the vector elements.

Parameters

val	The val to convert.
vector	The variable to store the converted value.

◆ convertFromVal() [9/15]

template<typename T >
requires Fundamental<T>

void Nui::convertFromVal	(	Nui::val const &	val,
		std::vector< T > &	vector
	)

Converts a Nui::val to a std::vector of fundamentals.

Template Parameters

T	The type of the vector elements.

Parameters

val	The val to convert.
vector	The variable to store the converted value.

◆ convertFromVal() [10/15]

template<typename T , class Bases , class Members >
requires (!std::is_union_v<T>)

void Nui::convertFromVal	(	Nui::val const &	val,
		T &	obj
	)

Converts a Nui::val to a class/struct object.

Template Parameters

T	The type of the object.
Bases	The base classes of the object.
Members	The members of the object.

◆ convertFromVal() [11/15]

template<typename T , class Members >
requires (!std::is_union_v<T> && !boost::describe::has_describe_bases<T>::value)

void Nui::convertFromVal	(	Nui::val const &	val,
		T &	obj
	)

Converts a Nui::val to a class/struct object.

Template Parameters

T	The type of the object.
Members	The boost describe members of the object.

◆ convertFromVal() [12/15]

template<typename T , class Bases = boost::describe::describe_bases<T, boost::describe::mod_any_access>, class Members = boost::describe::describe_members<T, boost::describe::mod_any_access>>
requires (!std::is_union_v<T> && boost::describe::has_describe_bases<T>::value)

void Nui::convertFromVal	(	Nui::val const &	val,
		T &	obj
	)

Converts a Nui::val to a class/struct object.

Template Parameters

T	The type of the object.
Bases	The base classes of the object.
Members	The members of the object.

◆ convertFromVal() [13/15]

template<typename T >
requires Fundamental<T>

void Nui::convertFromVal	(	Nui::val const &	val,
		T &	value
	)

Converts a Nui::val to a fundamental type.

Template Parameters

T	The fundamental type.

Parameters

val	The val to convert.
value	The variable to store the converted value.

◆ convertFromVal() [14/15]

template<typename T >
requires Detail::HasFromVal<T>

void Nui::convertFromVal	(	Nui::val const &	val,
		T &	value
	)

Converts a Nui::val to a type that has a "from_val" function provided found by ADL.

Template Parameters

T	The type of the value.

Parameters

val	The val to convert.
value	The variable to store the converted value.

◆ convertFromVal() [15/15]

void Nui::convertFromVal	(	Nui::val const &	val,
		unsigned long long &	value
	)

inline

◆ convertToVal() [1/19]

Nui::val Nui::convertToVal ( char const * value )

inline

Converts a C-style string to Nui::val.

Parameters

value The C-style string to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [2/19]

Nui::val Nui::convertToVal ( long long )

inline

◆ convertToVal() [3/19]

Nui::val Nui::convertToVal ( Nui::val value )

inline

Copy for val.

Useful if a class itself contains a val.

Parameters

value The val to copy.

Returns: Nui::val The copied val.

◆ convertToVal() [4/19]

template<typename T >

Nui::val Nui::convertToVal ( Observed< T > const & observed )

Converts an Observed<T> to Nui::val.

Template Parameters

T	The type of the observed value.

Parameters

observed The observed value to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [5/19]

Nui::val Nui::convertToVal ( std::filesystem::path const & value )

inline

Converts a filesystem path to Nui::val.

Parameters

value The filesystem path to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [6/19]

template<typename T >

Nui::val Nui::convertToVal ( std::map< std::string, T > const & map )

Converts a map to Nui::val.

Template Parameters

T	The value type of the map.

Parameters

map	The map to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [7/19]

Nui::val Nui::convertToVal ( std::monostate )

inline

Converts a monostate to Nui::val (interpreted as undefined)

Returns: Nui::val javascript undefined value.

◆ convertToVal() [8/19]

template<typename T >

Nui::val Nui::convertToVal ( std::optional< T > const & option )

Converts an optional<T> to a Nui::val.

Template Parameters

T	The wrapped type of the optional

Parameters

option The optional value to convert

Returns: Nui::val The converted val

◆ convertToVal() [9/19]

template<typename T >

Nui::val Nui::convertToVal ( std::shared_ptr< T > const & ptr )

Converts a shared pointer to Nui::val.

Template Parameters

T	The type of the pointed-to object.

Parameters

ptr	The shared pointer to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [10/19]

Nui::val Nui::convertToVal ( std::string const & value )

inline

Converts string to Nui::val.

Parameters

value The string to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [11/19]

Nui::val Nui::convertToVal ( std::string_view value )

inline

Converts a string_view to Nui::val.

Parameters

view	The string_view to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [12/19]

template<typename T >

Nui::val Nui::convertToVal ( std::unique_ptr< T > const & ptr )

Converts a unique pointer to Nui::val.

Template Parameters

T	The type of the pointed-to object.

Parameters

ptr	The unique pointer to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [13/19]

template<typename T >

Nui::val Nui::convertToVal ( std::unordered_map< std::string, T > const & map )

Converts an unordered_map to Nui::val.

Template Parameters

T	The value type of the map.

Parameters

map	The map to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [14/19]

template<typename... Ts>

Nui::val Nui::convertToVal ( std::variant< Ts... > const & variant )

Converts a variant to Nui::val by converting the currently held type.

Template Parameters

Ts

Parameters

variant

Returns: Nui::val

◆ convertToVal() [15/19]

template<typename T >

Nui::val Nui::convertToVal ( std::vector< T > const & vector )

Converts a vector to Nui::val.

Template Parameters

T	The element type of the vector.

Parameters

vector The vector to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [16/19]

template<typename T , class Bases = boost::describe::describe_bases<T, boost::describe::mod_any_access>, class Members = boost::describe::describe_members<T, boost::describe::mod_any_access>, class Enable = std::enable_if_t<!std::is_union_v<T>>>

Nui::val Nui::convertToVal ( T const & obj )

Converts a boost described class/struct to a Nui::val object.

Template Parameters

T	The class type
Bases	Boost describe bases
Members	Boost describe members
Enable	Used to disable unions for this function

Parameters

obj	The object to convert

Returns: Returns the val.

◆ convertToVal() [17/19]

template<typename T >
requires Fundamental<T>

Nui::val Nui::convertToVal ( T const & value )

Converts fundamental types to Nui::val.

Template Parameters

T	The fundamental type

Parameters

value The value to convert

Returns: Nui::val The converted val

◆ convertToVal() [18/19]

template<typename T >
requires Detail::HasToVal<T>

Nui::val Nui::convertToVal ( T const & value )

Converts anything that a "to_val" function is provided for found by ADL.

Template Parameters

T	The type of the object.

Parameters

obj	The object to convert.

Returns: Nui::val The converted val.

◆ convertToVal() [19/19]

Nui::val Nui::convertToVal ( unsigned long long )

inline

◆ delocalizedSlot() [1/2]

ElementRenderer Nui::delocalizedSlot	(	char const *	slot,
		Delocalized< std::string > &	delocalizedElement,
		std::vector< Attribute >	wrapperAttributes = `{}`,
		ElementRenderer	alternative = `Elements::div{Attributes::style = "display: none"}()`
	)

inline

◆ delocalizedSlot() [2/2]

template<typename SlotId >

ElementRenderer Nui::delocalizedSlot	(	SlotId	slot,
		Delocalized< SlotId > &	delocalizedElement,
		std::vector< Attribute >	wrapperAttributes = `{}`,
		ElementRenderer	alternative = `Elements::div{Attributes::style = "display: none"}()`
	)

◆ dynamic_pointer_cast()

template<typename T , typename U >

GObjectReference< T > Nui::dynamic_pointer_cast ( GObjectReference const & ptr )

◆ fixConcat()

template<unsigned... Length>

constexpr auto Nui::fixConcat ( const char(&... strings)[Length] )

constexpr

Allows for compile-time string concatenation.

Use very sparingly.

◆ FixedString()

template<unsigned N>

Nui::FixedString ( char const(&)[N] ) -> FixedString< N - 1 >

◆ fixToLower() [1/2]

template<unsigned N>

constexpr auto Nui::fixToLower ( char const (&) str[N] )

constexpr

◆ fixToLower() [2/2]

template<unsigned N>

constexpr auto Nui::fixToLower ( FixedString< N > base )

constexpr

◆ folderMappingResponseFromRequest()

CustomSchemeResponse Nui::folderMappingResponseFromRequest	(	CustomSchemeRequest const &	req,
		HostNameMappingInfo const &	hostNameMappingInfo
	)

◆ getEnvironmentVariables() [1/2]

std::unordered_map< std::string, std::string > Nui::getEnvironmentVariables ( )

◆ getEnvironmentVariables() [2/2]

void Nui::getEnvironmentVariables ( std::function< void(std::unordered_map< std::string, std::string > &&)> callback )

◆ IteratorAccessor() [1/2]

template<typename ContainerT >

Nui::IteratorAccessor ( ContainerT & ) -> IteratorAccessor< ContainerT >

◆ IteratorAccessor() [2/2]

template<typename ContainerT >

Nui::IteratorAccessor ( ContainerT const & ) -> IteratorAccessor< const ContainerT >

◆ JS_BIND_FUNCTION_TYPES()

Nui::JS_BIND_FUNCTION_TYPES ( )

◆ listen() [1/12]

template<typename ValueT , typename FunctionT >
requires ( (std::invocable<FunctionT, ValueT const&> || std::invocable<FunctionT, ValueT>) && !Detail::IsStdFunction<FunctionT>::value)

void Nui::listen	(	EventContext &	eventContext,
		Observed< ValueT > const &	obs,
		FunctionT &&	onEvent
	)

◆ listen() [2/12]

template<typename ValueT >

void Nui::listen	(	EventContext &	eventContext,
		Observed< ValueT > const &	obs,
		std::function< bool(ValueT const &)>	onEvent
	)

◆ listen() [3/12]

template<typename ValueT >
requires std::is_scalar_v<ValueT>

void Nui::listen	(	EventContext &	eventContext,
		Observed< ValueT > const &	obs,
		std::function< bool(ValueT)>	onEvent
	)

◆ listen() [4/12]

template<typename ValueT >

void Nui::listen	(	EventContext &	eventContext,
		Observed< ValueT > const &	obs,
		std::function< void(ValueT const &)>	onEvent
	)

◆ listen() [5/12]

template<typename ValueT >
requires std::is_scalar_v<ValueT>

void Nui::listen	(	EventContext &	eventContext,
		Observed< ValueT > const &	obs,
		std::function< void(ValueT)>	onEvent
	)

◆ listen() [6/12]

template<typename ValueT , typename FunctionT >
requires ( (std::invocable<FunctionT, ValueT const&> || std::invocable<FunctionT, ValueT>) && !Detail::IsStdFunction<FunctionT>::value)

void Nui::listen	(	EventContext &	eventContext,
		std::shared_ptr< Observed< ValueT > > const &	obs,
		FunctionT &&	onEvent
	)

◆ listen() [7/12]

template<typename ValueT >

void Nui::listen	(	EventContext &	eventContext,
		std::shared_ptr< Observed< ValueT > > const &	obs,
		std::function< bool(ValueT const &)>	onEvent
	)

◆ listen() [8/12]

template<typename ValueT >
requires std::is_scalar_v<ValueT>

void Nui::listen	(	EventContext &	eventContext,
		std::shared_ptr< Observed< ValueT > > const &	obs,
		std::function< bool(ValueT)>	onEvent
	)

◆ listen() [9/12]

template<typename ValueT >

void Nui::listen	(	EventContext &	eventContext,
		std::shared_ptr< Observed< ValueT > > const &	obs,
		std::function< void(ValueT const &)>	onEvent
	)

◆ listen() [10/12]

template<typename ValueT >
requires std::is_scalar_v<ValueT>

void Nui::listen	(	EventContext &	eventContext,
		std::shared_ptr< Observed< ValueT > > const &	obs,
		std::function< void(ValueT)>	onEvent
	)

◆ listen() [11/12]

template<typename ValueT , typename FunctionT >
requires ( (std::invocable<FunctionT, ValueT const&> || std::invocable<FunctionT, ValueT>) && !Detail::IsStdFunction<FunctionT>::value)

void Nui::listen	(	Observed< ValueT > const &	obs,
		FunctionT &&	onEvent
	)

◆ listen() [12/12]

template<typename ValueT , typename FunctionT >
requires ( (std::invocable<FunctionT, ValueT const&> || std::invocable<FunctionT, ValueT>) && !Detail::IsStdFunction<FunctionT>::value)

void Nui::listen	(	std::shared_ptr< Observed< ValueT > > const &	obs,
		FunctionT &&	onEvent
	)

◆ listenToFragmentChanges()

void Nui::listenToFragmentChanges ( Observed< std::string > & fragment )

Listens to fragment changes and changes the attached observed.

◆ makeResizeable()

void Nui::makeResizeable	(	Nui::val const &	element,
		ResizeableEdge	edge = `ResizeableEdge::Right`
	)

◆ nil()

static auto Nui::nil ( )

static

◆ NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE() [1/2]

Nui::NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE	(	FetchOptions	,
		method	,
		headers	,
		body	,
		verbose	,
		followRedirects	,
		maxRedirects	,
		autoReferer	,
		dontDecodeBody	,
		verifyPeer	,
		verifyHost
	)

◆ NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE() [2/2]

Nui::NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE	(	FetchResponse	,
		curlCode	,
		status	,
		proxyStatus	,
		downloadSize	,
		redirectUrl	,
		body	,
		headers
	)

◆ observe()

template<typename... ObservedValues>
requires (IsObservedLike<ObservedValues> && ...)

ObservedValueCombinator< std::decay_t< Detail::ObservedAddReference_t< ObservedValues > >... > Nui::observe ( ObservedValues &&... observedValues )

◆ ObservedValueCombinator() [1/2]

template<typename... ObservedValues>

Nui::ObservedValueCombinator ( ObservedValues && ... ) -> ObservedValueCombinator< std::decay_t< Detail::ObservedAddReference_t< ObservedValues > >... >

◆ ObservedValueCombinator() [2/2]

template<typename... ObservedValues>

Nui::ObservedValueCombinator ( std::tuple< Detail::ObservedAddReference_t< ObservedValues >... > ) -> ObservedValueCombinator< std::decay_t< Detail::ObservedAddReference_t< ObservedValues > >... >

◆ openFile() [1/3]

void Nui::openFile	(	char const *	filename,
		std::ios_base::openmode	mode,
		std::function< void(std::optional< AsyncFile > &&)>	onOpen
	)

◆ openFile() [2/3]

void Nui::openFile	(	std::filesystem::path const &	filename,
		std::ios_base::openmode	mode,
		std::function< void(std::optional< AsyncFile > &&)>	onOpen
	)

◆ openFile() [3/3]

void Nui::openFile	(	std::string const &	filename,
		std::ios_base::openmode	mode,
		std::function< void(std::optional< AsyncFile > &&)>	onOpen
	)

◆ operator!()

Attribute && Nui::operator! ( Attribute && attribute )

inline

◆ operator!=() [1/3]

template<typename T , typename U >

bool Nui::operator!=	(	GObjectReference< T > const &	lhs,
		GObjectReference< U > const &	rhs
	)

◆ operator!=() [2/3]

template<typename T , typename U >

bool Nui::operator!=	(	GObjectReference< T > const &	lhs,
		T *	rhs
	)

◆ operator!=() [3/3]

template<typename T , typename U >

bool Nui::operator!=	(	T *	lhs,
		GObjectReference< U > const &	rhs
	)

◆ operator++() [1/2]

template<typename T >
requires Incrementable<T>

ModifiableObserved< T > & Nui::operator++ ( ModifiableObserved< T > & observedValue )

inline

◆ operator++() [2/2]

template<typename T >
requires Incrementable<T>

T Nui::operator++	(	ModifiableObserved< T > &	observedValue,
		int
	)

inline

◆ operator--() [1/2]

template<typename T >

auto Nui::operator-- ( ModifiableObserved< T > & observedValue ) -> ModifiableObserved<Detail::PickFirst_t<T, decltype(--std::declval<T>())>>&

inline

◆ operator--() [2/2]

template<typename T >

auto Nui::operator--	(	ModifiableObserved< T > &	observedValue,
		int
	)		-> Detail::PickFirst_t<T, decltype(std::declval<T>()--)>

inline

◆ operator==() [1/3]

template<typename T , typename U >

bool Nui::operator==	(	GObjectReference< T > const &	lhs,
		GObjectReference< U > const &	rhs
	)

◆ operator==() [2/3]

template<typename T , typename U >

bool Nui::operator==	(	GObjectReference< T > const &	lhs,
		T *	rhs
	)

◆ operator==() [3/3]

template<typename T , typename U >

bool Nui::operator==	(	T *	lhs,
		GObjectReference< U > const &	rhs
	)

◆ overloaded()

template<typename... Ts>

Nui::overloaded ( Ts... ) -> overloaded< Ts... >

◆ property() [1/7]

template<typename RendererType , typename... ObservedValues>

ObservedValueCombinatorWithPropertyGenerator< RendererType, ObservedValues... > Nui::property ( ObservedValueCombinatorWithGenerator< RendererType, ObservedValues... > combinator )

◆ property() [2/7]

template<typename U >
requires (IsWeakObserved<std::decay_t>)

Detail::Property< std::decay_t > Nui::property ( U && val )

◆ property() [3/7]

template<typename U >
requires (IsObserved<std::decay_t>)

Detail::Property< std::decay_t > Nui::property ( U & val )

◆ property() [4/7]

template<typename U >
requires (IsSharedObserved<std::decay_t>)

Detail::Property< typename std::decay_t::weak_type > Nui::property ( U const & val )

◆ property() [5/7]

template<typename U >
requires (std::invocable<U, Nui::val>)

Detail::Property< std::function< void(Nui::val)> > Nui::property ( U val )

◆ property() [6/7]

template<typename U >
requires (std::invocable)

Detail::Property< std::function< void()> > Nui::property ( U val )

◆ property() [7/7]

template<typename U >
requires (!IsObservedLike<std::decay_t> && !std::invocable && !std::invocable<U, Nui::val>)

Detail::Property< std::decay_t > Nui::property ( U val )

◆ range() [1/6]

template<typename ContainerT >

UnoptimizedRange< IteratorAccessor< ContainerT > > Nui::range ( ContainerT & container )

◆ range() [2/6]

template<typename ContainerT , typename... Observed>

UnoptimizedRange< IteratorAccessor< ContainerT >, std::decay_t< Detail::ObservedAddReference_t< Observed > >... > Nui::range	(	ContainerT &	container,
		Observed &&...	observed
	)

◆ range() [3/6]

template<typename ContainerT >

UnoptimizedRange< IteratorAccessor< ContainerT const > > Nui::range ( ContainerT const & container )

◆ range() [4/6]

template<typename ContainerT , typename... Observed>

UnoptimizedRange< IteratorAccessor< ContainerT const >, std::decay_t< Detail::ObservedAddReference_t< Observed > >... > Nui::range	(	ContainerT const &	container,
		Observed &&...	observed
	)

◆ range() [5/6]

template<typename ObservedValue >
requires (IsObserved<ObservedValue>)

ObservedRange< ObservedValue > Nui::range ( ObservedValue & observedValues )

◆ range() [6/6]

template<typename ObservedValue >
requires (IsObserved<ObservedValue>)

ObservedRange< const ObservedValue > Nui::range ( ObservedValue const & observedValues )

◆ registerEnvironmentVariables()

void Nui::registerEnvironmentVariables ( Nui::RpcHub const & hub )

◆ registerFetch()

void Nui::registerFetch ( Nui::RpcHub const & hub )

◆ registerFile()

void Nui::registerFile ( Nui::RpcHub & hub )

◆ registerScreen()

void Nui::registerScreen ( Nui::RpcHub const & hub )

◆ registerThrottle()

void Nui::registerThrottle ( Nui::RpcHub & hub )

◆ registerTimer()

void Nui::registerTimer ( Nui::RpcHub & hub )

◆ renderElement()

auto Nui::renderElement	(	Renderer const &	gen,
		auto &	element,
		auto const &	htmlElement
	)

◆ resolvePath()

std::filesystem::path Nui::resolvePath ( std::filesystem::path const & path )

Will replace prefixes like "~" and "%appdata%" with actual directories on linux and windows.

The percent values are case insensitive. ~ Linux: home. Windows: home userprofile% Linux: home. Windows: home appdata% Linux: home. Windows: CSIDL_APPDATA localappdata% Linux: home. Windows: CSIDL_APPDATA_LOCAL temp% Linux: /tmp. Windows: ${USER}\AppData\Local\Temp config_home% Linux: $XDG_CONFIG_HOME. Windows: CSIDL_APPDATA config_home2% Linux: $XDG_CONFIG_HOME. Windows: CSIDL_MYDOCUMENTS config_home3% Linux: $XDG_CONFIG_HOME. Windows: home state_home% Linux: $XDG_CONFIG_HOME. Windows: CSIDL_APPDATA state_home2% Linux: $XDG_CONFIG_HOME. Windows: CSIDL_MYDOCUMENTS state_home3% Linux: $XDG_CONFIG_HOME. Windows: home data_home% Linux: $XDG_DATA_HOME. Windows: CSIDL_APPDATA data_home2% Linux: $XDG_DATA_HOME. Windows: CSIDL_MYDOCUMENTS data_home3% Linux: $XDG_DATA_HOME. Windows: home

Parameters

path

Returns: std::filesystem::path

◆ setInterval()

void Nui::setInterval	(	int	milliseconds,
		std::function< void()>	toWrap,
		std::function< void(TimerHandle &&)>	callback
	)

Creates a new timer that calls "toWrap" every "milliseconds" milliseconds.

This function is less accurate than the browser setInterval, because it has to traverse from backend to frontend. This is an alternative if you have trouble with ASYNCIFY and code running from setInterval. You should avoid using this function for small time intervals to avoid performance issues.

Parameters

milliseconds	The time between each call of the function.
toWrap	The function to call periodically.
callback	This callback receives the interval handle. The timer can be stopped using this handle.

◆ setTimeout()

void Nui::setTimeout	(	int	milliseconds,
		std::function< void()>	toWrap,
		std::function< void(TimerHandle)>	callback
	)

Creates a new delayed function that calls "toWrap" after "milliseconds" milliseconds.

This function is less accurate than the browser setTimeout, because it has to traverse from backend to frontend. This is an alternative if you have trouble with ASYNCIFY and code running from setTimeout. You should avoid using this function for small timeouts to avoid performance issues.

Parameters

milliseconds	The time to wait before calling the function.
toWrap	The function to call after the timeout.
callback	This callback receives the timeout handle. The timeout can be stopped using this handle.

◆ stabilize()

ElementRenderer Nui::stabilize	(	StableElement &	stableElement,
		ElementRenderer const &	encapsulatedRenderer
	)

Stabilizes an element, so that it is not re-rendered on every render.

Parameters

stableElement	A stable element handle held by the caller. Must not be destroyed before the associated ui.
encapsulatedRenderer	The renderer that should be rendered once and then stabilized.

Returns: ElementRenderer A renderer that renders the encapsulated renderer once and then stabilizes it.

◆ static_pointer_cast()

template<typename T , typename U >

GObjectReference< T > Nui::static_pointer_cast ( GObjectReference const & ptr )

◆ swap()

template<typename T >

void Nui::swap	(	GObjectReference< T > &	lhs,
		GObjectReference< T > &	rhs
	)

◆ throttle()

void Nui::throttle	(	int	milliseconds,
		std::function< void()>	toWrap,
		std::function< void(ThrottledFunction &&)>	callback,
		bool	callWhenReady = `false`
	)

Creates a function that can be used to call a function at most once during the specified interval.

You can imagine it as a std::call_once that is reset after the given time. This function is not very accurate, because of the back and forth travel time.

Parameters

milliseconds	The minimum time between each call of the function.
func	The function to call throttled.
callback	This callback receives the throttled function.
callWhenReady	call the function when ready if it was not during the wait interval.

◆ tupleForEach() [1/2]

template<typename FuncT , typename... Types>

void Nui::tupleForEach	(	std::tuple< Types... > &	t,
		FuncT &&	func
	)

◆ tupleForEach() [2/2]

template<typename FuncT , typename... Types>

void Nui::tupleForEach	(	std::tuple< Types... > const &	t,
		FuncT &&	func
	)

◆ utf16ToUtf8()

template<typename Utf16StringType , typename Utf8StringType >
requires (Detail::IsStringCharTypeUtf16Compatible<Utf16StringType>) && (Detail::IsStringCharTypeUtf8Compatible<Utf8StringType>)

Utf8StringType Nui::utf16ToUtf8 ( Utf16StringType const & str )

◆ utf8ToUtf16()

template<typename Utf16StringType , typename Utf8StringType >
requires (Detail::IsStringCharTypeUtf16Compatible<Utf16StringType>) && (Detail::IsStringCharTypeUtf8Compatible<Utf8StringType>)

Utf16StringType Nui::utf8ToUtf16 ( Utf8StringType const & str )

◆ visitOverloaded() [1/2]

template<typename... VariantTypes, typename... VisitFunctionTypes>

auto Nui::visitOverloaded	(	std::variant< VariantTypes... > &&	variant,
		VisitFunctionTypes &&...	visitFunctions
	)

◆ visitOverloaded() [2/2]

template<typename... VariantTypes, typename... VisitFunctionTypes>

auto Nui::visitOverloaded	(	std::variant< VariantTypes... > const &	variant,
		VisitFunctionTypes &&...	visitFunctions
	)

◆ webView2EnvironmentOptionsFromOptions()

Microsoft::WRL::ComPtr< ICoreWebView2EnvironmentOptions > Nui::webView2EnvironmentOptionsFromOptions ( WindowOptions const & options )

Variable Documentation

◆ CommentElementBridge

constexpr auto Nui::CommentElementBridge

constexpr

Initial value:

= HtmlElementBridge{
        .createElement =
            +[](HtmlElement const& element) {
                return Nui::val::global("document")
                    .call<Nui::val>("createComment", Nui::val{element.attributes()[0].stringData()});
            },
    }

◆ CustomEventContextFlag

constexpr CustomEventContextFlag_t Nui::CustomEventContextFlag {}

inlineconstexpr

◆ globalEventContext

thread_local EventContext Nui::globalEventContext

◆ IsTuple_v

template<typename T >

constexpr bool Nui::IsTuple_v = IsTuple<std::decay_t<T>>::value

constexpr

◆ RegularHtmlElementBridge

constexpr auto Nui::RegularHtmlElementBridge

constexpr

Initial value:

= HtmlElementBridge{
        .createElement =
            +[](HtmlElement const& element) {
                return Nui::val::global("document").call<Nui::val>("createElement", Nui::val{element.name()});
            },
    }

◆ SvgElementBridge

constexpr auto Nui::SvgElementBridge

constexpr

Initial value:

= HtmlElementBridge{
        .createElement =
            +[](HtmlElement const& element) {
                return Nui::val::global("document")
                    .call<Nui::val>(
                        "createElementNS",
                        Nui::val{std::string{"http://www.w3.org/2000/svg"}},
                        Nui::val{element.name()});
            },
    }

◆ TextElementBridge

constexpr auto Nui::TextElementBridge

constexpr

Initial value:

= HtmlElementBridge{
        .createElement =
            +[](HtmlElement const& element) {
                return Nui::val::global("document")
                    .call<Nui::val>("createTextNode", Nui::val{element.attributes()[0].stringData()});
            },
    }

Namespaces

Classes

Concepts

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ Console

◆ ElementRenderer

◆ ExtractValueType_t

◆ UnpackObserved_t

◆ Url

◆ val

Enumeration Type Documentation

◆ HostResourceAccessKind

◆ NuiCoreWebView2WebResourceContext

◆ RangeOperationType

◆ RendererType

◆ ResizeableEdge

◆ WebViewHint

Function Documentation

◆ assertImpl()

◆ bind()

◆ BOOST_DESCRIBE_STRUCT() [1/2]

◆ BOOST_DESCRIBE_STRUCT() [2/2]

◆ convertFromVal() [1/15]

◆ convertFromVal() [2/15]

◆ convertFromVal() [3/15]

◆ convertFromVal() [4/15]

◆ convertFromVal() [5/15]

◆ convertFromVal() [6/15]

◆ convertFromVal() [7/15]

◆ convertFromVal() [8/15]

◆ convertFromVal() [9/15]

◆ convertFromVal() [10/15]

◆ convertFromVal() [11/15]

◆ convertFromVal() [12/15]

◆ convertFromVal() [13/15]

◆ convertFromVal() [14/15]

◆ convertFromVal() [15/15]

◆ convertToVal() [1/19]

◆ convertToVal() [2/19]

◆ convertToVal() [3/19]

◆ convertToVal() [4/19]

◆ convertToVal() [5/19]

◆ convertToVal() [6/19]

◆ convertToVal() [7/19]

◆ convertToVal() [8/19]

◆ convertToVal() [9/19]

◆ convertToVal() [10/19]

◆ convertToVal() [11/19]

◆ convertToVal() [12/19]

◆ convertToVal() [13/19]

◆ convertToVal() [14/19]

◆ convertToVal() [15/19]

◆ convertToVal() [16/19]

◆ convertToVal() [17/19]

◆ convertToVal() [18/19]

◆ convertToVal() [19/19]

◆ delocalizedSlot() [1/2]

◆ delocalizedSlot() [2/2]

◆ dynamic_pointer_cast()

◆ fixConcat()

◆ FixedString()

◆ fixToLower() [1/2]

◆ fixToLower() [2/2]

◆ folderMappingResponseFromRequest()

◆ getEnvironmentVariables() [1/2]

◆ getEnvironmentVariables() [2/2]

◆ IteratorAccessor() [1/2]

◆ IteratorAccessor() [2/2]

◆ JS_BIND_FUNCTION_TYPES()

◆ listen() [1/12]

◆ listen() [2/12]

◆ listen() [3/12]

◆ listen() [4/12]

◆ listen() [5/12]

◆ listen() [6/12]

◆ listen() [7/12]