1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
/* CTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * Modified by the CTK+ Team and others 1997-2001.  See the AUTHORS
 * file for a list of people on the CTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * CTK+ at ftp://ftp.ctk.org/pub/ctk/.
 */

/**
 * SECTION:ctkarrow
 * @Short_description: Displays an arrow
 * @Title: CtkArrow
 * @See_also: ctk_render_arrow()
 *
 * CtkArrow 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 CTK+ to come.
 *
 * CtkArrow will fill any space alloted to it, but since it is inherited
 * from #CtkMisc, it can be padded and/or aligned, to fill exactly the
 * space the programmer desires.
 *
 * Arrows are created with a call to ctk_arrow_new().  The direction or
 * style of an arrow can be changed after creation by using ctk_arrow_set().
 *
 * CtkArrow has been deprecated; you can simply use a #CtkImage with a
 * suitable icon name, such as “pan-down-symbolic“. When replacing 
 * CtkArrow by an image, pay attention to the fact that CtkArrow is
 * doing automatic flipping between #CTK_ARROW_LEFT and #CTK_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.
 */

#include "config.h"
#include <math.h>
#include "ctkarrow.h"
#include "ctksizerequest.h"
#include "ctktypebuiltins.h"
#include "ctkprivate.h"
#include "ctkintl.h"

#include "a11y/ctkarrowaccessible.h"

G_GNUC_BEGIN_IGNORE_DEPRECATIONS

#define MIN_ARROW_SIZE  15

struct _CtkArrowPrivate
{
  gint16 arrow_type;
  gint16 shadow_type;
};

enum {
  PROP_0,
  PROP_ARROW_TYPE,
  PROP_SHADOW_TYPE
};


static void     ctk_arrow_set_property (GObject        *object,
                                        guint           prop_id,
                                        const GValue   *value,
                                        GParamSpec     *pspec);
static void     ctk_arrow_get_property (GObject        *object,
                                        guint           prop_id,
                                        GValue         *value,
                                        GParamSpec     *pspec);
static gboolean ctk_arrow_draw         (CtkWidget      *widget,
                                        cairo_t        *cr);

static void     ctk_arrow_get_preferred_width         (CtkWidget           *widget,
                                                       gint                *minimum_size,
                                                       gint                *natural_size);
static void     ctk_arrow_get_preferred_height        (CtkWidget           *widget,
                                                       gint                *minimum_size,
                                                       gint                *natural_size);

G_GNUC_BEGIN_IGNORE_DEPRECATIONS
G_DEFINE_TYPE_WITH_PRIVATE (CtkArrow, ctk_arrow, CTK_TYPE_MISC)
G_GNUC_END_IGNORE_DEPRECATIONS

static void
ctk_arrow_class_init (CtkArrowClass *class)
{
  GObjectClass *gobject_class;
  CtkWidgetClass *widget_class;

  gobject_class = (GObjectClass*) class;
  widget_class = (CtkWidgetClass*) class;

  gobject_class->set_property = ctk_arrow_set_property;
  gobject_class->get_property = ctk_arrow_get_property;

  widget_class->draw = ctk_arrow_draw;
  widget_class->get_preferred_width  = ctk_arrow_get_preferred_width;
  widget_class->get_preferred_height = ctk_arrow_get_preferred_height;

  g_object_class_install_property (gobject_class,
                                   PROP_ARROW_TYPE,
                                   g_param_spec_enum ("arrow-type",
                                                      P_("Arrow direction"),
                                                      P_("The direction the arrow should point"),
						      CTK_TYPE_ARROW_TYPE,
						      CTK_ARROW_RIGHT,
                                                      CTK_PARAM_READWRITE));

  g_object_class_install_property (gobject_class,
                                   PROP_SHADOW_TYPE,
                                   g_param_spec_enum ("shadow-type",
                                                      P_("Arrow shadow"),
                                                      P_("Appearance of the shadow surrounding the arrow"),
						      CTK_TYPE_SHADOW_TYPE,
						      CTK_SHADOW_OUT,
                                                      CTK_PARAM_READWRITE));

  ctk_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,
                                                               CTK_PARAM_READABLE));

  ctk_widget_class_set_accessible_type (widget_class, CTK_TYPE_ARROW_ACCESSIBLE);
}

