* Modified by the GTK+ Team and others 1997-2001. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
- * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
-#include <config.h>
+/**
+ * SECTION:gtkarrow
+ * @Short_description: Displays an arrow
+ * @Title: GtkArrow
+ * @See_also: gtk_paint_arrow()
+ *
+ * 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().
+ */
+
+#include "config.h"
#include <math.h>
#include "gtkarrow.h"
+#include "gtkprivate.h"
#include "gtkintl.h"
-#include "gtkalias.h"
#define MIN_ARROW_SIZE 15
enum {
PROP_0,
-
PROP_ARROW_TYPE,
- PROP_SHADOW_TYPE,
-
- PROP_LAST
+ PROP_SHADOW_TYPE
};
-static void gtk_arrow_class_init (GtkArrowClass *klass);
-static void gtk_arrow_init (GtkArrow *arrow);
-static gint gtk_arrow_expose (GtkWidget *widget,
- GdkEventExpose *event);
-static void gtk_arrow_set_property (GObject *object,
- guint prop_id,
- const GValue *value,
- GParamSpec *pspec);
-static void gtk_arrow_get_property (GObject *object,
- guint prop_id,
- GValue *value,
- GParamSpec *pspec);
-
-GType
-gtk_arrow_get_type (void)
-{
- static GType arrow_type = 0;
+static void gtk_arrow_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec);
+static void gtk_arrow_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec);
+static gboolean gtk_arrow_expose (GtkWidget *widget,
+ GdkEventExpose *event);
- if (!arrow_type)
- {
- static const GTypeInfo arrow_info =
- {
- sizeof (GtkArrowClass),
- NULL, /* base_init */
- NULL, /* base_finalize */
- (GClassInitFunc) gtk_arrow_class_init,
- NULL, /* class_finalize */
- NULL, /* class_data */
- sizeof (GtkArrow),
- 0, /* n_preallocs */
- (GInstanceInitFunc) gtk_arrow_init,
- };
-
- arrow_type = g_type_register_static (GTK_TYPE_MISC, "GtkArrow",
- &arrow_info, 0);
- }
- return arrow_type;
-}
+G_DEFINE_TYPE (GtkArrow, gtk_arrow, GTK_TYPE_MISC)
+
static void
gtk_arrow_class_init (GtkArrowClass *class)
gobject_class->set_property = gtk_arrow_set_property;
gobject_class->get_property = gtk_arrow_get_property;
-
+
+ widget_class->expose_event = gtk_arrow_expose;
+
g_object_class_install_property (gobject_class,
PROP_ARROW_TYPE,
g_param_spec_enum ("arrow-type",
P_("The direction the arrow should point"),
GTK_TYPE_ARROW_TYPE,
GTK_ARROW_RIGHT,
- G_PARAM_READABLE | G_PARAM_WRITABLE));
+ GTK_PARAM_READWRITE));
+
g_object_class_install_property (gobject_class,
PROP_SHADOW_TYPE,
g_param_spec_enum ("shadow-type",
P_("Appearance of the shadow surrounding the arrow"),
GTK_TYPE_SHADOW_TYPE,
GTK_SHADOW_OUT,
- G_PARAM_READABLE | G_PARAM_WRITABLE));
-
- widget_class->expose_event = gtk_arrow_expose;
+ GTK_PARAM_READWRITE));
+
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_float ("arrow-scaling",
+ P_("Arrow Scaling"),
+ P_("Amount of space used up by arrow"),
+ 0.0, 1.0, 0.7,
+ GTK_PARAM_READABLE));
}
static void
const GValue *value,
GParamSpec *pspec)
{
- GtkArrow *arrow;
-
- arrow = GTK_ARROW (object);
+ GtkArrow *arrow = GTK_ARROW (object);
switch (prop_id)
{
}
}
-
static void
gtk_arrow_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
- GtkArrow *arrow;
-
- arrow = GTK_ARROW (object);
+ GtkArrow *arrow = GTK_ARROW (object);
+
switch (prop_id)
{
case PROP_ARROW_TYPE:
static void
gtk_arrow_init (GtkArrow *arrow)
{
- GTK_WIDGET_SET_FLAGS (arrow, GTK_NO_WINDOW);
+ gtk_widget_set_has_window (GTK_WIDGET (arrow), FALSE);
GTK_WIDGET (arrow)->requisition.width = MIN_ARROW_SIZE + GTK_MISC (arrow)->xpad * 2;
GTK_WIDGET (arrow)->requisition.height = MIN_ARROW_SIZE + GTK_MISC (arrow)->ypad * 2;
arrow->shadow_type = GTK_SHADOW_OUT;
}
+/**
+ * gtk_arrow_new:
+ * @arrow_type: a valid #GtkArrowType.
+ * @shadow_type: a valid #GtkShadowType.
+ *
+ * Creates a new #GtkArrow widget.
+ *
+ * Returns: the new #GtkArrow widget.
+ */
GtkWidget*
gtk_arrow_new (GtkArrowType arrow_type,
GtkShadowType shadow_type)
return GTK_WIDGET (arrow);
}
+/**
+ * gtk_arrow_set:
+ * @arrow: a widget of type #GtkArrow.
+ * @arrow_type: a valid #GtkArrowType.
+ * @shadow_type: a valid #GtkShadowType.
+ *
+ * Sets the direction and style of the #GtkArrow, @arrow.
+ */
void
gtk_arrow_set (GtkArrow *arrow,
GtkArrowType arrow_type,
GtkShadowType shadow_type)
{
+ GtkWidget *widget;
+
g_return_if_fail (GTK_IS_ARROW (arrow));
if ( ((GtkArrowType) arrow->arrow_type != arrow_type)
if ((GtkArrowType) arrow->arrow_type != arrow_type)
{
arrow->arrow_type = arrow_type;
- g_object_notify (G_OBJECT (arrow), "arrow_type");
+ g_object_notify (G_OBJECT (arrow), "arrow-type");
}
if ((GtkShadowType) arrow->shadow_type != shadow_type)
{
arrow->shadow_type = shadow_type;
- g_object_notify (G_OBJECT (arrow), "shadow_type");
+ g_object_notify (G_OBJECT (arrow), "shadow-type");
}
g_object_thaw_notify (G_OBJECT (arrow));
- if (GTK_WIDGET_DRAWABLE (arrow))
- gtk_widget_queue_draw (GTK_WIDGET (arrow));
+ widget = GTK_WIDGET (arrow);
+ if (gtk_widget_is_drawable (widget))
+ gtk_widget_queue_draw (widget);
}
}
-static gboolean
+static gboolean
gtk_arrow_expose (GtkWidget *widget,
GdkEventExpose *event)
{
- GtkArrow *arrow;
- GtkMisc *misc;
- GtkShadowType shadow_type;
- gint width, height;
- gint x, y;
- gint extent;
- gfloat xalign;
- GtkArrowType effective_arrow_type;
-
- if (GTK_WIDGET_DRAWABLE (widget))
+ if (gtk_widget_is_drawable (widget))
{
- arrow = GTK_ARROW (widget);
- misc = GTK_MISC (widget);
+ GtkArrow *arrow = GTK_ARROW (widget);
+ GtkMisc *misc = GTK_MISC (widget);
+ GtkShadowType shadow_type;
+ gint width, height;
+ gint x, y;
+ gint extent;
+ gfloat xalign;
+ GtkArrowType effective_arrow_type;
+ gfloat arrow_scaling;
+
+ gtk_widget_style_get (widget, "arrow-scaling", &arrow_scaling, NULL);
width = widget->allocation.width - misc->xpad * 2;
height = widget->allocation.height - misc->ypad * 2;
- extent = MIN (width, height) * 0.7;
+ extent = MIN (width, height) * arrow_scaling;
effective_arrow_type = arrow->arrow_type;
if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
}
x = floor (widget->allocation.x + misc->xpad
- + ((widget->allocation.width - extent) * xalign)
- + 0.5);
- y = floor (widget->allocation.y + misc->ypad
- + ((widget->allocation.height - extent) * misc->yalign)
- + 0.5);
-
+ + ((widget->allocation.width - extent) * xalign));
+ y = floor (widget->allocation.y + misc->ypad
+ + ((widget->allocation.height - extent) * misc->yalign));
+
shadow_type = arrow->shadow_type;
if (widget->state == GTK_STATE_ACTIVE)
return FALSE;
}
-
-#define __GTK_ARROW_C__
-#include "gtkaliasdef.c"
projects / ~andy / gtk / blobdiff