MythTV master
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
GameHandler Class Reference

#include <mythplugins/mythgame/mythgame/gamehandler.h>

Inheritance diagram for GameHandler:
[legend]
Collaboration diagram for GameHandler:
[legend]

Public Member Functions

 GameHandler ()=default
 
void InitMetaDataMap (const QString &GameType)
 
void GetMetadata (GameHandler *handler, const QString &rom, QString *Genre, QString *Year, QString *Country, QString *CRC32, QString *GameName, QString *Plot, QString *Publisher, QString *Version, QString *Fanart, QString *Boxart)
 
void promptForRemoval (const GameScan &scan)
 
void UpdateGameDB (GameHandler *handler)
 
void VerifyGameDB (GameHandler *handler)
 
void clearAllGameData (void)
 
void buildFileList (const QString &directory, GameHandler *handler, int *filecount)
 
void processGames (GameHandler *handler)
 
void setRebuild (bool setrebuild)
 
bool needRebuild (void) const
 
bool SpanDisks () const
 
QString SystemName () const
 
QString SystemCmdLine () const
 
QString SystemRomPath () const
 
QString SystemWorkingPath () const
 
QString SystemScreenShots () const
 
uint GamePlayerID () const
 
QString GameType () const
 
QStringList ValidExtensions () const
 

Static Public Member Functions

static void updateSettings (GameHandler *handler)
 
static GameHandler * getHandler (uint i)
 
static GameHandler * newHandler (QString name)
 
static uint count (void)
 
static int buildFileCount (const QString &directory, GameHandler *handler)
 
static void processAllGames (void)
 
static void registerHandler (GameHandler *handler)
 
static void Launchgame (RomInfo *romdata, const QString &systemname)
 
static void EditSettings (RomInfo *romdata)
 
static void EditSystemSettings (RomInfo *romdata)
 
static RomInfo * CreateRomInfo (RomInfo *parent)
 
static RomInfo * create_rominfo (RomInfo *parent)
 
static void clearAllMetadata (void)
 
static GameHandler * GetHandler (RomInfo *rominfo)
 
static GameHandler * GetHandlerByName (const QString &systemname)
 

Protected Member Functions

void customEvent (QEvent *event) override
 

Protected Attributes

bool m_rebuild {false}
 
bool m_spandisks {false}
 
QString m_systemname
 
QString m_rompath
 
QString m_commandline
 
QString m_workingpath
 
QString m_screenshots
 
uint m_gameplayerid {0}
 
QString m_gametype
 
QStringList m_validextensions
 
RomDBMap m_romDB
 
GameScanMap m_gameMap
 
bool m_removeAll {false}
 
bool m_keepAll {false}
 

Private Member Functions

void CreateProgress (const QString &message)
 

Private Attributes

MythUIProgressDialog * m_progressDlg {nullptr}
 

Static Private Attributes

static GameHandler * s_newInstance = nullptr
 

Detailed Description

Definition at line 64 of file gamehandler.h.

Constructor & Destructor Documentation

◆ GameHandler()

GameHandler::GameHandler ( )
default

Referenced by newHandler().

Member Function Documentation

◆ buildFileCount()

int GameHandler::buildFileCount ( const QString &  directory,
GameHandler *  handler 
)
static

Definition at line 573 of file gamehandler.cpp.

Referenced by buildFileCount(), and processGames().

◆ buildFileList()

void GameHandler::buildFileList ( const QString &  directory,
GameHandler *  handler,
int *  filecount 
)

Definition at line 631 of file gamehandler.cpp.

Referenced by buildFileList(), and processGames().

◆ clearAllGameData()

void GameHandler::clearAllGameData ( void  )

Definition at line 611 of file gamehandler.cpp.

◆ clearAllMetadata()

void GameHandler::clearAllMetadata ( void  )
static

Definition at line 988 of file gamehandler.cpp.

Referenced by customEvent().

◆ count()

uint GameHandler::count ( void  )
static

Definition at line 97 of file gamehandler.cpp.

Referenced by GameUI::BuildTree().

◆ create_rominfo()

static RomInfo * GameHandler::create_rominfo ( RomInfo *  parent)
static

◆ CreateProgress()

void GameHandler::CreateProgress ( const QString &  message)
private

