Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 1 | \subsubsection{Viewport Declaration Syntax} |
| 2 | |
Alex Parker | 77a78ee | 2011-08-19 11:43:51 +0000 | [diff] [blame] | 3 | \config{\%V(x,y,[width],[height],[font]) \%Vf([fgcolour]) \%Vb([bgcolour]) % |
| 4 | \%Vg(start, end [,text])}% |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 5 | |
| 6 | \begin{itemize} |
Alex Parker | 77a78ee | 2011-08-19 11:43:51 +0000 | [diff] [blame] | 7 | \item \%Vf and \%Vb set the foreground and background colours respectively. |
Alexander Levin | b57fe48 | 2009-12-23 20:05:29 +0000 | [diff] [blame] | 8 | \item `fgcolour' and `bgcolour' are 6-digit RGB888 colours, e.g. FF00FF. |
Alex Parker | 77a78ee | 2011-08-19 11:43:51 +0000 | [diff] [blame] | 9 | \item \%Vg defines a gradient fill that can then be used with the \%Vs tag. |
| 10 | `start' and `end' set the initial and final colours, and the optional `text' |
| 11 | sets the text colour. Colours are 6-digit RGB888, e.g. FF00FF. |
Alexander Levin | b57fe48 | 2009-12-23 20:05:29 +0000 | [diff] [blame] | 12 | \item `font' is a number: 0 is the built-in system font, 1 is the |
Alex Parker | 994d955 | 2010-06-20 16:23:47 +0000 | [diff] [blame] | 13 | current menu font, and 2-9 are additional skin loaded fonts (see |
Alex Parker | 1b0c77f | 2010-06-20 12:58:09 +0000 | [diff] [blame] | 14 | \reference{ref:multifont}). |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 15 | \item Only the coordinates \emph{have} to be specified. Leaving the other |
| 16 | definitions blank will set them to their default values. |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 17 | \end{itemize} |
| 18 | |
Alex Parker | 64d4ddf | 2010-06-20 12:58:41 +0000 | [diff] [blame] | 19 | \note{The correct number of commas with hyphens in |
Alex Parker | 77a78ee | 2011-08-19 11:43:51 +0000 | [diff] [blame] | 20 | blank fields are still needed.} |
Alexander Levin | 64bb9a0 | 2010-05-18 20:23:22 +0000 | [diff] [blame] | 21 | |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 22 | \begin{example} |
Alex Parker | 77a78ee | 2011-08-19 11:43:51 +0000 | [diff] [blame] | 23 | %V(12,20,-,-,1) %Vf(000000) %Vb(FFFFFF) %Vg(FFC0CB, FF0000, FFFF00) |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 24 | %sThis viewport is displayed permanently. It starts 12px from the left and |
| 25 | %s20px from the top of the screen, and fills the rest of the screen from |
| 26 | %sthat point. The lines will scroll if this text does not fit in the viewport. |
Alex Parker | 64d4ddf | 2010-06-20 12:58:41 +0000 | [diff] [blame] | 27 | %sThe user font is used, and the foreground and background are set to black |
Alex Parker | 77a78ee | 2011-08-19 11:43:51 +0000 | [diff] [blame] | 28 | %sand white respectively. The line gradient is set to pink to red with yellow |
| 29 | %text. |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 30 | \end{example} |
Alexander Levin | 9df5638 | 2010-05-12 22:06:18 +0000 | [diff] [blame] | 31 | \begin{rbtabular}{.75\textwidth}{XX}{\textbf{Viewport definition} & \textbf{Default value}}{}{} |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 32 | width/height & remaining part of screen \\ |
| 33 | font & user defined \\ |
Alexander Levin | 9df5638 | 2010-05-12 22:06:18 +0000 | [diff] [blame] | 34 | foreground/background colours & defined by theme \\ |
Alexander Levin | b57fe48 | 2009-12-23 20:05:29 +0000 | [diff] [blame] | 35 | \end{rbtabular} |
| 36 | |