ISourceControlState

An abstraction of the state of a file under source control

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

ISourceControlState

References

Module

SourceControl

Header

/Engine/Source/Developer/SourceControl/Public/ISourceControlState.h

Include

#include "ISourceControlState.h"

Syntax

Remarks

An abstraction of the state of a file under source control

Destructors

Name Description

Public function Virtual

~ISourceControlState()

Virtual destructor

Functions

Name Description

Public function Const

bool

 

CanAdd()

Get whether this file can be added to source control (i.e. is part of the directory structure currently under source control)

Public function Const

bool

 

CanCheckIn()

Get whether this file can be checked in.

Public function Const

bool

 

CanCheckout()

Get whether this file can be checked out

Public function Const

bool

 

CanDelete()

Get whether source control allows this file to be deleted.

Public function Const

bool

 

CanEdit()

Get whether source control allows this file to be edited

Public function Const

bool

 

CanRevert()

Get whether this file can be reverted, i.e. its changes are discarded and the file will no longer be checked-out.

Public function Const

TSharedPtr< ...

 

FindHistoryRevision

(
    int32 RevisionNumber
)

Find an item from the history with the specified revision number.

Public function Const

TSharedPtr< ...

 

FindHistoryRevision

(
    const FString& InRevision
)

Find an item from the history with the specified revision.

Public function Const

TSharedPtr< ...

 

GetBaseRevForMerge()

Get the revision that we should use as a base when performing a three wage merge, does not refresh source control state

Public function Const

TArray< FStr...

 

GetCheckedOutBranches()

Get the other branches this file is checked out in

Public function Const

FText

 

GetDisplayName()

Get a text representation of the state

Public function Const

FText

 

GetDisplayTooltip()

Get a tooltip to describe this state

Public function Const

const FStrin...

 

GetFilename()

Get the local filename that this state represents

Public function Const

TSharedPtr< ...

 

GetHistoryItem

(
    int32 HistoryIndex
)

Get an item from the history

Public function Const

int32

 

GetHistorySize()

Get the size of the history.

Public function Const

FName

 

GetIconName()

Get the name of the icon graphic we should use to display the state in a UI.

Public function Const

bool

 

GetOtherBranchHeadModification

(
    FString& HeadBranchOut,
    FString& ActionOut,
    int32& HeadChangeListOut
)

Get head modification information for other branches

Public function Const

FString

 

GetOtherUserBranchCheckedOuts()

Get the user info for checkouts on other branches

Public function Const

FName

 

GetSmallIconName()

Get the name of the small icon graphic we should use to display the state in a UI.

Public function Const

const FDateT...

 

GetTimeStamp()

Get the timestamp of the last update that was made to this state.

Public function Const

bool

 

IsAdded()

Get whether this file is marked for add

Public function Const

bool

 

IsCheckedOut()

Get whether this file is checked out

Public function Const

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

Public function Const

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

Public function Const

bool

 

IsCheckedOutOther

(
    FString* Who
)

Get whether this file is checked out by someone else in the current branch

Public function Const

bool

 

IsConflicted()

Get whether this file is in a conflicted state

Public function Const

bool

 

IsCurrent()

Get whether this file is up-to-date with the version in source control

Public function Const

bool

 

IsDeleted()

Get whether this file is marked for delete

Public function Const

bool

 

IsIgnored()

Get whether this file is ignored by source control

Public function Virtual Const

bool

 

IsLocal()

Get whether this file is local to the current user (ie, has never been pushed to anyone else)

Public function Const

bool

 

IsModified()

Get whether this file is modified compared to the version we have from source control

Public function Const

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

Public function Const

bool

 

IsSourceControlled()

Get whether this file is under source control

Public function Const

bool

 

IsUnknown()

Get whether we know anything about this files source control state

Constants

Name

Description

INVALID_REVISION

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