KWin::EffectTogglableState Class Reference

#include <effecttogglablestate.h>

Inheritance diagram for KWin::EffectTogglableState:

Public Types
enum class	Status {   Inactive , Activating , Deactivating , Active ,   Stopped }

Signals
void	inProgressChanged ()
void	partialActivationFactorChanged ()
void	activated ()
void	deactivated ()
void	statusChanged (Status status)

Public Member Functions
	EffectTogglableState (Effect *parent)
bool	inProgress () const
void	setInProgress (bool gesture)
qreal	partialActivationFactor () const
void	setPartialActivationFactor (qreal factor)
QAction *	activateAction () const
QAction *	deactivateAction () const
QAction *	toggleAction () const
void	activate ()
void	deactivate ()
void	toggle ()
void	stop ()
void	setStatus (Status status)
Status	status () const

Protected Member Functions
std::function< void(qreal progress)>	progressCallback ()
std::function< void(qreal progress)>	regressCallback ()
void	setProgress (qreal progress)
void	setRegress (qreal regress)
	regress being the progress when on an active state

Friends
class	EffectTogglableGesture
class	EffectTogglableTouchBorder

Detailed Description

It's common to have effects that get activated and deactivated. This class helps us simplify this process, especially in the cases where we want activation to happen progressively, like through a touch our touchpad events.

Definition at line 24 of file effecttogglablestate.h.

Member Enumeration Documentation

Status

enum class KWin::EffectTogglableState::Status

strong

Enumerator
Inactive
Activating
Deactivating
Active
Stopped

Definition at line 28 of file effecttogglablestate.h.

Constructor & Destructor Documentation

EffectTogglableState()

KWin::EffectTogglableState::EffectTogglableState

(

Effect *

parent

)

Constructs the object, passes the effect as the parent.

Definition at line 13 of file effecttogglablestate.cpp.

Member Function Documentation

activate()

void KWin::EffectTogglableState::activate

(

)

Definition at line 44 of file effecttogglablestate.cpp.

activateAction()

QAction * KWin::EffectTogglableState::activateAction ( ) const

inline

Definition at line 49 of file effecttogglablestate.h.

activated

void KWin::EffectTogglableState::activated ( )

signal

deactivate()

void KWin::EffectTogglableState::deactivate

(

)

Definition at line 59 of file effecttogglablestate.cpp.

deactivateAction()

QAction * KWin::EffectTogglableState::deactivateAction ( ) const

inline

Definition at line 53 of file effecttogglablestate.h.

deactivated

void KWin::EffectTogglableState::deactivated ( )

signal

inProgress()

bool KWin::EffectTogglableState::inProgress

(

)

const

Definition at line 73 of file effecttogglablestate.cpp.

inProgressChanged

void KWin::EffectTogglableState::inProgressChanged ( )

signal

partialActivationFactor()

qreal KWin::EffectTogglableState::partialActivationFactor ( ) const

inline

Definition at line 43 of file effecttogglablestate.h.

partialActivationFactorChanged

void KWin::EffectTogglableState::partialActivationFactorChanged ( )

signal

progressCallback()

std::function< void(qreal progress)> KWin::EffectTogglableState::progressCallback ( )

protected

Definition at line 191 of file effecttogglablestate.cpp.

regressCallback()

std::function< void(qreal progress)> KWin::EffectTogglableState::regressCallback ( )

protected

Definition at line 198 of file effecttogglablestate.cpp.

setInProgress()

void KWin::EffectTogglableState::setInProgress

(

bool

gesture

)

Definition at line 78 of file effecttogglablestate.cpp.

setPartialActivationFactor()

void KWin::EffectTogglableState::setPartialActivationFactor

(

qreal

factor

)

Definition at line 51 of file effecttogglablestate.cpp.

setProgress()

void KWin::EffectTogglableState::setProgress ( qreal progress )

protected

Definition at line 123 of file effecttogglablestate.cpp.

setRegress()

void KWin::EffectTogglableState::setRegress ( qreal regress )

protected

regress being the progress when on an active state

Definition at line 140 of file effecttogglablestate.cpp.

setStatus()

void KWin::EffectTogglableState::setStatus

(

Status

status

)

Definition at line 86 of file effecttogglablestate.cpp.

status()

Status KWin::EffectTogglableState::status ( ) const

inline

Definition at line 67 of file effecttogglablestate.h.

statusChanged

void KWin::EffectTogglableState::statusChanged ( Status status )

signal

stop()

void KWin::EffectTogglableState::stop

(

)

Definition at line 66 of file effecttogglablestate.cpp.

toggle()

void KWin::EffectTogglableState::toggle

(

)

Definition at line 112 of file effecttogglablestate.cpp.

toggleAction()

QAction * KWin::EffectTogglableState::toggleAction ( ) const

inline

Definition at line 57 of file effecttogglablestate.h.

Friends And Related Symbol Documentation

EffectTogglableGesture

friend class EffectTogglableGesture

friend

Definition at line 98 of file effecttogglablestate.h.

EffectTogglableTouchBorder

friend class EffectTogglableTouchBorder

friend

Definition at line 99 of file effecttogglablestate.h.

---

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

• src/effect/effecttogglablestate.h
• src/effect/effecttogglablestate.cpp