Index: doc/developer/hid_gtk3/Makefile =================================================================== --- doc/developer/hid_gtk3/Makefile (nonexistent) +++ doc/developer/hid_gtk3/Makefile (revision 6867) @@ -0,0 +1,5 @@ +%.html: %.adoc + asciidoctor --safe-mode=secure $^ + + +# asciidoctor $^ > $@ Index: doc/developer/hid_gtk3/default.css =================================================================== --- doc/developer/hid_gtk3/default.css (nonexistent) +++ doc/developer/hid_gtk3/default.css (revision 6867) @@ -0,0 +1,358 @@ +/* pcb-rnd (c) Alain Vigne*/ +@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Sans:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/ +article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} +[hidden],template{display:none} +script{display:none!important} +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} +a{background:transparent} +a:focus{outline:thin dotted} +a:active,a:hover{outline:0} +h1{font-size:2em;margin:.67em 0} +abbr[title]{border-bottom:1px dotted} +b,strong{font-weight:bold} +hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} +mark{background:#ff0;color:#000} +code,kbd,pre,samp{font-family:monospace;font-size:1em} +pre{white-space:pre-wrap} +q{quotes:"\201C" "\201D" "\2018" "\2019"} +small{font-size:80%} +sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} +sup{top:-.5em} +sub{bottom:-.25em} +img{border:0} +svg:not(:root){overflow:hidden} +figure{margin:0} +legend{border:0;padding:0} +button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} +button,input{line-height:normal} +button,select{text-transform:none} +button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} +button[disabled],html input[disabled]{cursor:default} +input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} +input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} +input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} +button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} +textarea{overflow:auto;vertical-align:top} +table{border-collapse:collapse;border-spacing:0} +*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} +html,body{font-size:100%} +body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Sans","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased} +a:hover{cursor:pointer} +img,object,embed{max-width:100%;height:auto} +object,embed{height:100%} +img{-ms-interpolation-mode:bicubic} +.left{float:left!important} +.right{float:right!important} +.text-left{text-align:left!important} +.text-right{text-align:right!important} +.text-center{text-align:center!important} +.text-justify{text-align:justify!important} +.hide{display:none} +img,object,svg{display:inline-block;vertical-align:middle} +textarea{height:auto;min-height:50px} +select{width:100%} +.center{margin-left:auto;margin-right:auto} +.spread{width:100%} +p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} +.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} +div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} +a{color:#2156a5;text-decoration:underline;line-height:inherit} +a:hover,a:focus{color:#1d4b8f} +a img{border:none} +p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} +p aside{font-size:.875em;line-height:1.35;font-style:italic} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#804419;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} +h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} +h1{font-size:2.125em} +h2{font-size:1.6875em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} +h4,h5{font-size:1.125em} +h6{font-size:1em} +hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} +em,i{font-style:italic;line-height:inherit} +strong,b{font-weight:bold;line-height:inherit} +small{font-size:60%;line-height:inherit} +code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} +ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} +ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em} +ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} +ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} +ul.square{list-style-type:square} +ul.circle{list-style-type:circle} +ul.disc{list-style-type:disc} +ul.no-bullet{list-style:none} +ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} +dl dt{margin-bottom:.3125em;font-weight:bold} +dl dd{margin-bottom:1.25em} +abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} +abbr{text-transform:none} +blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} +blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} +blockquote cite:before{content:"\2014 \0020"} +blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} +blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} +@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} +h1{font-size:2.75em} +h2{font-size:2.3125em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} +h4{font-size:1.4375em}} +table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} +table thead,table tfoot{background:#f7f8f7;font-weight:bold} +table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} +table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} +table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} +table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} +h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} +.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} +.clearfix:after,.float-group:after{clear:both} +*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word} +*:not(pre)>code.nobreak{word-wrap:normal} +*:not(pre)>code.nowrap{white-space:nowrap} +pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} +em em{font-style:normal} +strong strong{font-weight:400} +.keyseq{color:rgba(51,51,51,.8)} +kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap} +.keyseq kbd:first-child{margin-left:0} +.keyseq kbd:last-child{margin-right:0} +.menuseq,.menu{color:rgba(0,0,0,.8)} +b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} +b.button:before{content:"[";padding:0 3px 0 2px} +b.button:after{content:"]";padding:0 2px 0 3px} +p a>code:hover{color:rgba(0,0,0,.9)} +#header,#content,#footnotes,#footer{width:95%;margin-left:2em;margin-right:auto;margin-top:0;margin-bottom:0;/*max-width:62.5em;*/*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} +#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table} +#header:after,#content:after,#footnotes:after,#footer:after{clear:both} +#content{margin-top:1.25em} +#content:before{content:none} +#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} +#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} +#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} +#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} +#header .details span:first-child{margin-left:-.125em} +#header .details span.email a{color:rgba(0,0,0,.85)} +#header .details br{display:none} +#header .details br+span:before{content:"\00a0\2013\00a0"} +#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} +#header .details br+span#revremark:before{content:"\00a0|\00a0"} +#header #revnumber{text-transform:capitalize} +#header #revnumber:after{content:"\00a0"} +#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} +#toc{border-bottom:1px solid #efefed;padding-bottom:.5em} +#toc>ul{margin-left:.125em} +#toc ul.sectlevel0>li>a{font-style:italic} +#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} +#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} +#toc li{line-height:1.3334;margin-top:.3334em} +#toc a{text-decoration:none} +#toc a:active{text-decoration:underline} +#toctitle{color:#7a2518;font-size:1.2em} +body.toc2{padding-left:20em;padding-right:0} +#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:20em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} +#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em} +#toc.toc2>ul{font-size:.9em;margin-bottom:0} +#toc.toc2 ul ul{margin-left:0;padding-left:1em} +#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} +body.toc2.toc-right{padding-left:0;padding-right:15em} +body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}} +.sect1+.sect1{border-top:1px solid #efefed} +#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} +#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} +#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} +#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} +#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} +#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} +#footer-text{color:rgba(255,255,255,.8);line-height:1.44} +.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} +.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Sans","DejaVu Serif",serif;font-size:1rem;font-style:italic} +table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} +.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} +table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} +.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} +.admonitionblock>table td.icon{text-align:center;width:80px} +.admonitionblock>table td.icon img{max-width:none} +.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} +.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} +.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} +.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} +.exampleblock>.content>:first-child{margin-top:0} +.exampleblock>.content>:last-child{margin-bottom:0} +.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +.sidebarblock>:first-child{margin-top:0} +.sidebarblock>:last-child{margin-bottom:0} +.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} +.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} +.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} +.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} +.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} +.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} +.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em} +.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} +.listingblock pre.highlightjs{padding:0} +.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} +.listingblock pre.prettyprint{border-width:0} +.listingblock>.content{position:relative} +.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} +.listingblock:hover code[data-lang]:before{display:block} +.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} +.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} +table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} +table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45} +table.pyhltable td.code{padding-left:.75em;padding-right:0} +pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} +pre.pygments .lineno{display:inline-block;margin-right:.25em} +table.pyhltable .linenodiv{background:none!important;padding-right:0!important} +.quoteblock{margin:0 1em 1.25em 1.5em;display:table} +.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} +.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} +.quoteblock blockquote{margin:0;padding:0;border:0} +.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} +.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} +.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} +.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} +.quoteblock .quoteblock blockquote{padding:0 0 0 .75em} +.quoteblock .quoteblock blockquote:before{display:none} +.verseblock{margin:0 1em 1.25em 1em} +.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} +.verseblock pre strong{font-weight:400} +.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} +.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} +.quoteblock .attribution br,.verseblock .attribution br{display:none} +.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)} +.quoteblock.abstract{margin:0 0 1.25em 0;display:block} +.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} +.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} +table.tableblock{max-width:100%;border-collapse:separate} +table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} +table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} +table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} +table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} +table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} +table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} +table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} +table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0} +table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} +table.frame-all{border-width:1px} +table.frame-sides{border-width:0 1px} +table.frame-topbot{border-width:1px 0} +th.halign-left,td.halign-left{text-align:left} +th.halign-right,td.halign-right{text-align:right} +th.halign-center,td.halign-center{text-align:center} +th.valign-top,td.valign-top{vertical-align:top} +th.valign-bottom,td.valign-bottom{vertical-align:bottom} +th.valign-middle,td.valign-middle{vertical-align:middle} +table thead th,table tfoot th{font-weight:bold} +tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} +tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} +p.tableblock>code:only-child{background:none;padding:0} +p.tableblock{font-size:1em} +td>div.verse{white-space:pre} +ol{margin-left:1.75em} +ul li ol{margin-left:1.5em} +dl dd{margin-left:1.125em} +dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} +ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} +ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none} +ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em} +ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em} +ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px} +ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden} +ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block} +ul.inline>li>*{display:block} +.unstyled dl dt{font-weight:400;font-style:normal} +ol.arabic{list-style-type:decimal} +ol.decimal{list-style-type:decimal-leading-zero} +ol.loweralpha{list-style-type:lower-alpha} +ol.upperalpha{list-style-type:upper-alpha} +ol.lowerroman{list-style-type:lower-roman} +ol.upperroman{list-style-type:upper-roman} +ol.lowergreek{list-style-type:lower-greek} +.hdlist>table,.colist>table{border:0;background:none} +.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} +td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em} +td.hdlist1{font-weight:bold;padding-bottom:1.25em} +.literalblock+.colist,.listingblock+.colist{margin-top:-.5em} +.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1} +.colist>table tr>td:last-of-type{padding:.25em 0} +.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} +.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} +.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} +.imageblock>.title{margin-bottom:0} +.imageblock.thumb,.imageblock.th{border-width:6px} +.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} +.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} +.image.left{margin-right:.625em} +.image.right{margin-left:.625em} +a.image{text-decoration:none;display:inline-block} +a.image object{pointer-events:none} +sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super} +sup.footnote a,sup.footnoteref a{text-decoration:none} +sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline} +#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} +#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} +#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em} +#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none} +#footnotes .footnote:last-of-type{margin-bottom:0} +#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} +.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} +.gist .file-data>table td.line-data{width:99%} +div.unbreakable{page-break-inside:avoid} +.big{font-size:larger} +.small{font-size:smaller} +.underline{text-decoration:underline} +.overline{text-decoration:overline} +.line-through{text-decoration:line-through} +.aqua{color:#00bfbf} +.aqua-background{background-color:#00fafa} +.black{color:#000} +.black-background{background-color:#000} +.blue{color:#0000bf} +.blue-background{background-color:#0000fa} +.fuchsia{color:#bf00bf} +.fuchsia-background{background-color:#fa00fa} +.gray{color:#606060} +.gray-background{background-color:#7d7d7d} +.green{color:#006000} +.green-background{background-color:#007d00} +.lime{color:#00bf00} +.lime-background{background-color:#00fa00} +.maroon{color:#600000} +.maroon-background{background-color:#7d0000} +.navy{color:#000060} +.navy-background{background-color:#00007d} +.olive{color:#606000} +.olive-background{background-color:#7d7d00} +.purple{color:#600060} +.purple-background{background-color:#7d007d} +.red{color:#bf0000} +.red-background{background-color:#fa0000} +.silver{color:#909090} +.silver-background{background-color:#bcbcbc} +.teal{color:#006060} +.teal-background{background-color:#007d7d} +.white{color:#bfbfbf} +.white-background{background-color:#fafafa} +.yellow{color:#bfbf00} +.yellow-background{background-color:#fafa00} +span.icon>.fa{cursor:default} +.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} +.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} +.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} +.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900} +.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400} +.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000} +.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} +.conum[data-value] *{color:#fff!important} +.conum[data-value]+b{display:none} +.conum[data-value]:after{content:attr(data-value)} +pre .conum[data-value]{position:relative;top:-.125em} +b.conum *{color:inherit!important} +.conum:not([data-value]):empty{display:none} +dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility} +h1,h2,p,td.content,span.alt{letter-spacing:-.01em} +p strong,td.content strong,div.footnote strong{letter-spacing:-.005em} +p,blockquote,dt,td.content,span.alt{font-size:1.0625rem} +p{margin-bottom:1.25rem} +.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} +.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} Index: doc/developer/hid_gtk3/img_route_style/gtk2-edit_route_styles_001.png =================================================================== Cannot display: file marked as a binary type. svn:mime-type = image/png Index: doc/developer/hid_gtk3/img_route_style/gtk2-edit_route_styles_001.png =================================================================== --- doc/developer/hid_gtk3/img_route_style/gtk2-edit_route_styles_001.png (nonexistent) +++ doc/developer/hid_gtk3/img_route_style/gtk2-edit_route_styles_001.png (revision 6867) Property changes on: doc/developer/hid_gtk3/img_route_style/gtk2-edit_route_styles_001.png ___________________________________________________________________ Added: svn:mime-type ## -0,0 +1 ## +image/png \ No newline at end of property Index: doc/developer/hid_gtk3/img_route_style/gtk2-pcb-rnd_001.png =================================================================== Cannot display: file marked as a binary type. svn:mime-type = image/png Index: doc/developer/hid_gtk3/img_route_style/gtk2-pcb-rnd_001.png =================================================================== --- doc/developer/hid_gtk3/img_route_style/gtk2-pcb-rnd_001.png (nonexistent) +++ doc/developer/hid_gtk3/img_route_style/gtk2-pcb-rnd_001.png (revision 6867) Property changes on: doc/developer/hid_gtk3/img_route_style/gtk2-pcb-rnd_001.png ___________________________________________________________________ Added: svn:mime-type ## -0,0 +1 ## +image/png \ No newline at end of property Index: doc/developer/hid_gtk3/index.adoc =================================================================== --- doc/developer/hid_gtk3/index.adoc (nonexistent) +++ doc/developer/hid_gtk3/index.adoc (revision 6867) @@ -0,0 +1,9 @@ +//:toc: left +:stylesheet: default.css +:linkcss: + += GTK2 / GTK3 GUI related topics + +* `cairo` back-end +* GTK3 compatibility ? +* <> dialog + widget. Concepts \ No newline at end of file Index: doc/developer/hid_gtk3/index.html =================================================================== --- doc/developer/hid_gtk3/index.html (nonexistent) +++ doc/developer/hid_gtk3/index.html (revision 6867) @@ -0,0 +1,36 @@ + + + + + + + +GTK2 / GTK3 GUI related topics + + + + +
+
+
    +
  • +

    cairo back-end

    +
    • +
  • +

    GTK3 compatibility ?

    +
    • +
  • +

    Route styles dialog + widget. Concepts

    +
    • +
