Class documentation for ColorWheel, ValueBar and color mapping units.

4 files changed, 285 insertions, 21 deletions

diff --git a/docs/html/corelib.cnt b/docs/html/corelib.cnt
index 8aa1bb0d..3cecf74b 100644
--- a/docs/html/corelib.cnt
+++ b/docs/html/corelib.cnt
@@ -1007,6 +1007,7 @@
   TOrientation fpg_main/torientation.html
   TAlign fpg_main/talign.html
   TLayout fpg_main/tlayout.html
+  TBoxLayout fpg_main/tboxlayout.html
   TAnchor fpg_main/tanchor.html
   TAnchors fpg_main/tanchors.html
   TFButtonFlags fpg_main/tfbuttonflags.html
@@ -1159,6 +1160,7 @@
   PrintCallTrace fpg_main/printcalltrace.html
   PrintCallTraceDbgLn fpg_main/printcalltracedbgln.html
   DumpStack fpg_main/dumpstack.html
+  DebugLn fpg_main/debugln.html
   fpgStyle fpg_main/fpgstyle.html
   fpgCaret fpg_main/fpgcaret.html
   fpgImages fpg_main/fpgimages.html
@@ -1352,12 +1354,15 @@
   fpgAppendPathDelim fpg_utils/fpgappendpathdelim.html
   fpgHasSubDirs fpg_utils/fpghassubdirs.html
   fpgAllFilesMask fpg_utils/fpgallfilesmask.html
+  fpgConvertLineEndings fpg_utils/fpgconvertlineendings.html
   fpgFindFirst fpg_utils/fpgfindfirst.html
   fpgFindNext fpg_utils/fpgfindnext.html
   fpgGetCurrentDir fpg_utils/fpggetcurrentdir.html
   fpgSetCurrentDir fpg_utils/fpgsetcurrentdir.html
   fpgExpandFileName fpg_utils/fpgexpandfilename.html
   fpgFileExists fpg_utils/fpgfileexists.html
+  fpgDirectoryExists fpg_utils/fpgdirectoryexists.html
+  fpgExtractFileDir fpg_utils/fpgextractfiledir.html
  fpg_popupwindow fpg_popupwindow/index.html
   TfpgPopupWindow fpg_popupwindow/tfpgpopupwindow.html
    MsgClose fpg_popupwindow/tfpgpopupwindow.msgclose.html
@@ -1437,6 +1442,7 @@
   rsexampletext fpg_constants/index-1.html#rsexampletext
   rsexit fpg_constants/index-1.html#rsexit
   rserrfailedtocreatedir fpg_constants/index-1.html#rserrfailedtocreatedir
+  rsfalse fpg_constants/index-1.html#rsfalse
   rscollectionfavourites fpg_constants/index-1.html#rscollectionfavourites
   rsshortfeb fpg_constants/index-1.html#rsshortfeb
   rslongfeb fpg_constants/index-1.html#rslongfeb
@@ -1506,6 +1512,7 @@
   rsshortthu fpg_constants/index-1.html#rsshortthu
   rslongthu fpg_constants/index-1.html#rslongthu
   rstoday fpg_constants/index-1.html#rstoday
+  rstrue fpg_constants/index-1.html#rstrue
   rsshorttue fpg_constants/index-1.html#rsshorttue
   rslongtue fpg_constants/index-1.html#rslongtue
   rsfiletype fpg_constants/index-1.html#rsfiletype
@@ -1542,7 +1549,6 @@
   EPOFileError fpg_pofiles/epofileerror.html
   TranslateUnitResourceStrings fpg_pofiles/translateunitresourcestrings.html
   UTF8ToSystemCharSet fpg_pofiles/utf8tosystemcharset.html
-  DebugLn fpg_pofiles/debugln.html
   SystemCharSetIsUTF8 fpg_pofiles/systemcharsetisutf8.html
  fpg_translations fpg_translations/index.html
   PTranslation fpg_translations/ptranslation.html
diff --git a/docs/html/gui.cnt b/docs/html/gui.cnt
index 1e8ecd76..be02edee 100644
--- a/docs/html/gui.cnt
+++ b/docs/html/gui.cnt
@@ -91,6 +91,10 @@
    AfterCreate fpg_dialogs/tfpgselectdirdialog.aftercreate.html
    SelectedDir fpg_dialogs/tfpgselectdirdialog.selecteddir.html
    RootDirectory fpg_dialogs/tfpgselectdirdialog.rootdirectory.html
