Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
FileItem.h File Reference
#include "LockType.h"
#include "XBDateTime.h"
#include "guilib/GUIListItem.h"
#include "threads/CriticalSection.h"
#include "utils/IArchivable.h"
#include "utils/ISerializable.h"
#include "utils/ISortable.h"
#include "utils/SortUtils.h"
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>

Classes

class  CFileItem
 Represents a file on a share. More...
 

Namespaces

namespace  ADDON
 
namespace  MUSIC_INFO
 
namespace  KODI
 
namespace  KODI::GAME
 
namespace  PVR
 

Macros

#define STARTOFFSET_RESUME   (-1)
 

Typedefs

typedef std::shared_ptr< CCueDocumentCCueDocumentPtr
 
typedef std::shared_ptr< const IEventEventPtr
 
typedef std::shared_ptr< CFileItemCFileItemPtr
 A shared pointer to CFileItem.
 
typedef std::vector< CFileItemPtrVECFILEITEMS
 A vector of pointer to CFileItem.
 
typedef std::vector< CFileItemPtr >::iterator IVECFILEITEMS
 Iterator for VECFILEITEMS.
 
typedef std::map< std::string, CFileItemPtrMAPFILEITEMS
 A map of pointers to CFileItem.
 
typedef std::pair< std::string, CFileItemPtrMAPFILEITEMSPAIR
 Pair for MAPFILEITEMS.
 
typedef bool(* FILEITEMLISTCOMPARISONFUNC) (const CFileItemPtr &pItem1, const CFileItemPtr &pItem2)
 
typedef void(* FILEITEMFILLFUNC) (CFileItemPtr &item)
 

Enumerations

enum  EFileFolderType {
  EFILEFOLDER_TYPE_ALWAYS = 1<<0 , EFILEFOLDER_TYPE_ONCLICK = 1<<1 , EFILEFOLDER_TYPE_ONBROWSE = 1<<2 , EFILEFOLDER_MASK_ALL = 0xff ,
  EFILEFOLDER_MASK_ONCLICK , EFILEFOLDER_MASK_ONBROWSE
}
 

Macro Definition Documentation

◆ STARTOFFSET_RESUME

#define STARTOFFSET_RESUME   (-1)

Typedef Documentation

◆ CCueDocumentPtr

typedef std::shared_ptr<CCueDocument> CCueDocumentPtr

◆ CFileItemPtr

typedef std::shared_ptr<CFileItem> CFileItemPtr

A shared pointer to CFileItem.

See also
CFileItem

◆ EventPtr

typedef std::shared_ptr<const IEvent> EventPtr

◆ FILEITEMFILLFUNC

typedef void(* FILEITEMFILLFUNC) (CFileItemPtr &item)

◆ FILEITEMLISTCOMPARISONFUNC

typedef bool(* FILEITEMLISTCOMPARISONFUNC) (const CFileItemPtr &pItem1, const CFileItemPtr &pItem2)

◆ IVECFILEITEMS

typedef std::vector<CFileItemPtr>::iterator IVECFILEITEMS

Iterator for VECFILEITEMS.

See also
CFileItemList

◆ MAPFILEITEMS

typedef std::map<std::string, CFileItemPtr > MAPFILEITEMS

A map of pointers to CFileItem.

See also
CFileItem

◆ MAPFILEITEMSPAIR

typedef std::pair<std::string, CFileItemPtr > MAPFILEITEMSPAIR

Pair for MAPFILEITEMS.

See also
MAPFILEITEMS

◆ VECFILEITEMS

typedef std::vector< CFileItemPtr > VECFILEITEMS

A vector of pointer to CFileItem.

See also
CFileItem

Enumeration Type Documentation

◆ EFileFolderType

Enumerator
EFILEFOLDER_TYPE_ALWAYS 
EFILEFOLDER_TYPE_ONCLICK 
EFILEFOLDER_TYPE_ONBROWSE 
EFILEFOLDER_MASK_ALL 
EFILEFOLDER_MASK_ONCLICK 
EFILEFOLDER_MASK_ONBROWSE