Class
CasildaCompositor
Description [src]
final class Casilda.Compositor : Gtk.Widget
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Scrollable {
/* No available fields */
}
A simple Wayland compositor widget for Gtk 4.
It was originally created for Cambalache’s workspace using (wlroots)[https://gitlab.freedesktop.org/wlroots/wlroots], a modular library to create Wayland compositors.
Following Wayland tradition, this library is named after my hometown in Santa Fe, Argentina.
To embed another process window in your Gtk 4 application all you have to do is create a CasildaCompositor widget and add it in the hierarchy just like any other widget.
You can specify which UNIX socket the compositor will listen for clients connections or use
casilda_compositor_get_client_socket_fd() to get a already connected socket to the compositor.
compositor = casilda_compositor_new ("/tmp/casilda-example.sock");
gtk_window_set_child (GTK_WINDOW (window), GTK_WIDGET (compositor));
Once the compositor is running you can connect to it by specifying the socket in WAYLAND_DISPLAY environment variable.
export GDK_BACKEND=wayland
export WAYLAND_DISPLAY=/tmp/casilda-example.sock
gtk4-demo
If you do not want any client being able to connect to the compositor you can pass NULL as socket and spawn the client
with casilda_compositor_spawn_async() or get an already connected socket with
casilda_compositor_get_client_socket_fd() and pass it to the client on WAYLAND_SOCKET env variable.
compositor = casilda_compositor_new (NULL);
gtk_window_set_child (GTK_WINDOW (window), GTK_WIDGET (compositor));
gtk_window_present (GTK_WINDOW (window));
gchar *argv[] = { "/usr/bin/gtk4-demo", NULL };
casilda_compositor_spawn_async (compositor, NULL, argv, NULL, G_SPAWN_DEFAULT, NULL, NULL, NULL, NULL);
Python example running gtk4-demo with casilda_compositor_spawn_async()
import gi
import sys
gi.require_version("Gtk", "4.0")
gi.require_version("Casilda", "1.0")
from gi.repository import GLib, Gtk, Casilda
class CasildaApplication(Gtk.Application):
def __init__(self):
super().__init__(application_id="ar.xjuan.casilda.PyGObject.Example")
def do_activate(self):
compositor = Casilda.Compositor()
window = Gtk.ApplicationWindow(
application=self,
title="Casilda Compositor",
default_width=800,
default_height=600,
child=compositor
)
compositor.spawn_async (
None,
["/usr/bin/gtk4-demo"],
None,
GLib.SpawnFlags.DEFAULT
)
window.present()
if __name__ == "__main__":
app = CasildaApplication()
sys.exit(app.run(sys.argv))
and the same in Javascript:
import System from 'system';
import GLib from 'gi://GLib';
import GObject from 'gi://GObject';
import Gtk from 'gi://Gtk?version=4.0';
import Casilda from 'gi://Casilda?version=1.0';
let CasildaApplication = GObject.registerClass({},
class CasildaApplication extends Gtk.Application {
constructor() {
super({
application_id: 'ar.xjuan.casilda.Gjs.Example'
});
}
vfunc_activate() {
let compositor = new Casilda.Compositor();
let window = new Gtk.ApplicationWindow({
application: this,
title: 'Casilda Compositor',
default_width: 800,
default_height: 600,
child: compositor
});
window.connect('close-request', () => {
this.quit();
});
compositor.spawn_async (
null,
["/usr/bin/gtk4-demo"],
null,
GLib.SpawnFlags.DEFAULT,
null
);
window.present();
}
});
let app = new CasildaApplication();
app.run([System.programInvocationName].concat(ARGV));
Constructors
casilda_compositor_new
Create a new CasildaCompositor widget using socket as the name of the Wayland socket.
Clients can connect to the compositor by setting WAYLAND_DISPLAY=socket.
Instance methods
casilda_compositor_get_client_socket_fd
Create a client socket file descriptor connected to this compositor ready to use by passing it to a client with WAYLAND_SOCKET environment variable. Once the returned FD is passed to the client it must be closed on the parent otherwise the client windows wont get destroyed if the client looses the connection to the server.
casilda_compositor_spawn_async
Executes a child program asynchronously with the right environment to automatically connect to this compositor.
Methods inherited from GtkAccessible (20)
gtk_accessible_announce
Requests the user’s screen reader to announce the given message.
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
gtk_accessible_get_at_context
Retrieves the implementation for the given accessible object.
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
gtk_accessible_get_platform_state
Queries a platform state, such as focus.
gtk_accessible_reset_property
Resets the accessible property to its default value.
gtk_accessible_reset_relation
Resets the accessible relation to its default value.
gtk_accessible_reset_state
Resets the accessible state to its default value.
gtk_accessible_set_accessible_parent
Sets the parent and sibling of an accessible object.
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling.
gtk_accessible_update_platform_state
Informs ATs that the platform state has changed.
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable object.
Methods inherited from GtkScrollable (9)
gtk_scrollable_get_border
Returns the size of a non-scrolling border around the outside of the scrollable.
gtk_scrollable_get_hadjustment
Retrieves the GtkAdjustment used for horizontal scrolling.
gtk_scrollable_get_hscroll_policy
Gets the horizontal GtkScrollablePolicy.
gtk_scrollable_get_vadjustment
Retrieves the GtkAdjustment used for vertical scrolling.
gtk_scrollable_get_vscroll_policy
Gets the vertical GtkScrollablePolicy.
gtk_scrollable_set_hadjustment
Sets the horizontal adjustment of the GtkScrollable.
gtk_scrollable_set_hscroll_policy
Sets the GtkScrollablePolicy.
gtk_scrollable_set_vadjustment
Sets the vertical adjustment of the GtkScrollable.
gtk_scrollable_set_vscroll_policy
Sets the GtkScrollablePolicy.
Properties
Properties inherited from GtkWidget (35)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the GtkWidget::query-tooltip
signal on widget.
Gtk.Widget:height-request
Overrides for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand property.
Gtk.Widget:layout-manager
The GtkLayoutManager instance to use to compute
the preferred size of the widget, and allocate its children.
Gtk.Widget:limit-events
Makes this widget act like a modal dialog, with respect to event delivery.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Overrides for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible implementation.
Properties inherited from GtkScrollable (4)
Gtk.Scrollable:hadjustment
Horizontal GtkAdjustment of the scrollable widget.
Gtk.Scrollable:hscroll-policy
Determines when horizontal scrolling should start.
Gtk.Scrollable:vadjustment
Vertical GtkAdjustment of the scrollable widget.
Gtk.Scrollable:vscroll-policy
Determines when vertical scrolling should start.
Signals
Signals inherited from GtkWidget (13)
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
GtkWidget::hide
Emitted when widget is hidden.
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
GtkWidget::map
Emitted when widget is going to be mapped.
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
GtkWidget::move-focus
Emitted when the focus is moved.
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
GtkWidget::realize
Emitted when widget is associated with a GdkSurface.
GtkWidget::show
Emitted when widget is shown.
GtkWidget::state-flags-changed
Emitted when the widget state changes.
GtkWidget::unmap
Emitted when widget is going to be unmapped.
GtkWidget::unrealize
Emitted when the GdkSurface associated with widget is destroyed.
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.