Top | ![]() |
![]() |
![]() |
![]() |
IdeGridIdeGrid — A grid for IdePage |
IdeGridColumn * | current-column | Read / Write |
IdePage * | current-page | Read |
IdeFrame * | current-stack | Read |
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── DzlMultiPaned ╰── IdeGrid
IdeGrid implements AtkImplementorIface, GtkBuildable, GtkOrientable and GListModel.
The IdeGrid provides a grid of pages that the user may manipulate.
Internally, this is implemented with IdeGrid at the top containing one or more of IdeGridColumn. Those columns contain one or more IdeFrame. The stack can contain many IdePage.
IdeGrid implements the GListModel interface to simplify
the process of listing (with deduplication) the pages that are
contianed within the IdeGrid. If you would instead like
to see all possible pages in the stack, use the
ide_grid_foreach_page()
API.
IdeGridColumn * ide_grid_get_nth_column (IdeGrid *self
,gint nth
);
Gets the nth
column from the grid.
If nth
is -1, then a new column at the beginning of the
grid is created.
If nth
is >= the number of columns in the grid, then a new
column at the end of the grid is created.
Since: 3.32
IdePage * ide_grid_focus_neighbor (IdeGrid *self
,GtkDirectionType dir
);
Attempts to focus a neighbor IdePage in the grid based on the direction requested.
If an IdePage was focused, it will be returned to the caller.
Since: 3.32
IdeGridColumn *
ide_grid_get_current_column (IdeGrid *self
);
Gets the most recently focused column of the grid.
Since: 3.32
void ide_grid_set_current_column (IdeGrid *self
,IdeGridColumn *column
);
Sets the current column for the grid. Generally this is automatically updated for you when the focus changes within the workbench.
column
can be NULL
out of convenience.
Since: 3.32
IdeFrame *
ide_grid_get_current_stack (IdeGrid *self
);
Gets the most recently focused stack. This is useful when you want to open a document on the stack the user last focused.
Since: 3.32
IdePage *
ide_grid_get_current_page (IdeGrid *self
);
Gets the most recent page used by the user as determined by tracking the window focus.
Since: 3.32
void ide_grid_foreach_page (IdeGrid *self
,GtkCallback callback
,gpointer user_data
);
This function will call callback
for every page found in self
.
self |
a IdeGrid |
|
callback |
A callback for each page. |
[scope call][closure user_data] |
user_data |
user data for |
Since: 3.32
struct IdeGridClass { DzlMultiPanedClass parent_class; IdeFrame *(*create_frame) (IdeGrid *self); IdePage *(*create_page) (IdeGrid *self, const gchar *uri); };
“current-column”
property“current-column” IdeGridColumn *
The most recently focused grid column.
Owner: IdeGrid
Flags: Read / Write
“current-page”
property“current-page” IdePage *
The most recently focused IdePage.
Owner: IdeGrid
Flags: Read
“current-stack”
property“current-stack” IdeFrame *
The most recently focused IdeFrame.
Owner: IdeGrid
Flags: Read
“create-page”
signalIdePage* user_function (IdeGrid *self, gchar *uri, gpointer user_data)
Creates a new page for uri
to be added to the grid.
self |
an IdeGrid |
|
uri |
the URI to open |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.32