ResInsight/Fwk/AppFwk/cafUserInterface/cafPdmUiLineEditor.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 "cafPdmOptionItemInfo.h"
#include "cafPdmUiFieldLabelEditorHandle.h"

#include <QHBoxLayout>
#include <QLabel>
#include <QLineEdit>
#include <QPointer>
#include <QString>
#include <QStringListModel>
#include <QToolButton>
#include <QValidator>
#include <QWidget>

class QGridLayout;
class QCompleter;

namespace caf
{
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
class PdmUiLineEditorAttribute : public PdmUiEditorAttribute
{
public:
    PdmUiLineEditorAttribute()
    {
        avoidSendingEnterEventToParentWidget = false;
        completerCaseSensitivity             = Qt::CaseInsensitive;
        completerFilterMode                  = Qt::MatchContains;
        maximumWidth                         = -1;
        selectAllOnFocusEvent                = false;
        placeholderText                      = "";
        notifyWhenTextIsEdited               = false;
    }

public:
    bool                 avoidSendingEnterEventToParentWidget;
    QPointer<QValidator> validator;

    // Completer setup
    Qt::CaseSensitivity completerCaseSensitivity;
    Qt::MatchFlags      completerFilterMode;
    int                 maximumWidth;
    bool                selectAllOnFocusEvent;
    QString             placeholderText;
    bool                notifyWhenTextIsEdited;
};

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
class PdmUiLineEditorAttributeUiDisplayString : public PdmUiEditorAttribute
{
public:
    PdmUiLineEditorAttributeUiDisplayString() {}

public:
    QString m_displayString;
};

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
class PdmUiLineEdit : public QLineEdit
{
    Q_OBJECT
public:
    PdmUiLineEdit( QWidget* parent, bool avoidSendingEnterEvent );
    void setAvoidSendingEnterEventToParentWidget( bool avoidSendingEnter );

protected:
    void keyPressEvent( QKeyEvent* event ) override;

private:
    bool m_avoidSendingEnterEvent;
};

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
class PdmUiLineEditor : public PdmUiFieldLabelEditorHandle
{
    Q_OBJECT
    CAF_PDM_UI_FIELD_EDITOR_HEADER_INIT;

public:
    PdmUiLineEditor()
        : m_ignoreCompleterActivated( false )
    {
    }
    ~PdmUiLineEditor() override {}

    // Attribute key constants for compile-time safety and discoverability
    struct Keys
    {
        static inline const QString MAXIMUM_WIDTH              = QStringLiteral( "maximumWidth" );
        static inline const QString SELECT_ALL_ON_FOCUS_EVENT  = QStringLiteral( "selectAllOnFocusEvent" );
        static inline const QString PLACEHOLDER_TEXT           = QStringLiteral( "placeholderText" );
        static inline const QString AVOID_SENDING_ENTER_EVENT  = QStringLiteral( "avoidSendingEnterEvent" );
        static inline const QString COMPLETER_CASE_SENSITIVITY = QStringLiteral( "completerCaseSensitivity" );
        static inline const QString COMPLETER_FILTER_MODE      = QStringLiteral( "completerFilterMode" );
        static inline const QString NOTIFY_WHEN_TEXT_IS_EDITED = QStringLiteral( "notifyWhenTextIsEdited" );
    };

    // Set of all supported attributes for validation
    inline static const std::set<QString> SUPPORTED_ATTRIBUTES = { Keys::MAXIMUM_WIDTH,
                                                                   Keys::SELECT_ALL_ON_FOCUS_EVENT,
                                                                   Keys::PLACEHOLDER_TEXT,
                                                                   Keys::AVOID_SENDING_ENTER_EVENT,
                                                                   Keys::COMPLETER_CASE_SENSITIVITY,
                                                                   Keys::COMPLETER_FILTER_MODE,
                                                                   Keys::NOTIFY_WHEN_TEXT_IS_EDITED };

    static void updateLineEditFromReadOnlyState( QLineEdit* lineEdit, bool isReadOnly );

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

    bool eventFilter( QObject* watched, QEvent* event ) override;

protected slots:
    void slotEditingFinished();
    void slotCompleterActivated( const QModelIndex& index );
    void slotApplyAutoValue();

private:
    bool isMultipleFieldsWithSameKeywordSelected( PdmFieldHandle* editorField ) const;

protected:
    QPointer<PdmUiLineEdit> m_lineEdit;

    QPointer<QToolButton> m_autoValueToolButton;

    QPointer<QHBoxLayout> m_layout;
    QPointer<QWidget>     m_placeholder;

    QPointer<QCompleter>       m_completer;
    QPointer<QStringListModel> m_completerTextList;
    QList<PdmOptionItemInfo>   m_optionCache;
    bool                       m_ignoreCompleterActivated;

    int findIndexToOption( const QString& uiText );
};

} // end namespace caf