Kwave::SignalView Class Reference

#include <SignalView.h>

Inheritance diagram for Kwave::SignalView:

Collaboration diagram for Kwave::SignalView:

Classes
class	PositionWidget

Public Types
enum	Location {   UpperDockTop, UpperDockBottom, Top, AboveTrackTop,   AboveTrackBottom, BelowTrackTop, BelowTrackBottom, Bottom,   LowerDockTop, LowerDockBottom }

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)

Signals
void	contentSizeChanged ()
void	sigCursorChanged (sample_index_t pos)
void	sigNeedRepaint (Kwave::SignalView *view)
void	sigCommand (const QString &command)

Public Member Functions
	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
Kwave::SignalManager *	signalManager () const
int	track () const
sample_index_t	offset () const
double	zoom () const
double	verticalZoom () const
sample_index_t	firstVisible () const
sample_index_t	lastVisible () const
int	samples2pixels (sample_index_t samples) const
sample_index_t	pixels2samples (int pixels) const
double	samples2ms (sample_index_t samples)
virtual bool	canHandleSelection () const
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)

Protected Types
enum	SelectionPosEnum { None = 0x0000, LeftBorder = 0x0001, RightBorder = 0x0002, Selection = 0x8000 }

Protected Slots
virtual void	showPosition (const QString &text, sample_index_t pos, const QPoint &mouse)
virtual void	hidePosition ()

Protected Member Functions
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
SelectionPos	selectionPosition (int x)
bool	isInSelection (int x)
void	findNewItem (const QPoint &mouse_pos, bool active)

Protected Attributes
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 Types
enum	{ MouseNormal = 0, MouseMoveItem, MouseDragItem }

Private Attributes
double	m_vertical_zoom
enum Kwave::SignalView:: { ... }	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

Detailed Description

Definition at line 50 of file SignalView.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

mode of the mouse cursor

Enumerator
MouseNormal	over the signal [default]
MouseMoveItem	while moving an item
MouseDragItem	while dragging an item

Definition at line 413 of file SignalView.h.

             {
            MouseNormal = 0,   
            MouseMoveItem,     
            MouseDragItem      
        } m_mouse_mode;

Location

enum Kwave::SignalView::Location

preferred location of the SignalView

Enumerator
UpperDockTop	upper dock area, top
UpperDockBottom	upper dock area, bottom
Top	above all others
AboveTrackTop	above the associated track, top
AboveTrackBottom	above the associated track, bottom
BelowTrackTop	below the associated track, top
BelowTrackBottom	below the associated track, bottom
Bottom	below all others
LowerDockTop	lower dock area, top
LowerDockBottom	lower dock area, bottom

Definition at line 56 of file SignalView.h.

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

SelectionPosEnum

enum Kwave::SignalView::SelectionPosEnum

protected

Relationship between a screen position and the current selection.

Enumerator
None	not near a border
LeftBorder	close to start of selection
RightBorder	close to end of selection
Selection	within the selection

Definition at line 295 of file SignalView.h.

                              {
            None        = 0x0000, 
            LeftBorder  = 0x0001, 
            RightBorder = 0x0002, 
            Selection   = 0x8000  
        };

Constructor & Destructor Documentation

SignalView()

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

Constructor

Parameters

parent	pointer to the parent widget
controls	container widget for associated controls
signal_manager	the signal manager
preferred_location	the location where to insert the view
track	(optional) index of the associated track or -1 if not related to a specific track (default)

Definition at line 52 of file SignalView.cpp.

References Kwave::connect(), m_position_widget, and m_position_widget_timer.

    :QWidget(parent),
     m_controls(controls),
     m_signal_manager(signal_manager),
     m_preferred_location(preferred_location),
     m_track_index(track),
     m_offset(0),
     m_zoom(1.0),
     m_vertical_zoom(1.0),
     m_mouse_mode(MouseNormal),
     m_mouse_selection(),
     m_mouse_down_x(0),
     m_position_widget(this),
     m_position_widget_timer(this),
     m_siblings(),
     m_selected_item(Q_NULLPTR)
{
    // connect the timer of the position widget
    connect(&m_position_widget_timer, SIGNAL(timeout()),
            &m_position_widget, SLOT(hide()));

    setMouseTracking(true);
    setAcceptDrops(true);            // enable drag&drop
    setFocusPolicy(Qt::StrongFocus); // enabled keyboard events
}

Here is the call graph for this function:

~SignalView()

Kwave::SignalView::~SignalView ( )

virtual

Destructor

Definition at line 82 of file SignalView.cpp.

References hidePosition(), m_mouse_mode, m_selected_item, m_siblings, and MouseNormal.

{
    m_mouse_mode = MouseNormal;
    setCursor(Qt::ArrowCursor);
    hidePosition();
    m_selected_item.clear();

    if (!m_siblings.isEmpty()) {
        QMutableListIterator<QPointer<QWidget> > it(m_siblings);
        it.toBack();
        while (it.hasPrevious()) {
            QWidget *widget = it.previous();
            it.remove();
            if (widget) delete widget;
        }
    }
}

Here is the call graph for this function:

Member Function Documentation

addSibling()

void Kwave::SignalView::addSibling ( QWidget *  widget )

virtual

Adds a widget to the list of associated widgets

