CreateServerDialogApi Class Reference

Plugin proxy for CreateServerDialog. More...

#include <createserverdialogapi.h>

Public Member Functions

QDialog * dialog () const
 Accesses underlying CreateServerDialog as a QDialog. More...
 
bool fillInCommandLineArguments (QString &executable, QStringList &args)
 When QDialog is closed with 'accepted' state, this method will build appropriate command line. More...
 
void makeRemoteGameSetup (const EnginePlugin *plugin)
 Configures the dialog box for a setup of a remote game. More...
 
void setIwadByName (const QString &iwad)
 Attempt to chose default IWAD by name. More...
 

Static Public Member Functions

static CreateServerDialogApicreateNew (QWidget *parent)
 Constructs a new CreateServerDialog that is deleted when the API object is deleted. More...
 

Detailed Description

Plugin proxy for CreateServerDialog.

Spawns a new CreateServerDialog object with a parent specified in the constructor. The dialog can be accessed through dialog() accessor, although the method returns a pointer to QDialog only as this is the highest-level class that is still accessible by plugins. All CreateServerDialog methods need to be accessed through methods of this proxy class.

Deleting this proxy object will also delete underlying CreateServerDialog. This object cannot be copied.

Definition at line 45 of file createserverdialogapi.h.

Member Function Documentation

CreateServerDialogApi * CreateServerDialogApi::createNew ( QWidget *  parent)
static

Constructs a new CreateServerDialog that is deleted when the API object is deleted.

Definition at line 50 of file createserverdialogapi.cpp.

QDialog * CreateServerDialogApi::dialog ( ) const

Accesses underlying CreateServerDialog as a QDialog.

You can call here any methods that you'd call on a QDialog: show(), exec(), setAttribute(), and so on.

Definition at line 56 of file createserverdialogapi.cpp.

bool CreateServerDialogApi::fillInCommandLineArguments ( QString &  executable,
QStringList &  args 
)

When QDialog is closed with 'accepted' state, this method will build appropriate command line.

Parameters
executableGame executable as set by the dialog.
argsAll arguments determined by the dialog.

Definition at line 61 of file createserverdialogapi.cpp.

void CreateServerDialogApi::makeRemoteGameSetup ( const EnginePlugin plugin)

Configures the dialog box for a setup of a remote game.

Certain games provide remote servers that can be configured before the game is started. By calling this method you disable all widgets that would modify networking parameters. Also, the game executable is by default set to "client" instead of "server".

Definition at line 67 of file createserverdialogapi.cpp.

void CreateServerDialogApi::setIwadByName ( const QString &  iwad)

Attempt to chose default IWAD by name.

Attempts to set the path to the IWAD. It might be unsuccessful if IWAD cannot be found in any directory that was preconfigured by the user. In this case the method fails silently and does nothing.

Definition at line 73 of file createserverdialogapi.cpp.


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