Definition at line 996 of file gamehandler.cpp.

Referenced by processGames(), UpdateGameDB(), and VerifyGameDB().

◆ CreateRomInfo()

RomInfo * GameHandler::CreateRomInfo ( RomInfo *  parent)
static

Definition at line 933 of file gamehandler.cpp.

◆ customEvent()

void GameHandler::customEvent ( QEvent *  event)
overrideprotected

Definition at line 946 of file gamehandler.cpp.

◆ EditSettings()

static void GameHandler::EditSettings ( RomInfo *  romdata)
static

◆ EditSystemSettings()

static void GameHandler::EditSystemSettings ( RomInfo *  romdata)
static

◆ GamePlayerID()

uint GameHandler::GamePlayerID ( ) const
inline

Definition at line 110 of file gamehandler.h.

◆ GameType()

QString GameHandler::GameType ( ) const
inline

Definition at line 111 of file gamehandler.h.

Referenced by GetMetadata(), Launchgame(), processGames(), and UpdateGameDB().

◆ GetHandler()

GameHandler * GameHandler::GetHandler ( RomInfo *  rominfo)
static

Definition at line 791 of file gamehandler.cpp.

Referenced by CreateRomInfo(), and Launchgame().

◆ getHandler()

GameHandler * GameHandler::getHandler ( uint  i)
static

Definition at line 55 of file gamehandler.cpp.

Referenced by GameUI::BuildTree().

◆ GetHandlerByName()

GameHandler * GameHandler::GetHandlerByName ( const QString &  systemname)
static

Definition at line 808 of file gamehandler.cpp.

Referenced by GameScanner::doScanAll(), and Launchgame().

◆ GetMetadata()

void GameHandler::GetMetadata ( GameHandler *  handler,
const QString &  rom,
QString *  Genre,
QString *  Year,
QString *  Country,
QString *  CRC32,
QString *  GameName,
QString *  Plot,
QString *  Publisher,
QString *  Version,
QString *  Fanart,
QString *  Boxart 
)

Definition at line 145 of file gamehandler.cpp.

Referenced by UpdateGameDB().

◆ InitMetaDataMap()

void GameHandler::InitMetaDataMap ( const QString &  GameType)

Definition at line 103 of file gamehandler.cpp.

Referenced by processGames().

◆ Launchgame()

void GameHandler::Launchgame ( RomInfo *  romdata,
const QString &  systemname 
)
static

Definition at line 825 of file gamehandler.cpp.

Referenced by GameUI::customEvent(), and GameUI::itemClicked().

◆ needRebuild()

bool GameHandler::needRebuild ( void  ) const
inline

Definition at line 101 of file gamehandler.h.

◆ newHandler()

GameHandler * GameHandler::newHandler ( QString  name)
static

Definition at line 86 of file gamehandler.cpp.

Referenced by checkHandlers().

◆ processAllGames()

void GameHandler::processAllGames ( void  )
static

Definition at line 770 of file gamehandler.cpp.

Referenced by GameCallback().

◆ processGames()

void GameHandler::processGames ( GameHandler *  handler)

Definition at line 679 of file gamehandler.cpp.

◆ promptForRemoval()

void GameHandler::promptForRemoval ( const GameScan &  scan)

Definition at line 218 of file gamehandler.cpp.

Referenced by UpdateGameDB().

◆ registerHandler()

void GameHandler::registerHandler ( GameHandler *  handler)
static

Definition at line 941 of file gamehandler.cpp.

Referenced by checkHandlers().

◆ setRebuild()

void GameHandler::setRebuild ( bool  setrebuild)
inline

Definition at line 100 of file gamehandler.h.

Referenced by processGames().

◆ SpanDisks()

bool GameHandler::SpanDisks ( ) const
inline

Definition at line 104 of file gamehandler.h.

Referenced by Launchgame().

◆ SystemCmdLine()

QString GameHandler::SystemCmdLine ( ) const
inline

Definition at line 106 of file gamehandler.h.

Referenced by Launchgame(), and processGames().

◆ SystemName()

QString GameHandler::SystemName ( ) const
inline

Definition at line 105 of file gamehandler.h.

