QgsExternalResourceWidget Class Reference

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:

Public Types
enum	DocumentViewerContent { NoContent , Image , Web }

Signals
void	valueChanged (const QString &)
	emitteed as soon as the current document changes More...

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. More...
QString	defaultRoot () const
	Configures the base path which should be used if the relativeStorage property is set to QgsFileWidget::RelativeDefaultPath. More...
QVariant	documentPath (QVariant::Type type=QVariant::String) const
	documentPath returns the path of the current document in the widget More...
QgsExternalResourceWidget::DocumentViewerContent	documentViewerContent () const
	returns the type of content used in the document viewer More...
int	documentViewerHeight () const
	returns the height of the document viewer More...
int	documentViewerWidth () const
	returns the width of the document viewer More...
QgsExternalStorageFileWidget *	fileWidget ()
	Returns file widget to allow its configuration. More...
bool	fileWidgetVisible () const
	returns if the file widget is visible in the widget More...
QgsMessageBar *	messageBar () const
	Returns message bar used to report messages. More...
QgsFileWidget::RelativeStorage	relativeStorage () const
	Configures if paths are handled absolute or relative and if relative, which should be the base path. More...
void	setDefaultRoot (const QString &defaultRoot)
	Configures the base path which should be used if the relativeStorage property is set to QgsFileWidget::RelativeDefaultPath. More...
void	setDocumentPath (const QVariant &documentPath)
void	setDocumentViewerContent (QgsExternalResourceWidget::DocumentViewerContent content)
	setDocumentViewerContent defines the type of content to be shown. Widget will be adapted accordingly More...
void	setDocumentViewerHeight (int height)
	setDocumentViewerWidth set the height of the document viewer. More...
void	setDocumentViewerWidth (int width)
	setDocumentViewerWidth set the width of the document viewer. More...
void	setFileWidgetVisible (bool visible)
	Sets the visibility of the file widget in the layout. More...
void	setMessageBar (QgsMessageBar *messageBar)
	Set messageBar to report messages. More...
void	setReadOnly (bool readOnly)
	defines if the widget is readonly More...
void	setRelativeStorage (QgsFileWidget::RelativeStorage relativeStorage)
	Configures if paths are handled absolute or relative and if relative, which should be the base path. More...
void	setStorageAuthConfigId (const QString &authCfg)
	Sets the authentication configuration ID to be used for the current external storage (if defined) More...
void	setStorageType (const QString &storageType)
	Set storageType storage type unique identifier as defined in QgsExternalStorageRegistry or null QString if there is no storage defined, only file selection. More...
QString	storageAuthConfigId () const
	Returns the authentication configuration ID used for the current external storage (if defined) More...
QString	storageType () const
	Returns storage type unique identifier as defined in QgsExternalStorageRegistry. More...

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 52 of file qgsexternalresourcewidget.h.

Member Enumeration Documentation

DocumentViewerContent

enum QgsExternalResourceWidget::DocumentViewerContent

Enumerator
NoContent
Image
Web

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 40 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 216 of file qgsexternalresourcewidget.cpp.

documentPath()

QVariant QgsExternalResourceWidget::documentPath

(

QVariant::Type

type = QVariant::String

)

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 80 of file qgsexternalresourcewidget.cpp.

documentViewerContent()

QgsExternalResourceWidget::DocumentViewerContent QgsExternalResourceWidget::documentViewerContent

(

)

const

returns the type of content used in the document viewer

Definition at line 114 of file qgsexternalresourcewidget.cpp.

documentViewerHeight()

int QgsExternalResourceWidget::documentViewerHeight

(

)

const

returns the height of the document viewer

Definition at line 127 of file qgsexternalresourcewidget.cpp.

documentViewerWidth()

int QgsExternalResourceWidget::documentViewerWidth

(

)

const

returns the width of the document viewer

Definition at line 138 of file qgsexternalresourcewidget.cpp.

fileWidget()

QgsExternalStorageFileWidget * QgsExternalResourceWidget::fileWidget

(

)

Returns file widget to allow its configuration.

Definition at line 98 of file qgsexternalresourcewidget.cpp.

fileWidgetVisible()

bool QgsExternalResourceWidget::fileWidgetVisible

(

)

const

returns if the file widget is visible in the widget

Definition at line 103 of file qgsexternalresourcewidget.cpp.

messageBar()

QgsMessageBar * QgsExternalResourceWidget::messageBar

(

)

const

Returns message bar used to report messages.

Since

3.22

Definition at line 263 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 227 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 221 of file qgsexternalresourcewidget.cpp.

setDocumentPath()

void QgsExternalResourceWidget::setDocumentPath

(

const QVariant &

documentPath

)

Definition at line 93 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 119 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 132 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 143 of file qgsexternalresourcewidget.cpp.

setFileWidgetVisible()

void QgsExternalResourceWidget::setFileWidgetVisible

(

bool

visible

)

Sets the visibility of the file widget in the layout.

Definition at line 108 of file qgsexternalresourcewidget.cpp.

setMessageBar()

void QgsExternalResourceWidget::setMessageBar

(

QgsMessageBar *

messageBar

)

Set messageBar to report messages.

Since

3.22

Definition at line 258 of file qgsexternalresourcewidget.cpp.

setReadOnly()

void QgsExternalResourceWidget::setReadOnly

(

bool

readOnly

)

defines if the widget is readonly

Definition at line 149 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 232 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 248 of file qgsexternalresourcewidget.cpp.

setStorageType()

void QgsExternalResourceWidget::setStorageType

(

const QString &

storageType

)

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

See also

storageType

Since

QGIS 3.22

Definition at line 238 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 253 of file qgsexternalresourcewidget.cpp.

storageType()

QString QgsExternalResourceWidget::storageType

(

)

const

Returns storage type unique identifier as defined in QgsExternalStorageRegistry.

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

See also

setStorageType

Since

QGIS 3.22

Definition at line 243 of file qgsexternalresourcewidget.cpp.

valueChanged

void QgsExternalResourceWidget::valueChanged ( const QString &  )

signal

emitteed as soon as the current document changes

Friends And Related Function Documentation

TestQgsExternalResourceWidgetWrapper

friend class TestQgsExternalResourceWidgetWrapper

friend

Definition at line 238 of file qgsexternalresourcewidget.h.

Property Documentation

defaultRoot

QString QgsExternalResourceWidget::defaultRoot

readwrite

Definition at line 52 of file qgsexternalresourcewidget.h.

documentViewerContent

DocumentViewerContent QgsExternalResourceWidget::documentViewerContent

readwrite

Definition at line 52 of file qgsexternalresourcewidget.h.

documentViewerHeight

int QgsExternalResourceWidget::documentViewerHeight

readwrite

Definition at line 52 of file qgsexternalresourcewidget.h.

documentViewerWidth

int QgsExternalResourceWidget::documentViewerWidth

readwrite

Definition at line 52 of file qgsexternalresourcewidget.h.

fileWidgetVisible

bool QgsExternalResourceWidget::fileWidgetVisible

readwrite

Definition at line 52 of file qgsexternalresourcewidget.h.

relativeStorage

QgsFileWidget::RelativeStorage QgsExternalResourceWidget::relativeStorage

readwrite

Definition at line 52 of file qgsexternalresourcewidget.h.

---

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

• /build/qgis-3.28.0+99sid/src/gui/qgsexternalresourcewidget.h
• /build/qgis-3.28.0+99sid/src/gui/qgsexternalresourcewidget.cpp