From 23b2d2ada5b1b66ad65eda10d70b5b48d32ef9c5 Mon Sep 17 00:00:00 2001
From: Nico Vertriest <nico.vertriest@qt.io>
Date: Mon, 5 Mar 2018 16:19:40 +0100
Subject: [PATCH] Doc: Update Event Transitions Example

- added screenshot
- some modifications to the text

Task-number QTBUG-60635

Change-Id: I57b269f93cdba696b424b5ba008d0f46ac612cda
Reviewed-by: Martin Smith <martin.smith@qt.io>
---
 doc/src/images/transitions.png                | Bin 0 -> 4314 bytes
 .../widgets/doc/src/eventtransitions.qdoc     |  27 +++++++++++++-----
 2 files changed, 20 insertions(+), 7 deletions(-)
 create mode 100644 doc/src/images/transitions.png

diff --git a/doc/src/images/transitions.png b/doc/src/images/transitions.png
new file mode 100644
index 0000000000000000000000000000000000000000..b29466f5ab18de8ac71086294625348005b3a3a3
GIT binary patch
literal 4314
zcmbtYXH-*L8U>UmHku$HO(X~?2}OESK}rZ!2uN4yA#|ie1bLuHQ9ybZ0|ZDE1St}c
z&Le<IGg3m44xuL0kjZ;9vvi!d=Fj}N>wf2+@9gt^``oqny7!5(q0ZS;7f#X9(VYeB
z-nvakM=wdcESMN*Pr`cbg=x2Aei~piCMKrQDWgf+kkw!7j=!mwvwz?{Une?K*9ZRo
zPQDINpH9-I0>HO!ngxAZ9S`+4BSkiE5SjvIu4Q&RCTFS|Fa^_tpFLq^|6a&C@wjT+
zNvRS&9MWJ_xdQVT8n3DJ7_tf-hP|r|NQ&ibfDKt~fEmQ}jM+6AbfZ|=HSXJGWdc$%
zae!+(M8RW1fcK0%8Ef+_%$fSW^AjqB!-&9$VBIX_6NiK*#^$|?;4ji%iSV^s)RNni
zeC7&EX;V}|v`?LEQs)33j~^Xf-Z^;mak7-*B>QgFu>yd2+<htT3UhZ~-zq#@0Bd_2
zDz_bjLY-g{fO~oM_x9F|u9}#b@aasd@?5yEL?n8;y6PGj^x|--PL@nQb=pwq^3syT
zd5E@l3}H=>kMGQHkN9LJRZTdwFeAKYV!{u|XV0GH<lyM4k|;x=+^ifNUK*A_3=Bvi
zP5L^K7&yDTe6}XZ$;G873mL4MM<$a~Q#q14HRGBsv<KcE9UWCvR3s)cCv^%lGDISg
zmtTH%mCpvV)m;=W9$6;sg;gQl)YR0ZrKO9RY)aX_z~vilK$Zit`TYt3YR8)`lvD)-
zc#lQWVG0<yjHS5G9A}^{XoV!wfjFR0ClFVpl+bA`;Vjd!EM#{U(nOdQB<FjP&KXr#
zU>_e2w6+i3m<1+KmUupJ%{#%ri`lq-l)PeZSxs&S@<*N{_(m8ayg#W($xf0OYi8iv
zUw5WChAV7$$T2ec{ahgfYdarI&9Tm_4cGPo%83r&`<~*Io?`mX=*3;i-3XP|v$3&p
zu^5R-;7ymX5sMZZeT!f8r!myOkfJM)R8mw_R9gD@SP1*ljZyTf3b~fF3rGQ~VTu(c
zMNk+rNdY#V=5`hR;0`C7zj+gRSOBpfh3SWwc8=l2PTLPyOG39xTt=JtR}H;xxEN;M
z2_p@*k*m_xcf;D!lIL)2*6#um>O_3VsNnls5KhYCj6>+C@>t};_SJOz+_{OSCS-ki
zV?Rba^IRtvPAtoH1S0xXuK~O}x_qUaTtf<q0lX9exwWh)G1fL0zN3;ON-Do+_jCj%
zhHyWrws>)6O(0^ejoY#m+t)NyL#iAn-V|3>7a5Uml4>nddD$zTzIm-}hJ-aWCk8am
z%*+6Ulx)!%85yshp6_UD%b9a2MWdaOA<BMW7Z3d0x3s&kn<g88Z0clU)eg%x<c(6W
zywKPQE7hAqQBA$Q0{6PQAfNfy`gA}|?<*@k!*6@q1yoHhmX4BrV$;57Eb0!Q6vCg@
zo5N)V4{?M}r#g7~0AeDDqoZ?X>@t3xB5hXp6ZBF)-qq{!#bv3@#F<r=7s5<exmvfr
zNn7)ri7=^tg~W@OeCM*04h}0CVs}xV!|5bMaO=n`haC?{OSh13IKz|9Wt8i>gQyMd
z8RZ13uSzHco|MVfhj2+&-H`xUBn`~UWcNbOgA^$onPqwCkBPRS`_W2XWQkY<Hp@3n
z7*7~wyFk=sbN7Afk_UeRFfZ!x##Uj(JzRE1!2`G&F;|jBt#O9`^!e|Wj#H4$_q!4E
zT=u*AiMaUTZ??I&;Z^~jdJFy;+Jxx?8z!OYQ_j74chzOQ-p+ERM}yXr+Y2>E8&$3g
z8lMAB*I93%+>|YugcgA(7c;wkIzG3i!t3F<)^(L6fk^Ur{x*{)d93}KDM{nI6SqC0
z5?MCaJg9}N{x<ds{G2nFxQ@OOSFzBi2!g4SBp$pb@N%?N@8o_U@?$@btc?JAoEY8o
zbRZ6XUa;4A;Qh-+Z+jjcBq3aURwU(3wnHo*KU{-<P`ktLI$lGW3HMMt5^hDKP!4vU
zJQHznKb$1b{_DABoowc?;x;GcIA@Mx?ffIQ^`Iz?HW5ormBI}6m5|Rf%e=-0F0bn$
zAwhiWd-AC-cDBheXwJ}seOfGOTc!BTwYbA?@4ilIcQKQT8Mz`j<$hAw3yY!|N1^z#
zV4j#XB!xuEvc7}qs{O-v@>Zbw#`4Q#z{$cg;o;1V37I&|Y-?cPyTvaheLY6Cj}zlI
zt>(q;1V4%DX9e35%`9AcN@@hxD)E<A2pKLa?XBGE4Ex+EmvSh%;hN|4Lxct+Jx2;y
zeTL8VT~BJPAB5~F06oUuDy2?;5qbJM>l$2ad3E_J;camHrhDmzjZCqj_+yXp@w%7F
z89tU8aI;Sej(_+9bTuBAw!Md&no=S!3&F2dNyM@K@q`%GazRA1!i34ookU*JF9*Pb
z8OvUJb@PyfvWy?0SR-!|9(FDgJ=d-efzCWI$3pQAhWc-_WeLx&MB6=oWvUuK_Hu2Y
zL=o9mGc4~RK4Q>UbtYh?-0ze_-{1;&83nEoShg6T>>)o|#JHvTXo^;FkAg>laxTuS
zUoMvt*ZwqqNRE^*w*pU#KVPn<cF(w48=@h$an27&Y8<=0S-j!A=SZXTt9#!S5bR(*
zrS?%{AkR#)sMB0Yds2f)=-^ZOWS_$q7U9@R7=l7Zi$OM>z}lZfs`x)e(Ld7Ks8t{;
zaipG=Cg&__iGY=*gTBN*ci@*kQKNJo_yu8OI`Y2S*I2$i>8eEToUVc%cE$_jJ=Sac
z#S^;`^W00DH^D{rihw$%!kcdDAt&?29J``PR=Po^hZpE!$8RLi$uSgY(_&*`T3pIj
zSIl?Rx4*gRo5<)*kB8T`%7HAaqFd>0Za|?>oEbfu_urWX+B6VjVLI6HQZ^dM-vIuP
zslWF61>xs1ewq5ez<=)1+vk(kN}htOY~47KX5e|p@3nirv#uOoS%Jgi3pkuCK|tUv
zUN8n#Ue3a&_$(!*RbTEBE!S-Tx$&OGNJ~pAJUl!;;dxPGqxFDn-p*85)Fp3BFz1P1
z3g*i1qVy>a^M3sLE6-t;6$%XTe^UMPl4kt<CbqlqU(cg24U`<1C(^kN0JA&%N%epB
z@^~TN%dv^=ztPfLLWG<DYwH}~FfV<_zmKg=`Y===3od@7Y5Gv}W&$^OOCX5yS+F8Q
zPQ2UEusgqcv$j(~_Mor39HME^FVXK`f%f)$R>oHH{63=BVT8k$T8`Rv+EK4Q5=0!n
zWBhC_XrtuOo{}GAbQB5e^s}(6S}PM!><&-;I>zIN0qKA7%aLTS@V3!CrXtw5F|Ps<
zz=V;=VJU#<JFmTGQHYSktooht?E@{&ompN(@`6!4OLFD*^^w%LHwYdhl?JNBhLpSp
zlTdWyW;fLhM_oKeV0p!@*Cj(r6kYqH;$T3~y-DND;Gw_9N{*bzM`NvVN#Nt&x|x^g
zKrh{H?CQ*og8>V?!DZ79e!<}O$wCrKg?DiVZ9Ltk#R3mNY4~BQq#~v%HP}yLHXl4m
zUs|^BqyR&Qd;9sDocUmq2kj$qG8LDX>x#V8_C2|{QU<x790CQ+8n!%lwTY!dpUhq_
z?c<0Zqu*i-*CXeYj7FepcBO#v_eTSou~q>`&JBf5<JSr6@$>FfQpYf=Qu1&gSzj;R
znS;MOx<$x5Xa&w7-Uf`KS*YY?-cyyaTRW>EL3k9`IbxVk=Mn!hc7WQ3vbI;wQO_vT
zPQGg&n(x^2RwqG8d}GGrwtcAmjbeVpsS8eT@D4=)5oL8DAt5U!=|SSsX)AP2)54P5
z$+!&F)rDx;!7*Y<1Xg@c^o7xcGX7#TH<!d)icU4F#<mA#_1gH=kt1U0HHY83>M1US
zFxX<XwQV`t=$WEgd;*)+8$i3OS|wWAul0tPdy+FaPKhG<!o-pgzHmUMT4$QpZDQvG
z>a-I)QSS4@wRM?WGCKCL%n|1G14ERS8u801-HtLMI7F@c>vui9le!6Pol>5CvI7(I
z1Vu%d_L6%L=|x9fa;BR}t0X=rBr(NzHAPU)Gjwi$VY6|bL*f9cm83ik&Aw|qB>P~+
z<?~=+L5^R)waU(!a(jf|Z|5$<;#J>Vvmm6JAM`Yi$nPfpHeGqpWBXxTVQN?<4yVzz
z&;4lbLCBDF3RDa8c+&W;<2~h3PC~@`9;!)F62JBJ*s@AeL_B-`{A-d~s$9Gs%V$xe
z?m_;s+oB~d{L<<o+EY01aqdWcEh?7iBG<DfAzs-)jUDOjGUk0pp_J*^xn>`%$Ap3u
zP6=(hiTpmNb9DICzJwrO_90+ke?EZmRvxQ{E^^xjGBTG=80XJML$Xw**C!Cy8x`(Z
zy%BD=FvT|ZKXX#h(~;!s9k9S)4-tZgWES>_!1*YjkKxpy55gCtS(C$$#>?R&l%RIt
z5#i8v5s*?|_;IZcDVxBl*U^DVJI@^bYC+U%u;K%zU~e|o)2d-5O=mcelQO;f?E@z7
z{`oAVTZ`5H!oWLw^N5kEa`VIGtZ;CTx#I=Rq%m2_L@XAhc2IeBp0N29$?Rq1M+rsL
zQyaG+&USulbMb<hP?*nHmt1!#n8y0@#}*?5!odx^*lQ%1HK{xJyE^qyR6S_+D9VVs
z-W05*1)<JP)vU>FpJ<(Gz6I!>*)TIR<KW`b8T9lTtMl30oRx@(T}-*1JQ23l`}=7w
z?Lj*WDAZ@1Ny?P*hur0;M_~U>AkQx+(EX*1Kbw$u?WO&9ywwxjc>r+@su+vIKfUdT
z;DXc-!-QKl2BqX_=Jy{q#&u$tmo2d*=FOj;_QR136FHfqXUgvVrO-c1H;B1H;S!(G
z*}qfgPo$3B-5@Ab1biF%LiA=(0!vi|3KkZoDyMy_e8|e)K0iNSvIoc9@)YStB9Y9?
zUtAE@^7JGgQ4RuEzE1hpGhG}*0?o_i6co}g2zN!FJQuVi{N8zykKu=3|5E<{Wt4wW
z_@n2a+x(f`ABXZk-Jh2BGs3@CU5s~61w1)MZ*wOZ(47pRePuGsEosP^L!o6luC&+k
zg3bv=!X7voAXq3C_kC+G>SF;4Rfy0T(oJhtO7ey$#1(Z_Rh(`L_n*7cgF<}~TIZA%
g@7e5{+Mv?EuKLcra)MEg_IH8~tYvr$t#LQ%9}s8<P5=M^

literal 0
HcmV?d00001

diff --git a/examples/widgets/doc/src/eventtransitions.qdoc b/examples/widgets/doc/src/eventtransitions.qdoc
index 2c59d0863d..4d332c0e00 100644
--- a/examples/widgets/doc/src/eventtransitions.qdoc
+++ b/examples/widgets/doc/src/eventtransitions.qdoc
@@ -29,17 +29,29 @@
     \example statemachine/eventtransitions
     \title Event Transitions Example
 
-    \brief The Event Transitions example shows how to use event transitions, a
-    feature of \l{The State Machine Framework}.
+    \brief The Event Transitions example shows how to use event transitions,
+    a feature of \l{The State Machine Framework}.
+
+    The Event Transitions Example illustrates how states change when a
+    user enters or leaves the area of a button. The states are handled by
+    a QStateMachine object. The screen consists of a QVBoxLayout with a
+    central button.
+
+    When the mouse is outside the button, the text in the button displays
+    "Outside". When the mouse enters the button, it displays "Inside".
+
+    \borderedimage transitions.png
 
     \snippet statemachine/eventtransitions/main.cpp 0
 
     The \c Window class's constructors begins by creating a button.
+    This button is added to  \c layout, which is a QVBoxLayout object.
+    Then two states are created: \s1 is the state
+    "Outside", and \c s2 is the state "Inside".
 
     \snippet statemachine/eventtransitions/main.cpp 1
 
-    Two states, \c s1 and \c s2, are created; upon entry they will assign
-    "Outside" and "Inside" to the button's text, respectively.
+    State \c s1 is the state "Outside" and state \c s2 is state "Inside".
 
     \snippet statemachine/eventtransitions/main.cpp 2
 
@@ -54,11 +66,11 @@
 
     \snippet statemachine/eventtransitions/main.cpp 4
 
-    Next, the state \c s3 is created. \c s3 will be entered when the button
+    Next, state \c s3 is created. \c s3 will be entered when the button
     receives an event of type QEvent::MouseButtonPress and the state machine
     is in state \c s2. When the button receives an event of type
     QEvent::MouseButtonRelease and the state machine is in state \c s3, the
-    machine will transition back to state \c s2.
+    machine will revert to state \c s2.
 
     \snippet statemachine/eventtransitions/main.cpp 5
 
@@ -67,6 +79,7 @@
 
     \snippet statemachine/eventtransitions/main.cpp 6
 
-    The main() function constructs a Window object and shows it.
+    The main() function constructs a Window object that displays the QVBoxLayout
+    object \c layout with its \c button.
 
 */