+
+
+ + + \ No newline at end of file Index: doc/developer/hid_gtk3/route_style.adoc =================================================================== --- doc/developer/hid_gtk3/route_style.adoc (nonexistent) +++ doc/developer/hid_gtk3/route_style.adoc (revision 6867) @@ -0,0 +1,198 @@ +:author: Alain +:toc: left +:icons: font +:imagesdir: img_route_style +:stylesdir: ./ +:stylesheet: default.css +:linkcss: + +// Substitutions... +:prg: pass:q[`pcb-rnd`] +:yes: icon:check[role="green"] +:no: icon:times[role="red"] + += Route style GUI design + +[abstract] +== Abstract + +This document is a WIP, working document, mixture of many sources of documentation +linked to the <> GUI part, as presented to the user. + +PCB means PCB/gEDA, or mainline, {prg} is the primary focus for this WIP. + +:experimental: +:numbered: +== Introduction + +=== What is a Route Style + +The `menu:Edit[Route Styles]` menu allows you to select a style which is a group +of line thickness, via diameter, via drill size, and clearance (keepaway) +(collectively called a _routing style_) to be copied to the _active_ sizes. +You can also change the names given to the routing styles and adjust their +values from `menu:Edit[Route Styles > Edit]` menu. + +The active sizes are also adjustable from this menu (How ?). +The active sizes are shown in the status-line and control the initial size of +new vias, drilling holes, lines, clearances, text-objects and also +the maximum dimensions of the board layout. + +A routing style can be attributed to a net. (How ?, How am I sure all the +nets/lines/tracks are affected to the selected routing style ?) + +=== Using the autorouter + +Do we still have the autorouter ? Is what is described next working elsewhere ? + +Use routing styles in the netlist to have per-net routing styles. +Note that the routing style will be used for an entire net. +This means if you have a wide metal setting for a power net you will need to +manually route breakouts from any fine pitch parts on their power pins because +the router will not be able to change to a narrow trace to connect to the part. + +== Design intentions + +=== {prg} goals + +* Alleviate the limitation of 4 only different route styles. +* Keep track of "current" route style + +=== {prg} implementation prior 1.2.1 + +A radio-button area + extra <> + +==== Add a new route style + +This is ensured via the `` selection + +[[img-gtk2-edit_route]] +.Edit route styles dialog +image::gtk2-edit_route_styles_001.png[] + +Q: No `Add` button: historical reasons. The original code in mainline +has 4 route styles, hardwired. It can not remove styles. +We inherited the mechanism of adding style by selecting the ``. +(In mainline if you add styles more than 4, they are lost on save). + +The inherited code tries not to do modifications immediately but only when +you close the window. This is a common pattern in the gtk hid at the +moment: all data from core copied to some "hid_gtk-specific" mirror cache +for the dialog, then the dialog works on the cache and it is copied back +when you close the dialog. + +Igor2 thinks the idea was that the dialogs are modal and if the user says +cancel, you just don't do the copy-back. It's a lot of extra code and complication. +The strange mechanism might be a result of this: the dialog-cache +is probably not smart enough to hold multiple new styles, but with +the current mechanism you can add only one new style until you close the dialog. + +==== Keep track of current route style + +This is ensured via the `` selection in <>. + +At the end you are not drawing with the selected style, you are drawing +with a pen. When you change style, all parameters of the style +are copied into the pen. However, you can change any parameter of +the pen with hotkeys, which means you can easily end up drawing with a pen +that does not match any of the currently existing styles. + +Mainline has this too, it's all inherited. + +Using such a custom pen is useful when you want to draw a +single net of some special geometry - it is not worth adding a +new style, but you may still want to set the temporary pen up properly. + +The problem was that when you used such a custom pen, you didn't really +have a way to see your current setting and besides the `add +5 mils` kind of +hotkeys, you couldn't really set it up, e.g. +"I want 80 mil wide traces temporarily" +was hard to do. So I introduced the `` style, which shows the current +settings of the pen so it is not hidden anymore. + +NOTE: Lapsus here from Igor, who really means . I suggest to rename it ?? + +This way you can see and change all parameters of the pen, without having to +create a new style or having to use CLI actions. + +Igor2 definitely wants to keep `` in the gtk2 hid, wants to add it in the +lesstif hid and wants all new GUI hids to support it the same way. + + +`` mode is indicated by not selecting any style (no radio button selected). +As long as your pen matches any of the existing style, you are drawing with +that style and the style is marked in the radio button. +When you change your pen to something that doesn't match any existing style, +the radio button turns off. + +This is by design, Igor2 likes it, miloh, with whom we coded it likes it too. +Please do not change this. + +PCB Mainline does the same, except: + +* you can't see or modify the numeric fields of the `` style + directly (only modification possible is via hotkeys) +* you can't explicitly switch to the `` style (you need to make a + hotkey-modification of the pen) + +But the pen concept exists there too: press kbd:[Ctrl+Shift+V], it will change +the via drill size of the pen. This will result in a pen not matching +any existing style -> radio button selection disappears. + +=== PCB + +mainline has no explicit , no delete button and has the hardwired number of 4 styles. + +=== {prg} Next + +Honestly, I don't like it and want to change it (in all dialog boxes,even in gtk2): + +* I want the dialog boxes non-modal: you should be able to edit the layout while + the route style dialog is open +* I want changes to happen immediately - so if you change the line + width for a style and draw with it, it should have immediate effect +* I want to add undo code for the route style changes; I think the original + idea behind. Combining non-modal dialog and immediate effect makes cancel + meaningless, but if the user has the usual, central undo, that's fine. + +== GTK2 situation + +=== User manual + +Document this part... Most of the info are above. Select and create a section +-> See FIXME. + +Especially, document `Attributes` + +* what for ? +* expected key, values ? +* format ? units ? + +[[img-gtk2_gui]] +.{prg} on an empty design, with Edit Route Style dialog open +image::gtk2-pcb-rnd_001.png[] + +IMPORTANT: Where is `saved "as default"` ? Documentation here ? + +=== Short-term improvements ? + +This seems to be low priority w.r.t. cairo and GTK3... Am I right ? + +== GTK3 design proposal + +TODO: A mock-up (screenshot) + +A `GtkTreeView`, allowing the direct rename of style, allow sorting, or drag +and drop the styles to change order. + +Can be selected (highlighted) to show the active route style. + +`GtkButtonBox` with usual buttons : Add, Delete, Raise, Down ... + +Still another dialog is needed for other infos... + +== GTK2 retro-fit ? + +If so, then trade for a less advanced GtkTreeView + +`GtkHButtonBox` i.s.o `GtkButtonBox`. Index: doc/developer/hid_gtk3/route_style.html =================================================================== --- doc/developer/hid_gtk3/route_style.html (nonexistent) +++ doc/developer/hid_gtk3/route_style.html (revision 6867) @@ -0,0 +1,354 @@ + + + + + + + + +Route style GUI design + + + + +
+
+

