From f0bef0af0200a276e7df3418533a7f532971d781 Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Fri, 28 Jan 2022 17:53:20 -0600 Subject: [PATCH] Added MT and TM --- docs/art/views/multi_line_edit_text_view.md | 53 +++++++++++ docs/art/views/toggle_menu_view.md | 83 ++++++++++++++++++ .../multi_line_edit_text_view_example1.gif | Bin 0 -> 13256 bytes 3 files changed, 136 insertions(+) create mode 100644 docs/art/views/multi_line_edit_text_view.md create mode 100644 docs/art/views/toggle_menu_view.md create mode 100644 docs/assets/images/multi_line_edit_text_view_example1.gif diff --git a/docs/art/views/multi_line_edit_text_view.md b/docs/art/views/multi_line_edit_text_view.md new file mode 100644 index 00000000..870360ba --- /dev/null +++ b/docs/art/views/multi_line_edit_text_view.md @@ -0,0 +1,53 @@ +--- +layout: page +title: Multi Line Edit Text View +--- +## Multi Line Edit Text View +A text display / editor designed to edit or display a message. + +## General Information + +:information_source: A multi line edit text view is defined with a percent (%) and the characters MT, followed by the view number. For example: `%MT1` + +:information_source: See [MCI](../mci.md) for general information on how to use views and common configuration properties available for them. + +### Properties + +| Property | Description | +|-------------|--------------| +| `text` | Sets the text to display - only useful for read-only and preview, otherwise use a specific module | +| `width` | Sets the width of a view to display horizontally (default 15) | +| `height` | Sets the height of a view to display vertically | +| `argName` | Sets the argument name for the form | +| `mode` | One of edit, preview, or read-only. See **Mode** below | + +### Mode + +The mode of a multi line edit text view controls how the view behaves. The following modes are allowed: + +| Mode | Description | +|-------------|--------------| +| edit | edit the contents of the view | +| preview | preview the text, including scrolling | +| read-only | No scrolling or editing the view | + +:information_source: If `mode` is not set, the default mode is "edit" + +:information_source: With mode preview, scrolling the contents is allowed, but is not with read-only. + +## Example + +![Example](../../assets/images/multi_line_edit_text_view_example1.gif "Multi Line Edit Text View") + +
+Configuration fragment (expand to view) +
+``` +ML1: { + width: 79 + argName: message + mode: edit +} +``` +
+
diff --git a/docs/art/views/toggle_menu_view.md b/docs/art/views/toggle_menu_view.md new file mode 100644 index 00000000..65c1eabd --- /dev/null +++ b/docs/art/views/toggle_menu_view.md @@ -0,0 +1,83 @@ +--- +layout: page +title: Toggle Menu View +--- +## Toggle Menu View +A toggle menu view supports displaying a list of options on a screen horizontally (side to side, in a single row) similar to a [Horizontal Menu](horizontal_menu_view.md). It is designed to present one of two choices easily. + +## General Information + +Items can be selected on a menu via the left and right cursor keys, or by selecting them via a `hotKey` - see ***Hot Keys*** below. + +:information_source: A toggle menu view is defined with a percent (%) and the characters TM, followed by the view number (if used.) For example: `%TM1` + +:information_source: See [MCI](../mci.md) for general information on how to use views and common configuration properties available for them. + +### Properties + +| Property | Description | +|-------------|--------------| +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [MCI](../mci.md)| +| `focus` | If set to `true`, establishes initial focus | +| `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** | +| `hotKeys` | Sets hot keys to activate specific items. See **Hot Keys** below | +| `hotKeySubmit` | Set to submit a form on hotkey selection | +| `argName` | Sets the argument name for this selection in the form | +| `items` | List of items to show in the menu. Must include exactly two (2) items. See **Items** below. | + + +### Hot Keys + +A set of `hotKeys` are used to allow the user to press a character on the keyboard to select that item, and optionally submit the form. + +Example: + +``` +hotKeys: { A: 0, B: 1, Q: 1 } +hotKeySubmit: true +``` +This would select and submit the first item if `A` is typed, second if `B`, etc. + +### Items + +A toggle menu, similar to other menus, take a list of items to display in the menu. Unlike other menus, however, there must be exactly two items in a toggle menu. For example: + + +``` +items: [ + { + text: First Item + data: first + } + { + text: Second Item + data: second + } +] +``` + +If the list is for display only (there is no form action associated with it) you can omit the data element, and include the items as a simple list: + +``` +["First item", "Second item"] +``` + +## Example + +![Example](../../assets/images/toggle_menu_view_example1.gif "Toggle menu") + +
+Configuration fragment (expand to view) +
+``` +TM2: { + focus: true + submit: true + argName: navSelect + focusTextStyle: upper + items: [ "yes", "no" ] +} +``` +
+
diff --git a/docs/assets/images/multi_line_edit_text_view_example1.gif b/docs/assets/images/multi_line_edit_text_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..acba094d96e0818938277fb1824b367dff3ef899 GIT binary patch literal 13256 zcmeHtXH=8vx^@TwlF&jDLa34uAcP`aR6sgO0O=hS5RoEElL15|)X+Ny1Pnbi301Mo zP?e@4U_nIz%P4kGM@MIS-o)7qGvCMhX0LVj{(hYE{$j0{B=`N??Ygh)v8GrVZ1+3H ztHSdOL<+;E|BwD6L5C}0bF(eX+LZQ%Tw79r927{51kicTGl9G~AQc}{=(lRnKva+&r za&lX?Y>}6j$Kh~zJYGRTfj}TADk>@|DJd%}6Ny9;iKMEks-~uwOr}sMR4UcR#>Upx*3Qmu_wL>H_Vx}A4vvnFPEJnF zCJ<+5XBQV2S65dzH#c{8cMlH_Pft%TFE4LzZyz6@J$v@--MiP<*VoU_&)?sF|Ni{} z0RaaN90&{yJb3V6P*6~CaBxUSNN8y2p+kql!om(8K78cJk?`>Fh=_>D$jGRusOaeE zqeqX%#KipY!w<2sv2k&6@$vD;jvY%#NH~7{cw%DWi4!N1l9FgNT5@u7N=iy%)Y6ciK|78Vs16&Dwm zl$4Z~mX?*3ojiGx!C;h^m!CRys4AO&0TZAAlr)$EMUi~Q*fql$2nA{-xwCdO8>T!yipl*__oF>5ExgS(rTA@$e^K z0Suq*Irh>p9d%)}^<3wpD+LNRW#h43PbL{Up=CaC-9KMvnrAEBi|ctl%W`hL>>1zt z;x>E#NxxEuu zOoCvbB}x2Bti@#7=*VIU!pZ=ZjC2cHN)vRXFQv;Ev-~pT(?31Tz?TL2ClIPx%UMee zW6Rl^yMOl2(Y@tyKS%#5>rt4&>t~Phn?FDw7g!wr2vx}PaeQ24`!pt?$j(ZoA=I9< z{Yj}uvfF_&pP0{k!}g}DDEXV^1wSo!FU@>faY&;f@KpHa=d-6GZv`vcML%f%xmx+j z_|K=4_6h_tQ!(%bX1Y?#GZ(tX%CkC!&#>q9NmT0dh9A7Lo;QYvOgwKo7!O}z?aiXD zG`m-1t+d#-Osuq;oc{)Y(YAep`l4O)Zq|!4$}1BuI^=(azhq0mZC-XFq_SUj!AO%Y zyFohyU-f*Z*u3gp^~`?N_ab=m)!F4Z!Pn;&^r)}i+qhwQD}lr`E0qpBH*RUGUlV z{S8~m-1jrqDp%jn?%FQ=VJ>6B_QTB#O74eS8o^gT+%|^^f4mbIXZLYlzC8EiUFqhl zAMauMg@3s(Hg5OJg3x^KFAoHsf4ln2gT!yge^^YuZWp_BWJ}(syIETkV;<$@3&%a) zXTSUNt+IWIN1s;MUyb|O{)EV{Gqw4N(a#%2bK_TbbzJ-P+L@mcqh5Ahw>|c1>%+V+ z6X)L~M!xwmUnt@27E$}JmoINQ5wSX9Kb5d1x=Zx8p&9!V;U8{^<{ba{?eO*AetdA^ z#F0?(P_Q;{^^G~xPVN9mc8Eo%EcfAX9`p6I*yvmtEwwi{}RpXrq#^B|L@Hsn`iRbyrAURMOwhx*C?qKJ@^NGZ^+9iYP** zJvICpKHI!oqN}?~D?!;Xn0P(z0lWI+9L{)ces%cxDvJJ(uRkMrNe&8L?aUHGqS@Bw z>9mlp8j)873kCQ@rc-nY<`PRqr{#uAWKUh&S0Z_z%1q%zSG`iZBGox-va~Duq{i{) zt@}x{zB4_IBNtV6=Qqz*k-D3V!;~CS;8$yqM=Pw1TJ(xr<_>B1Hs4Pmx%{MZvpK7~ z#Z6t=tvl;ld*sooy}z~W946h0E$VH1Z>Z|^rukOyN_YF=SIRz*;M4sxN0~8~T1^G& z+br^||(qE4L|)poO>A8$K?SM^+Q=Yw6tG_cus$DT4wE5kmLR~KK?!XI1|_>dt&)YnC>w;!h$I&) z<45z^&*Y=&DMZwUoJ7ul{7LP9?UavDQ#T+>A z2o`O&FHCglN3T#wzJpR0VExgn-9b0N9+Q3Q-e>?9{SxFOLI|m6c7wbkXLabD)0jFVZBAEdDvp9CC?DcBiXPt0tF8SfQ;N}!vw6@ z<0083w?bV?gyLkHxXq8Y*r-7BllpwOrkYU)uT|+wkU<{`vQjJY*2Ytr$yu{ahIQ0E zP$mFm+-#V4CVF4E@p%lpDK_-HB#ZbD7wLIp!tS<)&Q}XV|A>hykn_?YB#<}tAXrI~ zC0l-w4}t^$RzZ?raw&*1XW@XNr(;n?_*e^EjveGizz8%&UQrlsKgAI9CtOBBoR3FR zbo}xttL(qsQU;?`|LQ9pr~eG#b%T)!$!zouL6b&T2#WN<;oL1mVsU$ltXJ?2gxZRHxQ!veyR{0US!EMX+ zaHMm?q3lA`=7xhUs^)QMJshC~$}%?`e&54^OtRWM9HM0Cdxty-ufAno0(7X6pX5+S zU8MB3n1KLXc@+*$yWQb?$?Ogl^MctBWW7SP`FO~yCv-mK=oh!Jzf&bn>!GRx!8AFc zGUfjss)0;5wjoaiF>_HBEv%y?V=*|_fp$=pLZ3h)VHLAg-&*8`igR9*kh2%R~>At5MAg{5yEP+F2 zq@dYay~)0IPY@^P@A0H9T!?)|WlTzFRCgx%i9MhE<%n-e3T#p@fgxY`w;JZYzlLy; zpBqAQ4G_Y^+z{3lZw%oM*oF`uT0f3r5DdXNjtX8dP*LX)1?DCl&=|)7cC97Y6CQXj z_FcYpzSMTNR2Md(Ef+6-9v3@7A1F{kok{Ig#!WFGfwvMU2*ur1`p1^hL6=J{VD0cS zx@HMTsyLn~_I|DeRNCqet2}qUzU6j@IS*adCgu=78dwc1Lu=Z+I|FPd(i)z$1Bl+{ zR<8}_$lheHjg=qwe|X8q^^(Ey62kQoU%t`HqK#hu>yu#9Po%FOSRtr)Knf}d<4x9v z5`kR`$3ufCh*U1IYt86L1+O+}#H^4BJJ9$3Gej)`e8g95z_cL1yqM_PCG)HZH&vqQ zee0sZTf((+(htTjC3TeTYBaCrXiG&aPog>qUIwsc^^<*IpWBuK8-Pi2ewMV4d++%z#n z%HtsTrAAYg7R1m@6tu=M#fC+0Fq0piYx3w0fa&CMzWzQW+QaRI?Fr> zqhuk^h*Db^D@YU%^u6>D^PP=3 zuGOWkMh=8=leC3`%Z339^%Jn2%O+5Y zw%7f!!u={4=$)jIC}=%7Q^}rG3AK4LQKBKxm6I8+WJl9K@-#=qkB(T1D-Y zU5b>RM07XLrh;mzRisj$EMV#1t7zIAI)}6vPM&+*tLo9|H(pj1k9l=xV_IJMYZWuW z+$#2{1*%x)dlfhTsfytndex@Em|J%>8E_SiZt*1waGDq}e&y`gc;g^)=Tb7At>ku} z__o#}PsS(^((hPrRfN&1w&P_# z5zHEbofUT0Q5(L)0#ObuP<3zfZM8C?Vji`!eXo=$9>ctH?G3%UF_)JBvqZRP(wk!z zwnaXj1{E0cV&VLT(%4cvWEl0eDVbPhkz}k`9o7V)=r2@W2pZ2(w$@fFkMy_6*eYOL z0P3`WUaxH$NN_-k%SzwH5Xa=Rn9m)}SUnjPBF>ZX3LFNk-; z*6|gvN{Wk(@NjeVK$sCC|Kd?@mSn+3swvBet>=RN`Zu6 z@&_@Y@`@O?Z%sRD-9MK zxmO60-Yc7%Ff=7`R9}}tAtYfMHV#REk`!>P=V*4+fvK-{PtzpbKoCC)0ybO_Ry*{cqd?yiPjP6 z!8+Di=V6UVhDido;{|v=V=}MUbbU5}9cTvWpfLvcHRs$H5IfN15!5`XFUuCmRDd|G& z+Oj&W7N8Z6i$9Z1I9W12Oy7=>JB01rKbpO!ACtf^-w<@ob@RFC)q&_jBy!Pf0aDGw zV;#L7Cr~1}=r!{@dX-Fa*c`ozliBazW~YKV==I#dQz(F5<^Djg)bHq38$hqEjR1PB z_?OYE(Ynofz>&+`Imp@A#Qc-eh&ARJ%9>gUxsiBh`E&{Kaf6<45i9T+>vw{g%}My0oxpGCJoS*xz$Fg>-`iU`29 zw2*~(L=u3wf66j3?Q8Sw5*cdw01s~Q_Skx>CG3k^fKR{g^IM~z@bZ7molVn)x?W_z z?;7&ocMT{9!lir%s(Blm|H{T)!+qUz2IyU?6c)});{XF6tTL)CLkdH!jD3r1qoZ~3 zJ#@$YR(W!IUI~m0Q(A$bwO4eqQ;nteezm~hezDqQ4a}8k0%$d6}nSemKIaHWu z%Y~JrSq^l8QscA(W?-@G#1vu<5MOM`@O#Z|LHhsD( zRN@W!(y`f(AHEcjH>6g;dhM6~zGMu-zb_e}Oecss5BM=_F$>rSmvKaxrI|@4myKXJ4*xy^Sti;v4ANIS6hOuDJ3b%&3i@1#nU6`u?L`IcU+M2F|4W3WHr z|A=)T zw`)I5PGuH*X#Snmgto5D-6^_`@(6#jlNWVqt){Vr*VL0pWtuk9n%xk@QY|w_8r$rh z!5!MnP^~`8VgByh)H{l{vn{TIOyF1#>o6HMXJ7jWhOhN0ru1x8Q;%O;{cs8yzIZkT zCOU`QfNVC+u>Zyvf1FDIFcHw?qydv;J|Nv<3w#0eB&lzR?erhY&}c3W0KWy$Df=LQ=d z-J|j7m6?r0d{ZC($f<)M7zj&d%X13=?ZI9eNJEI~mjr1p4`rdZc)8FEYcA(Pcg8?e zisZ*q6?awJ!WIL_8K^yhsVXSNsWLr4#K~myW&tA3KT5*8adIAjh+|2u4;rkqsnb8Y z0}-3lmQp6$eGrI6sax_e1awuH{yApl-Wua!BhKYRR6!)Z(YK$8P zrL2>+M!=wO#xmlGBBX1=`g4bFa-r~GHG%4c?j_=?*&4VIlm8ktPp zb-AjV+3bMUl^@KtFhe4A6$kh+L>c})Lk(ICkhrW6&Y|44-2BlbLyPy$RDaaLY-tC& zoSm00-*wh@@AraddyD6q-Ot7dOZUE<-&*x=B78SJ%Refp5(HD@5-o_|IWed`M281l z!t%`qdf<5+{W+dTFcBKh>49xVf~Pn=Frd|0)4ttnJhEooxj1sA63uF~OC}!g(v@@x zvZ@tK^Br;-Bl75+fyNZd`7zgPtDk0%e%17pJYIpktmXifW` z-hgu}0L8!|7ll85m;}hhKT`~wdXl)_Bdb8;1Ie!RBvY_Cf9;Mj_7bo&ODd)IPS;q1 z5rT4+9`F2zb09rmO5MUmPe4pRfRDp07D0e!`kJ7u*$+ zHqjeO1p)X%*ro;$^aEizdj$Jh?tu^8KHm=CcIHk$;>BG)Zzh1e6aSL}7p-B=sg{tW#xGb_k&Xg`wo+{mMwYP@p`kV5a~F3v zD9(}EJ^>}CTWI#iW8V>mv()$K2dG5hrYdyQmt|t3ng*(kX|K_wwejIPcFYiYxTpDg zlY;~pprJ^vFmzYQLdDIbn;p&+ob0g@-a8%s<9T|=`a-;V58QK8H#vJ|;XGs`8>$LY z2I7wb;(rDNi^XzCY;OGN1-xn=HJTKe57S7#bgWoWd@P|x#6c9$8_19SaDuQfdD9tx zf|ZP@7A}&4@+)xekc)|Mm~D_U74=(sw%y4TVJv2eP6kKA#jfJK;KMxh_zB+Z5_ z11%iC8=LBP7e-oE722wGOU8g$TTW9ZS{kBD8i%CYeI2P<;e1GfK}Dbo5ntOx*}8Sd z9`dq_i$|Oc7HVU{GAEtD4@C~$QXf@|#)rT{e_&!wk{Cku;mWntqT_s+w3{tg2DEIf zhYD0BEQYK~RIKrzak)QV7e^<`Ri(EBH(MmZ9#_vF4b2uMj#b-v_knMp^Yk7m?%$?{ z?~i)(u}U&F{Pu9>q+X)W52N7eI-8Sn8+z0};3!47M~T?j4SmR(8`iQz>nQ^emIxqa z79}`zpbxzn*XYjnHQLVR5dDYnLlfceYAf=$=taIf7oLB)SeinLMs7t2z80jBG6E8FJ>er&S(sA1#fMUtK{4PDiS7gh+j3{ z@&JdHvHgL#`x-HB>M-l``M+YXvobBdU!Ge`pB7}9|bN-G+W&+7-LomyO-LfO*H= zwD)i~?Ni&ry}*1()xB*78`68zkT3ynh}>5B2=Io;^~MMSe;GB+6iY)Wm_?fiVA@<5 z+Fq&RDJH!7821AsJ&qY8#o$bjLwuGs)wz)9LnF1*BDN(+*P$JJj^LuxT1Vh>^5`bB zDnrMK9%v!axeigd>;rENc4Rq~Vvc%=uQ+B??45dlol~W?fwzOaqF~_BUv0AvW$6Vdy;<<=N8|l3B>rp%f^3IVW zgT@AE4!_fnXok~Z1r|PQ;b8_hxPPwTx`nL;Uh=>> z!k#Ke*i+P)sA_%A5%$);3w!;?KIf^M0C)a|Hrjh-ed39&l1H>bXJb9xK$ar|kxSJ$Jqiqp}A=$P%wVARFuQ1T8n$$TKn7h(j5Lx0}POIb-!fhlI zD+;iA5zCkJu)C7$p%Da1wvt4aZDzQl4OqkTvhDWSfUAYubVOP{y`8lo1}F3Xw%P@d z3<4^|JrmKvm%)a0s|loD(#;mfofwX8aeJc$uh&nVBNCy{v6va(MWR+*CPySn{Q$^V zw0+uM=f*k}tPSeS@{mgrI4N6{YMBco^2tz{hUAVMm14YIs^$^oSX{BP-D%Y|+e3_% zz#?68VbP88o@O%;py20HYd9AwnnH4S^t_mE_r8?H*Xr8l4i0F*a7gNV8*TauWUdsq zVhcgmu*V2frisb#*E&y(;9>pbf z_zovGaLF_O*~HwjzA*3J;Dw1?sQXKw{-eVfpowmMxY5c@8xD-;pV+Jl1bfUGv@8p* z`If#ABEu0CZ-hJ}r-w{^WadPf