Navigation
API > API/Editor > API/Editor/UnrealEd
Simple class to represent a combined MRU and favorite map list
| Name | FMainMRUFavoritesList |
| Type | class |
| Header File | /Engine/Source/Editor/UnrealEd/Public/MRUFavoritesList.h |
| Include Path | #include "MRUFavoritesList.h" |
Syntax
class FMainMRUFavoritesList : public FMRUList
Inheritance Hierarchy
- FMRUList → FMainMRUFavoritesList
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Constructor | MRUFavoritesList.h | ||
FMainMRUFavoritesList
(
const FString& IniSectionOverride, |
MRUFavoritesList.h | ||
FMainMRUFavoritesList
(
const FString& IniSectionOverride, |
MRUFavoritesList.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMainMRUFavoritesList() |
Destructor | MRUFavoritesList.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FDoesMRUFavoritesItemPassFilter | TBaseDelegate_OneParam< bool, const FString &MRUFavoritesItem > | MRUFavoritesList.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DoesMRUFavoritesItemPassFilter | FDoesMRUFavoritesItemPassFilter | Filter delegate | MRUFavoritesList.h | |
| FavoriteItems | TArray< FString > | Favorited items | MRUFavoritesList.h | |
| INIFavoritesSection | FString | INI section to read/write favorite items to | MRUFavoritesList.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddFavoritesItem
(
const FString& Item |
Add a new file item to the favorites listAdd a new item to the favorites list | MRUFavoritesList.h | |
bool ContainsFavoritesItem
(
const FString& Item |
Returns whether a filename is favorited or not | MRUFavoritesList.h | |
bool FavoritesItemPassesCurrentFilter
(
int32 ItemIndex |
Checks the favorites item specified by the provided index against the optional 'DoesMRUFavoritesItemPassFilterDelegate'. | MRUFavoritesList.h | |
FString GetFavoritesItem
(
int32 ItemIndex |
Return the favorites item specified by the provided index | MRUFavoritesList.h | |
int32 GetNumFavorites() |
Returns the number of favorites items | MRUFavoritesList.h | |
void MoveFavoritesItemToHead
(
const FString& Item |
Moves the specified favorites item to the head of the list | MRUFavoritesList.h | |
bool MRUItemPassesCurrentFilter
(
int32 ItemIndex |
Checks the MRU item specified by the provided index against the optional 'DoesMRUFavoritesItemPassFilterDelegate'. | MRUFavoritesList.h | |
void RegisterDoesMRUFavoritesItemPassFilterDelegate
(
FDoesMRUFavoritesItemPassFilter DoesMRUFavoritesItemPassFilterDelegate |
Supplies an optional delegate that can be used to filter a given MRUFavorites item Useful for dynamically verifying which items should be utilized at a given time | MRUFavoritesList.h | |
void RemoveFavoritesItem
(
const FString& Item |
Remove a file from the favorites listRemove an item from the favorites list | MRUFavoritesList.h | |
void UnregisterDoesMRUFavoritesItemPassFilterDelegate() |
Unregisters the optional filter delegate | MRUFavoritesList.h | |
bool VerifyFavoritesFile
(
int32 ItemIndex |
Verifies that the favorites item specified by the provided index still exists. | MRUFavoritesList.h |
Overridden from FMRUList
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReadFromINI() |
Populate MRU/Favorites list by reading saved values from the relevant INI file | MRUFavoritesList.h | |
virtual void WriteToINI() |
Save off the state of the MRU and favorites lists to the relevant INI file | MRUFavoritesList.h |