• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdegames API Reference
  • KDE Home
  • Contact Us
 

kmahjongg

Public Member Functions | Public Attributes | Protected Member Functions | List of all members
BoardLayout Class Reference

#include <BoardLayout.h>

Public Member Functions

 BoardLayout ()
 
 BoardLayout (const BoardLayout &boardLayout)
 
 ~BoardLayout ()
 
bool allFilled (POSITION &p)
 
bool anyFilled (POSITION &p)
 
bool blockedLeftOrRight (short z, short y, short x)
 
void clearBoardLayout ()
 
void copyBoardLayout (UCHAR *to, unsigned short &numTiles)
 
void deleteTile (POSITION &p)
 
QByteArray getBoard () const
 
UCHAR getBoardData (short z, short y, short x)
 
QString getFilename () const
 
QByteArray getLoadedBoard () const
 
unsigned short getMaxTileNum () const
 
void insertTile (POSITION &p)
 
bool isTileAt (POSITION &p)
 
bool loadBoardLayout (const QString &from)
 
bool loadBoardLayout_10 (const QString &from)
 
bool saveBoardLayout (const QString &where)
 
void setBoardData (short z, short y, short x, UCHAR value)
 
void shiftDown ()
 
void shiftLeft ()
 
void shiftRight ()
 
void shiftUp ()
 
bool tileAbove (short z, short y, short x)
 
bool tileAbove (POSITION &p)
 

Public Attributes

int m_depth
 
int m_height
 
int m_maxTiles
 
int m_width
 

Protected Member Functions

void initialiseBoard ()
 

Detailed Description

This class implements methods for loading and manipulating board.

longer description

Author
Mauricio Piacentini mauri.nosp@m.cio@.nosp@m.tabul.nosp@m.eiro.nosp@m..com

Definition at line 36 of file BoardLayout.h.

Constructor & Destructor Documentation

BoardLayout::BoardLayout ( )

Default Constructor.

Definition at line 25 of file BoardLayout.cpp.

BoardLayout::BoardLayout ( const BoardLayout &  boardLayout)

Copy constructor.

Definition at line 35 of file BoardLayout.cpp.

BoardLayout::~BoardLayout ( )

Default Deconstructor.

Definition at line 47 of file BoardLayout.cpp.

Member Function Documentation

bool BoardLayout::allFilled ( POSITION &  p)

Description.

Parameters
&pblah blah pos
Returns
true if title abowe
false if title not abowe

Definition at line 397 of file BoardLayout.cpp.

bool BoardLayout::anyFilled ( POSITION &  p)

Description.

Parameters
&pblah blah pos
Returns
true if title abowe
false if title not abowe

Definition at line 391 of file BoardLayout.cpp.

bool BoardLayout::blockedLeftOrRight ( short  z,
short  y,
short  x 
)

is this tile blocked to the left or right

Parameters
zblah blah
yblah blah
xblah blah
Returns
true if ...
false if ...

Definition at line 376 of file BoardLayout.cpp.

void BoardLayout::clearBoardLayout ( )

Method description.

Definition at line 71 of file BoardLayout.cpp.

void BoardLayout::copyBoardLayout ( UCHAR *  to,
unsigned short &  numTiles 
)

Description.

Parameters
*toblah blah
&numTilesblah blah

Definition at line 266 of file BoardLayout.cpp.

void BoardLayout::deleteTile ( POSITION &  p)

Description.

Parameters
&pblah blah pos

Definition at line 381 of file BoardLayout.cpp.

QByteArray BoardLayout::getBoard ( ) const

Get the board.

Definition at line 61 of file BoardLayout.cpp.

UCHAR BoardLayout::getBoardData ( short  z,
short  y,
short  x 
)

Method description.

Parameters
zblah blah
yblah blah
xblah blah
Returns
UCHAR ...

Definition at line 410 of file BoardLayout.cpp.

QString BoardLayout::getFilename ( ) const

Get filename.

Returns
filename

Definition at line 51 of file BoardLayout.cpp.

QByteArray BoardLayout::getLoadedBoard ( ) const

Get the loaded board.

Definition at line 56 of file BoardLayout.cpp.

unsigned short BoardLayout::getMaxTileNum ( ) const

Get max tile num.

Definition at line 66 of file BoardLayout.cpp.

void BoardLayout::initialiseBoard ( )
protected

Protected Method description.

Definition at line 219 of file BoardLayout.cpp.

void BoardLayout::insertTile ( POSITION &  p)

Description.

Parameters
&pblah blah
See also
pos

Definition at line 403 of file BoardLayout.cpp.

bool BoardLayout::isTileAt ( POSITION &  p)
inline

Description.

Parameters
&pblah blah
See also
pos
Returns
true if title abowe
false if title not abowe

Definition at line 164 of file BoardLayout.h.

bool BoardLayout::loadBoardLayout ( const QString &  from)

Method description.

Parameters
fromblah blah
Returns
true if ...
false if ...

Definition at line 165 of file BoardLayout.cpp.

bool BoardLayout::loadBoardLayout_10 ( const QString &  from)

Method description.

Parameters
fromblah blah
Returns
true if ...
false if ...
See also
loadBoardLayout

Definition at line 120 of file BoardLayout.cpp.

bool BoardLayout::saveBoardLayout ( const QString &  where)

Method description.

Parameters
whereblah blah
Returns
true if ...
false if ...
See also
loadBoardLayout

Definition at line 76 of file BoardLayout.cpp.

void BoardLayout::setBoardData ( short  z,
short  y,
short  x,
UCHAR  value 
)

Method description.

Parameters
zblah blah
yblah blah
xblah blah
valueblah blah

Definition at line 414 of file BoardLayout.cpp.

void BoardLayout::shiftDown ( )

Method description.

Definition at line 339 of file BoardLayout.cpp.

void BoardLayout::shiftLeft ( )

Method description.

Definition at line 271 of file BoardLayout.cpp.

void BoardLayout::shiftRight ( )

Method description.

Definition at line 293 of file BoardLayout.cpp.

void BoardLayout::shiftUp ( )

Method description.

Definition at line 313 of file BoardLayout.cpp.

bool BoardLayout::tileAbove ( short  z,
short  y,
short  x 
)

is there a tile anywhere above here (top left to bot right quarter)

Parameters
zblah blah
yblah blah
xblah blah
Returns
true if title abowe
false if title not abowe

Definition at line 366 of file BoardLayout.cpp.

bool BoardLayout::tileAbove ( POSITION &  p)
inline

is there a tile anywhere above here (top left to bot right quarter)

Parameters
&pblah blah pos
Returns
true if title abowe
false if title not abowe
See also
tileAbove

Definition at line 115 of file BoardLayout.h.

Member Data Documentation

int BoardLayout::m_depth

Member Description.

Definition at line 207 of file BoardLayout.h.

int BoardLayout::m_height

Member Description.

Definition at line 206 of file BoardLayout.h.

int BoardLayout::m_maxTiles

Member Description.

Definition at line 208 of file BoardLayout.h.

int BoardLayout::m_width

Member Description.

Definition at line 205 of file BoardLayout.h.


The documentation for this class was generated from the following files:
  • BoardLayout.h
  • BoardLayout.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:18:33 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kmahjongg

Skip menu "kmahjongg"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdegames API Reference

Skip menu "kdegames API Reference"
  • granatier
  • kapman
  • kblackbox
  • kgoldrunner
  • kigo
  • kmahjongg
  • KShisen
  • ksquares
  • libkdegames
  •   highscore
  •   libkdegamesprivate
  •     kgame
  • libkmahjongg
  • palapeli
  •   libpala

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal