OreUI::RouteMatcher Class Reference

Inheritance diagram for OreUI::RouteMatcher:

Classes
struct	RouteEntry
struct	DefaultRouteEntry
struct	RedirectEntry

Public Types
using	IsActiveCallback = ::std::function<bool()>
using	OnMatchCallback = ::std::function<void(::std::string const&, ::OreUI::RouteHistoryAction)>
using	RouteRedirectComposer = ::std::function<::std::string(::std::string const&)>

Public Member Functions
virtual void	navigateTo (::std::string const &route, ::OreUI::RouteHistoryAction action) const
virtual::std::string	redirectIfNeeded (::std::string const &route) const
virtual bool	isSupported (::std::string const &route) const
virtual bool	areCompatible (::std::string const &routeA, ::std::string const &routeB) const
virtual ::std::optional<::std::string >	getDefaultRouteForFile (::std::string const &file) const
virtual::OreUI::RouteType	getRouteType (::std::string const &route) const
virtual::OreUI::RouteMode	getRouteMode (::std::string const &route) const
virtual::OreUI::RoutePrerequisite	getRoutePrerequisite (::std::string const &route) const
MCAPI ::std::optional<::OreUI::RouteMatcher::RedirectEntry >	_matchRedirect (::std::string const &route) const
MCAPI ::std::optional<::OreUI::RouteMatcher::RouteEntry >	_matchRoute (::std::string const &route) const
MCAPI void	addRedirect (::std::string const &path, ::std::function< bool()> isActiveCallback, ::std::function<::std::string(::std::string const &)> composer)
MCAPI void	addRoute (::std::string const &baseScreenId, ::std::string const &pattern, ::OreUI::RouteType type, ::OreUI::RouteMode mode, ::OreUI::RoutePrerequisite prerequisite, ::std::function< bool()> isActiveCallback, ::std::function< void(::std::string const &, ::OreUI::RouteHistoryAction)> matchCallback)
MCAPI void	$navigateTo (::std::string const &route, ::OreUI::RouteHistoryAction action) const
MCAPI::std::string	$redirectIfNeeded (::std::string const &route) const
MCAPI bool	$isSupported (::std::string const &route) const
MCAPI bool	$areCompatible (::std::string const &routeA, ::std::string const &routeB) const
MCAPI ::std::optional<::std::string >	$getDefaultRouteForFile (::std::string const &file) const
MCAPI::OreUI::RouteType	$getRouteType (::std::string const &route) const
MCAPI::OreUI::RouteMode	$getRouteMode (::std::string const &route) const
MCAPI::OreUI::RoutePrerequisite	$getRoutePrerequisite (::std::string const &route) const

Public Attributes
::ll::TypedStorage< 8, 24, ::std::vector<::OreUI::RouteMatcher::RouteEntry > >	mRoutes
::ll::TypedStorage< 8, 24, ::std::vector<::OreUI::RouteMatcher::DefaultRouteEntry > >	mDefaultRoutes
::ll::TypedStorage< 8, 24, ::std::vector<::OreUI::RouteMatcher::RedirectEntry > >	mRedirects

Member Function Documentation

navigateTo()

virtual void OreUI::RouteMatcher::navigateTo ( ::std::string const & route, ::OreUI::RouteHistoryAction action ) const

virtual

Implements OreUI::IRouteMatcher.

redirectIfNeeded()

virtual::std::string OreUI::RouteMatcher::redirectIfNeeded ( ::std::string const & route ) const

virtual

Implements OreUI::IRouteMatcher.

isSupported()

virtual bool OreUI::RouteMatcher::isSupported ( ::std::string const & route ) const

virtual

Implements OreUI::IRouteMatcher.

areCompatible()

virtual bool OreUI::RouteMatcher::areCompatible ( ::std::string const & routeA, ::std::string const & routeB ) const

virtual

Implements OreUI::IRouteMatcher.

getDefaultRouteForFile()

virtual ::std::optional<::std::string > OreUI::RouteMatcher::getDefaultRouteForFile ( ::std::string const & file ) const

virtual

Implements OreUI::IRouteMatcher.

getRouteType()

virtual::OreUI::RouteType OreUI::RouteMatcher::getRouteType ( ::std::string const & route ) const

virtual

Implements OreUI::IRouteMatcher.

getRouteMode()

virtual::OreUI::RouteMode OreUI::RouteMatcher::getRouteMode ( ::std::string const & route ) const

virtual

Implements OreUI::IRouteMatcher.

getRoutePrerequisite()

virtual::OreUI::RoutePrerequisite OreUI::RouteMatcher::getRoutePrerequisite ( ::std::string const & route ) const

virtual

Implements OreUI::IRouteMatcher.

_matchRedirect()

MCAPI ::std::optional<::OreUI::RouteMatcher::RedirectEntry > OreUI::RouteMatcher::_matchRedirect

(

::std::string const &

route

)

const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

_matchRoute()

MCAPI ::std::optional<::OreUI::RouteMatcher::RouteEntry > OreUI::RouteMatcher::_matchRoute

(

::std::string const &

route

)

const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

addRedirect()

MCAPI void OreUI::RouteMatcher::addRedirect	(	::std::string const &	path,
		::std::function< bool()>	isActiveCallback,
		::std::function<::std::string(::std::string const &)>	composer )

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

$navigateTo()

MCAPI void OreUI::RouteMatcher::$navigateTo	(	::std::string const &	route,
		::OreUI::RouteHistoryAction	action ) const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

$redirectIfNeeded()

MCAPI::std::string OreUI::RouteMatcher::$redirectIfNeeded

(

::std::string const &

route

)

const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

$isSupported()

MCAPI bool OreUI::RouteMatcher::$isSupported

(

::std::string const &

route

)

const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

$areCompatible()

MCAPI bool OreUI::RouteMatcher::$areCompatible	(	::std::string const &	routeA,
		::std::string const &	routeB ) const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

$getDefaultRouteForFile()

MCAPI ::std::optional<::std::string > OreUI::RouteMatcher::$getDefaultRouteForFile

(

::std::string const &

file

)

const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

$getRouteType()

MCAPI::OreUI::RouteType OreUI::RouteMatcher::$getRouteType

(

::std::string const &

route

)

const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

$getRouteMode()

MCAPI::OreUI::RouteMode OreUI::RouteMatcher::$getRouteMode

(

::std::string const &

route

)

const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

$getRoutePrerequisite()

MCAPI::OreUI::RoutePrerequisite OreUI::RouteMatcher::$getRoutePrerequisite

(

::std::string const &

route

)

const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

---

The documentation for this class was generated from the following files:

• src-server/mc/client/gui/oreui/routing/RouteMatcher.h
• src-client/mc/client/gui/oreui/routing/RouteMatcher.h