Squirt 3.21
OaGuiTestScreenCapture Class Reference

Captures screenshots from the current test panel. More...

Public Member Functions

public OaGuiTestScreenCapture (const string testCaseId="")
 The Default Constructor. More...
 
public void clearCaptures ()
 Deletes all captures for the current test case.
 
public void takeScreen (const string &suffix)
 Stores a screenshot of the current panel. More...
 
public void printLastLocation ()
 Logs the latest capture path as an informational message.
 

Public Attributes

public shape currentPanel = 0
 Active panel shape used for capture requests.
 

Protected Member Functions

protected string getImagesDir ()
 Returns the capture directory for the current test case. More...
 

Protected Attributes

protected string testCaseId
 Relative test case path used to organize captures.
 
protected string imagePath
 Absolute path of the latest created image.
 

Detailed Description

Captures screenshots from the current test panel.

Attention
This documentation is created with the help of an artificial intelligence.

Constructor & Destructor Documentation

◆ OaGuiTestScreenCapture()

public OaGuiTestScreenCapture::OaGuiTestScreenCapture ( const string  testCaseId = "")

The Default Constructor.

Parameters
testCaseIdRelative test case path for capture storage.

Member Function Documentation

◆ getImagesDir()

protected string OaGuiTestScreenCapture::getImagesDir ( )
protected

Returns the capture directory for the current test case.

Returns
Absolute directory path.

◆ takeScreen()

public void OaGuiTestScreenCapture::takeScreen ( const string &  suffix)

Stores a screenshot of the current panel.

Parameters
suffixFile name suffix, for example latest-success.

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