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

   Program: ParaView
   Module:  pqStandardViewFrameActionsImplementation.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 __pqStandardViewFrameActionsImplementation_h
#define __pqStandardViewFrameActionsImplementation_h

#include "pqViewFrameActionsInterface.h"
#include "pqApplicationComponentsModule.h" // needed for export macros
#include <QPointer> // needed for QPointer
#include <QObject>  // needed for QObject

class pqContextView;
class pqRenderView;
class pqSpreadSheetView;
class QAction;
class QShortcut;
class QWidget;

/// pqStandardViewFrameActionsImplementation implements
/// pqViewFrameActionsInterface to add the default view toolbar buttons/actions
/// used in ParaView for various types of views, including chart views and
/// render views.
class PQAPPLICATIONCOMPONENTS_EXPORT pqStandardViewFrameActionsImplementation :
  public QObject,
  public pqViewFrameActionsInterface
{
  Q_OBJECT
  Q_INTERFACES(pqViewFrameActionsInterface);
public:
  pqStandardViewFrameActionsImplementation(QObject* parent=0);
  virtual ~pqStandardViewFrameActionsImplementation();

  /// This method is called after a frame is assigned to a view. The view may be
  /// NULL, indicating the frame has been assigned to an empty view. Frames are
  /// never reused (except a frame assigned to an empty view).
  virtual void frameConnected(pqViewFrame* frame, pqView* view);
  /// Used to receive Esc key from main window. A shortcut stops delivering
  /// Esc to any other window which interferes with 'Search for properties'
  virtual bool eventFilter(QObject * watched, QEvent * event);

protected slots:
  /// Called before the "Convert To" menu is shown. We populate the menu with
  /// actions for available view types.
  void aboutToShowConvertMenu();

  /// This slot is called either from an action in the "Convert To" menu, or from
  /// the buttons on an empty frame.
  void invoked();

  /// slots for various shortcuts.
  void selectSurfaceCellsTrigerred();
  void selectSurfacePointsTrigerred();
  void selectFrustumCellsTriggered();
  void selectFrustumPointsTriggered();
  void selectBlocksTriggered();

  /// If a QAction is added to an exclusive QActionGroup, then a checked action
  /// cannot be unchecked by clicking on it. We need that to work. Hence, we
  /// manually manage the exclusivity of the action group.
  void manageGroupExclusivity(QAction*);

protected:
  /// called to setup empty frame.
  virtual void setupEmptyFrame(QWidget* frame);

  /// called to add view type independent actions first.
  virtual void addGenericActions(pqViewFrame* frame, pqView* view);

  /// called to add context view actions.
  virtual void addContextViewActions(pqViewFrame* frame, pqContextView* chart_view);

  /// called to add render view actions.
  virtual void addRenderViewActions(pqViewFrame *frame, pqRenderView* view);

  /// called to add actions/decorator for pqSpreadSheetView.
  virtual void addSpreadSheetViewActions(pqViewFrame* frame, pqSpreadSheetView* view);

  struct ViewType
    {
    QString Label;
    QString Name;
    ViewType(){}
    ViewType(const QString& label, const QString& name):
      Label(label), Name(name)
    {
    }
    };

  /// Returns available view types in the application. Used when setting up the
  /// "Convert To" menu or when filling up the empty-frame.
  virtual QList<ViewType> availableViewTypes();

  /// Called when user clicks "Convert To" or create a view from the empty
  /// frame.
  virtual void handleCreateView(const ViewType& viewType);
  /// Exit interactive selection
  void exitInteractiveSelection();
private:
  Q_DISABLE_COPY(pqStandardViewFrameActionsImplementation)
  QPointer<QShortcut> ShortCutSurfaceCells;
  QPointer<QShortcut> ShortCutSurfacePoints;
  QPointer<QShortcut> ShortCutFrustumCells;
  QPointer<QShortcut> ShortCutFrustumPoints;
  QPointer<QShortcut> ShortCutBlocks;
  static bool ViewTypeComparator(const ViewType& one, const ViewType& two);
};

#endif
