qgsnewnamedialog.h

Go to the documentation of this file.

/***************************************************************************
    qgsnewnamedialog.h
                             -------------------
    begin                : May, 2015
    copyright            : (C) 2015 Radim Blazek
    email                : [email protected]
 ***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSNEWNAMEDIALOG_H
#define QGSNEWNAMEDIALOG_H
 
class QLabel;
class QLineEdit;
 
#include "qgis_gui.h"
#include "qgsdialog.h"
 
#include <QRegularExpression>

class GUI_EXPORT QgsNewNameDialog : public QgsDialog
{
    Q_OBJECT
  public:

    QgsNewNameDialog( const QString &source = QString(), const QString &initial = QString(), const QStringList &extensions = QStringList(), const QStringList &existing = QStringList(), Qt::CaseSensitivity cs = Qt::CaseSensitive, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = QgsGuiUtils::ModalDialogFlags );

    void setHintString( const QString &hintString );

    QString hintString() const;

    void setOverwriteEnabled( bool enabled );

    bool overwriteEnabled() const { return mOverwriteEnabled; }

    void setAllowEmptyName( bool allowed );

    bool allowEmptyName() const { return mAllowEmptyName; }

    void setConflictingNameWarning( const QString &string );

    QString conflictingNameWarning() const { return mConflictingNameWarning; }

    void setRegularExpression( const QString &expression );

    void setShowExistingNamesCompleter( bool show );

    QString name() const;

    static bool exists( const QString &name, const QStringList &extensions, const QStringList &existing, Qt::CaseSensitivity cs = Qt::CaseSensitive );
  signals:
 
    // TODO QGIS 4.0 - rename to nameChanged

    void newNameChanged();
 
  public slots:
    // TODO QGIS 4.0 - rename to onNameChanged
    void nameChanged();
 
  protected:
    QStringList mExiting;
    QStringList mExtensions;
    Qt::CaseSensitivity mCaseSensitivity = Qt::CaseSensitive;
    QLabel *mHintLabel = nullptr;
    QLineEdit *mLineEdit = nullptr;
    QLabel *mNamesLabel = nullptr;
    QLabel *mErrorLabel = nullptr;
    QString mOkString;
    QRegularExpression mRegularExpression;
    bool mOverwriteEnabled = true;
    bool mAllowEmptyName = false;
    QString mConflictingNameWarning;
 
    static QString highlightText( const QString &text );
    static QStringList fullNames( const QString &name, const QStringList &extensions );
    // get list of existing names
    static QStringList matching( const QStringList &newNames, const QStringList &existingNames, Qt::CaseSensitivity cs = Qt::CaseSensitive );
};
 
#endif // QGSNEWNAMEDIALOG_H