API reference

router.h · C++ API

Browse entries grouped by interface file. Expand an entry for declarations, usage and version boundaries.

Read the related guide →

Entries retain declarations and sources. Runtime verification is recorded per entry; internal source candidates are not a promise of SDK delivery.

include/kui/router/router.h
bool
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
using NavigationGuard = std::function<bool(const RouteContext& from, const RouteContext& to)>;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:35

Report an issue with this entry →
Router::~Router
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
~Router();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:90

Report an issue with this entry →
Router::addBeforeEnter
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
u32 addBeforeEnter(NavigationGuard guard);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:137

Report an issue with this entry →
Router::addBeforeLeave
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
u32 addBeforeLeave(NavigationGuard guard);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:142

Report an issue with this entry →
Router::addRoute
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
bool addRoute(const String& path, RouteDefinition::ViewFactory factory, const String& name = "");

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:96

Report an issue with this entry →
Router::addRoute
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
bool addRoute(RouteDefinition def);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:102

Report an issue with this entry →
Router::back
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
bool back();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:120

Report an issue with this entry →
Router::clearRoutes
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
void clearRoutes();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:108

Report an issue with this entry →
Router::currentParams
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
const RouteParams& currentParams() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:133

Report an issue with this entry →
Router::currentPath
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
const String& currentPath() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:132

Report an issue with this entry →
Router::currentRoute
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
const RouteContext& currentRoute() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:129

Report an issue with this entry →
Router::findRoute
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
const RouteDefinition* findRoute(const String& path) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:164

Report an issue with this entry →
Router::forward
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
bool forward();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:123

Report an issue with this entry →
Router::go
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
bool go(int delta);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:126

Report an issue with this entry →
Router::hasRoute
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
bool hasRoute(const String& path) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:163

Report an issue with this entry →
Router::historyIndex
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
int historyIndex() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:134

Report an issue with this entry →
Router::historySize
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
int historySize() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:135

Report an issue with this entry →
Router::matchRoute
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
const RouteDefinition* matchRoute(const String& path, RouteParams& outParams) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:166

Report an issue with this entry →
Router::onAfterNavigate
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
u32 onAfterNavigate(AfterNavigateCallback callback);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:158

Report an issue with this entry →
Router::operator=
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
Router& operator=(const Router&) = delete;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:94

Report an issue with this entry →
Router::parseQuery
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
static std::unordered_map<String, String> parseQuery(const String& query);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:172

Report an issue with this entry →
Router::push
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
bool push(const String& path);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:111

Report an issue with this entry →
Router::registerView
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
void registerView(Element* view);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:148

Report an issue with this entry →
Router::removeAfterNavigate
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
void removeAfterNavigate(u32 id);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:159

Report an issue with this entry →
Router::removeGuard
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
void removeGuard(u32 id);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:145

Report an issue with this entry →
Router::removeRoute
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
bool removeRoute(const String& path);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:105

Report an issue with this entry →
Router::replace
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
bool replace(const String& path);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:117

Report an issue with this entry →
Router::routeCount
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
u32 routeCount() const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:161

Report an issue with this entry →
Router::Router
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
explicit Router(Document* doc = nullptr);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:89

Report an issue with this entry →
Router::Router
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
Router(const Router&) = delete;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:92

Report an issue with this entry →
Router::unregisterView
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
void unregisterView(Element* view);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:153

Report an issue with this entry →
Router::void
Needs verification3.61.7C++

Installed header declaration in the router module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

router.h
using AfterNavigateCallback = std::function<void(const RouteContext&)>;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/router/router.h:156

Report an issue with this entry →
Browse this reference type →