From bf484450bf675e209c78dbbaef9d81503530e9a4 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Tue, 12 Jul 2011 20:35:06 +0200 Subject: docs: update for fpg_base unit --- docs/xml/corelib/fpg_base.xml | 96 +++++++++++++++++++++++++++---------------- 1 file changed, 61 insertions(+), 35 deletions(-) diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml index a222542e..428eae3e 100644 --- a/docs/xml/corelib/fpg_base.xml +++ b/docs/xml/corelib/fpg_base.xml @@ -51,8 +51,8 @@ etc.). - A record structure holding the RGBA values of a color. - This is now marked as "deprecated". Please use TFPColor instead. + A record structure holding the RGBA values of a color + . This is now marked as "deprecated". Please use TFPColor instead. @@ -87,32 +87,50 @@ means no titlebar or window borders are going to be created. This window will normally not have a titlebar or window borders. This window will normally not have a titlebar or window borders and will appear above other windows. It is used for example in the dropdown window of a ComboBox or a tooltip window or popup menus. This type of window does not steal focus. - - - An enum types defining extra attributes of a window. - - - - - - If this attribute is set, the window will be resizeable by the user. - - - - If this attribute is set, the underlying window manager will decide where -the window will be placed on the screen it it becomes visible for the first time. - - - - If this attribute is set, the window will be centred on the screen when -it is shown for the first time. - - - - A set of TWindowAttribute types. - - - + + +An enum types defining extra attributes of a window. + + + +If this attribute is set, the window will be resizeable by the user. + + + +If this attribute is set, the underlying window manager will decide where +the window will be placed on the screen, when it becomes visible for the first time. + + + +The window will have no border painted. This is used in windows like Tooltips, Splash screens etc. + + + +When set, this will tell the window manager to create the window in a full screen state. + + + +When set, the fpGUI framework will calculate the remaining desktop space (minus the window height), and +then position the window one third of the way down (from the top of the screen). This is usually a more +desired position than the screen center. + + + +If this attribute is set, the window will be centered on the screen when it is shown for +the first time. + + + +If set, the window will always be above all other windows. This is used for example is Splash Screen windows. + + + +A set of TWindowAttribute types. + +TWindowAttribute + + + Enum types of the available mouse cursor shapes. @@ -919,12 +937,20 @@ set to gdVertical, then it paints from top to bottom. Last modified timestamp - - - A record structure holding the RGBA values of a color. - This is the same declaration as the one found in FPImage (include with Free Pascal Compiler). In future when FPImage is integrated with fpGUI, I will remove this declaration. - - + + +A record structure holding the RGBA values of a color. +This is the same declaration as the one found in FPImage (included with the +Free Pascal Compiler). In future when FPImage is integrated with fpGUI, this declaration +will be removed. + + + +An extension of the FPC TPoint structure +

. This structure is used inside the fpGUI framework, and includes some extra methods like +calculating lengths between to points etc.

 + + Quick calculation of the length between points

Returns the sum of the absolute values of X and Y, @@ -953,7 +979,7 @@ The tradition of "Manhattan length" arises because such distances apply to travelers who can only travel on a rectangular grid, like the streets of Manhattan.

For a further explanation of "Manhattan length" see the Wikipedia article on -Taxicab geometry.

+Taxicab geometry.

 -- cgit v1.2.3-70-g09d2