XedWindow

XedWindow

Functions

XedTab * xed_window_create_tab ()
XedTab * xed_window_create_tab_from_location ()
void xed_window_close_tab ()
void xed_window_close_all_tabs ()
void xed_window_close_tabs ()
XedTab * xed_window_get_active_tab ()
void xed_window_set_active_tab ()
XedView * xed_window_get_active_view ()
XedDocument * xed_window_get_active_document ()
GList * xed_window_get_documents ()
GList * xed_window_get_unsaved_documents ()
GList * xed_window_get_views ()
GtkWindowGroup * xed_window_get_group ()
XedPanel * xed_window_get_side_panel ()
XedPanel * xed_window_get_bottom_panel ()
GtkWidget * xed_window_get_statusbar ()
GtkUIManager * xed_window_get_ui_manager ()
XedWindowState xed_window_get_state ()
XedTab * xed_window_get_tab_from_location ()
XedMessageBus * xed_window_get_message_bus ()

Properties

XedWindowState state Read

Signals

void active-tab-changed Run First
void active-tab-state-changed Run First
void tab-added Run First
void tab-removed Run First
void tabs-reordered Run First

Types and Values

enum XedWindowState
  XedWindowPrivate
struct XedWindow

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── GtkWindow
                        ╰── GtkApplicationWindow
                            ╰── XedWindow

Implemented Interfaces

XedWindow implements AtkImplementorIface, GtkBuildable, GActionGroup and GActionMap.

Description

Functions

xed_window_create_tab ()

XedTab *
xed_window_create_tab (XedWindow *window,
                       gboolean jump_to);

Creates a new XedTab and adds the new tab to the XedNotebook. In case jump_to is TRUE the XedNotebook switches to that new XedTab.

Parameters

window

a XedWindow

  

jump_to

TRUE to set the new XedTab as active

  

Returns

a new XedTab.

[transfer none]

xed_window_create_tab_from_location ()

XedTab *
xed_window_create_tab_from_location (XedWindow *window,
                                     GFile *location,
                                     const GtkSourceEncoding *encoding,
                                     gint line_pos,
                                     gboolean create,
                                     gboolean jump_to);

Creates a new XedTab loading the document specified by uri . In case jump_to is TRUE the XedNotebook swithes to that new XedTab. Whether create is TRUE, creates a new empty document if location does not refer to an existing file

Parameters

window

a XedWindow

  

location

the location of the document

  

encoding

a GtkSourceEncoding.

[allow-none]

line_pos

the line position to visualize

  

create

TRUE to create a new document in case uri does exist

  

jump_to

TRUE to set the new XedTab as active

  

Returns

a new XedTab.

[transfer none]

xed_window_close_tab ()

void
xed_window_close_tab (XedWindow *window,
                      XedTab *tab);

Closes the tab .

Parameters

window

a XedWindow

  

tab

the XedTab to close

  

xed_window_close_all_tabs ()

void
xed_window_close_all_tabs (XedWindow *window);

Closes all opened tabs.

Parameters

window

a XedWindow

  

xed_window_close_tabs ()

void
xed_window_close_tabs (XedWindow *window,
                       const GList *tabs);

Closes all tabs specified by tabs .

Parameters

window

a XedWindow

  

tabs

a list of XedTab.

[element-type Xed.Tab]

xed_window_get_active_tab ()

XedTab *
xed_window_get_active_tab (XedWindow *window);

Gets the active XedTab in the window .

Parameters

window

a XedWindow

  

Returns

the active XedTab in the window .

[transfer none]

xed_window_set_active_tab ()

void
xed_window_set_active_tab (XedWindow *window,
                           XedTab *tab);

Switches to the tab that matches with tab .

Parameters

window

a XedWindow

  

tab

a XedTab

  

xed_window_get_active_view ()

XedView *
xed_window_get_active_view (XedWindow *window);

Gets the active XedView.

Parameters

window

a XedWindow

  

Returns

the active XedView.

[transfer none]

xed_window_get_active_document ()

XedDocument *
xed_window_get_active_document (XedWindow *window);

Gets the active XedDocument.

Parameters

window

a XedWindow

  

Returns

the active XedDocument.

[transfer none]

xed_window_get_documents ()

GList *
xed_window_get_documents (XedWindow *window);

