From 5b6c00952c778612059a3de41feb2d4abb82b162 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(-) (limited to 'docs/xml') 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 From 06f4a49c32f9d33e041e3567ef314d1fae90048a Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Tue, 19 Mar 2013 22:50:30 +0000 Subject: docs: adds new docs for fpg_grid.pas unit. --- docs/fpgui-docs-project.xml | 1 + docs/xml/gui/fpg_grid.xml | 54 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 docs/xml/gui/fpg_grid.xml (limited to 'docs/xml') diff --git a/docs/fpgui-docs-project.xml b/docs/fpgui-docs-project.xml index 435281d6..c4758228 100644 --- a/docs/fpgui-docs-project.xml +++ b/docs/fpgui-docs-project.xml @@ -124,6 +124,7 @@ + diff --git a/docs/xml/gui/fpg_grid.xml b/docs/xml/gui/fpg_grid.xml new file mode 100644 index 00000000..a916a544 --- /dev/null +++ b/docs/xml/gui/fpg_grid.xml @@ -0,0 +1,54 @@ + + + + + +This unit contains higher level grid widgets +. A File Grid and a String Grid widget. + + +Enable or disable grid line painting +If enabled (the default), then grid lines are drawn around each cell. + + + +This event allows you to do custom painting of grid cells +

ARow and ACol parameters should be obvious - they point to the cell being +drawn. ARect is the boundaries of the Cell being painted. AFlags contain some +state information about the grid. eg: Has the grid got focus, has the cell got +focus etc. ADefaultDrawing is set to True by default, which means the grid +will take care of painting the cell text for you (taking into account layout +and alignment settings of each column). If you set this to False, then you +need to paint the text yourself.

+ +procedure TMainForm.StringGridDrawCell(Sender: TObject; const ARow, + ACol: Integer; const ARect: TfpgRect; const AFlags: TfpgGridDrawState; + var ADefaultDrawing: boolean); +begin + // two rows with different background color + if (ARow = 7) or (ARow = 8) then + begin + if ((gdSelected in AFlags) and (gdFocused in AFlags)) or + (gdSelected in AFlags) then + Exit; // we want select cel to be painted as normal + // If we got here, we must do some painting. The background first. + StringGrid.Canvas.Color := clOrange; + StringGrid.Canvas.FillRectangle(ARect); + // NOTE: We want the grid to take care of the drawing of the text, which + // handles text layout and alignment, so we MUST NOT set the + // ADefaultDrawing to False. If we do, we need to handle text painting + // ourselves. + end; +end; + + + + fpg_basegrid.TfpgDrawCellEvent + + + + + + + + -- cgit v1.2.3-70-g09d2 From 5f0085748a2822f5f8399ff7237507dec9a56fae Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Tue, 19 Mar 2013 22:51:27 +0000 Subject: docs: fixes or adds the encoding attribute for fpdoc XML description files. --- docs/xml/gui/fpg_colormapping.xml | 2 +- docs/xml/gui/fpg_dialogs.xml | 2 +- docs/xml/gui/fpg_form.xml | 2 +- docs/xml/gui/fpg_hyperlink.xml | 2 +- docs/xml/gui/fpg_tree.xml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/xml') diff --git a/docs/xml/gui/fpg_colormapping.xml b/docs/xml/gui/fpg_colormapping.xml index f605d782..f249aa52 100644 --- a/docs/xml/gui/fpg_colormapping.xml +++ b/docs/xml/gui/fpg_colormapping.xml @@ -1,4 +1,4 @@ - + diff --git a/docs/xml/gui/fpg_dialogs.xml b/docs/xml/gui/fpg_dialogs.xml index 98e5fd2f..ef50cac8 100644 --- a/docs/xml/gui/fpg_dialogs.xml +++ b/docs/xml/gui/fpg_dialogs.xml @@ -1,4 +1,4 @@ - + diff --git a/docs/xml/gui/fpg_form.xml b/docs/xml/gui/fpg_form.xml index 7bfdf975..6a3027b1 100644 --- a/docs/xml/gui/fpg_form.xml +++ b/docs/xml/gui/fpg_form.xml @@ -1,4 +1,4 @@ - + diff --git a/docs/xml/gui/fpg_hyperlink.xml b/docs/xml/gui/fpg_hyperlink.xml index ae59a8a9..76fdea13 100644 --- a/docs/xml/gui/fpg_hyperlink.xml +++ b/docs/xml/gui/fpg_hyperlink.xml @@ -1,4 +1,4 @@ - + diff --git a/docs/xml/gui/fpg_tree.xml b/docs/xml/gui/fpg_tree.xml index 54cbd893..601bcc46 100644 --- a/docs/xml/gui/fpg_tree.xml +++ b/docs/xml/gui/fpg_tree.xml @@ -1,4 +1,4 @@ - + -- cgit v1.2.3-70-g09d2 From f9213218940fdbf01c100fd87477791989519eeb Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Tue, 19 Mar 2013 22:57:18 +0000 Subject: docs: fixes the tags to use the full fpdoc link syntax. --- docs/xml/gui/fpg_tree.xml | 48 +++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) (limited to 'docs/xml') diff --git a/docs/xml/gui/fpg_tree.xml b/docs/xml/gui/fpg_tree.xml index 601bcc46..6a69fd64 100644 --- a/docs/xml/gui/fpg_tree.xml +++ b/docs/xml/gui/fpg_tree.xml @@ -4,7 +4,7 @@ This unit defines a tree view control -

