/* -*- Mode: C; c-file-style: "gnu"; tab-width: 8 -*- */

/* 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

 * modify it under the terms of the GNU Lesser General Public

 * 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

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the

 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

/*

 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS

 * 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/.

 */

#ifndef __GTK_NOTEBOOK_H__

#define __GTK_NOTEBOOK_H__

#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)

#error "Only <gtk/gtk.h> can be included directly."

#endif

#include <gtk/gtkcontainer.h>

G_BEGIN_DECLS

#define GTK_TYPE_NOTEBOOK                  (gtk_notebook_get_type ())

#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))

typedef enum

{

  GTK_NOTEBOOK_TAB_FIRST,

  GTK_NOTEBOOK_TAB_LAST

} GtkNotebookTab;

typedef struct _GtkNotebook       GtkNotebook;

typedef struct _GtkNotebookClass  GtkNotebookClass;

#if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)

typedef struct _GtkNotebookPage   GtkNotebookPage;

#endif

struct _GtkNotebook

{

  GtkContainer container;

#if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)

  GtkNotebookPage *GSEAL (cur_page);

#else

  gpointer GSEAL (cur_page);

#endif

  GList *GSEAL (children);

  GList *GSEAL (first_tab);		/* The first tab visible (for scrolling notebooks) */

  GList *GSEAL (focus_tab);

  GtkWidget *GSEAL (menu);

  GdkWindow *GSEAL (event_window);

  guint32 GSEAL (timer);

  guint16 GSEAL (tab_hborder);

  guint16 GSEAL (tab_vborder);

  guint GSEAL (show_tabs)          : 1;

  guint GSEAL (homogeneous)        : 1;

  guint GSEAL (show_border)        : 1;

  guint GSEAL (tab_pos)            : 2;

  guint GSEAL (scrollable)         : 1;

  guint GSEAL (in_child)           : 3;

  guint GSEAL (click_child)        : 3;

  guint GSEAL (button)             : 2;

  guint GSEAL (need_timer)         : 1;

  guint GSEAL (child_has_focus)    : 1;

  guint GSEAL (have_visible_child) : 1;

  guint GSEAL (focus_out)          : 1;	/* Flag used by ::move-focus-out implementation */

  guint GSEAL (has_before_previous) : 1;

  guint GSEAL (has_before_next)     : 1;

  guint GSEAL (has_after_previous)  : 1;

  guint GSEAL (has_after_next)      : 1;

};

struct _GtkNotebookClass

{

  GtkContainerClass parent_class;

  void (* switch_page)       (GtkNotebook     *notebook,

#if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)

                              GtkNotebookPage *page,

#else

                              gpointer         page,

#endif

			      guint            page_num);

  /* Action signals for keybindings */

  gboolean (* select_page)     (GtkNotebook       *notebook,

                                gboolean           move_focus);

  gboolean (* focus_tab)       (GtkNotebook       *notebook,

                                GtkNotebookTab     type);

  gboolean (* change_current_page) (GtkNotebook   *notebook,

                                gint               offset);

  void (* move_focus_out)      (GtkNotebook       *notebook,

				GtkDirectionType   direction);

  gboolean (* reorder_tab)     (GtkNotebook       *notebook,

				GtkDirectionType   direction,

				gboolean           move_to_last);

  /* More vfuncs */

  gint (* insert_page)         (GtkNotebook       *notebook,

			        GtkWidget         *child,

				GtkWidget         *tab_label,

				GtkWidget         *menu_label,

				gint               position);

  GtkNotebook * (* create_window) (GtkNotebook       *notebook,

                                   GtkWidget         *page,

                                   gint               x,

                                   gint               y);

  void (*_gtk_reserved1) (void);

};

typedef GtkNotebook* (*GtkNotebookWindowCreationFunc) (GtkNotebook *source,

                                                       GtkWidget   *page,

                                                       gint         x,

                                                       gint         y,

                                                       gpointer     data);

/***********************************************************

 *           Creation, insertion, deletion                 *

 ***********************************************************/

GType   gtk_notebook_get_type       (void) G_GNUC_CONST;

GtkWidget * gtk_notebook_new        (void);

gint gtk_notebook_append_page       (GtkNotebook *notebook,

				     GtkWidget   *child,

				     GtkWidget   *tab_label);

gint gtk_notebook_append_page_menu  (GtkNotebook *notebook,

				     GtkWidget   *child,

				     GtkWidget   *tab_label,

				     GtkWidget   *menu_label);

gint gtk_notebook_prepend_page      (GtkNotebook *notebook,

				     GtkWidget   *child,

				     GtkWidget   *tab_label);

