gtknotebook.h 9.31 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Elliot Lee's avatar
Elliot Lee committed
27 28 29 30 31 32 33 34 35 36 37 38 39
#ifndef __GTK_NOTEBOOK_H__
#define __GTK_NOTEBOOK_H__


#include <gdk/gdk.h>
#include <gtk/gtkcontainer.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


40
#define GTK_TYPE_NOTEBOOK                  (gtk_notebook_get_type ())
Manish Singh's avatar
Manish Singh committed
41 42 43 44 45
#define GTK_NOTEBOOK(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_NOTEBOOK, GtkNotebook))
#define GTK_NOTEBOOK_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_NOTEBOOK, GtkNotebookClass))
#define GTK_IS_NOTEBOOK(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_NOTEBOOK))
#define GTK_IS_NOTEBOOK_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_NOTEBOOK))
#define GTK_NOTEBOOK_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_NOTEBOOK, GtkNotebookClass))
Tim Janik's avatar
Tim Janik committed
46

Elliot Lee's avatar
Elliot Lee committed
47

48 49 50 51 52 53
typedef enum
{
  GTK_NOTEBOOK_TAB_FIRST,
  GTK_NOTEBOOK_TAB_LAST
} GtkNotebookTab;

Elliot Lee's avatar
Elliot Lee committed
54 55 56 57 58 59 60
typedef struct _GtkNotebook       GtkNotebook;
typedef struct _GtkNotebookClass  GtkNotebookClass;
typedef struct _GtkNotebookPage   GtkNotebookPage;

struct _GtkNotebook
{
  GtkContainer container;
61
  
Elliot Lee's avatar
Elliot Lee committed
62 63
  GtkNotebookPage *cur_page;
  GList *children;
64
  GList *first_tab;		/* The first tab visible (for scrolling notebooks) */
65
  GList *focus_tab;
66
  
67
  GtkWidget *menu;
68
  GdkWindow *event_window;
69
  
70
  guint32 timer;
71
  
72 73
  guint16 tab_hborder;
  guint16 tab_vborder;
74
  
75 76 77 78 79
  guint show_tabs          : 1;
  guint homogeneous        : 1;
  guint show_border        : 1;
  guint tab_pos            : 2;
  guint scrollable         : 1;
80 81
  guint in_child           : 3;
  guint click_child        : 3;
82 83 84 85
  guint button             : 2;
  guint need_timer         : 1;
  guint child_has_focus    : 1;
  guint have_visible_child : 1;
86
  guint focus_out          : 1;	/* Flag used by ::move-focus-out implementation */
87 88 89 90 91

  guint has_before_previous : 1;
  guint has_before_next     : 1;
  guint has_after_previous  : 1;
  guint has_after_next      : 1;
Elliot Lee's avatar
Elliot Lee committed
92 93 94 95 96
};

struct _GtkNotebookClass
{
  GtkContainerClass parent_class;
97
  
98
  void (* switch_page)       (GtkNotebook     *notebook,
99
                              GtkNotebookPage *page,
100
			      guint            page_num);
101 102

  /* Action signals for keybindings */
103
  gboolean (* select_page)     (GtkNotebook       *notebook,
104
                                gboolean           move_focus);
105
  gboolean (* focus_tab)       (GtkNotebook       *notebook,
106 107 108
                                GtkNotebookTab     type);
  void (* change_current_page) (GtkNotebook       *notebook,
                                gint               offset);
109 110
  void (* move_focus_out)      (GtkNotebook       *notebook,
				GtkDirectionType   direction);
111 112 113 114 115 116

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
Elliot Lee's avatar
Elliot Lee committed
117 118
};

119 120 121 122
/***********************************************************
 *           Creation, insertion, deletion                 *
 ***********************************************************/

Manish Singh's avatar
Manish Singh committed
123
GType   gtk_notebook_get_type       (void) G_GNUC_CONST;
124
GtkWidget * gtk_notebook_new        (void);
125
gint gtk_notebook_append_page       (GtkNotebook *notebook,
126 127
				     GtkWidget   *child,
				     GtkWidget   *tab_label);
128
gint gtk_notebook_append_page_menu  (GtkNotebook *notebook,
129 130 131
				     GtkWidget   *child,
				     GtkWidget   *tab_label,
				     GtkWidget   *menu_label);
132
gint gtk_notebook_prepend_page      (GtkNotebook *notebook,
133 134
				     GtkWidget   *child,
				     GtkWidget   *tab_label);
135
gint gtk_notebook_prepend_page_menu (GtkNotebook *notebook,
136 137 138
				     GtkWidget   *child,
				     GtkWidget   *tab_label,
				     GtkWidget   *menu_label);
139
gint gtk_notebook_insert_page       (GtkNotebook *notebook,
140 141 142
				     GtkWidget   *child,
				     GtkWidget   *tab_label,
				     gint         position);
143
gint gtk_notebook_insert_page_menu  (GtkNotebook *notebook,
144 145 146 147 148 149 150 151 152 153 154
				     GtkWidget   *child,
				     GtkWidget   *tab_label,
				     GtkWidget   *menu_label,
				     gint         position);
