blob: d027c3b7579142472859642b0415473e31371b46 [file] [log] [blame]
Alex Parkerab563da2009-09-20 16:48:45 +00001\subsubsection{Viewport Declaration Syntax}
2
Alex Parker77a78ee2011-08-19 11:43:51 +00003\config{\%V(x,y,[width],[height],[font]) \%Vf([fgcolour]) \%Vb([bgcolour]) %
4 \%Vg(start, end [,text])}%
Alex Parkerab563da2009-09-20 16:48:45 +00005
6 \begin{itemize}
Alex Parker77a78ee2011-08-19 11:43:51 +00007 \item \%Vf and \%Vb set the foreground and background colours respectively.
Alexander Levinb57fe482009-12-23 20:05:29 +00008 \item `fgcolour' and `bgcolour' are 6-digit RGB888 colours, e.g. FF00FF.
Alex Parker77a78ee2011-08-19 11:43:51 +00009 \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 Levinb57fe482009-12-23 20:05:29 +000012 \item `font' is a number: 0 is the built-in system font, 1 is the
Alex Parker994d9552010-06-20 16:23:47 +000013 current menu font, and 2-9 are additional skin loaded fonts (see
Alex Parker1b0c77f2010-06-20 12:58:09 +000014 \reference{ref:multifont}).
Alex Parkerab563da2009-09-20 16:48:45 +000015 \item Only the coordinates \emph{have} to be specified. Leaving the other
16 definitions blank will set them to their default values.
Alex Parkerab563da2009-09-20 16:48:45 +000017 \end{itemize}
18
Alex Parker64d4ddf2010-06-20 12:58:41 +000019\note{The correct number of commas with hyphens in
Alex Parker77a78ee2011-08-19 11:43:51 +000020 blank fields are still needed.}
Alexander Levin64bb9a02010-05-18 20:23:22 +000021
Alex Parkerab563da2009-09-20 16:48:45 +000022\begin{example}
Alex Parker77a78ee2011-08-19 11:43:51 +000023 %V(12,20,-,-,1) %Vf(000000) %Vb(FFFFFF) %Vg(FFC0CB, FF0000, FFFF00)
Alex Parkerab563da2009-09-20 16:48:45 +000024 %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 Parker64d4ddf2010-06-20 12:58:41 +000027 %sThe user font is used, and the foreground and background are set to black
Alex Parker77a78ee2011-08-19 11:43:51 +000028 %sand white respectively. The line gradient is set to pink to red with yellow
29 %text.
Alex Parkerab563da2009-09-20 16:48:45 +000030\end{example}
Alexander Levin9df56382010-05-12 22:06:18 +000031\begin{rbtabular}{.75\textwidth}{XX}{\textbf{Viewport definition} & \textbf{Default value}}{}{}
Alex Parkerab563da2009-09-20 16:48:45 +000032 width/height & remaining part of screen \\
33 font & user defined \\
Alexander Levin9df56382010-05-12 22:06:18 +000034 foreground/background colours & defined by theme \\
Alexander Levinb57fe482009-12-23 20:05:29 +000035\end{rbtabular}
36