CDirEntry

Public Member Functions
void	AddProperty (const std::string &id, const std::string &value)
	Add a by string defined property entry to directory entry. More...
	CDirEntry (const std::string &label="", const std::string &path="", bool folder=false, int64_t size=-1, time_t dateTime=0)
	Constructor for VFS directory entry. More...
	CDirEntry (const VFSDirEntry &dirEntry)
void	ClearProperties ()
	Clear all present properties. More...
time_t	DateTime ()
	Get file time and date for a new entry. More...
const std::map< std::string, std::string > &	GetProperties () const
	Get the present properties list on directory entry. More...
bool	IsFolder (void) const
	Used to check entry is folder. More...
const std::string &	Label (void) const
	Get the directory entry name. More...
const std::string &	Path (void) const
	Get the path of the entry. More...
void	SetDateTime (time_t dateTime)
	Set file time and date for a new entry. More...
void	SetFolder (bool folder)
	Set the entry defined as folder. More...
void	SetLabel (const std::string &label)
	Set the label name. More...
void	SetPath (const std::string &path)
	Set the path of the entry. More...
void	SetSize (int64_t size)
	Set a file size for a new entry. More...
void	SetTitle (const std::string &title)
	Set the title name. More...
int64_t	Size (void) const
	If file, the size of the file. More...
const std::string &	Title (void) const
	Get the optional title of entry. More...

Member Function Documentation

Label()

const std::string& Label ( void  ) const

inline

Get the directory entry name.

Returns

Name of the entry

Title()

const std::string& Title ( void  ) const

inline

Get the optional title of entry.

Returns

Title of the entry, if exists

Path()

const std::string& Path ( void  ) const

inline

Get the path of the entry.

Returns

File system path of the entry

IsFolder()

bool IsFolder ( void  ) const

inline

Used to check entry is folder.

Returns

true if entry is a folder

Size()

int64_t Size ( void  ) const

inline

If file, the size of the file.

Returns

Defined file size

DateTime()

time_t DateTime ( )

inline

Get file time and date for a new entry.

Returns

The with time_t defined date and time of file

SetLabel()

void SetLabel ( const std::string &  label )

inline

Set the label name.

Parameters

[in]

label

name of entry

SetTitle()

void SetTitle ( const std::string &  title )

inline

Set the title name.

Parameters

[in]

title

title name of entry

SetPath()

void SetPath ( const std::string &  path )

inline

Set the path of the entry.

Parameters

[in]

path

path of entry

SetFolder()

void SetFolder ( bool  folder )

inline

Set the entry defined as folder.

Parameters

[in]

folder

If true becomes entry defined as folder

SetSize()

void SetSize ( int64_t  size )

inline

Set a file size for a new entry.

Parameters

[in]

size

Size to set for dir entry

SetDateTime()

void SetDateTime ( time_t  dateTime )

inline

Set file time and date for a new entry.

Parameters

[in]

dateTime

The with time_t defined date and time of file

AddProperty()

void AddProperty ( const std::string &  id, const std::string &  value  )

inline

Add a by string defined property entry to directory entry.

Note

A property can be used to add some special information about a file or directory entry, this can be used on other places to do the right work of them.

Parameters

[in]	id	Identification name of property
[in]	value	The property value to add by given id

ClearProperties()

void ClearProperties ( )

inline

Clear all present properties.

GetProperties()

const std::map<std::string, std::string>& GetProperties ( ) const

inline

Get the present properties list on directory entry.

Returns

map with all present properties

---

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

• /home/I-Cat/Development/Kodi/kodi-Matrix/xbmc/addons/kodi-dev-kit/include/kodi/Filesystem.h