IProgress.hpp File Reference

SDK 1.7 capability for shared application progress and operation logs. More...

#include <QObject>
#include <QString>
#include <QUuid>

Include dependency graph for IProgress.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	OpenSWMM::Sdk::IProgress
	Optional host-owned progress service; every method requires the GUI thread. More...

Namespaces
namespace	OpenSWMM
namespace	OpenSWMM::Sdk
	Public header-only ABI for independently compiled native GUI extensions.

Macros
#define	OPENSWMM_PROGRESS_IID   "io.opensimulator.openswmm.IProgress/1.0"
	Frozen discovery identity for shared application progress.

Enumerations
enum class	OpenSWMM::Sdk::ProgressOutcome {   OpenSWMM::Sdk::Succeeded ,   OpenSWMM::Sdk::Failed ,   OpenSWMM::Sdk::Cancelled }
	Terminal classification for an extension-owned progress operation. More...

Detailed Description

SDK 1.7 capability for shared application progress and operation logs.

Discover this optional interface with qobject_cast on ExtensionHost::lifetime(). It reports GUI-thread asynchronous work, including network transfers that do not use runJob(). The host qualifies titles with the plugin identity and records start, stage changes and one terminal outcome in the normal Logs panel and the plugin's bounded Output channel. Existing SDK interfaces and their binary layouts remain unchanged.

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

Copyright

Copyright (c) 2026 Caleb Buahin. All rights reserved.

License

GPL-3.0-or-later

Macro Definition Documentation

OPENSWMM_PROGRESS_IID

#define OPENSWMM_PROGRESS_IID   "io.opensimulator.openswmm.IProgress/1.0"

Frozen discovery identity for shared application progress.