KWin
Loading...
Searching...
No Matches
Public Slots | Signals | Public Member Functions | Properties | List of all members
KWin::OverviewEffect Class Reference

#include <overvieweffect.h>

Inheritance diagram for KWin::OverviewEffect:
KWin::QuickSceneEffect KWin::Effect

Public Slots

void activate ()
 
void deactivate ()
 
- Public Slots inherited from KWin::Effect

Signals

void animationDurationChanged ()
 
void layoutChanged ()
 
void overviewPartialActivationFactorChanged ()
 
void overviewGestureInProgressChanged ()
 
void transitionPartialActivationFactorChanged ()
 
void transitionGestureInProgressChanged ()
 
void gridPartialActivationFactorChanged ()
 
void gridGestureInProgressChanged ()
 
void ignoreMinimizedChanged ()
 
void filterWindowsChanged ()
 
void organizedGridChanged ()
 
void desktopOffsetChanged ()
 
void searchTextChanged ()
 
- Signals inherited from KWin::QuickSceneEffect
void itemDraggedOutOfScreen (QQuickItem *item, QList< Output * > screens)
 
void itemDroppedOutOfScreen (const QPointF &globalPos, QQuickItem *item, Output *screen)
 
void activeViewChanged (KWin::QuickSceneView *view)
 
void delegateChanged ()
 

Public Member Functions

 OverviewEffect ()
 
 ~OverviewEffect () override
 
int layout () const
 
void setLayout (int layout)
 
bool ignoreMinimized () const
 
bool organizedGrid () const
 
bool filterWindows () const
 
void setFilterWindows (bool filterWindows)
 
int animationDuration () const
 
void setAnimationDuration (int duration)
 
qreal overviewPartialActivationFactor () const
 
bool overviewGestureInProgress () const
 
qreal transitionPartialActivationFactor () const
 
bool transitionGestureInProgress () const
 
qreal gridPartialActivationFactor () const
 
bool gridGestureInProgress () const
 
QPointF desktopOffset () const
 
int requestedEffectChainPosition () const override
 
bool borderActivated (ElectricBorder border) override
 
void reconfigure (ReconfigureFlags flags) override
 
void grabbedKeyboardEvent (QKeyEvent *keyEvent) override
 
Q_INVOKABLE void swapDesktops (KWin::VirtualDesktop *from, KWin::VirtualDesktop *to)
 
- Public Member Functions inherited from KWin::QuickSceneEffect
 QuickSceneEffect (QObject *parent=nullptr)
 
 ~QuickSceneEffect () override
 
bool isRunning () const
 
void setRunning (bool running)
 
QuickSceneView * activeView () const
 
Q_INVOKABLE QuickSceneView * viewForScreen (Output *screen) const
 
Q_INVOKABLE QuickSceneView * viewAt (const QPoint &pos) const
 
Q_INVOKABLE KWin::QuickSceneView * getView (Qt::Edge edge)
 
Q_INVOKABLE void activateView (QuickSceneView *view)
 
QQmlComponent * delegate () const
 
void setDelegate (QQmlComponent *delegate)
 
QUrl source () const
 
void setSource (const QUrl &url)
 
bool eventFilter (QObject *watched, QEvent *event) override
 
void prePaintScreen (ScreenPrePaintData &data, std::chrono::milliseconds presentTime) override
 
void paintScreen (const RenderTarget &renderTarget, const RenderViewport &viewport, int mask, const QRegion &region, Output *screen) override
 
bool isActive () const override
 
void windowInputMouseEvent (QEvent *event) override
 
void grabbedKeyboardEvent (QKeyEvent *keyEvent) override
 
bool touchDown (qint32 id, const QPointF &pos, std::chrono::microseconds time) override
 
bool touchMotion (qint32 id, const QPointF &pos, std::chrono::microseconds time) override
 
bool touchUp (qint32 id, std::chrono::microseconds time) override
 
Q_INVOKABLE void checkItemDraggedOutOfScreen (QQuickItem *item)
 
