gtk2/gtk/gtkscale.h
Matthias Clasen 20c8c8b91c Add annotations to gtk headers
Add annotations to all exported functions in GTK+ headers.
2013-05-05 15:38:47 -04:00

128 lines
4.8 KiB
C

/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* 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
* 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, 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/.
*/
#ifndef __GTK_SCALE_H__
#define __GTK_SCALE_H__
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#include <gtk/gtkrange.h>
G_BEGIN_DECLS
#define GTK_TYPE_SCALE (gtk_scale_get_type ())
#define GTK_SCALE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SCALE, GtkScale))
#define GTK_SCALE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SCALE, GtkScaleClass))
#define GTK_IS_SCALE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SCALE))
#define GTK_IS_SCALE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SCALE))
#define GTK_SCALE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SCALE, GtkScaleClass))
typedef struct _GtkScale GtkScale;
typedef struct _GtkScalePrivate GtkScalePrivate;
typedef struct _GtkScaleClass GtkScaleClass;
struct _GtkScale
{
GtkRange range;
/*< private >*/
GtkScalePrivate *priv;
};
struct _GtkScaleClass
{
GtkRangeClass parent_class;
gchar* (* format_value) (GtkScale *scale,
gdouble value);
void (* draw_value) (GtkScale *scale);
void (* get_layout_offsets) (GtkScale *scale,
gint *x,
gint *y);
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
};
GDK_AVAILABLE_IN_ALL
GType gtk_scale_get_type (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
GtkWidget * gtk_scale_new (GtkOrientation orientation,
GtkAdjustment *adjustment);
GDK_AVAILABLE_IN_ALL
GtkWidget * gtk_scale_new_with_range (GtkOrientation orientation,
gdouble min,
gdouble max,
gdouble step);
GDK_AVAILABLE_IN_ALL
void gtk_scale_set_digits (GtkScale *scale,
gint digits);
GDK_AVAILABLE_IN_ALL
gint gtk_scale_get_digits (GtkScale *scale);
GDK_AVAILABLE_IN_ALL
void gtk_scale_set_draw_value (GtkScale *scale,
gboolean draw_value);
GDK_AVAILABLE_IN_ALL
gboolean gtk_scale_get_draw_value (GtkScale *scale);
GDK_AVAILABLE_IN_3_4
void gtk_scale_set_has_origin (GtkScale *scale,
gboolean has_origin);
GDK_AVAILABLE_IN_3_4
gboolean gtk_scale_get_has_origin (GtkScale *scale);
GDK_AVAILABLE_IN_ALL
void gtk_scale_set_value_pos (GtkScale *scale,
GtkPositionType pos);
GDK_AVAILABLE_IN_ALL
GtkPositionType gtk_scale_get_value_pos (GtkScale *scale);
GDK_AVAILABLE_IN_ALL
PangoLayout * gtk_scale_get_layout (GtkScale *scale);
GDK_AVAILABLE_IN_ALL
void gtk_scale_get_layout_offsets (GtkScale *scale,
gint *x,
gint *y);
GDK_AVAILABLE_IN_ALL
void gtk_scale_add_mark (GtkScale *scale,
gdouble value,
GtkPositionType position,
const gchar *markup);
GDK_AVAILABLE_IN_ALL
void gtk_scale_clear_marks (GtkScale *scale);
G_END_DECLS
#endif /* __GTK_SCALE_H__ */