FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::kLoadCompleteType Struct Reference


Sent when:

  • A file has completed loading into the specified history
  • BeginState/EndState happens This signals that processing has finished and everything can update. If the history ID is INVALID_ID, then this was for running tests, and no particular history is involved. TODO(hauswij): It would be nice to rename this to kEndStateCreation or something. And also create a real message for kLoadComplete, but named something solid like kFileFinishedLoaded with a payload of the filename.

#include <FormItCoreMessages.h>

Inheritance diagram for FormIt::kLoadCompleteType:
FormIt::MessageWithPayloadStruct FormIt::MessageStruct

Public Types

using Payload = LoadCompleteData
- Public Types inherited from FormIt::MessageStruct
using Payload = void

Public Member Functions

const Payloadextract (FormIt::MessagePayloadStruct const &payload) const
::string message () const override
 message() function. More...
- Public Member Functions inherited from FormIt::MessageStruct
bool operator== (MessageStruct const &right) const
 So we can see if a particular message received is the same as one of the predefined ones using simple comparisons. More...
bool operator!= (MessageStruct const &right) const

Additional Inherited Members

- Protected Member Functions inherited from FormIt::MessageWithPayloadStruct
template<typename T >
const T & cast (MessagePayloadStruct const &payload) const

Member Typedef Documentation

Member Function Documentation

const Payload& FormIt::kLoadCompleteType::extract ( FormIt::MessagePayloadStruct const &  payload) const
::string FormIt::kLoadCompleteType::message ( ) const

message() function.

Implements FormIt::MessageStruct.

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