Abstract

+
+
+

This document is a WIP, working document, mixture of many sources of documentation +linked to the Route Style GUI part, as presented to the user.

+
+
+

PCB means PCB/gEDA, or mainline, pcb-rnd is the primary focus for this WIP.

+
+
+
+
+

1. Introduction

+
+
+

1.1. What is a Route Style

+
+

The Edit ▸ Route Styles menu allows you to select a style which is a group +of line thickness, via diameter, via drill size, and clearance (keepaway) +(collectively called a routing style) to be copied to the active sizes. +You can also change the names given to the routing styles and adjust their +values from Edit ▸ Route Styles ▸ Edit menu.

+
+
+

The active sizes are also adjustable from this menu (How ?). +The active sizes are shown in the status-line and control the initial size of +new vias, drilling holes, lines, clearances, text-objects and also +the maximum dimensions of the board layout.

+
+
+

A routing style can be attributed to a net. (How ?, How am I sure all the +nets/lines/tracks are affected to the selected routing style ?)

+
+
+
+

1.2. Using the autorouter

+
+

Do we still have the autorouter ? Is what is described next working elsewhere ?

+
+
+

Use routing styles in the netlist to have per-net routing styles. +Note that the routing style will be used for an entire net. +This means if you have a wide metal setting for a power net you will need to +manually route breakouts from any fine pitch parts on their power pins because +the router will not be able to change to a narrow trace to connect to the part.

