File indexing completed on 2024-04-21 15:32:06

0001 /** ===========================================================
0002  * @file
0003  *
0004  * This file is a part of KDE project
0005  * <a href="https://commits.kde.org/libmediawiki">libmediawiki</a>
0006  *
0007  * @date   2011-03-22
0008  * @brief  a MediaWiki C++ interface for KDE
0009  *
0010  * @author Copyright (C) 2011-2012 by Gilles Caulier
0011  *         <a href="mailto:caulier dot gilles at gmail dot com">caulier dot gilles at gmail dot com</a>
0012  * @author Copyright (C) 2011 by Manuel Campomanes
0013  *         <a href="mailto:campomanes dot manuel at gmail dot com">campomanes dot manuel at gmail dot com</a>
0014  *
0015  * This program is free software; you can redistribute it
0016  * and/or modify it under the terms of the GNU General
0017  * Public License as published by the Free Software Foundation;
0018  * either version 2, or (at your option)
0019  * any later version.
0020  *
0021  * This program is distributed in the hope that it will be useful,
0022  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0023  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0024  * GNU General Public License for more details.
0025  *
0026  * ============================================================ */
0027 
0028 #ifndef GENERALINFO_H
0029 #define GENERALINFO_H
0030 
0031 // Qt includes
0032 
0033 #include <QDateTime>
0034 #include <QString>
0035 #include <QUrl>
0036 
0037 // Local includes
0038 
0039 #include "mediawiki_export.h"
0040 
0041 namespace mediawiki
0042 {
0043 
0044 /**
0045  * @brief A general info.
0046  */
0047 class MEDIAWIKI_EXPORT Generalinfo
0048 {
0049 
0050 public:
0051 
0052     /**
0053      * @brief Constructs a general info.
0054      */
0055     Generalinfo();
0056 
0057     /**
0058      * @brief Constructs a generalinfo from an other generalinfo.
0059      * @param other an other generalinfo
0060      */
0061     Generalinfo(const Generalinfo& other);
0062 
0063     /**
0064      * @brief Destructs a general info.
0065      */
0066     ~Generalinfo();
0067 
0068     /**
0069      * @brief Assingning an image from an other image.
0070      * @param other an other image
0071      */
0072     Generalinfo& operator=(const Generalinfo& other);
0073 
0074     /**
0075      * @brief Returns true if this instance and other are equal, else false.
0076      * @param other instance to compare
0077      * @return true if there are equal, else false
0078      */
0079     bool operator==(const Generalinfo& other) const;
0080 
0081     /**
0082      * @brief Get the name of the main page.
0083      * @return the name of the main page
0084      */
0085     QString mainPage() const;
0086 
0087     /**
0088      * @brief Set the name of the main page.
0089      * @param mainPage the name of the main page
0090      */
0091     void setMainPage(const QString& mainPage);
0092 
0093     /**
0094      * @brief Get the url of the page.
0095      * @return the url of the page
0096      */
0097     QUrl url() const;
0098 
0099     /**
0100      * @brief Set the url of the page.
0101      * @param url the url of the page
0102      */
0103     void setUrl(const QUrl& url);
0104 
0105     /**
0106      * @brief Get the name of the web site.
0107      * @return the name of the web site
0108      */
0109     QString siteName() const;
0110 
0111     /**
0112      * @brief Set the name of the web site.
0113      * @param siteName the name of the web site
0114      */
0115     void setSiteName(const QString& siteName);
0116 
0117     /**
0118      * @brief Get the generator.
0119      * @return the generator
0120      */
0121     QString generator() const;
0122 
0123     /**
0124      * @brief Set the generator.
0125      * @param generator
0126      */
0127     void setGenerator(const QString& generator);
0128 
0129     /**
0130      * @brief Get the PHP version.
0131      * @return the PHP version
0132      */
0133     QString phpVersion() const;
0134 
0135     /**
0136      * @brief Set the PHP version.
0137      * @param phpVersion the PHP version
0138      */
0139     void setPhpVersion(const QString& phpVersion);
0140 
0141     /**
0142      * @brief Get the PHP API name.
0143      * @return the PHP API name
0144      */
0145     QString phpApi() const;
0146 
0147     /**
0148      * @brief Set the PHP API name.
0149      * @param phpApi the PHP API name
0150      */
0151     void setPhpApi(const QString& phpApi);
0152 
0153     /**
0154      * @brief Get the type of the database.
0155      * @return the type of the database
0156      */
0157     QString dataBaseType() const;
0158 
0159     /**
0160      * @brief Set the type of the database.
0161      * @param dataBaseType the type of the database
0162      */
0163     void setDataBaseType(const QString& dataBaseType);
0164 
0165     /**
0166      * @brief Get the version of the database.
0167      * @return the version of the database
0168      */
0169     QString dataBaseVersion() const;
0170 
0171     /**
0172      * @brief Set the version of the database.
0173      * @param dataBaseVersion the version of the database
0174      */
0175     void setDataBaseVersion(const QString& dataBaseVersion);
0176 
0177     /**
0178      * @brief Get the rev number.
0179      * @return the rev number
0180      */
0181     QString rev() const;
0182 
0183     /**
0184      * @brief Set the rev number.
0185      * @param rev the rev number
0186      */
0187     void setRev(const QString& rev);
0188 
0189     /**
0190      * @brief Get the case.
0191      * @return the case
0192      */
0193     QString cas() const;
0194 
0195     /**
0196      * @brief Set the case.
0197      * @param cas the case
0198      */
0199     void setCas(const QString& cas);
0200 
0201     /**
0202      * @brief Get the licence.
0203      * @return the licence
0204      */
0205     QString licence() const;
0206 
0207     /**
0208      * @brief Set the licence.
0209      * @param licence the licence
0210      */
0211     void setLicence(const QString& licence);
0212 
0213     /**
0214      * @brief Get the language.
0215      * @return the language
0216      */
0217     QString language() const;
0218 
0219     /**
0220      * @brief Set the language.
0221      * @param language
0222      */
0223     void setLanguage(const QString& language);
0224 
0225     /**
0226      * @brief Get the fallBack8bitEncoding.
0227      * @return the fallBack8bitEncoding
0228      */
0229     QString fallBack8bitEncoding() const;
0230 
0231     /**
0232      * @brief Set the fallBack8bitEncoding.
0233      * @param fallBack8bitEncoding
0234      */
0235     void setFallBack8bitEncoding(const QString& fallBack8bitEncoding);
0236 
0237     /**
0238      * @brief Get the writeApi.
0239      * @return the writeApi
0240      */
0241     QString writeApi() const;
0242 
0243     /**
0244      * @brief Set the writeApi.
0245      * @param writeApi
0246      */
0247     void setWriteApi(const QString& writeApi);
0248 
0249     /**
0250      * @brief Get the timeZone.
0251      * @return the timeZone
0252      */
0253     QString timeZone() const;
0254 
0255     /**
0256      * @brief Set the timeZone.
0257      * @param timeZone
0258      */
0259     void setTimeZone(const QString& timeZone);
0260 
0261     /**
0262      * @brief Get the timeOffset.
0263      * @return the timeOffset
0264      */
0265     QString timeOffset() const;
0266 
0267     /**
0268      * @brief Set the timeOffset.
0269      * @param timeOffset
0270      */
0271     void setTimeOffset(const QString& timeOffset);
0272 
0273     /**
0274      * @brief Get the path of the article.
0275      * @return the path of the article
0276      */
0277     QString articlePath() const;
0278 
0279     /**
0280      * @brief Set the path of the article.
0281      * @param articlePath the path of the article
0282      */
0283     void setArticlePath(const QString& articlePath);
0284 
0285     /**
0286      * @brief Get the path of the script.
0287      * @return the path of the script
0288      */
0289     QString scriptPath() const;
0290 
0291     /**
0292      * @brief Set the path of the script.
0293      * @param scriptPath the path of the script
0294      */
0295     void setScriptPath(const QString& scriptPath);
0296 
0297     /**
0298      * @brief Get the path of the script file.
0299      * @return the path of the script file
0300      */
0301     QString script() const;
0302 
0303     /**
0304      * @brief Set the path of the script file.
0305      * @param script the path of the script file
0306      */
0307     void setScript(const QString& script);
0308 
0309     /**
0310      * @brief Get the path of the variant article.
0311      * @return the path of the variant article
0312      */
0313     QString variantArticlePath() const;
0314 
0315     /**
0316      * @brief Set the path of the variant article.
0317      * @param variantArticlePath the path of the variant article
0318      */
0319     void setVariantArticlePath(const QString& variantArticlePath);
0320 
0321     /**
0322      * @brief Get the url of the server.
0323      * @return the url of the server
0324      */
0325     QUrl serverUrl() const;
0326 
0327     /**
0328      * @brief Set the url of the server.
0329      * @param serverUrl the url of the server
0330      */
0331     void setServerUrl(const QUrl& serverUrl);
0332 
0333     /**
0334      * @brief Get the id of the wiki.
0335      * @return the id of the wiki
0336      */
0337     QString wikiId() const;
0338 
0339     /**
0340      * @brief Set the id of the wiki.
0341      * @param wikiId the id of the wiki
0342      */
0343     void setWikiId(const QString& wikiId);
0344 
0345     /**
0346      * @brief Get the time.
0347      * @return the time
0348      */
0349     QDateTime time() const;
0350 
0351     /**
0352      * @brief Set the time.
0353      * @param time
0354      */
0355     void setTime(const QDateTime& time);
0356 
0357 private:
0358 
0359     class GeneralinfoPrivate;
0360     GeneralinfoPrivate* const d;
0361 };
0362 
0363 } // namespace mediawiki
0364 
0365 #endif // GENERALINFO_H