SignalView.h

Go to the documentation of this file.

/***************************************************************************
    SignalView.h  -  base class for widgets for views to a signal
                             -------------------
    begin                : Mon Jan 18 2010
    copyright            : (C) 2010 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SIGNAL_VIEW_H
#define SIGNAL_VIEW_H

#include "config.h"

#include <QtGlobal>
#include <QLabel>
#include <QList>
#include <QObject>
#include <QPointer>
#include <QPolygon>
#include <QSharedPointer>
#include <QSize>
#include <QString>
#include <QTimer>
#include <QWidget>

#include "libkwave/Sample.h"

#include "libgui/MouseMark.h"
#include "libgui/ViewItem.h"

class QEvent;
class QMouseEvent;
class QPaintEvent;
class QPoint;

namespace Kwave
{

    class SignalManager; // forward declaration

    class Q_DECL_EXPORT SignalView: public QWidget
    {
        Q_OBJECT
    public:

        typedef enum {
            UpperDockTop,     
            UpperDockBottom,  
            Top,              
            AboveTrackTop,    
            AboveTrackBottom, 
            BelowTrackTop,    
            BelowTrackBottom, 
            Bottom,           
            LowerDockTop,     
            LowerDockBottom   
        } Location;

        SignalView(QWidget *parent, QWidget *controls,
                   Kwave::SignalManager *signal_manager,
                   Location preferred_location,
                   int track = -1);

        virtual ~SignalView() Q_DECL_OVERRIDE;

        virtual void refresh();

        Location preferredLocation() const {
            return m_preferred_location;
        }

        inline Kwave::SignalManager *signalManager() const {
            return m_signal_manager;
        }

        inline int track() const {
            return m_track_index;
        }

        inline sample_index_t offset() const {
            return m_offset;
        }

        inline double zoom() const {
            return m_zoom;
        }

        inline double verticalZoom() const {
            return m_vertical_zoom;
        }

        inline sample_index_t firstVisible() const {
            return m_offset;
        }

        inline sample_index_t lastVisible() const {
            const sample_index_t w = pixels2samples(width());
            return m_offset + ((w) ? (w - 1) : 0);
        }

        int samples2pixels(sample_index_t samples) const;

        sample_index_t pixels2samples(int pixels) const;

        double samples2ms(sample_index_t samples);

        virtual bool canHandleSelection() const { return false; }

        virtual QSharedPointer<Kwave::ViewItem> findItem(const QPoint &pos);

        virtual void mouseMoveEvent(QMouseEvent *e) Q_DECL_OVERRIDE;

        virtual void mousePressEvent(QMouseEvent *e) Q_DECL_OVERRIDE;

        virtual void mouseReleaseEvent(QMouseEvent *e) Q_DECL_OVERRIDE;

        virtual void leaveEvent(QEvent *e) Q_DECL_OVERRIDE;

        virtual void keyPressEvent(QKeyEvent *e) Q_DECL_OVERRIDE;

        virtual int selectionTolerance() const;

        virtual void handleContextMenu(const QPoint &pos, QMenu *menu);

        virtual void addSibling(QWidget *widget);

    signals:

        void contentSizeChanged();

        void sigCursorChanged(sample_index_t pos);

        void sigNeedRepaint(Kwave::SignalView *view);

        void sigCommand(const QString &command);

    public slots:

        virtual void setTrack(int track);

        virtual void setZoomAndOffset(double zoom, sample_index_t offset);

        virtual void setVerticalZoom(double zoom);

        virtual void showCursor(sample_index_t pos = SAMPLE_INDEX_MAX);

    protected slots:

        virtual void showPosition(const QString &text, sample_index_t pos,
                                  const QPoint &mouse);

        virtual void hidePosition() {
            showPosition(QString(), 0, QPoint(-1,-1));
        }

    protected:

        virtual void dragEnterEvent(QDragEnterEvent *event) Q_DECL_OVERRIDE;

        virtual void dragLeaveEvent(QDragLeaveEvent *event) Q_DECL_OVERRIDE;

        virtual void dropEvent(QDropEvent *event) Q_DECL_OVERRIDE;

        virtual void dragMoveEvent(QDragMoveEvent *event) Q_DECL_OVERRIDE;

    protected:

        enum SelectionPosEnum {
            None        = 0x0000, 
            LeftBorder  = 0x0001, 
            RightBorder = 0x0002, 
            Selection   = 0x8000  
        };
        Q_DECLARE_FLAGS(SelectionPos, SelectionPosEnum)

        
        SelectionPos selectionPosition(int x);

        bool isInSelection(int x);

        void findNewItem(const QPoint &mouse_pos, bool active);

    protected:

        QWidget *m_controls;

        Kwave::SignalManager *m_signal_manager;

        Location m_preferred_location;

        int m_track_index;

        sample_index_t m_offset;

        double m_zoom;

    private:

        class PositionWidget: public QWidget
        {
        public:
            explicit PositionWidget(QWidget *parent);

            virtual ~PositionWidget() Q_DECL_OVERRIDE;

            virtual void setText(const QString &text, Qt::Alignment alignment);

        protected:

            virtual void paintEvent(QPaintEvent *) Q_DECL_OVERRIDE;

            virtual void updateMask();

        private:

            QLabel *m_label;

            Qt::Alignment m_alignment;

            int m_radius;

            int m_arrow_length;

            Qt::Alignment m_last_alignment;

            QSize m_last_size;

            QPolygon m_polygon;
        };

    private:

        double m_vertical_zoom;

        enum {
            MouseNormal = 0,   
            MouseMoveItem,     
            MouseDragItem      
        } m_mouse_mode;

        Kwave::MouseMark m_mouse_selection;

        int m_mouse_down_x;

        PositionWidget m_position_widget;

        QTimer m_position_widget_timer;

        QList<QPointer<QWidget> > m_siblings;

        QSharedPointer<Kwave::ViewItem> m_selected_item;
    };

}

#endif /* SIGNAL_VIEW_H */

//***************************************************************************
//***************************************************************************