#include <SAtomMonitorLogWidget.h>

Inheritance diagram for SAtomMonitorLogWidget:

Public Member Functions
	SAtomMonitorLogWidget ()
void	AddLine (EAtomMonitorLogMode InLogType, TSharedRef< FString > LogLine, FTimespan InLogTimestamp=FTimespan::Zero(), FSlateColor LogColor=FSlateColor::UseForeground(), bool bTakeTabFocus=false)
void	Construct (const FArguments &Args)
void	OnMonitorRemoteStateChanged (const FString &ClientIP, bool bIsConnected)
void	OnMonitorStateChanged (const FString &HostIp, uint16 HostPort, EAtomMonitorLogState InMonitorState)
	SLATE_BEGIN_ARGS (SAtomMonitorLogWidget)

Public Attributes
TArray< TSharedPtr< FString > >	ConsoleContextList
FString	DefaultConsoleContext
TSharedPtr< STextBlock >	InGamePreviewStatusText
FOnConsoleCommand	OnConsoleCommand
FOnDeveloperClicked	OnDeveloperClicked
FOnSuspendClicked	OnStartStopClicked
TSharedPtr< SImage >	ServerStatusBackgroundIcon
TSharedPtr< SImage >	ServerStatusBadgeIcon
TSharedPtr< SImage >	ServerStatusDownloadIcon
TSharedPtr< STextBlock >	ServerStatusText
TSharedPtr< SImage >	ServerStatusUploadIcon
TSharedPtr< STextBlock >	StartStopButtonText

Protected Member Functions
TSharedPtr< SWidget > &	ArrayAddNew (TArray< TSharedPtr< SWidget > > &InArray)
bool	CanAutoScroll (TSharedPtr< FAtomMonitorLogTabInfo > InTab)
bool	CanClear () const
bool	CanCopy () const
bool	CanFind () const
TSharedPtr< FAtomMonitorLogTabInfo >	GetActiveTabInfo () const
TSharedRef< FTabManager::FLayout >	InitializeTabLayout (const FArguments &Args)
void	OnClear ()
void	OnCopy ()
void	OnFind ()
TSharedRef< ITableRow >	OnGenerateLogRow (TSharedRef< FAtomMonitorLogLine > Item, const TSharedRef< STableViewBase > &OwnerTable)
virtual FReply	OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyboardEvent) override
void	ScrollToEnd (TSharedRef< FAtomMonitorLogTabInfo > InTab)
void	ScrollToText (TSharedRef< FAtomMonitorLogTabInfo > InTab, FString FindText, bool bSearchUp=false)
void	SetServerStatusIcon (EAtomMonitorLogState InMonitorState) const
TSharedRef< SDockTab >	SpawnLogTab (const FSpawnTabArgs &InSpawnTabArgs)
virtual void	Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override
void	UpdateFindHighlight (TSharedPtr< FAtomMonitorLogTabInfo > InTab, bool bHighlight, FString HighlightText=TEXT(""))

Protected Attributes
bool	bAutoScroll
bool	bShowTimestamps
TSharedPtr< SComboBox< TSharedPtr< FString > > >	ConsoleComboBox
TSharedPtr< SEditableTextBox >	ConsoleTextBox
TArray< TSharedRef< FAtomMonitorLogLine > >	LogLines
TSharedPtr< FTabManager >	LogTabManager
TArray< TSharedRef< FAtomMonitorLogTabInfo > >	LogTabs
TSharedPtr< FUICommandList >	LogWidgetCommands

Constructor & Destructor Documentation

◆ SAtomMonitorLogWidget()

SAtomMonitorLogWidget::SAtomMonitorLogWidget ( )

inline

Input argument, outlining the log filters expected for this log window - used to decide which tabs should be added

Member Function Documentation

◆ AddLine()

void SAtomMonitorLogWidget::AddLine	(	EAtomMonitorLogMode	InLogType,
		TSharedRef< FString >	LogLine,
		FTimespan	InLogTimestamp = FTimespan::Zero(),
		FSlateColor	LogColor = FSlateColor::UseForeground(),
		bool	bTakeTabFocus = false )

Adds a log line to the log window

Parameters

InLogType	The type of log output this is (for filtering)
LogLine	The log line
LogColor	The colour to apply to the log line
bTakeTabFocus	If this log line isn't displayed on the currently focused tab, switch focus to a tab that does show it

◆ ArrayAddNew()

TSharedPtr< SWidget > & SAtomMonitorLogWidget::ArrayAddNew ( TArray< TSharedPtr< SWidget > > & InArray )

inlineprotected

Add a blank element to above array, and return a ref to that element - for tidiness/compatibility with Slate declarative syntax

◆ CanAutoScroll()

bool SAtomMonitorLogWidget::CanAutoScroll ( TSharedPtr< FAtomMonitorLogTabInfo > InTab )

protected

Whether or not auto-scrolling is presently possible for the specified tab NOTE: Does NOT determine whether or not it is presently enabled though

