Kwave::ClipBoard Class Reference

#include <ClipBoard.h>

Inheritance diagram for Kwave::ClipBoard:

Collaboration diagram for Kwave::ClipBoard:

Public Slots
void	slotChanged (QClipboard::Mode mode)

Signals
void	clipboardChanged (bool data_available)

Public Member Functions
	ClipBoard ()
virtual	~ClipBoard ()
void	copy (QWidget *widget, Kwave::SignalManager &signal_manager, const QList< unsigned int > &track_list, sample_index_t offset, sample_index_t length)
bool	paste (QWidget *widget, Kwave::SignalManager &signal_manager, sample_index_t offset, sample_index_t length)
void	clear ()
bool	isEmpty ()

Static Public Member Functions
static ClipBoard &	instance ()

Private Attributes
unsigned int	m_tracks

Detailed Description

Implements a global clipboard for Kwave. It supports only the three simple operations put, get and clear.

Definition at line 41 of file ClipBoard.h.

Constructor & Destructor Documentation

ClipBoard()

Kwave::ClipBoard::ClipBoard

(

)

Constructor.

Definition at line 45 of file ClipBoard.cpp.

    :m_tracks(0)
{
}

~ClipBoard()

Kwave::ClipBoard::~ClipBoard ( )

virtual

Destructor

Definition at line 51 of file ClipBoard.cpp.

{
    // clear() must have been before, e.g. in the application's destructor !
}

Member Function Documentation

clear()

void Kwave::ClipBoard::clear

(

)

Clears the internal buffers. The clipboard will be empty after this function returns and the sample rate will be set to zero.

Definition at line 124 of file ClipBoard.cpp.

Referenced by Kwave::SignalManager::executeCommand().

{
    QApplication::clipboard()->clear();
}

Here is the caller graph for this function:

clipboardChanged

void Kwave::ClipBoard::clipboardChanged ( bool  data_available )

signal

Emitted whenever the clipboard has changed from empty to non-empty (with decodeable data) or vice versa.

Parameters

data_available

if true: contains decodeable data, if false: nothing decodeable or empty

Referenced by slotChanged().

Here is the caller graph for this function:

copy()

void Kwave::ClipBoard::copy	(	QWidget *	widget,
		Kwave::SignalManager &	signal_manager,
		const QList< unsigned int > &	track_list,
		sample_index_t	offset,
		sample_index_t	length
	)

Discards the current content of the clipboard and fills it with a selected range of samples from a set of tracks.

Parameters

widget	the widget used as parent for displaying error messages
signal_manager	the SignalManager with the tracks to read from
track_list	a list of indices of tracks for reading
offset	first sample to copy
length	number of samples

Definition at line 69 of file ClipBoard.cpp.

References Kwave::MimeData::clear(), Kwave::MimeData::encode(), Kwave::SignalManager::metaData(), and Kwave::SinglePassForward.

Referenced by Kwave::SignalManager::executeCommand().

{
    // break if nothing to do
    if (!length || !track_list.count()) return;

    // get a buffer, implemented as a KwaveMimeData container
    Kwave::MimeData *buffer = new(std::nothrow) Kwave::MimeData();
    Q_ASSERT(buffer);
    if (!buffer) return;

    // encode into the mime data container
    Kwave::MultiTrackReader src(Kwave::SinglePassForward, signal_manager,
        track_list, offset, offset + length - 1);

    if (!buffer->encode(widget, src, signal_manager.metaData())) {
        // encoding failed, reset to empty
        buffer->clear();
        delete buffer;
        return;
    }

    // give the buffer to the KDE clipboard
    qApp->processEvents();
    QApplication::clipboard()->setMimeData(buffer, QClipboard::Clipboard);
}

Here is the call graph for this function:

Here is the caller graph for this function:

instance()

Kwave::ClipBoard & Kwave::ClipBoard::instance ( )

static

returns the static instance of the clipboard

Definition at line 39 of file ClipBoard.cpp.

References g_clipboard.

Referenced by Kwave::App::App(), Kwave::SignalWidget::contextMenuEvent(), Kwave::SignalManager::executeCommand(), Kwave::TopWidget::init(), and Kwave::TopWidget::updateMenu().

{
    return g_clipboard;
}

Here is the caller graph for this function:

isEmpty()

bool Kwave::ClipBoard::isEmpty

(

)

Returns true if the buffer is empty.

Definition at line 130 of file ClipBoard.cpp.

References Kwave::CodecManager::canDecode().

Referenced by Kwave::SignalManager::executeCommand(), paste(), slotChanged(), and Kwave::TopWidget::updateMenu().

{
    const QMimeData *mime_data =
        QApplication::clipboard()->mimeData(QClipboard::Clipboard);

    // no mime data -> empty
    if (!mime_data) return true;

    // there is a format that we can decode -> not empty
    foreach (const QString &format, mime_data->formats())
        if (Kwave::CodecManager::canDecode(format)) return false;

    // nothing to decode -> empty
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

paste()

bool Kwave::ClipBoard::paste	(	QWidget *	widget,
		Kwave::SignalManager &	signal_manager,
		sample_index_t	offset,
		sample_index_t	length
	)

Transfers all stored data from the clipboard into a SignalManager.

Parameters

widget	the widget used as parent for displaying error messages
signal_manager	the SignalManager with the tracks to write to
offset	sample position where to paste
length	length of the current selection in samples

Returns

true if successful, false if failed

Definition at line 99 of file ClipBoard.cpp.

References Kwave::MimeData::decode(), Kwave::SignalManager::deleteRange(), isEmpty(), and Kwave::SignalManager::selectRange().

Referenced by Kwave::SignalManager::executeCommand().

{
    Q_ASSERT(!isEmpty());
    if (isEmpty()) return false; // clipboard is empty ?

    // delete the current selection (with undo)
    if (length <= 1) length = 0; // do not paste single samples !
    if (length && !signal_manager.deleteRange(offset, length))
        return false;

    sample_index_t decoded_samples = Kwave::MimeData::decode(
        widget,
        QApplication::clipboard()->mimeData(QClipboard::Clipboard),
        signal_manager,
        offset);
    if (!decoded_samples) return false;

    // set the selection to the inserted range
    signal_manager.selectRange(offset, decoded_samples);
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

slotChanged

void Kwave::ClipBoard::slotChanged ( QClipboard::Mode  mode )

slot

emits clipboardChanged() whenever the clipboard has changed from empty to filled (with decodeable data) or vice versa (connected to the Qt clipboard)

Definition at line 57 of file ClipBoard.cpp.

References clipboardChanged(), and isEmpty().

{
    if (mode != QClipboard::Clipboard) return;
    bool data_available = !isEmpty();

//     qDebug("=> ClipBoard::clipboardChanged(%s)",
//      data_available ? "FULL" : "EMPTY");

    emit clipboardChanged(data_available);
}

Here is the call graph for this function:

Member Data Documentation

m_tracks

unsigned int Kwave::ClipBoard::m_tracks

private

number of tracks of the content

Definition at line 115 of file ClipBoard.h.

---

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

• libkwave/ClipBoard.h
• libkwave/ClipBoard.cpp