GeditNotebook

GeditNotebook

Synopsis

                    GeditNotebookPrivate;
                    GeditNotebook;
GtkWidget *         gedit_notebook_new                  (void);
void                gedit_notebook_add_tab              (GeditNotebook *nb,
                                                         GeditTab *tab,
                                                         gint position,
                                                         gboolean jump_to);
void                gedit_notebook_remove_tab           (GeditNotebook *nb,
                                                         GeditTab *tab);
void                gedit_notebook_remove_all_tabs      (GeditNotebook *nb);
void                gedit_notebook_reorder_tab          (GeditNotebook *src,
                                                         GeditTab *tab,
                                                         gint dest_position);
void                gedit_notebook_move_tab             (GeditNotebook *src,
                                                         GeditNotebook *dest,
                                                         GeditTab *tab,
                                                         gint dest_position);
void                gedit_notebook_set_always_show_tabs (GeditNotebook *nb,
                                                         gboolean show_tabs);
void                gedit_notebook_set_close_buttons_sensitive
                                                        (GeditNotebook *nb,
                                                         gboolean sensitive);
gboolean            gedit_notebook_get_close_buttons_sensitive
                                                        (GeditNotebook *nb);
void                gedit_notebook_set_tab_drag_and_drop_enabled
                                                        (GeditNotebook *nb,
                                                         gboolean enable);
gboolean            gedit_notebook_get_tab_drag_and_drop_enabled
                                                        (GeditNotebook *nb);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkNotebook
                                 +----GeditNotebook

Implemented Interfaces

GeditNotebook implements AtkImplementorIface and GtkBuildable.

Signals

  "tab-added"                                      : Run First
  "tab-close-request"                              : Run Last
  "tab-detached"                                   : Run First
  "tab-removed"                                    : Run First
  "tabs-reordered"                                 : Run First

Description

Details

GeditNotebookPrivate

typedef struct _GeditNotebookPrivate GeditNotebookPrivate;

GeditNotebook

typedef struct _GeditNotebook GeditNotebook;

gedit_notebook_new ()

GtkWidget *         gedit_notebook_new                  (void);

Creates a new GeditNotebook object.

Returns :

 a new GeditNotebook

gedit_notebook_add_tab ()

void                gedit_notebook_add_tab              (GeditNotebook *nb,
                                                         GeditTab *tab,
                                                         gint position,
                                                         gboolean jump_to);

Adds the specified tab to the nb.

nb :

 a GeditNotebook

tab :

 a GeditTab

position :

 the position where the tab should be added

jump_to :

 TRUE to set the tab as active

gedit_notebook_remove_tab ()

void                gedit_notebook_remove_tab           (GeditNotebook *nb,
                                                         GeditTab *tab);

Removes tab from nb.

nb :

 a GeditNotebook

tab :

 a GeditTab

gedit_notebook_remove_all_tabs ()

void                gedit_notebook_remove_all_tabs      (GeditNotebook *nb);

Removes all GeditTab from nb.

nb :

 a GeditNotebook

gedit_notebook_reorder_tab ()

void                gedit_notebook_reorder_tab          (GeditNotebook *src,
                                                         GeditTab *tab,
                                                         gint dest_position);

Reorders the page containing tab, so that it appears in dest_position position. If dest_position is greater than or equal to the number of tabs of the destination notebook or negative, tab will be moved to the end of the tabs.

src :

 a GeditNotebook

tab :

 a GeditTab

dest_position :

 the position for tab

gedit_notebook_move_tab ()

void                gedit_notebook_move_tab             (GeditNotebook *src,
                                                         GeditNotebook *dest,
                                                         GeditTab *tab,
                                                         gint dest_position);

Moves tab from src to dest. If dest_position is greater than or equal to the number of tabs of the destination nootebook or negative, tab will be moved to the end of the tabs.

src :

 a GeditNotebook

dest :

 a GeditNotebook

tab :

 a GeditTab

dest_position :

 the position for tab

gedit_notebook_set_always_show_tabs ()

void                gedit_notebook_set_always_show_tabs (GeditNotebook *nb,
                                                         gboolean show_tabs);

Sets the visibility of the tabs in the nb.

nb :

 a GeditNotebook

show_tabs :

 TRUE to always show the tabs

gedit_notebook_set_close_buttons_sensitive ()

void                gedit_notebook_set_close_buttons_sensitive
                                                        (GeditNotebook *nb,
                                                         gboolean sensitive);

Sets whether the close buttons in the tabs of nb are sensitive.

nb :

 a GeditNotebook

sensitive :

 TRUE to make the buttons sensitive

gedit_notebook_get_close_buttons_sensitive ()

gboolean            gedit_notebook_get_close_buttons_sensitive
                                                        (GeditNotebook *nb);

Whether the close buttons are sensitive.

nb :

 a GeditNotebook

Returns :

 TRUE if the close buttons are sensitive

gedit_notebook_set_tab_drag_and_drop_enabled ()

void                gedit_notebook_set_tab_drag_and_drop_enabled
                                                        (GeditNotebook *nb,
                                                         gboolean enable);

Sets whether drag and drop of tabs in the nb is enabled.

nb :

 a GeditNotebook

enable :

 TRUE to enable the drag and drop

gedit_notebook_get_tab_drag_and_drop_enabled ()

gboolean            gedit_notebook_get_tab_drag_and_drop_enabled
                                                        (GeditNotebook *nb);

Whether the drag and drop is enabled in the nb.

nb :

 a GeditNotebook

Returns :

 TRUE if the drag and drop is enabled.

Signal Details

The "tab-added" signal

void                user_function                      (GeditNotebook *geditnotebook,
                                                        GeditTab      *arg1,
                                                        gpointer       user_data)          : Run First

geditnotebook :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

The "tab-close-request" signal

void                user_function                      (GeditNotebook *geditnotebook,
                                                        GeditTab      *arg1,
                                                        gpointer       user_data)          : Run Last

geditnotebook :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

The "tab-detached" signal

void                user_function                      (GeditNotebook *geditnotebook,
                                                        GeditTab      *arg1,
                                                        gpointer       user_data)          : Run First

geditnotebook :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

The "tab-removed" signal

void                user_function                      (GeditNotebook *geditnotebook,
                                                        GeditTab      *arg1,
                                                        gpointer       user_data)          : Run First

geditnotebook :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

The "tabs-reordered" signal

void                user_function                      (GeditNotebook *geditnotebook,
                                                        gpointer       user_data)          : Run First

geditnotebook :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.11