renamed bmp images to png (only type supported)

added all images to widget documentation
fixed some spelling / formatting errors

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

components/nvidia-widgets/doc/nvwidgets.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
 <fpdoc-descriptions>
   <package name="nvidia-widgets">
     <module name="nvWidgets">
@@ -74,9 +74,9 @@
         <short>UI method for drawing a static text label</short>
         <descr>
           <p>The label displays a non interactive text.</p>
-          <p>The style flag enables to draw the label in two distict styles. The first one is default <var>(style = 0)</var> and displays the label simply as text. The alternative <var>(style = 1)</var> displays the label with a frame around it. An example is shown in then following figure.</p>
+          <p>The style flag enables to draw the label in two distinct styles. The first one is default <var>(style = 0)</var> and displays the label simply as text. The alternative <var>(style = 1)</var> displays the label with a frame around it. An example is shown in the following figure.</p>
           <img file="label.png"/>
-          <p>The Text can have multiple lines.</p>
+          <p>The <var>Text</var> variable can have multiple lines.</p>
         </descr>
       </element>
       <element name="UIContext.doLabel.r">
@@ -90,6 +90,10 @@
       </element>
       <element name="UIContext.doButton">
         <short>UI method for rendering and processing a push button</short>
+        <descr>
+          <p>The button method does only take a text and state variable. This variable is modified if the button is pressed or depressed. When a state change occurs the method function returns <var>True</var>.</p>
+          <img file="button.png"/>
+        </descr>
       </element>
       <element name="UIContext.doButton.r">
         <short>optionally provides a location and size for the button</short>
@@ -106,7 +110,10 @@
       </element>
       <element name="UIContext.doCheckButton">
         <short>UI method for rendering and processing a check button</short>
-        <descr>Check button behaves similarly as a toggle button used to display and edit a bool property.</descr>
+        <descr>
+          <p>Check button behaves similarly as a toggle button used to display and edit a boolean property.</p>
+          <img file="checkbutton.png"/>
+        </descr>
       </element>
       <element name="UIContext.doCheckButton.r">
         <short>optionally provides a location and size for the button</short>
@@ -123,11 +130,13 @@
       </element>
       <element name="UIContext.doRadioButton">
         <short>UI method for rendering and processing a radio button</short>
-        <descr>Radio buttons are typically used in groups to diplay and edit the possible reference values taken by an int value.
+        <descr>
-
+          <p>Radio buttons are typically used in groups to display and edit the possible reference values taken by an integer value.
-One radio button is representing a possible reference value taken by the current value.
+</p>
-It is displaying a boolean state true if the current value is equal to the reference value.
+          <p>One radio button is representing a possible reference value taken by the current value.
-</descr>
+It is displaying a boolean state true if the current value is equal to the reference value.</p>
+          <img file="radiobutton.png"/>
+        </descr>
       </element>
       <element name="UIContext.doRadioButton.reference">
         <short>The reference int value represented by this radio button.</short>
@@ -153,7 +162,10 @@ It is displaying a boolean state true if the current value is equal to the refer
       </element>
       <element name="UIContext.doHorizontalSlider">
         <short>UI method for rendering and processing a horizontal slider</short>
-        <descr>Horizontal slider is used to edit and display a scalar value in the specified range [min; max].</descr>
+        <descr>
+          <p>Horizontal slider is used to edit and display a scalar value in the specified range [min; max].</p>
+          <img file="horizontal_slider.png"/>
+        </descr>
       </element>
       <element name="UIContext.doHorizontalSlider.aRect">
         <short>optionally provides a location and size for the widget</short>
@@ -181,6 +193,7 @@ It is displaying a boolean state true if the current value is equal to the refer
           <code>texel = texture2DFetch(...);
 pixel = texelSwizzling( texel * texelScale + texelOffset );
 </code>
+          <img file="textureview.bmp"/>
         </descr>
       </element>
       <element name="UIContext.doTextureView.aRect">
@@ -215,22 +228,23 @@ pixel = texelSwizzling( texel * texelScale + texelOffset );
       </element>
       <element name="EvalBool">
         <short>Boolean evaluation function</short>
-        <descr>This function evaluates a boolean to a numerical value.
+        <descr>
-
+          <p>This function evaluates a boolean to a numerical value.</p>
-True equals 1
+          <p>True equals 1
-False equals 0</descr>
+False equals 0</p>
+        </descr>
       </element>
       <element name="Point.Point">
-        <short>Constructor for the point object</short>
+        <short>Constructor for the <link id="Point"/> object</short>
       </element>
       <element name="Rect.Rect">