Parameters

InTab The tab to check

Returns: Whether or not auto-scrolling is possible

◆ CanClear()

bool SAtomMonitorLogWidget::CanClear ( ) const

protected

Used to determine whether 'Clear Log' is currently a valid action

Returns: Whether or not a clear of the log can be performed right now

◆ CanCopy()

bool SAtomMonitorLogWidget::CanCopy ( ) const

protected

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

Returns: Whether or not a copy can be performed right now

◆ CanFind()

bool SAtomMonitorLogWidget::CanFind ( ) const

protected

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

Returns: Whether or not find can be performed right now

◆ Construct()

void SAtomMonitorLogWidget::Construct ( const FArguments & Args )

Widget constructor

SAtomMonitorLogWidget

Start/Stop button

Search button

AutoScroll checkbox

Developer checkbox

Show Timestamps checkbox

Log list filter tabs

status and Console command bar

Console command context selector

Console command edit box

Monitor Server status

In-Game Preview Connection status

◆ GetActiveTabInfo()

TSharedPtr< FAtomMonitorLogTabInfo > SAtomMonitorLogWidget::GetActiveTabInfo ( ) const

protected

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

Returns: The LogTabs entry, for the currently active tab

◆ InitializeTabLayout()

TSharedRef< FTabManager::FLayout > SAtomMonitorLogWidget::InitializeTabLayout ( const FArguments & Args )

protected

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

Parameters

Args	The widget constructions args

Returns: The layout to be used for initializing the tab widgets

◆ OnClear()

void SAtomMonitorLogWidget::OnClear ( )

protected

Called when the 'Clear Log' context button is clicked

◆ OnCopy()

void SAtomMonitorLogWidget::OnCopy ( )

protected

Called when the 'Copy' context button is clicked

◆ OnFind()

void SAtomMonitorLogWidget::OnFind ( )

protected

Called when the 'Find' context button is clicked

◆ OnGenerateLogRow()

TSharedRef< ITableRow > SAtomMonitorLogWidget::OnGenerateLogRow	(	TSharedRef< FAtomMonitorLogLine >	Item,
		const TSharedRef< STableViewBase > &	OwnerTable )

protected

◆ OnKeyDown()

FReply SAtomMonitorLogWidget::OnKeyDown	(	const FGeometry &	MyGeometry,
		const FKeyEvent &	InKeyboardEvent )

overrideprotectedvirtual

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

Parameters

MyGeometry	The Geometry of the widget receiving the event
InKeyboardEvent	Keyboard event

Returns: Returns whether the event was handled, along with other possible actions

◆ OnMonitorRemoteStateChanged()

void SAtomMonitorLogWidget::OnMonitorRemoteStateChanged	(	const FString &	ClientIP,
		bool	bIsConnected )

Notification from the Monitor (through a delegate), that the monitor remote conncection state has changed.

Parameters

InConnectionInfo The new monitor connection information

◆ OnMonitorStateChanged()

void SAtomMonitorLogWidget::OnMonitorStateChanged	(	const FString &	HostIp,
		uint16	HostPort,
		EAtomMonitorLogState	InMonitorState )

Notification from the Monitor (through a delegate), that the monitor state has changed (for the button text)

Parameters

InMonitorState The new monitor state

◆ ScrollToEnd()

void SAtomMonitorLogWidget::ScrollToEnd ( TSharedRef< FAtomMonitorLogTabInfo > InTab )

protected

Scrolls the specified tab to the last entry

Parameters

InTab The tab which should scroll to the end

◆ ScrollToText()

void SAtomMonitorLogWidget::ScrollToText	(	TSharedRef< FAtomMonitorLogTabInfo >	InTab,
		FString	FindText,
		bool	bSearchUp = false )

protected

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

Parameters

InTab	The tab that the search is being performed in
FindText	The text to find
bSearchUp	Whether or not to search up instead of down

◆ SetServerStatusIcon()

void SAtomMonitorLogWidget::SetServerStatusIcon ( EAtomMonitorLogState InMonitorState ) const

protected

◆ SLATE_BEGIN_ARGS()

SAtomMonitorLogWidget::SLATE_BEGIN_ARGS ( SAtomMonitorLogWidget )

inline

◆ SpawnLogTab()

TSharedRef< SDockTab > SAtomMonitorLogWidget::SpawnLogTab ( const FSpawnTabArgs & InSpawnTabArgs )

protected

Spawns an individual tab for the log list view

'Close Find Bar' 'x' button

'Find' label

Find previous button

Find Next button

Highlight checkbox

Find edit box

Find error label

Log list view

◆ Tick()

void SAtomMonitorLogWidget::Tick	(	const FGeometry &	AllottedGeometry,
		const double	InCurrentTime,
		const float	InDeltaTime )

overrideprotectedvirtual

◆ UpdateFindHighlight()

void SAtomMonitorLogWidget::UpdateFindHighlight	(	TSharedPtr< FAtomMonitorLogTabInfo >	InTab,
		bool	bHighlight,
		FString	HighlightText = TEXT("") )

