reorganizing documentation

git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2251 8e941d3f-bd1b-0410-a28a-d453659cc2b4

components/nvidia-widgets/fpdoc/fpdoc.css

@@ -0,0 +1,166 @@
+/*
+  $Id: fpdoc.css,v 1.1 2003/03/17 23:03:20 michael Exp $
+
+  Default style sheet for FPDoc reference documentation
+  by Sebastian Guenther, sg@freepascal.org
+
+  Feel free to use this file as a template for your own style sheets.
+*/
+
+body {
+  background: white
+}
+
+body, p, th, td, caption, h1, h2, h3, ul, ol, dl {
+  color: black;
+  font-family: sans-serif
+}
+
+tt, span.kw, pre {
+  font-family: Courier, monospace
+}
+
+body, p, th, td, caption, ul, ol, dl, tt, span.kw, pre {
+  font-size: 14px
+}
+
+A:link {
+  color: blue
+}
+
+A:visited {
+  color: darkblue
+}
+
+A:active {
+  color: red
+}
+
+A {
+  text-decoration: none
+}
+
+A:hover {
+  text-decoration: underline
+}
+
+h1, h2, td.h2 {
+  color: #005A9C
+}
+
+/* Especially for Netscape on Linux: */
+h3, td.h3 {
+  font-size: 12pt
+}
+
+/* source fragments */
+span.code {
+  white-space: nowrap
+}
+
+/* symbols in source fragments */
+span.sym {
+  color: darkred
+}
+
+/* keywords in source fragments */
+span.kw {
+  font-weight: bold
+}
+
+/* comments in source fragments */
+span.cmt {
+  color: darkcyan;
+  font-style: italic
+}
+
+/* directives in source fragments */
+span.dir {
+  color: darkyellow;
+  font-style: italic
+}
+
+/* numbers in source fragments */
+span.num {
+  color: darkmagenta
+}
+
+/* characters (#...) in source fragments */
+span.chr {
+  color: darkcyan
+}
+
+/* strings in source fragments */
+span.str {
+  color: blue
+}
+
+/* assembler passages in source fragments */
+span.asm {
+  color: green
+}
+
+
+td.pre {
+  white-space: pre
+}
+
+p.cmt {
+  color: gray
+}
+
+span.warning {
+  color: red;
+  font-weight: bold
+}
+
+/* !!!: How should we define this...? */
+span.file {
+  color: darkgreen
+}
+
+table.remark {
+  background-color: #ffffc0;
+}
+
+table.bar {
+  background-color: #a0c0ff;
+}
+
+span.bartitle {
+  font-weight: bold;
+  font-style: italic;
+  color: darkblue
+}
+
+span.footer {
+  font-style: italic;
+  color: darkblue
+}
+
+/* definition list */
+dl {
+ border: 3px double #ccc;
+ padding: 0.5em;
+}
+
+/* definition list: term */
+dt {
+ float: left;
+ clear: left;
+ width: auto; /* normally browsers default width of largest item */
+ padding-right: 20px;
+ font-weight: bold;
+ color: darkgreen;
+}
+
+/* definition list: description */
+dd {
+ margin: 0 0 0 110px;
+ padding: 0 0 0.5em 0;
+}
+
+/* for browsers in standards compliance mode */
+td p {
+  margin: 0;
+}

components/nvidia-widgets/fpdoc/glfreetype.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="nvidia-widgets">
+    <module name="glFreeType">
+	<short>Free Type support for OpenGL</short>
+    </module>
+  </package>
+</fpdoc-descriptions>

components/nvidia-widgets/fpdoc/glfreetypefont.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="widget_test">
+    <module name="GLFreeTypeFont">
+      <element name="TGLFreeTypeFont.TextHeight">
+        <short>Text height</short>
+      </element>
+    </module>
+  </package>
+</fpdoc-descriptions>

components/nvidia-widgets/fpdoc/glutbitmapfont.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="nvidia-widgets">
+    <module name="GLUTBitmapFont">
+	<short>GLUT bitmap font</short>
+    </module>
+  </package>
+</fpdoc-descriptions>

components/nvidia-widgets/fpdoc/images/crop_images.bat

