xbmc
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CInfoScanner Class Referenceabstract
Inheritance diagram for CInfoScanner:
Inheritance graph
[legend]
Collaboration diagram for CInfoScanner:
Collaboration graph
[legend]

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.
 
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. More...
 
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.
 
CGUIDialogProgressBarHandlem_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_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)

Member Function Documentation

◆ HasNoMedia()

bool CInfoScanner::HasNoMedia ( const std::string &  strDirectory) const

Check if the folder is excluded from scanning process.

Parameters
strDirectoryDirectory to scan
Returns
true if there is a .nomedia file

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