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. More...

#include <qgsexternalresourcewidget.h>

Inheritance diagram for QgsExternalResourceWidget:

[legend]

Public Types
enum	DocumentViewerContent { NoContent , Image , Web , Audio , Video }

Signals
void	valueChanged (const QString &value)
	Emitted as soon as the current document changes.

Public Member Functions
	QgsExternalResourceWidget (QWidget *parent=nullptr)
	QgsExternalResourceWidget creates a widget with a file widget and a document viewer Both part of the widget are optional.

QString	defaultRoot () const
	Configures the base path which should be used if the relativeStorage property is set to QgsFileWidget::RelativeDefaultPath.

QVariant	documentPath (QMetaType::Type type=QMetaType::Type::QString) const
	documentPath returns the path of the current document in the widget

Q_DECL_DEPRECATED QVariant	documentPath (QVariant::Type type) const
	documentPath returns the path of the current document in the widget

QgsExternalResourceWidget::DocumentViewerContent	documentViewerContent () const
	returns the type of content used in the document viewer

int	documentViewerHeight () const
	returns the height of the document viewer

int	documentViewerWidth () const
	returns the width of the document viewer

QgsExternalStorageFileWidget *	fileWidget ()
	Returns file widget to allow its configuration.

bool	fileWidgetVisible () const
	returns if the file widget is visible in the widget

QgsMessageBar *	messageBar () const
	Returns message bar used to report messages.

QgsFileWidget::RelativeStorage	relativeStorage () const
	Configures if paths are handled absolute or relative and if relative, which should be the base path.

void	setDefaultRoot (const QString &defaultRoot)
	Configures the base path which should be used if the relativeStorage property is set to QgsFileWidget::RelativeDefaultPath.

void	setDocumentPath (const QVariant &documentPath)

void	setDocumentViewerContent (QgsExternalResourceWidget::DocumentViewerContent content)
	setDocumentViewerContent defines the type of content to be shown. Widget will be adapted accordingly

void	setDocumentViewerHeight (int height)
	setDocumentViewerWidth set the height of the document viewer.

void	setDocumentViewerWidth (int width)
	setDocumentViewerWidth set the width of the document viewer.

void	setFileWidgetVisible (bool visible)
	Sets the visibility of the file widget in the layout.

void	setMessageBar (QgsMessageBar *messageBar)
	Set messageBar to report messages.

void	setReadOnly (bool readOnly)
	defines if the widget is readonly

void	setRelativeStorage (QgsFileWidget::RelativeStorage relativeStorage)
	Configures if paths are handled absolute or relative and if relative, which should be the base path.

void	setStorageAuthConfigId (const QString &authCfg)
	Sets the authentication configuration ID to be used for the current external storage (if defined)

void	setStorageType (const QString &storageType)
	Set storageType storage type unique identifier as defined in QgsExternalStorageRegistry or an empty QString if there is no storage defined, only file selection.

QString	storageAuthConfigId () const
	Returns the authentication configuration ID used for the current external storage (if defined)

QString	storageType () const
	Returns storage type unique identifier as defined in QgsExternalStorageRegistry.

Properties
QString	defaultRoot

DocumentViewerContent	documentViewerContent

int	documentViewerHeight

int	documentViewerWidth

bool	fileWidgetVisible

QgsFileWidget::RelativeStorage	relativeStorage

Friends
class	TestQgsExternalResourceWidgetWrapper

Detailed Description

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.

Definition at line 53 of file qgsexternalresourcewidget.h.

Member Enumeration Documentation

◆ DocumentViewerContent

enum QgsExternalResourceWidget::DocumentViewerContent

Enumerator
NoContent
Image
Web
Audio
Video

Definition at line 73 of file qgsexternalresourcewidget.h.

Constructor & Destructor Documentation

◆ QgsExternalResourceWidget()

QgsExternalResourceWidget::QgsExternalResourceWidget ( QWidget * parent = nullptr )

explicit

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

See also: QgsFileWidget

Definition at line 42 of file qgsexternalresourcewidget.cpp.

Member Function Documentation

◆ defaultRoot()

QString QgsExternalResourceWidget::defaultRoot ( ) const

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

Definition at line 265 of file qgsexternalresourcewidget.cpp.

