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

#include <windowvieweffect.h>

Inheritance diagram for KWin::WindowViewEffect:
KWin::QuickSceneEffect KWin::Effect

Public Types

enum  PresentWindowsMode {
  ModeAllDesktops , ModeCurrentDesktop , ModeWindowGroup , ModeWindowClass ,
  ModeWindowClassCurrentDesktop
}
 
enum class  Status { Inactive , Activating , Deactivating , Active }
 
- 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 }
 

Public Slots

void activate (const QStringList &windowIds)
 
void activate ()
 
void deactivate (int timeout)
 
void partialActivate (qreal factor)
 
void cancelPartialActivate ()
 
void partialDeactivate (qreal factor)
 
void cancelPartialDeactivate ()
 
- Public Slots inherited from KWin::Effect

Signals

void animationDurationChanged ()
 
void partialActivationFactorChanged ()
 
void gestureInProgressChanged ()
 
void modeChanged ()
 
void layoutChanged ()
 
void ignoreMinimizedChanged ()
 
void searchTextChanged ()
 
void selectedIdsChanged ()
 
- 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

 WindowViewEffect ()
 
 ~WindowViewEffect () override
 
int animationDuration () const
 
void setAnimationDuration (int duration)
 
int layout () const
 
void setLayout (int layout)
 
bool ignoreMinimized () const
 
void reconfigure (ReconfigureFlags) override
 
int requestedEffectChainPosition () const override
 
void grabbedKeyboardEvent (QKeyEvent *e) override
 
bool borderActivated (ElectricBorder border) override
 
qreal partialActivationFactor () const
 
void setPartialActivationFactor (qreal factor)
 
bool gestureInProgress () const
 
void setGestureInProgress (bool gesture)
 
void setMode (PresentWindowsMode mode)
 
void toggleMode (PresentWindowsMode mode)
 
PresentWindowsMode mode () const
 
- 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
 
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
 
PresentWindowsMode mode
 
qreal partialActivationFactor
 
bool gestureInProgress
 
QString searchText
 
QList< QUuid > selectedIds
 
- Properties inherited from KWin::QuickSceneEffect
QuickSceneView * activeView
 
QQmlComponent * delegate
 

Additional Inherited Members

- 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 18 of file windowvieweffect.h.

Member Enumeration Documentation

◆ PresentWindowsMode

enum KWin::WindowViewEffect::PresentWindowsMode
Enumerator
ModeAllDesktops 
ModeCurrentDesktop 
ModeWindowGroup 
ModeWindowClass 
ModeWindowClassCurrentDesktop 

Definition at line 31 of file windowvieweffect.h.

◆ Status

enum class KWin::WindowViewEffect::Status
strong
Enumerator
Inactive 
Activating 
Deactivating 
Active 

Definition at line 40 of file windowvieweffect.h.

Constructor & Destructor Documentation

◆ WindowViewEffect()

KWin::WindowViewEffect::WindowViewEffect ( )

Definition at line 25 of file windowvieweffect.cpp.

◆ ~WindowViewEffect()

KWin::WindowViewEffect::~WindowViewEffect ( )
override

Definition at line 117 of file windowvieweffect.cpp.

Member Function Documentation

◆ activate [1/2]

void KWin::WindowViewEffect::activate ( )
slot

Definition at line 316 of file windowvieweffect.cpp.

◆ activate [2/2]

void KWin::WindowViewEffect::activate ( const QStringList & windowIds)
slot

Definition at line 290 of file windowvieweffect.cpp.

◆ animationDuration()

int KWin::WindowViewEffect::animationDuration ( ) const

Definition at line 123 of file windowvieweffect.cpp.

◆ animationDurationChanged

void KWin::WindowViewEffect::animationDurationChanged ( )
signal

◆ borderActivated()

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

Reimplemented from KWin::Effect.

Definition at line 420 of file windowvieweffect.cpp.

◆ cancelPartialActivate

void KWin::WindowViewEffect::cancelPartialActivate ( )
slot

Definition at line 349 of file windowvieweffect.cpp.

◆ cancelPartialDeactivate

void KWin::WindowViewEffect::cancelPartialDeactivate ( )
slot

Definition at line 376 of file windowvieweffect.cpp.

◆ deactivate

void KWin::WindowViewEffect::deactivate ( int timeout)
slot

Definition at line 354 of file windowvieweffect.cpp.

