Pileus Git - ~andy/gtk/blob - gtk/gtkscrolledwindow.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   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 #ifndef __GTK_SCROLLED_WINDOW_H__
  28 #define __GTK_SCROLLED_WINDOW_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkhscrollbar.h>
  33 #include <gtk/gtkvscrollbar.h>
  34 #include <gtk/gtkviewport.h>
  35
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif /* __cplusplus */
  40
  41
  42 #define GTK_TYPE_SCROLLED_WINDOW            (gtk_scrolled_window_get_type ())
  43 #define GTK_SCROLLED_WINDOW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindow))
  44 #define GTK_SCROLLED_WINDOW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowClass))
  45 #define GTK_IS_SCROLLED_WINDOW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SCROLLED_WINDOW))
  46 #define GTK_IS_SCROLLED_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SCROLLED_WINDOW))
  47 #define GTK_SCROLLED_WINDOW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowClass))
  48
  49
  50
  51 typedef struct _GtkScrolledWindow       GtkScrolledWindow;
  52 typedef struct _GtkScrolledWindowClass  GtkScrolledWindowClass;
  53
  54 struct _GtkScrolledWindow
  55 {
  56   GtkBin container;
  57
  58   /*< public >*/
  59   GtkWidget *hscrollbar;
  60   GtkWidget *vscrollbar;
  61
  62   /*< private >*/
  63   guint hscrollbar_policy      : 2;
  64   guint vscrollbar_policy      : 2;
  65   guint hscrollbar_visible     : 1;
  66   guint vscrollbar_visible     : 1;
  67   guint window_placement       : 2;
  68   guint focus_out              : 1;     /* Flag used by ::move-focus-out implementation */
  69
  70   guint16 shadow_type;
  71 };
  72
  73 struct _GtkScrolledWindowClass
  74 {
  75   GtkBinClass parent_class;
  76
  77   gint scrollbar_spacing;
  78
  79   /* Action signals for keybindings. Do not connect to these signals
  80    */
  81
  82   /* Unfortunately, GtkScrollType is deficient in that there is
  83    * no horizontal/vertical variants for GTK_SCROLL_START/END,
  84    * so we have to add an additional boolean flag.
  85    */
  86   void (*scroll_child) (GtkScrolledWindow *scrolled_window,
  87                         GtkScrollType      scroll,
  88                         gboolean           horizontal);
  89
  90   void (* move_focus_out) (GtkScrolledWindow *scrolled_window,
  91                            GtkDirectionType   direction);
  92
  93   /* Padding for future expansion */
  94   void (*_gtk_reserved1) (void);
  95   void (*_gtk_reserved2) (void);
  96   void (*_gtk_reserved3) (void);
  97   void (*_gtk_reserved4) (void);
  98 };
  99
 100
 101 GType          gtk_scrolled_window_get_type          (void) G_GNUC_CONST;
 102 GtkWidget*     gtk_scrolled_window_new               (GtkAdjustment     *hadjustment,
 103                                                       GtkAdjustment     *vadjustment);
 104 void           gtk_scrolled_window_set_hadjustment   (GtkScrolledWindow *scrolled_window,
 105                                                       GtkAdjustment     *hadjustment);
 106 void           gtk_scrolled_window_set_vadjustment   (GtkScrolledWindow *scrolled_window,
 107                                                       GtkAdjustment     *vadjustment);
 108 GtkAdjustment* gtk_scrolled_window_get_hadjustment   (GtkScrolledWindow *scrolled_window);
 109 GtkAdjustment* gtk_scrolled_window_get_vadjustment   (GtkScrolledWindow *scrolled_window);
 110 GtkWidget*     gtk_scrolled_window_get_hscrollbar    (GtkScrolledWindow *scrolled_window);
 111 GtkWidget*     gtk_scrolled_window_get_vscrollbar    (GtkScrolledWindow *scrolled_window);
 112 void           gtk_scrolled_window_set_policy        (GtkScrolledWindow *scrolled_window,
 113                                                       GtkPolicyType      hscrollbar_policy,
 114                                                       GtkPolicyType      vscrollbar_policy);
 115 void           gtk_scrolled_window_get_policy        (GtkScrolledWindow *scrolled_window,
 116                                                       GtkPolicyType     *hscrollbar_policy,
 117                                                       GtkPolicyType     *vscrollbar_policy);
 118 void           gtk_scrolled_window_set_placement     (GtkScrolledWindow *scrolled_window,
 119                                                       GtkCornerType      window_placement);
 120 GtkCornerType  gtk_scrolled_window_get_placement     (GtkScrolledWindow *scrolled_window);
 121 void           gtk_scrolled_window_set_shadow_type   (GtkScrolledWindow *scrolled_window,
 122                                                       GtkShadowType      type);
 123 GtkShadowType  gtk_scrolled_window_get_shadow_type   (GtkScrolledWindow *scrolled_window);
 124 void           gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
 125                                                       GtkWidget         *child);
 126
 127 gint _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window);
 128
 129 #ifdef __cplusplus
 130 }
 131 #endif /* __cplusplus */
 132
 133
 134 #endif /* __GTK_SCROLLED_WINDOW_H__ */