Gets a newly allocated list with all the documents in the window. This list must be freed.

Parameters

window

a XedWindow

  

Returns

a newly allocated list with all the documents in the window.

[element-type Xed.Document][transfer container]

xed_window_get_unsaved_documents ()

GList *
xed_window_get_unsaved_documents (XedWindow *window);

Gets the list of documents that need to be saved before closing the window.

Parameters

window

a XedWindow

  

Returns

a list of XedDocument that need to be saved before closing the window.

[element-type Xed.Document][transfer container]

xed_window_get_views ()

GList *
xed_window_get_views (XedWindow *window);

Gets a list with all the views in the window. This list must be freed.

Parameters

window

a XedWindow

  

Returns

a newly allocated list with all the views in the window.

[element-type Xed.View][transfer container]

xed_window_get_group ()

GtkWindowGroup *
xed_window_get_group (XedWindow *window);

Gets the GtkWindowGroup in which window resides.

Parameters

window

a XedWindow

  

Returns

the GtkWindowGroup.

[transfer none]

xed_window_get_side_panel ()

XedPanel *
xed_window_get_side_panel (XedWindow *window);

Gets the side XedPanel of the window .

Parameters

window

a XedWindow

  

Returns

the side XedPanel.

[transfer none]

xed_window_get_bottom_panel ()

XedPanel *
xed_window_get_bottom_panel (XedWindow *window);

Gets the bottom XedPanel of the window .

Parameters

window

a XedWindow

  

Returns

the bottom XedPanel.

[transfer none]

xed_window_get_statusbar ()

GtkWidget *
xed_window_get_statusbar (XedWindow *window);

Gets the XedStatusbar of the window .

Parameters

window

a XedWindow

  

Returns

the XedStatusbar of the window .

[transfer none]

xed_window_get_ui_manager ()

GtkUIManager *
xed_window_get_ui_manager (XedWindow *window);

Gets the GtkUIManager associated with the window .

Parameters

window

a XedWindow

  

Returns

the GtkUIManager of the window .

[transfer none]

xed_window_get_state ()

XedWindowState
xed_window_get_state (XedWindow *window);

Retrieves the state of the window .

Parameters

window

a XedWindow

  

Returns

the current XedWindowState of the window .

xed_window_get_tab_from_location ()

XedTab *
xed_window_get_tab_from_location (XedWindow *window,
                                  GFile *location);

Gets the XedTab that matches with the given location .

Parameters

window

a XedWindow

  

location

a GFile

  

Returns

the XedTab that matches with the given location .

[transfer none]

xed_window_get_message_bus ()

XedMessageBus *
xed_window_get_message_bus (XedWindow *window);

Gets the XedMessageBus associated with window . The returned reference is owned by the window and should not be unreffed.

Parameters

window

a XedWindow

  

Returns

the XedMessageBus associated with window .

[transfer none]

Types and Values

enum XedWindowState

Members

XED_WINDOW_STATE_NORMAL

    

XED_WINDOW_STATE_SAVING

    

XED_WINDOW_STATE_PRINTING

    

XED_WINDOW_STATE_LOADING

    

XED_WINDOW_STATE_ERROR

    

XED_WINDOW_STATE_SAVING_SESSION

    

XedWindowPrivate

typedef struct _XedWindowPrivate XedWindowPrivate;

struct XedWindow

struct XedWindow;

Property Details

The “state” property

  “state”                    XedWindowState

The window's state.

Owner: XedWindow

Flags: Read

Signal Details

The “active-tab-changed” signal

void
user_function (XedWindow *xedwindow,
               XedTab    *arg1,
               gpointer   user_data)

Flags: Run First

The “active-tab-state-changed” signal

void
user_function (XedWindow *xedwindow,
               gpointer   user_data)

Flags: Run First

The “tab-added” signal

void
user_function (XedWindow *xedwindow,
               XedTab    *arg1,
               gpointer   user_data)

Flags: Run First

The “tab-removed” signal

void
user_function (XedWindow *xedwindow,
               XedTab    *arg1,
               gpointer   user_data)

Flags: Run First

The “tabs-reordered” signal

void
user_function (XedWindow *xedwindow,
               gpointer   user_data)

Flags: Run First

Generated by GTK-Doc V1.33.1