~ubuntu-branches/debian/sid/libmediawiki/sid

« back to all changes in this revision

Viewing changes to src/mediawiki.h

Committer: Package Import Robot
Author(s): Steve M. Robbins
Date: 2017-11-05 21:15:29 UTC
Revision ID: package-import@ubuntu.com-20171105211529-bgfi385yv79030cf

Tags: upstream-5.37.0

Import upstream version 5.37.0

files added:

.gitignore

.reviewboardrc

AUTHORS

CMakeLists.txt

COPYING

COPYING-CMAKE-SCRIPTS

COPYING.LIB

KF5MediaWikiConfig.cmake.in

README.md

autotests

autotests/CMakeLists.txt

examples

examples/editsample

examples/editsample/CMakeLists.txt

examples/editsample/main.cpp

examples/editsample/mainwindow.cpp

examples/editsample/mainwindow.h

examples/editsample/mainwindow.ui

examples/uploadsample

examples/uploadsample/CMakeLists.txt

examples/uploadsample/main.cpp

examples/uploadsample/mainwindow.cpp

examples/uploadsample/mainwindow.h

examples/uploadsample/mainwindow.ui

metainfo.yaml

src/CMakeLists.txt

src/Messages.sh

src/edit.cpp

src/edit.h

src/generalinfo.cpp

src/generalinfo.h

src/image.cpp

src/image.h

src/imageinfo.cpp

src/imageinfo.h

src/job.cpp

src/job.h

src/job_p.h

src/login.cpp

src/login.h

src/logout.cpp

src/logout.h

src/mediawiki.cpp

src/mediawiki.h

src/mediawiki_p.h

src/page.cpp

src/page.h

src/parse.cpp

src/parse.h

src/protection.cpp

src/protection.h

src/queryimageinfo.cpp

src/queryimageinfo.h

src/queryimages.cpp

src/queryimages.h

src/queryinfo.cpp

src/queryinfo.h

src/queryrevision.cpp

src/queryrevision.h

src/querysiteinfogeneral.cpp

src/querysiteinfogeneral.h

src/querysiteinfousergroups.cpp

src/querysiteinfousergroups.h

src/revision.cpp

src/revision.h

src/upload.cpp

src/upload.h

src/usergroup.cpp

src/usergroup.h

tests

tests/CMakeLists.txt

tests/edittest.cpp

tests/libmediawikitest

tests/libmediawikitest/fakeserver.cpp

tests/libmediawikitest/fakeserver.h

tests/logintest.cpp

tests/logouttest.cpp

tests/mediawikitest.cpp

tests/parsetest.cpp

tests/parsetest.rc

tests/queryimageinfotest.cpp

tests/queryimagestest.cpp

tests/queryinfotest.cpp

tests/queryrevisiontest.cpp

tests/queryrevisiontest.rc

tests/queryrevisiontest_content.rc

tests/queryrevisiontest_cuted.rc

tests/queryrevisiontest_onetitle.rc

tests/queryrevisiontest_parsetree.rc

tests/queryrevisiontest_rollback.rc

tests/queryrevisiontest_timestamponly.rc

tests/queryrevisiontest_useronly.rc

tests/querysiteinfogeneraltest.cpp

tests/querysiteinfousergroupstest.cpp

tests/uploadtest.cpp

tests/uploadtest_image.jpg

Show diffs side-by-side

added added

removed removed

src/mediawiki.h

/** ===========================================================

* @file

* This file is a part of KDE project

* <a href="https://projects.kde.org/projects/extragear/libs/libmediawiki">libmediawiki</a>

* @date 2011-03-22

* @brief a MediaWiki C++ interface for KDE

* <a href="mailto:caulier dot gilles at gmail dot com">caulier dot gilles at gmail dot com</a>

* <a href="mailto:rich at kde dot org">rich at kde dot org</a>

* This program is free software; you can redistribute it

* and/or modify it under the terms of the GNU General

* Public License as published by the Free Software Foundation;

* either version 2, or (at your option)

* any later version.

* This program 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 General Public License for more details.

* ============================================================ */

#ifndef MEDIAWIKI_MEDIAWIKI_H

#define MEDIAWIKI_MEDIAWIKI_H

// Qt includes

#include <QtCore/QString>

#include <QtCore/QUrl>

#include <QtNetwork/QNetworkAccessManager>

#include <QtNetwork/QNetworkCookieJar>

// Local includes

#include "mediawiki_export.h"

namespace mediawiki

{

/**

* @brief Provides access to wiki powered by MediaWiki.

class MEDIAWIKI_EXPORT MediaWiki

{

public:

/**

* @brief Constructs a MediaWiki by its url api.

* @param url the url api of the wiki

* @param customUserAgent you can specify the user agent to use

which will be concatenated with the postfix user agent

* else the postfix user agent is used only

explicit MediaWiki(const QUrl& url, const QString& customUserAgent = QString());

/**

* @brief Destructs the MediaWiki.

~MediaWiki();

/**

* @brief Returns the url api of the wiki.

* @returns the url api of the wiki

QUrl url() const;

/**

* @brief Returns the user agent of the wiki.

* @return the user agent of the wiki

QString userAgent() const;

/**

* @brief Returns the network manager instance of the wiki.

* @return the network manager instance of the wiki

QNetworkAccessManager* manager() const;

private:

class MediaWikiPrivate;

MediaWikiPrivate* const d_ptr;

friend class JobPrivate;

};

} // namespace mediawiki

#endif // MEDIAWIKI_MEDIAWIKI_H

Older »