From efc4be7b7323385d55dfd862f4d9be5f65f6b846 Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Tue, 19 Mar 2013 16:00:58 +0000 Subject: docs: fixes some fpdoc links by using the full path syntax. fpdoc is very buggy when it comes to cross-linking help topics. So by changing the link URL to the fully syntax, we try and help fpdoc along. This has limited success though, but every bit helps. --- docs/xml/corelib/fpg_base.xml | 65 +++++++++++++++++++---------------- docs/xml/corelib/fpg_command_intf.xml | 10 +++--- docs/xml/gui/fpg_button.xml | 14 ++++---- 3 files changed, 48 insertions(+), 41 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 @@ - + @@ -653,57 +653,61 @@ calculations and screen redraws.

Specifies the horizontal coordinate of the left edge of a component relative to its parent -

. Use the Left property to determine where the left side +

. Use the Left property to determine where the left side of the control begins or to reposition the left side of the control.

fpGUI delays acting on the Top, Left, Width and Height properties of a control until the -UpdateWindowPosition method is called. For more information on why this is so, see UpdateWindowPosition +UpdateWindowPosition method is called. For more information on why this is so, +see UpdateWindowPosition help. -TfpgWindowBase.UpdateWindowPosition +TfpgWindowBase.UpdateWindowPosition Specifies the vertical (X) coordinate of the top edge of a component relative to its parent -

. Use the Top property to determine where the top side +

. Use the Top property to determine where the top side of the control begins or to reposition the top side of the control.

fpGUI delays acting on the Top, Left, Width and Height properties of a control until the -UpdateWindowPosition method is called. For more information on why this is so, see UpdateWindowPosition +UpdateWindowPosition method is called. For more information on why this +is so, see UpdateWindowPosition help. -TfpgWindowBase.UpdateWindowPosition +TfpgWindowBase.UpdateWindowPosition Specifies the horizontal size of the control or form in pixels -

. Use the Width property +

. 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.

fpGUI delays acting on the Top, Left, Width and Height properties of a control until the -UpdateWindowPosition method is called. For more information on why this is so, see UpdateWindowPosition +UpdateWindowPosition method is called. For more information on why this is so, +see UpdateWindowPosition help. -TfpgWindowBase.UpdateWindowPosition +TfpgWindowBase.UpdateWindowPosition Specifies the vertical size of the control or form in pixels -

. Use the Height property +

. 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.

fpGUI delays acting on the Top, Left, Width and Height properties of a control until the -UpdateWindowPosition method is called. For more information on why this is so, see UpdateWindowPosition +UpdateWindowPosition method is called. For more information on why this +is so, see UpdateWindowPosition help. -TfpgWindowBase.UpdateWindowPosition +TfpgWindowBase.UpdateWindowPosition @@ -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. - + @@ -742,7 +746,7 @@ it seems that the active window is always brought to the front too. Inverts the Image - . This changes the actual + . 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 Invert. @@ -804,7 +808,7 @@ you must keep copy of the original image before you call Invert.A abstract class representing a base Interpolation filter. This is used as the base class to implement Interpolation filters like Gaussian, Sinc etc... These decendant filters are used in the -Canvas.StretchDraw function. +Canvas.StretchDraw function. Canvas.StretchDraw @@ -813,15 +817,16 @@ Gaussian, Sinc etc... These decendant filters are used in the Draws a rectangle. - - You can specify the size of the rectangle via X, Y, Width and Height parameters or via a TfpgRect parameter. + You can specify the size of the rectangle via X, Y, Width and Height parameters or via a TfpgRect parameter. Draws a line - - . 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. + . 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. @@ -849,7 +854,7 @@ returns the correct enum type detected. Converts the TfpgColor to TRGBTriple type This function converts the given TfpgColor into a TRGBTriple type. - TRGBTriple + TRGBTriple @@ -859,7 +864,7 @@ returns the correct enum type detected. This function converts the given TRGBTriple into a TfpgColor type. - TRGBTriple + TRGBTriple @@ -911,7 +916,7 @@ Right. And the Top is always smaller than the Bottom. Draws a line inside a clip rectangle -

. This procedure clips a line to the AClipRect boundaries and +

. 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. Paints a rectangle with a gradient -. If the gradient direction is +. 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. @@ -972,7 +977,7 @@ will be removed. An extension of the FPC TPoint structure -

. This structure is used inside the fpGUI framework, and includes some extra methods like +

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

 @@ -1011,7 +1016,7 @@ the streets of Manhattan.

A descendant of the FPC TComponent class -

. It adds a location where we can extend +

. It adds a location where we can extend the TComponent, without having to make changes to each and every class in fpGUI.

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.

 A numeric ID for the widget's context-sensitive help topic

HelpContext supports help systems that use numeric topic IDs. For help -systems that use topic keywords, see HelpKeyword.

-

To enable context-sensitive help for a widget, set HelpType to htContext and +systems that use topic keywords, see HelpKeyword.

+

To enable context-sensitive help for a widget, set HelpType 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 -TfpgWidget.InvokeHelp method +TfpgWidget.InvokeHelp method for more information.

 @@ -1050,7 +1055,7 @@ for more information.

Allows you to enable or disable the timer -. The timer will not function until you +. 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. 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 @@ - + This unit defines the Command design pattern interfaces used by fpGUI -

. The Command design pattern is similar to +

. The Command design pattern is similar to the TActions from Delphi or Lazarus.

 This interface represents a Command -. Currently in only defines one procedure called Execute. +. Currently in only defines one procedure called Execute. An interface that allows to Get or Set a Command -. An example of a class that implements this interface -is the TfpgBaseButton class. +. An example of a class that implements this interface +is the TfpgBaseButton class. 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 @@ - + @@ -35,23 +35,25 @@ is centred in the available horizontal space of the button. The registered name of a image to display on the button - . This is the name used when -a image resource was registered with the global fpgImages instance. + . This is the name used when +a image resource was registered with the global fpgImages instance. Concrete button class used in user interfaces to represent a push button - . This class is a descendant of TfpgBaseButton and + . This class is a +descendant of TfpgBaseButton and simply publishes various properties for runtime type information. - TfpgBaseButton + TfpgBaseButton - + + -- cgit v1.2.3-70-g09d2