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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __GTK_SCROLLED_WINDOW_H__
  26 #define __GTK_SCROLLED_WINDOW_H__
  27
  28 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  29 #error "Only <gtk/gtk.h> can be included directly."
  30 #endif
  31
  32 #include <gtk/gtkbin.h>
  33
  34 G_BEGIN_DECLS
  35
  36
  37 #define GTK_TYPE_SCROLLED_WINDOW            (gtk_scrolled_window_get_type ())
  38 #define GTK_SCROLLED_WINDOW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindow))
  39 #define GTK_SCROLLED_WINDOW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowClass))
  40 #define GTK_IS_SCROLLED_WINDOW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SCROLLED_WINDOW))
  41 #define GTK_IS_SCROLLED_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SCROLLED_WINDOW))
  42 #define GTK_SCROLLED_WINDOW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowClass))
  43
  44
  45 typedef struct _GtkScrolledWindow              GtkScrolledWindow;
  46 typedef struct _GtkScrolledWindowPrivate       GtkScrolledWindowPrivate;
  47 typedef struct _GtkScrolledWindowClass         GtkScrolledWindowClass;
  48
  49 struct _GtkScrolledWindow
  50 {
  51   GtkBin container;
  52
  53   GtkScrolledWindowPrivate *priv;
  54 };
  55
  56 struct _GtkScrolledWindowClass
  57 {
  58   GtkBinClass parent_class;
  59
  60   gint scrollbar_spacing;
  61
  62   /* Action signals for keybindings. Do not connect to these signals
  63    */
  64
  65   /* Unfortunately, GtkScrollType is deficient in that there is
  66    * no horizontal/vertical variants for GTK_SCROLL_START/END,
  67    * so we have to add an additional boolean flag.
  68    */
  69   gboolean (*scroll_child) (GtkScrolledWindow *scrolled_window,
  70                             GtkScrollType      scroll,
  71                             gboolean           horizontal);
  72
  73   void (* move_focus_out) (GtkScrolledWindow *scrolled_window,
  74                            GtkDirectionType   direction);
  75
  76   /* Padding for future expansion */
  77   void (*_gtk_reserved1) (void);
  78   void (*_gtk_reserved2) (void);
  79   void (*_gtk_reserved3) (void);
  80   void (*_gtk_reserved4) (void);
  81 };
  82
  83
  84 GType          gtk_scrolled_window_get_type          (void) G_GNUC_CONST;
  85 GtkWidget*     gtk_scrolled_window_new               (GtkAdjustment     *hadjustment,
  86                                                       GtkAdjustment     *vadjustment);
  87 void           gtk_scrolled_window_set_hadjustment   (GtkScrolledWindow *scrolled_window,
  88                                                       GtkAdjustment     *hadjustment);
  89 void           gtk_scrolled_window_set_vadjustment   (GtkScrolledWindow *scrolled_window,
  90                                                       GtkAdjustment     *vadjustment);
  91 GtkAdjustment* gtk_scrolled_window_get_hadjustment   (GtkScrolledWindow *scrolled_window);
  92 GtkAdjustment* gtk_scrolled_window_get_vadjustment   (GtkScrolledWindow *scrolled_window);
  93 GtkWidget*     gtk_scrolled_window_get_hscrollbar    (GtkScrolledWindow *scrolled_window);
  94 GtkWidget*     gtk_scrolled_window_get_vscrollbar    (GtkScrolledWindow *scrolled_window);
  95 void           gtk_scrolled_window_set_policy        (GtkScrolledWindow *scrolled_window,
  96                                                       GtkPolicyType      hscrollbar_policy,
  97                                                       GtkPolicyType      vscrollbar_policy);
  98 void           gtk_scrolled_window_get_policy        (GtkScrolledWindow *scrolled_window,
  99                                                       GtkPolicyType     *hscrollbar_policy,
 100                                                       GtkPolicyType     *vscrollbar_policy);
 101 void           gtk_scrolled_window_set_placement     (GtkScrolledWindow *scrolled_window,
 102                                                       GtkCornerType      window_placement);
 103 void           gtk_scrolled_window_unset_placement   (GtkScrolledWindow *scrolled_window);
 104
 105 GtkCornerType  gtk_scrolled_window_get_placement     (GtkScrolledWindow *scrolled_window);
 106 void           gtk_scrolled_window_set_shadow_type   (GtkScrolledWindow *scrolled_window,
 107                                                       GtkShadowType      type);
 108 GtkShadowType  gtk_scrolled_window_get_shadow_type   (GtkScrolledWindow *scrolled_window);
 109 GDK_DEPRECATED_IN_3_8_FOR(gtk_container_add)
 110 void           gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
 111                                                       GtkWidget         *child);
 112
 113 gint           gtk_scrolled_window_get_min_content_width  (GtkScrolledWindow *scrolled_window);
 114 void           gtk_scrolled_window_set_min_content_width  (GtkScrolledWindow *scrolled_window,
 115                                                            gint               width);
 116 gint           gtk_scrolled_window_get_min_content_height (GtkScrolledWindow *scrolled_window);
 117 void           gtk_scrolled_window_set_min_content_height (GtkScrolledWindow *scrolled_window,
 118                                                            gint               height);
 119 GDK_AVAILABLE_IN_3_4
 120 void           gtk_scrolled_window_set_kinetic_scrolling  (GtkScrolledWindow        *scrolled_window,
 121                                                            gboolean                  kinetic_scrolling);
 122 GDK_AVAILABLE_IN_3_4
 123 gboolean       gtk_scrolled_window_get_kinetic_scrolling  (GtkScrolledWindow        *scrolled_window);
 124
 125 GDK_AVAILABLE_IN_3_4
 126 void           gtk_scrolled_window_set_capture_button_press (GtkScrolledWindow      *scrolled_window,
 127                                                              gboolean                capture_button_press);
 128 GDK_AVAILABLE_IN_3_4
 129 gboolean       gtk_scrolled_window_get_capture_button_press (GtkScrolledWindow      *scrolled_window);
 130
 131 gint _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window);
 132
 133
 134 G_END_DECLS
 135
 136
 137 #endif /* __GTK_SCROLLED_WINDOW_H__ */