@@ -0,0 +1,25 @@
+::this script takes a screenshot from the widget_test example
+::and cut's the individual widget examples and saves them to 
+::a separate file
+::the crop application is located in ./utils
+
+..\..\utils\crop widget_test.png 4 29 152 81 label.png
+..\..\utils\crop widget_test.png 7 79 182 111 button.png
+..\..\utils\crop widget_test.png 7 118 406 180 checkbutton.bmp
+..\..\utils\crop widget_test.png 7 190 394 251 radiobutton.bmp
+..\..\utils\crop widget_test.png 7 253 117 279 horizontal_slider.png
+..\..\utils\crop widget_test.png 7 279 120 350 listbox.png
+..\..\utils\crop widget_test.png 116 279 255 348 combobox.png
+..\..\utils\crop widget_test.png 7 353 237 385 line_edit.png
+..\..\utils\crop widget_test.png 7 383 264 460 panel.png
+..\..\utils\crop widget_test.png 7 468 262 539 frame.png
+..\..\utils\crop widget_test.png 4 537 77 620 listitem.png
+..\..\utils\crop widget_test.png 4 615 114 724 textureview.bmp
+
+del checkbutton.png
+del radiobutton.png
+del textureview.png
+
+ren checkbutton.bmp checkbutton.png
+ren radiobutton.bmp radiobutton.png
+ren textureview.bmp textureview.png

components/nvidia-widgets/fpdoc/nvbasefont.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="nvidia-widgets">
+    <module name="nvBaseFont">
+      <short>Generic font support class</short>
+      <element name="TNVBaseFont.TextHeight">
+        <short>Text height</short>
+        <descr>Some fonts will only return the font size and not the actual text height</descr>
+      </element>
+      <element name="TNVBaseFont.Create">
+        <short>Contructor for the base font class</short>
+      </element>
+      <element name="TNVBaseFont.Add">
+        <short>Method that allows to add multiple stylized fonts</short>
+        <descr>To define font styles, you will need to add the fonts first. This method allows to add a named font style and set the styles of it.</descr>
+      </element>
+      <element name="TNVBaseFont.Name">
+        <short>Font name</short>
+      </element>
+      <element name="TNVBaseFont.Size">
+        <short>Font size</short>
+      </element>
+      <element name="TNVBaseFont.TextWidth">
+        <short>Text width</short>
+      </element>
+      <element name="TNVBaseFont.TextSize">
+        <short>Text size</short>
+        <seealso>TextWidth
+TextHeight</seealso>
+      </element>
+    </module>
+  </package>
+</fpdoc-descriptions>

components/nvidia-widgets/fpdoc/nvcontext.xml

@@ -0,0 +1,75 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="nvidia-widgets">
+    <module name="nvWidgets">
+      <element name="UIContext">
+        <short>Basic UI context</short>
+      </element>
+      <element name="UIContext.beginGroup">
+        <short>Begin grouping section of UI objects</short>
+      </element>
+      <short>User Interface library</short>
+      <element name="UIContext.doListItem">
+        <short>List item widget</short>
+        <descr>
+          <img file="listitem.png"/>
+        </descr>
+      </element>
+      <element name="UIContext.doListBox">
+        <short>Listbox widget</short>
+        <descr>
+          <img file="listbox.png"/>
+        </descr>
+      </element>
+      <element name="UIContext.doComboBox">
+        <short>Combobox widget</short>
+        <descr>
+          <img file="combobox.png"/>
+        </descr>
+      </element>
+      <element name="UIContext.doLineEdit">
+        <short>Line edit widget</short>
+        <descr>
+          <img file="line_edit.png"/>
+        </descr>
+      </element>
+      <element name="UIContext.beginFrame">
+        <short>Frame positioning section</short>
+        <descr>
+          <img file="frame.png"/>
+        </descr>
+      </element>
+      <element name="UIContext.endFrame">
+        <short>Frame positioning widget</short>
+        <descr>
+          <img file="frame.png"/>
+        </descr>
+      </element>
+      <element name="UIContext.beginPanel">
+        <short>Panel positioning widget</short>
+        <descr>
+          <img file="panel.png"/>
+        </descr>
+      </element>
+      <element name="UIContext.endPanel">
+        <short>Panel positioning widget</short>
+        <descr>
+          <img file="panel.png"/>
+        </descr>
+      </element>
+    </module>
+    <short>NVIDIA widget library</short>
+    <descr>
+      <p>This library is originally based on the NVIDIA widget library. NVIDIA Widgets is the 
+<url href="https://mollyrocket.com/forums/viewforum.php?f=10">immediate mode graphical user interface</url> toolkit used by the 
+<url href="http://developer.nvidia.com/object/sdk_home.html">NVIDIA SDK samples</url>.
+</p>
+      <p>Originally ported to FPC by Darius Blaszyk in June 2011.</p>
+      <p>This library is distributed under the <url href="http://www.opensource.org/licenses/mit-license.php">MIT</url> license, as the original library was.</p>
+      <p>The original code can be found here: <url href="http://code.google.com/p/nvidia-widgets/"/>
+      </p>
+      <img file="nvwidgets.png" caption="nvidia-widgets class chart"/>
+      <p>For more information see the <url href="http://wiki.lazarus.freepascal.org/nvidia-widgets">Lazarus wiki</url>.</p>
+    </descr>
+  </package>
+</fpdoc-descriptions>