+  TCharMapForm fpg_dialogs/tcharmapform.html
+   AfterCreate fpg_dialogs/tcharmapform.aftercreate.html
+   NewText fpg_dialogs/tcharmapform.newtext.html
+  fpgShowCharMap fpg_dialogs/fpgshowcharmap.html
   ShowMessage fpg_dialogs/showmessage.html
   SelectFontDialog fpg_dialogs/selectfontdialog.html
   SelectFileDialog fpg_dialogs/selectfiledialog.html
@@ -110,6 +114,74 @@
    TextColor fpg_hyperlink/tfpghyperlink.textcolor.html
    URL fpg_hyperlink/tfpghyperlink.url.html
    OnClick fpg_hyperlink/tfpghyperlink.onclick.html
+ fpg_ColorMapping fpg_colormapping/index.html
+  RGBToHSV fpg_colormapping/rgbtohsv.html
+  HSVToRGB fpg_colormapping/hsvtorgb.html
+ fpg_ColorWheel fpg_colorwheel/index.html
+  TfpgColorWheel fpg_colorwheel/tfpgcolorwheel.html
+   FValueBar fpg_colorwheel/tfpgcolorwheel.fvaluebar.html
+   FHue fpg_colorwheel/tfpgcolorwheel.fhue.html
+   FSaturation fpg_colorwheel/tfpgcolorwheel.fsaturation.html
+   FMarginWidth fpg_colorwheel/tfpgcolorwheel.fmarginwidth.html
+   FCursorSize fpg_colorwheel/tfpgcolorwheel.fcursorsize.html
+   FWhiteAreaPercent fpg_colorwheel/tfpgcolorwheel.fwhiteareapercent.html
+   FOnChange fpg_colorwheel/tfpgcolorwheel.fonchange.html
+   FImage fpg_colorwheel/tfpgcolorwheel.fimage.html
+   HSFromPoint fpg_colorwheel/tfpgcolorwheel.hsfrompoint.html
+   DrawCursor fpg_colorwheel/tfpgcolorwheel.drawcursor.html
+   SetMarginWidth fpg_colorwheel/tfpgcolorwheel.setmarginwidth.html
+   SetCursorSize fpg_colorwheel/tfpgcolorwheel.setcursorsize.html
+   SetValueBar fpg_colorwheel/tfpgcolorwheel.setvaluebar.html
+   SetWhiteAreaPercent fpg_colorwheel/tfpgcolorwheel.setwhiteareapercent.html
+   Notification fpg_colorwheel/tfpgcolorwheel.notification.html
+   DrawWidth fpg_colorwheel/tfpgcolorwheel.drawwidth.html
+   DrawHeight fpg_colorwheel/tfpgcolorwheel.drawheight.html
+   Change fpg_colorwheel/tfpgcolorwheel.change.html
+   HandlePaint fpg_colorwheel/tfpgcolorwheel.handlepaint.html
+   HandleLMouseDown fpg_colorwheel/tfpgcolorwheel.handlelmousedown.html
+   HandleMouseMove fpg_colorwheel/tfpgcolorwheel.handlemousemove.html
+   HandleLMouseUp fpg_colorwheel/tfpgcolorwheel.handlelmouseup.html
+   Create fpg_colorwheel/tfpgcolorwheel.create.html
+   Destroy fpg_colorwheel/tfpgcolorwheel.destroy.html
+   Hue fpg_colorwheel/tfpgcolorwheel.hue.html
+   Saturation fpg_colorwheel/tfpgcolorwheel.saturation.html
+   SetSelectedColor fpg_colorwheel/tfpgcolorwheel.setselectedcolor.html
+   BackgroundColor fpg_colorwheel/tfpgcolorwheel.backgroundcolor.html
+   ValueBar fpg_colorwheel/tfpgcolorwheel.valuebar.html
+   MarginWidth fpg_colorwheel/tfpgcolorwheel.marginwidth.html
+   CursorSize fpg_colorwheel/tfpgcolorwheel.cursorsize.html
+   WhiteAreaPercent fpg_colorwheel/tfpgcolorwheel.whiteareapercent.html
+   OnChange fpg_colorwheel/tfpgcolorwheel.onchange.html
+  TfpgValueBar fpg_colorwheel/tfpgvaluebar.html
+   FColorWheel fpg_colorwheel/tfpgvaluebar.fcolorwheel.html
+   FHue fpg_colorwheel/tfpgvaluebar.fhue.html
+   FSaturation fpg_colorwheel/tfpgvaluebar.fsaturation.html
+   FValue fpg_colorwheel/tfpgvaluebar.fvalue.html
+   FMarginWidth fpg_colorwheel/tfpgvaluebar.fmarginwidth.html
+   FCursorHeight fpg_colorwheel/tfpgvaluebar.fcursorheight.html
+   FOnChange fpg_colorwheel/tfpgvaluebar.fonchange.html
+   DrawCursor fpg_colorwheel/tfpgvaluebar.drawcursor.html
+   SetMarginWidth fpg_colorwheel/tfpgvaluebar.setmarginwidth.html
+   SetValue fpg_colorwheel/tfpgvaluebar.setvalue.html
+   SetCursorHeight fpg_colorwheel/tfpgvaluebar.setcursorheight.html
+   GetSelectedColor fpg_colorwheel/tfpgvaluebar.getselectedcolor.html
+   Change fpg_colorwheel/tfpgvaluebar.change.html
+   DrawWidth fpg_colorwheel/tfpgvaluebar.drawwidth.html
+   DrawHeight fpg_colorwheel/tfpgvaluebar.drawheight.html
+   ValueFromY fpg_colorwheel/tfpgvaluebar.valuefromy.html
+   DrawLine fpg_colorwheel/tfpgvaluebar.drawline.html
+   HandlePaint fpg_colorwheel/tfpgvaluebar.handlepaint.html
+   HandleLMouseDown fpg_colorwheel/tfpgvaluebar.handlelmousedown.html
+   HandleMouseMove fpg_colorwheel/tfpgvaluebar.handlemousemove.html
+   HandleLMouseUp fpg_colorwheel/tfpgvaluebar.handlelmouseup.html
+   Create fpg_colorwheel/tfpgvaluebar.create.html
+   SetHS fpg_colorwheel/tfpgvaluebar.seths.html
+   BackgroundColor fpg_colorwheel/tfpgvaluebar.backgroundcolor.html
+   Value fpg_colorwheel/tfpgvaluebar.value.html
+   SelectedColor fpg_colorwheel/tfpgvaluebar.selectedcolor.html
+   MarginWidth fpg_colorwheel/tfpgvaluebar.marginwidth.html
+   CursorHeight fpg_colorwheel/tfpgvaluebar.cursorheight.html
+   OnChange fpg_colorwheel/tfpgvaluebar.onchange.html
 
 :classes
 #GUI.fpg_dialogs.TfpgMessageBox TfpgForm
