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_paint_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 "gtkprivate.h"
54 #define MIN_ARROW_SIZE 15
56 struct _GtkArrowPrivate
69 static void gtk_arrow_set_property (GObject *object,
73 static void gtk_arrow_get_property (GObject *object,
77 static gboolean gtk_arrow_expose (GtkWidget *widget,
78 GdkEventExpose *event);
80 static void gtk_arrow_size_request_init (GtkSizeRequestIface *iface);
81 static void gtk_arrow_get_width (GtkSizeRequest *widget,
84 static void gtk_arrow_get_height (GtkSizeRequest *widget,
88 G_DEFINE_TYPE_WITH_CODE (GtkArrow, gtk_arrow, GTK_TYPE_MISC,
89 G_IMPLEMENT_INTERFACE (GTK_TYPE_SIZE_REQUEST,
90 gtk_arrow_size_request_init))
94 gtk_arrow_class_init (GtkArrowClass *class)
96 GObjectClass *gobject_class;
97 GtkWidgetClass *widget_class;
99 gobject_class = (GObjectClass*) class;
100 widget_class = (GtkWidgetClass*) class;
102 gobject_class->set_property = gtk_arrow_set_property;
103 gobject_class->get_property = gtk_arrow_get_property;
105 widget_class->expose_event = gtk_arrow_expose;
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_size_request_init (GtkSizeRequestIface *iface)
204 iface->get_width = gtk_arrow_get_width;
205 iface->get_height = gtk_arrow_get_height;
209 gtk_arrow_get_width (GtkSizeRequest *widget,
215 gtk_misc_get_padding (GTK_MISC (widget), &xpad, NULL);
218 *minimum_size = MIN_ARROW_SIZE + xpad * 2;
221 *natural_size = MIN_ARROW_SIZE + xpad * 2;
225 gtk_arrow_get_height (GtkSizeRequest *widget,
231 gtk_misc_get_padding (GTK_MISC (widget), NULL, &ypad);
234 *minimum_size = MIN_ARROW_SIZE + ypad * 2;
237 *natural_size = MIN_ARROW_SIZE + ypad * 2;
243 * @arrow_type: a valid #GtkArrowType.
244 * @shadow_type: a valid #GtkShadowType.
246 * Creates a new #GtkArrow widget.
248 * Returns: the new #GtkArrow widget.
251 gtk_arrow_new (GtkArrowType arrow_type,
252 GtkShadowType shadow_type)
254 GtkArrowPrivate *priv;
257 arrow = g_object_new (GTK_TYPE_ARROW, NULL);
261 priv->arrow_type = arrow_type;
262 priv->shadow_type = shadow_type;
264 return GTK_WIDGET (arrow);
269 * @arrow: a widget of type #GtkArrow.
270 * @arrow_type: a valid #GtkArrowType.
271 * @shadow_type: a valid #GtkShadowType.
273 * Sets the direction and style of the #GtkArrow, @arrow.
276 gtk_arrow_set (GtkArrow *arrow,
277 GtkArrowType arrow_type,
278 GtkShadowType shadow_type)
280 GtkArrowPrivate *priv;
283 g_return_if_fail (GTK_IS_ARROW (arrow));
287 if (priv->arrow_type != arrow_type
288 || priv->shadow_type != shadow_type)
290 g_object_freeze_notify (G_OBJECT (arrow));
292 if ((GtkArrowType) priv->arrow_type != arrow_type)
294 priv->arrow_type = arrow_type;
295 g_object_notify (G_OBJECT (arrow), "arrow-type");
298 if (priv->shadow_type != shadow_type)
300 priv->shadow_type = shadow_type;
301 g_object_notify (G_OBJECT (arrow), "shadow-type");
304 g_object_thaw_notify (G_OBJECT (arrow));
306 widget = GTK_WIDGET (arrow);
307 if (gtk_widget_is_drawable (widget))
308 gtk_widget_queue_draw (widget);
314 gtk_arrow_expose (GtkWidget *widget,
315 GdkEventExpose *event)
317 if (gtk_widget_is_drawable (widget))
319 GtkArrow *arrow = GTK_ARROW (widget);
320 GtkArrowPrivate *priv = arrow->priv;
321 GtkAllocation allocation;
322 GtkMisc *misc = GTK_MISC (widget);
323 GtkShadowType shadow_type;
329 gfloat xalign, yalign;
330 GtkArrowType effective_arrow_type;
331 gfloat arrow_scaling;
333 gtk_widget_style_get (widget, "arrow-scaling", &arrow_scaling, NULL);
335 gtk_widget_get_allocation (widget, &allocation);
336 gtk_misc_get_padding (misc, &xpad, &ypad);
337 gtk_misc_get_alignment (misc, &xalign, &yalign);
339 width = allocation.width - xpad * 2;
340 height = allocation.height - ypad * 2;
341 extent = MIN (width, height) * arrow_scaling;
342 effective_arrow_type = priv->arrow_type;
344 if (gtk_widget_get_direction (widget) != GTK_TEXT_DIR_LTR)
346 xalign = 1.0 - xalign;
347 if (priv->arrow_type == GTK_ARROW_LEFT)
348 effective_arrow_type = GTK_ARROW_RIGHT;
349 else if (priv->arrow_type == GTK_ARROW_RIGHT)
350 effective_arrow_type = GTK_ARROW_LEFT;
353 x = floor (allocation.x + xpad + ((allocation.width - extent) * xalign));
354 y = floor (allocation.y + ypad + ((allocation.height - extent) * yalign));
356 shadow_type = priv->shadow_type;
358 state = gtk_widget_get_state (widget);
360 if (state == GTK_STATE_ACTIVE)
362 if (shadow_type == GTK_SHADOW_IN)
363 shadow_type = GTK_SHADOW_OUT;
364 else if (shadow_type == GTK_SHADOW_OUT)
365 shadow_type = GTK_SHADOW_IN;
366 else if (shadow_type == GTK_SHADOW_ETCHED_IN)
367 shadow_type = GTK_SHADOW_ETCHED_OUT;
368 else if (shadow_type == GTK_SHADOW_ETCHED_OUT)
369 shadow_type = GTK_SHADOW_ETCHED_IN;
372 gtk_paint_arrow (gtk_widget_get_style (widget),
373 gtk_widget_get_window (widget),
375 &event->area, widget, "arrow",
376 effective_arrow_type, TRUE,
377 x, y, extent, extent);