summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graeme@mastermaths.co.za>2012-05-23 12:10:47 +0200
committerGraeme Geldenhuys <graeme@mastermaths.co.za>2012-07-31 09:54:03 +0100
commit2fc3a798df2aca429b17f34785f467450a6ac48b (patch)
tree7d3eacfdd7dbdebd9858ec78d16065256cc9d8ec /docs
parentf519c8d66d78cb5731d711eda48b94b2c98b2ead (diff)
downloadfpGUI-2fc3a798df2aca429b17f34785f467450a6ac48b.tar.xz
documented the BringToFront and ActivateWindow methods.
Diffstat (limited to 'docs')
-rw-r--r--docs/xml/corelib/fpg_base.xml23
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml
index 2b6cd0f5..aeaddc44 100644
--- a/docs/xml/corelib/fpg_base.xml
+++ b/docs/xml/corelib/fpg_base.xml
@@ -707,6 +707,27 @@ help.</remark></descr>
</seealso>
</element>
+<element name="TfpgWindowBase.BringToFront">
+<short>Changes the z-order of a window</short>
+<descr>This doesn't have much meaning at the widget level, but at the TfpgForm level,
+it brings a window to the front - above all other windows of the application. Note that
+this only changes the z-order, it doesn't actually change window focus.</descr>
+<seealso>
+<link id="fpg_base.TfpgWindowBase.ActivateWindow"></link>
+</seealso>
+</element>
+
+<element name="TfpgWindowBase.ActivateWindow">
+<short>This makse the target window the active window</short>
+<descr>This doesn't have much meaning at the widget level, but at the TfpgForm level,
+it makes the target window the active window. Note that depending on the operating system
+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>
+</seealso>
+</element>
+
<!-- object Visibility: default -->
<element name="TfpgCanvasBase">
<short>Abstract class used to represent a Canvas for painting</short>
@@ -895,7 +916,7 @@ Right. And the Top is always smaller than the Bottom.
For a detailed explanation see: http://www.nondot.org/~sabre/graphpro/line6.html
</p></descr>
</element>
-
+
<element name="TfpgCanvasBase.ClipLine">
<short>Clips the line based on AClipRect boundaries.</short>
<descr>This does not do any drawing, in only clips the line coordinates. This method is used internally by <link id="TfpgCanvasBase.DrawLineClipped"/>.</descr>