File: gtk-extra-plot

-----------------------------------------------------------------------

--               GtkAda - Ada95 binding for Gtk+/Gnome               --

--                                                                   --

--      Copyright (C) 2000 E. Briot, J. Brobecker and A. Charlet     --

--                Copyright (C) 2000-2006 AdaCore                    --

--                                                                   --

-- This library is free software; you can redistribute it and/or     --

-- modify it under the terms of the GNU General Public               --

-- License as published by the Free Software Foundation; either      --

-- version 2 of the License, or (at your option) any later version.  --

--                                                                   --

-- This library is distributed in the hope that it will be useful,   --

-- but WITHOUT ANY WARRANTY; without even the implied warranty of    --

-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU --

-- General Public License for more details.                          --

--                                                                   --

-- You should have received a copy of the GNU General Public         --

-- License along with this library; if not, write to the             --

-- Free Software Foundation, Inc., 59 Temple Place - Suite 330,      --

-- Boston, MA 02111-1307, USA.                                       --

--                                                                   --

-- As a special exception, if other files instantiate generics from  --

-- this unit, or you link this unit with other files to produce an   --

-- executable, this  unit  does not  by itself cause  the resulting  --

-- executable to be covered by the GNU General Public License. This  --

-- exception does not however invalidate any other reasons why the   --

-- executable file  might be covered by the  GNU Public License.     --

-----------------------------------------------------------------------

```
 
```
```
--  <description> 
```

--  This package defines the root of the plot hierarchy. It defines several

--  display strategies that can be used to show scientific data on the

--  screen (see the children for 3D, polar, bars,...)

```
-- 
```

--  All coordinates are in percent of the total size allocates for the data