Parameters

widget

a QWidget that is associated to this view

Definition at line 107 of file SignalView.cpp.

References m_siblings.

Referenced by Kwave::SignalWidget::insertRow().

{
    m_siblings.append(QPointer<QWidget>(widget));
}

Here is the caller graph for this function:

canHandleSelection()

virtual bool Kwave::SignalView::canHandleSelection ( ) const

inlinevirtual

Should be overwritten by subclasses that can display the currently selected range and allow the user to change the selection by mouse.

Returns

true if mouse selection is handled

Reimplemented in Kwave::TrackView.

Definition at line 164 of file SignalView.h.

References SAMPLE_INDEX_MAX.

Referenced by mousePressEvent(), mouseReleaseEvent(), and selectionPosition().

{ return false; }

Here is the caller graph for this function:

contentSizeChanged

void Kwave::SignalView::contentSizeChanged ( )

signal

emitted whenever the size of the content has changed

Referenced by Kwave::TrackView::setVerticalZoom().

Here is the caller graph for this function:

dragEnterEvent()

void Kwave::SignalView::dragEnterEvent ( QDragEnterEvent *  event )

protectedvirtual

See also

Qt XDND documentation

Definition at line 555 of file SignalView.cpp.

References Kwave::FileDrag::canDecode(), SAMPLE_INDEX_MAX, and sigCursorChanged().

{
    if (!event) return;
    if ((event->proposedAction() != Qt::MoveAction) &&
        (event->proposedAction() != Qt::CopyAction))
        return; /* unsupported action */

    if (Kwave::FileDrag::canDecode(event->mimeData()))
        event->acceptProposedAction();
    emit sigCursorChanged(SAMPLE_INDEX_MAX);
}

Here is the call graph for this function:

dragLeaveEvent()

void Kwave::SignalView::dragLeaveEvent ( QDragLeaveEvent *  event )

protectedvirtual

See also

Qt XDND documentation

Definition at line 568 of file SignalView.cpp.

References m_mouse_mode, MouseNormal, SAMPLE_INDEX_MAX, and sigCursorChanged().

{
    Q_UNUSED(event);
    m_mouse_mode = MouseNormal;
    setCursor(Qt::ArrowCursor);
    emit sigCursorChanged(SAMPLE_INDEX_MAX);
}

dragMoveEvent()

void Kwave::SignalView::dragMoveEvent ( QDragMoveEvent *  event )

protectedvirtual

See also

Qt XDND documentation

Definition at line 634 of file SignalView.cpp.

References Kwave::FileDrag::canDecode(), Kwave::Drag::canDecode(), Kwave::Selection::first(), isInSelection(), Kwave::Selection::last(), m_offset, m_signal_manager, pixels2samples(), rect(), SAMPLE_INDEX_MAX, samples2pixels(), Kwave::SignalManager::selection(), and sigCursorChanged().

{
    if (!event) return;
    const int x = event->pos().x();

    if ((event->source() == this) && isInSelection(x)) {
        // disable drag&drop into the selection itself
        // this would be nonsense

        Q_ASSERT(m_signal_manager);
        if (!m_signal_manager) {
            event->ignore();
            emit sigCursorChanged(SAMPLE_INDEX_MAX);
            return;
        }

        sample_index_t left  = m_signal_manager->selection().first();
        sample_index_t right = m_signal_manager->selection().last();
        const sample_index_t w = pixels2samples(width());
        QRect rect(this->rect());

        // crop selection to widget borders
        if (left < m_offset) left = m_offset;
        if (right > m_offset + w) right = m_offset + w - 1;

        // transform to pixel coordinates
        int l = qMin(samples2pixels(left  - m_offset), width() - 1);
        int r = qMin(samples2pixels(right - m_offset), l);
        rect.setLeft(l);
        rect.setRight(r);
        event->ignore(rect);
        emit sigCursorChanged(SAMPLE_INDEX_MAX);
    } else if (Kwave::Drag::canDecode(event->mimeData())) {
        // accept if it is decodeable within the
        // current range (if it's outside our own selection)
        event->acceptProposedAction();

        // show a cursor at the possible drop location
        sample_index_t item_pos  = m_offset + pixels2samples(x);
        emit sigCursorChanged(item_pos);
    } else if (Kwave::FileDrag::canDecode(event->mimeData())) {
        // file drag
        event->accept();
        emit sigCursorChanged(SAMPLE_INDEX_MAX);
    } else {
        event->ignore();
        emit sigCursorChanged(SAMPLE_INDEX_MAX);
    }
}

Here is the call graph for this function:

dropEvent()

void Kwave::SignalView::dropEvent ( QDropEvent *  event )

protectedvirtual

See also

Qt XDND documentation

Definition at line 577 of file SignalView.cpp.

References _, Kwave::Drag::canDecode(), Kwave::CodecManager::canDecode(), DBG, Kwave::Drag::decode(), Kwave::Parser::escape(), m_mouse_mode, m_offset, m_signal_manager, Kwave::CodecManager::mimeTypeOf(), MouseNormal, pixels2samples(), SAMPLE_INDEX_MAX, Kwave::SignalManager::selectRange(), sigCommand(), and sigCursorChanged().

