KardSelection Class Reference

#include <kardselection.h>

Collaboration diagram for KardSelection:

Detailed Description

This is a dialogue that presents a user with a sequence of cards and requests that they choose a specific number of them.


Public Member Functions
	KardSelection (const QString &caption, int number, const CardSequence &choices, const QString &cardImagePath="", const QString &cardBackImage="", QWidget *parent=0, bool modal=true)
const CardSequence &	selection () const
	~KardSelection ()

KardSelection::KardSelection	(	const QString &	caption,
		int	number,
		const CardSequence &	choices,
		const QString &	cardImagePath = `""`,
		const QString &	cardBackImage = `""`,
		QWidget *	parent = `0`,
		bool	modal = `true`
	)

Creates a dialogue to select a specific number of presented cards.

Parameters:

	caption	is the caption to display for the user, usually explaining what they need to do.
	number	is how many cards the user must select.
	choices	are the cards that a user can choose from.
	cardImagePath	is the path to the directory that holds the images for the front of the kards.
	cardBackImage	is the filename of the image for the back of our kards.
	parent	is the parent of the dialogue.
	modal	determines if the dialogue should be modal or not.

Note:: The dialogue will not be able to exit with an accept status until the user has selected exactly the number of cards requested.

KardSelection::~KardSelection ( )

Widget destructor.

const CardSequence & KardSelection::selection ( ) const

Gives the selection that the user has made.

Exceptions:

KardsGTError

if a selection has not been made by a user.

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