-        <short>Constructor for the rect object</short>
+        <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 rect object</short>
+        <short>Helper function to initialize the <link id="Rect"/> object</short>
       </element>
       <element name="UIContext">
         <short>Basic UI context</short>
@@ -242,6 +256,54 @@ False equals 0</descr>
         <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>

components/nvidia-widgets/doc/nvwidgets/evalbool.html

@@ -29,6 +29,7 @@
 </tr>
 </table>
 <h2>Description</h2>
-<p>This function evaluates a boolean to a numerical value.  True equals 1 False equals 0</p>
+<p>This function evaluates a boolean to a numerical value.</p>
+<p>True equals 1 False equals 0</p>
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/index-5.html

@@ -28,7 +28,7 @@
 <tr>
 <td valign="top"><p><tt><span class="code"><a href="../nvwidgets/setrect.html">SetRect</a></span></tt></p></td>
 <td><p>&nbsp;&nbsp;</p></td>
-<td><p class="cmt">Helper function to initialize the rect object</p></td>
+<td><p class="cmt">Helper function to initialize the <a href="../nvwidgets/rect.html">Rect</a> object</p></td>
 </tr>
 </table>
 </body>

components/nvidia-widgets/doc/nvwidgets/point.html

@@ -35,7 +35,7 @@
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">procedure </span><a href="../nvwidgets/point.point.html">Point</a><span class="sym">();</span></span></tt></p></td>
 <td><p>&nbsp;&nbsp;</p></td>
-<td><p class="cmt">Constructor for the point object</p></td>
+<td><p class="cmt">Constructor for the <a href="../nvwidgets/point.html">Point</a> object</p></td>
 </tr>
 <tr>
 <td><p><tt><span class="code"> <span class="kw">end</span><span class="sym">;</span></span></tt></p></td>

components/nvidia-widgets/doc/nvwidgets/point.point.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>Point.Point</h1>
-<p>Constructor for the point object</p>
+<p>Constructor for the <a href="../nvwidgets/point.html">Point</a> object</p>
 <h2>Declaration</h2>
 <p>Source position:  line 0</p>
 <table cellpadding="0" cellspacing="0">

components/nvidia-widgets/doc/nvwidgets/rect.html

@@ -45,7 +45,7 @@
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">procedure </span><a href="../nvwidgets/rect.rect.html">Rect</a><span class="sym">();</span></span></tt></p></td>
 <td><p>&nbsp;&nbsp;</p></td>
-<td><p class="cmt">Constructor for the rect object</p></td>
+<td><p class="cmt">Constructor for the <a href="../nvwidgets/rect.html">Rect</a> object</p></td>
 </tr>
 <tr>
 <td><p><tt><span class="code"> <span class="kw">end</span><span class="sym">;</span></span></tt></p></td>

components/nvidia-widgets/doc/nvwidgets/rect.rect.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>Rect.Rect</h1>
-<p>Constructor for the rect object</p>
+<p>Constructor for the <a href="../nvwidgets/rect.html">Rect</a> object</p>
 <h2>Declaration</h2>
 <p>Source position:  line 0</p>
 <table cellpadding="0" cellspacing="0">

components/nvidia-widgets/doc/nvwidgets/setrect.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>SetRect</h1>
-<p>Helper function to initialize the rect object</p>
+<p>Helper function to initialize the <a href="../nvwidgets/rect.html">Rect</a> object</p>
 <h2>Declaration</h2>
 <p>Source position:  line 0</p>
 <table cellpadding="0" cellspacing="0">

components/nvidia-widgets/doc/nvwidgets/uicontext.beginframe.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>UIContext.beginFrame</h1>
-<p></p>
+<p>Frame positioning section</p>
 <h2>Declaration</h2>
 <p>Source position: nvWidgets.pas line 342</p>
 <table cellpadding="0" cellspacing="0">
@@ -34,5 +34,8 @@
 <td><p><tt><span class="code"><span class="sym">)</span><span class="sym">;</span></span></tt></p></td>
 </tr>
 </table>
+<h2>Description</h2>
+<img alt="" src="../images/frame.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.beginpanel.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>UIContext.beginPanel</h1>
-<p></p>
+<p>Panel positioning widget</p>
 <h2>Declaration</h2>
 <p>Source position: nvWidgets.pas line 345</p>
 <table cellpadding="0" cellspacing="0">
@@ -40,5 +40,8 @@
 <td><p><tt><span class="code"><span class="sym">):</span>Boolean<span class="sym">;</span></span></tt></p></td>
 </tr>
 </table>