+
+
+
+
+
+

2. Design intentions

+
+
+

2.1. pcb-rnd goals

+
+
    +
  • +

    Alleviate the limitation of 4 only different route styles.

    +
    • +
  • +

    Keep track of "current" route style

    +
    • +
+
+
+
+

2.2. pcb-rnd implementation prior 1.2.1

+
+

A radio-button area + extra dialog

+
+
+

2.2.1. Add a new route style

+
+

This is ensured via the <New> selection

+
+
+
+gtk2 edit route styles 001 +
+
Figure 1. Edit route styles dialog
+
+
+

Q: No Add button: historical reasons. The original code in mainline +has 4 route styles, hardwired. It can not remove styles. +We inherited the mechanism of adding style by selecting the <New>. +(In mainline if you add styles more than 4, they are lost on save).

+
+
+

The inherited code tries not to do modifications immediately but only when +you close the window. This is a common pattern in the gtk hid at the +moment: all data from core copied to some "hid_gtk-specific" mirror cache +for the dialog, then the dialog works on the cache and it is copied back +when you close the dialog.

+
+
+

Igor2 thinks the idea was that the dialogs are modal and if the user says +cancel, you just don’t do the copy-back. It’s a lot of extra code and complication. +The strange <new style> mechanism might be a result of this: the dialog-cache +is probably not smart enough to hold multiple new styles, but with +the current mechanism you can add only one new style until you close the dialog.

