ResInsight/Fwk/AppFwk/cafUserInterface/cafPdmUiFilePathEditor.cpp

//##################################################################################################
//
//   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.
//
//##################################################################################################

#include "cafPdmUiFilePathEditor.h"

#include "cafFactory.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"
#include "cafPdmUiDefaultObjectEditor.h"
#include "cafPdmUiFieldEditorHandle.h"
#include "cafPdmUiLineEditor.h"
#include "cafPdmUiOrdering.h"
#include "cafQShortenedLabel.h"

#include <QBoxLayout>
#include <QDir>
#include <QFileDialog>
#include <QIntValidator>
#include <QLabel>
#include <QLineEdit>

namespace caf
{
CAF_PDM_UI_FIELD_EDITOR_SOURCE_INIT( PdmUiFilePathEditor );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiFilePathEditor::configureAndUpdateUi( const QString& uiConfigName )
{
    CAF_ASSERT( !m_lineEdit.isNull() );
    CAF_ASSERT( !m_label.isNull() );

    PdmUiFieldEditorHandle::updateLabelFromField( m_label, uiConfigName );

    PdmUiLineEditor::updateLineEditFromReadOnlyState( m_lineEdit, uiField()->isUiReadOnly( uiConfigName ) );

    m_lineEdit->setToolTip( uiField()->uiToolTip( uiConfigName ) );
    m_button->setEnabled( !uiField()->isUiReadOnly( uiConfigName ) );

    caf::PdmUiObjectHandle* uiObject = uiObj( uiField()->fieldHandle()->ownerObject() );
    if ( uiObject )
    {
        uiObject->editorAttribute( uiField()->fieldHandle(), uiConfigName, &m_attributes );
    }

    m_lineEdit->setText( uiField()->uiValue().toString() );

    if ( m_attributes.m_appendUiSelectedFolderToText )
    {
        m_label->setToolTip( "Define multiple directories separated by ';'" );
        m_button->setText( QLatin1String( "Append" ) );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QWidget* PdmUiFilePathEditor::createEditorWidget( QWidget* parent )
{
    QWidget* placeholder = new QWidget( parent );

    QHBoxLayout* layout = new QHBoxLayout( placeholder );
    layout->setContentsMargins( 0, 0, 0, 0 );
    layout->setSpacing( 0 );

    m_lineEdit = new QLineEdit( parent );
    m_button   = new QToolButton( parent );
    m_button->setSizePolicy( QSizePolicy( QSizePolicy::Fixed, QSizePolicy::Preferred ) );
    m_button->setText( QLatin1String( "..." ) );

    layout->addWidget( m_lineEdit );
    layout->addWidget( m_button );

    connect( m_button, SIGNAL( clicked() ), this, SLOT( fileSelectionClicked() ) );
    connect( m_lineEdit, SIGNAL( editingFinished() ), this, SLOT( slotEditingFinished() ) );

    return placeholder;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QWidget* PdmUiFilePathEditor::createLabelWidget( QWidget* parent )
{
    m_label = new QShortenedLabel( parent );
    return m_label;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiFilePathEditor::slotEditingFinished()
{
    QVariant v;
    QString  textValue = m_lineEdit->text();
    v                  = textValue;
    this->setValueToField( v );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiFilePathEditor::fileSelectionClicked()
{
    QString defaultPath;
    if ( m_lineEdit->text().isEmpty() )
    {
        if ( m_attributes.m_defaultPath.isNull() )
        {
            defaultPath = QDir::homePath();
        }
        else
        {
            defaultPath = m_attributes.m_defaultPath;
        }
    }
    else
    {
        defaultPath = m_lineEdit->text();
    }

    QFileDialog::Options fileDialogOptions;
#ifndef WIN32
    fileDialogOptions = QFileDialog::DontUseNativeDialog;
#endif

    if ( m_attributes.m_selectDirectory )
    {
        auto folderOptions = fileDialogOptions | QFileDialog::ShowDirsOnly | QFileDialog::DontResolveSymlinks;

        QString directoryPath =
            QFileDialog::getExistingDirectory( m_lineEdit, tr( "Get existing directory" ), defaultPath, folderOptions );

        if ( !directoryPath.isEmpty() )
        {
            QString filePathString;
            if ( m_attributes.m_appendUiSelectedFolderToText )
            {
                filePathString = m_lineEdit->text();
                if ( !filePathString.isEmpty() &&
                     !filePathString.endsWith( m_attributes.m_multipleItemSeparator, Qt::CaseInsensitive ) )
                {
                    filePathString += m_attributes.m_multipleItemSeparator;
                }
                filePathString += directoryPath;
            }
            else
            {
                filePathString = directoryPath;
            }

            m_lineEdit->setText( filePathString );
            slotEditingFinished();
        }
    }
    else
    {
        QString filePath;
        if ( m_attributes.m_selectSaveFileName )
        {
            filePath = QFileDialog::getSaveFileName( m_lineEdit,
                                                     tr( "Save File" ),
                                                     defaultPath,
                                                     m_attributes.m_fileSelectionFilter,
                                                     nullptr,
                                                     fileDialogOptions );
        }
        else
        {
            filePath = QFileDialog::getOpenFileName( m_lineEdit,
                                                     tr( "Choose a file" ),
                                                     defaultPath,
                                                     m_attributes.m_fileSelectionFilter,
                                                     nullptr,
                                                     fileDialogOptions );
        }

        if ( !filePath.isEmpty() )
        {
            m_lineEdit->setText( filePath );
            slotEditingFinished();
        }
    }
}

} // end namespace caf