components/nvidia-widgets/fpdoc/nvglpainter.xml

@@ -0,0 +1,237 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="nvidia-widgets">
+    <module name="nvGLPainter">
+      <element name="nvGLPainter">
+        <short>User Interface library</short>
+      </element>
+      <element name="GLUIPainter">
+        <short>OpenGL painter class</short>
+      </element>
+      <element name="GLUIPainter.getCanvasMargin">
+        <short>Evaluate canvas margin</short>
+      </element>
+      <element name="GLUIPainter.getCanvasSpace">
+        <short>Evaluate canvas space</short>
+      </element>
+      <element name="GLUIPainter.getFontHeight">
+        <short>Evaluate font height</short>
+      </element>
+      <element name="GLUIPainter.getTextLineWidth">
+        <short>Evaluate text width</short>
+      </element>
+      <element name="GLUIPainter.getTextSize">
+        <short>Evaluate text size</short>
+        <descr>
+          <p>
+            <var>getTextSize</var>
+evaluates a string, it will calculate the number of lines it consists of and will return the length in pixels of the longest line.</p>
+        </descr>
+      </element>
+      <element name="GLUIPainter.getCanvasMargin.Result">
+        <short>Exterior margin</short>
+      </element>
+      <element name="GLUIPainter.getCanvasSpace.Result">
+        <short>Interior margin</short>
+      </element>
+      <element name="GLUIPainter.getFontHeight.Result">
+        <short>Font height in pixels</short>
+      </element>
+      <element name="GLUIPainter.getTextLineWidth.Result">
+        <short>Text width</short>
+      </element>
+      <element name="GLUIPainter.getTextSize.Result">
+        <short>Text width of widest line</short>
+      </element>
+      <element name="GLUIPainter.drawDebugRect">
+        <short>Draw a rectangle for debugging purposes</short>
+        <descr>
+          <p>
+            <var>drawDebugRect</var>
+ draws a simple rectangle usefull for debugging purposes.</p>
+        </descr>
+      </element>
+      <element name="GLUIPainter.drawDebugRect.r">
+        <short>Rectangle size to draw</short>
+      </element>
+      <short>User Interface library specialized for OpenGL</short>
+      <element name="GLUIPainter.drawText">
+        <short>Draw text with rectangle primitive</short>
+      </element>
+      <element name="GLUIPainter.drawFrame">
+        <short>Draw frame primitive</short>
+      </element>
+      <element name="GLUIPainter.drawBoolFrame">
+        <short>Draw bool frame primitive</short>
+      </element>
+      <element name="GLUIPainter.drawString">
+        <short>Draw multi-line text primitive</short>
+      </element>
+      <element name="GLUIPainter.drawRect">
+        <short>Draw rectangle primitive</short>
+      </element>
+      <element name="GLUIPainter.drawRect.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawRect.fillColorId">
+        <short>Fill color</short>
+      </element>
+      <element name="GLUIPainter.drawRect.borderColorId">
+        <short>Border color</short>
+      </element>
+      <element name="GLUIPainter.drawText.r">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawText.nbLines">
+        <short>Number of lines in text</short>
+      </element>
+      <element name="GLUIPainter.drawText.caretPos">
+        <short>Caret position</short>
+      </element>
+      <element name="GLUIPainter.drawText.isHover">
+        <short>Boolean indicating if the mouse is hovering over it</short>
+      </element>
+      <element name="GLUIPainter.drawText.isOn">
+        <short>Boolean indicating if the widget is on</short>
+      </element>
+      <element name="GLUIPainter.drawText.isFocus">
+        <short>Boolean indicating if the widget has focus</short>
+      </element>
+      <element name="GLUIPainter.drawFrame.isFocus">
+        <short>Boolean indicating if the widget has focus</short>
+      </element>
+      <element name="GLUIPainter.drawBoolFrame.isFocus">
+        <short>Boolean indicating if the widget has focus</short>
+      </element>
+      <element name="GLUIPainter.drawFrame.isOn">
+        <short>Boolean indicating if the widget is on</short>
+      </element>
+      <element name="GLUIPainter.drawBoolFrame.isOn">
+        <short>Boolean indicating if the widget is on</short>
+      </element>
+      <element name="GLUIPainter.drawFrame.isHover">
+        <short>Boolean indicating if the mouse is hovering over it</short>
+      </element>
+      <element name="GLUIPainter.drawBoolFrame.isHover">
+        <short>Boolean indicating if the mouse is hovering over it</short>
+      </element>
+      <element name="GLUIPainter.drawString.nbLines">
+        <short>Number of lines in text</short>
+      </element>
+      <element name="GLUIPainter.drawRoundedRect.fillColorId">
+        <short>Fill color</short>
+      </element>
+      <element name="GLUIPainter.drawCircle.fillColorId">
+        <short>Fill color</short>
+      </element>
+      <element name="GLUIPainter.drawMinus.fillColorId">
+        <short>Fill color</short>
+      </element>
+      <element name="GLUIPainter.drawPlus.fillColorId">
+        <short>Fill color</short>
+      </element>
+      <element name="GLUIPainter.drawDownArrow.fillColorId">
+        <short>Fill color</short>
+      </element>
+      <element name="GLUIPainter.drawUpArrow.fillColorId">
+        <short>Fill color</short>
+      </element>
+      <element name="GLUIPainter.drawRoundedRect.borderColorId">
+        <short>Border color</short>
+      </element>
+      <element name="GLUIPainter.drawRoundedRectOutline.borderColorId">
+        <short>Border color</short>
+      </element>
+      <element name="GLUIPainter.drawCircle.borderColorId">
+        <short>Border color</short>
+      </element>
+      <element name="GLUIPainter.drawMinus.borderColorId">
+        <short>Border color</short>
+      </element>
+      <element name="GLUIPainter.drawPlus.borderColorId">
+        <short>Border color</short>
+      </element>
+      <element name="GLUIPainter.drawDownArrow.borderColorId">
+        <short>Border color</short>
+      </element>
+      <element name="GLUIPainter.drawUpArrow.borderColorId">
+        <short>Border color</short>
+      </element>
+      <element name="GLUIPainter.drawFrame.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawBoolFrame.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawRoundedRect.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawRoundedRectOutline.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawCircle.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawMinus.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawPlus.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawDownArrow.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawUpArrow.aRect">
+        <short>Rectangle to draw in</short>
+      </element>
+      <element name="GLUIPainter.drawUpArrow.Width">
+        <short>Width of the arrow</short>
+      </element>
+      <element name="GLUIPainter.drawDownArrow.Width">
+        <short>Width of the arrow</short>
+      </element>
+      <element name="GLUIPainter.drawPlus.Width">
+        <short>Width of the plus</short>
+      </element>
+      <element name="GLUIPainter.drawMinus.Width">
+        <short>Width of the minus</short>
+      </element>
+      <element name="GLUIPainter.drawRoundedRect.corner">
+        <short>Radius of the corner</short>
+      </element>
+      <element name="GLUIPainter.drawRoundedRectOutline.corner">
+        <short>Radius of the corner</short>
+      </element>
+      <element name="GLUIPainter.drawBoolFrame.corner">
+        <short>Radius of the corner</short>
+      </element>
+      <element name="GLUIPainter.drawFrame.corner">
+        <short>Radius of the corner</short>
+      </element>
+      <element name="GLUIPainter.drawRoundedRect">
+        <short>Draw rouded rectangle primitive</short>
+      </element>
+      <element name="GLUIPainter.drawRoundedRectOutline">
+        <short>Draw rouded rectangle outline primitive</short>
+      </element>
+      <element name="GLUIPainter.drawCircle">
+        <short>Draw circle primitive</short>
+      </element>
+      <element name="GLUIPainter.drawMinus">
+        <short>Draw minus primitive</short>
+      </element>
+      <element name="GLUIPainter.drawPlus">
+        <short>Draw plus primitive</short>
+      </element>
+      <element name="GLUIPainter.drawDownArrow">
+        <short>Draw down arrow primitive</short>
+      </element>
+      <element name="GLUIPainter.drawUpArrow">
+        <short>Draw up arrow primitive</short>
+      </element>
+      <element name="GLUIPainter.init">
+        <short>Initialization method of the painter class</short>
+      </element>
+    </module>
+  </package>
+</fpdoc-descriptions>

