QGIS API Documentation  3.17.0-Master (df2c9ff931)
Public Slots | Signals | Public Member Functions | Properties | List of all members
QgsAbstractFileContentSourceLineEdit Class Reference

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:
Inheritance graph
[legend]

Public Slots

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

Signals

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

Public Member Functions

 QgsAbstractFileContentSourceLineEdit (QWidget *parent=nullptr)
 Constructor for QgsAbstractFileContentSourceLineEdit, with the specified parent widget. More...
 
QgsMessageBarmessageBar () const
 Returns the message bar associated with the widget. More...
 
QgsPropertyOverrideButtonpropertyOverrideToolButton () const
 Returns the property override tool button. More...
 
void setLastPathSettingsKey (const QString &key)
 Sets a specific settings key to use when storing the last used path for the file source. More...
 
void setMessageBar (QgsMessageBar *bar)
 Sets the message bar associated with the widget. More...
 
void setPropertyOverrideToolButtonVisible (bool visible)
 Sets the visibility of the property override tool button. More...
 
QString source () const
 Returns the current file source. More...
 

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 32 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 361 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 101 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 356 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 106 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 112 of file qgsfilecontentsourcelineedit.cpp.

◆ source()

QString QgsAbstractFileContentSourceLineEdit::source ( ) const

Returns the current file source.

See also
setSource()
sourceChanged()

◆ 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: