SLogWidget

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NetcodeUnitTest

Header

/Engine/Plugins/NetcodeUnitTest/NetcodeUnitTest/Source/NetcodeUnitTest/Public/UI/SLogWidget.h

Include

#include "UI/SLogWidget.h"

Syntax

class SLogWidget : public SCompoundWidget

Variables

Name Description

Public variable

bool

 

bAutoClose

Whether or not auto-closing the current window is enabled

Protected variable

bool

 

bAutoScroll

Whether or not auto-scrolling is currently enabled

Protected variable

TSharedPtr< SCo...

 

ConsoleComboBox

The combo box for selecting the console command context

Public variable

TArray< TShared...

 

ConsoleContextList

The list of available console command contexts (for the combo box)

Protected variable

TSharedPtr< SEd...

 

ConsoleTextBox

The console command text box

Public variable

FString

 

DefaultConsoleContext

The default console command context (for the combo box)

Protected variable

TArray< TShared...

 

LogLines

The full list of all accumulated log lines - stored centrally/separately from tabs

Protected variable

TSharedPtr< FTa...

 

LogTabManager

The log window tab manager

Protected variable

TArray< TShared...

 

LogTabs

Holds information necessary for initializing and handling the state of each tab

Protected variable

TSharedPtr< FUI...

 

LogWidgetCommands

Log widget context-menu/shortcut-key commands

Public variable

FOnConsoleComma...

 

OnConsoleCommand

Delegate for handling UI-triggered console commands

Public variable

FOnDeveloperCli...

 

OnDeveloperClicked

Notification for developer checkbox click

Public variable

FOnSuspendClick...

 

OnSuspendClicked

Notification for suspend/resume button click

Public variable

TSharedPtr< STe...

 

SuspendButtonText

Reference to the suspend buttons text, so the text can be modified

Constructors

Name Description

Public function

SLogWidget()

Functions

Name Description

Public function

void

 

AddLine

(
    ELogType InLogType,
    TSharedRef< FString > LogLine,
    FSlateColor LogColor,
    bool bTakeTabFocus
)

Adds a log line to the log window

Protected function

bool

 

CanAutoScroll

(
    TSharedPtr< FLogTabInfo > InTab
)

Whether or not auto-scrolling is presently possible for the specified tab

Protected function Const

bool

 

CanCopy()

Used to determine whether 'Copy' is currently a valid action

Protected function Const

bool

 

CanFind()

Used to determine whether 'Find' is currently a valid action

Public function

void

 

Construct

(
    const FArguments& Args
)

Widget constructor

SLogWidget

Protected function Const

TSharedPtr< ...

 

GetActiveTabInfo()

Returns a reference to the LogTabs entry, for the currently active tab

Protected function

TSharedRef< ...

 

InitializeTabLayout

(
    const FArguments& Args
)

Initializes the LogTabInfo array and tab formatting, and returns the log tab formatting layout

Protected function

void

 

OnCopy()

Called when the 'Copy' context button is clicked

Protected function

void

 

OnFind()

Called when the 'Find' context button is clicked

Public function

void

 

OnSuspendStateChanged

(
    ESuspendState InSuspendState
)

Notification from the unit test (through a delegate), that the server suspend state has changed (for the button text)

Protected function

void

 

ScrollToEnd

(
    TSharedRef< FLogTabInfo > InTab
)

Scrolls the specified tab to the last entry

Protected function

void

 

ScrollToText

(
    TSharedRef< FLogTabInfo > InTab,
    FString FindText,
    bool bSearchUp
)

Scrolls to the specified text, in the specified tab (starting from the currently selected line)

Protected function

TSharedRef< ...

 

SpawnLogTab

(
    const FSpawnTabArgs& InSpawnTabArg...
)

Spawns an individual tab for the log list view

Protected function

void

 

UpdateFindHighlight

(
    TSharedPtr< FLogTabInfo > InTab,
    bool bHighlight,
    FString HighlightText
)

Updates the find text highlighting for a tab

Overridden from SWidget

Name Description

Protected function Virtual

FReply

 

OnKeyDown

(
    const FGeometry& MyGeometry,
    const FKeyEvent& InKeyboardEvent
)

Called after a key is pressed when this widget has keyboard focus

Protected function Virtual

void

 

Tick

(
    const FGeometry& AllottedGeometry,
    const double InCurrentTime,
    const float InDeltaTime
)

Ticks this widget with Geometry.

Classes

Name

Description

Public struct

FArguments

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss