CodeSlayerNotebookTab

CodeSlayerNotebookTab — The notebook page label.

Synopsis

#include <codeslayer/codeslayer-notebook-tab.h>

struct              CodeSlayerNotebookTab;
GtkWidget *         codeslayer_notebook_tab_new         (GtkWidget *notebook,
                                                         const gchar *name);
void                codeslayer_notebook_tab_show_buffer_dirty
                                                        (CodeSlayerNotebookTab *notebook_tab);
void                codeslayer_notebook_tab_show_buffer_clean
                                                        (CodeSlayerNotebookTab *notebook_tab);
GtkWidget *         codeslayer_notebook_tab_get_notebook_page
                                                        (CodeSlayerNotebookTab *notebook_tab);
void                codeslayer_notebook_tab_set_notebook_page
                                                        (CodeSlayerNotebookTab *notebook_tab,
                                                         GtkWidget *notebook_page);
void                codeslayer_notebook_tab_set_label_name
                                                        (CodeSlayerNotebookTab *notebook_tab,
                                                         gchar *name);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GtkHBox
                                 +----CodeSlayerNotebookTab

Implemented Interfaces

CodeSlayerNotebookTab implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Properties

  "notebook-page"            gpointer              : Read / Write

Signals

  "close-all-documents"                            : No Hooks
  "close-document"                                 : No Hooks
  "close-left-documents"                           : No Hooks
  "close-other-documents"                          : No Hooks
  "close-right-documents"                          : No Hooks
  "select-document"                                : No Hooks

Description

The tab is appended to the notebook page as a way to give the page a label. This label can also communicate whether or not the document needs to be saved. The tab itself allows a page to be closed.

Details

struct CodeSlayerNotebookTab

struct CodeSlayerNotebookTab;

codeslayer_notebook_tab_new ()

GtkWidget *         codeslayer_notebook_tab_new         (GtkWidget *notebook,
                                                         const gchar *name);

Creates a new CodeSlayerNotebookTab.

notebook :

a GtkWidget.

name :

the display name for the tab is the file name.

Returns :

a new CodeSlayerNotebookTab.

codeslayer_notebook_tab_show_buffer_dirty ()

void                codeslayer_notebook_tab_show_buffer_dirty
                                                        (CodeSlayerNotebookTab *notebook_tab);

The tab label needs to be show that the document needs to be saved.

notebook_tab :

a CodeSlayerNotebookTab.

codeslayer_notebook_tab_show_buffer_clean ()

void                codeslayer_notebook_tab_show_buffer_clean
                                                        (CodeSlayerNotebookTab *notebook_tab);

The tab label needs to be show that the document no longer needs to be saved.

notebook_tab :

a CodeSlayerNotebookTab.

codeslayer_notebook_tab_get_notebook_page ()

GtkWidget *         codeslayer_notebook_tab_get_notebook_page
                                                        (CodeSlayerNotebookTab *notebook_tab);

notebook_tab :

a CodeSlayerNotebookTab.

Returns :

the notebook page contained with the tab.

codeslayer_notebook_tab_set_notebook_page ()

void                codeslayer_notebook_tab_set_notebook_page
                                                        (CodeSlayerNotebookTab *notebook_tab,
                                                         GtkWidget *notebook_page);

notebook_tab :

a CodeSlayerNotebookTab.

notebook_page :

a CodeSlayerNotebookPage.

codeslayer_notebook_tab_set_label_name ()

void                codeslayer_notebook_tab_set_label_name
                                                        (CodeSlayerNotebookTab *notebook_tab,
                                                         gchar *name);

Change the label name of the tab.

notebook_tab :

a CodeSlayerNotebookTab.

name :

the display name for the tab is the file name.

Property Details

The "notebook-page" property

  "notebook-page"            gpointer              : Read / Write

A CodeSlayerNotebookPage.

Signal Details

The "close-all-documents" signal

void                user_function                      (CodeSlayerNotebookTab *codeslayernotebooktab,
                                                        gpointer               user_data)                  : No Hooks

The ::close-all-documents signal is a request to close all the documents.

codeslayernotebooktab :

the tab that received the signal

user_data :

user data set when the signal handler was connected.

The "close-document" signal

void                user_function                      (CodeSlayerNotebookTab *codeslayernotebooktab,
                                                        gpointer               user_data)                  : No Hooks

The ::close-document signal is a request to close the active document.

codeslayernotebooktab :

the tab that received the signal

user_data :

user data set when the signal handler was connected.

The "close-left-documents" signal

void                user_function                      (CodeSlayerNotebookTab *codeslayernotebooktab,
                                                        gpointer               user_data)                  : No Hooks

The ::close-left-documents signal is a request to close all documents to the left of the active one.

codeslayernotebooktab :

the tab that received the signal

user_data :

user data set when the signal handler was connected.

The "close-other-documents" signal

void                user_function                      (CodeSlayerNotebookTab *codeslayernotebooktab,
                                                        gpointer               user_data)                  : No Hooks

The ::close-other-documents signal is a request to close all documents except the active one.

codeslayernotebooktab :

the tab that received the signal

user_data :

user data set when the signal handler was connected.

The "close-right-documents" signal

void                user_function                      (CodeSlayerNotebookTab *codeslayernotebooktab,
                                                        gpointer               user_data)                  : No Hooks

The ::close-right-documents signal is a request to close all documents to the right of the active one.

codeslayernotebooktab :

the tab that received the signal

user_data :

user data set when the signal handler was connected.

The "select-document" signal

void                user_function                      (CodeSlayerNotebookTab *codeslayernotebooktab,
                                                        gpointer               user_data)                  : No Hooks

The ::select-document signal is a request to close the active document.

codeslayernotebooktab :

the tab that received the signal

user_data :

user data set when the signal handler was connected.