summaryrefslogtreecommitdiff
path: root/docs/xml
diff options
context:
space:
mode:
authorDavid Laurence Emerson <dle3ab@angelbase.com>2013-05-27 23:04:56 -0700
committerDavid Laurence Emerson <dle3ab@angelbase.com>2013-05-27 23:04:56 -0700
commitec68e3ec7ea545a2165644a3ec08ca9e36be2402 (patch)
tree131fe96875f9c26e6b444b6add4ad712ec6f4a18 /docs/xml
parent486f4f48ff250ce64ab532a302b6bbd6c05c4050 (diff)
parentc45010b6370b50f8e6192ddb7dc3d7762c8c29f7 (diff)
downloadfpGUI-ec68e3ec7ea545a2165644a3ec08ca9e36be2402.tar.xz
Merge branch 'master' into scroll-frame
Conflicts: src/corelib/x11/fpgui_toolkit.lpk
Diffstat (limited to 'docs/xml')
-rw-r--r--docs/xml/corelib/fpg_base.xml65
-rw-r--r--docs/xml/corelib/fpg_command_intf.xml10
-rw-r--r--docs/xml/gui/fpg_button.xml14
-rw-r--r--docs/xml/gui/fpg_colormapping.xml2
-rw-r--r--docs/xml/gui/fpg_dialogs.xml2
-rw-r--r--docs/xml/gui/fpg_form.xml2
-rw-r--r--docs/xml/gui/fpg_grid.xml54
-rw-r--r--docs/xml/gui/fpg_hyperlink.xml2
-rw-r--r--docs/xml/gui/fpg_tree.xml50
9 files changed, 131 insertions, 70 deletions
diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml
index abcb6f53..05a1f72f 100644
--- a/docs/xml/corelib/fpg_base.xml
+++ b/docs/xml/corelib/fpg_base.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="fpGUI">
@@ -653,57 +653,61 @@ calculations and screen redraws.</p>
<element name="TfpgWindowBase.Left">
<short>Specifies the horizontal coordinate of the left edge of a component relative to its parent</short>
-<descr><p><printshort id="TfpgWindowBase.Left"/>. Use the Left property to determine where the left side
+<descr><p><printshort id="#fpgui.fpg_base.TfpgWindowBase.Left"/>. Use the Left property to determine where the left side
of the control begins or to reposition the left side of the control.
</p>
<remark>fpGUI delays acting on the Top, Left, Width and Height properties of a control until the
-<var>UpdateWindowPosition</var> method is called. For more information on why this is so, see <link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
+<var>UpdateWindowPosition</var> method is called. For more information on why this is so,
+see <link id="#fpgui.fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
help.</remark></descr>
<seealso>
-<link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
+<link id="#fpgui.fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
</seealso>
</element>
<element name="TfpgWindowBase.Top">
<short>Specifies the vertical (X) coordinate of the top edge of a component relative to its parent</short>
-<descr><p><printshort id="TfpgWindowBase.Top"/>. Use the Top property to determine where the top side
+<descr><p><printshort id="#fpgui.fpg_base.TfpgWindowBase.Top"/>. Use the Top property to determine where the top side
of the control begins or to reposition the top side of the control.
</p>
<remark>fpGUI delays acting on the Top, Left, Width and Height properties of a control until the
-<var>UpdateWindowPosition</var> method is called. For more information on why this is so, see <link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
+<var>UpdateWindowPosition</var> method is called. For more information on why this
+is so, see <link id="#fpgui.fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
help.</remark></descr>
<seealso>
-<link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
+<link id="#fpgui.fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
</seealso>
</element>
<element name="TfpgWindowBase.Width">
<short>Specifies the horizontal size of the control or form in pixels</short>
-<descr><p><printshort id="TfpgWindowBase.Width"/>. Use the Width property
+<descr><p><printshort id="#fpgui.fpg_base.TfpgWindowBase.Width"/>. Use the Width property
to read or change the width of the control. For TfpgTabSheet controls of for
controls that have their Align property set to alTop, alBottom or alClient, changing
this property at runtime has no effect.
</p>
<remark>fpGUI delays acting on the Top, Left, Width and Height properties of a control until the
-<var>UpdateWindowPosition</var> method is called. For more information on why this is so, see <link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
+<var>UpdateWindowPosition</var> method is called. For more information on why this is so,
+see <link id="#fpgui.fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
help.</remark></descr>
<seealso>
-<link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
+<link id="#fpgui.fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
</seealso>
</element>
<element name="TfpgWindowBase.Height">
<short>Specifies the vertical size of the control or form in pixels</short>
-<descr><p><printshort id="TfpgWindowBase.Height"/>. Use the Height property
+<descr><p><printshort id="#fpgui.fpg_base.TfpgWindowBase.Height"/>. Use the Height property
to read or change the height of the control. For TfpgTabSheet controls of for
controls that have their Align property set to alLeft, alRight or alClient, changing
this property at runtime has no effect.
</p>
<remark>fpGUI delays acting on the Top, Left, Width and Height properties of a control until the
-<var>UpdateWindowPosition</var> method is called. For more information on why this is so, see <link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
+<var>UpdateWindowPosition</var> method is called. For more information on why this
+is so, see <link id="#fpgui.fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
help.</remark></descr>
<seealso>
-<link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
+<link id="#fpgui.fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
</seealso>
</element>
@@ -724,7 +728,7 @@ it makes the target window the active window. Note that depending on the operati
and Window Manager, the active window could still be obscured by other windows. Under Windows,
it seems that the active window is always brought to the front too.</descr>
<seealso>
-<link id="fpg_base.TfpgWindowBase.BringToFront"></link>
+<link id="#fpgui.fpg_base.TfpgWindowBase.BringToFront"></link>
</seealso>
</element>
@@ -742,7 +746,7 @@ it seems that the active window is always brought to the front too.</descr>
<!-- procedure Visibility: public -->
<element name="TfpgImageBase.Invert">
<short>Inverts the Image</short>
- <descr><printshort id="TfpgImageBase.Invert"/>. This changes the actual
+ <descr><printshort id="#fpgui.fpg_base.TfpgImageBase.Invert"/>. This changes the actual
data of the image. There is no undo function. So if you want to undo this action,
you must keep copy of the original image before you call <var>Invert</var>.</descr>
</element>
@@ -804,7 +808,7 @@ you must keep copy of the original image before you call <var>Invert</var>.</des
<short>A abstract class representing a base Interpolation filter.</short>
<descr>This is used as the base class to implement Interpolation filters like
Gaussian, Sinc etc... These decendant filters are used in the
-<link id="TfpgCanvasBase.StretchDraw">Canvas.StretchDraw</link> function.
+<link id="#fpgui.fpg_base.TfpgCanvasBase.StretchDraw">Canvas.StretchDraw</link> function.
</descr>
<seealso>
<link id="TfpgCanvasBase.StretchDraw">Canvas.StretchDraw</link>
@@ -813,15 +817,16 @@ Gaussian, Sinc etc... These decendant filters are used in the
<!-- procedure Visibility: public -->
<element name="TfpgCanvasBase.DrawRectangle">
<short>Draws a rectangle.</short>
- <descr>
- <printshort id="TfpgCanvasBase.DrawRectangle"/> You can specify the size of the rectangle via X, Y, Width and Height parameters or via a TfpgRect parameter.</descr>
+ <descr><printshort id="#fpgui.fpg_base.TfpgCanvasBase.DrawRectangle"/> You can specify the size of the rectangle via X, Y, Width and Height parameters or via a TfpgRect parameter.</descr>
</element>
<!-- procedure Visibility: public -->
<element name="TfpgCanvasBase.DrawLine">
<short>Draws a line</short>
- <descr>
- <printshort id="TfpgCanvasbase.DrawLine"/>. This method draws a line from (x1,y1) to (x2,y2), but does not draw the last pixel. All supported backends follow the Microsoft API and doesn't draw the last pixel. This optimises consecutive lines being drawn without overlapping pixels.</descr>
+ <descr><printshort id="#fpgui.fpg_base.TfpgCanvasBase.DrawLine"/>. This method
+draws a line from (x1,y1) to (x2,y2), but does not draw the last pixel. All supported
+backends follow the Microsoft API and doesn't draw the last pixel. This optimises
+consecutive lines being drawn without overlapping pixels.</descr>
</element>
<element name="TfpgCanvasBase.StretchDraw">
@@ -849,7 +854,7 @@ returns the correct enum type detected.
<short>Converts the TfpgColor to TRGBTriple type</short>
<descr>This function converts the given TfpgColor into a TRGBTriple type.</descr>
<seealso>
- <link id="fpg_base.TRGBTriple">TRGBTriple</link>
+ <link id="#fpgui.fpg_base.TRGBTriple">TRGBTriple</link>
</seealso>
</element>
@@ -859,7 +864,7 @@ returns the correct enum type detected.
<descr>This function converts the given TRGBTriple into a TfpgColor type.
</descr>
<seealso>
- <link id="fpg_base.TRGBTriple">TRGBTriple</link>
+ <link id="#fpgui.fpg_base.TRGBTriple">TRGBTriple</link>
</seealso>
</element>
<!-- function Visibility: default -->
@@ -911,7 +916,7 @@ Right. And the Top is always smaller than the Bottom.
<element name="TfpgCanvasBase.DrawLineClipped">
<short>Draws a line inside a clip rectangle</short>
- <descr><p><printshort id="TfpgCanvasBase.DrawLineClipped"/>. This procedure clips a line to the AClipRect boundaries and
+ <descr><p><printshort id="#fpgui.fpg_base.TfpgCanvasBase.DrawLineClipped"/>. This procedure clips a line to the AClipRect boundaries and
then calls the DrawLine procedure with the clipped coordinates. If the line
lies completely outside of the clip boundary, then the Line routine is not
called. This procedure uses the well known Cohen-Sutherland line clipping
@@ -928,7 +933,7 @@ Right. And the Top is always smaller than the Bottom.
<element name="TfpgCanvasBase.GradientFill">
<short>Paints a rectangle with a gradient</short>
-<descr><printshort id="TfpgCanvasBase.GradientFill"/>. If the gradient direction is
+<descr><printshort id="#fpgui.fpg_base.TfpgCanvasBase.GradientFill"/>. If the gradient direction is
set to gdHorizontal, then it pains from left to right. If the gradient direction is
set to gdVertical, then it paints from top to bottom.</descr>
</element>
@@ -972,7 +977,7 @@ will be removed.</descr>
<element name="TfpgPoint">
<short>An extension of the FPC TPoint structure</short>
-<descr><p><printshort id="TfpgPoint"/>. This structure is used inside the fpGUI framework, and includes some extra methods like
+<descr><p><printshort id="#fpgui.fpg_base.TfpgPoint"/>. This structure is used inside the fpGUI framework, and includes some extra methods like
calculating lengths between to points etc.</p></descr>
</element>
@@ -1011,7 +1016,7 @@ the streets of Manhattan.</p>
<element name="TfpgComponent">
<short>A descendant of the FPC TComponent class</short>
-<descr><p><printshort id="fpg_base.TfpgComponent"/>. It adds a location where we can extend
+<descr><p><printshort id="#fpgui.fpg_base.TfpgComponent"/>. It adds a location where we can extend
the TComponent, without having to make changes to each and every class in fpGUI.</p>
<p>For example: We added the TagPointer property (which is now largely obsolete) because
a while back the Tag property of TComponent could only store a 32bit value.
@@ -1023,12 +1028,12 @@ the type of the Tag property to support 64-bit addresses too.</p></descr>
<element name="fpgComponent.HelpContext">
<short>A numeric ID for the widget's context-sensitive help topic</short>
<descr><p>HelpContext supports help systems that use numeric topic IDs. For help
-systems that use topic keywords, see <link id="fpg_base.TfpgComponent.HelpKeyword">HelpKeyword</link>.</p>
-<p>To enable context-sensitive help for a widget, set <link id="fpg_base.TfpgComponent.HelpType">HelpType</link> to htContext and
+systems that use topic keywords, see <link id="#fpgui.fpg_base.TfpgComponent.HelpKeyword">HelpKeyword</link>.</p>
+<p>To enable context-sensitive help for a widget, set <link id="#fpgui.fpg_base.TfpgComponent.HelpType">HelpType</link> to htContext and
set HelpContext to a numeric topic ID. A topic ID of 0 (default) means that no help
topic is provided for the widget. A 0 ID also mean that the help system should
refer to the parent widget, if there is one, for a help topic; refer to the
-<link id="fpg_widget.TfpgWidget.InvokeHelp">TfpgWidget.InvokeHelp</link> method
+<link id="#fpgui.fpg_widget.TfpgWidget.InvokeHelp">TfpgWidget.InvokeHelp</link> method
for more information.</p></descr>
</element>
@@ -1050,7 +1055,7 @@ for more information.</p></descr>
<element name="TfpgBaseTimer.Enabled">
<short>Allows you to enable or disable the timer</short>
-<descr><printshort id="TfpgBaseTimer.Enabled"/>. The timer will not function until you
+<descr><printshort id="#fpgui.fpg_base.TfpgBaseTimer.Enabled"/>. The timer will not function until you
set the Enabled property to True. Later you can disable the timer by setting the
Enabled property to False.</descr>
</element>
diff --git a/docs/xml/corelib/fpg_command_intf.xml b/docs/xml/corelib/fpg_command_intf.xml
index 03ec28bb..b012efa8 100644
--- a/docs/xml/corelib/fpg_command_intf.xml
+++ b/docs/xml/corelib/fpg_command_intf.xml
@@ -1,22 +1,22 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="fpGUI">
<module name="fpg_command_intf">
<short>This unit defines the Command design pattern interfaces used by fpGUI</short>
-<descr><p><printshort id="fpg_command_intf"/>. The Command design pattern is similar to
+<descr><p><printshort id="#fpgui.fpg_command_intf"/>. The Command design pattern is similar to
the TActions from Delphi or Lazarus.</p></descr>
<element name="ICommand">
<short>This interface represents a Command</short>
-<descr><printshort id="ICommand"/>. Currently in only defines one procedure called <var>Execute</var>.</descr>
+<descr><printshort id="#fpgui.fpg_command_intf.ICommand"/>. Currently in only defines one procedure called <var>Execute</var>.</descr>
</element>
<element name="ICommandHolder">
<short>An interface that allows to Get or Set a Command</short>
-<descr><printshort id="ICommandHolder"/>. An example of a class that implements this interface
-is the <link id="fpg_button.TfpgBaseButton">TfpgBaseButton</link> class.</descr>
+<descr><printshort id="#fpgui.fpg_command_intf.ICommandHolder"/>. An example of a class that implements this interface
+is the <link id="#fpgui.fpg_button.TfpgBaseButton">TfpgBaseButton</link> class.</descr>
</element>
</module>
diff --git a/docs/xml/gui/fpg_button.xml b/docs/xml/gui/fpg_button.xml
index 0d0a13ce..ca39c92e 100644
--- a/docs/xml/gui/fpg_button.xml
+++ b/docs/xml/gui/fpg_button.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="fpGUI">
<module name="fpg_button">
@@ -35,23 +35,25 @@ is centred in the available horizontal space of the button.</descr>
<element name="TfpgBaseButton.ImageName">
<short>The registered name of a image to display on the button</short>
<descr>
- <printshort id="TfpgBaseButton.ImageName"/>. This is the name used when
-a image resource was registered with the global <link id="fpg_main.fpgImages">fpgImages</link> instance.</descr>
+ <printshort id="#fpgui.fpg_button.TfpgBaseButton.ImageName"/>. This is the name used when
+a image resource was registered with the global <link id="#fpgui.fpg_main.fpgImages">fpgImages</link> instance.</descr>
</element>
<element name="TfpgButton">
<short>Concrete button class used in user interfaces to represent a push button</short>
- <descr><printshort id="TfpgButton"/>. This class is a descendant of <link id="fpg_button.TfpgBaseButton">TfpgBaseButton</link> and
+ <descr><printshort id="#fpgui.fpg_button.TfpgButton"/>. This class is a
+descendant of <link id="#fpgui.fpg_button.TfpgBaseButton">TfpgBaseButton</link> and
simply publishes various properties for runtime type information.</descr>
<seealso>
- <link id="fpg_button.TfpgBaseButton">TfpgBaseButton</link>
+ <link id="#fpgui.fpg_button.TfpgBaseButton">TfpgBaseButton</link>
</seealso>
</element>
<element name="TfpgButton.ImageName" link="#fpgui.fpg_button.TfpgBaseButton.ImageName"/>
<element name="TfpgButton.ImageSpacing" link="#fpgui.fpg_button.TfpgBaseButton.ImageSpacing"/>
<element name="TfpgButton.ImageLayout" link="#fpgui.fpg_button.TfpgBaseButton.ImageLayout"/>
-
+<element name="TfpgButton.Left" link="#fpgui.fpg_base.TfpgWindowBase.Left"/>
+<element name="TfpgButton.Height" link="#fpgui.fpg_base.TfpgWindowBase.Height"/>
</module>
</package>
diff --git a/docs/xml/gui/fpg_colormapping.xml b/docs/xml/gui/fpg_colormapping.xml
index f605d782..f249aa52 100644
--- a/docs/xml/gui/fpg_colormapping.xml
+++ b/docs/xml/gui/fpg_colormapping.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="fpGUI">
<module name="fpg_colormapping">
diff --git a/docs/xml/gui/fpg_dialogs.xml b/docs/xml/gui/fpg_dialogs.xml
index 98e5fd2f..ef50cac8 100644
--- a/docs/xml/gui/fpg_dialogs.xml
+++ b/docs/xml/gui/fpg_dialogs.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="fpGUI">
diff --git a/docs/xml/gui/fpg_form.xml b/docs/xml/gui/fpg_form.xml
index 7bfdf975..6a3027b1 100644
--- a/docs/xml/gui/fpg_form.xml
+++ b/docs/xml/gui/fpg_form.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="fpGUI">
<module name="fpg_form">
diff --git a/docs/xml/gui/fpg_grid.xml b/docs/xml/gui/fpg_grid.xml
new file mode 100644
index 00000000..a916a544
--- /dev/null
+++ b/docs/xml/gui/fpg_grid.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<fpdoc-descriptions>
+<package name="fpGUI">
+
+<module name="fpg_grid">
+<short>This unit contains higher level grid widgets</short>
+<descr><printshort id="#fpgui.fpg_grid"/>. A File Grid and a String Grid widget.</descr>
+
+<element name="TfpgStringGrid.ShowGrid">
+<short>Enable or disable grid line painting</short>
+<descr>If enabled (the default), then grid lines are drawn around each cell.</descr>
+</element>
+
+<element name="TfpgStringGrid.OnDrawCell">
+<short>This event allows you to do custom painting of grid cells</short>
+<descr><p>ARow and ACol parameters should be obvious - they point to the cell being
+drawn. ARect is the boundaries of the Cell being painted. AFlags contain some
+state information about the grid. eg: Has the grid got focus, has the cell got
+focus etc. ADefaultDrawing is set to True by default, which means the grid
+will take care of painting the cell text for you (taking into account layout
+and alignment settings of each column). If you set this to False, then you
+need to paint the text yourself.</p>
+<code>
+procedure TMainForm.StringGridDrawCell(Sender: TObject; const ARow,
+ ACol: Integer; const ARect: TfpgRect; const AFlags: TfpgGridDrawState;
+ var ADefaultDrawing: boolean);
+begin
+ // two rows with different background color
+ if (ARow = 7) or (ARow = 8) then
+ begin
+ if ((gdSelected in AFlags) and (gdFocused in AFlags)) or
+ (gdSelected in AFlags) then
+ Exit; // we want select cel to be painted as normal
+ // If we got here, we must do some painting. The background first.
+ StringGrid.Canvas.Color := clOrange;
+ StringGrid.Canvas.FillRectangle(ARect);
+ // NOTE: We want the grid to take care of the drawing of the text, which
+ // handles text layout and alignment, so we MUST NOT set the
+ // ADefaultDrawing to False. If we do, we need to handle text painting
+ // ourselves.
+ end;
+end;
+</code>
+</descr>
+<seealso>
+ <link id="#fpgui.fpg_basegrid.TfpgDrawCellEvent">fpg_basegrid.TfpgDrawCellEvent</link>
+</seealso>
+</element>
+
+
+</module>
+</package>
+</fpdoc-descriptions>
+
diff --git a/docs/xml/gui/fpg_hyperlink.xml b/docs/xml/gui/fpg_hyperlink.xml
index ae59a8a9..76fdea13 100644
--- a/docs/xml/gui/fpg_hyperlink.xml
+++ b/docs/xml/gui/fpg_hyperlink.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="fpGUI">
<module name="fpg_hyperlink">
diff --git a/docs/xml/gui/fpg_tree.xml b/docs/xml/gui/fpg_tree.xml
index 54cbd893..6a69fd64 100644
--- a/docs/xml/gui/fpg_tree.xml
+++ b/docs/xml/gui/fpg_tree.xml
@@ -1,10 +1,10 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="fpGUI">
<module name="fpg_tree">
<short>This unit defines a tree view control</short>
-<descr><p><printshort id="fpg_tree"/>. A tree view displays items in an indented
+<descr><p><printshort id="#fpgui.fpg_tree"/>. A tree view displays items in an indented
outline. The control provides buttons that allow nodes to be expanded and collapsed.
You can include icons with items' text labels and display different icons to
indicate whether a node is expanded or collapsed.</p>
@@ -13,7 +13,7 @@ indicate whether a node is expanded or collapsed.</p>
<element name="TfpgTreeView">
<short>Represents a window that displays a hierachy list of items</short>
-<descr><p><printshort id="TfpgTreeView"/>. Examples of such hierachies can be
+<descr><p><printshort id="#fpgui.fpg_tree.TfpgTreeView"/>. Examples of such hierachies can be
the headings in a document, the entries in a index, or the files and directories
on a disk.</p>
<p>Use TfpgTreeView to add an expanding and contracting outline to a form. Each node
@@ -25,20 +25,20 @@ the user can expand or collapse the associated list of subnodes.</p>
<element name="TfpgTreeView.FullCollapse">
<short>Collapses all the nodes within a tree view control</short>
-<descr><printshort id="TfpgTreeView.FullCollapse"/>. Call FullCollapse to hide
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeView.FullCollapse"/>. Call FullCollapse to hide
all the nodes in the tree view except those at the first level. All node buttons
will change from '-' to '+'.</descr>
<seealso>
- <link id="TfpgTreeView.FullExpand"/>
+ <link id="#fpgui.fpg_tree.TfpgTreeView.FullExpand">TfpgTreeView.FullExpand</link>
</seealso>
</element>
<element name="TfpgTreeView.FullExpand">
<short>Expands all nodes within the tree view control</short>
-<descr><printshort id="TfpgTreeView.FullExpand"/>. Call FullExpand to display
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeView.FullExpand"/>. Call FullExpand to display
all the nodes in the tree view. All node buttons will change from '+' to '-'.</descr>
<seealso>
- <link id="TfpgTreeView.FullCollapse"/>
+ <link id="#fpgui.fpg_tree.TfpgTreeView.FullCollapse">TfpgTreeView.FullCollapse</link>
</seealso>
</element>
@@ -52,54 +52,54 @@ all the nodes in the tree view. All node buttons will change from '+' to '-'.</d
<element name="TfpgTreeView.NextNode">
<short>Return the next node after ANode</short>
-<descr><printshort id="TfpgTreeView.NextNode"/>. This function will step into child
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeView.NextNode"/>. This function will step into child
nodes as well, to return the correct node. It works on the actual nodes in the tree,
and not just the visible nodes in the tree.</descr>
<seealso>
- <link id="TfpgTreeView.PrevNode"/>
+ <link id="#fpgui.fpg_tree.TfpgTreeView.PrevNode">TfpgTreeView.PrevNode</link>
</seealso>
</element>
<element name="TfpgTreeView.PrevNode">
<short>Return the previous node starting from ANode</short>
-<descr><printshort id="TfpgTreeView.PrevNode"/>. This function will step into child
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeView.PrevNode"/>. This function will step into child
nodes as well, to insure it returns the correct node. It works on the actual nodes
in the tree, and not just on the visible nodes.</descr>
<seealso>
- <link id="TfpgTreeView.NextNode"/>
+ <link id="#fpgui.fpg_tree.TfpgTreeView.NextNode">TfpgTreeView.NextNode</link>
</seealso>
</element>
<element name="TfpgTreeview.NextVisualNode">
<short>Return the next visible node starting from ANode</short>
-<descr><printshort id="TfpgTreeview.NextVisualNode"/>. This works exactly the same
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeview.NextVisualNode"/>. This works exactly the same
as <var>NextNode</var> function, but this time it only acts on nodes that are visible.</descr>
<seealso>
- <link id="TfpgTreeview.NextNode"/>
+ <link id="#fpgui.fpg_tree.TfpgTreeview.NextNode">TfpgTreeview.NextNode</link>
</seealso>
</element>
<element name="TfpgTreeview.PrevVisualNode">
<short>Return the previous visible node starting from ANode</short>
-<descr><printshort id="TfpgTreeview.PrevVisualNode"/>. This works exactly the same
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeview.PrevVisualNode"/>. This works exactly the same
as <var>PrevNode</var> function, but this time it only acts on nodes that are visible.</descr>
<seealso>
- <link id="TfpgTreeview.PrevNode"/>
+ <link id="#fpgui.fpg_tree.TfpgTreeview.PrevNode">TfpgTreeview.PrevNode</link>
</seealso>
</element>
<element name="TfpgTreeview.Font">
<short>This gives you read access to the internal Font resource</short>
-<descr><printshort id="TfpgTreeview.Font"/>. If you want to change the font used
-in the tree view, use the <link id="TfpgTreeview.FondDesc">FondDesc</link> property instead.</descr>
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeview.Font"/>. If you want to change the font used
+in the tree view, use the <link id="#fpgui.fpg_tree.TfpgTreeview.FondDesc">FondDesc</link> property instead.</descr>
<seealso>
- <link id="TfpgTreeview.FontDesc"/>
+ <link id="#fpgui.fpg_tree.TfpgTreeview.FontDesc">TfpgTreeview.FontDesc</link>
</seealso>
</element>
<element name="TfpgTreeview.RootNode">
<short>Returns the first node of the tree where all other nodes branch from</short>
-<descr><printshort id="TfpgTreeview.RootNode"/>. This node is not a visible node, and
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeview.RootNode"/>. This node is not a visible node, and
is the internal node all other nodes in the tree branches from.</descr>
</element>
@@ -116,31 +116,31 @@ expanded, so the tree view will trigger the OnExpand event as well.</p></descr>
<element name="TfpgTreeview.ImageList">
<short>Refers to the image list associated with the tree view</short>
-<descr><printshort id="TfpgTreeview.ImageList"/>. Use the <var>ImageList</var> to
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeview.ImageList"/>. Use the <var>ImageList</var> to
provide a customised list of bitmaps that can be displayed with the node's text. Use
-the node's <link id="TfpgTreeNode.ImageIndex">ImageIndex</link> property to specify the
+the node's <link id="#fpgui.fpg_tree.TfpgTreeNode.ImageIndex">ImageIndex</link> property to specify the
bitmap that must be painted next to the node's text.</descr>
<seealso>
- <link id="TfpgTreeNode.ImageIndex"/>
+ <link id="#fpgui.fpg_tree.TfpgTreeNode.ImageIndex">TfpgTreeNode.ImageIndex</link>
</seealso>
</element>
<element name="TfpgTreeview.PopupMenu">
<short>Identifies the pop-up menu associated with the tree view</short>
-<descr><printshort id="TfpgTreeview.PopupMenu"/>. Assign a value to <var>PopupMenu</var>
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeview.PopupMenu"/>. Assign a value to <var>PopupMenu</var>
to make a popup-menu appear when the user selects the control and clicks the right mouse
button.</descr>
</element>
<element name="TfpgTreeview.DefaultColumnWidth">
<short>Is the default with of columns displayed in the tree view</short>
-<descr><p><printshort id="TfpgTreeview.DefaultColumnWidth"/>.</p>
+<descr><p><printshort id="#fpgui.fpg_tree.TfpgTreeview.DefaultColumnWidth"/>.</p>
<remark>There is basic column support, but this is still very experimental.</remark></descr>
</element>
<element name="TfpgTreeview.FontDesc">
<short>Specifies the font used for the tree view</short>
-<descr><printshort id="TfpgTreeview.FontDesc"/>. You can specify the font name and size
+<descr><printshort id="#fpgui.fpg_tree.TfpgTreeview.FontDesc"/>. You can specify the font name and size
in the format <var>fontname-size:attributes</var>, or you can use any of the font
aliases that has been setup. A font alias is a short name for some specific font, font size
and attribute all in one. A font alias is in the format <var>#aliasname</var>.</descr>