Navigation
API > API/Developer > API/Developer/SharedSettingsWidgets
Implements a widget that provides a notice for files that need to be checked out.
| Name | SSettingsEditorCheckoutNotice |
| Type | class |
| Header File | /Engine/Source/Developer/SharedSettingsWidgets/Public/SSettingsEditorCheckoutNotice.h |
| Include Path | #include "SSettingsEditorCheckoutNotice.h" |
Syntax
class SSettingsEditorCheckoutNotice : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SSettingsEditorCheckoutNotice
- FSlateControlledConstruction → SWidget → SCompoundWidget → SSettingsEditorCheckoutNotice
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ConfigFilePath | TAttribute< FString > | The current file being watched. | SSettingsEditorCheckoutNotice.h | |
| DefaultConfigCheckOutNeeded | bool | Holds a flag indicating whether the section's configuration file needs to be checked out. | SSettingsEditorCheckoutNotice.h | |
| DefaultConfigQueryInProgress | bool | Holds a flag indicating whether the section's configuration file has a source control status request in progress. | SSettingsEditorCheckoutNotice.h | |
| LastDefaultConfigCheckOutTime | double | Holds a timer for checking whether the section's configuration file needs to be checked out. | SSettingsEditorCheckoutNotice.h | |
| OnFileProbablyModifiedExternally | FSimpleDelegate | Called when the file was modified externally. | SSettingsEditorCheckoutNotice.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Constructs the widget. | SSettingsEditorCheckoutNotice.h | |
void Invalidate() |
Force an update on the next tick. | SSettingsEditorCheckoutNotice.h | |
bool IsUnlocked() |
Return true if the watched file can be modified (as of the last update) | SSettingsEditorCheckoutNotice.h | |
virtual void Tick
(
const FGeometry& AllottedGeometry, |
SSettingsEditorCheckoutNotice.h |