{
    if (!event) return;
    const QMimeData *mime_data = event->mimeData();
    if (!mime_data) return;
    Q_ASSERT(m_signal_manager);
    if (!m_signal_manager) return;

    if (Kwave::Drag::canDecode(mime_data)) {
        Kwave::UndoTransactionGuard undo(*m_signal_manager,
                                         i18n("Drag and Drop"));
        sample_index_t pos = m_offset + pixels2samples(event->pos().x());
        sample_index_t len = 0;

        if ((len = Kwave::Drag::decode(this, mime_data,
            *m_signal_manager, pos)))
        {
            // set selection to the new area where the drop was done
            m_signal_manager->selectRange(pos, len);
            event->acceptProposedAction();
        } else {
            QStringList formats = mime_data->formats();
            qWarning("SignalView::dropEvent(%s): failed !",
                DBG(formats.join(_("; "))));
        }
    } else if (mime_data->hasUrls()) {
        bool first = true;
        foreach (const QUrl &url, mime_data->urls()) {
            QString filename = url.toLocalFile();
            QString mimetype = Kwave::CodecManager::mimeTypeOf(url);
            if (Kwave::CodecManager::canDecode(mimetype)) {
                if (first) {
                    // first dropped URL -> open in this window
                    emit sigCommand(_("open(") +
                                    Kwave::Parser::escape(filename) +
                                    _(")"));
                    first = false;
                    event->acceptProposedAction();
                } else {
                    // all others -> open a new window
                    emit sigCommand(_("newwindow(") +
                                    Kwave::Parser::escape(filename) +
                                    _(")"));
                }
            }
        }
    }

    qDebug("SignalView::dropEvent(): done");
    m_mouse_mode = MouseNormal;
    setCursor(Qt::ArrowCursor);
    emit sigCursorChanged(SAMPLE_INDEX_MAX);

    if (!event->isAccepted()) event->ignore();
}

Here is the call graph for this function:

findItem()

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

virtual

Tries to find the nearest item that is visible in this view at a given position

Parameters

pos	position to look at, relative to view [pixels]

Returns

the nearest ViewObject in range or a null pointer if nothing found

Reimplemented in Kwave::TrackView.

Definition at line 215 of file SignalView.cpp.

Referenced by findNewItem().

{
    Q_UNUSED(pos);
    return QSharedPointer<Kwave::ViewItem>(Q_NULLPTR);
}

Here is the caller graph for this function:

findNewItem()

void Kwave::SignalView::findNewItem ( const QPoint &  mouse_pos, bool  active  )

protected

Tries to find the nearest item that is visible in this view at a given position and show or hide the corresponding tool tip.

Parameters

mouse_pos	position to look at, relative to view [pixels]
active	if true an operation (move or drag&drop) is active, otherwise it is only a hover over an item

Definition at line 287 of file SignalView.cpp.

References Kwave::ViewItem::CanDragAndDrop, Kwave::ViewItem::CanGrabAndMove, findItem(), hidePosition(), m_mouse_mode, m_offset, m_selected_item, MouseMoveItem, MouseNormal, pixels2samples(), and showPosition().

Referenced by mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

