ResInsight/Fwk/AppFwk/cafUserInterface/cafPdmUiFilePathEditor.h

//##################################################################################################
//
//   Custom Visualization Core library
//   Copyright (C) 2011-2013 Ceetron AS
//
//   This library may be used under the terms of either the GNU General Public License or
//   the GNU Lesser General Public License as follows:
//
//   GNU General Public License Usage
//   This library 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 3 of the License, or
//   (at your option) any later version.
//
//   This library is distributed in the hope that it will be useful, but WITHOUT ANY
//   WARRANTY; without even the implied warranty of MERCHANTABILITY or
//   FITNESS FOR A PARTICULAR PURPOSE.
//
//   See the GNU General Public License at <<http://www.gnu.org/licenses/gpl.html>>
//   for more details.
//
//   GNU Lesser General Public License Usage
//   This library is free software; you can redistribute it and/or modify
//   it under the terms of the GNU Lesser General Public License as published by
//   the Free Software Foundation; either version 2.1 of the License, or
//   (at your option) any later version.
//
//   This library is distributed in the hope that it will be useful, but WITHOUT ANY
//   WARRANTY; without even the implied warranty of MERCHANTABILITY or
//   FITNESS FOR A PARTICULAR PURPOSE.
//
//   See the GNU Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
//   for more details.
//
//##################################################################################################

#pragma once

#include "cafPdmUiFieldLabelEditorHandle.h"

#include <QLabel>
#include <QLineEdit>
#include <QPointer>
#include <QString>
#include <QToolButton>
#include <QWidget>

class QGridLayout;

namespace caf
{
//==================================================================================================
///
//==================================================================================================
class PdmUiFilePathEditorAttribute : public PdmUiEditorAttribute
{
public:
    PdmUiFilePathEditorAttribute()
    {
        m_selectSaveFileName           = false;
        m_fileSelectionFilter          = "All files (*)";
        m_defaultPath                  = QString();
        m_selectDirectory              = false;
        m_appendUiSelectedFolderToText = false;
        m_multipleItemSeparator        = ';';
    }

public:
    bool    m_selectSaveFileName;
    QString m_fileSelectionFilter;

    QString m_defaultPath;
    bool    m_selectDirectory;
    bool    m_appendUiSelectedFolderToText;
    QChar   m_multipleItemSeparator;
};

//==================================================================================================
///
//==================================================================================================
class PdmUiFilePathEditor : public PdmUiFieldLabelEditorHandle
{
    Q_OBJECT
    CAF_PDM_UI_FIELD_EDITOR_HEADER_INIT;

public:
    PdmUiFilePathEditor() {}
    ~PdmUiFilePathEditor() override {}

    // Attribute key constants for compile-time safety and discoverability
    struct Keys
    {
        static inline const QString SELECT_SAVE_FILE_NAME = QStringLiteral( "selectSaveFileName" );
        static inline const QString FILE_SELECTION_FILTER = QStringLiteral( "fileSelectionFilter" );
        static inline const QString DEFAULT_PATH          = QStringLiteral( "defaultPath" );
        static inline const QString SELECT_DIRECTORY      = QStringLiteral( "selectDirectory" );
        static inline const QString APPEND_UI_SELECTED_FOLDER_TO_TEXT =
            QStringLiteral( "appendUiSelectedFolderToText" );
        static inline const QString MULTIPLE_ITEM_SEPARATOR = QStringLiteral( "multipleItemSeparator" );
    };

    // Set of all supported attributes for validation
    inline static const std::set<QString> SUPPORTED_ATTRIBUTES = { Keys::SELECT_SAVE_FILE_NAME,
                                                                   Keys::FILE_SELECTION_FILTER,
                                                                   Keys::DEFAULT_PATH,
                                                                   Keys::SELECT_DIRECTORY,
                                                                   Keys::APPEND_UI_SELECTED_FOLDER_TO_TEXT,
                                                                   Keys::MULTIPLE_ITEM_SEPARATOR };

protected:
    QWidget* createEditorWidget( QWidget* parent ) override;
    void     configureAndUpdateUi( const QString& uiConfigName ) override;

protected slots:
    void slotEditingFinished();
    void fileSelectionClicked();
    void copyToClipboard();

private:
    QPointer<QLineEdit>   m_lineEdit;
    QPointer<QToolButton> m_button;
    QPointer<QToolButton> m_copyToClipboardButton;

    PdmUiFilePathEditorAttribute m_attributes;
};

} // end namespace caf