--  set (ie the actual position is (x * width, y * height), where (x, y) is

--  the value stored in the data set and (width, height) its allocated screen

```
--  size. 
```
```
--  </description> 
```

--  <c_version>gtkextra 2.1.1</c_version>

```
--  <group>Plotting Data</group> 
```

--  <testgtk>create_plot_realtime.adb</testgtk>

```
 
```

with Gdk.ColorTo API doc
To spec
To body;

```
with Gdk.GCTo API doc
To spec
To body; 
```
```
with GlibTo API doc
To spec
To body; 
```

with Gtk.WidgetTo API doc
To spec
To body;

with Gtkada.TypesTo API doc
To spec
To body;

```
with Unchecked_Conversion; 
```
```
 
```

package Gtk.Extra.Plot_DataTo API doc
To spec
To body is

```
 
```

   type Plot_Label_Style is (Label_Float, Label_Exp, Label_Pow);

   --  The style of labels (floating point, or scientific notation)

   pragma Convention (C, Plot_Label_StyleTo API doc
To spec);

```
 
```

   type Plot_Scale is (Scale_Linear, Scale_Log10);

   --  Type of scale used for each axis of a graph.

   pragma Convention (C, Plot_ScaleTo API doc
To spec);

```
 
```

   type Gtk_Plot_Data_RecordTo API doc
To body is new Gtk.Widget.Gtk_Widget_RecordTo API doc
To spec
To body with private;

   type Gtk_Plot_Data is access all Gtk_Plot_Data_RecordTo API doc
To spec
To body'Class;

   --  A set of values that can be represented on the screen. There are

   --  several strategies to set the values, either explicitely in your

   --  application, or by having them automatically generated by a function.

```
 
```

   type Gtk_Plot_Marker is new Gdk.C_ProxyTo API doc
To spec;

```
 
```
```
   --  <doc_ignore> 
```

   --  The convert functions are needed to e.g. instantiate Generic_List

   --  They should not be used directly

   function Convert is new Unchecked_Conversion

     (Gtk_Plot_DataTo API doc
To spec, System.Address);

   function Convert is new Unchecked_Conversion

     (System.Address, Gtk_Plot_DataTo API doc
To spec);

```
   --  </doc_ignore> 
```
```
 
```
```
   ----------- 
```
```
   -- Types -- 
```
```
   ----------- 
```
```
 
```

   type No_Range_Gdouble_Array is array (Natural) of GdoubleTo API doc
To spec;

```
   --  An array of values. 
```

   --  This is used to represent the data values displayed in the plot.

   --  This array does not have any range information (so that it can be

   --  easily returned from a C function, without requiring an extra

   --  copy of the table). You can not use 'Range on this array.

```
 
```

   type No_Range_Gdouble_Array_Access is access all No_Range_Gdouble_ArrayTo API doc
To spec;

```
   --  An access to a flat array. 
```
```
 
```

   type Gdouble_Array_Access is access all Glib.Gdouble_ArrayTo API doc
To spec;

   --  The reason we use this type in the functions below is because

   --  gtk+-extra does not keep a copy of the arrays, but points to the one

   --  given in argument. Thus, the Ada arrays should not be allocated on the

   --  stack, or at least they should be at library level. Using this 'Access

   --  will force the compiler to do the check for us.

```
 
```
```
   type Points_Array is record 
```

      Points     : No_Range_Gdouble_Array_AccessTo API doc
To spec;

      Num_Points : GintTo API doc
To spec := 0;

```
   end record; 
```

   --  The points are indexed from 0 to Num_Points-1.

   --  Note that you can't use 'Range, 'First or 'Last on Points.

```
 
```
```
   type Plot_Connector is 
```
```
     (Connect_None, 
```
```
      --  No connection 
```
```
 
```
```
      Connect_Straight, 
```
```
      --  straight line 
```
```
 
```
```
      Connect_Spline, 
```
```
      --  spline or Bezier curve 
```
```
 
```
```
      Connect_Hv_Step, 
```
```
      --  Horizontal then vertical 
```
```
 
```
```
      Connect_Vh_Step, 
```
```
      --  Vertical then horizontal 
```
```
 
```
```
      Connect_Middle_Step 
```
```
      --  Split in the middle 
```
```
     ); 
```

   --  The type of connection between two adjacent points in a graph.

   pragma Convention (C, Plot_ConnectorTo API doc
To spec);

```
 
```
```
   type Plot_Gradient is new Integer; 
```

   --  Indicate which color components vary along the gradient

```
 
```

   Gradient_H : constant Plot_GradientTo API doc
To spec; --  Hue

   Gradient_V : constant Plot_GradientTo API doc
To spec; --  Value

   Gradient_S : constant Plot_GradientTo API doc
To spec; --  Saturation

```
 
```
```
   type Plot_Symbol_Type is 
```
```
     (Symbol_None, 
```
```
      Symbol_Square, 
```
```
      Symbol_Circle, 
```
```
      Symbol_Up_Triangle, 
```
```
      Symbol_Down_Triangle, 
```
```
      Symbol_Right_Triangle, 
```
```
      Symbol_Left_Triangle, 
```
```
      Symbol_Diamond, 
```
```
      Symbol_Plus, 
```
```
      Symbol_Cross, 
```
```
      Symbol_Star, 
```
```
      Symbol_Dot, 
```
```
      Symbol_Impulse); 
```

   --  Type of symbol used to represent the points in a graph.

   pragma Convention (C, Plot_Symbol_TypeTo API doc
To spec);

```
 
```
```
   type Plot_Symbol_Style is 
```
```
     (Symbol_Empty, 
```
```
      Symbol_Filled, 
```
```
      Symbol_Opaque); 
```

   --  Style used to draw the points in a graph.

   pragma Convention (C, Plot_Symbol_StyleTo API doc
To spec);

```
 
```
```
   type Plot_Line_Style is 
```
```
     (Line_None, 
```
```
      Line_Solid, 
```
```
      Line_Dotted, 
```
```
      Line_Dashed, 
```
```
      Line_Dot_Dash, 
```
```
      Line_Dot_Dot_Dash, 
```
```
      Line_Dot_Dash_Dash); 
```

   --  Lines used to connect two adjacent points in a graph.

   pragma Convention (C, Plot_Line_StyleTo API doc
To spec);

```
 
```

   type Plot_Angle is (Angle_0, Angle_90, Angle_180, Angle_270);

   --  Valid values for the angles of texts and titles.

   pragma Convention (C, Plot_AngleTo API doc
To spec);

```
 
```
```
   -------------------- 
```
```
   -- Plot functions -- 
```
```
   -------------------- 
```

   --  Plot functions should generate a unique Y value given a parameter.

   --  These can be used for instance to represent exactly mathematical

```
   --  functions. 
```

   --  Note that due to the C interface, the subprograms in Gtk.Extra.Plot and

   --  in this package expect functions that take a System.Address as a

   --  parameter. However, since it is much more convenient in your application

   --  to get a Gtk_Plot_Record directly, GtkAda includes a generic function

   --  that automatically does the conversion for you (see

   --  Gtk.Plot.Generic_Plot_Function).

```
 
```

   type Plot_Function is access function

```
     (Plot  : System.Address; 
```

      Set   : Gtk_Plot_DataTo API doc
To spec;

      X     : GdoubleTo API doc
To spec;

      Error : access GbooleanTo API doc
To spec) return GdoubleTo API doc
To spec;