@@ -285,6 +357,23 @@
 3MAfterCreate
 3MSelectedDir
 3PRootDirectory rw
+#GUI.fpg_dialogs.TCharMapForm TfpgForm
+1VStringGrid1
+1VButton1
+1VlblCharInfo
+1VedText
+1VlblText
+1VpnlChar
+1MFormShow
+1MStringGrid1FocusChange
+1MStringGrid1DrawCell
+1MStringGrid1CanSelectCell
+1MStringGrid1DoubleClick
+1MFillCharMap
+1MButton1Clicked
+1MGetNewText
+3MAfterCreate
+3PNewText r
 #GUI.fpg_hyperlink.TfpgHyperlink TfpgCustomLabel
 1VfHotTrackColor
 1VfOldColor
@@ -307,3 +396,67 @@
 4PTextColor
 4PURL rw
 4POnClick
+#GUI.fpg_ColorWheel.TfpgColorWheel #CoreLib.fpg_widget.TfpgWidget
+2VFValueBar
+2VFHue
+2VFSaturation
+2VFMarginWidth
+2VFCursorSize
+2VFWhiteAreaPercent
+2VFOnChange
+2VFImage
+2MHSFromPoint
+2MDrawCursor
+2MSetMarginWidth
+2MSetCursorSize
+2MSetValueBar
+2MSetWhiteAreaPercent
+2MNotification
+2MDrawWidth
+2MDrawHeight
+2MChange
+2MHandlePaint
+2MHandleLMouseDown
+2MHandleMouseMove
+2MHandleLMouseUp
+3MCreate
+3MDestroy
+3PHue r
+3PSaturation r
+3MSetSelectedColor
+4PBackgroundColor
+4PValueBar rw
+4PMarginWidth rw
+4PCursorSize rw
+4PWhiteAreaPercent rw
+4POnChange rw
+#GUI.fpg_ColorWheel.TfpgValueBar #CoreLib.fpg_widget.TfpgWidget
+2VFColorWheel
+2VFHue
+2VFSaturation
+2VFValue
+2VFMarginWidth
+2VFCursorHeight
+2VFOnChange
+2MDrawCursor
+2MSetMarginWidth
+2MSetValue
+2MSetCursorHeight
+2MGetSelectedColor
+2MChange
+2MDrawWidth
+2MDrawHeight
+2MValueFromY
+2MDrawLine
+2MHandlePaint
+2MHandleLMouseDown
+2MHandleMouseMove
+2MHandleLMouseUp
+3MCreate
+3MSetHS
+4PBackgroundColor
+4PValue rw
+4PSelectedColor r
+4PMarginWidth rw
+4PCursorHeight rw
+4POnChange rw
diff --git a/docs/xml/gui/fpg_colormapping.xml b/docs/xml/gui/fpg_colormapping.xml
index 209a7095..8a348362 100644
--- a/docs/xml/gui/fpg_colormapping.xml
+++ b/docs/xml/gui/fpg_colormapping.xml
@@ -1,12 +1,31 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0"?>
 <fpdoc-descriptions>
