libkdegames

carddeckinfo.h

00001 /*
00002     This file is part of the KDE games library
00003     Copyright 2008 Andreas Pakulat <apaku@gmx.de>
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License version 2 as published by the Free Software Foundation.
00008 
00009     This library is distributed in the hope that it will be useful,
00010     but WITHOUT ANY WARRANTY; without even the implied warranty of
00011     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012     Library General Public License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public License
00015     along with this library; see the file COPYING.LIB.  If not, write to
00016     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00017     Boston, MA 02110-1301, USA.
00018 */
00019 #ifndef __CARDDECKINFO_H_
00020 #define __CARDDECKINFO_H_
00021 
00022 #include <QtCore/QString>
00023 #include <QtCore/QStringList>
00024 #include <libkdegames_export.h>
00025 
00026 class KConfigGroup;
00027 
00035 namespace CardDeckInfo
00036 {
00041    KDEGAMES_EXPORT QString backSVGFilePath(const QString& name);
00042 
00050    KDEGAMES_EXPORT QString frontSVGFilePath(const QString& name);
00051 
00056    KDEGAMES_EXPORT bool isSVGBack(const QString& name);
00057 
00062    KDEGAMES_EXPORT bool isSVGFront(const QString& name);
00063    
00068    KDEGAMES_EXPORT QString defaultFrontName(bool pAllowPNG = true);
00069    
00074    KDEGAMES_EXPORT QString defaultBackName(bool pAllowPNG = true);
00075    
00080    KDEGAMES_EXPORT QString randomFrontName(bool pAllowPNG = true);
00081  
00086    KDEGAMES_EXPORT QString randomBackName(bool pAllowPNG = true);
00087 
00094    KDEGAMES_EXPORT QString frontDir(const QString& name);
00095 
00102    KDEGAMES_EXPORT QString backFilename(const QString& name);
00103 
00109    KDEGAMES_EXPORT QStringList backNames();
00110 
00116    KDEGAMES_EXPORT QStringList frontNames();
00117 
00125    KDEGAMES_EXPORT QString frontTheme( const KConfigGroup& group, const QString& defaultTheme = defaultFrontName(false) );
00126 
00134    KDEGAMES_EXPORT QString backTheme( const KConfigGroup& group, const QString& defaultTheme = defaultBackName(false) );
00135 
00143    KDEGAMES_EXPORT bool allowFixedSizeDecks( const KConfigGroup& group, bool allowDefault = false );
00144 
00152    KDEGAMES_EXPORT bool lockFrontToBackside( const KConfigGroup& group, bool lockDefault = true );
00153 
00159    KDEGAMES_EXPORT void writeFrontTheme( KConfigGroup& group, const QString& theme );
00160 
00166    KDEGAMES_EXPORT void writeBackTheme( KConfigGroup& group, const QString& theme );
00167 
00173    KDEGAMES_EXPORT void writeAllowFixedSizeDecks( KConfigGroup& group, bool allowFixedSize );
00174 
00180    KDEGAMES_EXPORT void writeLockFrontToBackside( KConfigGroup& group, bool lock );
00181 }
00182 
00183 #endif
libkdegames

carddeckinfo.h

libkdegames

API Reference
