src/views/selectiontoggle.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Peter Penz <peter.penz@gmx.at>                  *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef SELECTIONTOGGLE_H
  21 #define SELECTIONTOGGLE_H
  22
  23 #include <KUrl>
  24
  25 #include <QAbstractButton>
  26 #include <QPixmap>
  27
  28 class QTimeLine;
  29
  30 /**
  31  * @brief Toggle button for changing the selection of an hovered item.
  32  *
  33  * The toggle button is visually invisible until it is displayed at least
  34  * for one second.
  35  *
  36  * @see SelectionManager
  37  */
  38 class SelectionToggle : public QAbstractButton
  39 {
  40     Q_OBJECT
  41
  42 public:
  43     explicit SelectionToggle(QWidget* parent);
  44     virtual ~SelectionToggle();
  45     virtual QSize sizeHint() const;
  46
  47     /**
  48      * Resets the selection toggle so that it is hidden and stays
  49      * visually invisible for at least one second after it is shown again.
  50      */
  51     void reset();
  52
  53     void setUrl(const KUrl& url);
  54     KUrl url() const;
  55
  56     /**
  57      * Sets the margin around the selection-icon in pixels. Per default
  58      * the value is 0.
  59      */
  60     void setMargin(int margin);
  61     int margin() const;
  62
  63 public slots:
  64     virtual void setVisible(bool visible);
  65
  66 protected:
  67     virtual bool eventFilter(QObject* obj, QEvent* event);
  68     virtual void enterEvent(QEvent* event);
  69     virtual void leaveEvent(QEvent* event);
  70     virtual void mousePressEvent(QMouseEvent* event);
  71     virtual void mouseReleaseEvent(QMouseEvent* event);
  72     virtual void resizeEvent(QResizeEvent* event);
  73     virtual void paintEvent(QPaintEvent* event);
  74
  75 private slots:
  76     /**
  77      * Sets the alpha value for the fading animation and is
  78      * connected with m_fadingTimeLine.
  79      */
  80     void setFadingValue(int value);
  81
  82     void setIconOverlay(bool checked);
  83     void refreshIcon();
  84
  85 private:
  86     void startFading();
  87     void stopFading();
  88
  89 private:
  90     bool m_isHovered;
  91     bool m_leftMouseButtonPressed;
  92     int m_fadingValue;
  93     int m_margin;
  94     QPixmap m_icon;
  95     QTimeLine* m_fadingTimeLine;
  96     KUrl m_url;
  97 };
  98
  99 #endif