Class: QgsExternalResourceWidget

class qgis.gui.QgsExternalResourceWidget(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

QgsExternalResourceWidget creates a widget with a file widget and a document viewer Both part of the widget are optional.

See also

QgsFileWidget

Widget to display file path with a push button for an “open file” dialog It can also be used to display a picture or a web page.

Parameters

parent

class DocumentViewerContent

Bases: int

Image = 1
NoContent = 0
Web = 2
actionEvent(self, QActionEvent)
changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
defaultRoot(self) → str

Configures the base path which should be used if the relativeStorage property is set to QgsFileWidget.RelativeDefaultPath.

Return type

str

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
documentPath(self, type: QVariant.Type = QVariant.String) → Any

documentPath returns the path of the current document in the widget

Parameters

type (QVariant.Type = QVariant.String) – determines the type of the returned null variant if the document is not defined yet

Return type

Any

documentViewerContent(self)QgsExternalResourceWidget.DocumentViewerContent

returns the type of content used in the document viewer

Return type

QgsExternalResourceWidget.DocumentViewerContent

documentViewerHeight(self) → int

returns the height of the document viewer

Return type

int

documentViewerWidth(self) → int

returns the width of the document viewer

Return type

int

dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent) → bool
fileWidget(self)QgsFileWidget

access the file widget to allow its configuration

Return type

QgsFileWidget

fileWidgetVisible(self) → bool

returns if the file widget is visible in the widget

Return type

bool

focusInEvent(self, QFocusEvent)
focusNextChild(self) → bool
focusNextPrevChild(self, bool) → bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self) → bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod) → bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric) → int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL) → int
relativeStorage(self)QgsFileWidget.RelativeStorage

Configures if paths are handled absolute or relative and if relative, which should be the base path.

Return type

QgsFileWidget.RelativeStorage

resizeEvent(self, QResizeEvent)
sender(self) → QObject
senderSignalIndex(self) → int
setDefaultRoot(self, defaultRoot: str)

Configures the base path which should be used if the relativeStorage property is set to QgsFileWidget.RelativeDefaultPath.

Parameters

defaultRoot (str) –

setDocumentPath(self, documentPath: Any)
Parameters

documentPath (Any) –

setDocumentViewerContent(self, content: QgsExternalResourceWidget.DocumentViewerContent)

setDocumentViewerContent defines the type of content to be shown. Widget will be adapted accordingly

Parameters

content (QgsExternalResourceWidget.DocumentViewerContent) –

setDocumentViewerHeight(self, height: int)

setDocumentViewerWidth set the height of the document viewer.

Parameters

height (int) – the height. Use 0 for automatic best display.

setDocumentViewerWidth(self, width: int)

setDocumentViewerWidth set the width of the document viewer.

Parameters

width (int) – the width. Use 0 for automatic best display.

setFileWidgetVisible(self, visible: bool)

Sets the visibility of the file widget in the layout

Parameters

visible (bool) –

setReadOnly(self, readOnly: bool)

defines if the widget is readonly

Parameters

readOnly (bool) –

setRelativeStorage(self, relativeStorage: QgsFileWidget.RelativeStorage)

Configures if paths are handled absolute or relative and if relative, which should be the base path.

Parameters

relativeStorage (QgsFileWidget.RelativeStorage) –

sharedPainter(self) → QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
valueChanged

emitteed as soon as the current document changes [signal]

wheelEvent(self, QWheelEvent)