components/nvidia-widgets/fpdoc/nvglutcontext.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<fpdoc-descriptions>
+  <package name="nvidia-widgets">
+    <module name="nvGlutContext">
+      <element name="GlutUIContext.translateKey">
+        <short>Translate non-ascii keys from GLUT to nvWidgets</short>
+      </element>
+      <element name="GlutUIContext.specialKeyboard">
+        <short>UI method for processing key events</short>
+        <descr>Call this method from the glutReshapeFunc callback</descr>
+      </element>
+      <element name="GlutUIContext.mouse">
+        <short>UI method for processing GLUT mouse button events</short>
+        <descr>Call this method from the glutMouseFunc callback, the modifier parameter maps to glutGetModifiers.</descr>
+      </element>
+      <element name="GlutUIContext.init">
+        <short>One time initialization</short>
+      </element>
+      <element name="GlutUIContext.Destroy">
+        <short>UI destructor</short>
+      </element>
+      <element name="GlutUIContext.Create">
+        <short>UI constructor</short>
+        <descr>Allows for overriding the standard painter</descr>
+      </element>
+      <element name="GlutUIContext.m_ownPainter">
+        <short>Variable indicating a default painter object</short>
+      </element>
+      <element name="GlutUIContext">
+        <short>GLut specific UI context</short>
+      </element>
+      <short>GLut adaptor class</short>
+      <descr>Adaptor classes to integrate the nvWidgets UI library with the GLUT windowing toolkit. The adaptors convert native GLUT UI data to native nvWidgets data. All adaptor classes are implemented as in-line code in this header. The adaptor defaults to using the standard OpenGL painter implementation.</descr>
+    </module>
+  </package>
+</fpdoc-descriptions>