gint gtk_notebook_prepend_page_menu (GtkNotebook *notebook,

				     GtkWidget   *child,

				     GtkWidget   *tab_label,

				     GtkWidget   *menu_label);

gint gtk_notebook_insert_page       (GtkNotebook *notebook,

				     GtkWidget   *child,

				     GtkWidget   *tab_label,

				     gint         position);

gint gtk_notebook_insert_page_menu  (GtkNotebook *notebook,

				     GtkWidget   *child,

				     GtkWidget   *tab_label,

				     GtkWidget   *menu_label,

				     gint         position);

void gtk_notebook_remove_page       (GtkNotebook *notebook,

				     gint         page_num);

/***********************************************************

 *           Tabs drag and drop                            *

 ***********************************************************/

#ifndef GTK_DISABLE_DEPRECATED

void gtk_notebook_set_window_creation_hook (GtkNotebookWindowCreationFunc  func,

					    gpointer                       data,

                                            GDestroyNotify                 destroy);

void gtk_notebook_set_group_id             (GtkNotebook *notebook,

					    gint         group_id);

gint gtk_notebook_get_group_id             (GtkNotebook *notebook);

void gtk_notebook_set_group                (GtkNotebook *notebook,

					    gpointer     group);

gpointer gtk_notebook_get_group            (GtkNotebook *notebook);

#endif /* GTK_DISABLE_DEPRECATED */

void         gtk_notebook_set_group_name   (GtkNotebook *notebook,

                                            const gchar *group_name);

const gchar *gtk_notebook_get_group_name   (GtkNotebook *notebook);

/***********************************************************

 *            query, set current NotebookPage              *

 ***********************************************************/

gint       gtk_notebook_get_current_page (GtkNotebook *notebook);

GtkWidget* gtk_notebook_get_nth_page     (GtkNotebook *notebook,

					  gint         page_num);

gint       gtk_notebook_get_n_pages      (GtkNotebook *notebook);

gint       gtk_notebook_page_num         (GtkNotebook *notebook,

					  GtkWidget   *child);

void       gtk_notebook_set_current_page (GtkNotebook *notebook,

					  gint         page_num);

void       gtk_notebook_next_page        (GtkNotebook *notebook);

void       gtk_notebook_prev_page        (GtkNotebook *notebook);

/***********************************************************

 *            set Notebook, NotebookTab style              *

 ***********************************************************/

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);

guint16  gtk_notebook_get_tab_hborder      (GtkNotebook     *notebook);

guint16  gtk_notebook_get_tab_vborder      (GtkNotebook     *notebook);

/***********************************************************

 *               enable/disable PopupMenu                  *

 ***********************************************************/

void gtk_notebook_popup_enable  (GtkNotebook *notebook);

void gtk_notebook_popup_disable (GtkNotebook *notebook);

/***********************************************************

 *             query/set NotebookPage Properties           *

 ***********************************************************/

GtkWidget * gtk_notebook_get_tab_label    (GtkNotebook *notebook,

					   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,

					   const gchar *tab_text);

const gchar *gtk_notebook_get_tab_label_text (GtkNotebook *notebook,

                                              GtkWidget   *child);

GtkWidget * gtk_notebook_get_menu_label   (GtkNotebook *notebook,

					   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,

					   const gchar *menu_text);

const gchar *gtk_notebook_get_menu_label_text (GtkNotebook *notebook,

                                               GtkWidget   *child);

#ifndef GTK_DISABLE_DEPRECATED

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);

#endif

void gtk_notebook_reorder_child           (GtkNotebook *notebook,

					   GtkWidget   *child,

					   gint         position);

gboolean gtk_notebook_get_tab_reorderable (GtkNotebook *notebook,

					   GtkWidget   *child);

void gtk_notebook_set_tab_reorderable     (GtkNotebook *notebook,

					   GtkWidget   *child,

					   gboolean     reorderable);

gboolean gtk_notebook_get_tab_detachable  (GtkNotebook *notebook,

					   GtkWidget   *child);

void gtk_notebook_set_tab_detachable      (GtkNotebook *notebook,

					   GtkWidget   *child,

					   gboolean     detachable);

GtkWidget* gtk_notebook_get_action_widget (GtkNotebook *notebook,

                                           GtkPackType  pack_type);

void       gtk_notebook_set_action_widget (GtkNotebook *notebook,

                                           GtkWidget   *widget,

                                           GtkPackType  pack_type);

#ifndef GTK_DISABLE_DEPRECATED

#define	gtk_notebook_current_page               gtk_notebook_get_current_page

#define gtk_notebook_set_page                   gtk_notebook_set_current_page

#endif /* GTK_DISABLE_DEPRECATED */

G_END_DECLS

#endif /* __GTK_NOTEBOOK_H__ */