KisFileNameRequester Class Reference

#include <kis_file_name_requester.h>

Inheritance diagram for KisFileNameRequester:

Public Slots
void	setFileName (const QString &path)
void	slotSelectFile ()

Signals
void	fileSelected (const QString &fileName)
void	textChanged (const QString &fileName)

Public Member Functions
QString	fileName () const
	KisFileNameRequester (QWidget *parent=0)
KoFileDialog::DialogType	mode () const
void	setConfigurationName (const QString &name)
	Set the name used to store the last-used directory in the settings.
void	setMimeTypeFilters (const QStringList &filterList, QString defaultFilter=QString())
void	setMode (KoFileDialog::DialogType mode)
void	setReadOnlyText (bool readonly)
void	setStartDir (const QString &path)
void	setValidator (QValidator *validator)
	~KisFileNameRequester () override

Private Attributes
QString	m_basePath
QString	m_mime_default_filter
QStringList	m_mime_filter_list
KoFileDialog::DialogType	m_mode
QString	m_name
QScopedPointer< Ui::WdgFileNameRequester >	m_ui

Detailed Description

This represents an editable file name. Visual it presents a QLineEdit + a button that pops up a file chooser.

Signals are fired when the user changes the text or selects a new file via the button/file chooser.

Definition at line 31 of file kis_file_name_requester.h.

Constructor & Destructor Documentation

KisFileNameRequester()

KisFileNameRequester::KisFileNameRequester ( QWidget * parent = 0 )

explicit

Definition at line 16 of file kis_file_name_requester.cpp.

    : QWidget(parent)
    , m_ui(new Ui::WdgFileNameRequester)
    , m_mode(KoFileDialog::OpenFile)
    , m_name("OpenDocument")
{
    m_ui->setupUi(this);
 
    m_ui->btnSelectFile->setIcon(kisIcon("folder"));
 
    connect(m_ui->btnSelectFile, SIGNAL(clicked()), SLOT(slotSelectFile()));
    connect(m_ui->txtFileName, SIGNAL(textChanged(QString)), SIGNAL(textChanged(QString)));
}

References connect(), kisIcon, m_ui, slotSelectFile(), and textChanged().

~KisFileNameRequester()

KisFileNameRequester::~KisFileNameRequester ( )

override

Definition at line 30 of file kis_file_name_requester.cpp.

{
}

Member Function Documentation

fileName()

QString KisFileNameRequester::fileName

(

)

const

Definition at line 50 of file kis_file_name_requester.cpp.

{
    return m_ui->txtFileName->text();
}

References m_ui.

fileSelected

void KisFileNameRequester::fileSelected ( const QString & fileName )

signal

mode()

KoFileDialog::DialogType KisFileNameRequester::mode

(

)

const

Definition at line 60 of file kis_file_name_requester.cpp.

{
    return m_mode;
}

References m_mode.

setConfigurationName()

void KisFileNameRequester::setConfigurationName

(

const QString &

name

)

Set the name used to store the last-used directory in the settings.

Definition at line 39 of file kis_file_name_requester.cpp.

{
    m_name = name;
}

References m_name.

setFileName

void KisFileNameRequester::setFileName ( const QString & path )

slot

Definition at line 44 of file kis_file_name_requester.cpp.

{
    m_ui->txtFileName->setText(path);
    Q_EMIT fileSelected(path);
}

References fileSelected(), and m_ui.

setMimeTypeFilters()

void KisFileNameRequester::setMimeTypeFilters	(	const QStringList &	filterList,
		QString	defaultFilter = QString() )

Sets the mime type filters to use, same format as KoFileDialog::setMimeTypeFilters. If this is not called, the default list is used, which simply selects all the image file formats Krita can load.

Definition at line 70 of file kis_file_name_requester.cpp.

{
    m_mime_filter_list = filterList;
    m_mime_default_filter = defaultFilter;
}

References m_mime_default_filter, and m_mime_filter_list.

setMode()

void KisFileNameRequester::setMode

(

KoFileDialog::DialogType

mode

)

Definition at line 55 of file kis_file_name_requester.cpp.

{
    m_mode = mode;
}

References m_mode, and mode().

setReadOnlyText()

void KisFileNameRequester::setReadOnlyText

(

bool

readonly

)

Definition at line 65 of file kis_file_name_requester.cpp.

{
    m_ui->txtFileName->setReadOnly(readonly);
}

References m_ui.

setStartDir()

void KisFileNameRequester::setStartDir

(

const QString &

path

)

Definition at line 34 of file kis_file_name_requester.cpp.

{
    m_basePath = path;
}

References m_basePath.

setValidator()

void KisFileNameRequester::setValidator

(

QValidator *

validator

)

Definition at line 76 of file kis_file_name_requester.cpp.

{
    m_ui->txtFileName->setValidator(validator);
}

References m_ui.

slotSelectFile

void KisFileNameRequester::slotSelectFile ( )

slot

Definition at line 81 of file kis_file_name_requester.cpp.

{
    KoFileDialog dialog(this, m_mode, m_name);
    if (m_mode == KoFileDialog::OpenFile)
    {
        dialog.setCaption(i18n("Select a file to load..."));
    }
    else if (m_mode == KoFileDialog::OpenDirectory)
    {
        dialog.setCaption(i18n("Select a directory to load..."));
    }
 
    const QString basePath =
        KritaUtils::resolveAbsoluteFilePath(QStandardPaths::writableLocation(QStandardPaths::PicturesLocation),
                                            m_basePath);
 
    const QString filePath =
        KritaUtils::resolveAbsoluteFilePath(basePath, m_ui->txtFileName->text());
 
    dialog.setDefaultDir(filePath, true);
    dialog.setMimeTypeFilters(m_mime_filter_list, m_mime_default_filter);
 
    QString newFileName = dialog.filename();
 
    if (!newFileName.isEmpty()) {
        setFileName(newFileName);
    }
}

References m_basePath, m_mime_default_filter, m_mime_filter_list, m_mode, m_name, m_ui, KoFileDialog::OpenDirectory, KoFileDialog::OpenFile, KritaUtils::resolveAbsoluteFilePath(), and setFileName().

textChanged

void KisFileNameRequester::textChanged ( const QString & fileName )

signal

Member Data Documentation

m_basePath

QString KisFileNameRequester::m_basePath

private

Definition at line 68 of file kis_file_name_requester.h.

m_mime_default_filter

QString KisFileNameRequester::m_mime_default_filter

private

Definition at line 71 of file kis_file_name_requester.h.

m_mime_filter_list

QStringList KisFileNameRequester::m_mime_filter_list

private

Definition at line 70 of file kis_file_name_requester.h.

m_mode

KoFileDialog::DialogType KisFileNameRequester::m_mode

private

Definition at line 69 of file kis_file_name_requester.h.

m_name

QString KisFileNameRequester::m_name

private

Definition at line 72 of file kis_file_name_requester.h.

m_ui

QScopedPointer<Ui::WdgFileNameRequester> KisFileNameRequester::m_ui

private

Definition at line 67 of file kis_file_name_requester.h.

---

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

• libs/widgets/kis_file_name_requester.h
• libs/widgets/kis_file_name_requester.cpp