gtkvscrollbar.c 2.59 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3
 * Copyright (C) 2001 Red Hat, Inc.
Elliot Lee's avatar
Elliot Lee committed
4 5
 *
 * This library is free software; you can redistribute it and/or
6
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
7 8 9 10 11 12
 * 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
13
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
14
 *
15
 * You should have received a copy of the GNU Lesser General Public
16 17 18
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
19
 */
20 21

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

28
#include "config.h"
29 30

#include "gtkorientable.h"
Elliot Lee's avatar
Elliot Lee committed
31
#include "gtkvscrollbar.h"
Alexander Larsson's avatar
Alexander Larsson committed
32
#include "gtkintl.h"
33

Elliot Lee's avatar
Elliot Lee committed
34

35 36 37 38 39 40 41 42 43 44 45 46 47 48
/**
 * SECTION:gtkvscrollbar
 * @Short_description: A vertical scrollbar
 * @Title: GtkVScrollbar
 * @See_also:#GtkScrollbar, #GtkScrolledWindow
 *
 * The #GtkVScrollbar widget is a widget arranged vertically creating a
 * scrollbar. See #GtkScrollbar for details on
 * scrollbars. #GtkAdjustment pointers may be added to handle the
 * adjustment of the scrollbar or it may be left %NULL in which case one
 * will be created for you. See #GtkScrollbar for a description of what the
 * fields in an adjustment represent for a scrollbar.
 */

Matthias Clasen's avatar
Matthias Clasen committed
49
G_DEFINE_TYPE (GtkVScrollbar, gtk_vscrollbar, GTK_TYPE_SCROLLBAR)
Elliot Lee's avatar
Elliot Lee committed
50 51

static void
52
gtk_vscrollbar_class_init (GtkVScrollbarClass *class)
Elliot Lee's avatar
Elliot Lee committed
53
{
54
  GTK_RANGE_CLASS (class)->stepper_detail = "vscrollbar";
Elliot Lee's avatar
Elliot Lee committed
55 56
}

57
static void
58
gtk_vscrollbar_init (GtkVScrollbar *vscrollbar)
59
{
60 61
  gtk_orientable_set_orientation (GTK_ORIENTABLE (vscrollbar),
                                  GTK_ORIENTATION_VERTICAL);
Elliot Lee's avatar
Elliot Lee committed
62 63
}

64 65
/**
 * gtk_vscrollbar_new:
66
 * @adjustment: (allow-none): the #GtkAdjustment to use, or %NULL to create a new adjustment
67 68 69 70 71
 *
 * Creates a new vertical scrollbar.
 *
 * Returns: the new #GtkVScrollbar
 */
72
GtkWidget *
Elliot Lee's avatar
Elliot Lee committed
73 74
gtk_vscrollbar_new (GtkAdjustment *adjustment)
{
75 76 77 78 79 80
  g_return_val_if_fail (adjustment == NULL || GTK_IS_ADJUSTMENT (adjustment),
                        NULL);

  return g_object_new (GTK_TYPE_VSCROLLBAR,
                       "adjustment", adjustment,
                       NULL);
Elliot Lee's avatar
Elliot Lee committed
81
}