API reference

extension_manager.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/extension/extension_manager.h
ExtensionInvokeResult::operator bool
Needs verification3.61.7C++

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

extension_manager.h
explicit operator bool() const

Verification scope

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

include/kui/extension/extension_manager.h:65

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

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

extension_manager.h
~ExtensionManager();

Verification scope

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

include/kui/extension/extension_manager.h:71

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

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

extension_manager.h
static ExtensionManager* activeInstance();

Verification scope

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

include/kui/extension/extension_manager.h:238

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

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

extension_manager.h
void addAllowedDirectory(const std::string& dir);

Verification scope

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

include/kui/extension/extension_manager.h:171

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

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

extension_manager.h
const std::vector<std::string>& allowedDirectories() const

Verification scope

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

include/kui/extension/extension_manager.h:175

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

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

extension_manager.h
bool apiVersionCompatible(uint32_t requiredApiVersion) const;

Verification scope

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

include/kui/extension/extension_manager.h:190

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

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

extension_manager.h
bool capabilitiesSatisfied(uint32_t requiredCaps) const;

Verification scope

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

include/kui/extension/extension_manager.h:187

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

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

extension_manager.h
void clearAllowedDirectories();

Verification scope

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

include/kui/extension/extension_manager.h:173

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

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

extension_manager.h
size_t count() const

Verification scope

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

include/kui/extension/extension_manager.h:93

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

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

extension_manager.h
bool detectLuaShared() const;

Verification scope

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

include/kui/extension/extension_manager.h:116

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

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

extension_manager.h
uint32_t enabledCapabilities() const

Verification scope

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

include/kui/extension/extension_manager.h:180

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

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

extension_manager.h
explicit ExtensionManager(Document* doc);

Verification scope

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

include/kui/extension/extension_manager.h:70

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

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

extension_manager.h
ExtensionManager(const ExtensionManager&) = delete;

Verification scope

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

include/kui/extension/extension_manager.h:73

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

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

extension_manager.h
PerfStats getPerfStats(const std::string& tagName) const;

Verification scope

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

include/kui/extension/extension_manager.h:142

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

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

extension_manager.h
const KuiExtHostAPI* hostAPI() const

Verification scope

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

include/kui/extension/extension_manager.h:100

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

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

extension_manager.h
ExtensionInvokeResult invoke(Element* element, const std::string& methodName, const std::vector<ExtensionValue>& args = {}, size_t maxResults = 8) const;

Verification scope

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

include/kui/extension/extension_manager.h:103

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

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

extension_manager.h
bool isDllPathAllowed(const std::string& dllPath) const;

Verification scope

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

include/kui/extension/extension_manager.h:182

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

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

extension_manager.h
bool isExtensionLoaded(const std::string& tagName) const;

Verification scope

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

include/kui/extension/extension_manager.h:96

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

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

extension_manager.h
bool isWatching() const

Verification scope

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

include/kui/extension/extension_manager.h:124

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

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

extension_manager.h
bool loadExtension(const std::string& dllPath);

Verification scope

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

include/kui/extension/extension_manager.h:81

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

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

extension_manager.h
int loadFromDirectory(const std::string& dirPath);

Verification scope

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

include/kui/extension/extension_manager.h:77

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

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

extension_manager.h
ExtensionManager& operator=(const ExtensionManager&) = delete;

Verification scope

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

include/kui/extension/extension_manager.h:75

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

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

extension_manager.h
double perfThreshold() const

Verification scope

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

include/kui/extension/extension_manager.h:148

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

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

extension_manager.h
int processPendingReloads();

Verification scope

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

include/kui/extension/extension_manager.h:126

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

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

extension_manager.h
void recordPaintPerf(const std::string& tagName, double elapsedMs);

Verification scope

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

include/kui/extension/extension_manager.h:152

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

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

extension_manager.h
void recordTickPerf(const std::string& tagName, double elapsedMs);

Verification scope

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

include/kui/extension/extension_manager.h:150

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

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

extension_manager.h
void registerLuaMethods(const char* tagName, const KuiExtLuaMethodDef* methods, int count);

Verification scope

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

include/kui/extension/extension_manager.h:112

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

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

extension_manager.h
void registerMessageHandler(const std::string& tagName, KuiExtMessageFn handler);

Verification scope

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

include/kui/extension/extension_manager.h:230

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

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

extension_manager.h
bool reloadExtension(const std::string& dllPath);

Verification scope

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

include/kui/extension/extension_manager.h:87

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

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

extension_manager.h
void resetPerfStats();

Verification scope

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

include/kui/extension/extension_manager.h:144

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

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

extension_manager.h
int routeMessage(const char* sourceTag, const char* targetTag, const char* messageType, const KuiValue* payload, int payloadCount);

Verification scope

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

include/kui/extension/extension_manager.h:233

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

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

extension_manager.h
static void setActiveInstance(ExtensionManager* mgr);

Verification scope

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

include/kui/extension/extension_manager.h:240

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

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

extension_manager.h
void setAllowedDirectories(std::vector<std::string> dirs);

Verification scope

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

include/kui/extension/extension_manager.h:154

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

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

extension_manager.h
void setEnabledCapabilities(uint32_t mask)

Verification scope

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

include/kui/extension/extension_manager.h:178

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

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

extension_manager.h
void setPerfThreshold(double thresholdMs)

Verification scope

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

include/kui/extension/extension_manager.h:146

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

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

extension_manager.h
void startWatching(const std::string& dirPath);

Verification scope

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

include/kui/extension/extension_manager.h:119

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

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

extension_manager.h
void stopWatching();

Verification scope

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

include/kui/extension/extension_manager.h:123

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

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

extension_manager.h
void unloadAll();

Verification scope

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

include/kui/extension/extension_manager.h:90

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

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

extension_manager.h
bool unloadExtension(const std::string& tagName);

Verification scope

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

include/kui/extension/extension_manager.h:84

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

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

extension_manager.h
static ExtensionValue boolean(bool value);

Verification scope

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

include/kui/extension/extension_manager.h:47

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

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

extension_manager.h
#if !defined(nil) static ExtensionValue nil()

Verification scope

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

include/kui/extension/extension_manager.h:39

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

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

extension_manager.h
#endif static ExtensionValue integer(int64_t value);

Verification scope

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

include/kui/extension/extension_manager.h:43

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

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

extension_manager.h
static ExtensionValue nullValue();

Verification scope

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

include/kui/extension/extension_manager.h:35

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

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

extension_manager.h
static ExtensionValue number(double value);

Verification scope

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

include/kui/extension/extension_manager.h:45

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

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

extension_manager.h
static ExtensionValue string(std::string value);

Verification scope

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

include/kui/extension/extension_manager.h:46

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

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

extension_manager.h
KUI_API const std::unordered_map<std::string, std::unordered_map<std::string, ExtMethodEntry>>& getExtensionMethods();

Verification scope

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

include/kui/extension/extension_manager.h:260

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