1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2001. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 * @Short_description: Displays an arrow
31 * @See_also: gtk_render_arrow()
33 * GtkArrow should be used to draw simple arrows that need to point in
34 * one of the four cardinal directions (up, down, left, or right). The
35 * style of the arrow can be one of shadow in, shadow out, etched in, or
36 * etched out. Note that these directions and style types may be
37 * ammended in versions of GTK+ to come.
39 * GtkArrow will fill any space alloted to it, but since it is inherited
40 * from #GtkMisc, it can be padded and/or aligned, to fill exactly the
41 * space the programmer desires.
43 * Arrows are created with a call to gtk_arrow_new(). The direction or
44 * style of an arrow can be changed after creation by using gtk_arrow_set().
50 #include "gtksizerequest.h"
51 #include "gtktypeutils.h"
52 #include "gtkprivate.h"
55 #define MIN_ARROW_SIZE 15
57 struct _GtkArrowPrivate
70 static void gtk_arrow_set_property (GObject *object,
74 static void gtk_arrow_get_property (GObject *object,
78 static gboolean gtk_arrow_draw (GtkWidget *widget,
81 static void gtk_arrow_get_preferred_width (GtkWidget *widget,
84 static void gtk_arrow_get_preferred_height (GtkWidget *widget,
88 G_DEFINE_TYPE (GtkArrow, gtk_arrow, GTK_TYPE_MISC)
92 gtk_arrow_class_init (GtkArrowClass *class)
94 GObjectClass *gobject_class;
95 GtkWidgetClass *widget_class;
97 gobject_class = (GObjectClass*) class;
98 widget_class = (GtkWidgetClass*) class;
100 gobject_class->set_property = gtk_arrow_set_property;
101 gobject_class->get_property = gtk_arrow_get_property;
103 widget_class->draw = gtk_arrow_draw;
104 widget_class->get_preferred_width = gtk_arrow_get_preferred_width;
105 widget_class->get_preferred_height = gtk_arrow_get_preferred_height;
107 g_object_class_install_property (gobject_class,
109 g_param_spec_enum ("arrow-type",
110 P_("Arrow direction"),
111 P_("The direction the arrow should point"),
114 GTK_PARAM_READWRITE));
116 g_object_class_install_property (gobject_class,
118 g_param_spec_enum ("shadow-type",
120 P_("Appearance of the shadow surrounding the arrow"),
121 GTK_TYPE_SHADOW_TYPE,
123 GTK_PARAM_READWRITE));
125 gtk_widget_class_install_style_property (widget_class,
126 g_param_spec_float ("arrow-scaling",
128 P_("Amount of space used up by arrow"),
130 GTK_PARAM_READABLE));
132 g_type_class_add_private (class, sizeof (GtkArrowPrivate));
136 gtk_arrow_set_property (GObject *object,
141 GtkArrow *arrow = GTK_ARROW (object);
142 GtkArrowPrivate *priv = arrow->priv;
146 case PROP_ARROW_TYPE:
147 gtk_arrow_set (arrow,
148 g_value_get_enum (value),
151 case PROP_SHADOW_TYPE:
152 gtk_arrow_set (arrow,
154 g_value_get_enum (value));
157 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
163 gtk_arrow_get_property (GObject *object,
168 GtkArrow *arrow = GTK_ARROW (object);
169 GtkArrowPrivate *priv = arrow->priv;
173 case PROP_ARROW_TYPE:
174 g_value_set_enum (value, priv->arrow_type);
176 case PROP_SHADOW_TYPE:
177 g_value_set_enum (value, priv->shadow_type);
180 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
186 gtk_arrow_init (GtkArrow *arrow)
188 GtkArrowPrivate *priv;
190 arrow->priv = G_TYPE_INSTANCE_GET_PRIVATE (arrow,
195 gtk_widget_set_has_window (GTK_WIDGET (arrow), FALSE);
197 priv->arrow_type = GTK_ARROW_RIGHT;
198 priv->shadow_type = GTK_SHADOW_OUT;
202 gtk_arrow_get_preferred_width (GtkWidget *widget,
208 gtk_misc_get_padding (GTK_MISC (widget), &xpad, NULL);
211 *minimum_size = MIN_ARROW_SIZE + xpad * 2;
214 *natural_size = MIN_ARROW_SIZE + xpad * 2;
218 gtk_arrow_get_preferred_height (GtkWidget *widget,
224 gtk_misc_get_padding (GTK_MISC (widget), NULL, &ypad);
227 *minimum_size = MIN_ARROW_SIZE + ypad * 2;
230 *natural_size = MIN_ARROW_SIZE + ypad * 2;
236 * @arrow_type: a valid #GtkArrowType.
237 * @shadow_type: a valid #GtkShadowType.
239 * Creates a new #GtkArrow widget.
241 * Returns: the new #GtkArrow widget.
244 gtk_arrow_new (GtkArrowType arrow_type,
245 GtkShadowType shadow_type)
247 GtkArrowPrivate *priv;
250 arrow = g_object_new (GTK_TYPE_ARROW, NULL);
254 priv->arrow_type = arrow_type;
255 priv->shadow_type = shadow_type;
257 return GTK_WIDGET (arrow);
262 * @arrow: a widget of type #GtkArrow.
263 * @arrow_type: a valid #GtkArrowType.
264 * @shadow_type: a valid #GtkShadowType.
266 * Sets the direction and style of the #GtkArrow, @arrow.
269 gtk_arrow_set (GtkArrow *arrow,
270 GtkArrowType arrow_type,
271 GtkShadowType shadow_type)
273 GtkArrowPrivate *priv;
276 g_return_if_fail (GTK_IS_ARROW (arrow));
280 if (priv->arrow_type != arrow_type
281 || priv->shadow_type != shadow_type)
283 g_object_freeze_notify (G_OBJECT (arrow));
285 if ((GtkArrowType) priv->arrow_type != arrow_type)
287 priv->arrow_type = arrow_type;
288 g_object_notify (G_OBJECT (arrow), "arrow-type");
291 if (priv->shadow_type != shadow_type)
293 priv->shadow_type = shadow_type;
294 g_object_notify (G_OBJECT (arrow), "shadow-type");
297 g_object_thaw_notify (G_OBJECT (arrow));
299 widget = GTK_WIDGET (arrow);
300 if (gtk_widget_is_drawable (widget))
301 gtk_widget_queue_draw (widget);
307 gtk_arrow_draw (GtkWidget *widget,
310 GtkArrow *arrow = GTK_ARROW (widget);
311 GtkArrowPrivate *priv = arrow->priv;
312 GtkMisc *misc = GTK_MISC (widget);
313 GtkStyleContext *context;
315 gint x, y, width, height;
318 gfloat xalign, yalign;
319 GtkArrowType effective_arrow_type;
320 gfloat arrow_scaling;
323 if (priv->arrow_type == GTK_ARROW_NONE)
326 context = gtk_widget_get_style_context (widget);
327 gtk_widget_style_get (widget, "arrow-scaling", &arrow_scaling, NULL);
329 gtk_misc_get_padding (misc, &xpad, &ypad);
330 gtk_misc_get_alignment (misc, &xalign, &yalign);
332 width = gtk_widget_get_allocated_width (widget);
333 height = gtk_widget_get_allocated_height (widget);
335 extent = MIN (width - 2 * xpad, height - 2 * ypad) * arrow_scaling;
336 effective_arrow_type = priv->arrow_type;
338 if (gtk_widget_get_direction (widget) != GTK_TEXT_DIR_LTR)
340 xalign = 1.0 - xalign;
341 if (priv->arrow_type == GTK_ARROW_LEFT)
342 effective_arrow_type = GTK_ARROW_RIGHT;
343 else if (priv->arrow_type == GTK_ARROW_RIGHT)
344 effective_arrow_type = GTK_ARROW_LEFT;
347 x = floor (xpad + ((width - extent) * xalign));
348 y = floor (ypad + ((height - extent) * yalign));
350 switch (effective_arrow_type)
355 case GTK_ARROW_RIGHT:
363 angle = (3 * G_PI) / 2;
367 gtk_style_context_save (context);
369 state = gtk_widget_get_state_flags (widget);
370 gtk_style_context_set_state (context, state);
371 gtk_render_arrow (context, cr, angle, x, y, extent);
373 gtk_style_context_restore (context);