1. Epic GamesDeveloper
  3. FMessageLogListingViewModel

FMessageLogListingViewModel

The non-UI solution specific presentation logic for a collection of messages for a particular system.

API > API/Developer > API/Developer/MessageLog > API/Developer/MessageLog/Presentation

Inheritance Hierarchy

References

   
Module MessageLog
Header /Engine/Source/Developer/MessageLog/Public/Presentation/MessageLogListingViewModel.h
Include #include "Presentation/MessageLogListingViewModel.h"

Syntax

class FMessageLogListingViewModel :  
    public TSharedFromThis< FMessageLogListingViewModel >,  
    public IMessageLogListing

Remarks

The non-UI solution specific presentation logic for a collection of messages for a particular system.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static TSharedRef< FMessageLogListingViewModel >

Create ( const TSharedRef< FMessageLogListingModel >& InMessageLogListingModel,
const FText& InLogLabel,
const FMessageLogInitializationOptions& InitializationOptions
)

 Factory method which creates a new FMessageLogListingViewModel object
Public function Const bool Get whether we should show allow the user to clear the log.
Public function Const uint32 Get the current page index we are viewing
Public function Const bool Get whether we should discard duplicates or not
Public function Const MessageContainer::TConstIterator Obtains a const iterator to the filtered messages
Public function const TArray< TSharedRef< FTokenizedMessage > > & Returns the filtered message list
Public function Const uint32 Get the maximum page count this log can hold
Public function Const const TSharedPtr< FTokenizedMessage >

GetMessageAtIndex ( const int32 MessageIndex
)

 Returns the message at the specified index in the filtered list
Public function Const uint32 Get the number of pages we can view
Public function Const const FText &

GetPageTitle ( const uint32 PageIndex
)

 Get the title of the page at the specified index
Public function Const bool Get whether we should scroll to the bottom when messages are added
Public function Const MessageContainer::TConstIterator Obtains a const iterator to the selected filtered messages list
Public function Const bool Get whether we should show filters or not
Public function Const bool Get whether we should show pages or not
Public function Virtual void End IMessageLogListing interface Initializes the FMessageLogListingViewModel for use
Public function void Go to the page at the index after the current
Public function Const uint32 Gets the number of messages in the current log page
Public function Virtual void Called when data is changed changed/updated in the model
Public function void Handles updating the viewmodel when one of its filters changes
Public function void Go to the page at the index before the current
Public function void

SetAllowClear ( bool bInAllowClear
)

 Set whether we should show allow the user to clear the log.
Public function void

SetCurrentPageIndex ( uint32 InCurrentPageIndex
)

 Set the current page index we are viewing
Public function void

SetDiscardDuplicates ( bool bInDiscardDuplicates
)

 Set whether we should discard duplicates or not
Public function void

SetMaxPageCount ( uint32 InMaxPageCount
)

 Set the maximum page count this log can hold
Public function void

SetScrollToBottom ( bool bInScrollToBottom
)

 Set whether we should scroll to the bottom when messages are added
Public function void

SetShowFilters ( bool bInShowFilters
)

 Set whether we should show filters or not
Public function void

SetShowPages ( bool bInShowPages
)

 Set whether we should show pages or not
Public function Const bool Get whether to show this log in the main log window

Overridden from IMessageLogListing

  Type Name Description
Public function Virtual void Clears messages (if paged, in the current page)
Public function Virtual void Clears the message selection
Public function Virtual Const void

ExecuteToken ( const TSharedRef< class IMessageToken >& Token
)

 Performs an operation depending on the token (execute hyperlink etc.)
Public function Virtual Const FString Gets all the unfiltered messages as a single piece of text
Public function Virtual Const const TArray< TSharedRef< class FTokenizedMessage > > & Gets a list of the filtered messages for the specific log listing
Public function Virtual Const const FText & Gets the message log listing label
Public function Virtual Const const TArray< TSharedRef< FMessageFilter > > & Gets the set of message filters used when displaying messages
Public function Virtual Const const FName &

GetName ()

 Gets the message log listing unique name
Public function Virtual Const const TArray< TSharedRef< class FTokenizedMessage > > & Gets a list of the selected messages for the specific log listing
Public function Virtual Const FString Gets all the unfiltered selected messages as a single piece of text
Public function Virtual void Inverts the message selection
Public function Virtual Const bool

IsMessageSelected ( const TSharedRef< class FTokenizedMessage >& Message
)

 Get the message selection state
Public function Virtual IMessageLogListing::FChangedEvent &  
Public function Virtual IMessageLogListing::IMessageTokenClickedEvent &  
Public function Virtual IMessageLogListing::FOnPageSelectionChangedEvent &  
Public function Virtual IMessageLogListing::FOnSelectionChangedEvent &  
Public function Virtual void

SelectMessage ( const TSharedRef< class FTokenizedMessage >& Message,
bool bSelected
)

 Set the message selection state
Public function Virtual void

SelectMessages ( const TArray< TSharedRef< class FTokenizedMessage > >& InSelectedMessages
)

 Sets multiple selected messages
Public function Virtual void

SetLabel ( const FText& InLogLabel
)

 Sets the message log listing label

Overridden from IMessageLog

  Type Name Description
Public function Virtual void

AddMessage ( const TSharedRef< class FTokenizedMessage >& NewMessage,
bool bMirrorToOutputLog
)

 Begin IMessageLogListing interface
Public function Virtual void

AddMessages ( const TArray< TSharedRef< class FTokenizedMessage > >& NewMessages,
bool bMirrorToOutputLog
)

 Appends multiple messages
Public function Virtual void

NewPage ( const FText& Title
)

 Adds a new page to the log.
Public function Virtual void

NotifyIfAnyMessages ( const FText& Message,
EMessageSeverity::Type SeverityFilter,
bool bForce
)

 Notify the user if there are any messages on the current page for this log.
Public function Virtual int32

NumMessages ( EMessageSeverity::Type SeverityFilter
)

 Checks to see if there are any messages according to the passed-in severity
Public function Virtual void

Open ()

 Opens up the message log to this listing.
Public function Virtual void

SetCurrentPage ( const FText& Title
)

 Sets the current page to the one specified by the title.
Public function Virtual void

SetCurrentPage ( const uint32 InOldPageIndex
)

 Sets the current page to the one specified by the title.

Constants

Name Description
NextNotificationId  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page