## GtkPlotSegment

GtkPlotSegment

## Synopsis

    #include <gtkextra.h>

                        GtkPlotSegment;
    enum                GtkPlotArrow;
    GtkWidget*          gtk_plot_segment_new                (void);
    void                gtk_plot_segment_set_relative       (GtkPlotSegment *segment,
                                                             gboolean set);
    gboolean            gtk_plot_segment_relative           (GtkPlotSegment *segment);
    void                gtk_plot_segment_set_arrow          (GtkPlotSegment *segment,
                                                             gint arrow_length,
                                                             gint arrow_width,
                                                             GtkPlotSymbolStyle arrow_style);
    void                gtk_plot_segment_get_arrow          (GtkPlotSegment *segment,
                                                             gint *arrow_length,
                                                             gint *arrow_width,
                                                             GtkPlotSymbolStyle *arrow_style);
    void                gtk_plot_segment_set_arrow_mask     (GtkPlotSegment *segment,
                                                             GtkPlotArrow mask);
    guint               gtk_plot_segment_get_arrow_mask     (GtkPlotSegment *segment);
    void                gtk_plot_segment_center             (GtkPlotSegment *segment,
                                                             gboolean center);
    gboolean            gtk_plot_segment_is_centered        (GtkPlotSegment *segment);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkPlotData
                               +----GtkPlotSegment

## Implemented Interfaces

GtkPlotSegment implements AtkImplementorIface and GtkBuildable.

## Properties

      "arrow-mask"               gint                  : Read / Write
      "centered"                 gboolean              : Read / Write
      "length"                   gint                  : Read / Write
      "relative"                 gboolean              : Read / Write
      "style"                    gint                  : Read / Write
      "width"                    gint                  : Read / Write

## Description

FIXME:: need long description

## Details

### GtkPlotSegment

    typedef struct _GtkPlotSegment GtkPlotSegment;

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

### enum GtkPlotArrow

    typedef enum
    {
          GTK_PLOT_ARROW_NONE            = 0,
          GTK_PLOT_ARROW_ORIGIN          = 1 << 0,
          GTK_PLOT_ARROW_END             = 1 << 1
    } GtkPlotArrow;

### gtk_plot_segment_new ()

    GtkWidget*          gtk_plot_segment_new                (void);

Returns : |

### gtk_plot_segment_set_relative ()

    void                gtk_plot_segment_set_relative       (GtkPlotSegment *segment,
                                                             gboolean set);

`segment` : | a GtkPlotSegment widget.
`set` : |

### gtk_plot_segment_relative ()

    gboolean            gtk_plot_segment_relative           (GtkPlotSegment *segment);

`segment` : | a GtkPlotSegment widget.
Returns : |

### gtk_plot_segment_set_arrow ()

    void                gtk_plot_segment_set_arrow          (GtkPlotSegment *segment,
                                                             gint arrow_length,
                                                             gint arrow_width,
                                                             GtkPlotSymbolStyle arrow_style);

`segment` : | a GtkPlotSegment widget.
`arrow_length` : |
`arrow_width` : |
`arrow_style` : |

### gtk_plot_segment_get_arrow ()

    void                gtk_plot_segment_get_arrow          (GtkPlotSegment *segment,
                                                             gint *arrow_length,
                                                             gint *arrow_width,
                                                             GtkPlotSymbolStyle *arrow_style);

`segment` : | a GtkPlotSegment widget.
`arrow_length` : |
`arrow_width` : |
`arrow_style` : |

### gtk_plot_segment_set_arrow_mask ()

    void                gtk_plot_segment_set_arrow_mask     (GtkPlotSegment *segment,
                                                             GtkPlotArrow mask);

`segment` : | a GtkPlotSegment widget.
`mask` : |

### gtk_plot_segment_get_arrow_mask ()

    guint               gtk_plot_segment_get_arrow_mask     (GtkPlotSegment *segment);

`segment` : | a GtkPlotSegment widget.
Returns : |

### gtk_plot_segment_center ()

    void                gtk_plot_segment_center             (GtkPlotSegment *segment,
                                                             gboolean center);

`segment` : | a GtkPlotSegment widget.
`center` : |

### gtk_plot_segment_is_centered ()

    gboolean            gtk_plot_segment_is_centered        (GtkPlotSegment *segment);

`segment` : | a GtkPlotSegment widget.
Returns : |

## Property Details

### The `"arrow-mask"` property

      "arrow-mask"               gint                  : Read / Write

Allowed values: >= 0

Default value: 0

### The `"centered"` property

      "centered"                 gboolean              : Read / Write

Default value: FALSE

### The `"length"` property

      "length"                   gint                  : Read / Write

Allowed values: >= 0

Default value: 0

### The `"relative"` property

      "relative"                 gboolean              : Read / Write

Default value: FALSE

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