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

   1 /* -*- Mode: C; c-file-style: "gnu"; tab-width: 8 -*- */
   2 /* GTK - The GIMP Toolkit
   3  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  29 #error "Only <gtk/gtk.h> can be included directly."
  30 #endif
  31
  32 #ifndef __GTK_NOTEBOOK_H__
  33 #define __GTK_NOTEBOOK_H__
  34
  35
  36 #include <gtk/gtkcontainer.h>
  37
  38
  39 G_BEGIN_DECLS
  40
  41 #define GTK_TYPE_NOTEBOOK                  (gtk_notebook_get_type ())
  42 #define GTK_NOTEBOOK(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_NOTEBOOK, GtkNotebook))
  43 #define GTK_NOTEBOOK_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_NOTEBOOK, GtkNotebookClass))
  44 #define GTK_IS_NOTEBOOK(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_NOTEBOOK))
  45 #define GTK_IS_NOTEBOOK_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_NOTEBOOK))
  46 #define GTK_NOTEBOOK_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_NOTEBOOK, GtkNotebookClass))
  47
  48
  49 typedef enum
  50 {
  51   GTK_NOTEBOOK_TAB_FIRST,
  52   GTK_NOTEBOOK_TAB_LAST
  53 } GtkNotebookTab;
  54
  55 typedef struct _GtkNotebook       GtkNotebook;
  56 typedef struct _GtkNotebookPriv   GtkNotebookPriv;
  57 typedef struct _GtkNotebookClass  GtkNotebookClass;
  58
  59 struct _GtkNotebook
  60 {
  61   GtkContainer container;
  62
  63   /* <private> */
  64   GtkNotebookPriv *priv;
  65 };
  66
  67 struct _GtkNotebookClass
  68 {
  69   GtkContainerClass parent_class;
  70
  71   void (* switch_page)       (GtkNotebook     *notebook,
  72                               GtkWidget       *page,
  73                               guint            page_num);
  74
  75   /* Action signals for keybindings */
  76   gboolean (* select_page)     (GtkNotebook       *notebook,
  77                                 gboolean           move_focus);
  78   gboolean (* focus_tab)       (GtkNotebook       *notebook,
  79                                 GtkNotebookTab     type);
  80   gboolean (* change_current_page) (GtkNotebook   *notebook,
  81                                 gint               offset);
  82   void (* move_focus_out)      (GtkNotebook       *notebook,
  83                                 GtkDirectionType   direction);
  84   gboolean (* reorder_tab)     (GtkNotebook       *notebook,
  85                                 GtkDirectionType   direction,
  86                                 gboolean           move_to_last);
  87
  88   /* More vfuncs */
  89   gint (* insert_page)         (GtkNotebook       *notebook,
  90                                 GtkWidget         *child,
  91                                 GtkWidget         *tab_label,
  92                                 GtkWidget         *menu_label,
  93                                 gint               position);
  94
  95   GtkNotebook * (* create_window) (GtkNotebook       *notebook,
  96                                    GtkWidget         *page,
  97                                    gint               x,
  98                                    gint               y);
  99
 100   void (*_gtk_reserved1) (void);
 101 };
 102
 103 typedef GtkNotebook* (*GtkNotebookWindowCreationFunc) (GtkNotebook *source,
 104                                                        GtkWidget   *page,
 105                                                        gint         x,
 106                                                        gint         y,
 107                                                        gpointer     data);
 108
 109 /***********************************************************
 110  *           Creation, insertion, deletion                 *
 111  ***********************************************************/
 112
 113 GType   gtk_notebook_get_type       (void) G_GNUC_CONST;
 114 GtkWidget * gtk_notebook_new        (void);
 115 gint gtk_notebook_append_page       (GtkNotebook *notebook,
 116                                      GtkWidget   *child,
 117                                      GtkWidget   *tab_label);
 118 gint gtk_notebook_append_page_menu  (GtkNotebook *notebook,
 119                                      GtkWidget   *child,
 120                                      GtkWidget   *tab_label,
 121                                      GtkWidget   *menu_label);
 122 gint gtk_notebook_prepend_page      (GtkNotebook *notebook,
 123                                      GtkWidget   *child,
 124                                      GtkWidget   *tab_label);
 125 gint gtk_notebook_prepend_page_menu (GtkNotebook *notebook,
 126                                      GtkWidget   *child,
 127                                      GtkWidget   *tab_label,
 128                                      GtkWidget   *menu_label);
 129 gint gtk_notebook_insert_page       (GtkNotebook *notebook,
 130                                      GtkWidget   *child,
 131                                      GtkWidget   *tab_label,
 132                                      gint         position);
 133 gint gtk_notebook_insert_page_menu  (GtkNotebook *notebook,
 134                                      GtkWidget   *child,
 135                                      GtkWidget   *tab_label,
 136                                      GtkWidget   *menu_label,
 137                                      gint         position);
 138 void gtk_notebook_remove_page       (GtkNotebook *notebook,
 139                                      gint         page_num);
 140
 141 /***********************************************************
 142  *           Tabs drag and drop                            *
 143  ***********************************************************/
 144
 145 void gtk_notebook_set_window_creation_hook (GtkNotebookWindowCreationFunc  func,
 146                                             gpointer                       data,
 147                                             GDestroyNotify                 destroy);
 148 void gtk_notebook_set_group                (GtkNotebook *notebook,
 149                                             gpointer     group);
 150 gpointer gtk_notebook_get_group            (GtkNotebook *notebook);
 151
 152
 153
 154 /***********************************************************
 155  *            query, set current NotebookPage              *
 156  ***********************************************************/
 157
 158 gint       gtk_notebook_get_current_page (GtkNotebook *notebook);
 159 GtkWidget* gtk_notebook_get_nth_page     (GtkNotebook *notebook,
 160                                           gint         page_num);
 161 gint       gtk_notebook_get_n_pages      (GtkNotebook *notebook);
 162 gint       gtk_notebook_page_num         (GtkNotebook *notebook,
 163                                           GtkWidget   *child);
 164 void       gtk_notebook_set_current_page (GtkNotebook *notebook,
 165                                           gint         page_num);
 166 void       gtk_notebook_next_page        (GtkNotebook *notebook);
 167 void       gtk_notebook_prev_page        (GtkNotebook *notebook);
 168
 169 /***********************************************************
 170  *            set Notebook, NotebookTab style              *
 171  ***********************************************************/
 172
 173 void     gtk_notebook_set_show_border      (GtkNotebook     *notebook,
 174                                             gboolean         show_border);
 175 gboolean gtk_notebook_get_show_border      (GtkNotebook     *notebook);
 176 void     gtk_notebook_set_show_tabs        (GtkNotebook     *notebook,
 177                                             gboolean         show_tabs);
 178 gboolean gtk_notebook_get_show_tabs        (GtkNotebook     *notebook);
 179 void     gtk_notebook_set_tab_pos          (GtkNotebook     *notebook,
 180                                             GtkPositionType  pos);
 181 GtkPositionType gtk_notebook_get_tab_pos   (GtkNotebook     *notebook);
 182 void     gtk_notebook_set_scrollable       (GtkNotebook     *notebook,
 183                                             gboolean         scrollable);
 184 gboolean gtk_notebook_get_scrollable       (GtkNotebook     *notebook);
 185
 186 /***********************************************************
 187  *               enable/disable PopupMenu                  *
 188  ***********************************************************/
 189
 190 void gtk_notebook_popup_enable  (GtkNotebook *notebook);
 191 void gtk_notebook_popup_disable (GtkNotebook *notebook);
 192
 193 /***********************************************************
 194  *             query/set NotebookPage Properties           *
 195  ***********************************************************/
 196
 197 GtkWidget * gtk_notebook_get_tab_label    (GtkNotebook *notebook,
 198                                            GtkWidget   *child);
 199 void gtk_notebook_set_tab_label           (GtkNotebook *notebook,
 200                                            GtkWidget   *child,
 201                                            GtkWidget   *tab_label);
 202 void gtk_notebook_set_tab_label_text      (GtkNotebook *notebook,
 203                                            GtkWidget   *child,
 204                                            const gchar *tab_text);
 205 G_CONST_RETURN gchar *gtk_notebook_get_tab_label_text (GtkNotebook *notebook,
 206                                                        GtkWidget   *child);
 207 GtkWidget * gtk_notebook_get_menu_label   (GtkNotebook *notebook,
 208                                            GtkWidget   *child);
 209 void gtk_notebook_set_menu_label          (GtkNotebook *notebook,
 210                                            GtkWidget   *child,
 211                                            GtkWidget   *menu_label);
 212 void gtk_notebook_set_menu_label_text     (GtkNotebook *notebook,
 213                                            GtkWidget   *child,
 214                                            const gchar *menu_text);
 215 G_CONST_RETURN gchar *gtk_notebook_get_menu_label_text (GtkNotebook *notebook,
 216                                                         GtkWidget   *child);
 217 void gtk_notebook_reorder_child           (GtkNotebook *notebook,
 218                                            GtkWidget   *child,
 219                                            gint         position);
 220 gboolean gtk_notebook_get_tab_reorderable (GtkNotebook *notebook,
 221                                            GtkWidget   *child);
 222 void gtk_notebook_set_tab_reorderable     (GtkNotebook *notebook,
 223                                            GtkWidget   *child,
 224                                            gboolean     reorderable);
 225 gboolean gtk_notebook_get_tab_detachable  (GtkNotebook *notebook,
 226                                            GtkWidget   *child);
 227 void gtk_notebook_set_tab_detachable      (GtkNotebook *notebook,
 228                                            GtkWidget   *child,
 229                                            gboolean     detachable);
 230
 231 GtkWidget* gtk_notebook_get_action_widget (GtkNotebook *notebook,
 232                                            GtkPackType  pack_type);
 233 void       gtk_notebook_set_action_widget (GtkNotebook *notebook,
 234                                            GtkWidget   *widget,
 235                                            GtkPackType  pack_type);
 236
 237 G_END_DECLS
 238
 239 #endif /* __GTK_NOTEBOOK_H__ */