Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
"""
mantiddoc.tools.screenshot
~~~~~~~~~~~~~~~~~~~~~~~~~~
Provides functions to take a screenshot of a QWidgets.
It currently assumes that the functions are called within the
MantidPlot Python environment
:copyright: Copyright 2014
ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
"""
def algorithm_screenshot(name, directory, ext=".png"):
"""
Takes a snapshot of an algorithm dialog and saves it as an image
named "name_dlg.png"
Args:
name (str): The name of the algorithm
directory (str): An directory path where the image should be saved
ext (str): An optional extension (including the period). Default=.png
Returns:
str: A full path to the image file
"""
import mantidqtpython as mantidqt
from mantidplot import screenshot_to_dir, threadsafe_call
iface_mgr = mantidqt.MantidQt.API.InterfaceManager()
# threadsafe_call required for MantidPlot
dlg = threadsafe_call(iface_mgr.createDialogFromName, name, True)
filename = name + "_dlg" + ext
img_path = screenshot_to_dir(widget=dlg, filename=filename, screenshot_dir=directory)
threadsafe_call(dlg.close)
return img_path