SMessageLogListing

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

Unreal Engine C++ API Reference > Developer > MessageLog > UserInterface

Inheritance Hierarchy

References

   
Module MessageLog
Header /Engine/Source/Developer/MessageLog/Public/UserInterface/SMessageLogListing.h
Include #include "UserInterface/SMessageLogListing.h"

Syntax

class SMessageLogListing : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)  

Remarks

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

Constructors

Type Name Description
  SMessageLogListing ()  

Destructors

Type Name Description
  ~SMessageLogListing ()  

Functions

Type Name Description
void BroadcastMessageDoubleClicked ( TSharedPtr< class FTokenizedMessage... ) Used to execute a message's featured action (a token associated with the entire message)
void BroadcastMessageTokenClicked ( TSharedPtr< class FTokenizedMessage..., const TSharedRef< class IMessageTok... ) Used to execute the 'on clicked token' delegate
void ClearSelectedMessages () Clears the message selection
void Construct ( const FArguments& InArgs, const TSharedRef< class IMessageLog... )  
FString CopyLogOutput ( bool bSelected, bool bClipboard ) Copies log output (selected/all), optionally to the clipboard
void CopySelectedToClipboard () Copies the selected messages to the clipboard
FString GetAllMessagesAsString () Compiles all the messages into a single string.
EVisibility GetClearWidgetVisibility () Delegate for showing & hiding the clear button depending on whether this log uses pages or not
const TShare... GetCommandList ()  
EVisibility GetFilterMenuVisibility () Delegate to get the display visibility of the show filter combobox
const FText ... GetLabel () Gets the message log listing label
const TArray... GetMessageFilters () Gets the set of message filters used when displaying messages
const FName ... GetName () Gets the message log listing unique name
FString GetPageText () Delegate supplying a label for the page-flipper widget
EVisibility GetPageWidgetVisibility () Delegate for showing & hiding the page widget depending on whether this log uses pages or not
const TArray... GetSelectedMessages () Gets a list of the selected messages
FString GetSelectedMessagesAsString () Compiles the selected messages into a single string.
void InvertSelectedMessages () Inverts the message selection
bool IsClearWidgetEnabled () Delegate for enabling & disabling the clear button depending on the number of messages
bool IsMessageSelected ( const TSharedRef< class FTokenizedM... ) Get the message selection state
bool IsPageWidgetEnabled () Delegate for enabling & disabling the page widget depending on the number of pages
TSharedRef< ... MakeShowWidget ( TSharedRef< FMessageFilter > Select..., const TSharedRef< STableViewBase > ... ) Generates the widgets for show filtering
void OnChanged () Called when data is changed changed/updated in the model
FReply OnClear () Delegate for Clear button
FReply OnClickedNextPage () Delegate to display the next page
FReply OnClickedPrevPage () Delegate to display the previous page
TSharedRef< ... OnGetFilterMenuContent () Generates the menu content for filtering log content
TSharedRef< ... OnGetPageMenuContent () Delegate to generate the menu content for the page combobox
FText OnGetPageMenuLabel () Delegate to generate the label for the page combobox
void OnPageSelected ( uint32 PageIndex ) Delegate called when a page is selected from the page menu
void OnSelectionChanged () Called whenever the viewmodel selection changes
void RefreshVisibility () Refreshes the log messages, reapplying any filtering
void ScrollToMessage ( const TSharedRef< class FTokenizedM... ) Scrolls the message into view
void SelectMessage ( const TSharedRef< class FTokenizedM..., bool bSelected ) Set the message selection state

Overridden from SWidget

Type Name Description
FReply OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent ) Called after a key is pressed when this widget has focus

Classes

Type Name Description
Public struct FArguments  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library