Navigation
API > API/Developer > API/Developer/SourceControl
An abstraction of the state of a file under source control
| Name | ISourceControlState |
| Type | class |
| Header File | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h |
| Include Path | #include "ISourceControlState.h" |
Syntax
class ISourceControlState : public TSharedFromThis< ISourceControlState, ESPMode::ThreadSafe >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → ISourceControlState
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISourceControlState() |
Virtual destructor | ISourceControlState.h |
Structs
| Name | Remarks |
|---|---|
| FResolveInfo |
Enums
Public
| Name | Remarks |
|---|---|
| ISourceControlState |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanAdd() |
Get whether this file can be added to source control (i.e. is part of the directory structure currently under source control) | ISourceControlState.h | |
bool CanCheckIn() |
Get whether this file can be checked in. | ISourceControlState.h | |
bool CanCheckout() |
Get whether this file can be checked out | ISourceControlState.h | |
bool CanDelete() |
Get whether source control allows this file to be deleted. | ISourceControlState.h | |
bool CanEdit() |
Get whether source control allows this file to be edited | ISourceControlState.h | |
bool CanRevert() |
Get whether this file can be reverted, i.e. its changes are discarded and the file will no longer be checked-out. | ISourceControlState.h | |
TSharedPtr< class ISourceControlRevision, ESPMode::ThreadSafe > FindHistoryRevision
(
int32 RevisionNumber |
Find an item from the history with the specified revision number. | ISourceControlState.h | |
TSharedPtr< class ISourceControlRevision, ESPMode::ThreadSafe > FindHistoryRevision
(
const FString& InRevision |
Find an item from the history with the specified revision. | ISourceControlState.h | |
virtual TSharedPtr< class ISourceControlRevision, ESPMode::ThreadSafe > GetBaseRevForMerge() |
Get the revision that we should use as a base when performing a three way merge, does not refresh source control state | ISourceControlState.h | |
| Get the other branches this file is checked out in | ISourceControlState.h | ||
virtual FSourceControlChangelistPtr GetCheckInIdentifier() |
ISourceControlState.h | ||
TSharedPtr< class ISourceControlRevision, ESPMode::ThreadSafe > GetCurrentRevision() |
Get the revision that we are currently synced to | ISourceControlState.h | |
FText GetDisplayName() |
Get a text representation of the state | ISourceControlState.h | |
FText GetDisplayTooltip() |
Get a tooltip to describe this state | ISourceControlState.h | |
const FString & GetFilename() |
Get the local filename that this state represents | ISourceControlState.h | |
TSharedPtr< class ISourceControlRevision, ESPMode::ThreadSafe > GetHistoryItem
(
int32 HistoryIndex |
Get an item from the history | ISourceControlState.h | |
int32 GetHistorySize () |
Get the size of the history. | ISourceControlState.h | |
FSlateIcon GetIcon() |
Gets the icon we should use to display the state in a UI. | ISourceControlState.h | |
virtual FName GetIconName() |
Get the name of the icon graphic we should use to display the state in a UI. | ISourceControlState.h | |
| Get head modification information for other branches | ISourceControlState.h | ||
FString GetOtherUserBranchCheckedOuts() |
Get the user info for checkouts on other branches | ISourceControlState.h | |
virtual FResolveInfo GetResolveInfo() |
Get the file and revision number of the base and remote assets considered in a merge resolve | ISourceControlState.h | |
virtual FName GetSmallIconName() |
Get the name of the small icon graphic we should use to display the state in a UI. | ISourceControlState.h | |
virtual TOptional< FText > GetStatusText () |
Gets the status message associated with this state, if any. | ISourceControlState.h | |
const FDateTime & GetTimeStamp() |
Get the timestamp of the last update that was made to this state. | ISourceControlState.h | |
virtual TOptional< FText > GetWarningText () |
Gets the warnings messages associated with this state, if any. | ISourceControlState.h | |
bool IsAdded() |
Get whether this file is marked for add | ISourceControlState.h | |
bool IsCheckedOut() |
Get whether this file is checked out by the current user | ISourceControlState.h | |
bool IsCheckedOutInOtherBranch
(
const FString& CurrentBranch |
Get whether this file is checked out in a different branch, if no branch is specified defaults to FEngineVerion current branch | ISourceControlState.h | |
bool IsCheckedOutOrModifiedInOtherBranch
(
const FString& CurrentBranch |
Get whether this file is checked out or modified in a different branch, if no branch is specified defaults to FEngineVerion current branch | ISourceControlState.h | |
bool IsCheckedOutOther
(
FString* Who |
Get whether this file is checked out by someone else in the current branch | ISourceControlState.h | |
virtual bool IsConflicted() |
Get whether this file is in a conflicted state | ISourceControlState.h | |
bool IsCurrent() |
Get whether this file is up-to-date with the version in source control | ISourceControlState.h | |
bool IsDeleted() |
Get whether this file is marked for delete | ISourceControlState.h | |
bool IsIgnored() |
Get whether this file is ignored by source control | ISourceControlState.h | |
virtual bool IsLocal() |
Get whether this file is local to the current user (ie, has never been pushed to anyone else) | ISourceControlState.h | |
bool IsModified() |
Get whether this file is modified compared to the version we have from source control | ISourceControlState.h | |
bool IsModifiedInOtherBranch
(
const FString& CurrentBranch |
Get whether this file is modified in a different branch, if no branch is specified defaults to FEngineVerion current branch | ISourceControlState.h | |
bool IsSourceControlled() |
Get whether this file is under source control | ISourceControlState.h | |
bool IsUnknown() |
Get whether we know anything about this files source control state | ISourceControlState.h |