QGIS API Documentation  2.99.0-Master (6a61179)
Public Member Functions | Protected Member Functions | List of all members
QgsFileDropEdit Class Reference

A line edit for capturing file names that can have files dropped onto it via drag & drop. More...

#include <qgsfiledropedit.h>

Inheritance diagram for QgsFileDropEdit:
Inheritance graph

Public Member Functions

 QgsFileDropEdit (QWidget *parent=nullptr)
virtual ~QgsFileDropEdit ()
bool isDirOnly () const
bool isFileOnly () const
void setDirOnly (bool isDirOnly)
void setFileOnly (bool isFileOnly)
void setSuffixFilter (const QString &suffix)
QString suffixFilter () const

Protected Member Functions

virtual void dragEnterEvent (QDragEnterEvent *event) override
virtual void dragLeaveEvent (QDragLeaveEvent *event) override
virtual void dropEvent (QDropEvent *event) override
virtual void paintEvent (QPaintEvent *e) override

Detailed Description

A line edit for capturing file names that can have files dropped onto it via drag & drop.

The QgsDropNameEdit class provides a line edit widget which accepts file drops.

Dropping can be limited to files only, files with a specific extension or directories only. By default, dropping is limited to files only.

Definition at line 24 of file qgsfiledropedit.h.

Constructor & Destructor Documentation

§ QgsFileDropEdit()

QgsFileDropEdit::QgsFileDropEdit ( QWidget *  parent = nullptr)

Definition at line 33 of file qgsfiledropedit.cpp.

§ ~QgsFileDropEdit()

QgsFileDropEdit::~QgsFileDropEdit ( )

Definition at line 42 of file qgsfiledropedit.cpp.

Member Function Documentation

§ dragEnterEvent()

void QgsFileDropEdit::dragEnterEvent ( QDragEnterEvent *  event)

Check if dragged object is acceptible. Called when a drag is in progress and the mouse enters this widget.

Definition at line 98 of file qgsfiledropedit.cpp.

§ dragLeaveEvent()

void QgsFileDropEdit::dragLeaveEvent ( QDragLeaveEvent *  event)

Called when a drag is in progress and the mouse leaves this widget.

Definition at line 116 of file qgsfiledropedit.cpp.

§ dropEvent()

void QgsFileDropEdit::dropEvent ( QDropEvent *  event)

Receive the dragged object. Called when the drag is dropped on this widget.

Definition at line 127 of file qgsfiledropedit.cpp.

§ isDirOnly()

bool QgsFileDropEdit::isDirOnly ( ) const

Definition at line 32 of file qgsfiledropedit.h.

§ isFileOnly()

bool QgsFileDropEdit::isFileOnly ( ) const

Definition at line 35 of file qgsfiledropedit.h.

§ paintEvent()

void QgsFileDropEdit::paintEvent ( QPaintEvent *  e)

Paints line edit with drag highlight in response to a paint event.

Definition at line 148 of file qgsfiledropedit.cpp.

§ setDirOnly()

void QgsFileDropEdit::setDirOnly ( bool  isDirOnly)

Limit drops to directories.

Definition at line 48 of file qgsfiledropedit.cpp.

§ setFileOnly()

void QgsFileDropEdit::setFileOnly ( bool  isFileOnly)

Limit drops to files.

Definition at line 60 of file qgsfiledropedit.cpp.

§ setSuffixFilter()

void QgsFileDropEdit::setSuffixFilter ( const QString &  suffix)

Limit drops to files with specified extension.

Definition at line 72 of file qgsfiledropedit.cpp.

§ suffixFilter()

QString QgsFileDropEdit::suffixFilter ( ) const

Definition at line 38 of file qgsfiledropedit.h.

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