◆ gestureInProgress()

bool KWin::WindowViewEffect::gestureInProgress ( ) const

Definition at line 277 of file windowvieweffect.cpp.

◆ gestureInProgressChanged

void KWin::WindowViewEffect::gestureInProgressChanged ( )
signal

◆ grabbedKeyboardEvent()

void KWin::WindowViewEffect::grabbedKeyboardEvent ( QKeyEvent * e)
overridevirtual

Reimplemented from KWin::QuickSceneEffect.

Definition at line 240 of file windowvieweffect.cpp.

◆ ignoreMinimized()

bool KWin::WindowViewEffect::ignoreMinimized ( ) const

Definition at line 149 of file windowvieweffect.cpp.

◆ ignoreMinimizedChanged

void KWin::WindowViewEffect::ignoreMinimizedChanged ( )
signal

◆ layout()

int KWin::WindowViewEffect::layout ( ) const

Definition at line 136 of file windowvieweffect.cpp.

◆ layoutChanged

void KWin::WindowViewEffect::layoutChanged ( )
signal

◆ mode()

WindowViewEffect::PresentWindowsMode KWin::WindowViewEffect::mode ( ) const

Definition at line 415 of file windowvieweffect.cpp.

◆ modeChanged

void KWin::WindowViewEffect::modeChanged ( )
signal

◆ partialActivate

void KWin::WindowViewEffect::partialActivate ( qreal factor)
slot

Definition at line 333 of file windowvieweffect.cpp.

◆ partialActivationFactor()

qreal KWin::WindowViewEffect::partialActivationFactor ( ) const

Definition at line 264 of file windowvieweffect.cpp.

◆ partialActivationFactorChanged

void KWin::WindowViewEffect::partialActivationFactorChanged ( )
signal

◆ partialDeactivate

void KWin::WindowViewEffect::partialDeactivate ( qreal factor)
slot

Definition at line 368 of file windowvieweffect.cpp.

◆ reconfigure()

void KWin::WindowViewEffect::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 159 of file windowvieweffect.cpp.

◆ requestedEffectChainPosition()

int KWin::WindowViewEffect::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 154 of file windowvieweffect.cpp.

◆ searchTextChanged

void KWin::WindowViewEffect::searchTextChanged ( )
signal

◆ selectedIdsChanged

void KWin::WindowViewEffect::selectedIdsChanged ( )
signal

◆ setAnimationDuration()

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

Definition at line 128 of file windowvieweffect.cpp.

◆ setGestureInProgress()

void KWin::WindowViewEffect::setGestureInProgress ( bool gesture)

Definition at line 282 of file windowvieweffect.cpp.

◆ setLayout()

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

Definition at line 141 of file windowvieweffect.cpp.

◆ setMode()

void KWin::WindowViewEffect::setMode ( WindowViewEffect::PresentWindowsMode mode)

Definition at line 387 of file windowvieweffect.cpp.

◆ setPartialActivationFactor()

void KWin::WindowViewEffect::setPartialActivationFactor ( qreal factor)

Definition at line 269 of file windowvieweffect.cpp.

◆ toggleMode()

void KWin::WindowViewEffect::toggleMode ( PresentWindowsMode mode)

Definition at line 401 of file windowvieweffect.cpp.

Property Documentation

◆ animationDuration

int KWin::WindowViewEffect::animationDuration
read

Definition at line 21 of file windowvieweffect.h.

◆ gestureInProgress

bool KWin::WindowViewEffect::gestureInProgress
read

Definition at line 26 of file windowvieweffect.h.

◆ ignoreMinimized

bool KWin::WindowViewEffect::ignoreMinimized
read

Definition at line 23 of file windowvieweffect.h.

◆ layout

int KWin::WindowViewEffect::layout
read

Definition at line 22 of file windowvieweffect.h.

◆ mode

PresentWindowsMode KWin::WindowViewEffect::mode
read

Definition at line 24 of file windowvieweffect.h.

◆ partialActivationFactor

qreal KWin::WindowViewEffect::partialActivationFactor
read

Definition at line 25 of file windowvieweffect.h.

◆ searchText

QString KWin::WindowViewEffect::searchText

Definition at line 27 of file windowvieweffect.h.

◆ selectedIds

QList<QUuid> KWin::WindowViewEffect::selectedIds

Definition at line 28 of file windowvieweffect.h.

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