+
+
+
+

2.2.2. Keep track of current route style

+
+

This is ensured via the <custom> selection in dialog.

+
+
+

At the end you are not drawing with the selected style, you are drawing +with a pen. When you change style, all parameters of the style +are copied into the pen. However, you can change any parameter of +the pen with hotkeys, which means you can easily end up drawing with a pen +that does not match any of the currently existing styles.

+
+
+

Mainline has this too, it’s all inherited.

+
+
+

Using such a custom pen is useful when you want to draw a +single net of some special geometry - it is not worth adding a +new style, but you may still want to set the temporary pen up properly.

+
+
+

The problem was that when you used such a custom pen, you didn’t really +have a way to see your current setting and besides the add +5 mils kind of +hotkeys, you couldn’t really set it up, e.g. +"I want 80 mil wide traces temporarily" +was hard to do. So I introduced the <current> style, which shows the current +settings of the pen so it is not hidden anymore.

+
+
+ + + + + +
+
Note
+		 +Lapsus here from Igor, who really means <current>. I suggest to rename it <current> ?? +
+
+
+

This way you can see and change all parameters of the pen, without having to +create a new style or having to use CLI actions.

+
+
+

Igor2 definitely wants to keep <custom> in the gtk2 hid, wants to add it in the +lesstif hid and wants all new GUI hids to support it the same way.