Q_INVOKABLE void checkItemDroppedOutOfScreen (const QPointF &globalPos, QQuickItem *item)
 
- Public Member Functions inherited from KWin::Effect
 Effect (QObject *parent=nullptr)
 
 ~Effect () override
 
virtual void postPaintScreen ()
 
virtual void prePaintWindow (EffectWindow *w, WindowPrePaintData &data, std::chrono::milliseconds presentTime)
 
virtual void paintWindow (const RenderTarget &renderTarget, const RenderViewport &viewport, EffectWindow *w, int mask, QRegion region, WindowPaintData &data)
 
virtual void postPaintWindow (EffectWindow *w)
 
virtual bool provides (Feature)
 
virtual bool perform (Feature feature, const QVariantList &arguments)
 
virtual void drawWindow (const RenderTarget &renderTarget, const RenderViewport &viewport, EffectWindow *w, int mask, const QRegion &region, WindowPaintData &data)
 
virtual QString debug (const QString &parameter) const
 
virtual bool tabletToolEvent (QTabletEvent *event)
 
virtual bool tabletToolButtonEvent (uint button, bool pressed, quint64 tabletToolId)
 
virtual bool tabletPadButtonEvent (uint button, bool pressed, void *tabletPadId)
 
virtual bool tabletPadStripEvent (int number, int position, bool isFinger, void *tabletPadId)
 
virtual bool tabletPadRingEvent (int number, int position, bool isFinger, void *tabletPadId)
 
template<typename T >
int animationTime (int defaultDuration)
 
virtual bool blocksDirectScanout () const
 

Properties

int animationDuration
 
int layout
 
bool ignoreMinimized
 
bool filterWindows
 
bool organizedGrid
 
qreal overviewPartialActivationFactor
 
bool overviewGestureInProgress
 
qreal transitionPartialActivationFactor
 
bool transitionGestureInProgress
 
qreal gridPartialActivationFactor
 
bool gridGestureInProgress
 
QPointF desktopOffset
 
QString searchText
 
- Properties inherited from KWin::QuickSceneEffect
QuickSceneView * activeView
 
QQmlComponent * delegate
 

Additional Inherited Members

- Public Types inherited from KWin::Effect
enum  {
  PAINT_WINDOW_OPAQUE = 1 << 0 , PAINT_WINDOW_TRANSLUCENT = 1 << 1 , PAINT_WINDOW_TRANSFORMED = 1 << 2 , PAINT_SCREEN_REGION = 1 << 3 ,
  PAINT_SCREEN_TRANSFORMED = 1 << 4 , PAINT_SCREEN_WITH_TRANSFORMED_WINDOWS = 1 << 5 , PAINT_SCREEN_BACKGROUND_FIRST = 1 << 6
}
 
enum  Feature {
  Nothing = 0 , ScreenInversion , Blur , Contrast ,
  HighlightWindows
}
 
enum  ReconfigureFlag { ReconfigureAll = 1 << 0 }
 
- Static Public Member Functions inherited from KWin::QuickSceneEffect
static bool supported ()
 
- Static Public Member Functions inherited from KWin::Effect
static QPointF cursorPos ()
 
static double animationTime (const KConfigGroup &cfg, const QString &key, int defaultTime)
 
static double animationTime (int defaultTime)
 
static double interpolate (double x, double y, double a)
 
static void setPositionTransformations (WindowPaintData &data, QRect &region, EffectWindow *w, const QRect &r, Qt::AspectRatioMode aspect)
 
- Protected Member Functions inherited from KWin::QuickSceneEffect
virtual QVariantMap initialProperties (Output *screen)
 

Detailed Description

Definition at line 17 of file overvieweffect.h.

Constructor & Destructor Documentation

◆ OverviewEffect()

KWin::OverviewEffect::OverviewEffect ( )

Definition at line 22 of file overvieweffect.cpp.

◆ ~OverviewEffect()

KWin::OverviewEffect::~OverviewEffect ( )
override

