Kwave::MultiStateWidget Class Reference

#include <MultiStateWidget.h>

Inheritance diagram for Kwave::MultiStateWidget:

Collaboration diagram for Kwave::MultiStateWidget:

Public Slots
void	setState (int newstate)
void	switchState (bool on)
void	nextState ()

Signals
void	clicked (int id)

Public Member Functions
	MultiStateWidget (QWidget *parent, int id)
virtual	~MultiStateWidget () Q_DECL_OVERRIDE
void	setID (int id)
void	addPixmap (const QString &filename)

Private Member Functions
virtual void	mouseReleaseEvent (QMouseEvent *) Q_DECL_OVERRIDE
virtual void	paintEvent (QPaintEvent *) Q_DECL_OVERRIDE

Private Attributes
int	m_current_index
int	m_identifier
QVector< QPixmap >	m_pixmaps

Detailed Description

Definition at line 36 of file MultiStateWidget.h.

Constructor & Destructor Documentation

MultiStateWidget()

Kwave::MultiStateWidget::MultiStateWidget	(	QWidget *	parent,
		int	id
	)

Constructor

Parameters

parent	the parent widget
id	identifier

Definition at line 32 of file MultiStateWidget.cpp.

    :QWidget(parent), m_current_index(0), m_identifier(id), m_pixmaps()
{
    resize(20, 20);
}

~MultiStateWidget()

Kwave::MultiStateWidget::~MultiStateWidget ( )

virtual

Destructor

Definition at line 39 of file MultiStateWidget.cpp.

References m_pixmaps.

{
    m_pixmaps.clear();
}

Member Function Documentation

addPixmap()

void Kwave::MultiStateWidget::addPixmap

(

const QString &

filename

)

Adds a the content of pixmap file as pixmap for the next state. The file is found through the KStandardDirs mechanism. Adding a file for a second or further time is not possible, in this case the pixmap will not be loaded and the return value will be the id of the existing version.

See also

KStandardDirs

Parameters

filename

name of the file to be added, without path.

Definition at line 51 of file MultiStateWidget.cpp.

References _, and m_pixmaps.

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

{
    QString pics_dir = _("pics");
    QString path = QStandardPaths::locate(
        QStandardPaths::AppDataLocation,
        pics_dir + QDir::separator() + filename,
        QStandardPaths::LocateFile);
    QPixmap newpix(path);
    m_pixmaps.append(newpix);
}

Here is the caller graph for this function:

clicked

void Kwave::MultiStateWidget::clicked ( int  id )

signal

Signals that the widget has changed it's state.

Parameters

id	identifier of this widget's instance

Referenced by nextState().

Here is the caller graph for this function:

mouseReleaseEvent()

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

privatevirtual

reacts to the mouse release (click)

Definition at line 83 of file MultiStateWidget.cpp.

References nextState().

{
    if (e && (e->button() == Qt::LeftButton)) {
        nextState();
    }
}

Here is the call graph for this function:

nextState

void Kwave::MultiStateWidget::nextState ( )

slot

advance to the next state, with wrap-around to zero

Definition at line 76 of file MultiStateWidget.cpp.

References clicked(), m_current_index, m_identifier, and setState().

Referenced by mouseReleaseEvent().

{
    setState(m_current_index + 1);
    emit clicked(m_identifier);
}

Here is the call graph for this function:

Here is the caller graph for this function:

paintEvent()

void Kwave::MultiStateWidget::paintEvent ( QPaintEvent *  )

privatevirtual

repaints the pixmap

Definition at line 91 of file MultiStateWidget.cpp.

References m_current_index, and m_pixmaps.

{
    QPainter p(this);
    p.drawPixmap(0, 0, m_pixmaps[m_current_index]);
}

setID()

void Kwave::MultiStateWidget::setID

(

int

id

)

Sets the number that will passed as argument to the "clicked" signal.

Parameters

id	new identifier

Definition at line 45 of file MultiStateWidget.cpp.

References m_identifier.

{
    m_identifier = id;
}

setState

void Kwave::MultiStateWidget::setState ( int  newstate )

slot

Activates a new state, with wrap-around on overflows, limited to [ 0 ... m_pixmaps.count()-1 ].

Parameters

newstate

index of the new state [0...N]

Definition at line 63 of file MultiStateWidget.cpp.

References m_current_index, and m_pixmaps.

Referenced by nextState(), and switchState().

{
    m_current_index = (state % m_pixmaps.count());
    repaint();
}

Here is the caller graph for this function:

switchState

void Kwave::MultiStateWidget::switchState ( bool  on )

slot

For widgets that have only two states (on and off), this selects state 1 or 0

Parameters

on	if true, switch on (state 1), otherwise switch off (state 0)

Definition at line 70 of file MultiStateWidget.cpp.

References setState().

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

{
    setState((on) ? 1 : 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_current_index

int Kwave::MultiStateWidget::m_current_index

private

index of the current state

Definition at line 111 of file MultiStateWidget.h.

Referenced by nextState(), paintEvent(), and setState().

m_identifier

int Kwave::MultiStateWidget::m_identifier

private

identifier used for the clicked() signal

Definition at line 114 of file MultiStateWidget.h.

Referenced by nextState(), and setID().

m_pixmaps

QVector<QPixmap> Kwave::MultiStateWidget::m_pixmaps

private

list of QPixmaps

Definition at line 117 of file MultiStateWidget.h.

Referenced by addPixmap(), paintEvent(), setState(), and ~MultiStateWidget().

---

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

• libgui/MultiStateWidget.h
• libgui/MultiStateWidget.cpp