+<h2>Description</h2>
+<img alt="" src="../images/panel.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.dobutton.html

@@ -82,5 +82,9 @@
 <td><p class="cmt">text to display on the button</p></td>
 </tr>
 </table>
+<h2>Description</h2>
+<p>The button method does only take a text and state variable. This variable is modified if the button is pressed or depressed. When a state change occurs the method function returns <var>True</var>.</p>
+<img alt="" src="../images/button.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.docheckbutton.html

@@ -63,6 +63,8 @@
 <h2>Function result</h2>
 <p>True if the check button state changed</p>
 <h2>Description</h2>
-<p>Check button behaves similarly as a toggle button used to display and edit a bool property.</p>
+<p>Check button behaves similarly as a toggle button used to display and edit a boolean property.</p>
+<img alt="" src="../images/checkbutton.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.docombobox.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>UIContext.doComboBox</h1>
-<p></p>
+<p>Combobox widget</p>
 <h2>Declaration</h2>
 <p>Source position: nvWidgets.pas line 334</p>
 <table cellpadding="0" cellspacing="0">
@@ -40,5 +40,8 @@
 <td><p><tt><span class="code"><span class="sym">):</span>Boolean<span class="sym">;</span></span></tt></p></td>
 </tr>
 </table>
+<h2>Description</h2>
+<img alt="" src="../images/combobox.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.dohorizontalslider.html

@@ -72,5 +72,7 @@
 <p>True if the slider value changed</p>
 <h2>Description</h2>
 <p>Horizontal slider is used to edit and display a scalar value in the specified range [min; max].</p>
+<img alt="" src="../images/horizontal_slider.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.dolabel.html

@@ -54,9 +54,9 @@
 </table>
 <h2>Description</h2>
 <p>The label displays a non interactive text.</p>
-<p>The style flag enables to draw the label in two distict styles. The first one is default <var>(style = 0)</var> and displays the label simply as text. The alternative <var>(style = 1)</var> displays the label with a frame around it. An example is shown in then following figure.</p>
+<p>The style flag enables to draw the label in two distinct styles. The first one is default <var>(style = 0)</var> and displays the label simply as text. The alternative <var>(style = 1)</var> displays the label with a frame around it. An example is shown in the following figure.</p>
 <img alt="" src="../images/label.png">
 
-<p>The Text can have multiple lines.</p>
+<p>The <var>Text</var> variable can have multiple lines.</p>
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.dolineedit.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>UIContext.doLineEdit</h1>
-<p></p>
+<p>Line edit widget</p>
 <h2>Declaration</h2>
 <p>Source position: nvWidgets.pas line 336</p>
 <table cellpadding="0" cellspacing="0">
@@ -40,5 +40,8 @@
 <td><p><tt><span class="code"><span class="sym">):</span>Boolean<span class="sym">;</span></span></tt></p></td>
 </tr>
 </table>
+<h2>Description</h2>
+<img alt="" src="../images/line_edit.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.dolistbox.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>UIContext.doListBox</h1>
-<p></p>
+<p>Listbox widget</p>
 <h2>Declaration</h2>
 <p>Source position: nvWidgets.pas line 333</p>
 <table cellpadding="0" cellspacing="0">
@@ -40,5 +40,8 @@
 <td><p><tt><span class="code"><span class="sym">):</span>Boolean<span class="sym">;</span></span></tt></p></td>
 </tr>
 </table>
+<h2>Description</h2>
+<img alt="" src="../images/listbox.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.dolistitem.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>UIContext.doListItem</h1>
-<p></p>
+<p>List item widget</p>
 <h2>Declaration</h2>
 <p>Source position: nvWidgets.pas line 332</p>
 <table cellpadding="0" cellspacing="0">
@@ -40,5 +40,8 @@
 <td><p><tt><span class="code"><span class="sym">):</span>Boolean<span class="sym">;</span></span></tt></p></td>
 </tr>
 </table>
+<h2>Description</h2>
+<img alt="" src="../images/listitem.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.doradiobutton.html

@@ -71,6 +71,9 @@
 <h2>Function result</h2>
 <p>True if the radio button value changed</p>
 <h2>Description</h2>
-<p>Radio buttons are typically used in groups to diplay and edit the possible reference values taken by an int value.  One radio button is representing a possible reference value taken by the current value. It is displaying a boolean state true if the current value is equal to the reference value. </p>
+<p>Radio buttons are typically used in groups to display and edit the possible reference values taken by an integer value. </p>
+<p>One radio button is representing a possible reference value taken by the current value. It is displaying a boolean state true if the current value is equal to the reference value.</p>
+<img alt="" src="../images/radiobutton.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.dotextureview.html