Definition at line 168 of file overvieweffect.cpp.

Member Function Documentation

◆ activate

void KWin::OverviewEffect::activate ( )
slot

Definition at line 292 of file overvieweffect.cpp.

◆ animationDuration()

int KWin::OverviewEffect::animationDuration ( ) const

Definition at line 194 of file overvieweffect.cpp.

◆ animationDurationChanged

void KWin::OverviewEffect::animationDurationChanged ( )
signal

◆ borderActivated()

bool KWin::OverviewEffect::borderActivated ( ElectricBorder border)
overridevirtual

Reimplemented from KWin::Effect.

Definition at line 283 of file overvieweffect.cpp.

◆ deactivate

void KWin::OverviewEffect::deactivate ( )
slot

Definition at line 301 of file overvieweffect.cpp.

◆ desktopOffset()

QPointF KWin::OverviewEffect::desktopOffset ( ) const

Definition at line 250 of file overvieweffect.cpp.

◆ desktopOffsetChanged

void KWin::OverviewEffect::desktopOffsetChanged ( )
signal

◆ filterWindows()

bool KWin::OverviewEffect::filterWindows ( ) const

Definition at line 207 of file overvieweffect.cpp.

◆ filterWindowsChanged

void KWin::OverviewEffect::filterWindowsChanged ( )
signal

◆ grabbedKeyboardEvent()

void KWin::OverviewEffect::grabbedKeyboardEvent ( QKeyEvent * keyEvent)
overridevirtual

Reimplemented from KWin::Effect.

Definition at line 337 of file overvieweffect.cpp.

◆ gridGestureInProgress()

bool KWin::OverviewEffect::gridGestureInProgress ( ) const

Definition at line 245 of file overvieweffect.cpp.

◆ gridGestureInProgressChanged

void KWin::OverviewEffect::gridGestureInProgressChanged ( )
signal

◆ gridPartialActivationFactor()

qreal KWin::OverviewEffect::gridPartialActivationFactor ( ) const

Definition at line 240 of file overvieweffect.cpp.

◆ gridPartialActivationFactorChanged

void KWin::OverviewEffect::gridPartialActivationFactorChanged ( )
signal

◆ ignoreMinimized()

bool KWin::OverviewEffect::ignoreMinimized ( ) const

Definition at line 260 of file overvieweffect.cpp.

◆ ignoreMinimizedChanged

void KWin::OverviewEffect::ignoreMinimizedChanged ( )
signal

◆ layout()

int KWin::OverviewEffect::layout ( ) const

Definition at line 255 of file overvieweffect.cpp.

◆ layoutChanged

void KWin::OverviewEffect::layoutChanged ( )
signal

◆ organizedGrid()

bool KWin::OverviewEffect::organizedGrid ( ) const

Definition at line 265 of file overvieweffect.cpp.

◆ organizedGridChanged

void KWin::OverviewEffect::organizedGridChanged ( )
signal

◆ overviewGestureInProgress()

bool KWin::OverviewEffect::overviewGestureInProgress ( ) const

Definition at line 225 of file overvieweffect.cpp.

◆ overviewGestureInProgressChanged

void KWin::OverviewEffect::overviewGestureInProgressChanged ( )
signal

◆ overviewPartialActivationFactor()

qreal KWin::OverviewEffect::overviewPartialActivationFactor ( ) const

Definition at line 220 of file overvieweffect.cpp.

◆ overviewPartialActivationFactorChanged

void KWin::OverviewEffect::overviewPartialActivationFactorChanged ( )
signal

◆ reconfigure()

void KWin::OverviewEffect::reconfigure ( ReconfigureFlags flags)
overridevirtual

Called when configuration changes (either the effect's or KWin's global).

In OpenGL based compositing, the frameworks ensures that the context is current when the Effect is reconfigured. If this method is called from within the Effect it is required to ensure that the context is current if the implementation does OpenGL calls.

Reimplemented from KWin::Effect.

Definition at line 172 of file overvieweffect.cpp.

