1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
27 #ifndef __GTK_NOTEBOOK_H__
28 #define __GTK_NOTEBOOK_H__
32 #include <gtk/gtkcontainer.h>
37 #endif /* __cplusplus */
40 #define GTK_TYPE_NOTEBOOK (gtk_notebook_get_type ())
41 #define GTK_NOTEBOOK(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_NOTEBOOK, GtkNotebook))
42 #define GTK_NOTEBOOK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_NOTEBOOK, GtkNotebookClass))
43 #define GTK_IS_NOTEBOOK(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_NOTEBOOK))
44 #define GTK_IS_NOTEBOOK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_NOTEBOOK))
45 #define GTK_NOTEBOOK_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_NOTEBOOK, GtkNotebookClass))
50 GTK_NOTEBOOK_TAB_FIRST,
54 typedef struct _GtkNotebook GtkNotebook;
55 typedef struct _GtkNotebookClass GtkNotebookClass;
56 typedef struct _GtkNotebookPage GtkNotebookPage;
60 GtkContainer container;
62 GtkNotebookPage *cur_page;
64 GList *first_tab; /* The first tab visible (for scrolling notebooks) */
68 GdkWindow *event_window;
76 guint homogeneous : 1;
77 guint show_border : 1;
81 guint click_child : 3;
84 guint child_has_focus : 1;
85 guint have_visible_child : 1;
86 guint focus_out : 1; /* Flag used by ::move-focus-out implementation */
88 guint has_before_previous : 1;
89 guint has_before_next : 1;
90 guint has_after_previous : 1;
91 guint has_after_next : 1;
94 struct _GtkNotebookClass
96 GtkContainerClass parent_class;
98 void (* switch_page) (GtkNotebook *notebook,
99 GtkNotebookPage *page,
102 /* Action signals for keybindings */
103 gboolean (* select_page) (GtkNotebook *notebook,
104 gboolean move_focus);
105 gboolean (* focus_tab) (GtkNotebook *notebook,
106 GtkNotebookTab type);
107 void (* change_current_page) (GtkNotebook *notebook,
109 void (* move_focus_out) (GtkNotebook *notebook,
110 GtkDirectionType direction);
112 /* Padding for future expansion */
113 void (*_gtk_reserved1) (void);
114 void (*_gtk_reserved2) (void);
115 void (*_gtk_reserved3) (void);
116 void (*_gtk_reserved4) (void);
119 /***********************************************************
120 * Creation, insertion, deletion *
121 ***********************************************************/
123 GType gtk_notebook_get_type (void) G_GNUC_CONST;
124 GtkWidget * gtk_notebook_new (void);
125 void gtk_notebook_append_page (GtkNotebook *notebook,
127 GtkWidget *tab_label);
128 void gtk_notebook_append_page_menu (GtkNotebook *notebook,
130 GtkWidget *tab_label,
131 GtkWidget *menu_label);
132 void gtk_notebook_prepend_page (GtkNotebook *notebook,
134 GtkWidget *tab_label);
135 void gtk_notebook_prepend_page_menu (GtkNotebook *notebook,
137 GtkWidget *tab_label,
138 GtkWidget *menu_label);
139 void gtk_notebook_insert_page (GtkNotebook *notebook,
141 GtkWidget *tab_label,
143 void gtk_notebook_insert_page_menu (GtkNotebook *notebook,
145 GtkWidget *tab_label,
146 GtkWidget *menu_label,
148 void gtk_notebook_remove_page (GtkNotebook *notebook,
151 /***********************************************************
152 * query, set current NoteebookPage *
153 ***********************************************************/
155 gint gtk_notebook_get_current_page (GtkNotebook *notebook);
156 GtkWidget* gtk_notebook_get_nth_page (GtkNotebook *notebook,
158 gint gtk_notebook_get_n_pages (GtkNotebook *notebook);
159 gint gtk_notebook_page_num (GtkNotebook *notebook,
161 void gtk_notebook_set_current_page (GtkNotebook *notebook,
163 void gtk_notebook_next_page (GtkNotebook *notebook);
164 void gtk_notebook_prev_page (GtkNotebook *notebook);
166 /***********************************************************
167 * set Notebook, NotebookTab style *
168 ***********************************************************/
170 void gtk_notebook_set_show_border (GtkNotebook *notebook,
171 gboolean show_border);
172 gboolean gtk_notebook_get_show_border (GtkNotebook *notebook);
173 void gtk_notebook_set_show_tabs (GtkNotebook *notebook,
175 gboolean gtk_notebook_get_show_tabs (GtkNotebook *notebook);
176 void gtk_notebook_set_tab_pos (GtkNotebook *notebook,
177 GtkPositionType pos);
178 GtkPositionType gtk_notebook_get_tab_pos (GtkNotebook *notebook);
180 #ifndef GTK_DISABLE_DEPRECATED
181 void gtk_notebook_set_homogeneous_tabs (GtkNotebook *notebook,
182 gboolean homogeneous);
183 void gtk_notebook_set_tab_border (GtkNotebook *notebook,
185 void gtk_notebook_set_tab_hborder (GtkNotebook *notebook,
187 void gtk_notebook_set_tab_vborder (GtkNotebook *notebook,
189 #endif /* GTK_DISABLE_DEPRECATED */
191 void gtk_notebook_set_scrollable (GtkNotebook *notebook,
192 gboolean scrollable);
193 gboolean gtk_notebook_get_scrollable (GtkNotebook *notebook);
195 /***********************************************************
196 * enable/disable PopupMenu *
197 ***********************************************************/
199 void gtk_notebook_popup_enable (GtkNotebook *notebook);
200 void gtk_notebook_popup_disable (GtkNotebook *notebook);
202 /***********************************************************
203 * query/set NotebookPage Properties *
204 ***********************************************************/
206 GtkWidget * gtk_notebook_get_tab_label (GtkNotebook *notebook,
208 void gtk_notebook_set_tab_label (GtkNotebook *notebook,
210 GtkWidget *tab_label);
211 void gtk_notebook_set_tab_label_text (GtkNotebook *notebook,
213 const gchar *tab_text);
214 G_CONST_RETURN gchar *gtk_notebook_get_tab_label_text (GtkNotebook *notebook,
216 GtkWidget * gtk_notebook_get_menu_label (GtkNotebook *notebook,
218 void gtk_notebook_set_menu_label (GtkNotebook *notebook,
220 GtkWidget *menu_label);
221 void gtk_notebook_set_menu_label_text (GtkNotebook *notebook,
223 const gchar *menu_text);
224 G_CONST_RETURN gchar *gtk_notebook_get_menu_label_text (GtkNotebook *notebook,
226 void gtk_notebook_query_tab_label_packing (GtkNotebook *notebook,
230 GtkPackType *pack_type);
231 void gtk_notebook_set_tab_label_packing (GtkNotebook *notebook,
235 GtkPackType pack_type);
236 void gtk_notebook_reorder_child (GtkNotebook *notebook,
240 #ifndef GTK_DISABLE_DEPRECATED
241 #define gtk_notebook_current_page gtk_notebook_get_current_page
242 #define gtk_notebook_set_page gtk_notebook_set_current_page
243 #endif /* GTK_DISABLE_DEPRECATED */
247 #endif /* __cplusplus */
250 #endif /* __GTK_NOTEBOOK_H__ */