Abstract base class for a widgets which allows users to select content from a file, embedding a file, etc. More...

#include <qgsfilecontentsourcelineedit.h>

Inheritance diagram for QgsAbstractFileContentSourceLineEdit:

[legend]

Public Slots
void	setSource (const QString &source)
	Sets a new source to show in the widget.

Signals
void	sourceChanged (const QString &source)
	Emitted whenever the file source is changed in the widget.

Public Member Functions
	QgsAbstractFileContentSourceLineEdit (QWidget *parent=nullptr)
	Constructor for QgsAbstractFileContentSourceLineEdit, with the specified parent widget.

QgsMessageBar *	messageBar () const
	Returns the message bar associated with the widget.

QgsPropertyOverrideButton *	propertyOverrideToolButton () const
	Returns the property override tool button.

void	setLastPathSettingsKey (const QString &key)
	Sets a specific settings key to use when storing the last used path for the file source.

void	setMessageBar (QgsMessageBar *bar)
	Sets the message bar associated with the widget.

void	setPropertyOverrideToolButtonVisible (bool visible)
	Sets the visibility of the property override tool button.

QString	source () const
	Returns the current file source.

Properties
QString	source

Detailed Description

Abstract base class for a widgets which allows users to select content from a file, embedding a file, etc.

This class is designed to be used by content which is managed by a QgsAbstractContentCache, i.e. it can handle either direct file paths, base64 encoded contents, or remote HTTP urls.

Since: QGIS 3.6

Definition at line 40 of file qgsfilecontentsourcelineedit.h.

Constructor & Destructor Documentation

◆ QgsAbstractFileContentSourceLineEdit()

QgsAbstractFileContentSourceLineEdit::QgsAbstractFileContentSourceLineEdit ( QWidget * parent = nullptr )

Constructor for QgsAbstractFileContentSourceLineEdit, with the specified parent widget.

Definition at line 37 of file qgsfilecontentsourcelineedit.cpp.

Member Function Documentation

◆ messageBar()

QgsMessageBar * QgsAbstractFileContentSourceLineEdit::messageBar ( ) const

Returns the message bar associated with the widget.

See also: setMessageBar()

Definition at line 284 of file qgsfilecontentsourcelineedit.cpp.

◆ propertyOverrideToolButton()

QgsPropertyOverrideButton * QgsAbstractFileContentSourceLineEdit::propertyOverrideToolButton ( ) const

inline

Returns the property override tool button.

Since: QGIS 3.16

Definition at line 82 of file qgsfilecontentsourcelineedit.h.

◆ setLastPathSettingsKey()

void QgsAbstractFileContentSourceLineEdit::setLastPathSettingsKey ( const QString & key )

Sets a specific settings key to use when storing the last used path for the file source.

Definition at line 106 of file qgsfilecontentsourcelineedit.cpp.

◆ setMessageBar()

void QgsAbstractFileContentSourceLineEdit::setMessageBar ( QgsMessageBar * bar )

Sets the message bar associated with the widget.

This allows the widget to push feedback messages to the appropriate message bar.

See also: messageBar()

Definition at line 279 of file qgsfilecontentsourcelineedit.cpp.

◆ setPropertyOverrideToolButtonVisible()

void QgsAbstractFileContentSourceLineEdit::setPropertyOverrideToolButtonVisible ( bool visible )

Sets the visibility of the property override tool button.

Since: QGIS 3.16

Definition at line 111 of file qgsfilecontentsourcelineedit.cpp.

◆ setSource

void QgsAbstractFileContentSourceLineEdit::setSource ( const QString & source )

slot

Sets a new source to show in the widget.

See also: source(); sourceChanged()

Definition at line 117 of file qgsfilecontentsourcelineedit.cpp.

◆ source()

QString QgsAbstractFileContentSourceLineEdit::source ( ) const

Returns the current file source.

See also: setSource(); sourceChanged()

Definition at line 92 of file qgsfilecontentsourcelineedit.cpp.

◆ sourceChanged

void QgsAbstractFileContentSourceLineEdit::sourceChanged ( const QString & source )

signal

Emitted whenever the file source is changed in the widget.

Property Documentation

◆ source

QString QgsAbstractFileContentSourceLineEdit::source

readwrite

Definition at line 43 of file qgsfilecontentsourcelineedit.h.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/qgsfilecontentsourcelineedit.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/qgsfilecontentsourcelineedit.cpp

Public Slots

Signals

Public Member Functions

Properties