1. Epic GamesDeveloper
  3. SLogWidget

SLogWidget

Unreal Engine C++ API Reference > Plugins > NetcodeUnitTest > UI

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

  Type 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< SComboBox< TSharedPtr< FString > > > ConsoleComboBox The combo box for selecting the console command context
Public variable TArray< TSharedPtr< FString > > ConsoleContextList The list of available console command contexts (for the combo box)
Protected variable TSharedPtr< SEditableTextBox > ConsoleTextBox The console command text box
Public variable FString DefaultConsoleContext The default console command context (for the combo box)
Protected variable TArray< TSharedRef< FLogLine > > LogLines The full list of all accumulated log lines - stored centrally/separately from tabs
Protected variable TSharedPtr< FTabManager > LogTabManager The log window tab manager
Protected variable TArray< TSharedRef< FLogTabInfo > > LogTabs Holds information necessary for initializing and handling the state of each tab
Protected variable TSharedPtr< FUICommandList > LogWidgetCommands Log widget context-menu/shortcut-key commands
Public variable FOnConsoleCommand OnConsoleCommand Delegate for handling UI-triggered console commands
Public variable FOnDeveloperClicked OnDeveloperClicked Notification for developer checkbox click
Public variable FOnSuspendClicked OnSuspendClicked Notification for suspend/resume button click
Public variable TSharedPtr< STextBlock > SuspendButtonText Reference to the suspend buttons text, so the text can be modified

Constructors

  Type Name Description
Public function    

Functions

  Type 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 Whether or not auto-scrolling is presently possible for the specified tab NOTE: Does NOT determine whether or not it is presently enabled though
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 constructorSLogWidget
Protected function Const TSharedPtr< FLogTabInfo > Returns a reference to the LogTabs entry, for the currently active tab
Protected function TSharedRef< FTabManager::FLayout > 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 Notification from the unit test (through a delegate), that the server suspend state has changed (for the button text)
Protected function void 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< SDockTab >

SpawnLogTab ( const FSpawnTabArgs& InSpawnTabArgs
)

 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

  Type 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

  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

On this page