pqWidgetEventPlayer.h 2.26 KB
Newer Older
Clinton Stimpson's avatar
 
Clinton Stimpson committed
1 2 3 4 5
/*=========================================================================

   Program: ParaView
   Module:    pqWidgetEventPlayer.h

6
   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
Clinton Stimpson's avatar
 
Clinton Stimpson committed
7 8 9
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
10
   under the terms of the ParaView license version 1.2. 
Clinton Stimpson's avatar
 
Clinton Stimpson committed
11

12
   See License_v1.2.txt for the full ParaView license.
Clinton Stimpson's avatar
 
Clinton Stimpson committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
   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 _pqWidgetEventPlayer_h
#define _pqWidgetEventPlayer_h

#include "QtTestingExport.h"
Clinton Stimpson's avatar
 
Clinton Stimpson committed
37
#include <QObject>
Clinton Stimpson's avatar
 
Clinton Stimpson committed
38 39 40 41

class QString;

/**
42 43 44
Abstract interface for an object that can playback high-level
ParaView events by translating them into low-level Qt events,
for test-cases, demos, tutorials, etc.
Clinton Stimpson's avatar
 
Clinton Stimpson committed
45 46 47 48

\sa pqEventPlayer
*/

Clinton Stimpson's avatar
 
Clinton Stimpson committed
49
class QTTESTING_EXPORT pqWidgetEventPlayer : public QObject
Clinton Stimpson's avatar
 
Clinton Stimpson committed
50
{
51 52
  Q_OBJECT

Clinton Stimpson's avatar
 
Clinton Stimpson committed
53
public:
Clinton Stimpson's avatar
 
Clinton Stimpson committed
54 55
  pqWidgetEventPlayer(QObject* p);
  virtual ~pqWidgetEventPlayer();
Clinton Stimpson's avatar
 
Clinton Stimpson committed
56

57 58 59 60
  /** Derivatives should implement this and play-back the given command,
  returning "true" if they handled the command, and setting Error
  to "true" if there were any problems. */
  virtual bool playEvent(
Mathieu Westphal's avatar
Mathieu Westphal committed
61 62 63 64 65 66 67 68 69 70
    QObject* object,
    const QString& command,
    const QString& arguments,
    bool& error);
  virtual bool playEvent(
    QObject* object,
    const QString& command,
    const QString& arguments,
    int eventType,
    bool& error);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
71 72 73 74 75

};

#endif // !_pqWidgetEventPlayer_h