```
   --  Function used for plotting. 
```

   --  It should return the value associated with X in its graph, and set

   --  Error to True if there was an error while calculating the value.

```
 
```

   pragma Convention (C, Plot_FunctionTo API doc
To spec);

```
 
```
```
   ------------------------- 
```
```
   -- Creating a Data set -- 
```
```
   ------------------------- 
```
```
 
```

   procedure Gtk_NewTo API doc
To body (Data : out Gtk_Plot_DataTo API doc
To spec; Func : Plot_FunctionTo API doc
To spec := null);

   --  Creates a new data set. Its values can either be generated automatically

   --  from Func, or will have to be set explicitely using the other

```
   --  subprograms in this package. 
```
```
 
```

   procedure InitializeTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body'Class; Func : Plot_FunctionTo API doc
To spec := null);

   --  Internal initialization function.

   --  See the section "Creating your own widgets" in the documentation.

```
 
```

   function Get_TypeTo API doc
To body return Gtk.Gtk_TypeTo API doc
To spec;

   --  Return the internal value associated with a Gtk_Plot_Data.

```
 
```

   procedure Set_NameTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Name : String);

   --  Set the name used internally for that dataset.

   --  This name does not appear anywhere on the screen, but it is easier to

   --  find the dataset afterward by using this name.

```
 
```
```
   procedure CloneTo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      Copy : access Gtk_Plot_Data_RecordTo API doc
To spec
To body'Class);

   --  Copy the contents of Data into Copy, which must have been allocated

```
   --  first 
```
```
 
```
```
   ------------------- 
```
```
   -- Drawing a set -- 
```
```
   ------------------- 
```

   --  Although a set is basically a list of values, it is closely associated

   --  with its representation on the screen (see the children of Gtk_Plot_Data

   --  for various possible representations).

   --  The Gtk.Extra packages are designed so that the drawing can be done

   --  either to the screen (through a Gdk adapter), to a postscript file for

   --  easy printing, or to any other media.

```
 
```

   procedure PaintTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   --  Emits the "draw_data" signal to request a redrawing of the data set.

```
 
```

   procedure UpdateTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   --  Indicates that the data has changed, and the graphical view should

```
   --  reflect this. 
```
```
 
```

   procedure Draw_PointsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; N : GintTo API doc
To spec);

   --  Draw the N last (most recent) values of the Data set on the screen.

   --  If N is greater than the actual number of values in Data, then they are

   --  all displayed. This subprogram should be used when you want to

   --  periodically update the contents of a dataset (you would then modify

   --  the number of points in the dataset with a call to Set_Numpoints, then

   --  register the new points with Set_X and Set_Y, and finally refresh the

   --  dataset with a call to Draw_Points and Gtk.Plot.Refresh).

```
 
```

   procedure Draw_SymbolTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; X, Y : GdoubleTo API doc
To spec);

   --  Draw the current symbol (see Set_Symbol) at specific coordinates on

```
   --  the screen. 
```
```
 
```
```
   ---------------- 
```
```
   -- Dimensions -- 
```
```
   ---------------- 
```

   --  The coordinates of the points to draw are specified in space. Therefore,

   --  they have multiple coordinates, each associate with a specific

```
   --  dimension. 
```

   --  The name of dimensions below must be one of "x", "y", "z", "dx", "dy",

```
   --  "dz", "a", "da". 
```

   --  "d..." are the size (precision of these points). A bigger symbol is

   --  displayed for the points whose (dx,dy) is bigger.

   --  "a" is used to specify the size of the symbols. When plotting boxes in

   --  two dimensions, "Z" is used to specify the size of the box.

```
 
