Pileus Git - ~andy/gtk/blob - gtk/gtkhscale.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 "gtkhscale.h"
  33 #include "gtkorientable.h"
  34
  35
  36 /**
  37  * SECTION:gtkhscale
  38  * @Short_description: A horizontal slider widget for selecting a value from a range
  39  * @Title: GtkHScale
  40  *
  41  * The #GtkHScale widget is used to allow the user to select a value using
  42  * a horizontal 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
  49 G_DEFINE_TYPE (GtkHScale, gtk_hscale, GTK_TYPE_SCALE)
  50
  51 static void
  52 gtk_hscale_class_init (GtkHScaleClass *class)
  53 {
  54   GtkRangeClass *range_class = GTK_RANGE_CLASS (class);
  55
  56   range_class->slider_detail = "hscale";
  57 }
  58
  59 static void
  60 gtk_hscale_init (GtkHScale *hscale)
  61 {
  62   gtk_orientable_set_orientation (GTK_ORIENTABLE (hscale),
  63                                   GTK_ORIENTATION_HORIZONTAL);
  64 }
  65
  66 /**
  67  * gtk_hscale_new:
  68  * @adjustment: the #GtkAdjustment which sets the range of the scale.
  69  *
  70  * Creates a new #GtkHScale.
  71  *
  72  * Returns: a new #GtkHScale.
  73  */
  74 GtkWidget *
  75 gtk_hscale_new (GtkAdjustment *adjustment)
  76 {
  77   g_return_val_if_fail (adjustment == NULL || GTK_IS_ADJUSTMENT (adjustment),
  78                         NULL);
  79
  80   return g_object_new (GTK_TYPE_HSCALE,
  81                        "adjustment", adjustment,
  82                        NULL);
  83 }
  84
  85 /**
  86  * gtk_hscale_new_with_range:
  87  * @min: minimum value
  88  * @max: maximum value
  89  * @step: step increment (tick size) used with keyboard shortcuts
  90  *
  91  * Creates a new horizontal scale widget that lets the user input a
  92  * number between @min and @max (including @min and @max) with the
  93  * increment @step.  @step must be nonzero; it's the distance the
  94  * slider moves when using the arrow keys to adjust the scale value.
  95  *
  96  * Note that the way in which the precision is derived works best if @step
  97  * is a power of ten. If the resulting precision is not suitable for your
  98  * needs, use gtk_scale_set_digits() to correct it.
  99  *
 100  * Return value: a new #GtkHScale
 101  **/
 102 GtkWidget *
 103 gtk_hscale_new_with_range (gdouble min,
 104                            gdouble max,
 105                            gdouble step)
 106 {
 107   GtkAdjustment *adj;
 108   GtkScale *scale;
 109   gint digits;
 110
 111   g_return_val_if_fail (min < max, NULL);
 112   g_return_val_if_fail (step != 0.0, NULL);
 113
 114   adj = gtk_adjustment_new (min, min, max, step, 10 * step, 0);
 115
 116   if (fabs (step) >= 1.0 || step == 0.0)
 117     {
 118       digits = 0;
 119     }
 120   else
 121     {
 122       digits = abs ((gint) floor (log10 (fabs (step))));
 123       if (digits > 5)
 124         digits = 5;
 125     }
 126
 127   scale = g_object_new (GTK_TYPE_HSCALE,
 128                         "adjustment", adj,
 129                         "digits", digits,
 130                         NULL);
 131
 132   return GTK_WIDGET (scale);
 133 }