◆ documentPath() [1/2]

QVariant QgsExternalResourceWidget::documentPath ( QMetaType::Type type = QMetaType::Type::QString ) const

documentPath returns the path of the current document in the widget

Parameters

type	determines the type of the returned null variant if the document is not defined yet

Definition at line 85 of file qgsexternalresourcewidget.cpp.

◆ documentPath() [2/2]

QVariant QgsExternalResourceWidget::documentPath ( QVariant::Type type ) const

documentPath returns the path of the current document in the widget

Parameters

type	determines the type of the returned null variant if the document is not defined yet

Deprecated:: QGIS 3.38. Use the method with a QMetaType::Type argument instead.

Definition at line 98 of file qgsexternalresourcewidget.cpp.

◆ documentViewerContent()

QgsExternalResourceWidget::DocumentViewerContent QgsExternalResourceWidget::documentViewerContent ( ) const

returns the type of content used in the document viewer

Definition at line 125 of file qgsexternalresourcewidget.cpp.

◆ documentViewerHeight()

int QgsExternalResourceWidget::documentViewerHeight ( ) const

returns the height of the document viewer

Definition at line 138 of file qgsexternalresourcewidget.cpp.

◆ documentViewerWidth()

int QgsExternalResourceWidget::documentViewerWidth ( ) const

returns the width of the document viewer

Definition at line 149 of file qgsexternalresourcewidget.cpp.

◆ fileWidget()

QgsExternalStorageFileWidget * QgsExternalResourceWidget::fileWidget ( )

Returns file widget to allow its configuration.

Definition at line 109 of file qgsexternalresourcewidget.cpp.

◆ fileWidgetVisible()

bool QgsExternalResourceWidget::fileWidgetVisible ( ) const

returns if the file widget is visible in the widget

Definition at line 114 of file qgsexternalresourcewidget.cpp.

◆ messageBar()

QgsMessageBar * QgsExternalResourceWidget::messageBar ( ) const

Returns message bar used to report messages.

Since: QGIS 3.22

Definition at line 312 of file qgsexternalresourcewidget.cpp.

◆ relativeStorage()

QgsFileWidget::RelativeStorage QgsExternalResourceWidget::relativeStorage ( ) const

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

Definition at line 276 of file qgsexternalresourcewidget.cpp.

◆ setDefaultRoot()

void QgsExternalResourceWidget::setDefaultRoot ( const QString & defaultRoot )

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

Definition at line 270 of file qgsexternalresourcewidget.cpp.

◆ setDocumentPath()

void QgsExternalResourceWidget::setDocumentPath ( const QVariant & documentPath )

Definition at line 104 of file qgsexternalresourcewidget.cpp.

◆ setDocumentViewerContent()

void QgsExternalResourceWidget::setDocumentViewerContent ( QgsExternalResourceWidget::DocumentViewerContent content )

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

Definition at line 130 of file qgsexternalresourcewidget.cpp.

◆ setDocumentViewerHeight()

void QgsExternalResourceWidget::setDocumentViewerHeight ( int height )

setDocumentViewerWidth set the height of the document viewer.

Parameters

height the height. Use 0 for automatic best display.

Definition at line 143 of file qgsexternalresourcewidget.cpp.

◆ setDocumentViewerWidth()

void QgsExternalResourceWidget::setDocumentViewerWidth ( int width )

setDocumentViewerWidth set the width of the document viewer.

Parameters

width the width. Use 0 for automatic best display.

Definition at line 154 of file qgsexternalresourcewidget.cpp.

◆ setFileWidgetVisible()

void QgsExternalResourceWidget::setFileWidgetVisible ( bool visible )

Sets the visibility of the file widget in the layout.

Definition at line 119 of file qgsexternalresourcewidget.cpp.

◆ setMessageBar()

void QgsExternalResourceWidget::setMessageBar ( QgsMessageBar * messageBar )

Set messageBar to report messages.

Since: QGIS 3.22

Definition at line 307 of file qgsexternalresourcewidget.cpp.

◆ setReadOnly()

void QgsExternalResourceWidget::setReadOnly ( bool readOnly )

defines if the widget is readonly

Definition at line 160 of file qgsexternalresourcewidget.cpp.

◆ setRelativeStorage()

