Kwave::Label Class Reference

#include <Label.h>

Inheritance diagram for Kwave::Label:

Collaboration diagram for Kwave::Label:

Public Member Functions
	Label ()
	Label (const Kwave::MetaData &meta_data)
	Label (sample_index_t position, const QString &name)
virtual	~Label ()
virtual void	moveTo (sample_index_t position)
virtual sample_index_t	pos () const
virtual void	rename (const QString &name)
virtual QString	name () const
bool	operator< (const Kwave::Label &other) const
bool	operator== (const Kwave::Label &other) const
Public Member Functions inherited from Kwave::MetaData
	MetaData ()
	MetaData (const MetaData &other)
	MetaData (Scope scope)
virtual	~MetaData ()
virtual void	clear ()
virtual bool	isNull () const
QString	id () const
Scope	scope () const
void	setScope (Scope scope)
void	setProperty (const QString &p, const QVariant &value)
bool	hasProperty (const QString &p) const
QVariant	property (const QString &p) const
QVariant	operator[] (const QString p) const
QVariant &	property (const QString &p)
QVariant &	operator[] (const QString p)
bool	operator== (const MetaData &other) const
bool	operator!= (const MetaData &other) const
QStringList	keys () const
sample_index_t	firstSample () const
sample_index_t	lastSample () const
QList< unsigned int >	boundTracks () const
virtual void	dump () const

Static Public Member Functions
static QString	metaDataType ()
Static Public Member Functions inherited from Kwave::MetaData
static QStringList	positionBoundPropertyNames ()

Additional Inherited Members
Public Types inherited from Kwave::MetaData
enum	Scope {   None = 0, Signal = (1 << 0), Track = (1 << 1), Range = (1 << 2),   Position = (1 << 3), All = ~0 }
typedef QMap< QString, QVariant >	PropertyList
Static Public Attributes inherited from Kwave::MetaData
static const QString	STDPROP_TYPE
static const QString	STDPROP_TRACKS
static const QString	STDPROP_START
static const QString	STDPROP_END
static const QString	STDPROP_POS
static const QString	STDPROP_DESCRIPTION

Detailed Description

Definition at line 34 of file Label.h.

Constructor & Destructor Documentation

Label() [1/3]

Kwave::Label::Label

(

)

Default constructor, creates an empty label

Definition at line 22 of file Label.cpp.

    :Kwave::MetaData() // must be empty, isNull() should return true
{
}

Label() [2/3]

Kwave::Label::Label ( const Kwave::MetaData &  meta_data )

explicit

Constructor, takes over the identity of a MetaData object

Parameters

meta_data

reference to a meta data object

Definition at line 28 of file Label.cpp.

    :Kwave::MetaData(meta_data)
{
}

Label() [3/3]

Kwave::Label::Label	(	sample_index_t	position,
		const QString &	name
	)

Constructor

Parameters

position	the label position [samples]
name	the name of the label, user defined

Definition at line 34 of file Label.cpp.

References metaDataType(), Kwave::MetaData::setProperty(), Kwave::MetaData::STDPROP_DESCRIPTION, Kwave::MetaData::STDPROP_POS, and Kwave::MetaData::STDPROP_TYPE.

    :Kwave::MetaData(Kwave::MetaData::Position)
{
    setProperty(Kwave::MetaData::STDPROP_TYPE, metaDataType());
    setProperty(Kwave::MetaData::STDPROP_POS, position);
    if (name.length())
        setProperty(Kwave::MetaData::STDPROP_DESCRIPTION, name);
}

Here is the call graph for this function:

~Label()

Kwave::Label::~Label ( )

virtual

destructor

Definition at line 44 of file Label.cpp.

{
}

Member Function Documentation

metaDataType()

static QString Kwave::Label::metaDataType ( )

inlinestatic

returns the identifier of the "type" of this meta data object

Definition at line 59 of file Label.h.

References _, and name.

Referenced by Label(), Kwave::LabelList::LabelList(), moveTo(), and rename().

{ return _("Label"); }

Here is the caller graph for this function:

moveTo()

void Kwave::Label::moveTo ( sample_index_t  position )

virtual

Set a new position of the label

Parameters

position

the new position [samples]

Definition at line 49 of file Label.cpp.

References Kwave::MetaData::isNull(), metaDataType(), Kwave::MetaData::setProperty(), Kwave::MetaData::STDPROP_POS, and Kwave::MetaData::STDPROP_TYPE.

Referenced by Kwave::MainWidget::labelProperties(), and Kwave::SignalManager::modifyLabel().

{
    if (isNull()) setProperty(Kwave::MetaData::STDPROP_TYPE, metaDataType());
    setProperty(Kwave::MetaData::STDPROP_POS, position);
}

Here is the call graph for this function:

Here is the caller graph for this function:

name()

QString Kwave::Label::name ( ) const

virtual

returns the name of the string

Definition at line 74 of file Label.cpp.

References Kwave::MetaData::property(), and Kwave::MetaData::STDPROP_DESCRIPTION.

Referenced by Kwave::AsciiEncoder::encode(), Kwave::MainWidget::labelProperties(), operator==(), Kwave::MainWidget::saveLabels(), Kwave::SaveBlocksPlugin::scanBlocksToSave(), Kwave::K3BExportPlugin::scanBlocksToSave(), Kwave::TopWidget::updateMenu(), and Kwave::WavEncoder::writeLabels().

{
    return property(Kwave::MetaData::STDPROP_DESCRIPTION).toString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator<()

bool Kwave::Label::operator< ( const Kwave::Label &  other ) const

inline

less-than operator, needed for sorting the list

Definition at line 80 of file Label.h.

References pos().

                                                               {
            return (pos() < other.pos());
        }

Here is the call graph for this function:

operator==()

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

inline

equal operator

Definition at line 85 of file Label.h.

References name(), name, and pos().

                                                                {
            return ((pos() == other.pos()) && (name() == other.name()));
        }

Here is the call graph for this function:

pos()

sample_index_t Kwave::Label::pos ( ) const

virtual

Returns the label's position [samples]

Definition at line 56 of file Label.cpp.

References Kwave::MetaData::property(), and Kwave::MetaData::STDPROP_POS.

Referenced by Kwave::OverViewWidget::calculateBitmap(), Kwave::AsciiEncoder::encode(), Kwave::SignalManager::executeCommand(), Kwave::TrackView::findItem(), Kwave::SignalManager::findLabel(), Kwave::MainWidget::labelProperties(), Kwave::SignalManager::modifyLabel(), Kwave::LabelItem::moveTo(), Kwave::LabelList::nextLabelLeft(), Kwave::LabelList::nextLabelRight(), operator<(), operator==(), Kwave::TrackView::paintEvent(), Kwave::MainWidget::saveLabels(), Kwave::SaveBlocksPlugin::scanBlocksToSave(), Kwave::K3BExportPlugin::scanBlocksToSave(), Kwave::SaveBlocksPlugin::start(), and Kwave::WavEncoder::writeLabels().

{
    return static_cast<sample_index_t>(
        property(Kwave::MetaData::STDPROP_POS).toULongLong()
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

rename()

void Kwave::Label::rename ( const QString &  name )

virtual

change the name of the label

Parameters

name	the new name, user defined

Definition at line 64 of file Label.cpp.

References Kwave::MetaData::isNull(), metaDataType(), Kwave::MetaData::setProperty(), Kwave::MetaData::STDPROP_DESCRIPTION, and Kwave::MetaData::STDPROP_TYPE.

Referenced by Kwave::MainWidget::labelProperties(), and Kwave::SignalManager::modifyLabel().

{
    if (isNull()) setProperty(Kwave::MetaData::STDPROP_TYPE, metaDataType());
    if (name.length())
        setProperty(Kwave::MetaData::STDPROP_DESCRIPTION, name);
    else
        setProperty(Kwave::MetaData::STDPROP_DESCRIPTION, QVariant());
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• libkwave/Label.h
• libkwave/Label.cpp