libyui  3.3.1
YMacro Class Reference

Simple access to macro recording and playing. More...

#include <YMacro.h>

Static Public Member Functions

static void setRecorder (YMacroRecorder *recorder)
 Set a macro recorder. More...
 
static void setPlayer (YMacroPlayer *player)
 Set a macro player. More...
 
static void record (const std::string &macroFile)
 Record a macro to the specified macro file.
 
static void endRecording ()
 End macro recording.
 
static bool recording ()
 Return 'true' if a macro is currently being recorded.
 
static void play (const std::string &macroFile)
 Play a macro from the specified macro file.
 
static void playNextBlock ()
 Play the next block from the current macro, if there is one playing.
 
static bool playing ()
 Return 'true' if a macro is currently being played.
 
static YMacroRecorderrecorder ()
 Return the current macro recorder or 0 if there is none.
 
static YMacroPlayerplayer ()
 Return the current macro player or 0 if there is none.
 
static void deleteRecorder ()
 Delete the current macro recorder if there is one.
 
static void deletePlayer ()
 Delete the current macro player if there is one.
 

Detailed Description

Simple access to macro recording and playing.

This class stores an instance of a macro recorder and a macro player. Since both YMacroRecorder and YMacroPlayer are abstract base classes, derived classes from either of them have to be instantiated and set (setRecorder(), setPlayer()) from the outside for anything to happen. Until that point, none of the macro operations here do anything (but also don't throw any error or exception).

Definition at line 44 of file YMacro.h.

Member Function Documentation

◆ setPlayer()

void YMacro::setPlayer ( YMacroPlayer player)
static

Set a macro player.

This needs to be done from the outside since YMacroRecorder is an abstract base class, i.e., it needs to be derived to be instantiated.

Definition at line 43 of file YMacro.cc.

Here is the call graph for this function:

◆ setRecorder()

void YMacro::setRecorder ( YMacroRecorder recorder)
static

Set a macro recorder.

This needs to be done from the outside since YMacroRecorder is an abstract base class, i.e., it needs to be derived to be instantiated.

Definition at line 34 of file YMacro.cc.

Here is the call graph for this function:

The documentation for this class was generated from the following files: