GtkArrow

GtkArrow — Displays an arrow

Functions

GtkWidget * gtk_arrow_new ()
void gtk_arrow_set ()

Properties

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

Style Properties

float arrow-scaling Read

Types and Values

struct GtkArrow

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkMisc
                ╰── GtkArrow

Implemented Interfaces

GtkArrow implements AtkImplementorIface and GtkBuildable.

Includes

#include <gtk/gtk.h>

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 amended 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().

GtkArrow has been deprecated; you can simply use a GtkImage with a suitable icon name, such as “pan-down-symbolic“. When replacing GtkArrow by an image, pay attention to the fact that GtkArrow is doing automatic flipping between GTK_ARROW_LEFT and GTK_ARROW_RIGHT, depending on the text direction. To get the same effect with an image, use the icon names “pan-start-symbolic“ and “pan-end-symbolic“, which react to the text direction.

Functions

gtk_arrow_new ()

GtkWidget *
gtk_arrow_new (GtkArrowType arrow_type,
               GtkShadowType shadow_type);

gtk_arrow_new has been deprecated since version 3.14 and should not be used in newly-written code.

Use a GtkImage with a suitable icon.

Creates a new GtkArrow widget.

Parameters

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);

gtk_arrow_set has been deprecated since version 3.14 and should not be used in newly-written code.

Use a GtkImage with a suitable icon.

Sets the direction and style of the GtkArrow, arrow .

Parameters

arrow

a widget of type GtkArrow.

arrow_type

a valid GtkArrowType.

shadow_type

a valid GtkShadowType.

Types and Values

struct GtkArrow

struct GtkArrow;

Property Details

The “arrow-type” property

  “arrow-type”               GtkArrowType

The direction the arrow should point.

Owner: GtkArrow

Flags: Read / Write

Default value: GTK_ARROW_RIGHT

The “shadow-type” property

  “shadow-type”              GtkShadowType

Appearance of the shadow surrounding the arrow.

Owner: GtkArrow

Flags: Read / Write

Default value: GTK_SHADOW_OUT

Style Property Details

The “arrow-scaling” style property

  “arrow-scaling”            float

Amount of space used up by arrow.

Owner: GtkArrow

Flags: Read

Allowed values: [0,1]

Default value: 0.7

See Also

gtk_render_arrow()

© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.24/GtkArrow.html