blob: e4098284a70295d47115671a36d329751d2c40a1 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Designer of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists for the convenience
// of Qt Designer. This header
// file may change from version to version without notice, or even be removed.
//
// We mean it.
//
#ifndef TEXTPROPERTYEDITOR_H
#define TEXTPROPERTYEDITOR_H
#include "shared_global_p.h"
#include "shared_enums_p.h"
#include <QtGui/QWidget>
QT_BEGIN_NAMESPACE
namespace qdesigner_internal {
class PropertyLineEdit;
// Inline-Editor for text properties. Does escaping of newline characters
// to '\n' and back and provides validation modes. The interface
// corresponds to that of QLineEdit.
class QDESIGNER_SHARED_EXPORT TextPropertyEditor : public QWidget
{
TextPropertyEditor(const TextPropertyEditor &);
TextPropertyEditor& operator=(const TextPropertyEditor &);
Q_OBJECT
Q_PROPERTY(QString text READ text WRITE setText USER true)
public:
enum EmbeddingMode {
// Stand-alone widget
EmbeddingNone,
// Disable frame
EmbeddingTreeView,
// For editing in forms
EmbeddingInPlace
};
enum UpdateMode {
// Emit textChanged() as the user types
UpdateAsYouType,
// Emit textChanged() only when the user finishes (for QUrl, etc.)
UpdateOnFinished
};
explicit TextPropertyEditor(QWidget *parent = 0, EmbeddingMode embeddingMode = EmbeddingNone, TextPropertyValidationMode validationMode = ValidationMultiLine);
TextPropertyValidationMode textPropertyValidationMode() const { return m_validationMode; }
void setTextPropertyValidationMode(TextPropertyValidationMode vm);
UpdateMode updateMode() const { return m_updateMode; }
void setUpdateMode(UpdateMode um) { m_updateMode = um; }
QString text() const;
virtual QSize sizeHint () const;
virtual QSize minimumSizeHint () const;
void setAlignment(Qt::Alignment alignment);
bool hasAcceptableInput() const;
// installs an event filter object on the private QLineEdit
void installEventFilter(QObject *filterObject);
// Replace newline characters by literal "\n" for inline editing
// in mode ValidationMultiLine
static QString stringToEditorString(const QString &s, TextPropertyValidationMode validationMode = ValidationMultiLine);
// Replace literal "\n" by actual new lines in mode ValidationMultiLine
static QString editorStringToString(const QString &s, TextPropertyValidationMode validationMode = ValidationMultiLine);
// Returns whether newline characters are valid in validationMode.
static bool multiLine(TextPropertyValidationMode validationMode);
signals:
void textChanged(const QString &text);
void editingFinished();
public slots:
void setText(const QString &text);
void selectAll();
void clear();
protected:
void resizeEvent(QResizeEvent * event );
private slots:
void slotTextChanged(const QString &text);
void slotTextEdited();
void slotEditingFinished();
private:
void setRegExpValidator(const QString &pattern);
void markIntermediateState();
TextPropertyValidationMode m_validationMode;
UpdateMode m_updateMode;
PropertyLineEdit* m_lineEdit;
// Cached text containing real newline characters.
QString m_cachedText;
bool m_textEdited;
};
}
QT_END_NAMESPACE
#endif // TEXTPROPERTYEDITOR_H