```

   procedure Dimension_Set_PointsTo API doc
To body

     (Data   : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

```
      Name   : String; 
```

      Points : Gdouble_Array_AccessTo API doc
To spec);

   --  Set the coordinates of the points along one dimension

```
 
```

   procedure Set_NumpointsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Num : GintTo API doc
To spec);

   --  Set the number of points that should be expected in the graph.

   --  Note that this does not automatically resize all the internal structure,

   --  it just indicates what size the parameters to Set_X, Set_Y,... should

```
   --  have. 
```
```
 
```

   function Get_NumpointsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return GintTo API doc
To spec;

   --  Return the number of points expected in the graph.

```
 
```
```
   ------------------------- 
```
```
   -- Manipulating values -- 
```
```
   ------------------------- 
```

   --  These are older functions, kept for compatibility. They provide a

   --  somewhat simpler interface to the dimensions, but the use of dimensions

```
   --  is recommended. 
```

   --  See the comment for dimensions on the meaning of X, Y, Dx, Dy,...

```
 
```

   procedure Set_PointsTo API doc
To body

     (Data   : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      X, Y, Dx, Dy : Gdouble_Array_AccessTo API doc
To spec);

   --  Set some explicit points in the set.

   --  Note that the set must not be associated with a function, or the points

```
   --  will simply be ignored. 
```

   --  All of the arrays must have the same length, the behavior is undefined

```
   --  otherwise. 
```
```
 
```

   procedure Get_PointsTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      XTo API doc
To body    : out Points_ArrayTo API doc
To spec;

      YTo API doc
To body    : out Points_ArrayTo API doc
To spec;

      DxTo API doc
To body   : out Points_ArrayTo API doc
To spec;

      DyTo API doc
To body   : out Points_ArrayTo API doc
To spec);

   --  Return the value of the points in the set.

   --  Null-length arrays are returned if the set is associated with a

   --  function, since no explicit point has been set.

```
 
```
```
   procedure Set_XTo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; X : Gdouble_Array_AccessTo API doc
To spec);

```
   procedure Set_YTo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Y : Gdouble_Array_AccessTo API doc
To spec);

```
   procedure Set_ZTo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Z : Gdouble_Array_AccessTo API doc
To spec);

```
   procedure Set_ATo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; A : Gdouble_Array_AccessTo API doc
To spec);

   --  Set the values for one specific coordinate in the set.

   --  The array must have a length of Get_Numpoints (if GtkAda was

   --  compiled with assertions enabled, an exception will be raised if the

```
   --  length are different). 
```

   --  No copy of the array is made for efficiency reasons, thus modifying

   --  the array content later on will also modify the plot.

```
 
```

   procedure Set_A_ScaleTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; A_Scale : GdoubleTo API doc
To spec);

   function Get_A_ScaleTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return GdoubleTo API doc
To spec;

   --  Changes the scale used for the "A" coordinate

```
 
```
```
   procedure Set_DxTo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Dx : Gdouble_Array_AccessTo API doc
To spec);

```
   procedure Set_DyTo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Dy : Gdouble_Array_AccessTo API doc
To spec);

```
   procedure Set_DzTo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Dz : Gdouble_Array_AccessTo API doc
