diff options
Diffstat (limited to 'libkdegames/kcarddialog.h')
| -rw-r--r-- | libkdegames/kcarddialog.h | 346 |
1 files changed, 0 insertions, 346 deletions
diff --git a/libkdegames/kcarddialog.h b/libkdegames/kcarddialog.h deleted file mode 100644 index c3a0f018..00000000 --- a/libkdegames/kcarddialog.h +++ /dev/null @@ -1,346 +0,0 @@ -/* - This file is part of the KDE games library - Copyright (C) 2000 Martin Heni ([email protected]) - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Library General Public - License version 2 as published by the Free Software Foundation. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Library General Public License for more details. - - You should have received a copy of the GNU Library General Public License - along with this library; see the file COPYING.LIB. If not, write to - the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. -*/ -#ifndef __KCARDDIALOG_H_ -#define __KCARDDIALOG_H_ - -#include <tqstring.h> -#include <kdialogbase.h> -#include <tqmap.h> // TODO: remove - it is in kcarddialog.cpp now; left here for source compatibility - -#include <kdemacros.h> -class TQIconViewItem; - -class KConfig; - -class KCardDialogPrivate; - -/** - * @short 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: - * - * \code - * TQString deck,card; - * int result = KCardDialog::getCardDeck(deck,card ); - * if ( result == KCardDialog::Accepted ) - * ... - * \endcode - * - * Here you can see a card dialog in action - * @image html "kcarddialog.png" 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 TQPixmap::xFrom which gives you access to - * scaling. You can e.g. use - * \code - * TQWMatrix m; - * m.scale(s,s); - * pixmap.xForm(m); - * \endcode - * to scale your pixmap. - * - * @author Martin Heni <[email protected]> - * @version $Id$ - */ -class KDE_EXPORT KCardDialog : public KDialogBase -{ - Q_OBJECT - TQ_OBJECT - -public: - - /** - * @li @p Both - both are shown - * @li @p NoDeck - The deck (back) selection is not shown - * @li @p NoCards - The cards (front) selection is not shown - */ - enum CardFlags { Both=0, NoDeck=0x01, NoCards=0x02 }; - - /** - * Constructs a card deck selection dialog. - * - * @param parent The parent widget of the dialog, if any. - * @param name The name of the dialog. - * @param flags Specifies whether the dialog is modal or not. - */ - KCardDialog (TQWidget* parent = NULL,const char* name = NULL, - CardFlags flags = Both); - /** - * Destructs a card deck selection dialog. - */ - ~KCardDialog(); - - /** - * Creates a modal carddeck dialog, lets the user choose a deck, - * and returns when the dialog is closed. - * - * @param deck a reference to the filename used as backside of the - * cards. It is an absolute path and can directly be loaded as - * pixmap. - * - * @param 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 - * - * @param parent an optional pointer to the parent window of the dialog - * - * @param flags what to show - * - * @param 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 @ref getRandomDeck() - * - * @param 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 @ref getRandomCardDir() - * - * @param 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. - * - * @param 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. - * - * @return TQDialog::result(). - */ - static int getCardDeck(TQString &deck,TQString &carddir, TQWidget *parent=0, - CardFlags flags=Both, bool* randomDeck=0, - bool* randomCardDir=0, double* scale=0, KConfig* conf=0); - - /** - * 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. - * @param conf The config file to read from - * @param deck This will contain the chosen deck from the config file (or a - * random deck if this is desired according to the config) - * @param cardDir This will contain the chosen cardDir from the config file (or a - * random cardDir if this is desired according to the config) - * @param scale The scaling factor (usually 1) - **/ - static void getConfigCardDeck(KConfig* conf, TQString& deck, TQString& cardDir, double& scale); - - /** - * 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 - * \code - * getDefaultDeckPath() - * \endcode - * is a valid deck. - * - * @return The default path - */ - static TQString getDefaultDeck(); - - /** - * 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 - * \code - * getCardPath(getDefaultCardPath(), *) - * \endcode - * are valid cards for * from 1 to 52. - * - * @return returns the path to the card directory - */ - static TQString getDefaultCardDir(); - - /** - * Returns the path to the card frontside specified in dir carddir - * - * @param index the card to open - * @param carddir The carddir which's path shall be searched for - * @return returns the path to the card - */ - static TQString getCardPath(const TQString &carddir, int index); - - /** - * Returns a random deck in deckPath() - * @return A random deck - **/ - static TQString getRandomDeck(); - - /** - * Returns a random directory of cards - * @return A random card dir - **/ - static TQString getRandomCardDir(); - - /** - * Show or hides the "random backside" checkbox - * @param s Shows the checkbox if true otherwise hides it - **/ - void showRandomDeckBox(bool s); - - /** - * Show or hides the "random foreside" checkbox - * @param s Shows the checkbox if true otherwise hides it - **/ - void showRandomCardDirBox(bool s); - - /** - * Returns the chosen deck, which is a valid path to a imagefile. - * - * @return The deck - */ - const TQString& deck() const; - - /** - * Sets the default deck. - * @param file The full path to an image file - */ - void setDeck(const TQString& file); - - /** - * @return The chosen card directory - */ - const TQString& cardDir() const; - - /** - * Sets the default card directory. - * @param dir The full path to an card directory - */ - void setCardDir(const TQString& dir); - - /** - * @return the flags set to the dialog - */ - CardFlags flags() const; - - /** - * 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. - */ - void setupDialog(bool showResizeBox = false); - - /** - * @return TRUE if the selected deck is a random deck (i.e. the user checked - * the random checkbox) otherwise FALSE - **/ - bool isRandomDeck() const; - - /** - * @return TRUE if the selected carddir is a random dir (i.e. the user - * checked the random checkbox) otherwise FALSE - **/ - bool isRandomCardDir() const; - - /** - * @return TRUE if the global checkbox was selected - **/ - bool isGlobalDeck() const; - - /** - * @return TRUE if the global checkbox was selected - **/ - bool isGlobalCardDir() const; - - /** - * @return The scaling factor of the card pixmap - **/ - double cardScale() const; - - /** - * Load the default settings into the dialog (e.g. whether the "use random - * deck" checkbox is checked or not). - **/ - void loadConfig(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 @ref loadConfig and @ref - * getConfigCardDeck. - **/ - void saveConfig(KConfig* conf); - - -protected: - void insertCardIcons(); - void insertDeckIcons(); - - static void getGlobalDeck(TQString& cardDir, bool& random); - static void getGlobalCardDir(TQString& deck, bool& random); - - static TQString getDeckName(const TQString& desktop); - - /** - * @return the groupname used by functions like @ref saveConfig and @ref - * loadConfig. - **/ - static TQString group(); - -protected slots: - void slotDeckClicked(TQIconViewItem *); - void slotCardClicked(TQIconViewItem *); - void slotRandomCardDirToggled(bool on); - void slotRandomDeckToggled(bool on); - void slotCardResized(int); - void slotDefaultSize(); - void slotSetGlobalDeck(); - void slotSetGlobalCardDir(); - -private: - static void init(); - - KCardDialogPrivate* d; -}; - -#endif |