◆ requestedEffectChainPosition()

int KWin::OverviewEffect::requestedEffectChainPosition ( ) const
overridevirtual

Reimplement this method to indicate where in the Effect chain the Effect should be placed.

A low number indicates early chain position, thus before other Effects got called, a high number indicates a late position. The returned number should be in the interval [0, 100]. The default value is 0.

In KWin4 this information was provided in the Effect's desktop file as property X-KDE-Ordering. In the case of Scripted Effects this property is still used.

Since
5.0

Reimplemented from KWin::Effect.

Definition at line 278 of file overvieweffect.cpp.

◆ searchTextChanged

void KWin::OverviewEffect::searchTextChanged ( )
signal

◆ setAnimationDuration()

void KWin::OverviewEffect::setAnimationDuration ( int duration)

Definition at line 199 of file overvieweffect.cpp.

◆ setFilterWindows()

void KWin::OverviewEffect::setFilterWindows ( bool filterWindows)

Definition at line 212 of file overvieweffect.cpp.

◆ setLayout()

void KWin::OverviewEffect::setLayout ( int layout)

Definition at line 270 of file overvieweffect.cpp.

◆ swapDesktops()

void KWin::OverviewEffect::swapDesktops ( KWin::VirtualDesktop * from,
KWin::VirtualDesktop * to )

Definition at line 366 of file overvieweffect.cpp.

◆ transitionGestureInProgress()

bool KWin::OverviewEffect::transitionGestureInProgress ( ) const

Definition at line 235 of file overvieweffect.cpp.

◆ transitionGestureInProgressChanged

void KWin::OverviewEffect::transitionGestureInProgressChanged ( )
signal

◆ transitionPartialActivationFactor()

qreal KWin::OverviewEffect::transitionPartialActivationFactor ( ) const

Definition at line 230 of file overvieweffect.cpp.

◆ transitionPartialActivationFactorChanged

void KWin::OverviewEffect::transitionPartialActivationFactorChanged ( )
signal

Property Documentation

◆ animationDuration

int KWin::OverviewEffect::animationDuration
read

Definition at line 20 of file overvieweffect.h.

◆ desktopOffset

QPointF KWin::OverviewEffect::desktopOffset
read

Definition at line 32 of file overvieweffect.h.

◆ filterWindows

bool KWin::OverviewEffect::filterWindows
read

Definition at line 23 of file overvieweffect.h.

◆ gridGestureInProgress

bool KWin::OverviewEffect::gridGestureInProgress
read

Definition at line 31 of file overvieweffect.h.

◆ gridPartialActivationFactor

qreal KWin::OverviewEffect::gridPartialActivationFactor
read

Definition at line 30 of file overvieweffect.h.

◆ ignoreMinimized

bool KWin::OverviewEffect::ignoreMinimized
read

Definition at line 22 of file overvieweffect.h.

◆ layout

int KWin::OverviewEffect::layout
read

Definition at line 21 of file overvieweffect.h.

◆ organizedGrid

bool KWin::OverviewEffect::organizedGrid
read

Definition at line 24 of file overvieweffect.h.

◆ overviewGestureInProgress

bool KWin::OverviewEffect::overviewGestureInProgress
read

Definition at line 27 of file overvieweffect.h.

◆ overviewPartialActivationFactor

qreal KWin::OverviewEffect::overviewPartialActivationFactor
read

Definition at line 25 of file overvieweffect.h.

◆ searchText

QString KWin::OverviewEffect::searchText

Definition at line 33 of file overvieweffect.h.

◆ transitionGestureInProgress

bool KWin::OverviewEffect::transitionGestureInProgress
read

Definition at line 29 of file overvieweffect.h.

◆ transitionPartialActivationFactor

qreal KWin::OverviewEffect::transitionPartialActivationFactor
read

Definition at line 28 of file overvieweffect.h.

The documentation for this class was generated from the following files:
Generated on Sat Feb 17 2024 01:42:11 for KWin by doxygen 1.10.0