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

 /** ===========================================================
  * @file
  *
  * This file is a part of KDE project
  * <a href="https://commits.kde.org/libmediawiki">libmediawiki</a>
  *
  * @date   2011-03-22
  * @brief  a MediaWiki C++ interface for KDE
  *
  * @author Copyright (C) 2011-2012 by Gilles Caulier
  *         <a href="mailto:caulier dot gilles at gmail dot com">caulier dot gilles at gmail dot com</a>
  * @author Copyright (C) 2010 by Ludovic Delfau
  *         <a href="mailto:ludovicdelfau at gmail dot com">ludovicdelfau at gmail dot com</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_QUERYSITEINFOUSERGROUPS_H
 #define MEDIAWIKI_QUERYSITEINFOUSERGROUPS_H
 
 // Local includes
 
 #include "job.h"
 #include "mediawiki_export.h"
 #include "usergroup.h"
 
 namespace mediawiki
 {
 
 class MediaWiki;
 class QuerySiteinfoUsergroupsPrivate;
 
 /**
  * @brief UserGroups job.
  *
  * Uses for fetch a list of all user groups and their permissions.
  */
 class MEDIAWIKI_EXPORT QuerySiteinfoUsergroups : public Job
 {
     Q_OBJECT
     Q_DECLARE_PRIVATE(QuerySiteinfoUsergroups)
 
 public:
 
     /**
      * @brief Constructs a UserGroups job.
      * @param mediawiki the mediawiki concerned by the job
      * @param parent the QObject parent
      */
     explicit QuerySiteinfoUsergroups(MediaWiki& mediawiki, QObject* const parent = nullptr);
 
     /**
      * @brief Destroys the UserGroups job.
      */
     ~QuerySiteinfoUsergroups() override;
 
     /**
      * @brief If true number of users of each user group is included
      * @param includeNumber if true number of users of each user group is included
      */
     void setIncludeNumber(bool includeNumber);
 
     /**
      * @brief Starts the job asynchronously.
      */
     void start() override;
 
 Q_SIGNALS:
 
     /**
      * @brief Provides a list of all user groups.
      * @param usergroups list of all user groups
      * @see QuerySiteinfoUsergroups::Result
      */
     void usergroups(const QList<UserGroup>& usergroups);
 
 private Q_SLOTS:
 
     void doWorkSendRequest();
     void doWorkProcessReply();
 };
 
 } // namespace mediawiki
 
 #endif // MEDIAWIKI_QUERYSITEINFOUSERGROUPS_H