• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

libkdegames/kggzmod

KGGZMod::Request

KGGZMod::Request Class Reference

#include <request.h>

Inheritance diagram for KGGZMod::Request:

Inheritance graph
[legend]

List of all members.


Detailed Description

Requests to the GGZ core client.

Requests are sent from the game client to the GGZ core client whenever there is a need to change something about the game or to get more information. The first group includes seat changes (standing up, sitting down, booting players, adding bots and removing bots again). The second group includes retrieving extended information about a player or all players. In addition, table chat can also happen through a request.

When using KGGZSeatsDialog, everything except for chat can be left to the dialog.

Author:
Josef Spillner (josef@ggzgamingzone.org)

Definition at line 48 of file request.h.


Public Types

enum  Type {
  state, stand, sit, boot,
  bot, open, chat, info,
  rankings
}

Public Member Functions

 Request (Type type)
Type type () const

Public Attributes

QMap< QString, QString > data

Member Enumeration Documentation

enum KGGZMod::Request::Type

The type of the request.

Depending on this type, the object might be casted to a more specific class.

Enumerator:
state  Change the state.

stand  Stand up from seat.

sit  Sit down again if possible.

boot  Boot a player from table.

bot  Let a bot join the game.

open  Open up a bot seat.

chat  Send a chat message.

info  Request infos about a player.

rankings  Top player rankings for this game.

Definition at line 56 of file request.h.


Constructor & Destructor Documentation

Request::Request ( Type  type  ) 

Creates a request of a specific type.

The request will not be valid until all data fields are properly filled out. It is therefore recommended to not use the request base class, but to use specific classes and their constructors which take care of this.

Parameters:
type Type of the request

Definition at line 25 of file request.cpp.


Member Function Documentation

Request::Type Request::type (  )  const

Returns the type of a request.

Returns:
type of a request

Definition at line 30 of file request.cpp.


Member Data Documentation

QMap<QString, QString> KGGZMod::Request::data

Data storage for all requests.

Independent of the actual type of the request, all important data is stored in this map.

Definition at line 96 of file request.h.


The documentation for this class was generated from the following files:
  • request.h
  • request.cpp

libkdegames/kggzmod

Skip menu "libkdegames/kggzmod"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • kblackbox
  • kgoldrunner
  • kmahjongg
  • ksquares
  • libkdegames
  •   highscore
  •   kgame
  •   kggzgames
  •   kggzmod
  •   kggznet
  • libkmahjongg
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal