Private::FileLineEdit Class Reference

#include <fspathedit_p.h>

Inheritance diagram for Private::FileLineEdit:

Collaboration diagram for Private::FileLineEdit:

Public Member Functions
	FileLineEdit (QWidget *parent=nullptr)
	~FileLineEdit ()
void	completeDirectoriesOnly (bool completeDirsOnly) override
void	setFilenameFilters (const QStringList &filters) override
void	setBrowseAction (QAction *action) override
void	setValidator (QValidator *validator) override
QString	placeholder () const override
void	setPlaceholder (const QString &val) override
QWidget *	widget () override
Public Member Functions inherited from Private::FileEditorWithCompletion
virtual	~FileEditorWithCompletion ()=default

Protected Member Functions
void	keyPressEvent (QKeyEvent *event) override
void	contextMenuEvent (QContextMenuEvent *event) override

Private Member Functions
void	showCompletionPopup ()

Static Private Member Functions
static QString	warningText (FileSystemPathValidator::TestResult r)

Private Attributes
QFileSystemModel *	m_completerModel
QCompleter *	m_completer
QAction *	m_browseAction
QFileIconProvider	m_iconProvider
QAction *	m_warningAction

Detailed Description

Definition at line 113 of file fspathedit_p.h.

Constructor & Destructor Documentation

FileLineEdit()

Private::FileLineEdit::FileLineEdit

(

QWidget *

parent = nullptr

)

Definition at line 202 of file fspathedit_p.cpp.

    : QLineEdit {parent}
    , m_completerModel {new QFileSystemModel(this)}
    , m_completer {new QCompleter(this)}
    , m_browseAction {nullptr}
    , m_warningAction {nullptr}
{
    m_completerModel->setRootPath("");
    m_completerModel->setIconProvider(&m_iconProvider);
    m_completer->setModel(m_completerModel);
    m_completer->setCompletionMode(QCompleter::PopupCompletion);
    setCompleter(m_completer);
}

References m_completer, m_completerModel, and m_iconProvider.

~FileLineEdit()

Private::FileLineEdit::~FileLineEdit

(

)

Definition at line 216 of file fspathedit_p.cpp.

{
    delete m_completerModel; // has to be deleted before deleting the m_iconProvider object
}

Member Function Documentation

completeDirectoriesOnly()

void Private::FileLineEdit::completeDirectoriesOnly ( bool  completeDirsOnly )

overridevirtual

Implements Private::FileEditorWithCompletion.

Definition at line 221 of file fspathedit_p.cpp.

{
    QDir::Filters filters = completeDirsOnly ? QDir::Dirs : QDir::AllEntries;
    filters |= QDir::NoDotAndDotDot;
    m_completerModel->setFilter(filters);
}

contextMenuEvent()

void Private::FileLineEdit::contextMenuEvent ( QContextMenuEvent *  event )

overrideprotected

Definition at line 297 of file fspathedit_p.cpp.

{
    QMenu *menu = createStandardContextMenu();
    menu->setAttribute(Qt::WA_DeleteOnClose);
 
    if (m_browseAction)
    {
        menu->addSeparator();
        menu->addAction(m_browseAction);
    }
 
    menu->popup(event->globalPos());
}

keyPressEvent()

void Private::FileLineEdit::keyPressEvent ( QKeyEvent *  event )

overrideprotected

Definition at line 258 of file fspathedit_p.cpp.

{
    QLineEdit::keyPressEvent(e);
    if ((e->key() == Qt::Key_Space) && (e->modifiers() == Qt::CTRL))
    {
        m_completerModel->setRootPath(QFileInfo(text()).absoluteDir().absolutePath());
        showCompletionPopup();
    }
 
    auto *validator = qobject_cast<const FileSystemPathValidator *>(this->validator());
    if (validator)
    {
        FileSystemPathValidator::TestResult lastTestResult = validator->lastTestResult();
        QValidator::State lastState = validator->lastValidationState();
        if (lastTestResult == FileSystemPathValidator::TestResult::OK)
        {
            delete m_warningAction;
            m_warningAction = nullptr;
        }
        else
        {
            if (!m_warningAction)
            {
                m_warningAction = new QAction(this);
                addAction(m_warningAction, QLineEdit::TrailingPosition);
            }
        }
 
        if (m_warningAction)
        {
            if (lastState == QValidator::Invalid)
                m_warningAction->setIcon(style()->standardIcon(QStyle::SP_MessageBoxCritical));
            else if (lastState == QValidator::Intermediate)
                m_warningAction->setIcon(style()->standardIcon(QStyle::SP_MessageBoxWarning));
            m_warningAction->setToolTip(warningText(lastTestResult).arg(validator->lastTestedPath()));
        }
    }
}