static void
ctk_arrow_set_property (GObject         *object,
			guint            prop_id,
			const GValue    *value,
			GParamSpec      *pspec)
{
  CtkArrow *arrow = CTK_ARROW (object);
  CtkArrowPrivate *priv = arrow->priv;

  switch (prop_id)
    {
    case PROP_ARROW_TYPE:
      ctk_arrow_set (arrow,
		     g_value_get_enum (value),
		     priv->shadow_type);
      break;
    case PROP_SHADOW_TYPE:
      ctk_arrow_set (arrow,
		     priv->arrow_type,
		     g_value_get_enum (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
ctk_arrow_get_property (GObject         *object,
			guint            prop_id,
			GValue          *value,
			GParamSpec      *pspec)
{
  CtkArrow *arrow = CTK_ARROW (object);
  CtkArrowPrivate *priv = arrow->priv;

  switch (prop_id)
    {
    case PROP_ARROW_TYPE:
      g_value_set_enum (value, priv->arrow_type);
      break;
    case PROP_SHADOW_TYPE:
      g_value_set_enum (value, priv->shadow_type);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
ctk_arrow_init (CtkArrow *arrow)
{
  arrow->priv = ctk_arrow_get_instance_private (arrow);

  ctk_widget_set_has_window (CTK_WIDGET (arrow), FALSE);

  arrow->priv->arrow_type = CTK_ARROW_RIGHT;
  arrow->priv->shadow_type = CTK_SHADOW_OUT;
}

static void
ctk_arrow_get_preferred_width (CtkWidget *widget,
                               gint      *minimum_size,<--- Shadowed declaration
                               gint      *natural_size)
{
  CtkBorder border;

G_GNUC_BEGIN_IGNORE_DEPRECATIONS
  _ctk_misc_get_padding_and_border (CTK_MISC (widget), &border);<--- Variable '_ctk_misc_get_padding_and_border' is assigned a value that is never used.
G_GNUC_END_IGNORE_DEPRECATIONS

  *minimum_size = MIN_ARROW_SIZE + border.left + border.right;<--- Shadow variable<--- Variable 'minimum_size' can be declared as pointer to const<--- Variable 'minimum_size' is assigned a value that is never used.
  *natural_size = MIN_ARROW_SIZE + border.left + border.right;
}

static void
ctk_arrow_get_preferred_height (CtkWidget *widget,
                                gint      *minimum_size,<--- Shadowed declaration
                                gint      *natural_size)
{
  CtkBorder border;

G_GNUC_BEGIN_IGNORE_DEPRECATIONS
  _ctk_misc_get_padding_and_border (CTK_MISC (widget), &border);<--- Variable '_ctk_misc_get_padding_and_border' is assigned a value that is never used.
G_GNUC_END_IGNORE_DEPRECATIONS

  *minimum_size = MIN_ARROW_SIZE + border.top + border.bottom;<--- Shadow variable<--- Variable 'minimum_size' can be declared as pointer to const<--- Variable 'minimum_size' is assigned a value that is never used.
  *natural_size = MIN_ARROW_SIZE + border.top + border.bottom;
}

/**
 * ctk_arrow_new:
 * @arrow_type: a valid #CtkArrowType.
 * @shadow_type: a valid #CtkShadowType.
 *
 * Creates a new #CtkArrow widget.
 *
 * Returns: the new #CtkArrow widget.
 *
 * Deprecated: 3.14: Use a #CtkImage with a suitable icon.
 */
CtkWidget*
ctk_arrow_new (CtkArrowType  arrow_type,
	       CtkShadowType shadow_type)
{
  CtkArrowPrivate *priv;
  CtkArrow *arrow;

  arrow = g_object_new (CTK_TYPE_ARROW, NULL);

  priv = arrow->priv;

  priv->arrow_type = arrow_type;
  priv->shadow_type = shadow_type;

  return CTK_WIDGET (arrow);
}

/**
 * ctk_arrow_set:
 * @arrow: a widget of type #CtkArrow.
 * @arrow_type: a valid #CtkArrowType.
 * @shadow_type: a valid #CtkShadowType.
 *
 * Sets the direction and style of the #CtkArrow, @arrow.
 *
 * Deprecated: 3.14: Use a #CtkImage with a suitable icon.
 */
void
ctk_arrow_set (CtkArrow      *arrow,
	       CtkArrowType   arrow_type,
	       CtkShadowType  shadow_type)
{
  CtkArrowPrivate *priv;

  g_return_if_fail (CTK_IS_ARROW (arrow));

  priv = arrow->priv;

  if (priv->arrow_type != arrow_type
      || priv->shadow_type != shadow_type)
    {
      CtkWidget *widget;

      g_object_freeze_notify (G_OBJECT (arrow));

      if ((CtkArrowType) priv->arrow_type != arrow_type)
        {
          priv->arrow_type = arrow_type;
          g_object_notify (G_OBJECT (arrow), "arrow-type");
        }

      if (priv->shadow_type != shadow_type)
        {
          priv->shadow_type = shadow_type;
          g_object_notify (G_OBJECT (arrow), "shadow-type");
        }

      g_object_thaw_notify (G_OBJECT (arrow));

      widget = CTK_WIDGET (arrow);
      if (ctk_widget_is_drawable (widget))
        ctk_widget_queue_draw (widget);
    }
}

static gboolean
ctk_arrow_draw (CtkWidget *widget,
                cairo_t   *cr)
{
  CtkArrow *arrow = CTK_ARROW (widget);
  CtkArrowPrivate *priv = arrow->priv;<--- Variable 'priv' can be declared as pointer to const
  CtkStyleContext *context;
  gdouble x, y;
  gint width, height;<--- Unused variable: width
  gint extent;
  CtkBorder border;
  gfloat xalign, yalign;
  CtkArrowType effective_arrow_type;
  gfloat arrow_scaling;
  gdouble angle;

  if (priv->arrow_type == CTK_ARROW_NONE)
    return FALSE;

  context = ctk_widget_get_style_context (widget);
  ctk_widget_style_get (widget, "arrow-scaling", &arrow_scaling, NULL);

G_GNUC_BEGIN_IGNORE_DEPRECATIONS
  _ctk_misc_get_padding_and_border (CTK_MISC (widget), &border);
  ctk_misc_get_alignment (CTK_MISC (widget), &xalign, &yalign);
G_GNUC_END_IGNORE_DEPRECATIONS

  width = ctk_widget_get_allocated_width (widget) - border.left - border.right;
  height = ctk_widget_get_allocated_height (widget) - border.top - border.bottom;

  extent = MIN (width, height) * arrow_scaling;
  effective_arrow_type = priv->arrow_type;

  if (ctk_widget_get_direction (widget) != CTK_TEXT_DIR_LTR)
    {
      xalign = 1.0 - xalign;
      if (priv->arrow_type == CTK_ARROW_LEFT)
        effective_arrow_type = CTK_ARROW_RIGHT;
      else if (priv->arrow_type == CTK_ARROW_RIGHT)
        effective_arrow_type = CTK_ARROW_LEFT;
    }

  x = border.left + ((width - extent) * xalign);
  y = border.top + ((height - extent) * yalign);

  switch (effective_arrow_type)
    {
    case CTK_ARROW_UP:
      angle = 0;
      break;
    case CTK_ARROW_RIGHT:
      angle = G_PI / 2;
      break;
    case CTK_ARROW_DOWN:
      angle = G_PI;
      break;
    case CTK_ARROW_LEFT:
    default:
      angle = (3 * G_PI) / 2;
      break;
    }

  ctk_render_arrow (context, cr, angle, x, y, extent);

  return FALSE;
}