To spec);

   --  Set the precision of the points in the set. A bigger symbol is displayed

   --  for the points whose (Dx, Dy, Dz) is bigger.

   --  The array must have a length of Get_Numpoints (if GtkAda was

   --  compiled with assertions enabled, an exception will be raised if the

```
   --  length are different). 
```

   --  No copy of the array is made for efficiency reasons, thus modifying

   --  the array content later on will also modify the plot.

```
 
```
```
   procedure Set_DaTo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Da : Gdouble_Array_AccessTo API doc
To spec);

   --  Specifies the colors to use for the points.

   --  The color of the symbols is detemined using the gradient. the gradient

   --  has (min, max) values, and corresponding colors. The symbol's color is

   --  interpolated between these values using hue/saturation/value depending

```
   --  on the gradient_mask. 
```
```
 
```

   function Get_XTo API doc
To body  (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Points_ArrayTo API doc
To spec;

   function Get_YTo API doc
To body  (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Points_ArrayTo API doc
To spec;

   function Get_ZTo API doc
To body  (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Points_ArrayTo API doc
To spec;

   function Get_ATo API doc
To body  (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Points_ArrayTo API doc
To spec;

   function Get_DxTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Points_ArrayTo API doc
To spec;

   function Get_DyTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Points_ArrayTo API doc
To spec;

   function Get_DzTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Points_ArrayTo API doc
To spec;

   function Get_DaTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Points_ArrayTo API doc
To spec;

   --  Return the coordinates for the points in the set.

   --  This is a direct access to the underlying C array, thus modifying this

   --  array's contents also modifies the graph.

   --  See the corresponding Set_* functions for a definition of the

```
   --  coordinates 
```
```
 
```
```
   ------------ 
```
```
   -- Labels -- 
```
```
   ------------ 
```

   --  Each point in the data set can be associated with a label that describes

   --  it. This is only relevant for data sets where you explicitely give

   --  values, not when the values are generated by a function.

```
 
```

   procedure Set_LabelsTo API doc
To body

     (Data   : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      Labels : Gtkada.Types.Chars_Ptr_ArrayTo API doc
To spec);

   --  Set the labels associated which each point in the canvas.

   --  There must be at least Get_Numpoints elements in Labels, or the

```
   --  behavior is undefined 
```
```
 
```

   function Get_LabelsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body)

      return Gtkada.Types.Chars_Ptr_ArrayTo API doc
To spec;

   --  Return the labels associated with the points in the data set.

   --  Note that this returns a *copy* of the actual array, and thus might

```
   --  be expensive to call. 
```
```
 
```

   procedure Show_LabelsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Show : Boolean);

   --  Indicate whether the labels should be displayed next to each point in

   --  the data set. This has no effect if no labels were specified.

```
 
```

   procedure Labels_Set_AttributesTo API doc
To body

     (Data       : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

```
      Font       : String; 
```

      Height     : GintTo API doc
To spec;

      AngleTo API doc
To body      : Plot_AngleTo API doc
To spec;

      ForegroundTo API doc
To body : Gdk.Color.Gdk_ColorTo API doc
To spec
To body;

      BackgroundTo API doc
To body : Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Set the properties of the labels

```
 
```
```
   ---------------------------- 
```
```
   -- Symbols and Connectors -- 
```
```
   ---------------------------- 
```

   --  Each point that is explicitely set in the data set through the

   --  Set_X, Set_Y,... subprograms is visually associated with a symbol. There

   --  are several representations for the symbols.

```
   -- 
```

   --  All these symbols are then connected by a line, a curve or any other

   --  link. These are called connectors.

```
   -- 
```

   --  Each symbol, in addition to being connected to the next one with a

   --  connector, can also be linked to the axis X=0, Y=0 or Z=0 so that it is

   --  easier to read its coordinates. These are called errbars, and they must

```
   --  be explicitely shown. 
```
```
 
```

   procedure Set_SymbolTo API doc
To body

     (Data         : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      The_TypeTo API doc
To body     : Plot_Symbol_TypeTo API doc
To spec;

      StyleTo API doc
To body        : Plot_Symbol_StyleTo API doc
To spec;

      Size         : GintTo API doc
To spec;

      Line_Width   : GfloatTo API doc
To spec;

      ColorTo API doc
To body        : Gdk.Color.Gdk_ColorTo API doc
To spec
To body;

      Border_ColorTo API doc
To body : Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Set the visual aspect of the symbols.

```
 
```

   procedure Get_SymbolTo API doc
To body

     (Data         : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      The_TypeTo API doc
To body     : out Plot_Symbol_TypeTo API doc
To spec;

      StyleTo API doc
To body        : out Plot_Symbol_StyleTo API doc
To spec;

      Size         : out GintTo API doc
To spec;

      Line_Width   : out GintTo API doc
To spec;

      ColorTo API doc
To body        : out Gdk.Color.Gdk_ColorTo API doc
To spec
To body;

      Border_ColorTo API doc
To body : out Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Return the visual characteristics of the symbols.

```
 
```

   procedure Set_ConnectorTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; ConnectorTo API doc
To body : Plot_ConnectorTo API doc
To spec);

   --  Set the style of the connectors.

```
 
```

   function Get_ConnectorTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body)

      return Plot_ConnectorTo API doc
To spec;

   --  Return the connector style used for the data set.

```
 
```

   procedure Set_Line_AttributesTo API doc
To body

     (Data       : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      StyleTo API doc
To body      : Plot_Line_StyleTo API doc
To spec;

      Cap_StyleTo API doc
To body  : Gdk.GC.Gdk_Cap_StyleTo API doc
To spec;

      Join_StyleTo API doc
To body : Gdk.GC.Gdk_Join_StyleTo API doc
To spec;

      Width      : GfloatTo API doc
To spec;

      ColorTo API doc
To body      : Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Set the line style used for the connectors.

```
 
```

   procedure Get_Line_AttributesTo API doc
To body

     (Data       : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      StyleTo API doc
To body      : out Plot_Line_StyleTo API doc
To spec;

      Cap_StyleTo API doc
To body  : out Gdk.GC.Gdk_Cap_StyleTo API doc
To spec;

      Join_StyleTo API doc
To body : out Gdk.GC.Gdk_Join_StyleTo API doc
To spec;

      Width      : out GfloatTo API doc
To spec;

      ColorTo API doc
To body      : out Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Return the line attributes used for the connectors.

```
 
```

   procedure Set_X_AttributesTo API doc
To body

     (Data       : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      StyleTo API doc
To body      : Plot_Line_StyleTo API doc
To spec;

      Cap_StyleTo API doc
To body  : Gdk.GC.Gdk_Cap_StyleTo API doc
To spec;

      Join_StyleTo API doc
To body : Gdk.GC.Gdk_Join_StyleTo API doc
To spec;

      Width      : GfloatTo API doc
To spec;

      ColorTo API doc
To body      : Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Set the style of the lines used to connect the symbols to the X axis.

```
 
```

   procedure Set_Y_AttributesTo API doc
To body

     (Data       : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      StyleTo API doc
To body      : Plot_Line_StyleTo API doc
To spec;

      Cap_StyleTo API doc
To body  : Gdk.GC.Gdk_Cap_StyleTo API doc
To spec;

      Join_StyleTo API doc
To body : Gdk.GC.Gdk_Join_StyleTo API doc
To spec;

      Width      : GfloatTo API doc
To spec;

      ColorTo API doc
To body      : Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Set the style of the lines used to connect the symbols to the Y axis.

```
 
```

   procedure Set_Z_AttributesTo API doc
To body

     (Data       : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      StyleTo API doc
To body      : Plot_Line_StyleTo API doc
To spec;

      Cap_StyleTo API doc
To body  : Gdk.GC.Gdk_Cap_StyleTo API doc
To spec;

      Join_StyleTo API doc
To body : Gdk.GC.Gdk_Join_StyleTo API doc
To spec;

      Width      : GfloatTo API doc
To spec;

      ColorTo API doc
To body      : Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Set the style of the lines used to connect the symbols to the Z axis.

```
 
```

   procedure Show_XerrbarsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   procedure Show_YerrbarsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   procedure Show_ZerrbarsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   --  Indicate that each symbol should be connected to the various axis

```
 
```

   procedure Hide_XerrbarsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   procedure Hide_YerrbarsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   procedure Hide_ZerrbarsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   --  Indicate the the symbol should not be connected to the axis.

```
 
```

   procedure Fill_AreaTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Fill : Boolean);

   --  Indicate whether the area between two points should be filled or not.

```
 
```

   function Area_Is_FilledTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body)

```
      return Boolean; 
```

   --  Indicate whether the area between two points is filled.

```
 
```
```
   ------------- 
```
```
   -- Legends -- 
```
```
   ------------- 
```

   --  In addition to the drawing corresponding to the data set, it is possible

   --  to display a box that contains a legend. This is particulary useful when

   --  multiple data sets are displayed on the same plot.

```
 
```

   procedure Set_LegendTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Legend : String);

   --  Set the string printed in the legend for that data set.

   --  Note that an entry can exist in the legend even if there is no name

```
   --  associated with the graph. 
```
```
 
```

   procedure Show_LegendTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   --  An entry will be made in the plot's legend for that dataset.

```
 
```

   procedure Hide_LegendTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   --  No entry will appear in the plot's legend for that dataset.

```
 
```

   procedure Set_Legend_PrecisionTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Precision : GintTo API doc
To spec);

   --  Number of digits to display when the legends is associated with values,

```
   --  as is the case for gradients. 
```
```
 
```

   function Get_Legend_PrecisionTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body)

```
      return GintTo API doc
To spec; 
```

   --  Return the number of digits used for values in the legend

```
 
```
```
   --------------- 
```
```
   -- Gradients -- 
```
```
   --------------- 
```

   --  The symbols displayed in the plot can be assigned specific colors. But

   --  they can also compute their own color by picking it in a gradient,

```
   --  depending on the value. 
```
```
 
```
```
   --  See function Gtk.Plot.Gradient 
```
```
 
```

   procedure Move_GradientTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; X, Y : GdoubleTo API doc
To spec);

```
 
```

   procedure Set_Gradient_SizeTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Size : GintTo API doc
To spec);

```
 
```

   procedure Reset_GradientTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   --  Reset the gradient to its default value

```
 
```

   procedure Reset_Gradient_ColorsTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   --  Reset the colors of the gradient to their default values

```
 
```

   procedure Gradient_Use_Custom_ColorsTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Custom : Boolean);

   function Gradient_Custom_ColorsTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Boolean;

   --  Whether the gradient uses custom colors

```
 
```

   procedure Set_Gradient_MaskTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Mask : Plot_GradientTo API doc
To spec);

   function Get_Gradient_MaskTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Plot_GradientTo API doc
To spec;

   --  Set or Get how the component of the colors vary along the gradient.

```
 
```

   procedure Gradient_Set_VisibleTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Visible : Boolean);

   function Gradient_VisibleTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Boolean;

   --  Set or get whether the gradient is currently visible (this looks like a

```
   --  legend for the plot) 
