Huggle  build:^490^dce1e5c
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
wikisite.hpp
1 //This program is free software: you can redistribute it and/or modify
2 //it under the terms of the GNU General Public License as published by
3 //the Free Software Foundation, either version 3 of the License, or
4 //(at your option) any later version.
5 
6 //This program is distributed in the hope that it will be useful,
7 //but WITHOUT ANY WARRANTY; without even the implied warranty of
8 //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 //GNU General Public License for more details.
10 
11 #ifndef WIKISITE_H
12 #define WIKISITE_H
13 
14 #include <QString>
15 
16 namespace Huggle
17 {
18  //! Site
19  class WikiSite
20  {
21  public:
22  //! Name of wiki, used by huggle only
23  QString Name;
24  //! URL of wiki, no http prefix must be present
25  QString URL;
26  //! long article path (wiki/ for example on english wp)
27  QString LongPath;
28  //! short path
29  QString ScriptPath;
30  //! URL of oauth handler for this site
31  QString OAuthURL;
32  //! IRC channel of this site, if it doesn't have a channel leave it empty
33  QString IRCChannel;
34  //! URL of whitelist, every site needs to have some, if your site doesn't have it
35  //! leave it as test
36  QString WhiteList;
37  //! Whether the site supports the ssl
39  bool SupportOAuth;
40  WikiSite(WikiSite *w);
41  WikiSite(const WikiSite &w);
42  WikiSite(QString name, QString url);
43  //! This will create a new instance of wikisite with most of configuration
44  /*!
45  \param name is a name of wiki for internal purposes
46  \param url is relative url to wiki (no http prefix) which must be terminated with slash
47  \param path is long path for articles, like wiki/
48  \param script is short path w/
49  \param https set this true if your wiki support https
50  \param oauth set this true if your wiki support oauth
51  \param channel irc
52  \param wl whitelist
53  */
54  WikiSite(QString name, QString url, QString path, QString script, bool https, bool oauth, QString channel, QString wl);
55  };
56 }
57 
58 #endif // WIKISITE_H
QString WhiteList
Definition: wikisite.hpp:36
QString Name
Name of wiki, used by huggle only.
Definition: wikisite.hpp:23
QString LongPath
long article path (wiki/ for example on english wp)
Definition: wikisite.hpp:27
QString IRCChannel
IRC channel of this site, if it doesn&#39;t have a channel leave it empty.
Definition: wikisite.hpp:33
bool SupportHttps
Whether the site supports the ssl.
Definition: wikisite.hpp:38
QString ScriptPath
short path
Definition: wikisite.hpp:29
QString OAuthURL
URL of oauth handler for this site.
Definition: wikisite.hpp:31
QString URL
URL of wiki, no http prefix must be present.
Definition: wikisite.hpp:25