KCardDialog Class Reference

A carddeck selection dialog for card games. More...

#include <kcarddialog.h>

Collaboration diagram for KCardDialog:

[legend]List of all members.

Public Types
enum	CardFlags { Both = 0, NoDeck = 0x01, NoCards = 0x02 }
Public Member Functions
	KCardDialog (QWidget *parent=NULL, const char *name=NULL, CardFlags flags=Both)
	Constructs a card deck selection dialog.
	~KCardDialog ()
	Destructs a card deck selection dialog.
void	showRandomDeckBox (bool s)
	Show or hides the "random backside" checkbox.
void	showRandomCardDirBox (bool s)
	Show or hides the "random foreside" checkbox.
const QString &	deck () const
	Returns the chosen deck, which is a valid path to a imagefile.
void	setDeck (const QString &file)
	Sets the default deck.
const QString &	cardDir () const
void	setCardDir (const QString &dir)
	Sets the default card directory.
CardFlags	flags () const
void	setupDialog (bool showResizeBox=false)
	Creates the default widgets in the dialog.
bool	isRandomDeck () const
bool	isRandomCardDir () const
bool	isGlobalDeck () const
bool	isGlobalCardDir () const
double	cardScale () const
void	loadConfig (KConfig *conf)
	Load the default settings into the dialog (e.g.
void	saveConfig (KConfig *conf)
	Saves the KCardDialog config into a config file.
Static Public Member Functions
static int	getCardDeck (QString &deck, QString &carddir, QWidget *parent=0, CardFlags flags=Both, bool *randomDeck=0, bool *randomCardDir=0, double *scale=0, KConfig *conf=0)
	Creates a modal carddeck dialog, lets the user choose a deck, and returns when the dialog is closed.
static void	getConfigCardDeck (KConfig *conf, QString &deck, QString &cardDir, double &scale)
	Read the configuration from the applications rc file and put the previously chosen deck/frontside in the parameter deck and carddir.
static QString	getDefaultDeck ()
	Returns the default path to the card deck backsides.
static QString	getDefaultCardDir ()
	Returns the default path to the card frontsides.
static QString	getCardPath (const QString &carddir, int index)
	Returns the path to the card frontside specified in dir carddir.
static QString	getRandomDeck ()
	Returns a random deck in deckPath().
static QString	getRandomCardDir ()
	Returns a random directory of cards.
Protected Slots
void	slotDeckClicked (QIconViewItem *)
void	slotCardClicked (QIconViewItem *)
void	slotRandomCardDirToggled (bool on)
void	slotRandomDeckToggled (bool on)
void	slotCardResized (int)
void	slotDefaultSize ()
void	slotSetGlobalDeck ()
void	slotSetGlobalCardDir ()
Protected Member Functions
void	insertCardIcons ()
void	insertDeckIcons ()
Static Protected Member Functions
static void	getGlobalDeck (QString &cardDir, bool &random)
static void	getGlobalCardDir (QString &deck, bool &random)
static QString	getDeckName (const QString &desktop)
static QString	group ()

---

Detailed Description

A carddeck selection dialog for card games.

The KCardDialog provides a dialog for interactive carddeck selection. It gives cardgames an easy to use interface to select front and back of the card sets. As card sets the KDE default cardsets are offered as well as used specified ones.

In most cases, the simplest use of this class is the static method KCardDialog::getCardDeck, which pops up the dialog, allows the user to select a carddeck, and returns when the dialog is closed. Only if you really need some specific behaviour or if you overwrite the dialog you need all the other access functions.

Example:

      QString deck,card;
      int result = KCardDialog::getCardDeck(deck,card );
      if ( result == KCardDialog::Accepted )
            ...

Here you can see a card dialog in action

KCarddialog

KCardDialog::getCardDeck takes a lot of different parameters which are probably very useful. You can e.g. use the parameters randomDeck and randomCardDir to give the end-user the ability to choose a random deck/carddir. You have to save the value of those parameters in your config file - that's why the parameters are needed.

You can also provide a KConfig pointer (usually kapp->config()). This pointer is used to store information about the dialog in an own group ("KCardDailog"). So you can just ignore the randomCardDir and randomDeck values and call KCardDialog::getConfigCardDeck instead. The only reson for this function is to read a previously written configuration and give you the information about it. This way you don't have to save any configuration on your own - KCardDialog does this for you.

Another Parameter for KCardDialog::getCardDeck is scale. This pointer to a double variable contains the scaling factor the user has chosen in the dialog (the scale box won't be shown if you don't provide this parameter). You might want to check out QPixmap::xFrom which gives you access to scaling. You can e.g. use

 QWMatrix m;
 m.scale(s,s);
 pixmap.xForm(m);

to scale your pixmap.

Author:

Martin Heni <martin@heni-online.de>

Version:

Id

kcarddialog.h 465369 2005-09-29 14:33:08Z mueller

Definition at line 90 of file kcarddialog.h.

---

Member Enumeration Documentation

enum KCardDialog::CardFlags

Both - both are shown NoDeck - The deck (back) selection is not shown NoCards - The cards (front) selection is not shown Enumerator: Both  NoDeck  NoCards  Definition at line 101 of file kcarddialog.h.

---

Constructor & Destructor Documentation

KCardDialog::KCardDialog (  QWidget *  parent = NULL, const char *  name = NULL, CardFlags  flags = Both )

Constructs a card deck selection dialog. Parameters: parent  The parent widget of the dialog, if any. name  The name of the dialog. flags  Specifies whether the dialog is modal or not. Definition at line 531 of file kcarddialog.cpp. References KCardDialogPrivate::cFlags.

KCardDialog::~KCardDialog (   )

Destructs a card deck selection dialog. Definition at line 524 of file kcarddialog.cpp.

---

Member Function Documentation

const QString & KCardDialog::cardDir (   )  const

Returns: The chosen card directory Definition at line 249 of file kcarddialog.cpp. References KCardDialogPrivate::cCardDir. Referenced by getCardDeck(), saveConfig(), setupDialog(), slotRandomCardDirToggled(), and slotSetGlobalCardDir().

double KCardDialog::cardScale (   )  const

Returns: The scaling factor of the card pixmap Definition at line 252 of file kcarddialog.cpp. References KCardDialogPrivate::cScale. Referenced by getCardDeck().

const QString & KCardDialog::deck (   )  const

Returns the chosen deck, which is a valid path to a imagefile. Returns: The deck Definition at line 247 of file kcarddialog.cpp. References KCardDialogPrivate::cDeck. Referenced by getCardDeck(), saveConfig(), setupDialog(), and slotSetGlobalDeck().

KCardDialog::CardFlags KCardDialog::flags (   )  const

Returns: the flags set to the dialog Definition at line 251 of file kcarddialog.cpp. References KCardDialogPrivate::cFlags. Referenced by loadConfig(), saveConfig(), and setupDialog().

int KCardDialog::getCardDeck (  QString &  deck, QString &  carddir, QWidget *  parent = 0, CardFlags  flags = Both, bool *  randomDeck = 0, bool *  randomCardDir = 0, double *  scale = 0, KConfig *  conf = 0 )  [static]

Creates a modal carddeck dialog, lets the user choose a deck, and returns when the dialog is closed. Parameters: deck  a reference to the filename used as backside of the cards. It is an absolute path and can directly be loaded as pixmap. carddir  a reference to the directory name used as front of the cards. The directory contains the card images as 1.png to 52.png parent  an optional pointer to the parent window of the dialog flags  what to show randomDeck  if this pointer is non-zero, *ok is set to TRUE if the user wants a random deck otherwise to FALSE. Use this in the config file of your game to load a random deck on startup. See getRandomDeck() randomCardDir  if this pointer is non-zero, *ok is set to TRUE if the user wants a random card otherwise to FALSE. Use this in the config file of your game to load a random card foregrounds on startup. See getRandomCardDir() scale  If non-zero a box is shown which provides the possibility to change the size of the cards. The desired scaling factor is returned to the game in this variable. conf  If non-zero KCardDialog reads the initial settings for this dialog from the applications config file and stores them there when the dialog is closed. You can just use getConfigCardDeck to get the deck/carddir the user selected before. Note that the parameters randomDeck and randomCardDir overwrite the initial settings from the config file. Returns: QDialog::result(). Definition at line 112 of file kcarddialog.cpp. References cardDir(), cardScale(), deck(), getGlobalDeck(), isGlobalDeck(), isRandomCardDir(), isRandomDeck(), loadConfig(), setCardDir(), setDeck(), setupDialog(), showRandomCardDirBox(), and showRandomDeckBox(). Here is the call graph for this function:

QString KCardDialog::getCardPath (  const QString &  carddir, int  index )  [static]

Returns the path to the card frontside specified in dir carddir. Parameters: index  the card to open carddir  The carddir which's path shall be searched for Returns: returns the path to the card Definition at line 232 of file kcarddialog.cpp.

void KCardDialog::getConfigCardDeck (  KConfig *  conf, QString &  deck, QString &  cardDir, double &  scale )  [static]

Read the configuration from the applications rc file and put the previously chosen deck/frontside in the parameter deck and carddir. You probably want to use this function on startup of your program so that the user gets exactly the card/frontside he/she chose before. Note that you don't have to care whether the user wants to get a random carddeck or not as this function takes care of this. Parameters: conf  The config file to read from deck  This will contain the chosen deck from the config file (or a random deck if this is desired according to the config) cardDir  This will contain the chosen cardDir from the config file (or a random cardDir if this is desired according to the config) scale  The scaling factor (usually 1) Definition at line 179 of file kcarddialog.cpp. References CONF_DECK, CONF_GROUP, CONF_RANDOMDECK, and getRandomDeck(). Here is the call graph for this function:

QString KCardDialog::getDeckName (  const QString &  desktop  )  [static, protected]

Definition at line 562 of file kcarddialog.cpp. Referenced by getRandomDeck(), and insertDeckIcons().

QString KCardDialog::getDefaultCardDir (   )  [static]

Returns the default path to the card frontsides. You want to use this usually before the user used the card dialog the first time to get an default deck. You can assume that getCardPath(getDefaultCardPath(), *) are valid cards for * from 1 to 52. Returns: returns the path to the card directory Definition at line 224 of file kcarddialog.cpp. References KCARD_DEFAULTCARD, and KCARD_DEFAULTCARDDIR.

QString KCardDialog::getDefaultDeck (   )  [static]

Returns the default path to the card deck backsides. You want to use this usually before the user used the card dialog the first time to get a default deck. You can assume that getDefaultDeckPath() is a valid deck. Returns: The default path Definition at line 218 of file kcarddialog.cpp. References KCARD_DEFAULTDECK. Referenced by setupDialog().

void KCardDialog::getGlobalCardDir (  QString &  deck, bool &  random )  [static, protected]

Definition at line 781 of file kcarddialog.cpp. References CONF_GLOBAL_CARDDIR, CONF_GLOBAL_GROUP, CONF_GLOBAL_RANDOMCARDDIR, and getRandomCardDir(). Here is the call graph for this function:

void KCardDialog::getGlobalDeck (  QString &  cardDir, bool &  random )  [static, protected]

Definition at line 765 of file kcarddialog.cpp. References CONF_GLOBAL_DECK, CONF_GLOBAL_GROUP, CONF_GLOBAL_RANDOMDECK, and getRandomDeck(). Referenced by getCardDeck(). Here is the call graph for this function:

QString KCardDialog::getRandomCardDir (   )  [static]

Returns a random directory of cards. Returns: A random card dir Definition at line 586 of file kcarddialog.cpp. Referenced by getGlobalCardDir(), and slotRandomCardDirToggled().

QString KCardDialog::getRandomDeck (   )  [static]

Returns a random deck in deckPath(). Returns: A random deck Definition at line 574 of file kcarddialog.cpp. References getDeckName(). Referenced by getConfigCardDeck(), getGlobalDeck(), and slotRandomDeckToggled(). Here is the call graph for this function:

static QString KCardDialog::group (   )  [static, protected]

Returns: the groupname used by functions like saveConfig and loadConfig.

void KCardDialog::insertCardIcons (   )  [protected]

Definition at line 453 of file kcarddialog.cpp. References KCardDialogPrivate::cardIconView, KCardDialogPrivate::cardMap, and KCardDialogPrivate::helpMap. Referenced by setupDialog().

void KCardDialog::insertDeckIcons (   )  [protected]

Definition at line 489 of file kcarddialog.cpp. References KCardDialogPrivate::deckIconView, KCardDialogPrivate::deckMap, getDeckName(), and KCardDialogPrivate::helpMap. Referenced by setupDialog(). Here is the call graph for this function:

bool KCardDialog::isGlobalCardDir (   )  const

Returns: TRUE if the global checkbox was selected Definition at line 259 of file kcarddialog.cpp. References KCardDialogPrivate::globalCardDir.

bool KCardDialog::isGlobalDeck (   )  const

Returns: TRUE if the global checkbox was selected Definition at line 257 of file kcarddialog.cpp. References KCardDialogPrivate::globalDeck. Referenced by getCardDeck().

bool KCardDialog::isRandomCardDir (   )  const

Returns: TRUE if the selected carddir is a random dir (i.e. the user checked the random checkbox) otherwise FALSE Definition at line 255 of file kcarddialog.cpp. References KCardDialogPrivate::randomCardDir. Referenced by getCardDeck(), saveConfig(), and slotSetGlobalCardDir().

bool KCardDialog::isRandomDeck (   )  const

Returns: TRUE if the selected deck is a random deck (i.e. the user checked the random checkbox) otherwise FALSE Definition at line 253 of file kcarddialog.cpp. References KCardDialogPrivate::randomDeck. Referenced by getCardDeck(), saveConfig(), and slotSetGlobalDeck().

void KCardDialog::loadConfig (  KConfig *  conf  )

Load the default settings into the dialog (e.g. whether the "use random deck" checkbox is checked or not). Definition at line 646 of file kcarddialog.cpp. References CONF_DECK, CONF_GROUP, CONF_RANDOMDECK, CONF_USEGLOBALDECK, flags(), KCardDialogPrivate::globalDeck, NoDeck, KCardDialogPrivate::randomDeck, setDeck(), and slotRandomDeckToggled(). Referenced by getCardDeck(). Here is the call graph for this function:

void KCardDialog::saveConfig (  KConfig *  conf  )

Saves the KCardDialog config into a config file. This should be the applications config file - KCardDialog creates an own group ("KCardDialog"). These settings are used by loadConfig and getConfigCardDeck. Definition at line 720 of file kcarddialog.cpp. References cardDir(), CONF_DECK, CONF_GROUP, CONF_RANDOMCARDDIR, CONF_RANDOMDECK, CONF_SCALE, CONF_USEGLOBALCARDDIR, CONF_USEGLOBALDECK, KCardDialogPrivate::cScale, deck(), flags(), KCardDialogPrivate::globalCardDir, KCardDialogPrivate::globalDeck, isRandomCardDir(), isRandomDeck(), NoCards, and NoDeck. Here is the call graph for this function:

void KCardDialog::setCardDir (  const QString &  dir  )

Sets the default card directory. Parameters: dir  The full path to an card directory Definition at line 250 of file kcarddialog.cpp. References KCardDialogPrivate::cCardDir. Referenced by getCardDeck(), slotCardClicked(), and slotRandomCardDirToggled().

void KCardDialog::setDeck (  const QString &  file  )

Sets the default deck. Parameters: file  The full path to an image file Definition at line 248 of file kcarddialog.cpp. References KCardDialogPrivate::cDeck. Referenced by getCardDeck(), loadConfig(), slotDeckClicked(), and slotRandomDeckToggled().

void KCardDialog::setupDialog (  bool  showResizeBox = false  )

Creates the default widgets in the dialog. Must be called after all flags are set. This is only needed if you do NOT use the getCardDeck static function which provides all calls for you. Definition at line 262 of file kcarddialog.cpp. References cardDir(), KCardDialogPrivate::cardIconView, KCardDialogPrivate::cardLabel, KCardDialogPrivate::cPreview, KCardDialogPrivate::cPreviewPix, deck(), KCardDialogPrivate::deckIconView, KCardDialogPrivate::deckLabel, flags(), getDefaultDeck(), KCardDialogPrivate::globalCardDir, KCardDialogPrivate::globalDeck, KCardDialogPrivate::helpMap, insertCardIcons(), insertDeckIcons(), KCARD_DEFAULTCARD, NoCards, NoDeck, KCardDialogPrivate::randomCardDir, KCardDialogPrivate::randomDeck, KCardDialogPrivate::scaleSlider, SLIDER_MAX, SLIDER_MIN, slotCardClicked(), slotCardResized(), slotDeckClicked(), slotDefaultSize(), slotRandomCardDirToggled(), slotRandomDeckToggled(), slotSetGlobalCardDir(), and slotSetGlobalDeck(). Referenced by getCardDeck(). Here is the call graph for this function:

void KCardDialog::showRandomCardDirBox (  bool  s  )

Show or hides the "random foreside" checkbox. Parameters: s  Shows the checkbox if true otherwise hides it Definition at line 610 of file kcarddialog.cpp. References KCardDialogPrivate::randomCardDir. Referenced by getCardDeck().

void KCardDialog::showRandomDeckBox (  bool  s  )

Show or hides the "random backside" checkbox. Parameters: s  Shows the checkbox if true otherwise hides it Definition at line 599 of file kcarddialog.cpp. References KCardDialogPrivate::randomDeck. Referenced by getCardDeck().

void KCardDialog::slotCardClicked (  QIconViewItem *   )  [protected, slot]

Definition at line 550 of file kcarddialog.cpp. References KCardDialogPrivate::cardLabel, KCardDialogPrivate::cardMap, KCardDialogPrivate::deckLabel, KCardDialogPrivate::helpMap, and setCardDir(). Referenced by setupDialog().

void KCardDialog::slotCardResized (  int   )  [protected, slot]

Definition at line 691 of file kcarddialog.cpp. References KCardDialogPrivate::cPreview, KCardDialogPrivate::cPreviewPix, KCardDialogPrivate::cScale, SLIDER_MAX, and SLIDER_MIN. Referenced by setupDialog().

void KCardDialog::slotDeckClicked (  QIconViewItem *   )  [protected, slot]

Definition at line 540 of file kcarddialog.cpp. References KCardDialogPrivate::deckLabel, KCardDialogPrivate::deckMap, KCardDialogPrivate::helpMap, and setDeck(). Referenced by setupDialog().

void KCardDialog::slotDefaultSize (   )  [protected, slot]

Definition at line 712 of file kcarddialog.cpp. References KCardDialogPrivate::scaleSlider, SLIDER_MAX, and SLIDER_MIN. Referenced by setupDialog().

void KCardDialog::slotRandomCardDirToggled (  bool  on  )  [protected, slot]

Definition at line 632 of file kcarddialog.cpp. References cardDir(), KCardDialogPrivate::cardLabel, getRandomCardDir(), and setCardDir(). Referenced by setupDialog().

void KCardDialog::slotRandomDeckToggled (  bool  on  )  [protected, slot]

Definition at line 621 of file kcarddialog.cpp. References KCardDialogPrivate::deckLabel, getRandomDeck(), and setDeck(). Referenced by loadConfig(), and setupDialog().

void KCardDialog::slotSetGlobalCardDir (   )  [protected, slot]

Definition at line 754 of file kcarddialog.cpp. References cardDir(), CONF_GLOBAL_CARDDIR, CONF_GLOBAL_GROUP, CONF_GLOBAL_RANDOMCARDDIR, and isRandomCardDir(). Referenced by setupDialog().

void KCardDialog::slotSetGlobalDeck (   )  [protected, slot]

Definition at line 743 of file kcarddialog.cpp. References CONF_GLOBAL_DECK, CONF_GLOBAL_GROUP, CONF_GLOBAL_RANDOMDECK, deck(), and isRandomDeck(). Referenced by setupDialog().

---

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

• kcarddialog.h
• kcarddialog.cpp

---