```
```
 
```

   procedure Gradient_Autoscale_ATo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   procedure Gradient_Autoscale_DaTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   procedure Gradient_Autoscale_ZTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

```
   --  ??? 
```
```
 
```

   procedure Set_Gradient_ColorsTo API doc
To body

     (Data     : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      MinTo API doc
To body, MaxTo API doc
To body : Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   procedure Get_Gradient_ColorsTo API doc
To body

     (Data     : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      MinTo API doc
To body, MaxTo API doc
To body : out Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Set or Get the colors that define the gradient. The colors will vary

   --  from Min to Max along the components specified in Set_Gradient_Mask.

```
 
```

   procedure Set_Gradient_Nth_ColorTo API doc
To body

     (Data  : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

```
      Level : GuintTo API doc
To spec; 
```

      ColorTo API doc
To body : Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   function Get_Gradient_Nth_ColorTo API doc
To body

     (Data  : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Level : GuintTo API doc
To spec)

      return Gdk.Color.Gdk_ColorTo API doc
To spec
To body;

   --  Set or Get the nth color in the gradient

```
 
```

   procedure Set_Gradient_Outer_ColorsTo API doc
To body

     (Data     : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      MinTo API doc
To body, MaxTo API doc
To body : Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   procedure Get_Gradient_Outer_ColorsTo API doc
To body

     (Data     : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      MinTo API doc
To body, MaxTo API doc
To body : out Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Set the outer colors for the gradient

```
 
