blob: 654cd76322045d657e8098380133f2311706e52d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="fpGUI">
<module name="fpg_main">
<short>The main unit that ties everything together from CoreLib</short>
<descr>
<p>
<printshort id="fpg_main"/>. This unit contain the higher level classes that the end-user will use to build applications.
</p>
<p>This unit also contains the global objects instances used to start an application, or helper functions used through a a fpGUI based application. eg: <link id="fpgApplication"/>, <link id="fpgClipboard"/>.</p>
</descr>
<!-- procedure Visibility: default -->
<element name="fpgPostMessage">
<short>Posts a message to the event queue</short>
<descr>fpgPostMessage posts a message to the event queue, but doesn't wait for it to compelete. It returns immediately.</descr>
<errors/>
<seealso>
<link id="fpg_main.fpgSendMessage"/>
</seealso>
</element>
<!-- procedure Visibility: default -->
<element name="fpgSendMessage">
<short>Sends a message to the event queue</short>
<descr>fpgSendMessage sends a message to the event queue and waits for it to complete before it returns.</descr>
<errors/>
<seealso>
<link id="fpg_main.fpgPostMessage"/>
</seealso>
</element>
<element name="fpgColorToRGB">
<short>Convert a color to the RGB values of that color</short>
<descr><printshort id="fpgColorToRGB"/>. Not all <link id="fpg_base.TfpgColor">TfpgColor</link> values are in RGB format.
For example, you get "named" colors too (eg: clWindowBackground), which
is simply an index value, but later translated to a real RGB value via the theming system.</descr>
</element>
<element name="fpgGetNamedColor">
<short>Returns a "named" TfpgColor based on a RGB color</short>
</element>
<element name="fpgSetNamedColor">
<short>Define a new "named" color</short>
</element>
<element name="fpgGetNamedFontList">
<short>Return a TStringList of "named" fonts</short>
</element>
<element name="fpgSetNamedFont">
<short>Defined a new "named" font</short>
<descr>
<printshort id="fpgSetNamedFont"/>. Because fpGUI is a cross-platform toolkit, the same fonts might not be available on all systems. For this reason fpGUI supports "named" or "alias names" for fonts. You can specify a font description, and then give that font description a name. Then any component that has a FontDesc property you can pass the full font description, or the "named" font name. An example of a named font is '#Edit1' which is the default font used for <link id="fpg_edit.TfpgEdit">TfpgEdit</link>.</descr>
</element>
<element name="TfpgCanvas">
<short>This is the drawing Canvas of each widget</short>
<descr><printshort id="TfpgCanvas"/>.</descr>
</element>
<element name="TfpgCanvas.DrawText">
<short>Output Text onto the Canvas</short>
<descr>
<printshort id="TfpgCanvas.DrawText"/>.</descr>
</element>
<element name="TfpgCanvas.StretchDraw" link="#fpgui.fpg_base.TfpgCanvasBase.StretchDraw">
</element>
<element name="PrintRect">
<short>Prints rectangle information to console</short>
<descr><printshort id="PrintRect"/>. This is a helper function for debugging purposes.</descr>
<seealso>
<link id="fpg_base.TfpgRect">TfpgRect</link>
</seealso>
</element>
<element name="TfpgStyle">
<short>This supplies very basic theming support for now</short>
<descr><p><printshort id="TfpgStyle"/>. At a later date the theming support in
fpGUI will be totally reworked to supply built-in and image based theming.</p><p>See the
document named <var>theming_spec.txt</var> in the "docs" folder for details of what is
planned.</p></descr>
</element>
<element name="fpgRect">
<seealso>
<link id="fpg_base.TfpgRect">TfpgRect</link>
</seealso>
</element>
<element name="TfpgApplication">
<short>A concrete class that encapsulates a fpGUI application</short>
</element>
<element name="TfpgApplication.InvokeHelp" link="#fpgui.fpg_base.TfpgApplicationBase.InvokeHelp">
<short>fake</short>
</element>
<element name="TfpgApplication.HelpFile" link="#fpgui.fpg_base.TfpgApplicationBase.HelpFile">
<short>fake</short>
</element>
<element name="TfpgApplication.GetFormByClassName">
<short>Finds a form instance by its ClassName property</short>
<descr><printshort id="TfpgApplication.GetFormByClassName"/>. This only works if the form has
been created with <var>fpgApplication.CreateForm()</var>. If no form is found, then nil is
returned.</descr>
</element>
<element name="TfpgApplication.GetFormByName">
<short>Finds a form instance by its Name property</short>
<descr><printshort id="TfpgApplication.GetFormByName"/>. This only works if the form has
been created with <var>fpgApplication.CreateForm()</var>. If no form is found, then nil is
returned.</descr>
</element>
<element name="TfpgTimer">
<short>A timer component for fpGUI applications</short>
<descr><printshort id="TfpgTimer"/>.</descr>
</element>
<element name="TfpgTimer.Create">
<short>Use this method to create a timer component instance</short>
<descr><printshort id="TfpgTimer.Create"/>. The AInterval parameter is a value in
milliseconds. The timer will fire the OnTimer event every AInterval milliseconds or
until the timer is disabled when the Enabled property is set to False.</descr>
</element>
<element name="TfpgTimer.Enabled" link="#fpgui.fpg_base.TfpgBaseTimer.Enabled">
</element>
<element name="TfpgWindow">
<short>Encapsulates a top level or child window</short>
<descr><printshort id="TfpgWindow"/>.</descr>
</element>
<element name="TfpgImageBase">
<short>The base class representing a image</short>
<descr><printshort id="TfpgImageBase"/>.</descr>
</element>
<element name="TfpgImageBase.ImageData">
<short>Contains the pixel data of the image. The data format is in AARRGGBB format.</short>
<descr><printshort id="TfpgImageBase.ImageData"/>.</descr>
</element>
</module>
<!-- fpg_main -->
</package>
</fpdoc-descriptions>
|