References nova3.nova2dl::e, and Private::FileSystemPathValidator::OK.

placeholder()

QString Private::FileLineEdit::placeholder ( ) const

overridevirtual

Implements Private::FileEditorWithCompletion.

Definition at line 243 of file fspathedit_p.cpp.

{
    return placeholderText();
}

setBrowseAction()

void Private::FileLineEdit::setBrowseAction ( QAction *  action )

overridevirtual

Implements Private::FileEditorWithCompletion.

Definition at line 233 of file fspathedit_p.cpp.

{
    m_browseAction = action;
}

References tstool::action.

setFilenameFilters()

void Private::FileLineEdit::setFilenameFilters ( const QStringList &  filters )

overridevirtual

Implements Private::FileEditorWithCompletion.

Definition at line 228 of file fspathedit_p.cpp.

{
    m_completerModel->setNameFilters(filters);
}

setPlaceholder()

void Private::FileLineEdit::setPlaceholder ( const QString &  val )

overridevirtual

Implements Private::FileEditorWithCompletion.

Definition at line 248 of file fspathedit_p.cpp.

{
    setPlaceholderText(val);
}

setValidator()

void Private::FileLineEdit::setValidator ( QValidator *  validator )

overridevirtual

Implements Private::FileEditorWithCompletion.

Definition at line 238 of file fspathedit_p.cpp.

{
    QLineEdit::setValidator(validator);
}

showCompletionPopup()

void Private::FileLineEdit::showCompletionPopup ( )

private

Definition at line 311 of file fspathedit_p.cpp.

{
    m_completer->setCompletionPrefix(text());
    m_completer->complete();
}

warningText()

QString Private::FileLineEdit::warningText ( FileSystemPathValidator::TestResult  r )

staticprivate

Definition at line 317 of file fspathedit_p.cpp.

{
    using TestResult = FileSystemPathValidator::TestResult;
    switch (r)
    {
    case TestResult::DoesNotExist:
        return tr("'%1' does not exist");
    case TestResult::NotADir:
        return tr("'%1' does not point to a directory");
    case TestResult::NotAFile:
        return tr("'%1' does not point to a file");
    case TestResult::CantRead:
        return tr("Does not have read permission in '%1'");
    case TestResult::CantWrite:
        return tr("Does not have write permission in '%1'");
    default:
        return {};
    }
}

widget()

QWidget * Private::FileLineEdit::widget ( )

overridevirtual

Implements Private::FileEditorWithCompletion.

Definition at line 253 of file fspathedit_p.cpp.

{
    return this;
}

Member Data Documentation

m_browseAction

QAction* Private::FileLineEdit::m_browseAction

private

Definition at line 140 of file fspathedit_p.h.

m_completer

QCompleter* Private::FileLineEdit::m_completer

private

Definition at line 139 of file fspathedit_p.h.

Referenced by FileLineEdit().

m_completerModel

QFileSystemModel* Private::FileLineEdit::m_completerModel

private

Definition at line 138 of file fspathedit_p.h.

Referenced by FileLineEdit().

m_iconProvider

QFileIconProvider Private::FileLineEdit::m_iconProvider

private

Definition at line 141 of file fspathedit_p.h.

Referenced by FileLineEdit().

m_warningAction

QAction* Private::FileLineEdit::m_warningAction

private

Definition at line 142 of file fspathedit_p.h.

---

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

• src/gui/fspathedit_p.h
• src/gui/fspathedit_p.cpp