@@ -101,5 +101,7 @@
 <pre>texel <span class="sym">=</span> texture2DFetch<span class="sym">(</span><span class="sym">.</span><span class="sym">.</span><span class="sym">.</span><span class="sym">)</span><span class="sym">;</span>
 pixel <span class="sym">=</span> texelSwizzling<span class="sym">(</span> texel <span class="sym">*</span> texelScale <span class="sym">+</span> texelOffset <span class="sym">)</span><span class="sym">;</span>
 </pre>
+<img alt="" src="../images/textureview.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.endframe.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>UIContext.endFrame</h1>
-<p></p>
+<p>Frame positioning widget</p>
 <h2>Declaration</h2>
 <p>Source position: nvWidgets.pas line 343</p>
 <table cellpadding="0" cellspacing="0">
@@ -22,5 +22,8 @@
 <td><p><tt><span class="code"> <span class="kw">public</span> <span class="kw">procedure</span> <a href="../nvwidgets/uicontext.html">UIContext</a><span class="sym">.</span>endFrame<span class="sym">;</span></span></tt></p></td>
 </tr>
 </table>
+<h2>Description</h2>
+<img alt="" src="../images/frame.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.endpanel.html

@@ -14,7 +14,7 @@
 </tr>
 </table>
 <h1>UIContext.endPanel</h1>
-<p></p>
+<p>Panel positioning widget</p>
 <h2>Declaration</h2>
 <p>Source position: nvWidgets.pas line 346</p>
 <table cellpadding="0" cellspacing="0">
@@ -22,5 +22,8 @@
 <td><p><tt><span class="code"> <span class="kw">public</span> <span class="kw">procedure</span> <a href="../nvwidgets/uicontext.html">UIContext</a><span class="sym">.</span>endPanel<span class="sym">;</span></span></tt></p></td>
 </tr>
 </table>
+<h2>Description</h2>
+<img alt="" src="../images/panel.png">
+
 </body>
 </html>

components/nvidia-widgets/doc/nvwidgets/uicontext.html

@@ -102,15 +102,23 @@
 </tr>
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvwidgets/uicontext.dolistitem.html">doListItem</a><span class="sym">();</span></span></tt></p></td>
+<td><p>&nbsp;&nbsp;</p></td>
+<td><p class="cmt">List item widget</p></td>
 </tr>
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvwidgets/uicontext.dolistbox.html">doListBox</a><span class="sym">();</span></span></tt></p></td>
+<td><p>&nbsp;&nbsp;</p></td>
+<td><p class="cmt">Listbox widget</p></td>
 </tr>
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvwidgets/uicontext.docombobox.html">doComboBox</a><span class="sym">();</span></span></tt></p></td>
+<td><p>&nbsp;&nbsp;</p></td>
+<td><p class="cmt">Combobox widget</p></td>
 </tr>
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvwidgets/uicontext.dolineedit.html">doLineEdit</a><span class="sym">();</span></span></tt></p></td>
+<td><p>&nbsp;&nbsp;</p></td>
+<td><p class="cmt">Line edit widget</p></td>
 </tr>
 <tr>
 <td><p><tt><span class="code"><span class="kw">public</span></span></tt></p></td>
@@ -128,15 +136,23 @@
 </tr>
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">procedure </span><a href="../nvwidgets/uicontext.beginframe.html">beginFrame</a><span class="sym">();</span></span></tt></p></td>
+<td><p>&nbsp;&nbsp;</p></td>
+<td><p class="cmt">Frame positioning section</p></td>
 </tr>
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">procedure </span><a href="../nvwidgets/uicontext.endframe.html">endFrame</a><span class="sym">;</span></span></tt></p></td>
+<td><p>&nbsp;&nbsp;</p></td>
+<td><p class="cmt">Frame positioning widget</p></td>
 </tr>
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvwidgets/uicontext.beginpanel.html">beginPanel</a><span class="sym">();</span></span></tt></p></td>
+<td><p>&nbsp;&nbsp;</p></td>
+<td><p class="cmt">Panel positioning widget</p></td>
 </tr>
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">procedure </span><a href="../nvwidgets/uicontext.endpanel.html">endPanel</a><span class="sym">;</span></span></tt></p></td>
+<td><p>&nbsp;&nbsp;</p></td>
+<td><p class="cmt">Panel positioning widget</p></td>
 </tr>
 <tr>
 <td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvwidgets/uicontext.getgroupwidth.html">getGroupWidth</a><span class="sym">;</span></span></tt></p></td>