Skip to content

Improve screenshot capture function #11

Description

@lassoan

Currently self.tutorial.nextScreenshot() method is called to capture a screenshot. The problem with this is that the generated output cannot be easily associated with screenshot used in the documentation file. => the method should take in identifier (e.g., "012-part1-after-mri-loading")

Currently, each window is captured as a separate image. It means that each slice view controller floating widgets are captured as separate windows instead of part of the application screen layout. => change screen capture method to capture a single screenshot (capture each window and merge the images into a single image). In the future we could implement support for capturing only certain window (e.g., identified by specifying a widget that is inside that window), but it is not needed for now.

Method API would be:

def captureScreenshot(id: str)
    """Capture screenshot of the application window and all popup windows of the application.
    id: string that uniquely identifies the screenshot in the documentation, recommended to start with a 3-digit numeric code,
        followed by a short text. For example: `105-part2-clipping`
    """

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions