## GtkPlotFlux

GtkPlotFlux

## Synopsis

    #include <gtkextra.h>

                        GtkPlotFlux;
    GtkWidget*          gtk_plot_flux_new                   (void);
    void                gtk_plot_flux_set_arrow             (GtkPlotFlux *flux,
                                                             gint arrow_length,
                                                             gint arrow_width,
                                                             GtkPlotSymbolStyle arrow_style);
    void                gtk_plot_flux_get_arrow             (GtkPlotFlux *flux,
                                                             gint *arrow_length,
                                                             gint *arrow_width,
                                                             GtkPlotSymbolStyle *arrow_style);
    void                gtk_plot_flux_center                (GtkPlotFlux *flux,
                                                             gboolean center);
    gboolean            gtk_plot_flux_is_centered           (GtkPlotFlux *flux);
    void                gtk_plot_flux_show_scale            (GtkPlotFlux *flux,
                                                             gboolean show);
    void                gtk_plot_flux_set_scale_max         (GtkPlotFlux *flux,
                                                             gdouble scale_max);
    void                gtk_plot_flux_set_size_max          (GtkPlotFlux *flux,
                                                             guint size_max);
    void                gtk_plot_flux_set_labels_precision  (GtkPlotFlux *flux,
                                                             gint precision);
    void                gtk_plot_flux_set_labels_style      (GtkPlotFlux *flux,
                                                             GtkPlotLabelStyle style);
    void                gtk_plot_flux_set_labels_prefix     (GtkPlotFlux *flux,
                                                             const gchar *prefix);
    void                gtk_plot_flux_set_labels_suffix     (GtkPlotFlux *flux,
                                                             const gchar *suffix);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkPlotData
                               +----GtkPlotFlux

## Implemented Interfaces

GtkPlotFlux implements AtkImplementorIface and GtkBuildable.

## Properties

      "centered"                 gboolean              : Read / Write
      "labels-precision"         gint                  : Read / Write
      "labels-prefix"            gchar*                : Read / Write
      "labels-style"             gint                  : Read / Write
      "labels-suffix"            gchar*                : Read / Write
      "length"                   gint                  : Read / Write
      "scale-max"                gdouble               : Read / Write
      "show-scale"               gboolean              : Read / Write
      "size-max"                 gint                  : Read / Write
      "style"                    gint                  : Read / Write
      "width"                    gint                  : Read / Write

## Description

FIXME:: Need long description.

## Details

### GtkPlotFlux

    typedef struct _GtkPlotFlux GtkPlotFlux;

The GtkPlotFlux struct contains only private data. It should only be accessed through the functions described below.

### gtk_plot_flux_new ()

    GtkWidget*          gtk_plot_flux_new                   (void);

Returns : |

### gtk_plot_flux_set_arrow ()

    void                gtk_plot_flux_set_arrow             (GtkPlotFlux *flux,
                                                             gint arrow_length,
                                                             gint arrow_width,
                                                             GtkPlotSymbolStyle arrow_style);

`flux` : |
`arrow_length` : |
`arrow_width` : |
`arrow_style` : |

### gtk_plot_flux_get_arrow ()

    void                gtk_plot_flux_get_arrow             (GtkPlotFlux *flux,
                                                             gint *arrow_length,
                                                             gint *arrow_width,
                                                             GtkPlotSymbolStyle *arrow_style);

`flux` : |
`arrow_length` : |
`arrow_width` : |
`arrow_style` : |

### gtk_plot_flux_center ()

    void                gtk_plot_flux_center                (GtkPlotFlux *flux,
                                                             gboolean center);

`flux` : |
`center` : |

### gtk_plot_flux_is_centered ()

    gboolean            gtk_plot_flux_is_centered           (GtkPlotFlux *flux);

`flux` : |
Returns : |

### gtk_plot_flux_show_scale ()

    void                gtk_plot_flux_show_scale            (GtkPlotFlux *flux,
                                                             gboolean show);

`flux` : |
`show` : |

### gtk_plot_flux_set_scale_max ()

    void                gtk_plot_flux_set_scale_max         (GtkPlotFlux *flux,
                                                             gdouble scale_max);

`flux` : |
`scale_max` : |

### gtk_plot_flux_set_size_max ()

    void                gtk_plot_flux_set_size_max          (GtkPlotFlux *flux,
                                                             guint size_max);

`flux` : |
`size_max` : |

### gtk_plot_flux_set_labels_precision ()

    void                gtk_plot_flux_set_labels_precision  (GtkPlotFlux *flux,
                                                             gint precision);

`flux` : |
`precision` : |

### gtk_plot_flux_set_labels_style ()

    void                gtk_plot_flux_set_labels_style      (GtkPlotFlux *flux,
                                                             GtkPlotLabelStyle style);

`flux` : |
`style` : |

### gtk_plot_flux_set_labels_prefix ()

    void                gtk_plot_flux_set_labels_prefix     (GtkPlotFlux *flux,
                                                             const gchar *prefix);

`flux` : |
`prefix` : |

### gtk_plot_flux_set_labels_suffix ()

    void                gtk_plot_flux_set_labels_suffix     (GtkPlotFlux *flux,
                                                             const gchar *suffix);

`flux` : |
`suffix` : |

## Property Details

### The `"centered"` property

      "centered"                 gboolean              : Read / Write

Default value: FALSE

### The `"labels-precision"` property

      "labels-precision"         gint                  : Read / Write

Allowed values: >= 0

Default value: 0

### The `"labels-prefix"` property

      "labels-prefix"            gchar*                : Read / Write

Default value: NULL

### The `"labels-style"` property

      "labels-style"             gint                  : Read / Write

Allowed values: >= 0

Default value: 0

### The `"labels-suffix"` property

      "labels-suffix"            gchar*                : Read / Write

Default value: NULL

### The `"length"` property

      "length"                   gint                  : Read / Write

Allowed values: >= 0

Default value: 0

### The `"scale-max"` property

      "scale-max"                gdouble               : Read / Write

Allowed values: >= 0

Default value: 0

### The `"show-scale"` property

      "show-scale"               gboolean              : Read / Write

Default value: FALSE

### The `"size-max"` property

      "size-max"                 gint                  : Read / Write

Allowed values: >= 0

Default value: 0

### The `"style"` property

      "style"                    gint                  : Read / Write

Allowed values: >= 0

Default value: 0

### The `"width"` property

      "width"                    gint                  : Read / Write

Allowed values: >= 0

Default value: 0