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

   Program: ParaView
   Module:    pqViewFrameActionGroup.h

   Copyright (c) 2005-2008 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 _pqViewFrameActionGroup_h
#define _pqViewFrameActionGroup_h

#include <QActionGroup>
#include "pqComponentsModule.h"

class pqViewFrame;
class pqView;

/// Base class for custom action groups that can be added to a view 
/// frame based on the type of view.
class PQCOMPONENTS_EXPORT pqViewFrameActionGroup : public QActionGroup
{
  Q_OBJECT
public:
  pqViewFrameActionGroup(QObject* p) : QActionGroup(p){};
  ~pqViewFrameActionGroup(){};

  // Description:
  // Tries to add/remove this group's actions to/from the frame if the
  // view type is supported. Returns whether or not they were.
  virtual bool connect(pqViewFrame *frame, pqView *view) = 0;
  virtual bool disconnect(pqViewFrame *frame, pqView *view) = 0;

private:
  pqViewFrameActionGroup(const pqViewFrameActionGroup&); // Not implemented.
  void operator=(const pqViewFrameActionGroup&); // Not implemented.
};
#endif

