CTK/Libs/CommandLineModules/Frontend/QtGui/ctkCmdLineModuleMenuFactoryQtGui.h

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

  Library: CTK

  Copyright (c) University College London

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

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

#ifndef CTKCMDLINEMODULEMENUFACTORYQTGUI_H
#define CTKCMDLINEMODULEMENUFACTORYQTGUI_H

#include <QMenu>
#include <QList>
#include "ctkCmdLineModuleReference.h"
#include "ctkCommandLineModulesFrontendQtGuiExport.h"

/**
 * \class ctkCmdLineModuleMenuFactoryQtGui
 * \brief Takes a QHash of filename and ctkCmdLineModuleReference and produces a QMenu.
 * \author m.clarkson@ucl.ac.uk
 * \ingroup CommandLineModulesFrontendQtGui
 */
class CTK_CMDLINEMODULEQTGUI_EXPORT ctkCmdLineModuleMenuFactoryQtGui
{
public:

  ctkCmdLineModuleMenuFactoryQtGui();
  virtual ~ctkCmdLineModuleMenuFactoryQtGui();

  /**
   * \brief Constructs a menu, for all the items in the QHash.
   * \param list List of references, from which to build a menu.
   * \return QMenu* a menu.
   */
  QMenu* create(const QList<ctkCmdLineModuleReference>& list);
};

#endif // CTKCMDLINEMODULEMENUFACTORYQTGUI_H