Kwave::Selection Class Reference

#include <Selection.h>

Inheritance diagram for Kwave::Selection:

Collaboration diagram for Kwave::Selection:

Signals
void	changed (sample_index_t offset, sample_index_t length)

Public Member Functions
	Selection (sample_index_t offset, sample_index_t length)
	Selection (const Selection &other)
virtual	~Selection ()
void	select (sample_index_t offset, sample_index_t length)
void	clear ()
sample_index_t	offset () const
sample_index_t	length () const
sample_index_t	first () const
sample_index_t	last () const
bool	operator== (const Selection &other) const
Selection &	operator= (const Selection &source)

Private Attributes
sample_index_t	m_offset
sample_index_t	m_length

Detailed Description

Definition at line 31 of file Selection.h.

Constructor & Destructor Documentation

Selection() [1/2]

Kwave::Selection::Selection	(	sample_index_t	offset,
		sample_index_t	length
	)

constructor.

Parameters

offset	index of the first item
length	number of items

Definition at line 21 of file Selection.cpp.

    :QObject(), m_offset(offset), m_length(length)
{
}

Selection() [2/2]

Kwave::Selection::Selection

(

const Selection &

other

)

copy constructor

Definition at line 27 of file Selection.cpp.

    :QObject(), m_offset(other.offset()), m_length(other.length())
{
}

~Selection()

Kwave::Selection::~Selection ( )

virtual

Destructor

Definition at line 33 of file Selection.cpp.

{
}

Member Function Documentation

changed

void Kwave::Selection::changed ( sample_index_t  offset, sample_index_t  length  )

signal

Emits a change in the selected range.

Parameters

offset	index of the first selected items
length	number of selected items

Referenced by select().

Here is the caller graph for this function:

clear()

void Kwave::Selection::clear ( )

inline

Clears the selection (0 samples at offset 0)

Definition at line 56 of file Selection.h.

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

                            {
            select(0, 0);
        }

Here is the caller graph for this function:

first()

sample_index_t Kwave::Selection::first ( ) const

inline

Equal to offset().

Definition at line 71 of file Selection.h.

Referenced by Kwave::SignalView::dragMoveEvent(), Kwave::SignalManager::executeCommand(), Kwave::MainWidget::executeCommand(), Kwave::TrackView::findItem(), Kwave::SignalView::mousePressEvent(), Kwave::MultiTrackWriter::MultiTrackWriter(), Kwave::TrackView::paintEvent(), Kwave::SelectionBorderItem::SelectionBorderItem(), Kwave::SignalView::selectionPosition(), Kwave::PluginManager::selectionStart(), Kwave::PlaybackController::startDevicePlayBack(), and Kwave::SelectionItem::startDragging().

                                            {
            return offset();
        }

Here is the caller graph for this function:

last()

sample_index_t Kwave::Selection::last ( ) const

inline

Returns the index of the last selected item.

Definition at line 76 of file Selection.h.

Referenced by Kwave::SignalView::dragMoveEvent(), Kwave::SignalManager::executeCommand(), Kwave::MainWidget::executeCommand(), Kwave::TrackView::findItem(), Kwave::SignalView::mousePressEvent(), Kwave::MultiTrackWriter::MultiTrackWriter(), Kwave::TrackView::paintEvent(), Kwave::SelectionBorderItem::SelectionBorderItem(), Kwave::PluginManager::selectionEnd(), Kwave::SignalView::selectionPosition(), Kwave::PlaybackController::startDevicePlayBack(), and Kwave::SelectionItem::startDragging().

                                           {
            return m_offset + (m_length ? (m_length-1) : 0);
        }

Here is the caller graph for this function:

length()

sample_index_t Kwave::Selection::length ( ) const

inline

Returns the number of selected items.

Definition at line 66 of file Selection.h.

Referenced by Kwave::SignalWidget::contextMenuEvent(), Kwave::SignalManager::executeCommand(), Kwave::MainWidget::executeCommand(), Kwave::TrackView::findItem(), operator=(), operator==(), Kwave::SignalManager::save(), select(), Kwave::SelectionItem::startDragging(), Kwave::UndoSelection::store(), Kwave::UndoSelection::undo(), Kwave::SignalManager::undo(), Kwave::ZoomToolBar::updateToolbar(), Kwave::TopWidget::updateToolbar(), and Kwave::MainWidget::zoomSelection().

                                             {
            return m_length;
        }

Here is the caller graph for this function:

offset()

sample_index_t Kwave::Selection::offset ( ) const

inline

Returns the index of the first selected item.

Definition at line 61 of file Selection.h.

Referenced by Kwave::SignalManager::executeCommand(), operator=(), operator==(), Kwave::SignalManager::save(), select(), Kwave::UndoSelection::store(), Kwave::UndoSelection::undo(), Kwave::SignalManager::undo(), and Kwave::MainWidget::zoomSelection().

                                             {
            return m_offset;
        }

Here is the caller graph for this function:

operator=()

Selection& Kwave::Selection::operator= ( const Selection &  source )

inline

Assignment operator

Definition at line 87 of file Selection.h.

References length(), and offset().

                                                         {
            m_offset = source.offset();
            m_length = source.length();
            return *this;
        }

Here is the call graph for this function:

operator==()

bool Kwave::Selection::operator== ( const Selection &  other ) const

inline

compare operator

Definition at line 81 of file Selection.h.

References length(), and offset().

                                                        {
            return ((m_offset == other.offset()) &&
                    (m_length == other.length()));
        }

Here is the call graph for this function:

select()

void Kwave::Selection::select	(	sample_index_t	offset,
		sample_index_t	length
	)

Sets a new offset and length.

Parameters

offset	index of the first item
length	number of items

Definition at line 38 of file Selection.cpp.

References changed(), length(), m_length, m_offset, and offset().

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

{
    m_offset = offset;
    m_length = length;
    emit changed(m_offset, m_length);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_length

sample_index_t Kwave::Selection::m_length

private

number of items

Definition at line 107 of file Selection.h.

Referenced by select().

m_offset

sample_index_t Kwave::Selection::m_offset

private

index of the first selected item

Definition at line 104 of file Selection.h.

Referenced by select().

---

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

• libkwave/Selection.h
• libkwave/Selection.cpp