YMacro Class Reference

#include <YMacro.h>

Static Public Member Functions
static void	setRecorder (YMacroRecorder *recorder)
static void	setPlayer (YMacroPlayer *player)
static void	record (const std::string &macroFile)
static void	endRecording ()
static bool	recording ()
static void	play (const std::string &macroFile)
static void	playNextBlock ()
static bool	playing ()
static YMacroRecorder *	recorder ()
static YMacroPlayer *	player ()
static void	deleteRecorder ()
static void	deletePlayer ()

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

Member Function Documentation

deletePlayer()

void YMacro::deletePlayer ( )

static

Delete the current macro player if there is one.

deleteRecorder()

void YMacro::deleteRecorder ( )

static

Delete the current macro recorder if there is one.

endRecording()

void YMacro::endRecording ( )

static

End macro recording.

play()

void YMacro::play ( const std::string & macroFile )

static

Play a macro from the specified macro file.

player()

static YMacroPlayer * YMacro::player ( )

inlinestatic

Return the current macro player or 0 if there is none.

playing()

bool YMacro::playing ( )

static

Return 'true' if a macro is currently being played.

playNextBlock()

void YMacro::playNextBlock ( )

static

Play the next block from the current macro, if there is one playing.

record()

void YMacro::record ( const std::string & macroFile )

static

Record a macro to the specified macro file.

recorder()

static YMacroRecorder * YMacro::recorder ( )

inlinestatic

Return the current macro recorder or 0 if there is none.

recording()

bool YMacro::recording ( )

static

Return 'true' if a macro is currently being recorded.

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.

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.

---

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

• /__w/libyui/libyui/libyui/src/YMacro.h
• /__w/libyui/libyui/libyui/src/YMacro.cc