```

   procedure Set_GradientTo API doc
To body

     (Data       : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      Min, Max   : GdoubleTo API doc
To spec;

      Nlevels    : GintTo API doc
To spec;

      Nsublevels : GintTo API doc
To spec);

   procedure Get_GradientTo API doc
To body

     (Data       : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      Min, Max   : out GdoubleTo API doc
To spec;

      Nlevels    : out GintTo API doc
To spec;

      Nsublevels : out GintTo API doc
To spec);

   --  Define the values associated with the minimal color and the maximal

   --  color. Any value in between will have a color computed in between.

   --  Nlevels is the number of ticks to display in the gradient.

```
 
```

   procedure Get_Gradient_LevelTo API doc
To body

     (Data  : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      Level : GdoubleTo API doc
To spec;

      ColorTo API doc
To body : out Gdk.Color.Gdk_ColorTo API doc
To spec
To body);

   --  Return the color associated with a specific level.

   --  The color depends on the parameters to Set_Gradient and

```
   --  Set_Gradient_Colors. 
```
```
 
```

   procedure Gradient_Set_StyleTo API doc
To body

     (Data      : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      StyleTo API doc
To body     : Plot_Label_StyleTo API doc
To spec;

      Precision : GintTo API doc
To spec);

```
   --  ??? 