protected

Updates the find text highlighting for a tab

Parameters

InTab	The tab to update
bHighlight	Whether or not highlighting has been enabled (NOTE: This often differs from the tabs bHighlightFind value)
HighlightText	The text to highlight, if any

Member Data Documentation

◆ bAutoScroll

bool SAtomMonitorLogWidget::bAutoScroll

protected

Whether or not auto-scrolling is currently enabled

◆ bShowTimestamps

bool SAtomMonitorLogWidget::bShowTimestamps

protected

Whether or not showing timestamps in logs

◆ ConsoleComboBox

TSharedPtr<SComboBox<TSharedPtr<FString> > > SAtomMonitorLogWidget::ConsoleComboBox

protected

The combo box for selecting the console command context

◆ ConsoleContextList

TArray<TSharedPtr<FString> > SAtomMonitorLogWidget::ConsoleContextList

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

◆ ConsoleTextBox

TSharedPtr<SEditableTextBox> SAtomMonitorLogWidget::ConsoleTextBox

protected

The console command text box

◆ DefaultConsoleContext

FString SAtomMonitorLogWidget::DefaultConsoleContext

The default console command context (for the combo box)

◆ InGamePreviewStatusText

TSharedPtr<STextBlock> SAtomMonitorLogWidget::InGamePreviewStatusText

◆ LogLines

TArray<TSharedRef<FAtomMonitorLogLine> > SAtomMonitorLogWidget::LogLines

protected

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

◆ LogTabManager

TSharedPtr<FTabManager> SAtomMonitorLogWidget::LogTabManager

protected

The log window tab manager

◆ LogTabs

TArray<TSharedRef<FAtomMonitorLogTabInfo> > SAtomMonitorLogWidget::LogTabs

protected

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

◆ LogWidgetCommands

TSharedPtr<FUICommandList> SAtomMonitorLogWidget::LogWidgetCommands

protected

Log widget context-menu/shortcut-key commands

◆ OnConsoleCommand

FOnConsoleCommand SAtomMonitorLogWidget::OnConsoleCommand

Delegate for handling UI-triggered console commands

◆ OnDeveloperClicked

FOnDeveloperClicked SAtomMonitorLogWidget::OnDeveloperClicked

Notification for developer checkbox click

◆ OnStartStopClicked

FOnSuspendClicked SAtomMonitorLogWidget::OnStartStopClicked

Notification for start/stop button click

◆ ServerStatusBackgroundIcon

TSharedPtr<SImage> SAtomMonitorLogWidget::ServerStatusBackgroundIcon

◆ ServerStatusBadgeIcon

TSharedPtr<SImage> SAtomMonitorLogWidget::ServerStatusBadgeIcon

◆ ServerStatusDownloadIcon

TSharedPtr<SImage> SAtomMonitorLogWidget::ServerStatusDownloadIcon

◆ ServerStatusText

TSharedPtr<STextBlock> SAtomMonitorLogWidget::ServerStatusText

◆ ServerStatusUploadIcon

TSharedPtr<SImage> SAtomMonitorLogWidget::ServerStatusUploadIcon

◆ StartStopButtonText

TSharedPtr<STextBlock> SAtomMonitorLogWidget::StartStopButtonText

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

The documentation for this class was generated from the following files:

C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCoreEditor/Private/Widgets/SAtomMonitorLogWidget.h
C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCoreEditor/Private/Widgets/SAtomMonitorLogWidget.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ SAtomMonitorLogWidget()

Member Function Documentation

◆ AddLine()

◆ ArrayAddNew()

◆ CanAutoScroll()

◆ CanClear()

◆ CanCopy()

◆ CanFind()

◆ Construct()

◆ GetActiveTabInfo()

◆ InitializeTabLayout()

◆ OnClear()

◆ OnCopy()

◆ OnFind()

◆ OnGenerateLogRow()

◆ OnKeyDown()

◆ OnMonitorRemoteStateChanged()

◆ OnMonitorStateChanged()

◆ ScrollToEnd()

◆ ScrollToText()

◆ SetServerStatusIcon()

◆ SLATE_BEGIN_ARGS()

◆ SpawnLogTab()

◆ Tick()

◆ UpdateFindHighlight()

Member Data Documentation

◆ bAutoScroll

◆ bShowTimestamps

◆ ConsoleComboBox

◆ ConsoleContextList

◆ ConsoleTextBox

◆ DefaultConsoleContext

◆ InGamePreviewStatusText

◆ LogLines

◆ LogTabManager

◆ LogTabs

◆ LogWidgetCommands

◆ OnConsoleCommand

◆ OnDeveloperClicked

◆ OnStartStopClicked

◆ ServerStatusBackgroundIcon

◆ ServerStatusBadgeIcon

◆ ServerStatusDownloadIcon

◆ ServerStatusText

◆ ServerStatusUploadIcon

◆ StartStopButtonText