Kwave::LabelItem Class Reference

#include <LabelItem.h>

Inheritance diagram for Kwave::LabelItem:

Collaboration diagram for Kwave::LabelItem:

Public Member Functions
	LabelItem (Kwave::SignalView &view, Kwave::SignalManager &signal_manager, unsigned int index, const Kwave::Label &label)
virtual	~LabelItem () Q_DECL_OVERRIDE
virtual Kwave::ViewItem::Flags	flags () const Q_DECL_OVERRIDE
virtual QString	toolTip (sample_index_t &ofs) Q_DECL_OVERRIDE
virtual void	appendContextMenu (QMenu *parent) Q_DECL_OVERRIDE
virtual QCursor	mouseCursor () const Q_DECL_OVERRIDE
virtual void	moveTo (const QPoint &mouse_pos) Q_DECL_OVERRIDE
virtual void	done () Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::ViewItem
	ViewItem (Kwave::SignalView &view, Kwave::SignalManager &signal_manager)
virtual	~ViewItem ()
virtual void	startDragging ()

Private Slots
void	contextMenuLabelDelete ()
void	contextMenuLabelProperties ()

Private Attributes
unsigned int	m_index
sample_index_t	m_initial_pos
sample_index_t	m_current_pos
QString	m_description
Kwave::UndoTransactionGuard *	m_undo_transaction

Additional Inherited Members
Public Types inherited from Kwave::ViewItem
enum	Flag { None = 0, CanGrabAndMove = 1, CanDragAndDrop = 2 }
Signals inherited from Kwave::ViewItem
void	sigCommand (const QString &command)
Protected Attributes inherited from Kwave::ViewItem
Kwave::SignalView &	m_view
Kwave::SignalManager &	m_signal_manager

Detailed Description

Definition at line 39 of file LabelItem.h.

Constructor & Destructor Documentation

LabelItem()

Kwave::LabelItem::LabelItem	(	Kwave::SignalView &	view,
		Kwave::SignalManager &	signal_manager,
		unsigned int	index,
		const Kwave::Label &	label
	)

Constructor

Parameters

view	the owner (SignalView)
signal_manager	the corresponding SignalManager
index	the one-based index of the label
label	reference to the label

Definition at line 37 of file LabelItem.cpp.

    :Kwave::ViewItem(view, signal_manager),
     m_index(index),
     m_initial_pos(label.pos()),
     m_current_pos(label.pos()),
     m_description(label.name()),
     m_undo_transaction(Q_NULLPTR)
{
}

~LabelItem()

Kwave::LabelItem::~LabelItem ( )

virtual

Destructor

Definition at line 51 of file LabelItem.cpp.

References Kwave::UndoTransactionGuard::abort(), and m_undo_transaction.

{
    if (m_undo_transaction) {
        // restore the previous data
        qDebug("Kwave::LabelItem::~LabelItem() -> aborted -> reverting!");
        m_undo_transaction->abort();
        delete m_undo_transaction;
        m_undo_transaction = Q_NULLPTR;
    }
}

Here is the call graph for this function:

Member Function Documentation

appendContextMenu()

void Kwave::LabelItem::appendContextMenu ( QMenu *  parent )

virtual

Called to append entries to a context menu.

Parameters

parent

context menu to add items

Reimplemented from Kwave::ViewItem.

Definition at line 86 of file LabelItem.cpp.

References _, contextMenuLabelDelete(), and contextMenuLabelProperties().

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

    // locate the "label" menu
    QMenu *label_menu = Q_NULLPTR;
    foreach (const QAction *action, parent->actions()) {
        if (action->text() == i18n("Label")) {
            label_menu = action->menu();
            break;
        }
    }

    // the context menu of a label has been activated
    if (label_menu) {

        // find the "New" action and disable it
        foreach (QAction *action, label_menu->actions()) {
            if (action->text() == i18n("New")) {
                action->setEnabled(false);
                break;
            }
        }

        QAction *action_label_delete = label_menu->addAction(
            QIcon::fromTheme(_("list-remove")),
            i18n("&Delete"), this, SLOT(contextMenuLabelDelete()));
        Q_ASSERT(action_label_delete);
        if (!action_label_delete) return;

        QAction *action_label_properties = label_menu->addAction(
            QIcon::fromTheme(_("configure")),
            i18n("&Properties..."), this, SLOT(contextMenuLabelProperties()));
        Q_ASSERT(action_label_properties);
        if (!action_label_properties) return;
    }

}

Here is the call graph for this function:

contextMenuLabelDelete

void Kwave::LabelItem::contextMenuLabelDelete ( )

privateslot

context menu: "label / delete"

Definition at line 127 of file LabelItem.cpp.

References _, m_index, and Kwave::ViewItem::sigCommand().

Referenced by appendContextMenu().

{
    emit sigCommand(_("label:delete(%1)").arg(m_index));
}

Here is the caller graph for this function:

contextMenuLabelProperties

void Kwave::LabelItem::contextMenuLabelProperties ( )

privateslot

context menu: "label / properties..."

Definition at line 133 of file LabelItem.cpp.

References _, m_index, and Kwave::ViewItem::sigCommand().

Referenced by appendContextMenu().

{
    emit sigCommand(_("nomacro:label:edit(%1)").arg(m_index));
}

Here is the caller graph for this function:

done()

void Kwave::LabelItem::done ( )

virtual

Called when leaving the move mode, when the mouse button has been released.

Reimplemented from Kwave::ViewItem.

Definition at line 184 of file LabelItem.cpp.

