GtkArrow
3
GTK Library

# GtkArrow

Displays an arrow

## Synopsis

    #include <gtk/gtk.h>

                        GtkArrow;
    GtkWidget*          gtk_arrow_new                       (GtkArrowType arrow_type,
                                                             GtkShadowType shadow_type);
    void                gtk_arrow_set                       (GtkArrow *arrow,
                                                             GtkArrowType arrow_type,
                                                             GtkShadowType shadow_type);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkMisc
                               +----GtkArrow

## Implemented Interfaces

GtkArrow implements AtkImplementorIface and GtkBuildable.

## Properties

      "arrow-type"               GtkArrowType          : Read / Write
      "shadow-type"              GtkShadowType         : Read / Write

## Style Properties

      "arrow-scaling"            gfloat                : Read

## Description

GtkArrow should be used to draw simple arrows that need to point in one of the four cardinal directions (up, down, left, or right). The style of the arrow can be one of shadow in, shadow out, etched in, or etched out. Note that these directions and style types may be ammended in versions of Gtk to come.

GtkArrow will fill any space alloted to it, but since it is inherited from GtkMisc, it can be padded and/or aligned, to fill exactly the space the programmer desires.

Arrows are created with a call to `gtk_arrow_new()`. The direction or style of an arrow can be changed after creation by using `gtk_arrow_set()`.

## Details

### GtkArrow

    typedef struct _GtkArrow GtkArrow;

The GtkArrow struct containes the following fields. (These fields should be considered read-only. They should never be set by an application.)

### gtk_arrow_new ()

    GtkWidget*          gtk_arrow_new                       (GtkArrowType arrow_type,
                                                             GtkShadowType shadow_type);

Creates a new arrow widget.

`arrow_type` :

  a valid GtkArrowType.

`shadow_type` :

  a valid GtkShadowType.

Returns :

  the new GtkArrow widget.

### gtk_arrow_set ()

    void                gtk_arrow_set                       (GtkArrow *arrow,
                                                             GtkArrowType arrow_type,
                                                             GtkShadowType shadow_type);

Sets the direction and style of the GtkArrow, `arrow`.

`arrow` :

  a widget of type GtkArrow.

`arrow_type` :

  a valid GtkArrowType.

`shadow_type` :

  a valid GtkShadowType.

## Property Details

### The `"arrow-type"` property

      "arrow-type"               GtkArrowType          : Read / Write

The direction the arrow should point.

Default value: GTK_ARROW_RIGHT

### The `"shadow-type"` property

      "shadow-type"              GtkShadowType         : Read / Write

Appearance of the shadow surrounding the arrow.

Default value: GTK_SHADOW_OUT

## Style Property Details

### The `"arrow-scaling"` style property

      "arrow-scaling"            gfloat                : Read

Amount of space used up by arrow.

Allowed values: [0,1]

Default value: 0.7

## See Also

`gtk_paint_arrow()`

  the function used internally to paint the arrow.