summaryrefslogtreecommitdiff
path: root/docs/xml/gui
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graemeg@users.sourceforge.net>2007-03-18 17:15:46 +0000
committerGraeme Geldenhuys <graemeg@users.sourceforge.net>2007-03-18 17:15:46 +0000
commit38020d5baa685bb03910b02f057c2179db149723 (patch)
treeac3a6a1b19b00d82e17c24f10b3304b9598c5094 /docs/xml/gui
parent5aca96cc8be2e68fa04bc00dfe4b00f480e44b2a (diff)
downloadfpGUI-38020d5baa685bb03910b02f057c2179db149723.tar.xz
more documentation updates as well as scrip updates to build the documentation.
Diffstat (limited to 'docs/xml/gui')
-rw-r--r--docs/xml/gui/examples/TStyleManager.RegisterClass.pas6
-rw-r--r--docs/xml/gui/fpgui.xml257
-rw-r--r--docs/xml/gui/motifstyle.xml8
-rw-r--r--docs/xml/gui/opensoftstyle.xml12
-rw-r--r--docs/xml/gui/stylemanager.xml200
-rw-r--r--docs/xml/gui/windowsstyle.xml14
6 files changed, 245 insertions, 252 deletions
diff --git a/docs/xml/gui/examples/TStyleManager.RegisterClass.pas b/docs/xml/gui/examples/TStyleManager.RegisterClass.pas
new file mode 100644
index 00000000..5518386f
--- /dev/null
+++ b/docs/xml/gui/examples/TStyleManager.RegisterClass.pas
@@ -0,0 +1,6 @@
+initialization
+ gStyleManager.RegisterClass(cDefaultStyle, TWindowsStyle);
+ gStyleManager.RegisterClass('Windows', TWindowsStyle);
+ gStyleManager.RegisterClass('OpenSoft', TOpenSoftStyle);
+ gStyleManager.RegisterClass('Motif', TMotifStyle);
+
diff --git a/docs/xml/gui/fpgui.xml b/docs/xml/gui/fpgui.xml
index 71db669f..5a1cd297 100644
--- a/docs/xml/gui/fpgui.xml
+++ b/docs/xml/gui/fpgui.xml
@@ -640,523 +640,523 @@
<short />
</element>
<!-- object Visibility: default -->
- <element name="TStyle">
- <short>The TStyle class is an abstract base class that
+ <element name="TStyleAbs">
+ <short>The TStyleAbs class is an abstract base class that
encapsulates the look and feel of a GUI.</short>
- <descr>fpGUI contains a set of TStyle subclasses that
+ <descr>fpGUI contains a set of TStyleAbs subclasses that
emulate the styles of the different platforms supported by
fpGUI (TWindowsStyle, TMotifStyle, etc.). By default, these
styles are built into the fpGUI library. Styles are
preferably applied application wide, but can also be
- applied per widget. fpGUI's built-in widgets use TStyle to
+ applied per widget. fpGUI's built-in widgets use TStyleAbs to
perform all of their drawing, ensuring that they look
exactly like the equivalent native widgets.</descr>
<seealso>
- <link id="TDefaultStyle" />
+ <link id="TBasicStyle" />
</seealso>
</element>
<!-- variable Visibility: protected -->
- <element name="TStyle.UIColorCache">
+ <element name="TStyleAbs.UIColorCache">
<short />
<descr />
<seealso />
</element>
<!-- constructor Visibility: public -->
- <element name="TStyle.Create">
+ <element name="TStyleAbs.Create">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.Create.ADisplay">
+ <element name="TStyleAbs.Create.ADisplay">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.UpdateUIColorCache">
+ <element name="TStyleAbs.UpdateUIColorCache">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetGUIColor">
+ <element name="TStyleAbs.GetGUIColor">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetGUIColor.Result">
+ <element name="TStyleAbs.GetGUIColor.Result">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetGUIColor.Color">
+ <element name="TStyleAbs.GetGUIColor.Color">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetUIColor">
+ <element name="TStyleAbs.GetUIColor">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetUIColor.Result">
+ <element name="TStyleAbs.GetUIColor.Result">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetUIColor.AColor">
+ <element name="TStyleAbs.GetUIColor.AColor">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.SetUIColor">
+ <element name="TStyleAbs.SetUIColor">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.SetUIColor.Canvas">
+ <element name="TStyleAbs.SetUIColor.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.SetUIColor.Color">
+ <element name="TStyleAbs.SetUIColor.Color">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawText">
+ <element name="TStyleAbs.DrawText">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawText.Canvas">
+ <element name="TStyleAbs.DrawText.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawText.APosition">
+ <element name="TStyleAbs.DrawText.APosition">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawText.AText">
+ <element name="TStyleAbs.DrawText.AText">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawText.State">
+ <element name="TStyleAbs.DrawText.State">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawItemBefore">
+ <element name="TStyleAbs.DrawItemBefore">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawItemBefore.Canvas">
+ <element name="TStyleAbs.DrawItemBefore.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawItemBefore.ARect">
+ <element name="TStyleAbs.DrawItemBefore.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawItemBefore.Flags">
+ <element name="TStyleAbs.DrawItemBefore.Flags">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawItemAfter">
+ <element name="TStyleAbs.DrawItemAfter">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawItemAfter.Canvas">
+ <element name="TStyleAbs.DrawItemAfter.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawItemAfter.ARect">
+ <element name="TStyleAbs.DrawItemAfter.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawItemAfter.Flags">
+ <element name="TStyleAbs.DrawItemAfter.Flags">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawWindowBackground">
+ <element name="TStyleAbs.DrawWindowBackground">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawWindowBackground.Canvas">
+ <element name="TStyleAbs.DrawWindowBackground.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawWindowBackground.ARect">
+ <element name="TStyleAbs.DrawWindowBackground.ARect">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawButtonFace">
+ <element name="TStyleAbs.DrawButtonFace">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawButtonFace.Canvas">
+ <element name="TStyleAbs.DrawButtonFace.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawButtonFace.ARect">
+ <element name="TStyleAbs.DrawButtonFace.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawButtonFace.Flags">
+ <element name="TStyleAbs.DrawButtonFace.Flags">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetButtonBorders">
+ <element name="TStyleAbs.GetButtonBorders">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetButtonBorders.Result">
+ <element name="TStyleAbs.GetButtonBorders.Result">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetSeparatorSize">
+ <element name="TStyleAbs.GetSeparatorSize">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetSeparatorSize.Result">
+ <element name="TStyleAbs.GetSeparatorSize.Result">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawSeparator">
+ <element name="TStyleAbs.DrawSeparator">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawSeparator.Canvas">
+ <element name="TStyleAbs.DrawSeparator.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawSeparator.ARect">
+ <element name="TStyleAbs.DrawSeparator.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawSeparator.AOrientation">
+ <element name="TStyleAbs.DrawSeparator.AOrientation">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawGroupBox">
+ <element name="TStyleAbs.DrawGroupBox">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawGroupBox.Canvas">
+ <element name="TStyleAbs.DrawGroupBox.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawGroupBox.ARect">
+ <element name="TStyleAbs.DrawGroupBox.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawGroupBox.ALabel">
+ <element name="TStyleAbs.DrawGroupBox.ALabel">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawGroupBox.WidgetState">
+ <element name="TStyleAbs.DrawGroupBox.WidgetState">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetGroupBoxBorders">
+ <element name="TStyleAbs.GetGroupBoxBorders">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetGroupBoxBorders.Result">
+ <element name="TStyleAbs.GetGroupBoxBorders.Result">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetGroupBoxBorders.Canvas">
+ <element name="TStyleAbs.GetGroupBoxBorders.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetGroupBoxBorders.ALabel">
+ <element name="TStyleAbs.GetGroupBoxBorders.ALabel">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetGroupBoxBorders.LabelWidth">
+ <element name="TStyleAbs.GetGroupBoxBorders.LabelWidth">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawEditBox">
+ <element name="TStyleAbs.DrawEditBox">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawEditBox.Canvas">
+ <element name="TStyleAbs.DrawEditBox.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawEditBox.ARect">
+ <element name="TStyleAbs.DrawEditBox.ARect">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetEditBoxBorders">
+ <element name="TStyleAbs.GetEditBoxBorders">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetEditBoxBorders.Result">
+ <element name="TStyleAbs.GetEditBoxBorders.Result">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawCheckBox">
+ <element name="TStyleAbs.DrawCheckBox">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawCheckBox.Canvas">
+ <element name="TStyleAbs.DrawCheckBox.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawCheckBox.ARect">
+ <element name="TStyleAbs.DrawCheckBox.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawCheckBox.LabelRect">
+ <element name="TStyleAbs.DrawCheckBox.LabelRect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawCheckBox.Flags">
+ <element name="TStyleAbs.DrawCheckBox.Flags">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.GetCheckBoxLayout">
+ <element name="TStyleAbs.GetCheckBoxLayout">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetCheckBoxLayout.LabelSize">
+ <element name="TStyleAbs.GetCheckBoxLayout.LabelSize">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetCheckBoxLayout.TotalSize">
+ <element name="TStyleAbs.GetCheckBoxLayout.TotalSize">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetCheckBoxLayout.LabelPos">
+ <element name="TStyleAbs.GetCheckBoxLayout.LabelPos">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawRadioButton">
+ <element name="TStyleAbs.DrawRadioButton">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawRadioButton.Canvas">
+ <element name="TStyleAbs.DrawRadioButton.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawRadioButton.ARect">
+ <element name="TStyleAbs.DrawRadioButton.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawRadioButton.LabelRect">
+ <element name="TStyleAbs.DrawRadioButton.LabelRect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawRadioButton.Flags">
+ <element name="TStyleAbs.DrawRadioButton.Flags">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.GetRadioButtonLayout">
+ <element name="TStyleAbs.GetRadioButtonLayout">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetRadioButtonLayout.LabelSize">
+ <element name="TStyleAbs.GetRadioButtonLayout.LabelSize">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetRadioButtonLayout.TotalSize">
+ <element name="TStyleAbs.GetRadioButtonLayout.TotalSize">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetRadioButtonLayout.LabelPos">
+ <element name="TStyleAbs.GetRadioButtonLayout.LabelPos">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetComboBoxArrowSize">
+ <element name="TStyleAbs.GetComboBoxArrowSize">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetComboBoxArrowSize.Result">
+ <element name="TStyleAbs.GetComboBoxArrowSize.Result">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawComboBoxArrow">
+ <element name="TStyleAbs.DrawComboBoxArrow">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawComboBoxArrow.Canvas">
+ <element name="TStyleAbs.DrawComboBoxArrow.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawComboBoxArrow.ARect">
+ <element name="TStyleAbs.DrawComboBoxArrow.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawComboBoxArrow.IsPressed">
+ <element name="TStyleAbs.DrawComboBoxArrow.IsPressed">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawComboBoxArrow.IsEnabled">
+ <element name="TStyleAbs.DrawComboBoxArrow.IsEnabled">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetScrollBarBorders">
+ <element name="TStyleAbs.GetScrollBarBorders">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetScrollBarBorders.Result">
+ <element name="TStyleAbs.GetScrollBarBorders.Result">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetScrollBarBorders.Orientation">
+ <element name="TStyleAbs.GetScrollBarBorders.Orientation">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetScrollBarBtnSize">
+ <element name="TStyleAbs.GetScrollBarBtnSize">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetScrollBarBtnSize.Result">
+ <element name="TStyleAbs.GetScrollBarBtnSize.Result">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetScrollBarBtnSize.Orientation">
+ <element name="TStyleAbs.GetScrollBarBtnSize.Orientation">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetScrollBarBtnMinSize">
+ <element name="TStyleAbs.GetScrollBarBtnMinSize">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetScrollBarBtnMinSize.Result">
+ <element name="TStyleAbs.GetScrollBarBtnMinSize.Result">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawScrollBarBorder">
+ <element name="TStyleAbs.DrawScrollBarBorder">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawScrollBarBorder.Canvas">
+ <element name="TStyleAbs.DrawScrollBarBorder.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawScrollBarBorder.ARect">
+ <element name="TStyleAbs.DrawScrollBarBorder.ARect">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawScrollBarButton">
+ <element name="TStyleAbs.DrawScrollBarButton">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawScrollBarButton.Canvas">
+ <element name="TStyleAbs.DrawScrollBarButton.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawScrollBarButton.ARect">
+ <element name="TStyleAbs.DrawScrollBarButton.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawScrollBarButton.Direction">
+ <element name="TStyleAbs.DrawScrollBarButton.Direction">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawScrollBarButton.IsPressed">
+ <element name="TStyleAbs.DrawScrollBarButton.IsPressed">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawScrollBarButton.IsEnabled">
+ <element name="TStyleAbs.DrawScrollBarButton.IsEnabled">
<short />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetScrollBoxBorders">
+ <element name="TStyleAbs.GetScrollBoxBorders">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetScrollBoxBorders.Result">
+ <element name="TStyleAbs.GetScrollBoxBorders.Result">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawScrollBoxBorder">
+ <element name="TStyleAbs.DrawScrollBoxBorder">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawScrollBoxBorder.Canvas">
+ <element name="TStyleAbs.DrawScrollBoxBorder.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawScrollBoxBorder.ARect">
+ <element name="TStyleAbs.DrawScrollBoxBorder.ARect">
<short />
</element>
<!-- object Visibility: default -->
@@ -3047,7 +3047,7 @@
<p>Sets or Gets the widget's GUI style. The ownership of
the style object is not transferred.</p>
<p>If no style is set, the widget uses the application's
- style, TApplication.DefaultStyle instead.</p>
+ style default style, return by the gStyleManager.</p>
<p>
<b>Warning:</b>This function is particularly useful for
demonstration purposes, where you want to show fpGUI's
@@ -3055,8 +3055,7 @@
and use one consistent GUI style instead.</p>
</descr>
<seealso>
- <link id="TApplication.DefaultStyle" />
- <link id="TStyle" />
+ <link id="TStyleAbs" />
</seealso>
</element>
<!-- property Visibility: public -->
@@ -8039,64 +8038,64 @@
<short>maximum allowed value</short>
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.Draw3DFrame">
+ <element name="TStyleAbs.Draw3DFrame">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.Draw3DFrame.Canvas">
+ <element name="TStyleAbs.Draw3DFrame.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.Draw3DFrame.ARect">
+ <element name="TStyleAbs.Draw3DFrame.ARect">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.Draw3DFrame.Color1">
+ <element name="TStyleAbs.Draw3DFrame.Color1">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.Draw3DFrame.Color2">
+ <element name="TStyleAbs.Draw3DFrame.Color2">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.Draw3DFrame.Color3">
+ <element name="TStyleAbs.Draw3DFrame.Color3">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.Draw3DFrame.Color4">
+ <element name="TStyleAbs.Draw3DFrame.Color4">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawFocusRect">
+ <element name="TStyleAbs.DrawFocusRect">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawFocusRect.Canvas">
+ <element name="TStyleAbs.DrawFocusRect.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawFocusRect.ARect">
+ <element name="TStyleAbs.DrawFocusRect.ARect">
<short />
</element>
<!-- procedure Visibility: public -->
- <element name="TStyle.DrawSunkenOuterBorder">
+ <element name="TStyleAbs.DrawSunkenOuterBorder">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawSunkenOuterBorder.Canvas">
+ <element name="TStyleAbs.DrawSunkenOuterBorder.Canvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.DrawSunkenOuterBorder.ARect">
+ <element name="TStyleAbs.DrawSunkenOuterBorder.ARect">
<short />
</element>
<!-- object Visibility: default -->
@@ -8486,26 +8485,26 @@
<seealso />
</element>
<!-- function Visibility: public -->
- <element name="TStyle.GetMenuBorders">
+ <element name="TStyleAbs.GetMenuBorders">
<short />
<descr />
<errors />
<seealso />
</element>
<!-- function result Visibility: default -->
- <element name="TStyle.GetMenuBorders.Result">
+ <element name="TStyleAbs.GetMenuBorders.Result">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetMenuBorders.pCanvas">
+ <element name="TStyleAbs.GetMenuBorders.pCanvas">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetMenuBorders.pText">
+ <element name="TStyleAbs.GetMenuBorders.pText">
<short />
</element>
<!-- argument Visibility: default -->
- <element name="TStyle.GetMenuBorders.pTextWidth">
+ <element name="TStyleAbs.GetMenuBorders.pTextWidth">
<short />
</element>
<!-- function Visibility: public -->
diff --git a/docs/xml/gui/motifstyle.xml b/docs/xml/gui/motifstyle.xml
index 80d4ab62..0374d286 100644
--- a/docs/xml/gui/motifstyle.xml
+++ b/docs/xml/gui/motifstyle.xml
@@ -7,8 +7,8 @@
====================================================================
-->
<module name="MotifStyle">
- <short></short>
- <descr></descr>
+ <short>Defines a Motif GUI Style.</short>
+ <descr><printshort id="MotifStyle" />. The traditional Unix GUI style.</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short></short>
@@ -35,8 +35,8 @@
</element>
<!-- object Visibility: default -->
<element name="TMotifStyle">
- <short></short>
- <descr></descr>
+ <short>Defines a Motif GUI Style.</short>
+ <descr><printshort id="TMotifStyle" />. The traditional Unix GUI style.</descr>
<errors></errors>
<seealso></seealso>
</element>
diff --git a/docs/xml/gui/opensoftstyle.xml b/docs/xml/gui/opensoftstyle.xml
index 1f768571..3dc27776 100644
--- a/docs/xml/gui/opensoftstyle.xml
+++ b/docs/xml/gui/opensoftstyle.xml
@@ -7,8 +7,10 @@
====================================================================
-->
<module name="OpenSoftStyle">
- <short></short>
- <descr></descr>
+ <short>Defines a custom GUI Style called OpenSoft.</short>
+ <descr><printshort id="OpenSoftStyle" />. This started as a proof-of-concept
+ on how a custom style can be created. In the future this will be used
+ as the default style in my company products.</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short></short>
@@ -75,8 +77,10 @@
</element>
<!-- object Visibility: default -->
<element name="TOpenSoftStyle">
- <short></short>
- <descr></descr>
+ <short>Defines a custom GUI Style called OpenSoft.</short>
+ <descr><printshort id="OpenSoftStyle" />. This started as a proof-of-concept
+ on how a custom style can be created. In the future this will be used
+ as the default style in my company products.</descr>
<errors></errors>
<seealso></seealso>
</element>
diff --git a/docs/xml/gui/stylemanager.xml b/docs/xml/gui/stylemanager.xml
index fa3404f3..f3f6bc60 100644
--- a/docs/xml/gui/stylemanager.xml
+++ b/docs/xml/gui/stylemanager.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
+<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="fpGUI">
<!--
@@ -7,212 +7,190 @@
====================================================================
-->
<module name="StyleManager">
- <short></short>
- <descr></descr>
+ <short>Defines a class that manages all the GUI Styles.</short>
+ <descr><printshort id="StyleManager" />. All the different styles
+ must register with the Style Manager to be used at runtime.</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Contnrs">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="fpGUI">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- constant Visibility: default -->
- <element name="cDefaultStyle">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <element name="cDefaultStyle"> <short>Defines the default style the system will use.</short>
+ <descr><printshort id="cDefaultStyle"/></descr>
</element>
<!-- "class of" type Visibility: default -->
<element name="TStyleClass">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- object Visibility: default -->
- <element name="TStyleManager">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <element name="TStyleManager"> <short>Class that manages the different styles</short>
+ <descr><printshort id="TStyleManager"/>. It's function is to register new style classes, create instances of the style classes and many more functions.</descr>
</element>
<!-- variable Visibility: private -->
<element name="TStyleManager.FDefaultStyle">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TStyleManager.FUserStyle">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- function Visibility: private -->
- <element name="TStyleManager.GetDefaultStyle">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <element name="TStyleManager.GetDefaultStyle"> <short>Returns a instance of the default style</short>
+ <descr><printshort id="TStyleManager.GetDefaultStyle"/>. At the moment the default style is hard-coded to the Windows Style, but in the future it will be auto-detected based on the OS and Desktop Manager used.</descr>
</element>
<!-- function result Visibility: default -->
<element name="TStyleManager.GetDefaultStyle.Result">
- <short></short>
+ <short/>
</element>
<!-- constructor Visibility: public -->
<element name="TStyleManager.Create">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <errors/>
+ <seealso/>
</element>
<!-- destructor Visibility: public -->
<element name="TStyleManager.Destroy">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <errors/>
+ <seealso/>
</element>
<!-- property Visibility: public -->
<element name="TStyleManager.DefaultStyle">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TStyleManager.SetStyle">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <errors/>
+ <seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TStyleManager.SetStyle.pNewStyle">
- <short></short>
+ <short/>
</element>
<!-- function Visibility: default -->
- <element name="gStyleManager">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <element name="gStyleManager"> <short>Singleton function to access the Style Manager</short>
+ <descr><printshort id="gStyleManager"/>. Never create a instance of TStyleManager, always access in through the singleton function.</descr>
</element>
<!-- function result Visibility: default -->
<element name="gStyleManager.Result">
- <short></short>
+ <short/>
</element>
<!-- object Visibility: default -->
- <element name="TStyleClassMapping">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <element name="TStyleClassMapping"> <short>Class to map a string name to a style class</short>
+ <descr><printshort id="TStyleClassMapping"/>. Used internally as a data class to map a user friendly style name to a style class.</descr>
</element>
<!-- variable Visibility: private -->
<element name="TStyleClassMapping.FsMappingName">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TStyleClassMapping.FStyleClass">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TStyleClassMapping.Create">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <errors/>
+ <seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TStyleClassMapping.Create.AMappingName">
- <short></short>
+ <short/>
</element>
<!-- argument Visibility: default -->
<element name="TStyleClassMapping.Create.AStyleClass">
- <short></short>
+ <short/>
</element>
<!-- property Visibility: public -->
- <element name="TStyleClassMapping.MappingName">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <element name="TStyleClassMapping.MappingName"> <short>User friendly style name</short>
+ <descr><printshort id="TStyleClassMapping.MappingName"/>.</descr>
</element>
<!-- property Visibility: public -->
- <element name="TStyleClassMapping.StyleClass">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <element name="TStyleClassMapping.StyleClass"> <short>Class reference to the Style Class</short>
+ <descr><printshort id="TStyleClassMapping.StyleClass"/>.</descr>
</element>
<!-- variable Visibility: private -->
<element name="TStyleManager.FList">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TStyleManager.FDefaultStyleType">
- <short></short>
- <descr></descr>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TStyleManager.SetStyle.AStyleName">
- <short></short>
+ <short/>
</element>
<!-- procedure Visibility: public -->
- <element name="TStyleManager.RegisterClass">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <element name="TStyleManager.RegisterClass"> <short>Method used to register a new style with the Style Manager</short>
+ <descr><printshort id="TStyleManager.RegisterClass"/></descr>
+ <example file="examples/TStyleManager.RegisterClass.pas"/>
</element>
<!-- argument Visibility: default -->
<element name="TStyleManager.RegisterClass.AStyleName">
- <short></short>
+ <short/>
</element>
<!-- argument Visibility: default -->
<element name="TStyleManager.RegisterClass.AStyleClass">
- <short></short>
+ <short/>
</element>
<!-- function Visibility: public -->
- <element name="TStyleManager.CreateInstance">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <element name="TStyleManager.CreateInstance"> <short>Creates an instance of the named style</short>
+ <descr><printshort id="TStyleManager.CreateInstance"/>.</descr>
</element>
<!-- function result Visibility: default -->
- <element name="TStyleManager.CreateInstance.Result">
- <short></short>
+ <element name="TStyleManager.CreateInstance.Result"> <short>An instance of the named style</short>
+ <descr><printshort id="TStyleManager.CreateInstance.Result"/>.</descr>
</element>
<!-- argument Visibility: default -->
- <element name="TStyleManager.CreateInstance.AStyleName">
- <short></short>
+ <element name="TStyleManager.CreateInstance.AStyleName"> <short>The style name</short>
+ <descr><printshort id="TStyleManager.CreateInstance.AStyleName"/>. This name will be used and looked up internally in the style manager and if found, a instance of that style will be returned.</descr>
</element>
<!-- procedure Visibility: public -->
<element name="TStyleManager.AssignStyleTypes">
- <short></short>
- <descr></descr>
- <errors></errors>
- <seealso></seealso>
+ <short/>
+ <descr/>
+ <errors/>
+ <seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TStyleManager.AssignStyleTypes.AStrings">
- <short></short>
+ <short/>
</element>
</module>
<!-- StyleManager -->
diff --git a/docs/xml/gui/windowsstyle.xml b/docs/xml/gui/windowsstyle.xml
index 7c0a35d6..96fd9690 100644
--- a/docs/xml/gui/windowsstyle.xml
+++ b/docs/xml/gui/windowsstyle.xml
@@ -7,8 +7,11 @@
====================================================================
-->
<module name="WindowsStyle">
- <short></short>
- <descr></descr>
+ <short>Defines the Windows 9x/2000 GUI Style</short>
+ <descr><printshort id="WindowsStyle" />. Currently this is the default
+ style under all platforms. In the future the Style Manager will be
+ able to detect the OS and Desktop Manager and then pick a more
+ appropriate style.</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short></short>
@@ -29,8 +32,11 @@
</element>
<!-- object Visibility: default -->
<element name="TWindowsStyle">
- <short></short>
- <descr></descr>
+ <short>Defines the Windows 9x/2000 GUI Style.</short>
+ <descr><printshort id="TWindowsStyle" />. Currently this is the default
+ style under all platforms. In the future the Style Manager will be
+ able to detect the OS and Desktop Manager and then pick a more
+ appropriate style.</descr>
<errors></errors>
<seealso></seealso>
</element>