components/nvidia-widgets/fpdoc/nvpainter.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<fpdoc-descriptions>
+  <package name="nvidia-widgets">
+    <module name="nvPainter">
+      <short>Basic painter class</short>
+      <element name="EvalBool">
+        <short>Boolean evaluation function</short>
+        <descr>
+          <p>This function evaluates a boolean to a numerical value.</p>
+          <p>True equals 1
+False equals 0</p>
+        </descr>
+      </element>	  
+    </module>
+  </package>
+</fpdoc-descriptions>

components/nvidia-widgets/fpdoc/nvshaderutils.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="nvidia-widgets">
+    <module name="nvShaderUtils">
+	<short>Utility functions for compiling shaders and programs</short>
+      <element name="CompileGLSLShader"/>
+      <element name="LinkGLSLProgram">
+        <short>Create a program composed of vertex, geometry and fragment shaders.</short>
+      </element>
+    </module>
+  </package>
+</fpdoc-descriptions>

components/nvidia-widgets/fpdoc/nvtypes.xml

@@ -0,0 +1,71 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="nvidia-widgets">
+    <module name="nvTypes">
+      <short>Base types and constants</short>
+      <element name="Point">
+        <short>2D point object</short>
+      </element>
+      <element name="SetPoint.Result">
+        <short>Initialize the point object</short>
+      </element>
+      <element name="Rect">
+        <short>Rectangle object</short>
+      </element>
+      <element name="Rect.x">
+        <short>X position of top left point</short>
+      </element>
+      <element name="Rect.y">
+        <short>Y position of top left point</short>
+      </element>
+      <element name="Rect.w">
+        <short>Width of rectangle</short>
+      </element>
+      <element name="Rect.h">
+        <short>Height of rectangle</short>
+      </element>
+      <element name="MouseButton_Left">
+        <short>An enum to identify the left mouse button</short>
+      </element>
+      <element name="MouseButton_Middle">
+        <short>An enum to identify the middle mouse button</short>
+      </element>
+      <element name="MouseButton_Right">
+        <short>An enum to identify the right mouse button</short>
+      </element>
+      <element name="Group">
+        <short>Group record</short>
+      </element>
+      <element name="Group.bounds">
+        <short>anchor point + width and height of the region </short>
+      </element>
+      <element name="Group.flags">
+        <short>group behavior</short>
+      </element>
+      <element name="Group.margin">
+        <short>border</short>
+      </element>
+      <element name="Group.space">
+        <short>interior</short>
+      </element>
+      <element name="Point.x">
+        <short>X location</short>
+      </element>
+      <element name="Point.y">
+        <short>Y location</short>
+      </element>
+      <element name="Point.Point">
+        <short>Constructor for the <link id="Point"/> object</short>
+      </element>
+      <element name="Rect.Rect">
+        <short>Constructor for the <link id="Rect"/> object</short>
+      </element>
+      <element name="SetPoint">
+        <short>Helper function to initialize the point object</short>
+      </element>
+      <element name="SetRect">
+        <short>Helper function to initialize the <link id="Rect"/> object</short>
+      </element>
+    </module>	  
+  </package>
+</fpdoc-descriptions>