+
+
+

<current> mode is indicated by not selecting any style (no radio button selected). +As long as your pen matches any of the existing style, you are drawing with +that style and the style is marked in the radio button. +When you change your pen to something that doesn’t match any existing style, +the radio button turns off.

+
+
+

This is by design, Igor2 likes it, miloh, with whom we coded it likes it too. +Please do not change this.

+
+
+

PCB Mainline does the same, except:

+
+
+
    +
  • +

    you can’t see or modify the numeric fields of the <custom> style +directly (only modification possible is via hotkeys)

    +
    • +
  • +

    you can’t explicitly switch to the <custom> style (you need to make a +hotkey-modification of the pen)

    +
    • +
+
+
+

But the pen concept exists there too: press Ctrl+Shift+V, it will change +the via drill size of the pen. This will result in a pen not matching +any existing style → radio button selection disappears.

+
+
+
+
+

2.3. PCB

+
+

mainline has no explicit <custom>, no delete button and has the hardwired number of 4 styles.

+
+
+
+

2.4. pcb-rnd Next

+
+

Honestly, I don’t like it and want to change it (in all dialog boxes,even in gtk2):

+
+
+
    +
  • +

    I want the dialog boxes non-modal: you should be able to edit the layout while +the route style dialog is open

    +
    • +
  • +

    I want changes to happen immediately - so if you change the line +width for a style and draw with it, it should have immediate effect

    +
    • +
  • +

    I want to add undo code for the route style changes; I think the original +idea behind. Combining non-modal dialog and immediate effect makes cancel +meaningless, but if the user has the usual, central undo, that’s fine.

    +
    • +