-<package name="GUI">
-
-<module name="fpg_colormapping">
-<short></short>
-<descr></descr>
-
-</module>
-
-</package>
+  <package name="GUI">
+    <module name="fpg_colormapping">
+      <short>This unit contains some color conversion/mapping functions.</short>
+      <descr/>
+      <element name="RGBToHSV">
+        <short>Map RGB colorspace to HSV colorspace.</short>
+        <descr>This function converts a RGB (Red, Green, Blue) colorspace value to HSV (Hue, Saturation, Value) colorspace. The parameters have specific value ranges. Please see the parameter documentation for more details.</descr>
+      </element>
+      <element name="HSVToRGB">
+        <short>Map HSV colorspace to RGB colorspace.</short>
+      </element>
+      <element name="RGBToHSV.Hue">
+        <short>Returned Hue value</short>
+        <descr>The Hue range is from 0 - 1535. In that range, the primary colors are mapped to the following values. Red = 0. Green = 512 and Blue = 1024.</descr>
+      </element>
+      <element name="RGBToHSV.Saturation">
+        <short>Returned Saturation value.</short>
+        <descr>The Saturation value range is from 0.0 - 1.0. Grey (no color) = 0. Maximum color = 1.0.</descr>
+      </element>
+      <element name="RGBToHSV.Value">
+        <short>Returned Value value.</short>
+        <descr>The Value value range is from 0.0 to 1.0. Black being 0 and maximum brightness being 1.0.</descr>
+      </element>
+      <element name="HSVToRGB.H">
+        <short>Hue value</short>
+      </element>
+    </module>
+  </package>
 </fpdoc-descriptions>
diff --git a/docs/xml/gui/fpg_colorwheel.xml b/docs/xml/gui/fpg_colorwheel.xml
index 738654be..6340555b 100644
--- a/docs/xml/gui/fpg_colorwheel.xml
+++ b/docs/xml/gui/fpg_colorwheel.xml
@@ -1,12 +1,98 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0"?>
 <fpdoc-descriptions>
-<package name="GUI">
-
-<module name="fpg_colorwheel">
-<short></short>
-<descr></descr>
-
-</module>
-
-</package>
+  <package name="GUI">
+    <module name="fpg_colorwheel">
+      <short>The unit contains a ColorWheel and ValueBar component.</short>
+      <descr>
+        <p>
+          <b>Using the components:</b>
+        </p>
+        <p>Normally, you use both a color wheel and a value bar.

