gtkvscale.c 3.95 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2
 * Copyright (C) 2001 Red Hat, Inc.
Elliot Lee's avatar
Elliot Lee committed
3 4
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * 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
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardon's avatar
Javier Jardon committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16
 */
17 18

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20 21
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
22
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23 24
 */

25
#include "config.h"
26

27 28
#include <math.h>
#include <stdlib.h>
29

Elliot Lee's avatar
Elliot Lee committed
30
#include "gtkvscale.h"
31 32

#include "gtkadjustment.h"
33
#include "gtkorientable.h"
34

35
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
Elliot Lee's avatar
Elliot Lee committed
36

37 38 39 40 41 42 43 44 45
/**
 * SECTION:gtkvscale
 * @Short_description: A vertical slider widget for selecting a value from a range
 * @Title: GtkVScale
 *
 * The #GtkVScale widget is used to allow the user to select a value using
 * a vertical slider. To create one, use gtk_hscale_new_with_range().
 *
 * The position to show the current value, and the number of decimal places
46
 * shown can be set using the parent #GtkScale class’s functions.
47 48
 *
 * GtkVScale has been deprecated, use #GtkScale instead.
49
 */
50

Matthias Clasen's avatar
Matthias Clasen committed
51
G_DEFINE_TYPE (GtkVScale, gtk_vscale, GTK_TYPE_SCALE)
Elliot Lee's avatar
Elliot Lee committed
52 53 54 55

static void
gtk_vscale_class_init (GtkVScaleClass *class)
{
56
  GtkRangeClass *range_class = GTK_RANGE_CLASS (class);
57

58
  range_class->slider_detail = "vscale";
59 60
}

Elliot Lee's avatar
Elliot Lee committed
61 62 63
static void
gtk_vscale_init (GtkVScale *vscale)
{
64 65
  gtk_orientable_set_orientation (GTK_ORIENTABLE (vscale),
                                  GTK_ORIENTATION_VERTICAL);
Elliot Lee's avatar
Elliot Lee committed
66
}
67 68 69 70 71 72 73
/**
 * gtk_vscale_new:
 * @adjustment: the #GtkAdjustment which sets the range of the scale.
 *
 * Creates a new #GtkVScale.
 *
 * Returns: a new #GtkVScale.
74 75
 *
 * Deprecated: 3.2: Use gtk_scale_new() with %GTK_ORIENTATION_VERTICAL instead
76
 */
77
GtkWidget *
Elliot Lee's avatar
Elliot Lee committed
78 79
gtk_vscale_new (GtkAdjustment *adjustment)
{
80 81
  g_return_val_if_fail (adjustment == NULL || GTK_IS_ADJUSTMENT (adjustment),
                        NULL);
Elliot Lee's avatar
Elliot Lee committed
82

83 84 85 86
  return g_object_new (GTK_TYPE_VSCALE,
                       "adjustment", adjustment,
                       NULL);
}
87 88 89 90 91 92

/**
 * gtk_vscale_new_with_range:
 * @min: minimum value
 * @max: maximum value
 * @step: step increment (tick size) used with keyboard shortcuts
93
 *
94 95
 * Creates a new vertical scale widget that lets the user input a
 * number between @min and @max (including @min and @max) with the
96
 * increment @step.  @step must be nonzero; it’s the distance the
97
 * slider moves when using the arrow keys to adjust the scale value.
98 99 100 101 102
 *
 * Note that the way in which the precision is derived works best if @step
 * is a power of ten. If the resulting precision is not suitable for your
 * needs, use gtk_scale_set_digits() to correct it.
 *
103
 * Returns: a new #GtkVScale
104 105
 *
 * Deprecated: 3.2: Use gtk_scale_new_with_range() with %GTK_ORIENTATION_VERTICAL instead
106
 **/
107
GtkWidget *
108 109 110 111
gtk_vscale_new_with_range (gdouble min,
                           gdouble max,
                           gdouble step)
{
112
  GtkAdjustment *adj;
113 114 115 116 117 118
  GtkScale *scale;
  gint digits;

  g_return_val_if_fail (min < max, NULL);
  g_return_val_if_fail (step != 0.0, NULL);

119
  adj = gtk_adjustment_new (min, min, max, step, 10 * step, 0);
120

121
  if (fabs (step) >= 1.0 || step == 0.0)
Elliot Lee's avatar
Elliot Lee committed
122
    {
123
      digits = 0;
Elliot Lee's avatar
Elliot Lee committed
124
    }
125
  else
126
    {
127 128 129
      digits = abs ((gint) floor (log10 (fabs (step))));
      if (digits > 5)
        digits = 5;
130 131
    }

132 133 134 135
  scale = g_object_new (GTK_TYPE_VSCALE,
                        "adjustment", adj,
                        "digits", digits,
                        NULL);
136

137
  return GTK_WIDGET (scale);
Elliot Lee's avatar
Elliot Lee committed
138
}