OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Package Functions | Properties | List of all members
OmegaEngine.Storage.FileEntry Class Reference

Describes a file returned by ContentManager.GetFileList. More...

Inheritance diagram for OmegaEngine.Storage.FileEntry:
NanoByte::Common::Controls::IHighlightColor NanoByte::Common::Controls::IContextMenu

Public Member Functions

ContextMenu GetContextMenu ()
 Returns the context menu for this file entry; can be null. More...
 
bool Equals (FileEntry other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Package Functions

 FileEntry ([NotNull] string type, [NotNull, Localizable(false)] string name, FileEntryType entryType=FileEntryType.Normal)
 Creates a new file entry. More...
 

Properties

string FileType [get]
 The type of file (e.g. Textures, Sounds, ...). More...
 
string Name [get, set]
 The relative file path. More...
 
FileEntryType EntryType [get, set]
 The kind of file entry this is (in relation to its mod status). More...
 
Color HighlightColor [get]
 The color to highlight this file entry with in list representations. Color.Empty for FileEntryType.Normal (no highlighting). Color.Blue for FileEntryType.Modified. Color.Green for FileEntryType.Added. Color.Red for FileEntryType.Deleted. More...
 
- Properties inherited from NanoByte::Common::Controls::IHighlightColor
Color HighlightColor
 

Detailed Description

Describes a file returned by ContentManager.GetFileList.

Constructor & Destructor Documentation

OmegaEngine.Storage.FileEntry.FileEntry ( [NotNull] string  type,
[NotNull, Localizable(false)] string  name,
FileEntryType  entryType = FileEntryType.Normal 
)
inlinepackage

Creates a new file entry.

Parameters
typeThe type of file (e.g. Textures, Sounds, ...).
nameThe relative file path.
entryTypeThe kind of file entry this is (in relation to its mod status).

Member Function Documentation

ContextMenu OmegaEngine.Storage.FileEntry.GetContextMenu ( )
inline

Returns the context menu for this file entry; can be null.

Implements NanoByte::Common::Controls::IContextMenu.

Property Documentation

FileEntryType OmegaEngine.Storage.FileEntry.EntryType
getset

The kind of file entry this is (in relation to its mod status).

string OmegaEngine.Storage.FileEntry.FileType
get

The type of file (e.g. Textures, Sounds, ...).

This is only used for file operations and not for sorting!

Color OmegaEngine.Storage.FileEntry.HighlightColor
get

The color to highlight this file entry with in list representations. Color.Empty for FileEntryType.Normal (no highlighting). Color.Blue for FileEntryType.Modified. Color.Green for FileEntryType.Added. Color.Red for FileEntryType.Deleted.

string OmegaEngine.Storage.FileEntry.Name
getset

The relative file path.


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