Xfce Foundation Classes

Xfc::Gtk::Arrow Class Reference

A GtkArrow C++ wrapper class. More...

#include <xfc/gtk/arrow.hh>

Inheritance diagram for Xfc::Gtk::Arrow:

List of all members.

Public Member Functions

Constructors

Arrow ()
Construct an Arrow with the arrow type ARROW_RIGHT and the shadow type SHADOW_OUT.
Arrow (ArrowType arrow_type, ShadowType shadow_type)
Construct an Arrow with the specified direction and style.
virtual ~Arrow ()
Destructor.

Accessors

GtkArrow * gtk_arrow () const
Get a pointer to the GtkArrow structure.
operator GtkArrow * () const
Conversion operator; safely converts an Arrow to a GtkArrow pointer.

Methods

void set (ArrowType arrow_type, ShadowType shadow_type)
Sets the direction and style of the Arrow.

Protected Member Functions

Constructors

Arrow (GtkArrow *arrow, bool owns_reference=false)
Construct a new Arrow from an existing GtkArrow.

Detailed Description

A GtkArrow C++ wrapper class.

Arrow 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.

Arrow will fill any space alloted to it, but since it is inherited from Misc, it can be padded and/or aligned, to fill exactly the space the programmer desires. The direction or style of an arrow can be changed after creation by using set().

See also: the Arrow Widget HOWTO and example.

Constructor & Destructor Documentation

Xfc::Gtk::Arrow::Arrow ( GtkArrow * arrow,

bool owns_reference = false

) [explicit, protected]

Construct a new Arrow from an existing GtkArrow.

Parameters:

arrow A pointer to a GtkArrow.

owns_reference Set false if the initial reference count is floating, set true if it's not.

The arrow can be a newly created GtkArrow or an existing GtkArrow. (see G::Object::Object).

Xfc::Gtk::Arrow::Arrow ( ArrowType arrow_type,

ShadowType shadow_type

)

Construct an Arrow with the specified direction and style.

Parameters:

arrow_type The direction of the arrow, a valid ArrowType.

shadow_type The style of the arrow, a valid ShadowType.

Member Function Documentation

void Xfc::Gtk::Arrow::set ( ArrowType arrow_type,

ShadowType shadow_type

)

Sets the direction and style of the Arrow.

Parameters:

arrow_type The direction of the arrow, a valid ArrowType.

shadow_type The style of the arrow, a valid ShadowType.

The documentation for this class was generated from the following file:

arrow.hh

Xfce Foundation Classes

XFC 4.3