QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Types | Public Member Functions | Protected Member Functions | List of all members
QgsPictureSourceLineEditBase Class Reference

A line edit widget with toolbutton for setting a raster image path. More...

#include <qgsfilecontentsourcelineedit.h>

Inheritance diagram for QgsPictureSourceLineEditBase:
Inheritance graph
[legend]

Public Types

enum  Format { Svg , Image , AnimatedImage }
 Format of source image. More...
 

Public Member Functions

 QgsPictureSourceLineEditBase (QWidget *parent=nullptr)
 Constructor for QgsImageSourceLineEdit, with the specified parent widget. More...
 
void setMode (Format format)
 Defines the mode of the source line edit. More...
 
- Public Member Functions inherited from QgsAbstractFileContentSourceLineEdit
 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...
 

Protected Member Functions

 QgsPictureSourceLineEditBase (Format format, QWidget *parent=nullptr)
 Constructor for QgsImageSourceLineEdit, with the specified parent widget. More...
 

Additional Inherited Members

- Public Slots inherited from QgsAbstractFileContentSourceLineEdit
void setSource (const QString &source)
 Sets a new source to show in the widget. More...
 
- Signals inherited from QgsAbstractFileContentSourceLineEdit
void sourceChanged (const QString &source)
 Emitted whenever the file source is changed in the widget. More...
 
- Properties inherited from QgsAbstractFileContentSourceLineEdit
QString source
 

Detailed Description

A line edit widget with toolbutton for setting a raster image path.

See also
QgsSvgSourceLineEdit
Since
QGIS 3.20

Definition at line 190 of file qgsfilecontentsourcelineedit.h.

Member Enumeration Documentation

◆ Format

Format of source image.

Enumerator
Svg 

SVG image.

Image 

Raster image.

AnimatedImage 

Animated image (since QGIS 3.26)

Definition at line 198 of file qgsfilecontentsourcelineedit.h.

Constructor & Destructor Documentation

◆ QgsPictureSourceLineEditBase() [1/2]

QgsPictureSourceLineEditBase::QgsPictureSourceLineEditBase ( QWidget *  parent = nullptr)
inline

Constructor for QgsImageSourceLineEdit, with the specified parent widget.

The default format is SVG.

Definition at line 209 of file qgsfilecontentsourcelineedit.h.

◆ QgsPictureSourceLineEditBase() [2/2]

QgsPictureSourceLineEditBase::QgsPictureSourceLineEditBase ( Format  format,
QWidget *  parent = nullptr 
)
inlineprotected

Constructor for QgsImageSourceLineEdit, with the specified parent widget.

Definition at line 221 of file qgsfilecontentsourcelineedit.h.

Member Function Documentation

◆ setMode()

void QgsPictureSourceLineEditBase::setMode ( Format  format)
inline

Defines the mode of the source line edit.

Definition at line 214 of file qgsfilecontentsourcelineedit.h.


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