ProgressMonitorInterface Class Reference

#include <progressmonitor.h>

Inheritance diagram for ProgressMonitorInterface:

详细描述

Allows to be informed during time-intensive source control operations such as file sync. The monitor is called frequently during the operation.

公共成员函数

MAXON_METHOD Result < void >  初始化 (const String &command, const ArrayInterface < String > &arguments)
MAXON_METHOD Result < void >  TotalBytesToProcess ( UInt bytes)
MAXON_METHOD Result < void >  FinishedBytesToProcess ( UInt bytes)
MAXON_METHOD Result < void >  Finalize ()

私有成员函数

  MAXON_INTERFACE ( ProgressMonitorInterface , MAXON_REFERENCE_NORMAL , "net.maxon.misc.interface.progressmonitor")

成员函数文档编制

◆  MAXON_INTERFACE()

MAXON_INTERFACE ( ProgressMonitorInterface   ,
MAXON_REFERENCE_NORMAL   ,
"net.maxon.misc.interface.progressmonitor"   
)
private

◆  Initialize()

MAXON_METHOD Result <void> Initialize ( const String 命令 ,
const ArrayInterface < String > &  arguments  
)

Called before the source control operation.

参数
[in] 命令 The command string of the operation.
[in] arguments The set of arguments used with the command.
返回
OK on success.

◆  TotalBytesToProcess()

MAXON_METHOD Result <void> TotalBytesToProcess ( UInt   bytes )

Called once for the command. Note that this function might not be executed at all, or is executed after the operation is already progressing, such as a a download being partially complete, which is indicated by a call to FinishedBytesToProcess() before calling TotalBytesToProcess() .

参数
[in] bytes The total number of bytes for the operation.
返回
OK on success.

◆  FinishedBytesToProcess()

MAXON_METHOD Result <void> FinishedBytesToProcess ( UInt   bytes )

Called frequently, multiple times during the operation. Note that this function might not be executed at all. The sum of all reported finished bytes equals the total amount of bytes for a successful operation.

参数
[in] bytes The number of progress in bytes since the last call to TotalBytesToProcess() .
返回
OK on success.

◆  Finalize()

MAXON_METHOD Result <void> Finalize ( )

This method is called after the source control operation terminated successfully.

返回
OK on success.