ground/gcs/src/libs/utils/fancylineedit.cpp

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       fancylineedit.cpp
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  *             Parts by Nokia Corporation (qt-info@nokia.com) Copyright (C) 2009.
   7  * @brief
   8  * @see        The GNU Public License (GPL) Version 3
   9  * @defgroup
  10  * @{
  11  *
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28
  29 #include "fancylineedit.h"
  30
  31 #include <QtCore/QEvent>
  32 #include <QtCore/QDebug>
  33 #include <QtCore/QString>
  34 #include <QtWidgets/QApplication>
  35 #include <QMenu>
  36 #include <QMouseEvent>
  37 #include <QLabel>
  38
  39 enum { margin = 6 };
  40
  41 namespace Utils {
  42 static inline QString sideToStyleSheetString(FancyLineEdit::Side side)
  43 {
  44     return side == FancyLineEdit::Left ? QLatin1String("left") : QLatin1String("right");
  45 }
  46
  47 // Format style sheet for the label containing the pixmap. It has a margin on
  48 // the outer side of the whole FancyLineEdit.
  49 static QString labelStyleSheet(FancyLineEdit::Side side)
  50 {
  51     QString rc = QLatin1String("QLabel { margin-");
  52
  53     rc += sideToStyleSheetString(side);
  54     rc += QLatin1String(": ");
  55     rc += QString::number(margin);
  56     rc += QLatin1Char('}');
  57     return rc;
  58 }
  59
  60 // --------- FancyLineEditPrivate as QObject with label
  61 // event filter
  62
  63 class FancyLineEditPrivate : public QObject {
  64 public:
  65     explicit FancyLineEditPrivate(QLineEdit *parent);
  66
  67     virtual bool eventFilter(QObject *obj, QEvent *event);
  68
  69     const QString m_leftLabelStyleSheet;
  70     const QString m_rightLabelStyleSheet;
  71
  72     QLineEdit *m_lineEdit;
  73     QPixmap m_pixmap;
  74     QMenu *m_menu;
  75     QLabel *m_menuLabel;
  76     FancyLineEdit::Side m_side;
  77     bool m_useLayoutDirection;
  78     bool m_menuTabFocusTrigger;
  79     QString m_hintText;
  80     bool m_showingHintText;
  81 };
  82
  83
  84 FancyLineEditPrivate::FancyLineEditPrivate(QLineEdit *parent) :
  85     QObject(parent),
  86     m_leftLabelStyleSheet(labelStyleSheet(FancyLineEdit::Left)),
  87     m_rightLabelStyleSheet(labelStyleSheet(FancyLineEdit::Right)),
  88     m_lineEdit(parent),
  89     m_menu(0),
  90     m_menuLabel(0),
  91     m_side(FancyLineEdit::Left),
  92     m_useLayoutDirection(false),
  93     m_menuTabFocusTrigger(false),
  94     m_showingHintText(false)
  95 {}
  96
  97 bool FancyLineEditPrivate::eventFilter(QObject *obj, QEvent *event)
  98 {
  99     if (!m_menu || obj != m_menuLabel) {
 100         return QObject::eventFilter(obj, event);
 101     }
 102
 103     switch (event->type()) {
 104     case QEvent::MouseButtonPress:
 105     {
 106         const QMouseEvent *me = static_cast<QMouseEvent *>(event);
 107         m_menu->exec(me->globalPos());
 108         return true;
 109     }
 110     case QEvent::FocusIn:
 111         if (m_menuTabFocusTrigger) {
 112             m_lineEdit->setFocus();
 113             m_menu->exec(m_menuLabel->mapToGlobal(m_menuLabel->rect().center()));
 114             return true;
 115         }
 116     default:
 117         break;
 118     }
 119     return QObject::eventFilter(obj, event);
 120 }
 121
 122 // --------- FancyLineEdit
 123 FancyLineEdit::FancyLineEdit(QWidget *parent) :
 124     QLineEdit(parent),
 125     m_d(new FancyLineEditPrivate(this))
 126 {
 127     m_d->m_menuLabel = new QLabel(this);
 128     m_d->m_menuLabel->installEventFilter(m_d);
 129     updateMenuLabel();
 130     showHintText();
 131 }
 132
 133 FancyLineEdit::~FancyLineEdit()
 134 {}
 135
 136 // Position the menu label left or right according to size.
 137 // Called when switching side and from resizeEvent.
 138 void FancyLineEdit::positionMenuLabel()
 139 {
 140     switch (side()) {
 141     case Left:
 142         m_d->m_menuLabel->setGeometry(0, 0, m_d->m_pixmap.width() + margin, height());
 143         break;
 144     case Right:
 145         m_d->m_menuLabel->setGeometry(width() - m_d->m_pixmap.width() - margin, 0,
 146                                       m_d->m_pixmap.width() + margin, height());
 147         break;
 148     }
 149 }
 150
 151 void FancyLineEdit::updateStyleSheet(Side side)
 152 {
 153     // Udate the LineEdit style sheet. Make room for the label on the
 154     // respective side and set color according to whether we are showing the
 155     // hint text
 156     QString sheet = QLatin1String("QLineEdit{ padding-");
 157
 158     sheet += sideToStyleSheetString(side);
 159     sheet += QLatin1String(": ");
 160     sheet += QString::number(m_d->m_pixmap.width() + margin);
 161     sheet += QLatin1Char(';');
 162     if (m_d->m_showingHintText) {
 163         sheet += QLatin1String(" color: #BBBBBB;");
 164     }
 165     sheet += QLatin1Char('}');
 166     setStyleSheet(sheet);
 167 }
 168
 169 void FancyLineEdit::updateMenuLabel()
 170 {
 171     m_d->m_menuLabel->setPixmap(m_d->m_pixmap);
 172     const Side s = side();
 173     switch (s) {
 174     case Left:
 175         m_d->m_menuLabel->setAlignment(Qt::AlignVCenter | Qt::AlignLeft);
 176         m_d->m_menuLabel->setStyleSheet(m_d->m_leftLabelStyleSheet);
 177         break;
 178     case Right:
 179         m_d->m_menuLabel->setAlignment(Qt::AlignVCenter | Qt::AlignRight);
 180         m_d->m_menuLabel->setStyleSheet(m_d->m_rightLabelStyleSheet);
 181         break;
 182     }
 183     updateStyleSheet(s);
 184     positionMenuLabel();
 185 }
 186
 187 void FancyLineEdit::setSide(Side side)
 188 {
 189     m_d->m_side = side;
 190     updateMenuLabel();
 191 }
 192
 193 FancyLineEdit::Side FancyLineEdit::side() const
 194 {
 195     if (m_d->m_useLayoutDirection) {
 196         return qApp->layoutDirection() == Qt::LeftToRight ? Left : Right;
 197     }
 198     return m_d->m_side;
 199 }
 200
 201 void FancyLineEdit::resizeEvent(QResizeEvent *)
 202 {
 203     positionMenuLabel();
 204 }
 205
 206 void FancyLineEdit::setPixmap(const QPixmap &pixmap)
 207 {
 208     m_d->m_pixmap = pixmap;
 209     updateMenuLabel();
 210 }
 211
 212 QPixmap FancyLineEdit::pixmap() const
 213 {
 214     return m_d->m_pixmap;
 215 }
 216
 217 void FancyLineEdit::setMenu(QMenu *menu)
 218 {
 219     m_d->m_menu = menu;
 220 }
 221
 222 QMenu *FancyLineEdit::menu() const
 223 {
 224     return m_d->m_menu;
 225 }
 226
 227 bool FancyLineEdit::useLayoutDirection() const
 228 {
 229     return m_d->m_useLayoutDirection;
 230 }
 231
 232 void FancyLineEdit::setUseLayoutDirection(bool v)
 233 {
 234     m_d->m_useLayoutDirection = v;
 235 }
 236
 237 bool FancyLineEdit::isSideStored() const
 238 {
 239     return !m_d->m_useLayoutDirection;
 240 }
 241
 242 bool FancyLineEdit::hasMenuTabFocusTrigger() const
 243 {
 244     return m_d->m_menuTabFocusTrigger;
 245 }
 246
 247 void FancyLineEdit::setMenuTabFocusTrigger(bool v)
 248 {
 249     if (m_d->m_menuTabFocusTrigger == v) {
 250         return;
 251     }
 252
 253     m_d->m_menuTabFocusTrigger = v;
 254     m_d->m_menuLabel->setFocusPolicy(v ? Qt::TabFocus : Qt::NoFocus);
 255 }
 256
 257 QString FancyLineEdit::hintText() const
 258 {
 259     return m_d->m_hintText;
 260 }
 261
 262 void FancyLineEdit::setHintText(const QString &ht)
 263 {
 264     // Updating magic to make the property work in Designer.
 265     if (ht == m_d->m_hintText) {
 266         return;
 267     }
 268     hideHintText();
 269     m_d->m_hintText = ht;
 270     if (!hasFocus() && !ht.isEmpty()) {
 271         showHintText();
 272     }
 273 }
 274
 275 void FancyLineEdit::showHintText()
 276 {
 277     if (!m_d->m_showingHintText && text().isEmpty() && !m_d->m_hintText.isEmpty()) {
 278         m_d->m_showingHintText = true;
 279         setText(m_d->m_hintText);
 280         updateStyleSheet(side());
 281     }
 282 }
 283
 284 void FancyLineEdit::hideHintText()
 285 {
 286     if (m_d->m_showingHintText && !m_d->m_hintText.isEmpty()) {
 287         m_d->m_showingHintText = false;
 288         setText(QString());
 289         updateStyleSheet(side());
 290     }
 291 }
 292
 293 void FancyLineEdit::focusInEvent(QFocusEvent *e)
 294 {
 295     hideHintText();
 296     QLineEdit::focusInEvent(e);
 297 }
 298
 299 void FancyLineEdit::focusOutEvent(QFocusEvent *e)
 300 {
 301     // Focus out: Switch to displaying the hint text unless
 302     // there is user input
 303     showHintText();
 304     QLineEdit::focusOutEvent(e);
 305 }
 306
 307 bool FancyLineEdit::isShowingHintText() const
 308 {
 309     return m_d->m_showingHintText;
 310 }
 311
 312 QString FancyLineEdit::typedText() const
 313 {
 314     return m_d->m_showingHintText ? QString() : text();
 315 }
 316 } // namespace Utils