### GET /websites/aylur_github_io_libastal_astal4/astal_application_get_windows Source: https://aylur.github.io/libastal/astal4/method.Application.get_windows Retrieves a list of windows associated with an AstalApplication instance. ```APIDOC ## GET /websites/aylur_github_io_libastal_astal4/astal_application_get_windows ### Description Retrieves a list of windows associated with an AstalApplication instance. ### Method GET ### Endpoint /websites/aylur_github_io_libastal_astal4/astal_application_get_windows ### Parameters #### Path Parameters - **self** (AstalApplication*) - Required - The AstalApplication instance. ### Request Example (No request body for GET request) ### Response #### Success Response (200) - **return value** (GList*) - A list of windows. The ownership of the returned data belongs to the instance. #### Response Example { "example": "(GList*) list of windows" } ``` -------------------------------- ### Get Windows from AstalApplication (C) Source: https://aylur.github.io/libastal/astal4/method.Application.get_windows Retrieves a list of windows associated with an AstalApplication instance. The returned GList is owned by the instance. ```c GList* astal_application_get_windows ( AstalApplication* self ) ``` -------------------------------- ### GET /websites/aylur_github_io_libastal_astal4 Source: https://aylur.github.io/libastal/astal4/method.Application.get_window Retrieves an application window by its name. ```APIDOC ## GET /websites/aylur_github_io_libastal_astal4 ### Description Get a window by its `GtkWidget:name` that has been added to this app using `gtk_application_add_window()`. ### Method GET ### Endpoint /websites/aylur_github_io_libastal_astal4 ### Parameters #### Query Parameters - **name** (string) - Required - The name of the window to retrieve. ### Response #### Success Response (200) - **window** (GtkWindow) - The requested GtkWindow object, or NULL if not found. #### Response Example { "window": "" } ``` -------------------------------- ### Get Anchor from AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_anchor The `astal_window_get_anchor` function retrieves the anchor associated with an `AstalWindow`. It takes a pointer to an `AstalWindow` as input and returns an `AstalWindowAnchor`. No specific implementation details or usage examples are available. ```c AstalWindowAnchor astal_window_get_anchor ( AstalWindow* self ) ``` -------------------------------- ### Get AstalWindow Namespace (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_namespace Retrieves the namespace of an AstalWindow instance. The returned value is a NUL-terminated UTF-8 string owned by the instance. This function is written in C. ```c const gchar* astal_window_get_namespace ( AstalWindow* self ) ``` -------------------------------- ### GET /websites/aylur_github_io_libastal_astal4/astal_window_get_current_monitor Source: https://aylur.github.io/libastal/astal4/method.Window.get_current_monitor Retrieves the GdkMonitor object for the current monitor the AstalWindow resides in. ```APIDOC ## GET /websites/aylur_github_io_libastal_astal4/astal_window_get_current_monitor ### Description Get the current `GdkMonitor` this window resides in. ### Method GET ### Endpoint /websites/aylur_github_io_libastal_astal4/astal_window_get_current_monitor ### Parameters #### Path Parameters - **self** (AstalWindow*) - Required - The AstalWindow instance. ### Request Example ```json { "example": "No request body needed for this GET request." } ``` ### Response #### Success Response (200) - **GdkMonitor*** - The GdkMonitor object for the current monitor. The caller is responsible for freeing this memory. #### Response Example ```json { "example": "GdkMonitor object details (specific structure not provided in source)" } ``` ``` -------------------------------- ### Get Monitors from AstalApplication (C) Source: https://aylur.github.io/libastal/astal4/method.Application.get_monitors Retrieves a list of GdkMonitor objects associated with an AstalApplication instance. The caller is responsible for managing the ownership of the returned list, but not the individual monitor objects within it. This function is crucial for applications needing to query display information. ```c GList* astal_application_get_monitors ( AstalApplication* self ) ``` -------------------------------- ### AstalWindow Gdkmonitor Property Source: https://aylur.github.io/libastal/astal4/property.Window.gdkmonitor The gdkmonitor property allows you to get or set the Gdk.Monitor on which the AstalWindow should appear. This property is both readable and writable. ```APIDOC ## AstalWindow gdkmonitor Property ### Description Specifies which monitor the window should appear on. ### Method (Not applicable for property documentation) ### Endpoint (Not applicable for property documentation) ### Parameters #### Path Parameters (None) #### Query Parameters (None) #### Request Body (None) ### Request Example (Not applicable for property documentation) ### Response #### Success Response (200) - **gdkmonitor** (Gdk.Monitor) - The Gdk.Monitor associated with the window. #### Response Example ```json { "gdkmonitor": "" } ``` ``` -------------------------------- ### Get Icon Theme - C (GTK+) Source: https://aylur.github.io/libastal/astal4/method.Application.get_icon_theme Retrieves the icon theme name associated with an AstalApplication instance. The caller is responsible for freeing the returned NUL-terminated UTF-8 string. ```c gchar* astal_application_get_icon_theme ( AstalApplication* self ) ``` -------------------------------- ### Get GTK Theme as String - C Source: https://aylur.github.io/libastal/astal4/method.Application.get_gtk_theme Retrieves the GTK theme name associated with the AstalApplication. The returned value is a NUL-terminated UTF-8 string. The caller is responsible for freeing the returned memory. ```c gchar* astal_application_get_gtk_theme ( AstalApplication* self ) ``` -------------------------------- ### Get GtkWindow by Name - C Source: https://aylur.github.io/libastal/astal4/method.Application.get_window Retrieves a GtkWindow from an AstalApplication instance based on its GtkWidget:name. This function is useful for accessing specific windows managed by the application. The caller is responsible for freeing the returned GtkWindow if it's not NULL. The `name` parameter must be a NUL-terminated UTF-8 string. ```c GtkWindow* astal_application_get_window ( AstalApplication* self, const gchar* name ) ``` -------------------------------- ### Get GdkMonitor from AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_gdkmonitor Retrieves the GdkMonitor associated with an AstalWindow instance. The returned GdkMonitor is owned by the instance. No specific dependencies are mentioned, and the input is an AstalWindow pointer. ```c GdkMonitor* astal_window_get_gdkmonitor ( AstalWindow* self ) ``` -------------------------------- ### Get AstalLayer from AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_layer This C function retrieves an AstalLayer associated with a given AstalWindow. It requires a pointer to an AstalWindow as input and returns a pointer to the AstalLayer. No specific dependencies are mentioned, and error handling or edge cases are not detailed. ```c AstalLayer astal_window_get_layer ( AstalWindow* self ) ``` -------------------------------- ### Get Keymode from AstalWindow Source: https://aylur.github.io/libastal/astal4/method.Window.get_keymode Retrieves the keymode associated with an AstalWindow instance. The function takes a pointer to an AstalWindow as input and returns an AstalKeymode value. No specific dependencies or limitations are mentioned in the provided documentation. ```c AstalKeymode astal_window_get_keymode ( AstalWindow* self ) ``` -------------------------------- ### Get AstalWindow Exclusivity Status (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_exclusivity This C function retrieves the exclusivity status of a given AstalWindow. It takes a pointer to an AstalWindow as input and returns an AstalExclusivity enumeration value indicating the window's exclusivity. ```c AstalExclusivity astal_window_get_exclusivity ( AstalWindow* self ) ``` -------------------------------- ### Get Cursor Theme - C (AstalApplication) Source: https://aylur.github.io/libastal/astal4/method.Application.get_cursor_theme Retrieves the cursor theme name as a NUL-terminated UTF-8 string. The caller is responsible for freeing the returned string. This function is part of the AstalApplication class. ```c gchar* astal_application_get_cursor_theme ( AstalApplication* self ) ``` -------------------------------- ### Get Top Margin of AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_margin_top Retrieves the top margin of an AstalWindow. This function takes a pointer to an AstalWindow object as input and returns an integer representing the top margin. No specific dependencies are mentioned. ```c gint astal_window_get_margin_top ( AstalWindow* self ) ``` -------------------------------- ### Get Current Monitor for AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_current_monitor Retrieves the GdkMonitor object that the given AstalWindow currently resides on. The caller is responsible for freeing the returned GdkMonitor object after use. This function is useful for determining display properties related to the window's position. ```c GdkMonitor* astal_window_get_current_monitor ( AstalWindow* self ) ``` -------------------------------- ### Get Step Value of AstalSlider (C) Source: https://aylur.github.io/libastal/astal4/method.Slider.get_step Retrieves the step value from an AstalSlider object. This function takes a pointer to an AstalSlider as input and returns a gdouble representing the step. No specific dependencies are mentioned, and the return value is a floating-point number. ```c gdouble astal_slider_get_step ( AstalSlider* self ) ``` -------------------------------- ### AstalApplication Instance Methods Source: https://aylur.github.io/libastal/astal4/class.Application Provides core instance methods for AstalApplication, including resetting CSS, retrieving windows by name, applying CSS providers, adding icons, and handling incoming requests. Some methods have inherited functionality from parent classes. ```c // Remove all GtkStyleContext providers. void astal_application_reset_css(Astal.Application *self); // Get a window by its GtkWidget:name that has been added to this app using gtk_application_add_window(). GtkWidget* astal_application_get_window(Astal.Application *self, const char *name); // Add a new GtkStyleContext provider. void astal_application_apply_css(Astal.Application *self, Gtk.StyleProvider *provider); // Shortcut for gtk_icon_theme_add_search_path(). void astal_application_add_icons(Astal.Application *self, const char *path); // Handler for an incoming request. void astal_application_request(Astal.Application *self, ...); // No description available. ... get_monitors(...); ... get_window(...); ... get_gtk_theme(...); ... set_gtk_theme(...); ... get_icon_theme(...); ... set_icon_theme(...); ... get_cursor_theme(...); ... set_cursor_theme(...); ``` -------------------------------- ### Get Child Widget of AstalBin (C) Source: https://aylur.github.io/libastal/astal4/method.Bin.get_child Retrieves the child widget managed by an AstalBin instance. The returned GtkWidget is owned by the AstalBin instance and may be NULL. This function is part of the Astal library. ```c GtkWidget* astal_bin_get_child ( AstalBin* self ) ``` -------------------------------- ### AstalWindow Instance Methods Overview Source: https://aylur.github.io/libastal/astal4/class.Window Lists the instance methods available for AstalWindow objects, which allow for the retrieval and setting of various window properties such as monitor, namespace, anchor, exclusivity, layer, keymode, and margins. These methods facilitate dynamic control over window behavior. ```vala /* Instance methods of Astal.Window */ // Get the current GdkMonitor this window resides in. astal_window_get_current_monitor (Astal.Window self) // Namespace management. astal_window_get_namespace (Astal.Window self) astal_window_set_namespace (Astal.Window self, string ns) // Anchor management. astal_window_get_anchor (Astal.Window self) astal_window_set_anchor (Astal.Window self, uint anchor) // Exclusivity management. astal_window_get_exclusivity (Astal.Window self) astal_window_set_exclusivity (Astal.Window self, bool exclusive) // Layer management. astal_window_get_layer (Astal.Window self) astal_window_set_layer (Astal.Window self, uint layer) // Key mode management. astal_window_get_keymode (Astal.Window self) astal_window_set_keymode (Astal.Window self, uint mode) // GdkMonitor management. astal_window_get_gdkmonitor (Astal.Window self) astal_window_set_gdkmonitor (Astal.Window self, Gdk.Monitor monitor) // Margin management. astal_window_get_margin_top (Astal.Window self) astal_window_set_margin_top (Astal.Window self, int margin) astal_window_get_margin_bottom (Astal.Window self) astal_window_set_margin_bottom (Astal.Window self, int margin) astal_window_get_margin_left (Astal.Window self) astal_window_set_margin_left (Astal.Window self, int margin) astal_window_get_margin_right (Astal.Window self) astal_window_set_margin_right (Astal.Window self, int margin) astal_window_set_margin (Astal.Window self, int top, int bottom, int left, int right) // Monitor management (potentially different from GdkMonitor). astal_window_get_monitor (Astal.Window self) astal_window_set_monitor (Astal.Window self, int monitor_id) /* Constructor */ // Creates a new Astal.Window. astal_window_new (void) ``` -------------------------------- ### AstalBin Constructor and Child Methods (Vala) Source: https://aylur.github.io/libastal/astal4/class.Bin Provides the constructor and instance methods for AstalBin, allowing for the creation of new AstalBin widgets and the retrieval or setting of their child widgets. ```vala // Constructor public Astal.Bin(); // Instance methods public Gtk.Widget astal_bin_get_child(); public void astal_bin_set_child(Gtk.Widget child); ``` -------------------------------- ### GObject Signals Source: https://aylur.github.io/libastal/astal4/class.Application Signals inherited from GObject. ```APIDOC ## GObject::notify ### Description 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. ### Method SUBSCRIBE ### Endpoint `/gobject/notify ``` -------------------------------- ### AstalBox Child Property Source: https://aylur.github.io/libastal/astal4/property.Box.child Describes the 'child' property of the AstalBox widget, which allows for setting and getting a Gtk.Widget. ```APIDOC ## AstalBox Child Property ### Description This property allows you to set or get the Gtk.Widget that is a child of the AstalBox. ### Method Not applicable (property access) ### Endpoint Not applicable (property access) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ``` # Getting the child widget widget = astal_box.child # Setting a new child widget new_widget = Gtk.Label.new("New Child") astal_box.child = new_widget ``` ### Response #### Success Response (200) - **child** (Gtk.Widget) - The Gtk.Widget currently set as the child of the AstalBox. #### Response Example ```json { "child": "" } ``` ``` -------------------------------- ### Astal.Box Constructors and Methods Source: https://aylur.github.io/libastal/astal4/class.Box Provides an overview of the constructors and instance methods available for the Astal.Box class. This includes creating a new Astal.Box instance and methods for managing its children and orientation. ```vapi /* Constructors */ astal_box_new /* Instance methods */ astal_box_get_vertical astal_box_set_vertical astal_box_get_children astal_box_set_children astal_box_get_child astal_box_set_child ``` -------------------------------- ### Constructor AstalWindow Source: https://aylur.github.io/libastal/astal4/ctor.Window.new This constructor function creates and returns a new instance of AstalWindow. ```APIDOC ## Constructor AstalWindow ### Description Creates a new instance of the AstalWindow. ### Method N/A (Constructor) ### Endpoint N/A (Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (N/A) - **astalWindow** (AstalWindow) - A pointer to the newly created AstalWindow object. The data is owned by the called function. ``` -------------------------------- ### AstalApplication.windows Property Source: https://aylur.github.io/libastal/astal4/property.Application.windows Retrieves a list of all Gtk.Window objects that have been added to this AstalApplication instance using `gtk_application_add_window()`. ```APIDOC ## AstalApplication.windows Property ### Description Windows that have been added to this app using `gtk_application_add_window()`. ### Method GET ### Endpoint /websites/aylur_github_io_libastal_astal4/AstalApplication/windows ### Parameters #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "No request body needed for reading a property." } ``` ### Response #### Success Response (200) - **windows** (Gtk.Window list) - A list of Gtk.Window objects. #### Response Example ```json { "windows": [ "", "" ] } ``` ``` -------------------------------- ### Get Child GtkWidget from AstalBox (C) Source: https://aylur.github.io/libastal/astal4/method.Box.get_child Retrieves a child GtkWidget from an AstalBox. The caller is responsible for freeing the returned GtkWidget. The return value can be NULL. ```c GtkWidget* astal_box_get_child ( AstalBox* self ) ``` -------------------------------- ### GtkApplication Signals Source: https://aylur.github.io/libastal/astal4/class.Application Signals inherited from GtkApplication. ```APIDOC ## GtkApplication::query-end ### Description Emitted when the session manager is about to end the session. ### Method SUBSCRIBE ### Endpoint `/gtk/application/query-end ## GtkApplication::window-added ### Description Emitted when a window is added to an application. ### Method SUBSCRIBE ### Endpoint `/gtk/application/window-added ## GtkApplication::window-removed ### Description Emitted when a window is removed from an application. ### Method SUBSCRIBE ### Endpoint `/gtk/application/window-removed ``` -------------------------------- ### AstalIOApplication Properties Source: https://aylur.github.io/libastal/astal4/class.Application Properties inherited from AstalIOApplication. ```APIDOC ## AstalIO.Application:instance-name ### Description No description available. ### Method GET ### Endpoint `/astal-io/application/instance-name ``` -------------------------------- ### Get Page Value from AstalSlider (C) Source: https://aylur.github.io/libastal/astal4/method.Slider.get_page Retrieves the current page value from an AstalSlider object. This function is part of the libastal library and returns a gdouble representing the page. ```c gdouble astal_slider_get_page ( AstalSlider* self ) ``` -------------------------------- ### AstalApplication:icon-theme Property Source: https://aylur.github.io/libastal/astal4/property.Application.icon-theme This section describes the `icon-theme` property of the AstalApplication, including its type, read/write access, and its relationship to GtkSettings. ```APIDOC ## AstalApplication:icon-theme Property ### Description Shortcut for `GtkSettings:gtk-icon-theme-name`. ### Method Not applicable (Property) ### Endpoint Not applicable (Property) ### Parameters Not applicable (Property) ### Request Example Not applicable (Property) ### Response #### Success Response (Property Value) - **icon-theme** (utf8) - The name of the icon theme. #### Response Example ```json { "icon-theme": "Adwaita" } ``` ### Flags - **Readable**: yes - **Writable**: yes - **Construct**: no - **Construct only**: no ``` -------------------------------- ### AstalApplication Properties Source: https://aylur.github.io/libastal/astal4/class.Application Defines properties for AstalApplication related to monitor information, associated windows, and theme settings (GTK, icon, and cursor). These properties offer shortcuts to underlying GtkSettings or GdkDisplay functionalities. ```c // Get all monitors from GdkDisplay. monitor_list monitors { get; } // Windows that has been added to this app using gtk_application_add_window(). window_list windows { get; } // Shortcut for GtkSettings:gtk-theme-name. gtk_theme { get; set; } // Shortcut for GtkSettings:gtk-icon-theme-name. icon_theme { get; set; } // Shortcut for GtkSettings:gtk-cursor-theme-name. cursor_theme { get; set; } ``` -------------------------------- ### Define AstalApplication Class in Vala Source: https://aylur.github.io/libastal/astal4/class.Application Defines the AstalApplication class, which extends Gtk.Application and implements the AstalIO.Application interface. This class manages application-specific functionalities including window handling, styling, and icon themes. ```vala class Astal.Application : Gtk.Application implements AstalIO.Application { /* No available fields */ } ``` -------------------------------- ### Constructor: astal_application_new Source: https://aylur.github.io/libastal/astal4/ctor.Application.new Creates a new instance of AstalApplication. The caller is responsible for freeing the returned data. ```APIDOC ## astal_application_new ### Description No description available. ### Method N/A (Constructor) ### Endpoint N/A (Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (N/A) - **return value** (AstalApplication*) - The caller of the function takes ownership of the data, and is responsible for freeing it. #### Response Example ```c AstalApplication* app = astal_application_new(); // Use the application instance // ... // Free the application instance when done // astal_application_free(app); ``` ``` -------------------------------- ### Get Bottom Margin of AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_margin_bottom Retrieves the bottom margin value of an AstalWindow. This function takes a pointer to an AstalWindow as input and returns an integer representing the margin. No specific dependencies or limitations are documented. ```c gint ištal_window_get_margin_bottom ( AstalWindow* self ) ``` -------------------------------- ### GApplication Signals Source: https://aylur.github.io/libastal/astal4/class.Application Signals inherited from GApplication. ```APIDOC ## GApplication::activate ### Description The ::activate signal is emitted on the primary instance when an activation occurs. See g_application_activate(). ### Method SUBSCRIBE ### Endpoint `/gapplication/activate ## GApplication::command-line ### Description The ::command-line signal is emitted on the primary instance when a commandline is not handled locally. See `g_application_run()` and the `GApplicationCommandLine` documentation for more information. ### Method SUBSCRIBE ### Endpoint `/gapplication/command-line ## GApplication::handle-local-options ### Description The ::handle-local-options signal is emitted on the local instance after the parsing of the commandline options has occurred. ### Method SUBSCRIBE ### Endpoint `/gapplication/handle-local-options ## GApplication::name-lost ### Description The ::name-lost signal is emitted only on the registered primary instance when a new instance has taken over. This can only happen if the application is using the `G_APPLICATION_ALLOW_REPLACEMENT` flag. ### Method SUBSCRIBE ### Endpoint `/gapplication/name-lost ## GApplication::open ### Description The ::open signal is emitted on the primary instance when there are files to open. See `g_application_open()` for more information. ### Method SUBSCRIBE ### Endpoint `/gapplication/open ## GApplication::shutdown ### Description The ::shutdown signal is emitted only on the registered primary instance immediately after the main loop terminates. ### Method SUBSCRIBE ### Endpoint `/gapplication/shutdown ## GApplication::startup ### Description The ::startup signal is emitted on the primary instance immediately after registration. See g_application_register(). ### Method SUBSCRIBE ### Endpoint `/gapplication/startup ``` -------------------------------- ### Constructor AstalBin Source: https://aylur.github.io/libastal/astal4/ctor.Bin.new This section describes the AstalBin constructor function, which creates and returns a new AstalBin object. ```APIDOC ## Constructor AstalBin ### Description Creates a new AstalBin object. ### Method Constructor (Implicit) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response (200) - **AstalBin*** (pointer) - A pointer to the newly created AstalBin object. #### Response Example ```json { "return_type": "AstalBin*" } ``` ### Notes The data returned is owned by the calling function. ``` -------------------------------- ### Get Minimum Value from AstalSlider (C) Source: https://aylur.github.io/libastal/astal4/method.Slider.get_min Retrieves the minimum value of an AstalSlider. This function takes a pointer to an AstalSlider object and returns its minimum value as a gdouble. No specific dependencies are mentioned. ```c gdouble astal_slider_get_min ( AstalSlider* self ) ``` -------------------------------- ### AstalApplication Monitors Property Source: https://aylur.github.io/libastal/astal4/property.Application.monitors Retrieves all monitors associated with the GdkDisplay from the AstalApplication. ```APIDOC ## AstalApplication Monitors Property ### Description Get all monitors from `GdkDisplay`. ### Method GET ### Endpoint /websites/aylur_github_io_libastal_astal4/monitors ### Parameters #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "No request body needed." } ``` ### Response #### Success Response (200) - **monitors** (Gdk.Monitor list) - A list of `GdkMonitor*` representing all available monitors. #### Response Example ```json { "monitors": [ "GdkMonitor1", "GdkMonitor2" ] } ``` ``` -------------------------------- ### Get Maximum Value of AstalSlider Source: https://aylur.github.io/libastal/astal4/method.Slider.get_max Retrieves the maximum value currently set for an AstalSlider object. This method is part of the AstalSlider API and returns a gdouble representing the maximum value. No specific dependencies are mentioned. ```c gdouble astal_slider_get_max ( AstalSlider* self ) ``` -------------------------------- ### Apply CSS to AstalApplication Source: https://aylur.github.io/libastal/astal4/method.Application.apply_css Applies CSS styles to an AstalApplication by adding a new GtkStyleContext provider. The 'style' parameter can be a CSS string or a path to a CSS file. The 'reset' parameter controls whether existing styles are reset. This method is crucial for customizing the application's visual appearance. ```c void astal_application_apply_css ( AstalApplication* self, const gchar* style, gboolean reset ) ``` -------------------------------- ### Set GTK Theme for AstalApplication (C) Source: https://aylur.github.io/libastal/astal4/method.Application.set_gtk_theme Sets the GTK theme for an AstalApplication instance. This function takes a pointer to the AstalApplication and a NUL-terminated UTF-8 string representing the GTK theme. The caller retains ownership of the provided string value. ```c void astal_application_set_gtk_theme ( AstalApplication* self, const gchar* value ) ``` -------------------------------- ### Get AstalSlider Value (C) Source: https://aylur.github.io/libastal/astal4/method.Slider.get_value Retrieves the current value of an AstalSlider. This function takes a pointer to an AstalSlider object as input and returns its value as a gdouble. No specific dependencies are mentioned, and no input validation details are provided. ```c gdouble ištal_slider_get_value ( AstalSlider* self ) ``` -------------------------------- ### AstalApplication:cursor-theme Property Source: https://aylur.github.io/libastal/astal4/property.Application.cursor-theme Provides details on the cursor-theme property, its declaration, description, and flags. ```APIDOC ## AstalApplication:cursor-theme ### Description Shortcut for `GtkSettings:gtk-cursor-theme-name`. ### Method GET, SET (Implied by read, write flags) ### Endpoint N/A (This is a property, not a REST endpoint) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "operation": "get", "property": "cursor-theme" } ``` ```json { "operation": "set", "property": "cursor-theme", "value": "Adwaita" } ``` ### Response #### Success Response (200) - **value** (utf8) - The name of the cursor theme. #### Response Example ```json { "value": "Adwaita" } ``` ``` -------------------------------- ### Get Left Margin of AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_margin_left Retrieves the left margin value of an AstalWindow. This function takes a pointer to an AstalWindow object as input and returns an integer representing the left margin. No specific dependencies or limitations are mentioned. ```c gint ištal_window_get_margin_left ( AstalWindow* self ) ``` -------------------------------- ### AstalApplication:gtk-theme Source: https://aylur.github.io/libastal/astal4/property.Application.gtk-theme This property is a shortcut for GtkSettings:gtk-theme-name, allowing direct access to the GTK theme name. ```APIDOC ## AstalApplication:gtk-theme ### Description Shortcut for `GtkSettings:gtk-theme-name`. ### Method Read/Write ### Endpoint N/A (Property) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "gtk-theme": "Adwaita" } ``` ### Response #### Success Response (200) - **gtk-theme** (string) - The name of the GTK theme. #### Response Example ```json { "gtk-theme": "Adwaita" } ``` ``` -------------------------------- ### AstalApplicationapply_css Source: https://aylur.github.io/libastal/astal4/method.Application.apply_css Applies CSS to the AstalApplication. This method adds a new GtkStyleContext provider, allowing for custom styling. ```APIDOC ## void astal_application_apply_css ### Description Add a new `GtkStyleContext` provider. ### Method void ### Endpoint N/A (This is a library function, not a REST endpoint) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "self": "AstalApplication*", "style": "const gchar*", "reset": "gboolean" } ``` ### Response #### Success Response (void) This function does not return a value. #### Response Example N/A ``` -------------------------------- ### Get Right Margin of AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.get_margin_right This C function retrieves the right margin value from an AstalWindow object. It takes a pointer to an AstalWindow as input and returns an integer representing the margin. No specific dependencies are mentioned, and the return value is a gint. ```c gint astal_window_get_margin_right ( AstalWindow* self ) ``` -------------------------------- ### Astal.ApplicationClass.request Method Source: https://aylur.github.io/libastal/astal4/class.Application Handler for an incoming request. ```APIDOC ## Astal.ApplicationClass.request ### Description Handler for an incoming request. ### Method INVOKE ### Endpoint `/astal/application/request ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - **request** (string) - Required - The incoming request. - **conn** (GSocketConnection) - Required - The connection object. ``` -------------------------------- ### GObject Signals Source: https://aylur.github.io/libastal/astal4/class.Box Documentation for the 'notify' signal inherited from GObject. ```APIDOC ## GObject Signals ### Description Signals inherited from GObject, specifically the 'notify' signal. ### Signals - **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. ``` -------------------------------- ### Get Child Widgets from AstalBox (C) Source: https://aylur.github.io/libastal/astal4/method.Box.get_children Retrieves a list of child widgets contained within an AstalBox. The method returns a GList* containing GtkWidget* pointers. The caller is responsible for managing the returned list container but not the elements within it. ```c GList* astal_box_get_children ( AstalBox* self ) ``` -------------------------------- ### AstalSlider Class Documentation Source: https://aylur.github.io/libastal/astal4/class.Slider Documentation for the AstalSlider class, detailing its properties and methods. ```APIDOC ## AstalSlider Class ### Description No description available. ### Ancestors * GtkScale * GtkRange * GtkWidget * GInitiallyUnowned * GObject ### Constructors #### astal_slider_new No description available. ### Instance Methods #### astal_slider_get_value No description available. #### astal_slider_set_value No description available. #### astal_slider_get_min No description available. #### astal_slider_set_min No description available. #### astal_slider_get_max No description available. #### astal_slider_set_max No description available. #### astal_slider_get_step No description available. #### astal_slider_set_step No description available. #### astal_slider_get_page No description available. #### astal_slider_set_page No description available. ### Properties #### Astal.Slider:value - **Type**: (type not specified) - **Default**: `0` - **Description**: Value of this slider. #### Astal.Slider:min - **Type**: (type not specified) - **Default**: `0` - **Description**: Minimum possible value of this slider. #### Astal.Slider:max - **Type**: (type not specified) - **Default**: `1` - **Description**: Maximum possible value of this slider. #### Astal.Slider:step - **Type**: (type not specified) - **Default**: `0.05` - **Description**: Size of step increments. #### Astal.Slider:page - **Type**: (type not specified) - **Default**: `0.01` - **Description**: Size of page increments. ### Inherited Methods #### Methods inherited from GtkScale (13) - **gtk_scale_add_mark**: Adds a mark at `value`. - **gtk_scale_clear_marks**: Removes any marks that have been added. - **gtk_scale_get_digits**: Gets the number of decimal places that are displayed in the value. - **gtk_scale_get_draw_value**: Returns whether the current value is displayed as a string next to the slider. - **gtk_scale_get_has_origin**: Returns whether the scale has an origin. - **gtk_scale_get_layout**: Gets the `PangoLayout` used to display the scale. - **gtk_scale_get_layout_offsets**: Obtains the coordinates where the scale will draw the `PangoLayout` representing the text in the scale. - **gtk_scale_get_value_pos**: Gets the position in which the current value is displayed. - **gtk_scale_set_digits**: Sets the number of decimal places that are displayed in the value. - **gtk_scale_set_draw_value**: Specifies whether the current value is displayed as a string next to the slider. - **gtk_scale_set_format_value_func**: `func` allows you to change how the scale value is displayed. - **gtk_scale_set_has_origin**: Sets whether the scale has an origin. - **gtk_scale_set_value_pos**: Sets the position in which the current value is displayed. #### Methods inherited from GtkRange (22) - **gtk_range_get_adjustment**: Get the adjustment which is the “model” object for `GtkRange`. - **gtk_range_get_fill_level**: Gets the current position of the fill level indicator. - **gtk_range_get_flippable**: Gets whether the `GtkRange` respects text direction. - **gtk_range_get_inverted**: Gets whether the range is inverted. - **gtk_range_get_range_rect**: This function returns the area that contains the range’s trough, in coordinates relative to `range`‘s origin. - **gtk_range_get_restrict_to_fill_level**: Gets whether the range is restricted to the fill level. - **gtk_range_get_round_digits**: Gets the number of digits to round the value to when it changes. - **gtk_range_get_show_fill_level**: Gets whether the range displays the fill level graphically. - **gtk_range_get_slider_range**: This function returns sliders range along the long dimension, in widget->window coordinates. - **gtk_range_get_slider_size_fixed**: This function is useful mainly for `GtkRange` subclasses. - **gtk_range_get_value**: Gets the current value of the range. - **gtk_range_set_adjustment**: Sets the adjustment to be used as the “model” object for the `GtkRange`. - **gtk_range_set_fill_level**: Set the new position of the fill level indicator. - **gtk_range_set_flippable**: Sets whether the `GtkRange` respects text direction. - **gtk_range_set_increments**: Sets the step and page sizes for the range. - **gtk_range_set_inverted**: Sets whether to invert the range. - **gtk_range_set_range**: Sets the allowable values in the `GtkRange`. - **gtk_range_set_restrict_to_fill_level**: Sets whether the slider is restricted to the fill level. - **gtk_range_set_round_digits**: Sets the number of digits to round the value to when it changes. - **gtk_range_set_show_fill_level**: Sets whether a graphical fill level is show on the trough. - **gtk_range_set_slider_size_fixed**: Sets whether the range’s slider has a fixed size, or a size that depends on its adjustment’s page size. - **gtk_range_set_value**: Sets the current value of the range. #### Methods inherited from GtkWidget (164) Please see GtkWidget for a full list of methods. #### Methods inherited from GObject (43) Please see GObject for a full list of methods. ``` -------------------------------- ### Declare AstalApplicationrequest Handler (C) Source: https://aylur.github.io/libastal/astal4/method.Application.request Declares the astal_application_request function, which serves as a handler for incoming requests to an AstalApplication. It takes the application instance, the request string, and the socket connection as input. The request string is expected to be a NUL-terminated UTF-8 string. ```c void astal_application_request ( AstalApplication* self, const gchar* request, GSocketConnection* conn ) ``` -------------------------------- ### Get Vertical Status of AstalBox (C) Source: https://aylur.github.io/libastal/astal4/method.Box.get_vertical Retrieves the vertical orientation status of an AstalBox. This C function takes an AstalBox pointer as input and returns a boolean value indicating whether the box is oriented vertically. No specific dependencies or limitations are mentioned. ```c gboolean astal_box_get_vertical ( AstalBox* self ) ``` -------------------------------- ### Set Key Mode for AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.set_keymode The `astal_window_set_keymode` function sets the key mode for a given `AstalWindow`. It takes a pointer to the `AstalWindow` and an `AstalKeymode` value as input. No specific return value is documented, implying it operates directly on the provided window. ```c void astal_window_set_keymode ( AstalWindow* self, AstalKeymode value ) ``` -------------------------------- ### AstalWindow:monitor Property Source: https://aylur.github.io/libastal/astal4/property.Window.monitor Documentation for the monitor property of the AstalWindow class, which specifies which monitor the window should appear on. ```APIDOC ## AstalWindow:monitor ### Description Specifies which monitor to appear this window on. CAUTION: the id might not be the same mapped by the compositor. ### Method N/A (Property) ### Endpoint N/A (Property) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "N/A for property" } ``` ### Response #### Success Response (200) - **monitor** (gint) - The ID of the monitor the window should appear on. #### Response Example ```json { "example": "N/A for property" } ``` ``` -------------------------------- ### Constructor: AstalBox* astal_box_new(void) Source: https://aylur.github.io/libastal/astal4/ctor.Box.new This section details the astal_box_new function, which is used to create and initialize a new AstalBox object. It outlines the function's declaration, return type, and ownership of the returned data. ```APIDOC ## `astal_box_new` Constructor ### Description Creates a new instance of `AstalBox`. ### Method Constructor ### Endpoint N/A (This is a library function, not an API endpoint) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```c AstalBox* myBox = astal_box_new(); ``` ### Response #### Success Response (200) - **AstalBox*** (pointer) - A pointer to the newly created `AstalBox` object. #### Response Example ```c // Successful creation returns a pointer to an AstalBox object. // Example: AstalBox* box = astal_box_new(); ``` ### Return value - **AstalBox***: A pointer to the newly allocated `AstalBox`. The data is owned by the called function, implying the caller is responsible for managing its lifecycle (e.g., freeing memory if applicable). ``` -------------------------------- ### Declare AstalWindow Constructor - C Source: https://aylur.github.io/libastal/astal4/ctor.Window.new This C code snippet shows the declaration of the `astal_window_new` function, which serves as the constructor for `AstalWindow`. It takes no arguments and returns a pointer to an `AstalWindow` object. The ownership of the returned data is managed by the called function. ```c AstalWindow* astal_window_new ( void ) ``` -------------------------------- ### Declare AstalApplication Constructor Source: https://aylur.github.io/libastal/astal4/ctor.Application.new Declares the C function to create a new AstalApplication object. It takes no arguments and returns a pointer to an AstalApplication. The caller is responsible for freeing the returned memory. ```c AstalApplication* astal_application_new ( void ) ``` -------------------------------- ### AstalWindow Class Documentation Source: https://aylur.github.io/libastal/astal4/class.Window Documentation for the AstalWindow class, a subclass of Gtk.Window that integrates GtkLayerShell. ```APIDOC ## AstalWindow Class ### Description Subclass of `GtkWindow` which integrates GtkLayerShell as class fields. ### Ancestors * GtkWindow * GtkWidget * GInitiallyUnowned * GObject ### Constructors #### astal_window_new No description available. ### Instance Methods #### astal_window_get_current_monitor Get the current `GdkMonitor` this window resides in. #### astal_window_get_namespace No description available. #### astal_window_set_namespace No description available. #### astal_window_get_anchor No description available. #### astal_window_set_anchor No description available. #### astal_window_get_exclusivity No description available. #### astal_window_set_exclusivity No description available. #### astal_window_get_layer No description available. #### astal_window_set_layer No description available. #### astal_window_get_keymode No description available. #### astal_window_set_keymode No description available. #### astal_window_get_gdkmonitor No description available. #### astal_window_set_gdkmonitor No description available. #### astal_window_get_margin_top No description available. #### astal_window_set_margin_top No description available. #### astal_window_get_margin_bottom No description available. #### astal_window_set_margin_bottom No description available. #### astal_window_get_margin_left No description available. #### astal_window_set_margin_left No description available. #### astal_window_get_margin_right No description available. #### astal_window_set_margin_right No description available. #### astal_window_set_margin No description available. #### astal_window_get_monitor No description available. #### astal_window_set_monitor No description available. ### Properties #### Astal.Window:namespace Namespace of this window. This can be used to target the layer in compositor rules. #### Astal.Window:anchor Edges to anchor the window to. If two perpendicular edges are anchored, the surface will be anchored to that corner. If two opposite edges are anchored, the window will be stretched across the screen in that direction. #### Astal.Window:exclusivity Exclusivity of this window. #### Astal.Window:layer Which layer to appear this window on. #### Astal.Window:keymode Keyboard mode of this window. #### Astal.Window:gdkmonitor Which monitor to appear this window on. #### Astal.Window:margin-top No description available. #### Astal.Window:margin-bottom No description available. #### Astal.Window:margin-left No description available. #### Astal.Window:margin-right No description available. #### Astal.Window:margin No description available. #### Astal.Window:monitor Which monitor to appear this window on. CAUTION: the id might not be the same mapped by the compositor. ``` -------------------------------- ### Add icons to AstalApplication Source: https://aylur.github.io/libastal/astal4/method.Application.add_icons This C function, astal_application_add_icons, serves as a convenient shortcut for gtk_icon_theme_add_search_path. It takes an AstalApplication pointer and a path string as input to add search paths to the icon theme. The path argument can be NULL, and the data is owned by the caller. ```c void astal_application_add_icons ( AstalApplication* self, const gchar* path ) ``` -------------------------------- ### Gio.Application Properties Source: https://aylur.github.io/libastal/astal4/class.Application Properties of the Gio.Application class related to application state and configuration. ```APIDOC ## Gio.Application:is-busy ### Description Whether the application is currently marked as busy through `g_application_mark_busy()` or g_application_bind_busy_property(). ### Method GET ### Endpoint `/gio/application/is-busy ## Gio.Application:is-registered ### Description Whether `g_application_register()` has been called. ### Method GET ### Endpoint `/gio/application/is-registered ## Gio.Application:is-remote ### Description Whether this application instance is remote. ### Method GET ### Endpoint `/gio/application/is-remote ## Gio.Application:resource-base-path ### Description The base resource path for the application. ### Method GET ### Endpoint `/gio/application/resource-base-path ## Gio.Application:version ### Description The human-readable version number of the application. ### Method GET ### Endpoint `/gio/application/version ``` -------------------------------- ### astal_application_set_cursor_theme Source: https://aylur.github.io/libastal/astal4/method.Application.set_cursor_theme Sets the cursor theme for the AstalApplication. ```APIDOC ## POST /websites/aylur_github_io_libastal_astal4/astal_application_set_cursor_theme ### Description Sets the cursor theme for the AstalApplication. ### Method POST ### Endpoint /websites/aylur_github_io_libastal_astal4/astal_application_set_cursor_theme ### Parameters #### Request Body - **self** (AstalApplication*) - Required - The AstalApplication instance. - **value** (const gchar*) - Required - The NUL-terminated UTF-8 string representing the cursor theme. The data is owned by the caller. ### Request Example ```json { "self": "", "value": "" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates success. #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### Set Monitor for AstalWindow (C) Source: https://aylur.github.io/libastal/astal4/method.Window.set_monitor The astal_window_set_monitor function sets the monitor for a given AstalWindow. It takes a pointer to the AstalWindow object and an integer representing the monitor ID. No specific return value or error handling is described. ```c void astal_window_set_monitor ( AstalWindow* self, gint value ) ``` -------------------------------- ### Reset CSS Providers in AstalApplication (C) Source: https://aylur.github.io/libastal/astal4/method.Application.reset_css This C function, astal_application_reset_css, removes all GtkStyleContext providers associated with an AstalApplication instance. It takes a pointer to the AstalApplication object as input and does not return any value. This is useful for resetting the application's styling to its default state or applying new styles. ```c void astal_application_reset_css ( AstalApplication* self ) ``` -------------------------------- ### Declare astal_window_get_monitor in C Source: https://aylur.github.io/libastal/astal4/method.Window.get_monitor This C code snippet shows the declaration of the astal_window_get_monitor function. It takes a pointer to an AstalWindow object as input and returns an integer representing the monitor index. ```c gint ištal_window_get_monitor ( AstalWindow* self ) ```