{
    m_selected_item = QSharedPointer<Kwave::ViewItem>(Q_NULLPTR);
    if (!active) m_mouse_mode = MouseNormal;

    m_selected_item = findItem(mouse_pos);
    if (m_selected_item) {
        // we have an item to show, activate the position window
        sample_index_t item_pos  = m_offset + pixels2samples(mouse_pos.x());
        QString        item_text = m_selected_item->toolTip(item_pos);
        showPosition(item_text, item_pos, mouse_pos);

        // update the mouse cursor
        Kwave::ViewItem::Flags flags = m_selected_item->flags();
        if (flags & Kwave::ViewItem::CanDragAndDrop)
            setCursor(active ? Qt::ClosedHandCursor : Qt::ArrowCursor);
        else if (flags & Kwave::ViewItem::CanGrabAndMove)
            setCursor(m_selected_item->mouseCursor());
        else
            setCursor(Qt::ArrowCursor);

        if (active) m_mouse_mode = MouseMoveItem;
    } else {
        // out of scope
        hidePosition();
        m_mouse_mode = MouseNormal;
        setCursor(Qt::ArrowCursor);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

firstVisible()

sample_index_t Kwave::SignalView::firstVisible ( ) const

inline

returns the index of the first visible sample

Definition at line 125 of file SignalView.h.

                                                   {
            return m_offset;
        }

handleContextMenu()

void Kwave::SignalView::handleContextMenu ( const QPoint &  pos, QMenu *  menu  )

virtual

Called when the context menu has been activated over this view

Parameters

pos	a position in pixel within this widget
menu	pointer to the context menu

Reimplemented in Kwave::TrackView.

Definition at line 548 of file SignalView.cpp.

{
    Q_UNUSED(pos);
    Q_UNUSED(menu);
}

hidePosition

virtual void Kwave::SignalView::hidePosition ( )

inlineprotectedvirtualslot

Hide the current position marker

See also

showPosition

Definition at line 272 of file SignalView.h.

Referenced by findNewItem(), keyPressEvent(), leaveEvent(), mouseMoveEvent(), setZoomAndOffset(), and ~SignalView().

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

Here is the caller graph for this function:

isInSelection()

bool Kwave::SignalView::isInSelection ( int  x )

protected

Checks if a pixel position is within the left and right border of a selection. The tolerance is 2% of the currently visible area.

Parameters

x	pixel position to be tested

Returns

true if the position is within range

Definition at line 209 of file SignalView.cpp.

References selectionPosition().

Referenced by dragMoveEvent().

{
    return (selectionPosition(x) & Selection) != 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

keyPressEvent()

void Kwave::SignalView::keyPressEvent ( QKeyEvent *  e )

virtual

handles key press events (e.g. the Escape key)

Definition at line 527 of file SignalView.cpp.

References hidePosition(), m_mouse_mode, m_selected_item, and MouseNormal.

{
    if (!e) return;
    if (e->matches(QKeySequence::Cancel)) {
        // Cancel key (Escape) -> reset all view item operations
        m_mouse_mode = MouseNormal;
        setCursor(Qt::ArrowCursor);
        m_selected_item = QSharedPointer<Kwave::ViewItem>(Q_NULLPTR);
    } else {
        QWidget::keyPressEvent(e);
    }
    hidePosition();
}

Here is the call graph for this function:

lastVisible()

sample_index_t Kwave::SignalView::lastVisible ( ) const

inline

returns the index of the last visible sample

Definition at line 130 of file SignalView.h.

Referenced by Kwave::TrackView::paintEvent().

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

Here is the caller graph for this function:

leaveEvent()

void Kwave::SignalView::leaveEvent ( QEvent *  e )

virtual

slot when the mouse leaves the widget

Definition at line 518 of file SignalView.cpp.

References hidePosition(), m_mouse_mode, and MouseNormal.

{
    m_mouse_mode = MouseNormal;
    setCursor(Qt::ArrowCursor);
    hidePosition();
    QWidget::leaveEvent(e);
}

Here is the call graph for this function:

mouseMoveEvent()

void Kwave::SignalView::mouseMoveEvent ( QMouseEvent *  e )

virtual

slot for mouse moves, used for selection and drag&drop

Definition at line 318 of file SignalView.cpp.

References Kwave::ViewItem::CanDragAndDrop, Kwave::ViewItem::CanGrabAndMove, findNewItem(), hidePosition(), Kwave::SignalManager::length(), m_mouse_down_x, m_mouse_mode, m_offset, m_selected_item, m_signal_manager, MouseDragItem, MouseMoveItem, MouseNormal, pixels2samples(), and showPosition().

{
    Q_ASSERT(e);
    if (!e) return;

    // abort if no signal is loaded
    Q_ASSERT(m_signal_manager);
    if (!m_signal_manager || !m_signal_manager->length()) {
        e->ignore();
        return;
    }

    // there seems to be a BUG in Qt, sometimes e->pos() produces flicker/wrong
    // coordinates on the start of a fast move!?
    // globalPos() seems not to have this effect
    const QPoint mouse_pos(
        qBound(0, mapFromGlobal(e->globalPos()).x(), width()  - 1),
        qBound(0, mapFromGlobal(e->globalPos()).y(), height() - 1)
    );

    // bail out if the position did not change
    static QPoint last_pos = QPoint(-1, -1);
    if (mouse_pos == last_pos) {
        e->ignore();
        return;
    }

    switch (m_mouse_mode) {
        case MouseDragItem: /* FALLTHROUGH */
        case MouseMoveItem: {
            // move mode

            if (m_selected_item.isNull()) {
                hidePosition();
                break;
            }

            bool hide_position = true;
            Kwave::ViewItem::Flags flags = m_selected_item->flags();
            if (flags & Kwave::ViewItem::CanDragAndDrop) {
                const int dmin = QApplication::startDragDistance();
                if ((e->buttons() & Qt::LeftButton) &&
                    ((mouse_pos.x() < (m_mouse_down_x - dmin)) ||
                     (mouse_pos.x() > (m_mouse_down_x + dmin))) )
                {
                    m_selected_item->startDragging();
                }
            }

            if (flags & Kwave::ViewItem::CanGrabAndMove) {
                // update the position of the item
                m_selected_item->moveTo(mouse_pos);

                // show the position window, so that we see the coordinates
                // where we move the item to
                sample_index_t pos  = m_offset + pixels2samples(mouse_pos.x());
                QString item_text = m_selected_item->toolTip(pos);
                showPosition(item_text, pos, mouse_pos);
                hide_position = false;
            }

            if (hide_position) hidePosition();
            break;
        }
        case MouseNormal: /* FALLTHROUGH */
        default:
            findNewItem(mouse_pos, false);
            break;
    }
    e->accept();
}

Here is the call graph for this function:

mousePressEvent()

void Kwave::SignalView::mousePressEvent ( QMouseEvent *  e )

virtual

slot for mouse press, used for selection and drag&drop

Definition at line 391 of file SignalView.cpp.

References Kwave::ViewItem::CanDragAndDrop, canHandleSelection(), findNewItem(), Kwave::Selection::first(), Kwave::MouseMark::grep(), Kwave::Selection::last(), Kwave::MouseMark::left(), Kwave::MouseMark::length(), Kwave::SignalManager::length(), m_mouse_down_x, m_mouse_mode, m_mouse_selection, m_offset, m_selected_item, m_signal_manager, MouseMoveItem, pixels2samples(), Kwave::SignalManager::playbackController(), Kwave::PlaybackController::running(), Kwave::SignalManager::selection(), Kwave::SignalManager::selectRange(), and Kwave::MouseMark::set().

{
    Q_ASSERT(e);
    Q_ASSERT(m_signal_manager);
    if (!e) return;

    // abort if no signal is loaded
    if (!m_signal_manager || !m_signal_manager->length()) {
        e->ignore();
        return;
    }

    // ignore all mouse press events in playback mode
    if (m_signal_manager->playbackController().running()) {
        e->ignore();
        return;
    }

    const QPoint mouse_pos(
        qBound(0, mapFromGlobal(e->globalPos()).x(), width()  - 1),
        qBound(0, mapFromGlobal(e->globalPos()).y(), height() - 1)
    );

    findNewItem(mouse_pos, false);

    if (e->button() == Qt::LeftButton) {
        sample_index_t ofs = m_offset + pixels2samples(mouse_pos.x());
        sample_index_t selection_first = m_signal_manager->selection().first();
        sample_index_t selection_last  = m_signal_manager->selection().last();

        switch (e->modifiers()) {
            case Qt::ShiftModifier: {
                // expand the selection to "here"
                m_mouse_selection.set(selection_first, selection_last);
                m_mouse_selection.grep(ofs);
                m_signal_manager->selectRange(
                    m_mouse_selection.left(),
                    m_mouse_selection.length()
                );

                // this probably changes to "adjust selection border"
                findNewItem(mouse_pos, true);
                break;
            }
            case Qt::NoModifier: {
                // check whether there is some object near this position
                if (m_selected_item) {
                    // we have an item here:
                    m_mouse_mode = MouseMoveItem;

                    Kwave::ViewItem::Flags flags = m_selected_item->flags();
                    if (flags & Kwave::ViewItem::CanDragAndDrop) {
                        // store the x position for later drag&drop
                        m_mouse_down_x = mouse_pos.x();
                        setCursor(Qt::DragMoveCursor);
                    }
                } else if (canHandleSelection()) {
                    // start a new selection
                    m_mouse_selection.set(ofs, ofs);
                    m_signal_manager->selectRange(ofs, 0);

                    // this probably changes to "adjust selection border"
                    findNewItem(mouse_pos, true);
                }
                break;
            }
            default:
                break;
        }
    }
    e->accept();
}

Here is the call graph for this function:

mouseReleaseEvent()

void Kwave::SignalView::mouseReleaseEvent ( QMouseEvent *  e )

virtual

slot for mouse release, used for selection and drag&drop

Definition at line 465 of file SignalView.cpp.

References Kwave::ViewItem::CanGrabAndMove, canHandleSelection(), findNewItem(), Kwave::SignalManager::length(), m_mouse_mode, m_mouse_selection, m_offset, m_selected_item, m_signal_manager, MouseDragItem, MouseMoveItem, pixels2samples(), Kwave::SignalManager::playbackController(), Kwave::PlaybackController::running(), Kwave::SignalManager::selectRange(), and Kwave::MouseMark::set().

{
    Q_ASSERT(e);
    Q_ASSERT(m_signal_manager);
    if (!e) return;

    // abort if no signal is loaded
    if (!m_signal_manager || !m_signal_manager->length()) {
        e->ignore();
        return;
    }

    // ignore all mouse release events in playback mode
    if (m_signal_manager->playbackController().running()) {
        e->ignore();
        return;
    }

    const QPoint mouse_pos(
        qBound(0, mapFromGlobal(e->globalPos()).x(), width()  - 1),
        qBound(0, mapFromGlobal(e->globalPos()).y(), height() - 1)
    );

    switch (m_mouse_mode) {
        case MouseDragItem:
            // released after dragging
            if (m_selected_item) m_selected_item->done();
            findNewItem(mouse_pos, false);
            break;
        case MouseMoveItem:
            if (m_selected_item) {
                // released after move
                if (m_selected_item->flags() & Kwave::ViewItem::CanGrabAndMove)
                    m_selected_item->done();
                else if (canHandleSelection()) {
                    // maybe started dragging, but released before reaching
                    // the minimum drag distance -> start a new selection
                    sample_index_t ofs = m_offset +
                                         pixels2samples(mouse_pos.x());
                    m_mouse_selection.set(ofs, ofs);
                    m_signal_manager->selectRange(ofs, 0);
                }
            }
            findNewItem(mouse_pos, false);
            break;
        default:
            break;
    }

    e->accept();
}

Here is the call graph for this function:

offset()

sample_index_t Kwave::SignalView::offset ( ) const

inline

returns the current start position

Definition at line 110 of file SignalView.h.

Referenced by Kwave::TrackView::findItem(), Kwave::SelectionBorderItem::moveTo(), Kwave::LabelItem::moveTo(), and setZoomAndOffset().

                                             {
            return m_offset;
        }

Here is the caller graph for this function:

pixels2samples()

sample_index_t Kwave::SignalView::pixels2samples

(

int

pixels

)

const

Converts a number of pixels into a number of samples, based on the current zoom factor

Parameters

pixels

number of pixels (should be positive)

Returns

number of samples

Definition at line 155 of file SignalView.cpp.

References m_zoom.

Referenced by dragMoveEvent(), dropEvent(), Kwave::TrackView::findItem(), findNewItem(), Kwave::TrackView::handleContextMenu(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), Kwave::SelectionBorderItem::moveTo(), Kwave::LabelItem::moveTo(), and Kwave::TrackView::paintEvent().

{
    if ((pixels <= 0) || (m_zoom <= 0.0)) return 0;
    return static_cast<sample_index_t>(static_cast<double>(pixels) * m_zoom);
}

Here is the caller graph for this function:

preferredLocation()

Location Kwave::SignalView::preferredLocation ( ) const

inline

returns the preferred location

Definition at line 95 of file SignalView.h.

Referenced by Kwave::SignalWidget::insertView().

                                           {
            return m_preferred_location;
        }

Here is the caller graph for this function:

refresh()

void Kwave::SignalView::refresh ( )

virtual

refresh the content of the view. The default implementation calls repaint(). Can be overwritten to trigger more complex refresh scenarios.

See also

TrackView::refresh() for an example

Reimplemented in Kwave::TrackView.

Definition at line 101 of file SignalView.cpp.

Referenced by Kwave::SignalWidget::repaintTimerElapsed().

{
    repaint();
}

Here is the caller graph for this function:

samples2ms()

double Kwave::SignalView::samples2ms

(

sample_index_t

samples

)

Converts a number of samples to a time in milliseconds, based on the current signal rate.

Parameters

samples

number of samples

Returns

time in milliseconds

Definition at line 162 of file SignalView.cpp.

References m_signal_manager, and Kwave::SignalManager::rate().

Referenced by Kwave::SelectionBorderItem::toolTip(), and Kwave::LabelItem::toolTip().

{
    Q_ASSERT(m_signal_manager);
    if (!m_signal_manager) return 0.0;

    double rate = m_signal_manager->rate();
    if (rate == 0.0) return 0.0;
    return static_cast<double>(samples) * 1E3 / rate;
}

Here is the call graph for this function:

Here is the caller graph for this function:

samples2pixels()

int Kwave::SignalView::samples2pixels

(

sample_index_t

samples

)

const

converts a number of samples into a number of pixels, based on the current zoom factor

Parameters

samples

a small number of samples (must be positive)

Returns

number of pixels

Definition at line 149 of file SignalView.cpp.

References m_zoom, and Kwave::toInt().

Referenced by dragMoveEvent(), Kwave::TrackView::paintEvent(), and showPosition().

{
    return Kwave::toInt((m_zoom > 0.0) ? (samples / m_zoom) : 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

selectionPosition()

Kwave::SignalView::SelectionPos Kwave::SignalView::selectionPosition ( int  x )

protected

Determines the relationship between a screen position and the current selection.

Parameters

x	screen position

Returns

a SelectionPos

Definition at line 173 of file SignalView.cpp.

References canHandleSelection(), Kwave::Selection::first(), Kwave::Selection::last(), LeftBorder, m_offset, m_signal_manager, m_zoom, None, RightBorder, Kwave::SignalManager::selection(), Selection, and selectionTolerance().

Referenced by isInSelection(), and showPosition().

{
    // shortcut: if this view can't handle selection...
    if (!canHandleSelection()) return Q_NULLPTR;

    Q_ASSERT(m_signal_manager);
    if (!m_signal_manager) return None;

    const double p     = (m_zoom * x) + m_offset;
    const double tol   = m_zoom * selectionTolerance();
    const double first = m_signal_manager->selection().first();
    const double last  = m_signal_manager->selection().last();
    Q_ASSERT(first <= last);

    // get distance to left/right selection border
    double d_left  = (p > first) ? (p - first) : (first - p);
    double d_right = (p > last)  ? (p - last)  : (last  - p);

    // the simple cases...
    Kwave::SignalView::SelectionPos pos = None;
    if ((d_left  <= tol) && (p < last))  pos |= LeftBorder;
    if ((d_right <= tol) && (p > first)) pos |= RightBorder;
    if ((p >= first) && (p <= last))     pos |= Selection;

    if ((pos & LeftBorder) && (pos & RightBorder)) {
        // special case: determine which border is nearer
        if (d_left < d_right)
            pos &= ~RightBorder; // more on the left
        else
            pos &= ~LeftBorder;  // more on the right
    }

    return pos;
}

Here is the call graph for this function:

Here is the caller graph for this function:

selectionTolerance()

int Kwave::SignalView::selectionTolerance ( ) const

virtual

tolerance in pixel for snapping to a label or selection border

Returns

number of pixels

Definition at line 542 of file SignalView.cpp.

Referenced by Kwave::TrackView::findItem(), and selectionPosition().

{
    return (2 * QApplication::startDragDistance());
}

Here is the caller graph for this function:

setTrack

void Kwave::SignalView::setTrack ( int  track )

virtualslot

changes the association to a track

Parameters

track

the new track index, or -1 if not associated

Definition at line 113 of file SignalView.cpp.

References m_track_index.

Referenced by Kwave::SignalWidget::slotTrackDeleted(), and Kwave::SignalWidget::slotTrackInserted().

{
    m_track_index = (track >= 0) ? track : -1;
}

Here is the caller graph for this function:

setVerticalZoom

void Kwave::SignalView::setVerticalZoom ( double  zoom )

virtualslot

sets new vertical zoom factor

Parameters

zoom	vertical zoom factor

Reimplemented in Kwave::TrackView.

Definition at line 137 of file SignalView.cpp.

References m_vertical_zoom, and zoom().

Referenced by Kwave::SignalWidget::insertView(), and Kwave::TrackView::setVerticalZoom().

{
    m_vertical_zoom = zoom;
}

Here is the call graph for this function:

Here is the caller graph for this function:

setZoomAndOffset

void Kwave::SignalView::setZoomAndOffset ( double  zoom, sample_index_t  offset  )

virtualslot

sets new zoom factor and offset

Parameters

zoom	the new zoom factor in pixels/sample
offset	the index of the first visible sample

Reimplemented in Kwave::TrackView.

Definition at line 119 of file SignalView.cpp.

References hidePosition(), m_offset, m_zoom, offset(), and zoom().

Referenced by Kwave::SignalWidget::insertView(), and Kwave::TrackView::setZoomAndOffset().

{
    if (qFuzzyCompare(zoom, m_zoom) && (offset == m_offset)) return;
    m_zoom   = zoom;
    m_offset = offset;

//     sample_index_t visible = ((width() - 1) * zoom) + 1;
//     sample_index_t last = offset + visible - 1;
//     qDebug("SignalView::setZoomAndOffset(%g, %lu), last visible=%lu",
//         zoom,
//         static_cast<unsigned long int>(offset),
//         static_cast<unsigned long int>(last));

    // the relation to the position widget has become invalid
    hidePosition();
}

Here is the call graph for this function:

Here is the caller graph for this function:

showCursor

void Kwave::SignalView::showCursor ( sample_index_t  pos = SAMPLE_INDEX_MAX )

virtualslot

shows the cursor at a given position

Parameters

pos	current position of the cursor

Definition at line 143 of file SignalView.cpp.

{
    Q_UNUSED(pos);
}

showPosition

void Kwave::SignalView::showPosition ( const QString &  text, sample_index_t  pos, const QPoint &  mouse  )

protectedvirtualslot

Shows the current cursor position as a tooltip

Parameters

text	description of the position
pos	marker position [samples]
mouse	the coordinates of the mouse cursor, relative to this widget [pixel]

Definition at line 222 of file SignalView.cpp.

References LeftBorder, m_offset, m_position_widget, m_position_widget_timer, POSITION_WIDGET_TIME, RightBorder, samples2pixels(), selectionPosition(), and Kwave::SignalView::PositionWidget::setText().

Referenced by findNewItem(), and mouseMoveEvent().

{
    // check: showPosition() must be called from the GUI thread only!
    Q_ASSERT(this->thread() == QThread::currentThread());
    Q_ASSERT(this->thread() == qApp->thread());

    int x = mouse.x();
    int y = mouse.y();

    // x/y == -1/-1 or empty text -> reset/hide the position
    if (((x < 0) && (y < 0)) || !text.length()) {
        m_position_widget_timer.stop();
        m_position_widget.hide();
        return;
    }

    setUpdatesEnabled(false);
    m_position_widget.hide();

    switch (selectionPosition(mouse.x()) & ~Selection) {
        case LeftBorder:
            m_position_widget.setText(text, Qt::AlignRight);
            x = samples2pixels(pos - m_offset) - m_position_widget.width();
            if (x < 0) {
                // switch to left aligned mode
                m_position_widget.setText(text, Qt::AlignLeft);
                x = samples2pixels(pos - m_offset);
            }
            break;
        case RightBorder:
        default:
            m_position_widget.setText(text, Qt::AlignLeft);
            x = samples2pixels(pos - m_offset);
            if (x + m_position_widget.width() > width()) {
                // switch to right aligned mode
                m_position_widget.setText(text, Qt::AlignRight);
                x = samples2pixels(pos - m_offset) - m_position_widget.width();
            }
            break;
    }

    // adjust the position to avoid vertical clipping
    int lh = m_position_widget.height();
    if (y - lh/2 < 0) {
        y = 0;
    } else if (y + lh/2 > height()) {
        y = height() - lh;
    } else {
        y -= lh/2;
    }

    m_position_widget.move(x, y);

    if (!m_position_widget.isVisible())
        m_position_widget.show();

    m_position_widget_timer.stop();
    m_position_widget_timer.setSingleShot(true);
    m_position_widget_timer.start(POSITION_WIDGET_TIME);

    setUpdatesEnabled(true);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sigCommand

void Kwave::SignalView::sigCommand ( const QString &  command )

signal

forward a sigCommand to the next layer

Referenced by Kwave::TrackView::contextMenuLabelNew(), and dropEvent().

Here is the caller graph for this function:

sigCursorChanged

void Kwave::SignalView::sigCursorChanged ( sample_index_t  pos )

signal

emitted to request update of the cursor

Referenced by dragEnterEvent(), dragLeaveEvent(), dragMoveEvent(), and dropEvent().

Here is the caller graph for this function:

signalManager()

Kwave::SignalManager* Kwave::SignalView::signalManager ( ) const

inline

returns the associated signal manager

Definition at line 100 of file SignalView.h.

Referenced by Kwave::SelectionItem::startDragging().

                                                         {
            return m_signal_manager;
        }

Here is the caller graph for this function:

sigNeedRepaint

void Kwave::SignalView::sigNeedRepaint ( Kwave::SignalView *  view )

signal

Can be emitted to signal that this view needs to be repainted, probably after synchronizing with other views and additionally throttled to reduce GUI load

Parameters

view	pointer to the view that needs to be repainted

Referenced by Kwave::TrackView::refreshAllLayers(), Kwave::TrackView::refreshMarkersLayer(), Kwave::TrackView::refreshSelectionLayer(), Kwave::TrackView::refreshSignalLayer(), and Kwave::TrackView::showCursor().

Here is the caller graph for this function:

track()

int Kwave::SignalView::track ( ) const

inline

returns the index of the associated track (or -1)

Definition at line 105 of file SignalView.h.

Referenced by Kwave::SignalWidget::insertView(), and Kwave::SignalWidget::slotTrackDeleted().

                                 {
            return m_track_index;
        }

Here is the caller graph for this function:

verticalZoom()

double Kwave::SignalView::verticalZoom ( ) const

inline

returns the current vertical zoom factor

Definition at line 120 of file SignalView.h.

Referenced by Kwave::TrackView::setVerticalZoom().

                                           {
            return m_vertical_zoom;
        }

Here is the caller graph for this function:

zoom()

double Kwave::SignalView::zoom ( ) const

inline

returns the current zoom [pixels/sample]

Definition at line 115 of file SignalView.h.

Referenced by setVerticalZoom(), and setZoomAndOffset().

                                   {
            return m_zoom;
        }

Here is the caller graph for this function:

Member Data Documentation

m_controls

QWidget* Kwave::SignalView::m_controls

protected

widget for displaying associated controls

Definition at line 333 of file SignalView.h.

m_mouse_down_x

int Kwave::SignalView::m_mouse_down_x

private

x position where the user clicked the last time, needed for finding out where to start a drag&drop operation [pixel]

Definition at line 426 of file SignalView.h.

Referenced by mouseMoveEvent(), and mousePressEvent().

m_mouse_mode

enum { ... } Kwave::SignalView::m_mouse_mode

mode of the mouse cursor

Referenced by dragLeaveEvent(), dropEvent(), findNewItem(), keyPressEvent(), leaveEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), and ~SignalView().

m_mouse_selection

Kwave::MouseMark Kwave::SignalView::m_mouse_selection

private

selection handler

Definition at line 420 of file SignalView.h.

Referenced by mousePressEvent(), and mouseReleaseEvent().

m_offset

sample_index_t Kwave::SignalView::m_offset

protected

Offset from which signal is being displayed. This is equal to the index of the first visible sample.

Definition at line 348 of file SignalView.h.

Referenced by dragMoveEvent(), dropEvent(), Kwave::TrackView::findItem(), findNewItem(), Kwave::TrackView::handleContextMenu(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), Kwave::TrackView::paintEvent(), selectionPosition(), setZoomAndOffset(), and showPosition().

m_position_widget

PositionWidget Kwave::SignalView::m_position_widget

private

small widget for showing the mouse cursor position

Definition at line 429 of file SignalView.h.

Referenced by showPosition(), and SignalView().

m_position_widget_timer

QTimer Kwave::SignalView::m_position_widget_timer

private

timer for automatic hiding

Definition at line 432 of file SignalView.h.

Referenced by showPosition(), and SignalView().

m_preferred_location

Location Kwave::SignalView::m_preferred_location

protected

the preferred location, as per construction

Definition at line 339 of file SignalView.h.

m_selected_item

QSharedPointer<Kwave::ViewItem> Kwave::SignalView::m_selected_item

private

currently selected view item or null

Definition at line 438 of file SignalView.h.

Referenced by findNewItem(), keyPressEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), and ~SignalView().

m_siblings

QList<QPointer<QWidget> > Kwave::SignalView::m_siblings

private

list of associated widgets, e.g. controls etc

Definition at line 435 of file SignalView.h.

Referenced by addSibling(), and ~SignalView().

m_signal_manager

Kwave::SignalManager* Kwave::SignalView::m_signal_manager

protected

the signal manager

Definition at line 336 of file SignalView.h.

Referenced by dragMoveEvent(), dropEvent(), Kwave::TrackView::findItem(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), Kwave::TrackView::paintEvent(), samples2ms(), and selectionPosition().

m_track_index

int Kwave::SignalView::m_track_index

protected

index of the associated track or -1 if no relation to a track

Definition at line 342 of file SignalView.h.

Referenced by setTrack().

m_vertical_zoom

double Kwave::SignalView::m_vertical_zoom

private

zoom factor for vertical size

Definition at line 410 of file SignalView.h.

Referenced by setVerticalZoom().

m_zoom

double Kwave::SignalView::m_zoom

protected

number of samples per pixel

Definition at line 351 of file SignalView.h.

Referenced by Kwave::TrackView::findItem(), pixels2samples(), samples2pixels(), selectionPosition(), and setZoomAndOffset().

---

The documentation for this class was generated from the following files:

• libgui/SignalView.h
• libgui/SignalView.cpp