libyui  3.4.2
YMacroPlayer.h
1 /*
2  Copyright (C) 2000-2012 Novell, Inc
3  This library is free software; you can redistribute it and/or modify
4  it under the terms of the GNU Lesser General Public License as
5  published by the Free Software Foundation; either version 2.1 of the
6  License, or (at your option) version 3.0 of the License. This library
7  is distributed in the hope that it will be useful, but WITHOUT ANY
8  WARRANTY; without even the implied warranty of MERCHANTABILITY or
9  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
10  License for more details. You should have received a copy of the GNU
11  Lesser General Public License along with this library; if not, write
12  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
13  Floor, Boston, MA 02110-1301 USA
14 */
15 
16 
17 /*-/
18 
19  File: YMacroPlayer.h
20 
21  Author: Stefan Hundhammer <sh@suse.de>
22 
23 /-*/
24 
25 #ifndef YMacroPlayer_h
26 #define YMacroPlayer_h
27 
28 #include <string>
29 
30 /**
31  * Abstract base class for macro player.
32  *
33  * Applications should not use this directly, but the static methods in YMacro.
34  **/
36 {
37  friend class YMacro;
38 
39 protected:
40  /**
41  * Constructor
42  **/
44 
45 public:
46  /**
47  * Destructor
48  **/
49  virtual ~YMacroPlayer() {}
50 
51  /**
52  * Play a macro from the specified macro file.
53  **/
54  virtual void play( const std::string & macroFile ) = 0;
55 
56  /**
57  * Play the next block from the current macro, if there is one playing.
58  **/
59  virtual void playNextBlock() = 0;
60 
61  /**
62  * Return 'true' if a macro is currently being played.
63  **/
64  virtual bool playing() const = 0;
65 };
66 
67 #endif // YMacroPlayer_h
virtual void playNextBlock()=0
Play the next block from the current macro, if there is one playing.
Abstract base class for macro player.
Definition: YMacroPlayer.h:35
virtual void play(const std::string &macroFile)=0
Play a macro from the specified macro file.
YMacroPlayer()
Constructor.
Definition: YMacroPlayer.h:43
Simple access to macro recording and playing.
Definition: YMacro.h:44
virtual ~YMacroPlayer()
Destructor.
Definition: YMacroPlayer.h:49
virtual bool playing() const =0
Return &#39;true&#39; if a macro is currently being played.