KisTransportControls Class Reference

The KisTransportControls class provides a simple, reusable widget for common transport controls, including play/pause, stop, seek and skip. The client code will want to add this widget, configure it, and hook into the appropriate signals. More...

#include <kis_transport_controls.h>

Inheritance diagram for KisTransportControls:

Public Slots
void	setPlaying (bool playing)
	setPlaying flips the icon on the play/pause button. When playing, the button will show a pause icon. When paused, the button will show a play icon.
void	showSeekButtons (bool show)
void	showSkipButtons (bool show)
void	showStateButtons (bool show)

Signals
void	back ()
void	forward ()
void	playPause ()
void	skipBack ()
void	skipForward ()
void	stop ()

Public Member Functions
	KisTransportControls (QWidget *parent=nullptr)
QSize	sizeHint () const override
	~KisTransportControls ()

Private Attributes
QToolButton *	buttonBack
QToolButton *	buttonForward
QToolButton *	buttonPlayPause
QToolButton *	buttonSkipBack
QToolButton *	buttonSkipForward
QToolButton *	buttonStop

Detailed Description

The KisTransportControls class provides a simple, reusable widget for common transport controls, including play/pause, stop, seek and skip. The client code will want to add this widget, configure it, and hook into the appropriate signals.

Definition at line 23 of file kis_transport_controls.h.

Constructor & Destructor Documentation

KisTransportControls()

KisTransportControls::KisTransportControls

(

QWidget *

parent = nullptr

)

Definition at line 18 of file kis_transport_controls.cpp.

    : QWidget(parent)
{
    QHBoxLayout* layout = new QHBoxLayout(this);
    layout->setContentsMargins(0,0,0,0);
    layout->setSpacing(0);
 
    buttonSkipBack = new QToolButton(this);
    buttonSkipBack->setIcon(KisIconUtils::loadIcon("prevkeyframe"));
    buttonSkipBack->setToolTip(i18n("Skip Back"));
    buttonSkipBack->setIconSize(QSize(22, 22));
    buttonSkipBack->setFocusPolicy(Qt::NoFocus);
    buttonSkipBack->setAutoRaise(true);
    layout->addWidget(buttonSkipBack);
    connect(buttonSkipBack, SIGNAL(released()), this, SIGNAL(skipBack()));
 
    buttonBack = new QToolButton(this);
    buttonBack->setIcon(KisIconUtils::loadIcon("prevframe"));
    buttonBack->setToolTip(i18n("Back"));
    buttonBack->setIconSize(QSize(22, 22));
    buttonBack->setFocusPolicy(Qt::NoFocus);
    buttonBack->setAutoRaise(true);
    layout->addWidget(buttonBack);
    connect(buttonBack, SIGNAL(released()), this, SIGNAL(back()));
 
    buttonStop = new QToolButton(this);
    buttonStop->setIcon(KisIconUtils::loadIcon("animation_stop"));
    buttonStop->setToolTip(i18n("Stop"));
    buttonStop->setIconSize(QSize(22, 22));
    buttonStop->setFocusPolicy(Qt::NoFocus);
    buttonStop->setAutoRaise(true);
    layout->addWidget(buttonStop);
    connect(buttonStop, SIGNAL(released()), this, SIGNAL(stop()));
 
    buttonPlayPause = new QToolButton(this);
    buttonPlayPause->setIcon(KisIconUtils::loadIcon("animation_play"));
    buttonPlayPause->setToolTip(i18n("Play/Pause"));
    buttonPlayPause->setIconSize(QSize(22, 22));
    buttonPlayPause->setFocusPolicy(Qt::NoFocus);
    buttonPlayPause->setAutoRaise(true);
    layout->addWidget(buttonPlayPause);
    connect(buttonPlayPause, SIGNAL(released()), this, SIGNAL(playPause()));
 
    buttonForward = new QToolButton(this);
    buttonForward->setIcon(KisIconUtils::loadIcon("nextframe"));
    buttonForward->setToolTip(i18n("Forward"));
    buttonForward->setIconSize(QSize(22, 22));
    buttonForward->setFocusPolicy(Qt::NoFocus);
    buttonForward->setAutoRaise(true);
    layout->addWidget(buttonForward);
    connect(buttonForward, SIGNAL(released()), this, SIGNAL(forward()));
 
    buttonSkipForward = new QToolButton(this);
    buttonSkipForward->setIcon(KisIconUtils::loadIcon("nextkeyframe"));
    buttonSkipForward->setToolTip(i18n("Skip Forward"));
    buttonSkipForward->setIconSize(QSize(22, 22));
    buttonSkipForward->setFocusPolicy(Qt::NoFocus);
    buttonSkipForward->setAutoRaise(true);
    layout->addWidget(buttonSkipForward);
    connect(buttonSkipForward, SIGNAL(released()), this, SIGNAL(skipForward()));
 
    showStateButtons(true);
    showSeekButtons(true);
    showSkipButtons(false);
 
    setFocusPolicy(Qt::ClickFocus);
}