```
```
 
```

   procedure Gradient_Set_ScaleTo API doc
To body

     (Data      : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

      ScaleTo API doc
To body     : Plot_ScaleTo API doc
To spec);

```
   --  Set the scale of the gradient 
```
```
 
```
```
   ------------- 
```
```
   -- Markers -- 
```
```
   ------------- 
```
```
 
```

   function Add_MarkerTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Point : GuintTo API doc
To spec)

      return Gtk_Plot_MarkerTo API doc
To spec;

```
   --  Add a new marker 
```
```
 
```

   procedure Remove_MarkerTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Marker : Gtk_Plot_MarkerTo API doc
To spec);

```
   --  Remove a marker from the plot 
```
```
 
```

   procedure Remove_MarkersTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

```
   --  Remove all markers 
```
```
 
```

   procedure Show_MarkersTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body; Show : Boolean);

```
   --  Whether markers should be shown 
```
```
 
```

   function Markers_VisibleTo API doc
To body

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body) return Boolean;

   --  Whether markers are currently visible

```
 
```
```
   --------------- 
```
```
   -- User Data -- 
```
```
   --------------- 
```

   --  It is possible to associated your own user data with a plot. This is

   --  the mechanism provided by the C version of gtkextra. However, the best

   --  way to do this in Ada is to inherit from Gtk_Plot_Data_Record (or one

   --  of its children), and add your own fields.

```
 
```
```
   procedure Set_LinkTo API doc
To body 
```

     (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body;

```
      Link : System.Address); 
```

   --  Associate some user data with Data.

   --  It is the responsability of the user to do some convert conversion to

```
   --  System.Address. 
```
```
 
```

   function Get_LinkTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body)

```
      return System.Address; 
```

   --  Return the user data associated with Data, or Null_Address if there is

```
   --  none. 
```
```
 
```

   procedure Remove_LinkTo API doc
To body (Data : access Gtk_Plot_Data_RecordTo API doc
To spec
To body);

   --  Remove the user data associated with Data.

```
 
```
```
   --  <doc_ignore> 
```

   function To_Double_Array is new Unchecked_Conversion

     (System.Address, No_Range_Gdouble_Array_AccessTo API doc
To spec);

```
   --  </doc_ignore> 
```
```
 
```
```
private 
```

   type Gtk_Plot_Data_RecordTo API doc
To spec is new Gtk.Widget.Gtk_Widget_RecordTo API doc
To spec
To body with

```
     null record; 
```
```
 
```

   Gradient_HTo API doc
To spec : constant Plot_GradientTo API doc
To spec := 1;

   Gradient_VTo API doc
To spec : constant Plot_GradientTo API doc
To spec := 2;

   Gradient_STo API doc
To spec : constant Plot_GradientTo API doc
To spec := 4;

```
 
```
```
   for Plot_AngleTo API doc
To spec use 
```
```
     (Angle_0   => 0, 
```
```
      Angle_90  => 90, 
```
```
      Angle_180 => 180, 
```
```
      Angle_270 => 270); 
```
```
 
```

   pragma Import (C, Get_TypeTo API doc
To spec, "gtk_plot_data_get_type");

end Gtk.Extra.Plot_DataTo API doc
To spec
To body;

```
 
```
```
--  Unbound: 
```
```
--    gtk_plot_data_new_iterator 
```
```
--    gtk_plot_data_clone 
```

--    gtk_plot_data_get_gradient_outer_colors

```
--    gtk_plot_data_add_dimension 
```
```
--    gtk_plot_data_remove_dimension 
```
```
--    gtk_plot_data_find_dimension 
```

--    gtk_plot_data_required_dimensions

--    gtk_plot_data_independent_dimensions

--    gtk_plot_data_dimension_set_array

--    gtk_plot_data_dimension_get_array

```
--    gtk_plot_data_get_point 
```
```
--    gtk_plot_get_gradient_allocation 
```

--  These subprograms appear in gtkplotdata.h, but not in gtkplotdata.c

--    gtk_plot_data_dimension_set_scale

--    gtk_plot_data_dimension_get_scale

Documentation