Referenced by buildFileList(), GameUI::BuildTree(), Launchgame(), processGames(), UpdateGameDB(), updateSettings(), and VerifyGameDB().

◆ SystemRomPath()

QString GameHandler::SystemRomPath ( ) const
inline

Definition at line 107 of file gamehandler.h.

Referenced by processGames().

◆ SystemScreenShots()

QString GameHandler::SystemScreenShots ( ) const
inline

Definition at line 109 of file gamehandler.h.

◆ SystemWorkingPath()

QString GameHandler::SystemWorkingPath ( ) const
inline

Definition at line 108 of file gamehandler.h.

Referenced by Launchgame().

◆ UpdateGameDB()

void GameHandler::UpdateGameDB ( GameHandler *  handler)

Definition at line 385 of file gamehandler.cpp.

Referenced by processGames().

◆ updateSettings()

void GameHandler::updateSettings ( GameHandler *  handler)
static

Definition at line 60 of file gamehandler.cpp.

Referenced by newHandler(), and processAllGames().

◆ ValidExtensions()

QStringList GameHandler::ValidExtensions ( ) const
inline

Definition at line 112 of file gamehandler.h.

◆ VerifyGameDB()

void GameHandler::VerifyGameDB ( GameHandler *  handler)

Definition at line 512 of file gamehandler.cpp.

Referenced by processGames().

Member Data Documentation

◆ m_commandline

QString GameHandler::m_commandline
protected

Definition at line 126 of file gamehandler.h.

Referenced by updateSettings().

◆ m_gameMap

GameScanMap GameHandler::m_gameMap
protected

Definition at line 134 of file gamehandler.h.

Referenced by buildFileList(), processGames(), UpdateGameDB(), and VerifyGameDB().

◆ m_gameplayerid

uint GameHandler::m_gameplayerid {0}
protected

Definition at line 129 of file gamehandler.h.

Referenced by updateSettings().

◆ m_gametype

QString GameHandler::m_gametype
protected

Definition at line 130 of file gamehandler.h.

Referenced by updateSettings().

◆ m_keepAll

bool GameHandler::m_keepAll {false}
protected

Definition at line 137 of file gamehandler.h.

Referenced by customEvent(), and promptForRemoval().

◆ m_progressDlg

MythUIProgressDialog* GameHandler::m_progressDlg {nullptr}
private

Definition at line 143 of file gamehandler.h.

Referenced by buildFileList(), CreateProgress(), processGames(), UpdateGameDB(), and VerifyGameDB().

◆ m_rebuild

bool GameHandler::m_rebuild {false}
protected

Definition at line 122 of file gamehandler.h.

◆ m_removeAll

bool GameHandler::m_removeAll {false}
protected

Definition at line 136 of file gamehandler.h.

Referenced by customEvent(), and promptForRemoval().

◆ m_romDB

RomDBMap GameHandler::m_romDB
protected

Definition at line 133 of file gamehandler.h.

Referenced by GetMetadata(), InitMetaDataMap(), and processGames().

◆ m_rompath

QString GameHandler::m_rompath
protected

Definition at line 125 of file gamehandler.h.

Referenced by updateSettings().

◆ m_screenshots

QString GameHandler::m_screenshots
protected

Definition at line 128 of file gamehandler.h.

Referenced by updateSettings().

◆ m_spandisks

bool GameHandler::m_spandisks {false}
protected

Definition at line 123 of file gamehandler.h.

Referenced by updateSettings().

◆ m_systemname

QString GameHandler::m_systemname
protected

Definition at line 124 of file gamehandler.h.

Referenced by newHandler().

◆ m_validextensions

QStringList GameHandler::m_validextensions
protected

Definition at line 131 of file gamehandler.h.

Referenced by buildFileCount(), buildFileList(), and updateSettings().

◆ m_workingpath

QString GameHandler::m_workingpath
protected

Definition at line 127 of file gamehandler.h.

Referenced by updateSettings().

◆ s_newInstance

GameHandler * GameHandler::s_newInstance = nullptr
staticprivate

Definition at line 141 of file gamehandler.h.

Referenced by newHandler().

The documentation for this class was generated from the following files:
Generated on Sun Oct 19 2025 03:17:09 for MythTV by doxygen 1.9.4