A little something about metawidgets, and format strings

1 files changed, 27 insertions, 0 deletions

diff --git a/design/widgets/metawidget.tex b/design/widgets/metawidget.tex
new file mode 100644
index 0000000..dc09433
--- /dev/null
+++ b/design/widgets/metawidget.tex
@@ -0,0 +1,27 @@
+% -*- coding: utf-8 -*-
+\subsubsection{\texttt{metawidget} elementet}
+En metawidget er en widget som fungerer som container for andre
+widgets.\\
+En metawidget sammensætter værdierne fra de indre widgets igennem en
+formatstreng, og producerer på den måde et fælles output.\\
+De indre widgets kommer ikke til at indgå som en del af den ydre
+makros værdi liste.\\
+En metawidget kan ikke sætte sin værdi i de indre widgets (grundet
+måden hvorpå disse oprindeligt er indsamlet), så en sat værdi i en
+meta widget vil blot blive ignoreret.\\
+En metawidget har flg. attributter:
+\begin{itemize}
+\item \textit{name} - Navnet på meta widgeten.
+\item \textit{layout} - ``hbox'' eller ``vbox''.
+\item \textit{format} - Format streng som beskriver hvordan værdierne
+  i den indre skal sammensættes (Se dokumentation for format strengens
+  format i kapitel \ref{format}).
+\end{itemize}
+
+\begin{lstlisting}
+<metawidget name="cave_metawidget" layout="vbox"
+            format="Prep: ${prep}, Reak: ${reak}.">
+  <textedit name="prep"/>
+  <textedit name="reak"/>
+</metawidget>
+\end{lstlisting}