Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::PatchingNotificationHandler Class Referenceabstract

Patching notification handler interface. More...

#include <kanzi/core.ui/domain/patching_notification_handler.hpp>

Inheritance diagram for kanzi::PatchingNotificationHandler:
[legend]

Public Member Functions

virtual void onPatchingFinished ()=0
 The domain calls this function when patching ends. More...
 
virtual void onPatchingStarted ()=0
 The domain calls this function when patching starts. More...
 
void setKzbFile (KzbFile *kzbFile)
 Sets the kzb patch file to apply. More...
 
virtual ~PatchingNotificationHandler ()=default
 Destructor. More...
 

Protected Attributes

KzbFilem_kzbFile
 The kzb patch file to apply. More...
 

Detailed Description

Patching notification handler interface.

Derive from this class and provide an object to domain to receive notifications when domain applies patches to .kzb files. The domain will call these methods only in Kanzi Studio Preview.

Constructor & Destructor Documentation

virtual kanzi::PatchingNotificationHandler::~PatchingNotificationHandler ( )
virtualdefault

Destructor.

Member Function Documentation

virtual void kanzi::PatchingNotificationHandler::onPatchingStarted ( )
pure virtual

The domain calls this function when patching starts.

virtual void kanzi::PatchingNotificationHandler::onPatchingFinished ( )
pure virtual

The domain calls this function when patching ends.

void kanzi::PatchingNotificationHandler::setKzbFile ( KzbFile kzbFile)
inline

Sets the kzb patch file to apply.

Kanzi calls this function before applying the patch and guarantees that this pointer remains valid during patching handler calls.

Parameters
kzbFileThe kzb patch file to apply.
Since
Kanzi 3.9.3

Member Data Documentation

KzbFile* kanzi::PatchingNotificationHandler::m_kzbFile
protected

The kzb patch file to apply.

Since
Kanzi 3.9.3

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