From d78bb4d1417565db27f2f0182fe8fc541b2eaf22 Mon Sep 17 00:00:00 2001
From: Robert Jelic <36573031+NoryiE@users.noreply.github.com>
Date: Fri, 21 Oct 2022 21:13:09 +0200
Subject: [PATCH] Docs - panes

changed panes to make it more clear why they exist
---
 docs/_media/pane-example-1.png | Bin 0 -> 4128 bytes
 docs/_media/pane-example-2.png | Bin 0 -> 717 bytes
 docs/objects/Pane.md           |  31 +++++++++++++++++++++++++++----
 3 files changed, 27 insertions(+), 4 deletions(-)
 create mode 100644 docs/_media/pane-example-1.png
 create mode 100644 docs/_media/pane-example-2.png

diff --git a/docs/_media/pane-example-1.png b/docs/_media/pane-example-1.png
new file mode 100644
index 0000000000000000000000000000000000000000..f4412bf869f28bd965046b29c6dd5e0966c98220
GIT binary patch
literal 4128
zcmd^BYgAKL7QP6gZB<%rJ430&*0ONKifs@S8Uocepa^2CnIJ=O<RL5|APOZR3E0k1
zJJqNt1p>r1AgDZ|QeF)qRJ1$-1c?wqAX*?X1PJ6o%;P3=Zg}Zh{n52L|N0}zy=U)x
z?%Ch>?QiGo!9d*FSKoORf}pkjetQo=&<YH=E?8{~zAp#9a~%9wB_G0l3RQK#D+4z+
z(Y^<KA?P;aHRG|B;Qp0FKSDADt!qI(R;{G#5n%0O|GmCneib$~?3>`^|Ay@o``T|Y
z>%FRaJbdmtxE=jqU2|w=!#)p>aIb$_ulIQ7a%<G)TTM?4XKW%d>M;JiTvPt7BAYz<
zrO7qocJA50yLsX!y4h4lf}l%=`zkz?@z4ze`Mi?v2wk-~U<VyMQ@RS;^0bdc;u>aK
zrHUtdZ<=;kl}ePfw5BqMX1Gp_rNL7uv+nuMs?EA$T~?6UD7&Xuc4-yf-gIrGNmI@P
z8FE*%>bXW>Hgt`O>d!~1#PmUu*~+uL$w(c;riaiuA-E)SC9OydYwZMLZep)Bbor{x
z3fkABh9IY0*?Tp`Xbjdko+VY(-Y0yAQ9d54>yj|K)kc{JRm6MzcJ$xo+DO@AcczCB
zJUU*I_0Txi&y~P){ey%w9@j~nEN>K#tbpo2a>kTIm6iq3j^;Gx6?yC8ajMyS34%%*
z%^4I<2qgP;1qis3E_FrW6%XNN@dmA+sNo~9Y2xu^Q1ToPF$-mxYoembo2=2ubIY;P
zRi1-fXa2DBfl!<hr?Ok6iZ*}Jpu*Kqf^s-P`AGFs2{{__2h(_d9VM<-nS`Zze`mn6
zc|Q<^NVO-(P{w)-3)8aqcCst9?IivsZ3kJ*9T(8987DN+s%ZdC$I0G3v0((Bs1e^U
z>h7RKVsK4xitq~27t1kiQIr7Q`2Kb`@?^4XagGzIv`jIgj3U=|NeaPBB6owW(HL#M
zhp;;3$VfoYd1GI6LU$Fm!wcEEcj+9R>I;LD0d^5PyoA>Fxi81uFg*{ZF@$OFm|s0F
zVe{#`a<K+!dm;AbFy+n=wfEj>Hzp~yx<a%$i5Jo|e7yP!!!WA~9^#Q<t}!3cl`p~-
zp!vz0d^2^W_AUlfBDtagoDh^@1O=xKR0dcc7Fstmb(5sdL@R_H7r8cH+o2yM=-6<F
z{^W|+@52N7!^){TW_LP*4lWH4nSOf?^?uvE<@)J!0Rp9m8Z%28qud<tQpYj7ER`Z4
zMv<p?l1iheDvW|cnXUot!Iu`--6T5EHF?ZxIYSu;2)VP|7HCX~JAy`Mx7x=x>gCu0
zyHh_d@;t_npw>wQrnKpuV$QfkW8&-ML2!_jlG;JWtk?daQR=o#yUH)t6F(GB-yY~_
zg`a~3BG(i~JFtMvLIc#7Wj$=XGvdsfO3{^hw9R$)&+CD0dR0I0TYC6KM^D#F<<*z#
zu{RZ0H1F!h_r_ml82Tm_swq%k$hWA!j?a|IZshRvon6RAmQv?~lrE->;2`Z%yA=a?
z@vMg3i?Z6kbhsVDJ+akj%!Qv3iG(ARF2{P*J~)mxqQOvdR_<pyVR{;Fnq*1CRNSKp
zVG3S__;Zf71dd59L-au>xUv|(n(jEBHS{T`9GR8rLkwi0Pp%jjEhBF+B#K1?RH+n8
z-w+$bHB)ndOaQ09fd$sZtaFjI$|;f5_yT|!8j#8>xPDFv1PKR^_}k6=Ymj#aI+<h<
zfxcV7lnp2^c?gAHd^pd&0BIJ%oO#b{7tUon9zqMzOfeI<fv|uDvc8|dw-c!n$)vux
zG23xVG3;WKv2(#Rx3~MRYYvVg`^Be}uKG9^F^f*5?_!pkJKyoy32o7~RF+%P#$j*s
zt!#6;#R!NzS|_TK<@B;<B135e#yvO^^G+SZ!2g}*Q6q1<Lz{CM$Fo^ZKm|pyx^mtb
zS_(YSNI_%^cn%rC_w(jlo<)lox?)ZB828QyQkAQ7Y;pP!`w0DVD&oY5op!3#d9r~N
zj!}44R5YNEBI~DL1ZmMx@RcYPP9ELPl*N3mDIa5dCnu*^poR|SEVX=iY1Tu;I=>#s
zb8Kr40Apr3c2$;nK1I=fQtQ7#^k7P5=cN;9N2SH}W{ten_&`rk{-5*{Mi3*#I7CpQ
zfIhgu9P#v(@T9&vO}pri><VJdJQo1Gs4sc@XuE?Q#z$#27QUgY+vZ1!AV5(2c$^j3
z2-*^;B9){o7Yr5rgYN!<2RFpRx!4fwe&Do-2>+n7B(Ug@+UZRwEb2bYCSoOwe!(Th
z@JSWf90|LF;WHJ)@rvYvX5y1|>2Cs~@f%|2khG8Dz~PNxfgMJ7<&`dtSIfW|0<8>8
zSJk0MiW%AT7=2XiBByGBH6Zd}b#clTCQ4c)d{cAWbOPR%#;)){%z=M)a0^OX-iI20
zVYX1guo>QNKJ{x&bZt{!Q4@tf-z(LKKQ9j2!waNFk@JJ$tqZ`-i|*Re`H=CCC?y<e
zr5%X*EXNx2L0Vgz|KeYj#gQ^^oGa5+U1qCmUI%~iO&LJ`Z$bW_1@5i-H2e%?gYk=t
zsa<6~ov9IYt2bFe0f)es&C2zV&sV8->!IfD1&j9wf9FM`a-45hbah+IPvyHrFTSke
zzb&?#_mjw^!tVzMPK?GTYdko!)6VV1nn+W-h-lCd_fcgL{rYPL-f8dH=;Cwbo<uB>
zAl4t3i?Ctr7F(!!t7qJfUV}ppI<ED!$g9O&)-XZQ^1$5<*4#n*1l&{Cw9Wy7%Aei(
zxvdxdNo97hmqUDLeAS43t+n_l+;gL1!gyTnI&7{~St6C#uOr}(<k~8FV_4Q&DC4k=
zJCu>Q!U6Kx75ykYLT2yyXoZ2bU$O?-bafmAJzYrnBopQynMx?<dRDpP>F6(r61lY8
z6U(7hx{hwGrR@qf7RpzN&!cu<43+XWVlOUa!x+M7(qSo*OM>^D9?@q_7(=OBGuJ|!
z3Yu-9*8{_?q194H_rJ=xS<<<_sTsG*CRI}R{k|VkL%SR5&FLZVOkm&c{UXJ%Suw(U
zx2P1;*fML{cp-Vh3njhI$~ig@0_70|{r$77wV&sVs7E~QYpNgo(kGe7>J}_vjm5(~
z{s0Yajj0zFd!mq(!-Z@XyMhGY*2qz8(J^Z%{H=}PDDYaoeeLK^^1@?Gbvzdxhr6-#
zo^=k**K*Bb+l<dnS>P(_Z@*r6&K+Q)So1g&2Oi;6o7P;?v{r~YrdjevcL+N21~}W@
zR}d@<j(vUcTJ%@puT9do=b^z$#rwCcpl>!H36<Um-!ZbK1<Mo5^t=q2^PeQ`C-}J?
zy<XoZWf7@!a-tYxofxvhp=YX$NK4bSFi>pTj1;@HsxYg|p2}wIGlZ`{%1AI9vRP|_
zvIJ1Uzng7O8HUSPVeoi%(6p(BZu{iNDsdClAbM&KW%zi$pmWd&e@>*K)qfUE{ozXM
z|3ai{`es%`KKaxmlv$04XtxJ~dMB#~|6_;pUV~hxKc9IzVYW(q`_Nk^`&#XbQ{jKN
CXMj@x

literal 0
HcmV?d00001

diff --git a/docs/_media/pane-example-2.png b/docs/_media/pane-example-2.png
new file mode 100644
index 0000000000000000000000000000000000000000..99e5c7007e8ffc9fd06c97ab61341089ebc371e6
GIT binary patch
literal 717
zcmeAS@N?(olHy`uVBq!ia0y~yV0;E-r*N<V$>2GYR{$x-;vjb?hIQv;UIIBR>5jgR
z3=A9lx&I`x0{NT;9+AZi419+{nDKc2iWCM0rg%>m$B>G+w|6(@1_z2XB+k~Ip}f+A
zSG3rm+5H38bi)R&tQCi3dJ>y<dg#qbSD&<2{>Q#&b058koGA2v*QVt4$0c@)GEDf8
z6vx=WkjT~`fCo>QJpa$vfB(|_7!DNg-Tl{Yd8*$T1_32B{OI=#Muj7tk_=8QG{V=C
zd+yHZzm;QF%)~G+d-vUQnKOlr8Cp2d@SK|PZ)e;4i=)2%x_$lc*VC(a|NT0}od5TJ
zxgU4_F28sG-=^%h^>sJm-!D)7f9ibp{~h-A@2CH(E%^U9>-+vMpX<N=yEm10&f7Wa
z!4Itd$Qv`nGy-k;(@Mx!es!P3847H%1r2&ok;~sCm;B~g&9v#?^PhjY-GAG^*y`NA
zzs}#@%5Td5f8qbO{}SqH3><<`T=^;c48wt^7KY3Y9R{S~V_9E?lkJ3GW$&1^5SacL
OJYD@<);T3K0TBT4IQ~!o

literal 0
HcmV?d00001

diff --git a/docs/objects/Pane.md b/docs/objects/Pane.md
index f0d9c23..c500169 100644
--- a/docs/objects/Pane.md
+++ b/docs/objects/Pane.md
@@ -1,10 +1,10 @@
-With panes you are able to create background without any functionality
+Panes are here to do some visual background modifying, without listening (by default) to any events.
 
-Because panes don't have any unique functionality, there is also no method list for them. 
+Because panes don't have any unique functionality, there is also no method list for them.
 
 [Object](objects/Object.md) methods also apply for panes.
 
-## Example:
+## Example
 
 ```lua
 local mainFrame = basalt.createFrame()
@@ -13,6 +13,29 @@ aPane:setSize(30, 10)
 aPane:setBackground(colors.yellow)
 aPane:show()
 ```
+
 ```xml
 <pane width="30" height="10" bg="yellow" />
-```
\ No newline at end of file
+```
+
+### Other examples
+
+!["pane-example-1"](../_media/pane-example-1.png)
+
+```lua
+main:addPane():setSize(15, 8):setPosition(2, 2):setBackground(colors.red)
+main:addPane():setSize(15, 8):setPosition(18, 2):setBackground(colors.blue, "#")
+main:addPane():setSize(15, 8):setPosition(17 * 2, 2):setBackground(colors.green, "#", colors.orange)
+```
+
+You could also create a 1-line height pane with dynamic width:
+
+!["pane-example-2"](../_media/pane-example-2.png)
+
+```lua
+main:addPane():setSize("parent.w - 2", 1):setPosition(2, 2):setBackground(false, "\140", colors.blue)
+main:addPane():setSize("parent.w - 2", 1):setPosition(2, 4):setBackground(colors.black, "\45", colors.red)
+main:addPane():setSize("parent.w - 2", 1):setPosition(2, 6):setBackground(false, "\183", colors.purple)
+```
+
+You can also do that in y instead of x direction.