void gtk_notebook_remove_page       (GtkNotebook *notebook,
				     gint         page_num);

/***********************************************************
 *            query, set current NoteebookPage             *
 ***********************************************************/

155 156 157
gint       gtk_notebook_get_current_page (GtkNotebook *notebook);
GtkWidget* gtk_notebook_get_nth_page     (GtkNotebook *notebook,
					  gint         page_num);
158
gint       gtk_notebook_get_n_pages      (GtkNotebook *notebook);
159 160
gint       gtk_notebook_page_num         (GtkNotebook *notebook,
					  GtkWidget   *child);
161
void       gtk_notebook_set_current_page (GtkNotebook *notebook,
162 163 164
					  gint         page_num);
void       gtk_notebook_next_page        (GtkNotebook *notebook);
void       gtk_notebook_prev_page        (GtkNotebook *notebook);
165 166 167 168 169

/***********************************************************
 *            set Notebook, NotebookTab style              *
 ***********************************************************/

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
void     gtk_notebook_set_show_border      (GtkNotebook     *notebook,
					    gboolean         show_border);
gboolean gtk_notebook_get_show_border      (GtkNotebook     *notebook);
void     gtk_notebook_set_show_tabs        (GtkNotebook     *notebook,
					    gboolean         show_tabs);
gboolean gtk_notebook_get_show_tabs        (GtkNotebook     *notebook);
void     gtk_notebook_set_tab_pos          (GtkNotebook     *notebook,
				            GtkPositionType  pos);
GtkPositionType gtk_notebook_get_tab_pos   (GtkNotebook     *notebook);

#ifndef GTK_DISABLE_DEPRECATED
void     gtk_notebook_set_homogeneous_tabs (GtkNotebook     *notebook,
					    gboolean         homogeneous);
void     gtk_notebook_set_tab_border       (GtkNotebook     *notebook,
					    guint            border_width);
void     gtk_notebook_set_tab_hborder      (GtkNotebook     *notebook,
					    guint            tab_hborder);
void     gtk_notebook_set_tab_vborder      (GtkNotebook     *notebook,
					    guint            tab_vborder);
#endif /* GTK_DISABLE_DEPRECATED */

void     gtk_notebook_set_scrollable       (GtkNotebook     *notebook,
					    gboolean         scrollable);
gboolean gtk_notebook_get_scrollable       (GtkNotebook     *notebook);
194 195 196 197 198 199 200 201 202 203 204 205

/***********************************************************
 *               enable/disable PopupMenu                  *
 ***********************************************************/

void gtk_notebook_popup_enable  (GtkNotebook *notebook);
void gtk_notebook_popup_disable (GtkNotebook *notebook);

/***********************************************************
 *             query/set NotebookPage Properties           *
 ***********************************************************/

206
GtkWidget * gtk_notebook_get_tab_label    (GtkNotebook *notebook,
207 208 209 210 211 212
					   GtkWidget   *child);
void gtk_notebook_set_tab_label           (GtkNotebook *notebook,
					   GtkWidget   *child,
					   GtkWidget   *tab_label);
void gtk_notebook_set_tab_label_text      (GtkNotebook *notebook,
					   GtkWidget   *child,
213
					   const gchar *tab_text);
214 215
G_CONST_RETURN gchar *gtk_notebook_get_tab_label_text (GtkNotebook *notebook,
						       GtkWidget   *child);
216
GtkWidget * gtk_notebook_get_menu_label   (GtkNotebook *notebook,
217 218 219 220 221 222
					   GtkWidget   *child);
void gtk_notebook_set_menu_label          (GtkNotebook *notebook,
					   GtkWidget   *child,
					   GtkWidget   *menu_label);
void gtk_notebook_set_menu_label_text     (GtkNotebook *notebook,
					   GtkWidget   *child,
223
					   const gchar *menu_text);
224 225
G_CONST_RETURN gchar *gtk_notebook_get_menu_label_text (GtkNotebook *notebook,
							GtkWidget   *child);
226 227 228 229 230 231 232 233 234 235 236 237 238
void gtk_notebook_query_tab_label_packing (GtkNotebook *notebook,
					   GtkWidget   *child,
					   gboolean    *expand,
					   gboolean    *fill,
					   GtkPackType *pack_type);
void gtk_notebook_set_tab_label_packing   (GtkNotebook *notebook,
					   GtkWidget   *child,
					   gboolean     expand,
					   gboolean     fill,
					   GtkPackType  pack_type);
void gtk_notebook_reorder_child           (GtkNotebook *notebook,
					   GtkWidget   *child,
					   gint         position);
Elliot Lee's avatar
Elliot Lee committed
239

240 241
#ifndef GTK_DISABLE_DEPRECATED
#define	gtk_notebook_current_page               gtk_notebook_get_current_page
242
#define gtk_notebook_set_page                   gtk_notebook_set_current_page
243 244
#endif /* GTK_DISABLE_DEPRECATED */

Elliot Lee's avatar
Elliot Lee committed
245 246 247 248 249 250
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_NOTEBOOK_H__ */