Development/Tutorials/KWin/Effects/JS API

< Development | Tutorials

Jump to: navigation, search
Contents
[hide]
1 Global
1.1 ead!onl" #roperties
1.$ %unctions
$ &'in::%#($
$.1 ead!)rite #roperties
$.$ %unctions
* &'in::+,,ects-andler
*.1 ead!onl" #roperties
*.$ ead!)rite #roperties
*.* .ignals
*./ %unctions
/ &'in::+,,ect'indo)
/.1 +nums
/.1.1 011
/.$ ead!onl" #roperties
/.* ead!)rite #roperties
/./ %unctions
1 &'in::2nimation+,,ect
1.1 +nums
1.1.1 2nchor
1.1.$ 2ttribute
1.1.* 3etaT"pe
1.$ %unctions
4 &'in::2nimationData
4.1 +nums
4.1.1 2(is
4.$ ead!)rite #roperties
4.* %unctions
5 &'in::.cripted+,,ect
5.1 +nums
5.1.1 Dataole
5.$ .ignals
5.* %unctions
Global
Methods and properties added to the global JavaScript object.
Read-only Properties
KWin::EfectsHandler efects: Global property to the core wrapper of
KWin Efects
KWin::ScriptedEfect efect: Global property to the actal Efect
object Efect: !rovides access to en"s de#ned in KWin::$ni"ationEfect
and KWin::ScriptedEfect
object KWin: !rovides access to en"s de#ned in
KWin::Wor%spaceWrapper
object QEasingCurve: !rovides access to en"s de#ned in
&Easing'rve
Functions
QList<quint64> animate(settings: Schedles one or "any ani"ations
for one window. (he ani"ations are de#ned throgh the settings object
providing
a "ore declarative way to specify the ani"ations than the ani"ate call on the
efect object. (he settings object spports the following attribtes:
)
window: EfectWindow* +, the window to ani"ate* re-ired ,+
dration: int* +, dration in "sec* re-ired ,+
crve: &Easing'rve.(ype* +, global easing crve* optional ,+
type: Efect.$ttribte* +, for #rst ani"ation* optional ,+
fro": .!/0* +, for #rst ani"ation* optional ,+
to: .!/0* +, for #rst ani"ation* optional ,+
delay: int* +, for #rst ani"ation* optional ,+
ani"ations: 1 +, additional ani"ations* optional ,+
)
crve: &Easing'rve.(ype* +, overrides global ,+
type: Efect.$ttribte*
fro": .!/0*
to: .!/0*
delay: int
2
3
2
$t least one ani"ation or attribte setter 4see below5 needs to be speci#ed
either with the top6level properties or in the ani"ations list.
QList<quint64> set(settings: 7i%e ani"ate* jst that the "aniplation
does not i"plicitly end with the ani"ation. 8o have to e/plicitly cancel
it.
9ntil then* the "aniplated attribte will re"ain at ani"ation target vale.
bool cancel(Q!ist"#uint$%&: 'ancel one or "ore present ani"ations
cased and retrned by KWin::ScriptedEfect::ani"ate or
KWin::ScriptedEfect::set.
.or convenience yo can pass a single -int:; as well.
print(Q'ariant ((( values: !rints all provided vales to %<ebg and as
a <6=s signal
int animation)ime(int duration: $djsts the passed in dration to the
global ani"ation ti"e facator.
int displayWidt*(: Width of the co"plete display 4all screens5.
int display+eig*t(: >eight of the co"plete display 4all screens5.
bool register,creenEdge(Electric-order border. Q,cript'alue
callbac/: ?egisters the callbac% for the screen edge. When the "ose
gets pshed against the given edge the callbac% will be invo%ed.
bool register,*ortcut(Q,tring title. Q,tring te0t. Q,tring
/ey,e#uence. Q,cript'alue callbac/: ?egisters %eySe-ence as a
global shortct. When the shortct is invo%ed the callbac% will be called.
(itle and te/t are sed to na"e the shortct and "a%e it available to the
global shortct con#gration "odle.
KWin11FP02
(his class is sed to describe the ani"ation end points* that is fro" which .!/0
vales to which .!/0 vales an ani"ation goes. (his class contains two
properties to describe two ani"ation co"ponents individally 4e.g. width and
height5. =t it@s also possible to jst have one vale 4e.g. opacity5. An this case
the de#nition of an .!/0 can be replaced by a single vale.
Read-3rite Properties
qreal value4
qreal value2
Functions
KWin11Efects+andler
Manager class that handles all the efects.
Read-only Properties
QString current5ctivity
QSize des/topGrid,i6e
int des/topGridWidt*
int des/topGrid+eig*t
int 3or/spaceWidt*
int 3or/space+eig*t
bool optionRoll7ver8es/tops
int active,creen
int num,creens
qreal animation)imeFactor: .actor by which ani"ation speed in the
efect shold be "odi#ed 4"ltiplied5. Af con#grable in the efect itself*
the option shold have also @defalt@ ani"ation speed. (he actal vale
shold be deter"ined sing ani"ation(i"e45. Bote: (he factor can be
also C* so "a%e sre yor code can cope with C"s ti"e if sed "anally.
QList< KWin::EfectWindo! " > stac/ing7rder
bool decorations+ave5lp*a: Whether window decorations se the
alpha channel.
bool decoration,upports-lur-e*ind: Whether the window decorations
spport blrring behind the decoration.
#o$positing%&pe compositing)ype
Q'oint cursorPos
Read-3rite Properties
int current8es/top
KWin::EfectWindo! activeWindo3
int des/tops: (he n"ber of des%tops crrently sed. Mini"" n"ber
of des%tops is D* "a/i"" 0C.
,ignals
des/topC*anged(int old8es/top. int ne38es/top.
KWin11EfectWindo3 93it*: Signal e"itted when the crrent des%top
changed.
old<es%top
(he previosly crrent des%top
new<es%top
(he new crrent des%top
with
(he window which is ta%en over to the new des%top* can be B977
;.E
des/topC*anged(int old8es/top. int ne38es/top: ;.F
<eprecated
number8es/topsC*anged(uint old: Signal e"itted when the n"ber
of crrently e/isting des%tops is changed.
old
(he previos n"ber of des%tops in sed.
Efects>andler::n"berGf<es%tops. ;.F
3indo35dded(KWin11EfectWindo3 93: Signal e"itted when a new
window has been added to the Wor%space.
w
(he added window
;.F
3indo3Closed(KWin11EfectWindo3 93: Signal e"itted when a
window is being re"oved fro" the Wor%space. $n efect which wants to
ani"ate the window closing shold connect to this signal and reference
the window by sing w (he window which is being closed ;.F
3indo35ctivated(KWin11EfectWindo3 93: Signal e"itted when a
window get@s activated.
w
(he new active window* or B977 if there is no active window.
;.F
3indo38eleted(KWin11EfectWindo3 93: Signal e"itted when a
window is deleted. (his "eans that a closed window is not referenced
any "ore. $n efect boo%%eeping the closed windows shold connect to
this signal to clean p the internal references.
w
(he window which is going to be deleted.
EfectWindow::refWindow EfectWindow::nrefWindow window'losed ;.F
3indo3,tart:ser;ovedResi6ed(KWin11EfectWindo3 93: Signal
e"itted when a ser begins a window "ove or resiHe operation. (o #gre
ot whether the ser resiHes or "oves the window se or
EfectWindow::is9ser?esiHe. Whenever the geo"etry is pdated the
signal windowStep9serMoved?esiHed is e"itted with the crrent
geo"etry. (he "ove+resiHe operation ends with the signal
window.inish9serMoved?esiHed. Gnly one window can be "oved+resiHed
by the ser at the sa"e ti"eI w (he window which is being
"oved+resiHed windowStep9serMoved?esiHed
window.inish9serMoved?esiHed EfectWindow::is9serMove
EfectWindow::is9ser?esiHe ;.F
3indo3,tep:ser;ovedResi6ed(KWin11EfectWindo3 93. const
QRect <geometry: Signal e"itted dring a "ove+resiHe operation
when the ser changed the geo"etry. !lease note: KWin spports two
operation "odes. An one "ode all changes are applied instantly. (his
"eans the window@s geo"etry "atches the passed in geo"etry. An the
other "ode the geo"etry is changed after the ser ended the
"ove+resiHe "ode. (he geo"etry difers fro" the window@s geo"etry.
$lso the window@s pi/"ap still has the sa"e siHe as before. <epending
what the efect wants to do it wold be reco""ended to scale+translate
the window.
w
(he window which is being "oved+resiHed
geo"etry
(he geo"etry of the window in the crrent "ove+resiHe step.
windowStart9serMoved?esiHed window.inish9serMoved?esiHed
EfectWindow::is9serMove EfectWindow::is9ser?esiHe ;.F
3indo3Finis*:ser;ovedResi6ed(KWin11EfectWindo3 93: Signal
e"itted when the ser #nishes "ove+resiHe of window w.
w
(he window which has been "oved+resiHed
windowStart9serMoved?esiHed window.inish9serMoved?esiHed ;.F
3indo3;a0imi6ed,tateC*anged(KWin11EfectWindo3 93. bool
*ori6ontal. bool vertical: Signal e"itted when the "a/i"iHed state of
the window w changed. $ window can be in one of for states:
restored: both horiHontal and vertical are false horiHontally "a/i"iHed:
horiHontal is tre and vertical is false vertically "a/i"iHed: horiHontal is false
and vertical is tre co"pletely "a/i"iHed: both horiHontal and vertical are tre
w
(he window whose "a/i"iHed state changed
horiHontal
Af tre "a/i"iHed horiHontally
vertical
Af tre "a/i"iHed vertically
;.F
3indo3Geometry,*apeC*anged(KWin11EfectWindo3 93. const
QRect <old: Signal e"itted when the geo"etry or shape of a window
changed. (his is cased if the window changes geo"etry withot ser
interaction. E.g. the decoration is changed. (his is in opposite to
window9serMoved?esiHed which is cased by direct ser interaction.
w
(he window whose geo"etry changed
old
(he previos geo"etry
window9serMoved?esiHed ;.F
3indo3PaddingC*anged(KWin11EfectWindo3 93. const QRect
<old: Signal e"itted when the padding of a window changed. 4eg.
shadow siHe5
w
(he window whose geo"etry changed
old
(he previos e/pandedGeo"etry45
;.E
3indo37pacityC*anged(KWin11EfectWindo3 93. #real
old7pacity. #real ne37pacity: Signal e"itted when the windows
opacity is changed.
w
(he window whose opacity level is changed.
oldGpacity
(he previos opacity level
newGpacity
(he new opacity level
;.F
3indo3;inimi6ed(KWin11EfectWindo3 93: Signal e"itted when a
window got "ini"iHed.
w
(he window which was "ini"iHed
;.F
3indo3:nminimi6ed(KWin11EfectWindo3 93: Signal e"itted when
a window got n"ini"iHed.
w
(he window which was n"ini"iHed
;.F
3indo38amaged(KWin11EfectWindo3 93. const QRect <r: Signal
e"itted when an area of a window is schedled for repainting. 9se this
signal in an efect if another area needs to be synced as well.
w
(he window which is schedled for repainting
r
$lways e"pty.
;.F
tab-o05dded(int mode: Signal e"itted when a tabbo/ is added. $n
efect who wants to replace the tabbo/ with itself shold se "ode (he
(ab=o/Mode. ref(ab=o/ tab=o/'losed tab=o/9pdated tab=o/KeyEvent
;.F
tab-o0Closed(: Signal e"itted when the (ab=o/ was closed by KWin
core. $n efect which referenced the (ab=o/ shold se to nref again.
nref(ab=o/ tab=o/$dded ;.F
tab-o0:pdated(: Signal e"itted when the selected (ab=o/ window
changed or the (ab=o/ 7ist changed. $n efect shold only response to
this signal if it referenced the (ab=o/ with ref(ab=o/
crrent(ab=o/Window7ist crrent(ab=o/<es%top7ist
crrent(ab=o/Window crrent(ab=o/<es%top ;.F
tab-o0KeyEvent(QKeyEvent 9event: Signal e"itted when a %ey
event* which is not handled by (ab=o/ directly is* happens while (ab=o/
is active. $n efect "ight se the %ey event to e.g. change the selected
window. $n efect shold only response to this signal if it referenced the
(ab=o/ with event (he %ey event not handled by (ab=o/ directly
ref(ab=o/ ;.F
current)ab5bout)oC*ange(KWin11EfectWindo3 9=rom.
KWin11EfectWindo3 9to
tab5dded(KWin11EfectWindo3 9=rom. KWin11EfectWindo3 9to
tabRemoved(KWin11EfectWindo3 9c. KWin11EfectWindo3
9group
mouseC*anged(const QPoint <pos. const QPoint <oldpos.
Qt11;ouse-uttons buttons. Qt11;ouse-uttons oldbuttons.
Qt11Keyboard;odi>ers modi>ers. Qt11Keyboard;odi>ers
oldmodi>ers: Signal e"itted when "ose changed. Af an efect needs
to get pdated "ose positions* it needs to #rst call .or a fllscreen
efect it is better to se an inpt window and react on
windowAnptMoseEvent. pos (he new "ose position oldpos (he
previosly "ose position bttons (he pressed "ose bttons oldbttons
(he previosly pressed "ose bttons "odi#ers !ressed %eyboard
"odi#ers old"odi#ers !reviosly pressed %eyboard "odi#ers.
startMose!olling ;.F
property?oti=y(KWin11EfectWindo3 93. long atom: ?eceives
events registered for sing 9se read!roperty45 to get the property data.
Bote that the property "ay be already set on the window* so doing the
sa"e processing fro" window$dded45 4e.g. si"ply calling
propertyBotify45 fro" it5 is sally needed. w (he window whose property
changed* is nll if it is a root window property ato" (he property ;.F
screenGeometryC*anged(const Q,i6e <si6e: Signal e"itted after
the screen geo"etry changed 4e.g. add of a "onitor5. Efects sing
displayWidth45+display>eight45 to cache infor"ation shold react on this
signal and pdate the caches.
siHe
(he new screen siHe
;.J
current5ctivityC*anged(const Q,tring <id: (his signal is e"itted
when the global activity is changed
id
id of the new crrent activity
;.E
activity5dded(const Q,tring <id: (his signal is e"itted when a new
activity is added
id
id of the new activity
;.E
activityRemoved(const Q,tring <id: (his signal is e"itted when the
activity is re"oved
id
id of the re"oved activity
;.E
screen!oc/ingC*anged(bool loc/ed: (his signal is e"itted when the
screen got loc%ed or nloc%ed.
loc%ed
tre if the screen is now loc%ed* false if it is now nloc%ed
;.DD
stac/ing7rderC*anged(: (his signels is e"itted when ever the
stac%ing order is change* ie. a window is risen or lowered ;.DC
screenEdge5pproac*ing(Electric-order border. #real =actor. const
QRect <geometry: (his signal is e"itted when the ser starts to
approach the border with the "ose. (he factor describes how far away
the "ose is in a relative "ean. (he vales are in 1C.C* D.C3 with C.C
being e"itted when #rst entered and on leaving. (he vale D.C "eans
that the border is reached with the "ose. So the vales are well sited
for ani"ations. (he signal is always e"itted when the "ose crsor
position changes.
border
(he screen edge which is being approached
factor
Kale in range 1C.C*D.C3 to describe how close the "ose is to the border
geo"etry
(he geo"etry of the edge which is being approached
;.DD
Functions
moveWindo3(KWin11EfectWindo3 93. const QPoint <pos. bool
snap@=alse. double snap5dAust@4(B@B
3indo3)o8es/top(KWin11EfectWindo3 93. int des/top@B
3indo3)o,creen(KWin11EfectWindo3 93. int screen@B
int des/top5bove(int des/top@B. bool 3rap@true const @B: (he
A< of the des%top above des%top id. Wraps arond to the botto" of the
layot if wrap is set. Af id is not set se the crrent one.
int des/top)oRig*t(int des/top@B. bool 3rap@true const @B: (he
A< of the des%top to the right of des%top id. Wraps arond to the left of
the layot if wrap is set. Af id is not set se the crrent one.
int des/top-elo3(int des/top@B. bool 3rap@true const @B: (he A<
of the des%top below des%top id. Wraps arond to the top of the layot if
wrap is set. Af id is not set se the crrent one.
int des/top)o!e=t(int des/top@B. bool 3rap@true const @B: (he A<
of the des%top to the left of des%top id. Wraps arond to the right of the
layot if wrap is set. Af id is not set se the crrent one.
QString des/top?ame(int des/top const @B
int screen?umber(const QPoint <pos const @B
KWin::EfectWindo! " >ndWindo3(WCd id const @B
addRepaintFull(@B: Schedles the entire wor%space to be repainted
ne/t ti"e. Af yo call it dring painting 4inclding prepaint5 then it does
not afect the crrent painting.
addRepaint(const QRect <r@B
addRepaint(const QRegion <r@B
addRepaint(int 0. int y. int 3. int *@B
KWin11EfectWindo3
?epresentation of a window sed by+for Efect classes.
Enums
D4E
P5C?)F8C,5-!E8: Window will not be painted
P5C?)F8C,5-!E8F-GF8E!E)E: Window will not be painted becase it is
deleted
P5C?)F8C,5-!E8F-GF8E,K)7P: Window will not be painted becase of
which des%top it@s on
P5C?)F8C,5-!E8F-GF;C?C;CHE: Window will not be painted becase it
is "ini"iHed
P5C?)F8C,5-!E8F-GF)5-FGR7:P: Window will not be painted becase
it is not the active window in a client grop
P5C?)F8C,5-!E8F-GF5C)C'C)G: Window will not be painted becase
it@s not on the crrent activity
Read-only Properties
bool alp*a
Q(ect geometry
Q(ect e0pandedGeometry
int *eig*t
qreal opacity
Q'oint pos
int screen
QSize si6e
int 3idt*
int 0
int y
int des/top
bool on5ll8es/tops
bool onCurrent8es/top
Q(ect rect
QString 3indo3Class
QString 3indo3Role
bool des/topWindo3: ?etrns whether the window is a des%top
bac%grond window 4the one with wallpaper5. See
LBE(LWMLWAB<GWL(8!EL<ESK(G! at http:66standards.,reedes7top.org6)m!
spec6)m!spec!latest.html .
bool doc/: ?etrns whether the window is a doc% 4i.e. a panel5. See
LBE(LWMLWAB<GWL(8!EL<G'K at http:66standards.,reedes7top.org6)m! spec6)m!
spec!latest.html .
bool toolbar: ?etrns whether the window is a standalone 4detached5
toolbar window. See LBE(LWMLWAB<GWL(8!EL(GG7=$? at
http:66standards.,reedes7top.org6)m!spec6)m!spec!latest.html .
bool menu: ?etrns whether the window is a torn6of "en. See
LBE(LWMLWAB<GWL(8!ELMEB9 at http:66standards.,reedes7top.org6)m!spec6)m!
spec!latest.html .
bool normalWindo3: ?etrns whether the window is a Mnor"alM window*
i.e. an application or any other window for which none of the specialiHed
window types #t. See LBE(LWMLWAB<GWL(8!ELBG?M$7 at
http:66standards.,reedes7top.org6)m!spec6)m!spec!latest.html .
bool dialog: ?etrns whether the window is a dialog window. See
LBE(LWMLWAB<GWL(8!EL<A$7GG at http:66standards.,reedes7top.org6)m!
spec6)m!spec!latest.html .
bool splas*: ?etrns whether the window is a splashscreen. Bote that
"any 4especially older5 applications do not spport "ar%ing their splash
windows with this type. See LBE(LWMLWAB<GWL(8!ELS!7$S> at
http:66standards.,reedes7top.org6)m!spec6)m!spec!latest.html .
bool utility: ?etrns whether the window is a tility window* sch as a
tool window. See LBE(LWMLWAB<GWL(8!EL9(A7A(8 at
http:66standards.,reedes7top.org6)m!spec6)m!spec!latest.html .
bool dropdo3n;enu: ?etrns whether the window is a dropdown "en
4i.e. a popp directly or indirectly open fro" the applications "enbar5.
See LBE(LWMLWAB<GWL(8!EL<?G!<GWBLMEB9 at
http:66standards.,reedes7top.org6)m!spec6)m!spec!latest.html .
bool popup;enu: ?etrns whether the window is a popp "en 4that is
not a torn6of or dropdown "en5. See
LBE(LWMLWAB<GWL(8!EL!G!9!LMEB9 at http:66standards.,reedes7top.org6)m!
spec6)m!spec!latest.html .
bool tooltip: ?etrns whether the window is a tooltip. See
LBE(LWMLWAB<GWL(8!EL(GG7(A! at http:66standards.,reedes7top.org6)m!
spec6)m!spec!latest.html .
bool noti>cation: ?etrns whether the window is a window with a
noti#cation. See LBE(LWMLWAB<GWL(8!ELBG(A.A'$(AGB at
http:66standards.,reedes7top.org6)m!spec6)m!spec!latest.html .
bool combo-o0: ?etrns whether the window is a co"bobo/ popp. See
LBE(LWMLWAB<GWL(8!EL'GM=G at http:66standards.,reedes7top.org6)m!
spec6)m!spec!latest.html .
bool dndCcon: ?etrns whether the window is a <ragN<rop icon. See
LBE(LWMLWAB<GWL(8!EL<B< at http:66standards.,reedes7top.org6)m!spec6)m!
spec!latest.html .
int 3indo3)ype: ?etrns the BE(WM window type See
http:66standards.,reedes7top.org6)m!spec6)m!spec!latest.html .
bool managed: Whether this EfectWindow is "anaged by KWin 4it has
control over its place"ent and other aspects* as opposed to override6
redirect windows that are entirely handled by the application5.
bool deleted: Whether this EfectWindow represents an already deleted
window and only %ept for the co"positor for ani"ations.
bool s*aped: Whether the window has an own shape
Q(egion s*ape: (he Window@s shape
QString caption: (he 'aption of the window. ?ead fro" WMLB$ME
property together with a sO/ for hostna"e and shortct.
bool /eep5bove: Whether the window is set to be %ept above other
windows.
bool modal: Whether the window represents a "odal window.
bool moveable: Whether the window is "oveable. Even if it is not
"oveable* it "ight be possible to "ove it to another screen.
"oveable$crossScreens
bool moveable5cross,creens: Whether the window can be "oved to
another screen. "oveable
QSize basic:nit: =y how "ch the window wishes to grow+shrin% at
least. 9sally &SiHe4D*D5. M$8 =E <ASG=E8E< =8 (>E WMI At@s only for
infor"ation* do BG( rely on it at all.
bool move: Whether the window is crrently being "oved by the ser.
bool resi6e: Whether the window is crrently being resiHed by the ser.
Q(ect iconGeometry: (he optional geo"etry representing the
"ini"iHed 'lient in e.g a tas%bar. See LBE(LWMLA'GBLGEGME(?8 at
http:66standards.,reedes7top.org6)m!spec6)m!spec!latest.html .
bool specialWindo3: ?etrns whether the window is any of special
windows types 4des%top* doc%* splash* ...5* i.e. window types that sally
don@t have a window fra"e and the ser does not se window
"anage"ent 4"oving* raising*...5 on the".
Q'i)$ap icon
bool s/ip,3itc*er: Whether the window shold be e/clded fro"
window switching efects.
Q(ect contentsRect: Geo"etry of the actal window contents inside the
whole 4inclding decorations5 window.
Q(ect decorationCnnerRect: Geo"etry of the transparent rect in the
decoration. May be diferent fro" contents?ect if the decoration is
e/tended into the client area.
bool *as8ecoration
QStringList activities
bool onCurrent5ctivity
bool on5ll5ctivities
bool decoration+as5lp*a: Whether the decoration crrently ses an
alpha channel. ;.DC
bool visible: Whether the window is crrently visible to the ser* that is:
Bot "ini"iHed
Gn crrent des%top
Gn crrent activity
;.DD
Read-3rite Properties
bool minimi6ed: Whether the window is "ini"iHed.
Functions
addRepaint(const QRect <r
addRepaint(int 0. int y. int 3. int *
addRepaintFull(
add!ayerRepaint(const QRect <r
add!ayerRepaint(int 0. int y. int 3. int *
bool is7n5ctivity(Q,tring id const
KWin::EfectWindo! " >nd;odal(@B
QList< KWin::EfectWindo! " > mainWindo3s( const @B
closeWindo3( const
set8ata(int role. const Q'ariant <data@B: 'an be sed to by
efects to store arbitrary data in the EfectWindow.
Q*ariant data(int role const @B
KWin115nimationEfect
Cn*erits1 KWin::Efect
Enums
5nc*or
!e=t:
)op:
Rig*t:
-ottom:
+ori6ontal:
'ertical:
;ouse:
5ttribute
7pacity:
-rig*tness:
,aturation:
,cale:
Rotation:
8ecoration7pacity:
Position:
,i6e:
)ranslation:
Clip:
Generic:
CrossFadePrevious:
?onFloat-ase:
;eta)ype
,ource5nc*or:
)arget5nc*or:
Relative,ourceI:
Relative,ourceG:
Relative)argetI:
Relative)argetG:
50is:
Functions
KWin115nimation8ata
Enums
50is
I50is:
G50is:
H50is:
Read-3rite Properties
KWin::+ni$ationEfect::+nc,or source5nc*or
KWin::+ni$ationEfect::+nc,or target5nc*or
int relative,ourceI
int relative,ourceG
int relative)argetI
int relative)argetG
+)is a0is
Functions
KWin11,criptedEfect
Cn*erits1 KWin::$ni"ationEfect
Enums
8ataRole
Windo35ddedGrabRole:
Windo3ClosedGrabRole:
Windo3;inimi6edGrabRole:
Windo3:nminimi6edGrabRole:
Windo3Force-lurRole:
Windo3-lur-e*indRole:
!anc6osCac*eRole:
,ignals
con>gC*anged(: Signal e"itted whenever the efect@s con#g changed.
Functions
quint64 animate(KWin11EfectWindo3 93. 5ttribute a. int ms.
KWin11FP02 to. KWin11FP02 =rom@KWin11FP02(.
KWin115nimation8ata 9data@?:!!. QEasingCurve11)ype
curve@QEasingCurve11!inear. int delay@B
quint64 set(KWin11EfectWindo3 93. 5ttribute a. int ms.
KWin11FP02 to. KWin11FP02 =rom@KWin11FP02(.
KWin115nimation8ata 9data@?:!!. QEasingCurve11)ype
curve@QEasingCurve11!inear. int delay@B
bool cancel(#uint$% animationCd
bool border5ctivated(Electric-order border
bool isGrabbed(KWin11EfectWindo3 93. 8ataRole grabRole:
Whether another efect has grabbed the w with the given grab?ole.
w
(he window to chec%
grab?ole
(he grab role to chec%
tre if another window has grabbed the efect* false otherwise
Q*ariant readCon>g(const Q,tring </ey. const Q'ariant
de=ault'alue@Q'ariant(: ?eads the vale fro" the con#gration data
for the given %ey.
%ey
(he %ey to search for
defaltKale
(he vale to retrn if the %ey is not fond
(he con#g vale if present
This page )as last modi,ied on 1 June $81*, at 1$:14. This page has been accessed $,*88 times.
9ontent is available under 9reative 9ommons :icense .2 *.8 as )ell as the G;< %ree
Documentation :icense 1.$.