+</p>
+        <ol>
+          <li>Put a color wheel on your form.</li>
+          <li>Put a value bar on your form beside the wheel.</li>
+          <li>Set the ColorWheel's ValueBar property to the ValueBar component

+   you just put on the form.</li>
+        </ol>
+        <p>The two components are now linked together. When a selection is

+made in the color wheel the value bar will update to show the range

+for that selection.

+</p>
+        <p>
+          <b>Note:</b> you won't see the colors in the UI Designer. Colors will
+only be displayed at runtime.</p>
+        <p>
+          <b>Reading and setting the color:</b>
+        </p>
+        <p>To set the color being displayed, use the SetSelectedColor method

+           of the color wheel.</p>
+        <p>To read the color selected, read the SelectedColor property

+           of the ValueBar.</p>
+        <p>If you want to know when the user picks a color, you

+           can use the OnChange event in the ValueBar.</p>
+      </descr>
+      <element name="TfpgColorWheel">
+        <short>A colorwheel component.</short>
+        <descr>This component draws a ColorWheel at runtime. This allows the user to select the Hue and Saturation values in the HSV color range.</descr>
+      </element>
+      <element name="TfpgColorWheel.CursorSize">
+        <short>Size of the crosshair.</short>
+        <descr>If the cursor size is set too big it will just 'clip' to the edge of the control. You can use this effect to get full cross hairs by making the CursorSize large.</descr>
+      </element>
+      <element name="TfpgColorWheel.MarginWidth">
+        <short>The width of the black area around the wheel.</short>
+        <descr>
+          <p>The margin is there so that when the cross hair is on the edge of the wheel, the complete cross hair can be drawn, without being clipped. It makes selecting colors on the edge of the colorwheel easier.</p>
+          <p>If the margin is set too large, the colorwheel will not be drawn / displayed.</p>
+        </descr>
+      </element>
+      <element name="TfpgColorWheel.WhiteAreaPercent">
+        <short>The percentage from the centre of the wheel.</short>
+        <descr>The percentage of the radius from the centre of the wheel, that is held for pure white.This makes it possible to easily select the color white. The percentage range is 0% - 50% of the colorwheel. The cross hair will also snap to the centre of the wheel when it enters this radius range.</descr>
+      </element>
+      <element name="TfpgColorWheel.OnChange">
+        <short>This event is triggered when a new color has been selected in the wheel.</short>
+      </element>
+      <element name="TfpgColorWheel.ValueBar">
+        <short>Used to link the ColorWheel to the ValueBar component.</short>
+        <seealso>
+          <link id="TfpgValueBar"/>
+        </seealso>
+      </element>
+      <element name="TfpgColorWheel.Hue">
+        <short>Hue value of selected color.</short>
+      </element>
+      <element name="TfpgColorWheel.Saturation">
+        <short>Saturation value of selected color.</short>
+      </element>
+      <element name="TfpgColorWheel.SetSelectedColor">
+        <short>Sets a new color value programatically.</short>
+      </element>
+      <element name="TfpgValueBar">
+        <short>A ValueBar component.</short>
+        <descr>At runtime, this component draws a ValueBar. It allows the user to select the brightness (Value) color in the HSV colorspace. This components works with the TfpgColorWheel component to set the full HSV color values.</descr>
+      </element>
+      <element name="TfpgValueBar.Value">
+        <short>Currently selected Value</short>
+        <descr>The Value color range is from 0.0 to 1.0, where 0 is black and 1 is the brightest.</descr>
+      </element>
+      <element name="TfpgValueBar.SelectedColor">
+        <short>The selected HSV color but in TfpgColor format.</short>
+      </element>
+      <element name="TfpgValueBar.MarginWidth">
+        <short>Margin width around the ValueBar.</short>
+      </element>
+      <element name="TfpgValueBar.OnChange">
+        <short>Event is triggered when a new color is selected.</short>
+      </element>
+      <element name="TfpgValueBar.CursorHeight">
+        <short>The height of the selection cursor.</short>
+      </element>
+      <element name="TfpgValueBar.SetHS">
+        <short>Sets the Hue and Saturation values.</short>
+        <descr>This method is normally called by the <link id="TfpgColorWheel"/> component. These components work together to specify the full HSV color.</descr>
+      </element>
+    </module>
+  </package>
 </fpdoc-descriptions>