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

   Program: ParaView
   Module:    pqFiltersMenuReaction.h

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#ifndef pqFiltersMenuReaction_h
#define pqFiltersMenuReaction_h

#include <QObject>

#include "pqApplicationComponentsModule.h"
#include "pqTimer.h"

class pqPipelineSource;
class pqProxyGroupMenuManager;

/**
 * @ingroup Reactions
 * Reaction to handle creation of filters from the filters menu.
 * pqFiltersMenuReaction knows when to enable/disable actions in the menu as
 * well as what to do when an action is triggered.
 */
class PQAPPLICATIONCOMPONENTS_EXPORT pqFiltersMenuReaction : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqFiltersMenuReaction(pqProxyGroupMenuManager* menuManager, bool hideDisabledActions = false);

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  /**
   * Updates the enabled state.  The actions in toolbars will
   * be updated automatically.  The containing widget of other actions
   * should connect its aboutToShow signal to this slot.
   */
  virtual void updateEnableState(bool updateOnlyToolbars = false);

  /**
   * Creates a filter of the given type.
   */
  static pqPipelineSource* createFilter(const QString& group, const QString& name);

protected Q_SLOTS:
  /**
   * Called when the action is triggered.
   */
  virtual void onTriggered(const QString& group, const QString& name)
  {
    pqFiltersMenuReaction::createFilter(group, name);
  }
  virtual void setEnableStateDirty();

private:
  Q_DISABLE_COPY(pqFiltersMenuReaction)

  pqTimer Timer;
  bool IsDirty;
  bool HideDisabledActions;
};

#endif
