Pileus Git - ~andy/gtk/blob - gtk/gtknotebook.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 Library 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library 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 #ifndef __GTK_NOTEBOOK_H__
  20 #define __GTK_NOTEBOOK_H__
  21
  22
  23 #include <gdk/gdk.h>
  24 #include <gtk/gtkcontainer.h>
  25
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif /* __cplusplus */
  30
  31
  32 #define GTK_TYPE_NOTEBOOK                  (gtk_notebook_get_type ())
  33 #define GTK_NOTEBOOK(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_NOTEBOOK, GtkNotebook))
  34 #define GTK_NOTEBOOK_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_NOTEBOOK, GtkNotebookClass))
  35 #define GTK_IS_NOTEBOOK(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_NOTEBOOK))
  36 #define GTK_IS_NOTEBOOK_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_NOTEBOOK))
  37
  38 #define GTK_NOTEBOOK_PAGE(_glist_)         ((GtkNotebookPage *)((GList *)(_glist_))->data)
  39
  40
  41 typedef struct _GtkNotebook       GtkNotebook;
  42 typedef struct _GtkNotebookClass  GtkNotebookClass;
  43 typedef struct _GtkNotebookPage   GtkNotebookPage;
  44
  45 struct _GtkNotebook
  46 {
  47   GtkContainer container;
  48
  49   GtkNotebookPage *cur_page;
  50   GList *children;
  51   GList *first_tab;
  52   GList *focus_tab;
  53
  54   GtkWidget *menu;
  55   GdkWindow *panel;
  56
  57   guint32 timer;
  58
  59   guint16 tab_hborder;
  60   guint16 tab_vborder;
  61
  62   guint show_tabs          : 1;
  63   guint homogeneous        : 1;
  64   guint show_border        : 1;
  65   guint tab_pos            : 2;
  66   guint scrollable         : 1;
  67   guint in_child           : 2;
  68   guint click_child        : 2;
  69   guint button             : 2;
  70   guint need_timer         : 1;
  71   guint child_has_focus    : 1;
  72   guint have_visible_child : 1;
  73 };
  74
  75 struct _GtkNotebookClass
  76 {
  77   GtkContainerClass parent_class;
  78
  79   void (* switch_page)       (GtkNotebook     *notebook,
  80                               GtkNotebookPage *page,
  81                               guint            page_num);
  82 };
  83
  84 struct _GtkNotebookPage
  85 {
  86   GtkWidget *child;
  87   GtkWidget *tab_label;
  88   GtkWidget *menu_label;
  89
  90   guint default_menu : 1;
  91   guint default_tab  : 1;
  92   guint expand       : 1;
  93   guint fill         : 1;
  94   guint pack         : 1;
  95
  96   GtkRequisition requisition;
  97   GtkAllocation allocation;
  98 };
  99
 100 /***********************************************************
 101  *           Creation, insertion, deletion                 *
 102  ***********************************************************/
 103
 104 GtkType gtk_notebook_get_type       (void);
 105 GtkWidget * gtk_notebook_new        (void);
 106 void gtk_notebook_append_page       (GtkNotebook *notebook,
 107                                      GtkWidget   *child,
 108                                      GtkWidget   *tab_label);
 109 void gtk_notebook_append_page_menu  (GtkNotebook *notebook,
 110                                      GtkWidget   *child,
 111                                      GtkWidget   *tab_label,
 112                                      GtkWidget   *menu_label);
 113 void gtk_notebook_prepend_page      (GtkNotebook *notebook,
 114                                      GtkWidget   *child,
 115                                      GtkWidget   *tab_label);
 116 void gtk_notebook_prepend_page_menu (GtkNotebook *notebook,
 117                                      GtkWidget   *child,
 118                                      GtkWidget   *tab_label,
 119                                      GtkWidget   *menu_label);
 120 void gtk_notebook_insert_page       (GtkNotebook *notebook,
 121                                      GtkWidget   *child,
 122                                      GtkWidget   *tab_label,
 123                                      gint         position);
 124 void gtk_notebook_insert_page_menu  (GtkNotebook *notebook,
 125                                      GtkWidget   *child,
 126                                      GtkWidget   *tab_label,
 127                                      GtkWidget   *menu_label,
 128                                      gint         position);
 129 void gtk_notebook_remove_page       (GtkNotebook *notebook,
 130                                      gint         page_num);
 131
 132 /***********************************************************
 133  *            query, set current NoteebookPage             *
 134  ***********************************************************/
 135
 136 gint gtk_notebook_get_current_page   (GtkNotebook *notebook);
 137 GtkWidget* gtk_notebook_get_nth_page (GtkNotebook *notebook,
 138                                       gint         page_num);
 139 gint gtk_notebook_page_num         (GtkNotebook *notebook,
 140                                     GtkWidget   *child);
 141 void gtk_notebook_set_page         (GtkNotebook *notebook,
 142                                     gint         page_num);
 143 void gtk_notebook_next_page        (GtkNotebook *notebook);
 144 void gtk_notebook_prev_page        (GtkNotebook *notebook);
 145
 146 /***********************************************************
 147  *            set Notebook, NotebookTab style              *
 148  ***********************************************************/
 149
 150 void gtk_notebook_set_show_border      (GtkNotebook     *notebook,
 151                                         gboolean         show_border);
 152 void gtk_notebook_set_show_tabs        (GtkNotebook     *notebook,
 153                                         gboolean         show_tabs);
 154 void gtk_notebook_set_tab_pos          (GtkNotebook     *notebook,
 155                                         GtkPositionType  pos);
 156 void gtk_notebook_set_homogeneous_tabs (GtkNotebook     *notebook,
 157                                         gboolean         homogeneous);
 158 void gtk_notebook_set_tab_border       (GtkNotebook     *notebook,
 159                                         guint            border_width);
 160 void gtk_notebook_set_tab_hborder      (GtkNotebook     *notebook,
 161                                         guint            tab_hborder);
 162 void gtk_notebook_set_tab_vborder      (GtkNotebook     *notebook,
 163                                         guint            tab_vborder);
 164 void gtk_notebook_set_scrollable       (GtkNotebook     *notebook,
 165                                         gboolean         scrollable);
 166
 167 /***********************************************************
 168  *               enable/disable PopupMenu                  *
 169  ***********************************************************/
 170
 171 void gtk_notebook_popup_enable  (GtkNotebook *notebook);
 172 void gtk_notebook_popup_disable (GtkNotebook *notebook);
 173
 174 /***********************************************************
 175  *             query/set NotebookPage Properties           *
 176  ***********************************************************/
 177
 178 GtkWidget * gtk_notebook_get_tab_label    (GtkNotebook *notebook,
 179                                            GtkWidget   *child);
 180 void gtk_notebook_set_tab_label           (GtkNotebook *notebook,
 181                                            GtkWidget   *child,
 182                                            GtkWidget   *tab_label);
 183 void gtk_notebook_set_tab_label_text      (GtkNotebook *notebook,
 184                                            GtkWidget   *child,
 185                                            const gchar *tab_text);
 186 GtkWidget * gtk_notebook_get_menu_label   (GtkNotebook *notebook,
 187                                            GtkWidget   *child);
 188 void gtk_notebook_set_menu_label          (GtkNotebook *notebook,
 189                                            GtkWidget   *child,
 190                                            GtkWidget   *menu_label);
 191 void gtk_notebook_set_menu_label_text     (GtkNotebook *notebook,
 192                                            GtkWidget   *child,
 193                                            const gchar *menu_text);
 194 void gtk_notebook_query_tab_label_packing (GtkNotebook *notebook,
 195                                            GtkWidget   *child,
 196                                            gboolean    *expand,
 197                                            gboolean    *fill,
 198                                            GtkPackType *pack_type);
 199 void gtk_notebook_set_tab_label_packing   (GtkNotebook *notebook,
 200                                            GtkWidget   *child,
 201                                            gboolean     expand,
 202                                            gboolean     fill,
 203                                            GtkPackType  pack_type);
 204 void gtk_notebook_reorder_child           (GtkNotebook *notebook,
 205                                            GtkWidget   *child,
 206                                            gint         position);
 207
 208 #ifdef __cplusplus
 209 }
 210 #endif /* __cplusplus */
 211
 212
 213 #endif /* __GTK_NOTEBOOK_H__ */