+
+
+
+
+
+

3. GTK2 situation

+
+
+

3.1. User manual

+
+

Document this part…​ Most of the info are above. Select and create a section +→ See FIXME.

+
+
+

Especially, document Attributes

+
+
+
    +
  • +

    what for ?

    +
    • +
  • +

    expected key, values ?

    +
    • +
  • +

    format ? units ?

    +
    • +
+
+
+
+gtk2 pcb rnd 001 +
+
Figure 2. pcb-rnd on an empty design, with Edit Route Style dialog open
+
+
+ + + + + +
+
Important
+		 +Where is saved "as default" ? Documentation here ? +
+
+
+
+

3.2. Short-term improvements ?

+
+

This seems to be low priority w.r.t. cairo and GTK3…​ Am I right ?

+
+
+
+
+
+

4. GTK3 design proposal

+
+
+

TODO: A mock-up (screenshot)

+
+
+

A GtkTreeView, allowing the direct rename of style, allow sorting, or drag +and drop the styles to change order.

+
+
+

Can be selected (highlighted) to show the active route style.

+
+
+

GtkButtonBox with usual buttons : Add, Delete, Raise, Down …​

+
+
+

Still another dialog is needed for other infos…​

+
+
+
+
+

5. GTK2 retro-fit ?

+
+
+

If so, then trade for a less advanced GtkTreeView

+
+
+

GtkHButtonBox i.s.o GtkButtonBox.

+
+
+
+
+ + + \ No newline at end of file