PyDMEmbeddedDisplay

class pydm.widgets.embedded_display.PyDMEmbeddedDisplay(parent=None)[source]

A QFrame capable of rendering a PyDM Display

Parameters

parent (QWidget) – The parent widget for the Label

connect()[source]

Establish the connection between the embedded widget and the channels associated with it.

disconnect()[source]

Disconnects the embedded widget from the channels associated with it.

disconnectWhenHidden

Disconnect from PVs when this widget is not visible.

Returns

Return type

bool

property embedded_widget

The embedded widget being displayed.

Returns

Return type

QWidget

filename

Filename of the display to embed.

Returns

Return type

str

hideEvent(e)[source]

Hide events are sent to widgets that become invisible on the screen.

Parameters

event (QHideEvent) –

loadWhenShown

If True, only load and display the file once the PyDMEmbeddedDisplayWidget is visible on screen. This is very useful if you have many different PyDMEmbeddedWidgets in different tabs of a QTabBar or PyDMTabBar: only the tab that the user is looking at will be loaded, which can greatly speed up the launch time of a display.

If this property is changed from ‘True’ to ‘False’, and the file has not been loaded yet, it will be loaded immediately.

Returns

Return type

bool

macros

JSON-formatted string containing macro variables to pass to the embedded file.

Returns

Return type

str

minimumSizeHint()[source]

This property holds the recommended minimum size for the widget.

Returns

Return type

QSize

open_file(force=False)[source]

Opens the widget specified in the widget’s filename property.

Returns

display

Return type

QWidget

parsed_macros()[source]

Dictionary containing the key value pair for each macro specified.

Returns

Return type

dict

showEvent(e)[source]

Show events are sent to widgets that become visible on the screen.

Parameters

event (QShowEvent) –