|
|
///////////////////////////////////////////////////////////////////// // /// // GGZCore++ - C++ API wrapper for the ggzcore library /// // Copyright (C) 2001, 2002 Josef Spillner /// // dr_maux@users.sourceforge.net /// // The MindX Open Source Project /// // http://mindx.sourceforge.net/ /// // /// // This library may be distributed under the terms of the GNU GPL. /// // /// //////////////////////////////////////////////////////////////////// ///// GGZ Module ///////////////////////////////////////////////// #ifndef GGZMODULE_H #define GGZMODULE_H #include/** * * A certain game module and its actual configuration can be handled by GGZCoreModule. * This class should be used for launching games. * */ class GGZCoreModule { public: /** * Constructor */ GGZCoreModule(); /** * Destructor */ ~GGZCoreModule(); /** * Return all available games. */ unsigned int countAll(); /** * Return all games which match the given type. */ unsigned int count(); /** * Add a game. */ int add(const char* game, const char* version, const char* protocol, const char *engine, const char* author, const char* frontend, const char* url, const char* exe_path, const char* icon_path, const char* help_path); /** * Launch this module. */ int launch(); /** * Return the name of this game module. */ char* game(); /** * Return the version of this game module. */ char* version(); /** * Return the protocol version of this game module. */ char* protocolVersion(); /** * Return the associated protocol engine. */ char *protocolEngine(); /** * Return the author of this game module. */ char* author(); /** * Return the frontend type of this game module. */ char* frontend(); /** * Return the homepage of this game module. */ char* url(); /** * Return the execution path of this game module, including command line options. */ char** argv(); /** * Return the icon path of this game module. */ char* pathIcon(); /** * Return the help path of this game module. */ char* pathHelp(); /** * Initialize this module to find out compatible ones. */ void init(const char* game, const char* protocol, const char *engine); /** * Select a module as the active one. */ void setActive(const unsigned int number); /** * Retreive the internal ggzcore module object. */ GGZModule *module(); private: GGZModule* m_module; char *m_game; char *m_protocol; char *m_engine; }; #endif
Generated by: josef on athlon500 on Tue Mar 19 23:18:22 2002, using kdoc 2.0a53. |