. A tree view displays items in an indented +

. A tree view displays items in an indented outline. The control provides buttons that allow nodes to be expanded and collapsed. You can include icons with items' text labels and display different icons to indicate whether a node is expanded or collapsed.

@@ -13,7 +13,7 @@ indicate whether a node is expanded or collapsed.

Represents a window that displays a hierachy list of items -

. Examples of such hierachies can be +

. Examples of such hierachies can be the headings in a document, the entries in a index, or the files and directories on a disk.

Use TfpgTreeView to add an expanding and contracting outline to a form. Each node @@ -25,20 +25,20 @@ the user can expand or collapse the associated list of subnodes.

Collapses all the nodes within a tree view control -. Call FullCollapse to hide +. Call FullCollapse to hide all the nodes in the tree view except those at the first level. All node buttons will change from '-' to '+'. - + TfpgTreeView.FullExpand Expands all nodes within the tree view control -. Call FullExpand to display +. Call FullExpand to display all the nodes in the tree view. All node buttons will change from '+' to '-'. - + TfpgTreeView.FullCollapse @@ -52,54 +52,54 @@ all the nodes in the tree view. All node buttons will change from '+' to '-'. Return the next node after ANode -. This function will step into child +. This function will step into child nodes as well, to return the correct node. It works on the actual nodes in the tree, and not just the visible nodes in the tree. - + TfpgTreeView.PrevNode Return the previous node starting from ANode -. This function will step into child +. This function will step into child nodes as well, to insure it returns the correct node. It works on the actual nodes in the tree, and not just on the visible nodes. - + TfpgTreeView.NextNode Return the next visible node starting from ANode -. This works exactly the same +. This works exactly the same as NextNode function, but this time it only acts on nodes that are visible. - + TfpgTreeview.NextNode Return the previous visible node starting from ANode -. This works exactly the same +. This works exactly the same as PrevNode function, but this time it only acts on nodes that are visible. - + TfpgTreeview.PrevNode This gives you read access to the internal Font resource -. If you want to change the font used -in the tree view, use the FondDesc property instead. +. If you want to change the font used +in the tree view, use the FondDesc property instead. - + TfpgTreeview.FontDesc Returns the first node of the tree where all other nodes branch from -. This node is not a visible node, and +. This node is not a visible node, and is the internal node all other nodes in the tree branches from. @@ -116,31 +116,31 @@ expanded, so the tree view will trigger the OnExpand event as well.

 Refers to the image list associated with the tree view -. Use the ImageList to +. Use the ImageList to provide a customised list of bitmaps that can be displayed with the node's text. Use -the node's ImageIndex property to specify the +the node's ImageIndex property to specify the bitmap that must be painted next to the node's text. - + TfpgTreeNode.ImageIndex Identifies the pop-up menu associated with the tree view -. Assign a value to PopupMenu +. Assign a value to PopupMenu to make a popup-menu appear when the user selects the control and clicks the right mouse button. Is the default with of columns displayed in the tree view -

.

+

.

There is basic column support, but this is still very experimental. Specifies the font used for the tree view -. You can specify the font name and size +. You can specify the font name and size in the format fontname-size:attributes, or you can use any of the font aliases that has been setup. A font alias is a short name for some specific font, font size and attribute all in one. A font alias is in the format #aliasname. -- cgit v1.2.3-70-g09d2