]> Pileus Git - ~andy/gtk/blob - gtk/gtkvscrollbar.c
Move documentation to inline comments: GtkVScrollbar
[~andy/gtk] / gtk / gtkvscrollbar.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  * Copyright (C) 2001 Red Hat, Inc.
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
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 /*
22  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
23  * file for a list of people on the GTK+ Team.  See the ChangeLog
24  * 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"
31 #include "gtkvscrollbar.h"
32 #include "gtkintl.h"
33 #include "gtkalias.h"
34
35 /**
36  * SECTION:gtkvscrollbar
37  * @Short_description: A vertical scrollbar
38  * @Title: GtkVScrollbar
39  * @See_also:#GtkScrollbar, #GtkScrolledWindow
40  *
41  * The #GtkVScrollbar widget is a widget arranged vertically creating a
42  * scrollbar. See #GtkScrollbar for details on
43  * scrollbars. #GtkAdjustment pointers may be added to handle the
44  * adjustment of the scrollbar or it may be left %NULL in which case one
45  * will be created for you. See #GtkScrollbar for a description of what the
46  * fields in an adjustment represent for a scrollbar.
47  */
48
49 G_DEFINE_TYPE (GtkVScrollbar, gtk_vscrollbar, GTK_TYPE_SCROLLBAR)
50
51 static void
52 gtk_vscrollbar_class_init (GtkVScrollbarClass *class)
53 {
54   GTK_RANGE_CLASS (class)->stepper_detail = "vscrollbar";
55 }
56
57 static void
58 gtk_vscrollbar_init (GtkVScrollbar *vscrollbar)
59 {
60   gtk_orientable_set_orientation (GTK_ORIENTABLE (vscrollbar),
61                                   GTK_ORIENTATION_VERTICAL);
62 }
63
64 /**
65  * gtk_vscrollbar_new:
66  * @adjustment: (allow-none): the #GtkAdjustment to use, or %NULL to create a new adjustment
67  *
68  * Creates a new vertical scrollbar.
69  *
70  * Returns: the new #GtkVScrollbar
71  */
72 GtkWidget *
73 gtk_vscrollbar_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_VSCROLLBAR,
79                        "adjustment", adjustment,
80                        NULL);
81 }
82
83 #define __GTK_VSCROLLBAR_C__
84 #include "gtkaliasdef.c"