* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
- * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+#include "config.h"
+
#include "gtkscrollbar.h"
+
+#include "gtkadjustment.h"
#include "gtkintl.h"
+#include "gtkprivate.h"
-static void gtk_scrollbar_class_init (GtkScrollbarClass *klass);
-static void gtk_scrollbar_init (GtkScrollbar *scrollbar);
-static void gtk_scrollbar_style_set (GtkWidget *widget,
- GtkStyle *previous);
-static gpointer parent_class;
+/**
+ * SECTION:gtkscrollbar
+ * @Short_description: A Scrollbar
+ * @Title: GtkScrollbar
+ * @See_also: #GtkAdjustment, #GtkScrolledWindow
+ *
+ * The #GtkScrollbar widget is a horizontal or vertical scrollbar,
+ * depending on the value of the #GtkOrientable:orientation property.
+ *
+ * The position of the thumb in a scrollbar is controlled by the scroll
+ * adjustments. See #GtkAdjustment for the fields in an adjustment - for
+ * #GtkScrollbar, the #GtkAdjustment:value field represents the position
+ * of the scrollbar, which must be between the #GtkAdjustment:lower field
+ * and #GtkAdjustment:upper - #GtkAdjustment:page-size. The
+ * #GtkAdjustment:page-size field represents the size of the visible
+ * scrollable area. The #GtkAdjustment:step-increment and
+ * #GtkAdjustment:page-increment fields are properties when the user asks to
+ * step down (using the small stepper arrows) or page down (using for
+ * example the <keycap>PageDown</keycap> key).
+ */
-GtkType
-gtk_scrollbar_get_type (void)
-{
- static GtkType scrollbar_type = 0;
-
- if (!scrollbar_type)
- {
- static const GTypeInfo scrollbar_info =
- {
- sizeof (GtkScrollbarClass),
- NULL, /* base_init */
- NULL, /* base_finalize */
- (GClassInitFunc) gtk_scrollbar_class_init,
- NULL, /* class_finalize */
- NULL, /* class_data */
- sizeof (GtkScrollbar),
- 0, /* n_preallocs */
- (GInstanceInitFunc) gtk_scrollbar_init,
- NULL, /* value_table */
- };
-
- scrollbar_type = g_type_register_static (GTK_TYPE_RANGE, "GtkScrollbar",
- &scrollbar_info, G_TYPE_FLAG_ABSTRACT);
- }
-
- return scrollbar_type;
-}
+
+static void gtk_scrollbar_style_updated (GtkWidget *widget);
+
+G_DEFINE_TYPE (GtkScrollbar, gtk_scrollbar, GTK_TYPE_RANGE)
static void
gtk_scrollbar_class_init (GtkScrollbarClass *class)
{
- GtkWidgetClass *widget_class;
+ GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
- widget_class = GTK_WIDGET_CLASS (class);
+ widget_class->style_updated = gtk_scrollbar_style_updated;
- parent_class = g_type_class_peek_parent (class);
-
- widget_class->style_set = gtk_scrollbar_style_set;
-
gtk_widget_class_install_style_property (widget_class,
- g_param_spec_int ("min_slider_length",
- _("Minimum Slider Length"),
- _("Minimum length of scrollbar slider"),
+ g_param_spec_int ("min-slider-length",
+ P_("Minimum Slider Length"),
+ P_("Minimum length of scrollbar slider"),
0,
G_MAXINT,
- 7,
- G_PARAM_READABLE));
+ 21,
+ GTK_PARAM_READABLE));
gtk_widget_class_install_style_property (widget_class,
- g_param_spec_boolean ("fixed_slider_length",
- _("Fixed slider size"),
- _("Don't change slider size, just lock it to the minimum length"),
+ g_param_spec_boolean ("fixed-slider-length",
+ P_("Fixed slider size"),
+ P_("Don't change slider size, just lock it to the minimum length"),
FALSE,
-
- G_PARAM_READABLE));
-
+ GTK_PARAM_READABLE));
+
gtk_widget_class_install_style_property (widget_class,
- g_param_spec_boolean ("has_backward_stepper",
- _("Backward stepper"),
- _("Display the standard backward arrow button"),
+ g_param_spec_boolean ("has-backward-stepper",
+ P_("Backward stepper"),
+ P_("Display the standard backward arrow button"),
TRUE,
-
- G_PARAM_READABLE));
+ GTK_PARAM_READABLE));
- gtk_widget_class_install_style_property (widget_class,
- g_param_spec_boolean ("has_forward_stepper",
- _("Forward stepper"),
- _("Display the standard forward arrow button"),
- TRUE,
-
- G_PARAM_READABLE));
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_boolean ("has-forward-stepper",
+ P_("Forward stepper"),
+ P_("Display the standard forward arrow button"),
+ TRUE,
+ GTK_PARAM_READABLE));
gtk_widget_class_install_style_property (widget_class,
- g_param_spec_boolean ("has_secondary_backward_stepper",
- _("Secondary backward stepper"),
- _("Display a second backward arrow button on the opposite end of the scrollbar"),
+ g_param_spec_boolean ("has-secondary-backward-stepper",
+ P_("Secondary backward stepper"),
+ P_("Display a second backward arrow button on the opposite end of the scrollbar"),
FALSE,
-
- G_PARAM_READABLE));
-
- gtk_widget_class_install_style_property (widget_class,
- g_param_spec_boolean ("has_secondary_forward_stepper",
- _("Secondary forward stepper"),
- _("Display a secondary forward arrow button on the opposite end of the scrollbar"),
- FALSE,
-
- G_PARAM_READABLE));
-}
+ GTK_PARAM_READABLE));
-static void
-gtk_scrollbar_init (GtkScrollbar *scrollbar)
-{
- GtkRange *range;
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_boolean ("has-secondary-forward-stepper",
+ P_("Secondary forward stepper"),
+ P_("Display a second forward arrow button on the opposite end of the scrollbar"),
+ FALSE,
+ GTK_PARAM_READABLE));
- range = GTK_RANGE (scrollbar);
+ gtk_widget_class_set_accessible_role (widget_class, ATK_ROLE_SCROLL_BAR);
}
static void
-gtk_scrollbar_style_set (GtkWidget *widget,
- GtkStyle *previous)
+gtk_scrollbar_update_style (GtkScrollbar *scrollbar)
{
gint slider_length;
gboolean fixed_size;
gboolean has_a, has_b, has_c, has_d;
- GtkRange *range;
+ GtkRange *range = GTK_RANGE (scrollbar);
+ GtkWidget *widget = GTK_WIDGET (scrollbar);
- range = GTK_RANGE (widget);
-
gtk_widget_style_get (widget,
- "min_slider_length", &slider_length,
- "fixed_slider_length", &fixed_size,
- "has_backward_stepper", &has_a,
- "has_secondary_forward_stepper", &has_b,
- "has_secondary_backward_stepper", &has_c,
- "has_forward_stepper", &has_d,
+ "min-slider-length", &slider_length,
+ "fixed-slider-length", &fixed_size,
+ "has-backward-stepper", &has_a,
+ "has-secondary-forward-stepper", &has_b,
+ "has-secondary-backward-stepper", &has_c,
+ "has-forward-stepper", &has_d,
NULL);
-
- range->min_slider_size = slider_length;
- range->slider_size_fixed = fixed_size;
-
- range->has_stepper_a = has_a;
- range->has_stepper_b = has_b;
- range->has_stepper_c = has_c;
- range->has_stepper_d = has_d;
-
- (* GTK_WIDGET_CLASS (parent_class)->style_set) (widget, previous);
+
+ gtk_range_set_min_slider_size (range, slider_length);
+ gtk_range_set_slider_size_fixed (range, fixed_size);
+ _gtk_range_set_steppers (range,
+ has_a, has_b, has_c, has_d);
}
+static void
+gtk_scrollbar_init (GtkScrollbar *scrollbar)
+{
+ GtkStyleContext *context;
+ context = gtk_widget_get_style_context (GTK_WIDGET (scrollbar));
+ gtk_style_context_add_class (context, GTK_STYLE_CLASS_SCROLLBAR);
+ gtk_scrollbar_update_style (scrollbar);
+}
+
+static void
+gtk_scrollbar_style_updated (GtkWidget *widget)
+{
+ gtk_scrollbar_update_style (GTK_SCROLLBAR (widget));
+ GTK_WIDGET_CLASS (gtk_scrollbar_parent_class)->style_updated (widget);
+}
+
+/**
+ * gtk_scrollbar_new:
+ * @orientation: the scrollbar's orientation.
+ * @adjustment: (allow-none): the #GtkAdjustment to use, or %NULL to create a new adjustment.
+ *
+ * Creates a new scrollbar with the given orientation.
+ *
+ * Return value: the new #GtkScrollbar.
+ *
+ * Since: 3.0
+ **/
+GtkWidget *
+gtk_scrollbar_new (GtkOrientation orientation,
+ GtkAdjustment *adjustment)
+{
+ g_return_val_if_fail (adjustment == NULL || GTK_IS_ADJUSTMENT (adjustment),
+ NULL);
+
+ return g_object_new (GTK_TYPE_SCROLLBAR,
+ "orientation", orientation,
+ "adjustment", adjustment,
+ NULL);
+}