References back(), buttonBack, buttonForward, buttonPlayPause, buttonSkipBack, buttonSkipForward, buttonStop, connect(), forward(), KisIconUtils::loadIcon(), playPause(), showSeekButtons(), showSkipButtons(), showStateButtons(), skipBack(), skipForward(), and stop().

~KisTransportControls()

KisTransportControls::~KisTransportControls

(

)

Definition at line 86 of file kis_transport_controls.cpp.

{
}

Member Function Documentation

back

void KisTransportControls::back ( )

signal

forward

void KisTransportControls::forward ( )

signal

playPause

void KisTransportControls::playPause ( )

signal

setPlaying

void KisTransportControls::setPlaying ( bool playing )

slot

setPlaying flips the icon on the play/pause button. When playing, the button will show a pause icon. When paused, the button will show a play icon.

Definition at line 95 of file kis_transport_controls.cpp.

{
    if (playing) {
        buttonPlayPause->setIcon(KisIconUtils::loadIcon("animation_pause"));
    } else {
        buttonPlayPause->setIcon(KisIconUtils::loadIcon("animation_play"));
    }
}

References buttonPlayPause, and KisIconUtils::loadIcon().

showSeekButtons

void KisTransportControls::showSeekButtons ( bool show )

slot

Definition at line 115 of file kis_transport_controls.cpp.

{
    if (show) {
        buttonBack->show();
        buttonForward->show();
    } else {
        buttonBack->hide();
        buttonForward->hide();
    }
}

References buttonBack, and buttonForward.

showSkipButtons

void KisTransportControls::showSkipButtons ( bool show )

slot

Definition at line 126 of file kis_transport_controls.cpp.

{
    if (show) {
        buttonSkipBack->show();
        buttonSkipForward->show();
    } else {
        buttonSkipBack->hide();
        buttonSkipForward->hide();
    }
}

References buttonSkipBack, and buttonSkipForward.

showStateButtons

void KisTransportControls::showStateButtons ( bool show )

slot

Definition at line 104 of file kis_transport_controls.cpp.

{
    if (show) {
        buttonPlayPause->show();
        buttonStop->show();
    } else {
        buttonPlayPause->hide();
        buttonStop->hide();
    }
}

References buttonPlayPause, and buttonStop.

sizeHint()

QSize KisTransportControls::sizeHint ( ) const

override

Definition at line 90 of file kis_transport_controls.cpp.

{
    return QSize(32, 32);
}

skipBack

void KisTransportControls::skipBack ( )

signal

skipForward

void KisTransportControls::skipForward ( )

signal

stop

void KisTransportControls::stop ( )

signal

Member Data Documentation

buttonBack

QToolButton* KisTransportControls::buttonBack

private

Definition at line 55 of file kis_transport_controls.h.

buttonForward

QToolButton* KisTransportControls::buttonForward

private

Definition at line 58 of file kis_transport_controls.h.

buttonPlayPause

QToolButton* KisTransportControls::buttonPlayPause

private

Definition at line 57 of file kis_transport_controls.h.

buttonSkipBack

QToolButton* KisTransportControls::buttonSkipBack

private

Definition at line 54 of file kis_transport_controls.h.

buttonSkipForward

QToolButton* KisTransportControls::buttonSkipForward

private

Definition at line 59 of file kis_transport_controls.h.

buttonStop

QToolButton* KisTransportControls::buttonStop

private

Definition at line 56 of file kis_transport_controls.h.

---

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

• libs/ui/widgets/kis_transport_controls.h
• libs/ui/widgets/kis_transport_controls.cpp