lazarus/docs/xml/lcl/chart.xml
2008-04-22 13:31:49 +00:00

515 lines
14 KiB
XML

<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
Chart
====================================================================
-->
<module name="Chart">
<short>Classes for constructing Bar Charts</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLProc">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Controls">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="ExtCtrls">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Graphics">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Dialogs">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TBar">
<short>
<var>TBar</var> - base class for <var>TBarChartItems</var> in a <var>TBarChart</var>
<var/>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TBar.FSName">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TBar.FValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TBar.FColor">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomBarChart">
<short>
<var>TCustomBarChart</var> - base class for <var>TBarChart</var>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomBarChart.FUpdateCount">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomBarChart.FBars">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomBarChart.FDepth">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TCustomBarChart.NormalizeScaleUnits">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomBarChart.NormalizeScaleUnits.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomBarChart.NormalizeScaleUnits.OldScale">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomBarChart.Paint">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomBarChart.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomBarChart.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomBarChart.Destroy">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomBarChart.Clear">
<short>
<var>Clear</var> - remove all previous contents and start with a blank BarChart</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: public -->
<element name="TCustomBarChart.AddBar">
<short>
<var>AddBar</var> - add a bar with the specified properties (name, value and colour) to the BarChart</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomBarChart.AddBar.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomBarChart.AddBar.SName">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomBarChart.AddBar.Value">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomBarChart.AddBar.AColor">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TCustomBarChart.GetBar">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomBarChart.GetBar.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomBarChart.GetBar.SId">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TCustomBarChart.BarCount">
<short>
<var>BarCount</var> - number of bars in the chart</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomBarChart.BarCount.Result">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomBarChart.BeginUpdate">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomBarChart.EndUpdate">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomBarChart.Depth">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TBarChart">
<short>
<var>TBarChart</var> - graph in which each value is represented by the length or height of a bar</short>
<descr>
<p>
<var>TBarChart</var> - graph in which each value is represented by the length or height of a bar</p>
<p>The Bars are defined in <var>TCustomBarChart</var>
</p>
</descr>
<errors/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Alignment">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.AutoSize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BevelInner">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BevelOuter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BevelWidth">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BorderWidth">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BorderStyle">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Caption">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ClientHeight">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ClientWidth">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Color">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Constraints">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Depth">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.DragMode">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Enabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Font">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.FullRepaint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ParentColor">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ParentFont">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.TabStop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Visible">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnDblClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnDragDrop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnDragOver">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnEndDrag">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnExit">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnStartDrag">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="Register">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<element name="TBar.SName">
<short>
<var>SName</var> - the name identifying this bar in the barchart</short>
</element>
<element name="TBar.Value">
<short>The numerical <var>Value</var> or size of this bar in the barchart</short>
</element>
<element name="TBar.Color">
<short>The <var>Color</var> to be used to draw this bar in the barchart</short>
</element>
<element name="TBarChartItems">
<short>
<var>TBarChartItems</var> - the collection of items defining the bars in this barchart</short>
</element>
<element name="TBarChartItems.Create"/>
<element name="TCustomBarChart.Bars">
<short>
<var>Bars</var> - the collection of bars that comprise the BarChart</short>
</element>
<element name="TCustomBarChart.LabelPosition">
<short>
<var>LabelPosition</var> - left, centered or right</short>
</element>
</module>
<!-- Chart -->
</package>
</fpdoc-descriptions>