Pileus Git - ~andy/gtk/blob - gtk/gtkvscale.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2001 Red Hat, Inc.
   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
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  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/.
  25  */
  26
  27 #include "config.h"
  28
  29 #include <math.h>
  30 #include <stdlib.h>
  31
  32 #include "gtkvscale.h"
  33 #include "gtkorientable.h"
  34
  35
  36 /**
  37  * SECTION:gtkvscale
  38  * @Short_description: A vertical slider widget for selecting a value from a range
  39  * @Title: GtkVScale
  40  *
  41  * The #GtkVScale widget is used to allow the user to select a value using
  42  * a vertical slider. To create one, use gtk_hscale_new_with_range().
  43  *
  44  * The position to show the current value, and the number of decimal places
  45  * shown can be set using the parent #GtkScale class's functions.
  46  */
  47
  48 G_DEFINE_TYPE (GtkVScale, gtk_vscale, GTK_TYPE_SCALE)
  49
  50 static void
  51 gtk_vscale_class_init (GtkVScaleClass *class)
  52 {
  53   GtkRangeClass *range_class = GTK_RANGE_CLASS (class);
  54
  55   range_class->slider_detail = "vscale";
  56 }
  57
  58 static void
  59 gtk_vscale_init (GtkVScale *vscale)
  60 {
  61   gtk_orientable_set_orientation (GTK_ORIENTABLE (vscale),
  62                                   GTK_ORIENTATION_VERTICAL);
  63 }
  64 /**
  65  * gtk_vscale_new:
  66  * @adjustment: the #GtkAdjustment which sets the range of the scale.
  67  *
  68  * Creates a new #GtkVScale.
  69  *
  70  * Returns: a new #GtkVScale.
  71  */
  72 GtkWidget *
  73 gtk_vscale_new (GtkAdjustment *adjustment)
  74 {
  75   g_return_val_if_fail (adjustment == NULL || GTK_IS_ADJUSTMENT (adjustment),
  76                         NULL);
  77
  78   return g_object_new (GTK_TYPE_VSCALE,
  79                        "adjustment", adjustment,
  80                        NULL);
  81 }
  82
  83 /**
  84  * gtk_vscale_new_with_range:
  85  * @min: minimum value
  86  * @max: maximum value
  87  * @step: step increment (tick size) used with keyboard shortcuts
  88  *
  89  * Creates a new vertical scale widget that lets the user input a
  90  * number between @min and @max (including @min and @max) with the
  91  * increment @step.  @step must be nonzero; it's the distance the
  92  * slider moves when using the arrow keys to adjust the scale value.
  93  *
  94  * Note that the way in which the precision is derived works best if @step
  95  * is a power of ten. If the resulting precision is not suitable for your
  96  * needs, use gtk_scale_set_digits() to correct it.
  97  *
  98  * Return value: a new #GtkVScale
  99  **/
 100 GtkWidget *
 101 gtk_vscale_new_with_range (gdouble min,
 102                            gdouble max,
 103                            gdouble step)
 104 {
 105   GObject *adj;
 106   GtkScale *scale;
 107   gint digits;
 108
 109   g_return_val_if_fail (min < max, NULL);
 110   g_return_val_if_fail (step != 0.0, NULL);
 111
 112   adj = gtk_adjustment_new (min, min, max, step, 10 * step, 0);
 113
 114   if (fabs (step) >= 1.0 || step == 0.0)
 115     {
 116       digits = 0;
 117     }
 118   else
 119     {
 120       digits = abs ((gint) floor (log10 (fabs (step))));
 121       if (digits > 5)
 122         digits = 5;
 123     }
 124
 125   scale = g_object_new (GTK_TYPE_VSCALE,
 126                         "adjustment", adj,
 127                         "digits", digits,
 128                         NULL);
 129
 130   return GTK_WIDGET (scale);
 131 }