CInfoScanner Class Reference

#include <InfoScanner.h>

Inheritance diagram for CInfoScanner:

Public Types
enum	INFO_RET {   INFO_CANCELLED , INFO_ERROR , INFO_NOT_NEEDED , INFO_HAVE_ALREADY ,   INFO_NOT_FOUND , INFO_ADDED }
	Return values from the information lookup functions. More...
enum	INFO_TYPE {   NO_NFO = 0 , FULL_NFO = 1 , URL_NFO = 2 , OVERRIDE_NFO = 3 ,   COMBINED_NFO = 4 , ERROR_NFO = 5 , TITLE_NFO = 6 }

Public Member Functions
virtual	~CInfoScanner ()=default
	Empty destructor.
virtual bool	DoScan (const std::string &strDirectory)=0
bool	HasNoMedia (const std::string &strDirectory) const
	Check if the folder is excluded from scanning process.
void	ShowDialog (bool show)
	Set whether or not to show a progress dialog.
bool	IsScanning () const
	Returns whether or not a scan is in progress.

Protected Member Functions
	CInfoScanner ()=default
	Protected constructor to only allow subclass instances.

Protected Attributes
std::set< std::string >	m_pathsToScan
	Set of paths to scan.
bool	m_showDialog = false
	Whether or not to show progress bar dialog.
CGUIDialogProgressBarHandle *	m_handle = nullptr
	Progress bar handle.
bool	m_bRunning = false
	Whether or not scanner is running.
bool	m_bCanInterrupt = false
	Whether or not scanner is currently interruptible.
bool	m_bClean = false
	Whether or not to perform cleaning during scanning.

Member Enumeration Documentation

INFO_RET

enum CInfoScanner::INFO_RET

Return values from the information lookup functions.

Enumerator
INFO_CANCELLED
INFO_ERROR
INFO_NOT_NEEDED
INFO_HAVE_ALREADY
INFO_NOT_FOUND
INFO_ADDED

INFO_TYPE

enum CInfoScanner::INFO_TYPE

Enumerator
NO_NFO	No info found.
FULL_NFO	Full info specified.
URL_NFO	A URL to grab info from was found.
OVERRIDE_NFO	Override info was found.
COMBINED_NFO	A URL to grab info from + override info was found.
ERROR_NFO	Error processing info.
TITLE_NFO	At least Title was read (and optionally the Year)

Constructor & Destructor Documentation

~CInfoScanner()

virtual CInfoScanner::~CInfoScanner ( )

virtualdefault

Empty destructor.

CInfoScanner()

CInfoScanner::CInfoScanner ( )

protecteddefault

Protected constructor to only allow subclass instances.

Member Function Documentation

DoScan()

virtual bool CInfoScanner::DoScan ( const std::string & strDirectory )

pure virtual

Implemented in MUSIC_INFO::CMusicInfoScanner, and KODI::VIDEO::CVideoInfoScanner.

HasNoMedia()

bool CInfoScanner::HasNoMedia

(

const std::string &

strDirectory

)

const

Check if the folder is excluded from scanning process.

Parameters

strDirectory

Directory to scan

Returns

true if there is a .nomedia file

IsScanning()

bool CInfoScanner::IsScanning ( ) const

inline

Returns whether or not a scan is in progress.

ShowDialog()

void CInfoScanner::ShowDialog ( bool show )

inline

Set whether or not to show a progress dialog.

Member Data Documentation

m_bCanInterrupt

bool CInfoScanner::m_bCanInterrupt = false

protected

Whether or not scanner is currently interruptible.

m_bClean

bool CInfoScanner::m_bClean = false

protected

Whether or not to perform cleaning during scanning.

m_bRunning

bool CInfoScanner::m_bRunning = false

protected

Whether or not scanner is running.

m_handle

CGUIDialogProgressBarHandle* CInfoScanner::m_handle = nullptr

protected

Progress bar handle.

m_pathsToScan

std::set<std::string> CInfoScanner::m_pathsToScan

protected

Set of paths to scan.

m_showDialog

bool CInfoScanner::m_showDialog = false

protected

Whether or not to show progress bar dialog.

---

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

• InfoScanner.h
• InfoScanner.cpp