void QgsExternalResourceWidget::setRelativeStorage ( QgsFileWidget::RelativeStorage relativeStorage )

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

Definition at line 281 of file qgsexternalresourcewidget.cpp.

◆ setStorageAuthConfigId()

void QgsExternalResourceWidget::setStorageAuthConfigId ( const QString & authCfg )

Sets the authentication configuration ID to be used for the current external storage (if defined)

Since: QGIS 3.22

Definition at line 297 of file qgsexternalresourcewidget.cpp.

◆ setStorageType()

void QgsExternalResourceWidget::setStorageType ( const QString & storageType )

Set storageType storage type unique identifier as defined in QgsExternalStorageRegistry or an empty QString if there is no storage defined, only file selection.

See also: storageType

Since: QGIS 3.22

Definition at line 287 of file qgsexternalresourcewidget.cpp.

◆ storageAuthConfigId()

QString QgsExternalResourceWidget::storageAuthConfigId ( ) const

Returns the authentication configuration ID used for the current external storage (if defined)

Since: QGIS 3.22

Definition at line 302 of file qgsexternalresourcewidget.cpp.

◆ storageType()

QString QgsExternalResourceWidget::storageType ( ) const

Returns storage type unique identifier as defined in QgsExternalStorageRegistry.

Returns an empty QString if there is no storage defined, only file selection.

See also: setStorageType

Since: QGIS 3.22

Definition at line 292 of file qgsexternalresourcewidget.cpp.

◆ valueChanged

void QgsExternalResourceWidget::valueChanged ( const QString & value )

signal

Emitted as soon as the current document changes.

Friends And Related Symbol Documentation

◆ TestQgsExternalResourceWidgetWrapper

friend class TestQgsExternalResourceWidgetWrapper

friend

Definition at line 252 of file qgsexternalresourcewidget.h.

Property Documentation

◆ defaultRoot

QString QgsExternalResourceWidget::defaultRoot

readwrite

Definition at line 70 of file qgsexternalresourcewidget.h.

◆ documentViewerContent

DocumentViewerContent QgsExternalResourceWidget::documentViewerContent

readwrite

Definition at line 66 of file qgsexternalresourcewidget.h.

◆ documentViewerHeight

int QgsExternalResourceWidget::documentViewerHeight

readwrite

Definition at line 67 of file qgsexternalresourcewidget.h.

◆ documentViewerWidth

int QgsExternalResourceWidget::documentViewerWidth

readwrite

Definition at line 68 of file qgsexternalresourcewidget.h.

◆ fileWidgetVisible

bool QgsExternalResourceWidget::fileWidgetVisible

readwrite

Definition at line 65 of file qgsexternalresourcewidget.h.

◆ relativeStorage

QgsFileWidget::RelativeStorage QgsExternalResourceWidget::relativeStorage

readwrite

Definition at line 69 of file qgsexternalresourcewidget.h.

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

/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/qgsexternalresourcewidget.h
/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/qgsexternalresourcewidget.cpp

Public Types

Signals

Public Member Functions

Properties

Friends

Detailed Description

Member Enumeration Documentation

◆ DocumentViewerContent

Constructor & Destructor Documentation

◆ QgsExternalResourceWidget()

Member Function Documentation

◆ defaultRoot()

◆ documentPath() [1/2]

◆ documentPath() [2/2]

◆ documentViewerContent()

◆ documentViewerHeight()

◆ documentViewerWidth()

◆ fileWidget()

◆ fileWidgetVisible()

◆ messageBar()

◆ relativeStorage()

◆ setDefaultRoot()

◆ setDocumentPath()

◆ setDocumentViewerContent()

◆ setDocumentViewerHeight()

◆ setDocumentViewerWidth()

◆ setFileWidgetVisible()

◆ setMessageBar()

◆ setReadOnly()

◆ setRelativeStorage()

◆ setStorageAuthConfigId()

◆ setStorageType()

◆ storageAuthConfigId()

◆ storageType()

◆ valueChanged

Friends And Related Symbol Documentation

◆ TestQgsExternalResourceWidgetWrapper

Property Documentation

◆ defaultRoot

◆ documentViewerContent

◆ documentViewerHeight

◆ documentViewerWidth

◆ fileWidgetVisible

◆ relativeStorage