References Kwave::UndoTransactionGuard::abort(), m_current_pos, m_initial_pos, and m_undo_transaction.

{
    if (m_undo_transaction) {
        // close the undo transaction (regularly, with undo action)
        if (m_current_pos == m_initial_pos)
            m_undo_transaction->abort();
        delete m_undo_transaction;
        m_undo_transaction = Q_NULLPTR;
    }
}

Here is the call graph for this function:

flags()

Kwave::ViewItem::Flags Kwave::LabelItem::flags ( ) const

virtual

Returns flags describing the possible interactions with this object

See also

Kwave::ViewItem::Flags

Reimplemented from Kwave::ViewItem.

Definition at line 63 of file LabelItem.cpp.

References Kwave::ViewItem::CanGrabAndMove.

{
    return Kwave::ViewItem::CanGrabAndMove;
}

mouseCursor()

QCursor Kwave::LabelItem::mouseCursor ( ) const

virtual

Returns a mouse cursor used when moving the item

Reimplemented from Kwave::ViewItem.

Definition at line 139 of file LabelItem.cpp.

{
    return Qt::SizeHorCursor;
}

moveTo()

void Kwave::LabelItem::moveTo ( const QPoint &  mouse_pos )

virtual

handles updates when being moved with the mouse

Parameters

mouse_pos

position of the mouse, in pixel coordinates relative to the parent widget

Reimplemented from Kwave::ViewItem.

Definition at line 145 of file LabelItem.cpp.

References Kwave::SignalManager::findLabel(), Kwave::MetaData::isNull(), Kwave::SignalManager::labelIndex(), m_current_pos, m_description, m_index, m_initial_pos, Kwave::ViewItem::m_signal_manager, m_undo_transaction, Kwave::ViewItem::m_view, Kwave::SignalManager::modifyLabel(), Kwave::SignalView::offset(), Kwave::SignalView::pixels2samples(), Kwave::Label::pos(), and Kwave::UndoTransactionGuard::registerUndoAction().

{
    const sample_index_t new_pos = m_view.offset() +
                                   m_view.pixels2samples(mouse_pos.x());

    Kwave::Label label = m_signal_manager.findLabel(new_pos);
    if (label.isNull()) {

        // this is the first move ?
        if (!m_undo_transaction) {
            // there probably will be something to undo later
            // create an undo transaction guard
            m_undo_transaction = new(std::nothrow)
                Kwave::UndoTransactionGuard(
                    m_signal_manager, i18n("Move Label"));
            Q_ASSERT(m_undo_transaction);
            if (!m_undo_transaction) return;

            // save the previous label data for undo
            Kwave::Label lbl = m_signal_manager.findLabel(m_initial_pos);
            if (!m_undo_transaction->registerUndoAction(new(std::nothrow)
                UndoModifyMetaDataAction(Kwave::MetaDataList(lbl)))) {
                qWarning("Kwave::LabelItem::done(): saving undo data failed!");
                return;
            }
        }

        if (m_signal_manager.modifyLabel(m_index, new_pos,
                                         m_description, false)) {
            Kwave::Label lbl = m_signal_manager.findLabel(new_pos);
            if (!lbl.isNull()) {
                m_index       = m_signal_manager.labelIndex(lbl);
                m_current_pos = lbl.pos();
            }
        }
    }
}

Here is the call graph for this function:

toolTip()

QString Kwave::LabelItem::toolTip ( sample_index_t &  ofs )

virtual

Can be overwritten to return a tooltip.

Parameters

ofs	sample index the tooltip should refer to (unused)

Returns

an already localized tooltip

Reimplemented from Kwave::ViewItem.

Definition at line 69 of file LabelItem.cpp.

References _, m_current_pos, m_description, m_index, Kwave::ViewItem::m_view, Kwave::ms2hms(), and Kwave::SignalView::samples2ms().

{
    Q_UNUSED(ofs);

    QString description = (m_description.length()) ?
        i18nc("tooltip of a label, %1=index, %2=description/name",
                "Label #%1 (%2)", m_index, m_description) :
        i18nc("tooltip of a label, without description, %1=index",
                "Label #%1", m_index);

    QString hms = Kwave::ms2hms(m_view.samples2ms(m_current_pos));
    QString tip = _("%1\n%2\n%3").arg(description).arg(m_current_pos).arg(hms);

    return tip;
}

Here is the call graph for this function:

Member Data Documentation

m_current_pos

sample_index_t Kwave::LabelItem::m_current_pos

private

current position of the label, in samples

Definition at line 113 of file LabelItem.h.

Referenced by done(), moveTo(), and toolTip().

m_description

QString Kwave::LabelItem::m_description

private

description of the label

Definition at line 116 of file LabelItem.h.

Referenced by moveTo(), and toolTip().

m_index

unsigned int Kwave::LabelItem::m_index

private

index of the label

Definition at line 107 of file LabelItem.h.

Referenced by contextMenuLabelDelete(), contextMenuLabelProperties(), moveTo(), and toolTip().

m_initial_pos

sample_index_t Kwave::LabelItem::m_initial_pos

private

initial position of the label, in samples

Definition at line 110 of file LabelItem.h.

Referenced by done(), and moveTo().

m_undo_transaction

Kwave::UndoTransactionGuard* Kwave::LabelItem::m_undo_transaction

private

used when we are within a undo transaction (we started)

Definition at line 119 of file LabelItem.h.

Referenced by done(), moveTo(), and ~LabelItem().

---

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

• libgui/LabelItem.h
• libgui/LabelItem.cpp