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

Description

Sent when an file had completed loading.

This is different from kLoadComplete, as it is only called after opening an new file. kLoadComplete is also called anytime a WSM history was loaded, which may be after import, place content ... inside an existing session.

#include <FormItCoreMessages.h>

Inheritance diagram for FormIt::kOpenFileCompleteType:
FormIt::MessageWithPayloadStruct FormIt::MessageStruct

Public Types

using Payload = 1::string
 
- 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::kOpenFileCompleteType::extract ( FormIt::MessagePayloadStruct const &  payload) const
::string FormIt::kOpenFileCompleteType::message ( ) const
overridevirtual

message() function.

Implements FormIt::MessageStruct.


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