From 2063bc970c9e8f777f72a65424f98a5c04329b2f Mon Sep 17 00:00:00 2001
From: Graeme Geldenhuys <graeme@mastermaths.co.za>
Date: Tue, 6 Dec 2011 17:32:12 +0200
Subject: Some basic docs or the basegrid unit.

---
 docs/xml/gui/fpg_basegrid.xml | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 docs/xml/gui/fpg_basegrid.xml

(limited to 'docs/xml/gui')

diff --git a/docs/xml/gui/fpg_basegrid.xml b/docs/xml/gui/fpg_basegrid.xml
new file mode 100644
index 00000000..76a93d2b
--- /dev/null
+++ b/docs/xml/gui/fpg_basegrid.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<fpdoc-descriptions>
+<package name="fpgui">
+
+<module name="fpg_basegrid">
+<unit>$(fpgui_src)/gui/fpg_basegrid.pas</unit>
+<short>This unit defines a class that represents the most basic parts of a
+grid.</short>
+<descr><printshort id="fpg_basegrid"/>.</descr>
+
+
+<element name="TfpgBaseGrid.OnRowChange">
+<short>This even is fired as soon as the focused row has changed</short>
+<descr><printshort id="TfpgBaseGrid.OnRowChange"/>. This event only works on the
+row level of the grid.</descr>
+</element>
+
+<element name="TfpgBaseGrid.OnFocusChange">
+<short>This even is fired as soon as the focused cell has changed</short>
+<descr><printshort id="TfpgBaseGrid.OnFocusChange"/>. This event works on the
+grid cell level.</descr>
+</element>
+
+<element name="TfpgBaseGrid.OnCanSelectCell">
+<short>This event allows the program to decide if a cell can be selected or not</short>
+<descr><printshort id="TfpgBaseGrid.OnCanSelectCell"/>. The default value for
+<var>ACanSelect</var> is True. Setting this to false inside the event handler
+will prevent the cell at position ACol, ARow to be selected.</descr>
+</element>
+
+
+</module>
+
+</package>
+</fpdoc-descriptions>
-- 
cgit v1.2.3-70-g09d2