pqEventSource.h 2.23 KB
Newer Older
Clinton Stimpson's avatar
 
Clinton Stimpson committed
1 2 3
/*=========================================================================

   Program: ParaView
4
   Module:    pqEventSource.h
Clinton Stimpson's avatar
 
Clinton Stimpson committed
5

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
   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.

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

33 34
#ifndef _pqEventSource_h
#define _pqEventSource_h
Clinton Stimpson's avatar
 
Clinton Stimpson committed
35 36

#include "QtTestingExport.h"
Clinton Stimpson's avatar
 
Clinton Stimpson committed
37
#include <QObject>
38
class QString;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
39

40
/// Abstract interface for objects that can supply high-level testing events
Clinton Stimpson's avatar
 
Clinton Stimpson committed
41
class QTTESTING_EXPORT pqEventSource : public QObject
Clinton Stimpson's avatar
 
Clinton Stimpson committed
42
{
Clinton Stimpson's avatar
 
Clinton Stimpson committed
43
  Q_OBJECT
Clinton Stimpson's avatar
 
Clinton Stimpson committed
44
public:
Clinton Stimpson's avatar
 
Clinton Stimpson committed
45
  pqEventSource(QObject* p) : QObject(p) {}
46
  virtual ~pqEventSource() {}
Clinton Stimpson's avatar
 
Clinton Stimpson committed
47

Clinton Stimpson's avatar
 
Clinton Stimpson committed
48 49 50 51 52 53 54
  enum { SUCCESS, FAILURE, DONE };

  /** Retrieves the next available event.  
    Returns SUCCESS if an event was returned and can be processed,
    FAILURE if there was a problem,
    DONE, if there are no more events. */
  virtual int getNextEvent(
55 56 57
    QString& object,
    QString& command,
    QString& arguments) = 0;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
58

Clinton Stimpson's avatar
 
Clinton Stimpson committed
59 60 61 62
  /** Set the filename for contents.
      Returns true for valid file, false for invalid file */
  virtual void setContent(const QString& filename) = 0;

Clinton Stimpson's avatar
 
Clinton Stimpson committed
63 64 65
  /** tell the source to stop feeding in events */
  virtual void stop() {}

Clinton Stimpson's avatar
 
Clinton Stimpson committed
66 67
};

68
#endif // !_pqEventSource_h
Clinton Stimpson's avatar
 
Clinton Stimpson committed
69