libyui  3.0.10
/usr/src/RPM/BUILD/libyui-3.0.10/src/YMacroPlayer.h
00001 /*
00002   Copyright (C) 2000-2012 Novell, Inc
00003   This library is free software; you can redistribute it and/or modify
00004   it under the terms of the GNU Lesser General Public License as
00005   published by the Free Software Foundation; either version 2.1 of the
00006   License, or (at your option) version 3.0 of the License. This library
00007   is distributed in the hope that it will be useful, but WITHOUT ANY
00008   WARRANTY; without even the implied warranty of MERCHANTABILITY or 
00009   FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
00010   License for more details. You should have received a copy of the GNU
00011   Lesser General Public License along with this library; if not, write
00012   to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
00013   Floor, Boston, MA 02110-1301 USA
00014 */
00015 
00016 
00017 /*-/
00018 
00019   File:         YMacroPlayer.h
00020 
00021   Author:       Stefan Hundhammer <sh@suse.de>
00022 
00023 /-*/
00024 
00025 #ifndef YMacroPlayer_h
00026 #define YMacroPlayer_h
00027 
00028 #include <string>
00029 
00030 /**
00031  * Abstract base class for macro player.
00032  *
00033  * Applications should not use this directly, but the static methods in YMacro.
00034  **/
00035 class YMacroPlayer
00036 {
00037     friend class YMacro;
00038 
00039 protected:
00040     /**
00041      * Constructor
00042      **/
00043     YMacroPlayer() {}
00044 
00045 public:
00046     /**
00047      * Destructor
00048      **/
00049     virtual ~YMacroPlayer() {}
00050 
00051     /**
00052      * Play a macro from the specified macro file.
00053      **/
00054     virtual void play( const std::string & macroFile ) = 0;
00055 
00056     /**
00057      * Play the next block from the current macro, if there is one playing.
00058      **/
00059     virtual void playNextBlock() = 0;
00060 
00061     /**
00062      * Return 'true' if a macro is currently being played.
00063      **/
00064     virtual bool playing() const = 0;
00065 };
00066 
00067 #endif // YMacroPlayer_h
 All Classes Functions Variables Enumerations Friends