1. Epic GamesDeveloper
  3. SMessageLogListing

SMessageLogListing

A message log listing, such as the Compiler Log, or the Map Check Log.

API > API/Developer > API/Developer/MessageLog

A message log listing, such as the Compiler Log, or the Map Check Log. Holds the log lines, and any extra widgets necessary.

   
Name SMessageLogListing
Type class
Header File /Engine/Source/Developer/MessageLog/Public/UserInterface/SMessageLogListing.h
Include Path #include "UserInterface/SMessageLogListing.h"

Syntax

class SMessageLogListing : public SCompoundWidget

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

SMessageLogListing()

   UserInterface/SMessageLogListing.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~SMessageLogListing()

   UserInterface/SMessageLogListing.h  

Structs

Name Remarks
FArguments  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bUpdatingSelection bool Whether the view is currently updating the viewmodel selection UserInterface/SMessageLogListing.h  
MessageListView TSharedPtr< SListView< TSharedRef< class FTokenizedMessage > > > The list view for showing all the message log lines UserInterface/SMessageLogListing.h  
MessageLogListingViewModel TSharedPtr< class FMessageLogListingViewModel > Reference to the ViewModel which holds state info and has access to data UserInterface/SMessageLogListing.h  
UICommandList const TSharedRef< FUICommandList > The list of commands with bound delegates for the message log UserInterface/SMessageLogListing.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BroadcastMessageDoubleClicked ( TSharedPtr< class FTokenizedMessage > Message
)

 Used to execute a message's featured action (a token associated with the entire message) UserInterface/SMessageLogListing.h  

void BroadcastMessageTokenClicked ( TSharedPtr< class FTokenizedMessage > Message,
const TSharedRef< class IMessageToken >& Token
)

 Used to execute the 'on clicked token' delegate UserInterface/SMessageLogListing.h  

void ClearSelectedMessages()

 Clears the message selection UserInterface/SMessageLogListing.h  

void Construct ( const FArguments& InArgs,
const TSharedRef< class IMessageLogListing >& InModelView
)

   UserInterface/SMessageLogListing.h  

FString CopyLogOutput ( bool bSelected,
bool bClipboard
) const

 Copies log output (selected/all), optionally to the clipboard UserInterface/SMessageLogListing.h  

void CopySelectedToClipboard()

 Copies the selected messages to the clipboard UserInterface/SMessageLogListing.h  

FString GetAllMessagesAsString()

 Compiles all the messages into a single string. UserInterface/SMessageLogListing.h  

EVisibility GetClearWidgetVisibility()

 Delegate for showing & hiding the clear button depending on whether this log uses pages or not UserInterface/SMessageLogListing.h  

const TSharedRef< const FUICommandList > GetCommandList()

   UserInterface/SMessageLogListing.h  

EVisibility GetFilterMenuVisibility()

 Delegate to get the display visibility of the show filter combobox UserInterface/SMessageLogListing.h  

const FText & GetLabel()

 Gets the message log listing label UserInterface/SMessageLogListing.h  

const TArray< TSharedRef< class FMessageFilter > > & GetMessageFilters()

 Gets the set of message filters used when displaying messages UserInterface/SMessageLogListing.h  

const FName & GetName()

 Gets the message log listing unique name UserInterface/SMessageLogListing.h  

FString GetPageText()

 Delegate supplying a label for the page-flipper widget UserInterface/SMessageLogListing.h  

EVisibility GetPageWidgetVisibility()

 Delegate for showing & hiding the page widget depending on whether this log uses pages or not UserInterface/SMessageLogListing.h  

const TArray< TSharedRef< class FTokenizedMessage > > GetSelectedMessages()

 Gets a list of the selected messages UserInterface/SMessageLogListing.h  

FString GetSelectedMessagesAsString()

 Compiles the selected messages into a single string. UserInterface/SMessageLogListing.h  

void InvertSelectedMessages()

 Inverts the message selection UserInterface/SMessageLogListing.h  

bool IsClearWidgetEnabled()

 Delegate for enabling & disabling the clear button depending on the number of messages UserInterface/SMessageLogListing.h  

bool IsMessageSelected ( const TSharedRef< class FTokenizedMessage >& Message
) const

 Get the message selection state UserInterface/SMessageLogListing.h  

bool IsPageWidgetEnabled()

 Delegate for enabling & disabling the page widget depending on the number of pages UserInterface/SMessageLogListing.h  

TSharedRef< ITableRow > MakeShowWidget ( TSharedRef< FMessageFilter > Selection,
const TSharedRef< STableViewBase >& OwnerTable
)

 Generates the widgets for show filtering UserInterface/SMessageLogListing.h  

void OnChanged()

 Called when data is changed changed/updated in the model UserInterface/SMessageLogListing.h  

FReply OnClear()

 Delegate for Clear button UserInterface/SMessageLogListing.h  

FReply OnClickedNextPage()

 Delegate to display the next page UserInterface/SMessageLogListing.h  

FReply OnClickedPrevPage()

 Delegate to display the previous page UserInterface/SMessageLogListing.h  

TSharedRef< SWidget > OnGetFilterMenuContent()

 Generates the menu content for filtering log content UserInterface/SMessageLogListing.h  

TSharedRef< SWidget > OnGetPageMenuContent()

 Delegate to generate the menu content for the page combobox UserInterface/SMessageLogListing.h  

FText OnGetPageMenuLabel()

 Delegate to generate the label for the page combobox UserInterface/SMessageLogListing.h  

FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is pressed when this widget has focus UserInterface/SMessageLogListing.h  

void OnPageSelected ( uint32 PageIndex
)

 Delegate called when a page is selected from the page menu UserInterface/SMessageLogListing.h  

void OnSelectionChanged()

 Called whenever the viewmodel selection changes UserInterface/SMessageLogListing.h  

void RefreshVisibility()

 Refreshes the log messages, reapplying any filtering UserInterface/SMessageLogListing.h  

void ScrollToMessage ( const TSharedRef< class FTokenizedMessage >& Message
) const

 Scrolls the message into view UserInterface/SMessageLogListing.h  

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

 Set the message selection state UserInterface/SMessageLogListing.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page