YMacroRecorder Class Reference

#include <YMacroRecorder.h>

List of all members.

Public Member Functions
	YMacroRecorder (const string &macroFileName)
virtual	~YMacroRecorder ()
void	recordUserInput (const YCPValue &input)
void	recordWidgetProperty (YWidget *widget, const char *propertyName)
void	recordMakeScreenShot (bool enabled=false, const char *filename=0)
void	recordComment (string comment_text)
void	beginBlock ()
void	endBlock ()
Protected Member Functions
void	openMacroFile (const string &macroFileName)
void	closeMacroFile ()
void	writeMacroFileHeader ()
void	writeMacroFileFooter ()
void	recordYcpCodeLocation ()
void	recordTimeStamp ()
void	recordDialogDebugLabel ()
Protected Attributes
FILE *	_macroFile
int	_screenShotCount

---

Constructor & Destructor Documentation

YMacroRecorder::YMacroRecorder

(

const string &

macroFileName

)

Constructor

YMacroRecorder::~YMacroRecorder

(

)

[virtual]

Destructor

---

Member Function Documentation

void YMacroRecorder::recordUserInput

(

const YCPValue &

input

)

Record one user input.

void YMacroRecorder::recordWidgetProperty	(	YWidget *	widget,
		const char *	propertyName
	)

Record one widget property.

void YMacroRecorder::recordMakeScreenShot	(	bool	enabled = false,
		const char *	filename = 0
	)

Record a "UI::MakeScreenShot()" statement.

If 'enabled' is 'false', this statement will be commented out. If no file name is given, a default file name (with auto-increment) will be used.

void YMacroRecorder::recordComment

(

string

comment_text

)

Record a text as a comment.

void YMacroRecorder::beginBlock

(

)

Begin a macro block that will be executed as a whole.

void YMacroRecorder::endBlock

(

)

End a macro block that will be executed as a whole.

void YMacroRecorder::openMacroFile

(

const string &

macroFileName

)

[protected]

Open the internally used macro file for writing.

On error a message is issued to the log file. All write functions check the internally used macro file prior to using it, so it is perfectly safe to use them even if the initial open failed.

void YMacroRecorder::closeMacroFile

(

)

[protected]

Close the internally used macro file.

void YMacroRecorder::writeMacroFileHeader

(

)

[protected]

Write a standardized macro file header.

void YMacroRecorder::writeMacroFileFooter

(

)

[protected]

Write a standardized macro file footer.

void YMacroRecorder::recordYcpCodeLocation

(

)

[protected]

Record file name and line number of current YCP code

void YMacroRecorder::recordTimeStamp

(

)

[protected]

Record a time stamp to match with y2logs

void YMacroRecorder::recordDialogDebugLabel

(

)

[protected]

Record a human-readable identification of the dialog (its heading etc.)

---

Member Data Documentation

FILE* YMacroRecorder::_macroFile [protected]

The internally used macro file; valid if non-null.

int YMacroRecorder::_screenShotCount [protected]

A counter for making screen shots.

---

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

• YMacroRecorder.h
• YMacroRecorder.cc

---