Up: cl-cffi-gtk4 API documentation
Package gdk
GDK is an intermediate layer which isolates GTK from the details of the
windowing system. This is the API documentation of a Lisp binding to GDK.
About This PackageDisplays, Devices, Monitors, and Seats Paintables Surfaces, Toplevels, Popups Draw contexts Clipboard, Drag and Drop Application launching Miscellaneous Pixbuf, Pango, and Backends interaction GeneralEnumerations
Defines the reference point of a surface and is used in the gdk:popup-layout implementation. ... A mask covering all entries in the gdk:modifier-type enumeration. ...
Flags to indicate the state of modifier keys and mouse buttons in events. ... GdkRectangle The gdk:rectangle structure is a data type for representing
rectangles. ... Copy constructor of a gdk:rectangle structure. ...
Checks if the two given rectangles are equal. ...
Calculates the intersection of two rectangles. ...
Calculates the union of two rectangles. ... GdkRGBA The gdk:rgba structure is used to represent a (possibly translucent)
color, in a way that is compatible with Cairo's notion of color. ...
Checks if a RGBA color is transparent. ...
Checks if a RGBA color is transparent. ...
Parses a textual representation of a color, and returns a RGBA instance filling in the red, green, blue and alpha
fields. ...
A hash function suitable for using for a hash table that stores
RGBA colors. ... Compares two RGBA colors. ... Returns a textual specification of color in the form rgb(r,g,b) or rgba(r,g,b,a), where r, g, b and a
represent the red, green, blue and alpha values respectively. ... Key Values
Converts a key value into a symbolic name. ...
Converts a key name to a key value. ...
Obtains the upper-case and lower-case versions of the key value. ...
Converts a key value to upper case, if applicable. ...
Converts a key value to lower case, if applicable. ... Returns true if the given key value is in upper case. ... Returns true if the given key value is in lower case. ...
Convert from a GDK key value to the corresponding ISO10646 (Unicode)
character. ...
Convert from a ISO10646 character to a GDK key value. ... GdkDmabufFormats The gdk:dmabuf-formats structure provides information about
supported DMA buffer formats. ... Returns whether a given format is contained in formats. ...
Gets the fourcc code and modifier for a format that is contained in formats. ...
Returns the number of formats that the formats object contains. ... GdkColorState The gdk:color-state structure provides the information to interpret
colors and pixels in a variety of ways. ...
Returns the color state object representing the linear rec2100 color space. ...
Returns the color state object representing the rec2100-pq color space. ...
Returns the color state object representing the sRGB color space. ...
Returns the color state object representing the linearized sRGB color space. ... Create a gdk:cicp-params object representing the colorstate. ...
Compares two color states for equality. ... GdkCicpParams
The values of this enumeration describe whether image data uses the full range
of 8-bit values. ... The gdk:cicp-params object contains the parameters that define a
colorstate according to the ITU-T H.273 specification. ... Creates a new gdk:cicp-params object. ... Displays, Devices, Monitors, and SeatsGdkDisplayManager The purpose of the gdk:display-manager singleton object is to offer
notification when displays appear or disappear or the default display
changes. ... Gets the gdk:display-manager singleton object. ... List all currently open displays. ... Opens a display. ...
Sets a list of backends that GDK should try to use. ... GdkDisplay The gdk:display object is the GDK representation of a workstation. ...
Returns the dma-buf formats that are supported on the display. ...
Returns whether it is possible for a surface to draw outside of the window
area. ... Opens a display named by name. ...
Gets the default display. ... Gets the name of the display. ... Returns true if there is an ongoing grab on the device for the
display. ... Emits a short beep on the display. ...
Flushes any requests queued for the windowing system and waits until all
requests have been handled. ...
Flushes any requests queued for the windowing system. ...
Closes the connection to the windowing system for the given display. ... Finds out if the display has been closed. ...
Returns whether surfaces on this display are created with an alpha channel. ...
Returns whether surfaces can reasonably be expected to have their alpha
channel drawn correctly on the screen. ... Returns true if the display supports input shapes. ... Returns a gdk:app-launch-context object suitable for launching
applications on the given display. ...
Indicates to the GUI environment that the application has finished loading,
using a given identifier. ...
Returns the default seat object for this display. ...
Returns the list of seats known to the display. ...
Gets the list of monitors associated with the display. ...
Gets the monitor in which the largest area of the surface resides. ... Gets the clipboard used for copy/paste operations. ...
Gets the clipboard used for the primary selection. ...
Retrieves a desktop-wide setting such as double-click time for the display. ... Gets the startup notification ID for a Wayland display, or nil if no
ID has been defined. ...
Obtains a list of keycode/group/level combinations that will generate keyval. ... Returns the keyvals bound to keycode. ...
Translates a keycode into a keyval, effective group, and level. ... Checks that OpenGL is available for display and ensures that it is
properly initialized. ...
Creates a new OpenGL context for the display. ... GdkDeviceTool
Indicates the specific type of tool being used being a tablet. ... A physical tool associated to a gdk:device object. ... GdkDevice
An enumeration describing the type of an input device in general terms. ...
An enumeration describing the way in which a device axis (valuator) maps
onto the predefined valuator types that GTK understands. ...
Flags describing the current capabilities of a device/tool. ... The gdk:device object represents a single input device, such as a
keyboard, a mouse, a touchpad, etc. ... Obtains the surface underneath device, returning the location of the device in xwin and ywin in double precision. ...
Returns the timestamp of the last activity for this device. ... GdkDevicePadGdkMonitor
This enumeration describes how the red, green and blue components of
physical pixels on an output device are laid out. ... The gdk:monitor objects represent the individual outputs that are associated with a gdk:display object. ...
Gets the internal scale factor that maps from monitor coordinates to device
pixels. ... Returns true if the monitor object corresponds to a physical monitor. ... GdkSeatPaintablesGdkPaintable Flags about a gdk:paintable object. ...
Base type for snapshot operations. ... The gdk:paintable interface is a simple interface used by GDK and
GTK to represent objects that can be painted anywhere at any size without
requiring any sort of layout. ... Method called from the gdk:paintable-snapshot function. ... Method called from the gdk:paintable-current-image function. ... Method called from the gdk:paintable-flags function. ... Method called from the gdk:paintable-intrinsic-width function. ... Method called from the gdk:paintable-intrinsic-height function. ... Method called from the gdk:paintable-intrinsic-aspect-ratio function. ...
Gets an immutable paintable for the current contents displayed by paintable. ... Snapshots the given paintable with the given width and height at the current (0,0) offset of the snapshot. ...
Get flags for the paintable. ...
Gets the preferred width the paintable would like to be displayed at. ...
Gets the preferred height the paintable would like to be displayed at. ...
Gets the preferred aspect ratio the paintable would like to be displayed at. ...
Applies the sizing algorithm outlined in
https://drafts.csswg.org/css-images-3/default-sizing to the given paintable. ... Called by implementations of a gdk:paintable subclass to invalidate
their contents. ... Called by implementations of gdk:paintable subclasses to invalidate
their size. ...
Returns a paintable that has the given intrinsic size and draws nothing. ... GdkTexture The gdk:memory-format enumeration describes a format that bytes can
have in memory. ... The gdk:texture object is the basic element used to refer to pixel
data. ... Creates a new texture object representing pixbuf. ...
Creates a new texture by loading an image from a resource. ...
Creates a new texture by loading an image from a file. ...
Creates a new texture by loading an image from a file. ...
Creates a new texture by loading an image from a memory. ...
Downloads the texture into local memory. ...
Store the given texture to the filename as a PNG file. ...
Store the given texture in memory as a PNG file. ...
Store the given texture to the filename as a TIFF file. ...
Store the given texture in memory as a TIFF file. ...
Gets the memory format most closely associated with the data of the texture. ... A gdk:texture implementation representing image data in memory. ...
Creates a new texture for a blob of image data. ... A gdk:texture implementation representing a GL texture object. ...
Creates a new texture for an existing GL texture. ... Releases the GL resources held by a gdk:gl-texture object that was created with the gdk:gl-texture-new function. ... GdkTextureDownloader Creates a new texture downloader for texture. ...
Creates a copy of the downloader ...
Downloads the texture into local memory. ...
Sets the color state the downloader will convert the data to. ...
Sets the format the downloader will download. ...
Changes the texture the downloader will download. ... GdkDmabufTexture The gdk:dmabuf-texture-builder object is a builder used to construct gdk:texture objects from DMA buffers. ... Create a new texture builder. ... Surfaces, Toplevels, PopupsSurfaces The gdk:surface object is a rectangular region on the screen. ... Creates a new toplevel surface. ...
Creates a new popup surface. ... Destroys the window system resources associated with surface and
decrements reference count of the surface. ... Check to see if a surface is destroyed. ...
For toplevel surfaces, withdraws them, so they will no longer be known to
the window manager. ... Translates the given coordinates from being relative to the from surface to being relative to the to surface. ... Emits a short beep associated to surface in the appropriate display,
if supported. ...
For optimisation purposes, compositing window managers may like to not draw
obscured regions of surfaces, or turn off blending during for these regions. ...
Creates a new OpenGL context matching the framebuffer format to the visual
of the surface. ...
Creates a new surface that is as compatible as possible with the given surface. ... Forces a "render" signal emission for surface to be scheduled. ...
Request a layout phase from the frame clock of the surface. ...
Apply the region to the surface for the purpose of event handling. ...
Obtains the current device position in doubles and modifier state. ... The gdk:surface-device-cursor function retrieves a gdk:cursor pointer for the device currently set on the specified surface, or nil. ... GdkToplevelSize The gdk:toplevel-size structure contains information that may be useful for users of gdk:toplevel objects to compute a surface size. ...
Retrieves the bounds the toplevel is placed within. ...
Sets the size the toplevel prefers to be resized to. ...
The minimum size corresponds to the limitations the toplevel can be shrunk
to, without resulting in incorrect painting. ...
The shadow width corresponds to the part of the computed surface size that
would consist of the shadow margin surrounding the window, would there be
any. ... GdkToplevelLayout
Toplevel surfaces are sovereign windows that can be presented to the user
in various states (maximized, on all workspaces, etc). ...
Create a toplevel layout description. ...
If the layout specifies whether the toplevel should go maximized, the maximized argument is set to true if it should go fullscreen, or false, if it should go unmaximized. ...
If the layout specifies whether the toplevel should go fullscreen, the fullscreen value is set to true if it should go fullscreen, or false, if it should go unfullscreen. ...
Returns the monitor that the layout is fullscreening the surface on. ... The gdk:toplevel-layout-resizable function returns whether the layout
should allow the user to resize the surface. ... GdkToplevel
Specifies the state of a toplevel surface. ...
Indicates which monitor (in a multi-head setup) a surface should span over
when in fullscreen mode. ...
Determines a surface edge or corner. ...
The kind of title bar gesture to emit with the gdk:toplevel-titlebar-gesture function. ... The gdk:toplevel object is a freestanding toplevel surface. ...
Asks to minimize the toplevel. ...
Asks to lower the toplevel below other windows. ...
Sets keyboard focus to surface . ...
Asks the windowing system to show the window menu. ...
Returns whether the desktop environment supports tiled window states. ...
Requests that the toplevel inhibit the system shortcuts, asking the desktop
environment/windowing system to let all keyboard events reach the surface,
as long as it is focused, instead of triggering system actions. ...
Restore default system keyboard shortcuts which were previously requested to be inhibited by the gdk:toplevel-inhibit-system-shortcuts
function. ...
Begins an interactive resize operation, for a toplevel surface. ...
Begins an interactive move operation, for a toplevel surface. ...
No description available. ... GdkPopupLayout
Positioning hints for aligning a surface relative to a rectangle. ...
Popups are positioned relative to their parent surface. ...
Create a popup layout description. ... Create a new popup layout and copy the contents of layout into it. ... The gdk:popup-layout-anchor-rect function gets the anchor rectangle. ... The gdk:popup-layout-rect-anchor function returns the anchor position
on the anchor rectangle. ... The gdk:popup-layout-surface-anchor function returns the anchor
position on the popup surface. ... The gdk:popup-layout-anchor-hints function gets the anchor hints. ... The gdk:popup-layout-offset function retrieves the offset for the
anchor rectangle. ... The gdk:popup-layout-shadow-width function obtains the shadow widths
of the popup layout. ... GdkPopup A gdk:popup object is a surface that is attached to another surface,
called its "parent", and is positioned relative to it. ...
Gets the current popup surface anchor. ...
Gets the current popup surface anchor. ... Obtains the position of the popup relative to its parent. ... Obtains the position of the popup relative to its parent. ... Draw contextsGdkDrawContext The gdk:draw-context object is the base object used by contexts implementing different rendering methods, such as the gdk:gl-context
context. ... Ends a drawing operation started with the gdk:draw-context-begin-frame
function and makes the drawing available on screen. ... Returns true if context is in the process of drawing to its surface after a call to the gdk:draw-context-begin-frame function and not yet having called the gdk:draw-context-end-frame function. ...
Retrieves the region that is currently in the process of being repainted. ... GdkGLContext The list of the different APIs that a gdk:gl-context object can
potentially support. ... The gdk:gl-context object is an object representing the platform
specific OpenGL draw context. ...
Retrieves the display the GL context is created for. ...
Retrieves the surface used by the GL context. ...
Retrieves the OpenGL version of the GL context. ... The gdk:gl-context-debug-enabled function retrieves whether debugging
is enabled. ... The gdk:gl-context-forward-compatible function returns whether the
GL context should be forward compatible. ... The gdk:gl-context-uses-es function checks whether the context is
using an OpenGL or OpenGL ES profile. ...
Whether the GL context is in legacy mode or not. ...
Realizes the given OpenGL context. ...
Makes the GL context the current one. ...
Retrieves the current GL context. ...
Clears the current GL context. ... GdkCairoContextClipboard, Drag and DropContent Formats The gdk:content-formats structure is used to advertise and negotiate
the format of content. ... Creates a new gdk:content-formats instance from a list of
mime types. ... Prints the given formats into a human-readable string. ... Gets the mime types included in formats. ... Checks if a given mime type is part of the given formats. ... GdkContentProvider A gdk:content-provider object is used to provide content for the
clipboard in a number of formats. ...
Gets the formats that the content provider can provide its current contents
in. ...
Gets the formats that the content provider suggests other applications to
store the data in. ... Creates a content provider that provides the given gvalue. ... GdkContentSerializer The gdk:content-serializer object is used to serialize content for
inter-application data transfers. ... GdkContentDeserializer The gdk:content-deserializer object is used to deserialize content
received via inter-application data transfers. ... Clipboards The gdk:clipboard object represents data shared between applications
or inside an application. ...
Returns if the clipboard is local. ...
Asynchronously instructs the clipboard to store its contents remotely to
preserve them for later usage. ...
Finishes an asynchronous clipboard store started with the gdk:clipboard-store-async function. ...
Asynchronously request the clipboard contents converted to the given gtype. ...
Finishes an asynchronous clipboard read started with the gdk:clipboard-read-value-async function. ...
Asynchronously request the clipboard contents converted to a gdk:pixbuf object. ...
Finishes an asynchronous clipboard read started with the gdk:clipboard-read-texture-async function. ...
Asynchronously request the clipboard contents converted to a string. ...
Finishes an asynchronous clipboard read started with the gdk:clipboard-read-text-async function. ... Sets a new content provider on clipboard. ... Sets the clipboard to contain the given value. ... Sets the clipboard to contain the given gvalue. ... Puts the given text into the clipboard. ... Puts the given texture into the clipboard. ... GdkDrag Used in gdk:drop and gdk:drag objects to indicate the
actions that the destination can and should do with the dropped data. ...
Inform GDK if the drop ended successfully. ...
Starts a drag and creates a new drag context for it. ...
Returns the surface on which the drag icon should be rendered during the
drag operation. ...
Sets the position of the drag surface that will be kept under the cursor
hotspot. ... Checks if action represents a single action or if it includes
multiple flags that can be selected from. ... GdkDrop
Selects all actions that are potentially supported by the destination. ...
Ends the drag operation after a drop. ...
Asynchronously request the drag operation's contents converted to the given gtype. ... Finishes an async drop read started with the gdk:drop-read-value-async
function. ... GdkDragSurface The gdk:drag-surface-size structure contains information that is
useful to compute the size of a drag surface. ...
Sets the size the drag surface prefers to be resized to. ... The gdk:drag-surface interface is an interface for surfaces used
during DND. ... Present the drag surface. ... Application launchingGdkAppLaunchContext The gdk:app-launch-context object is an implementation of the g:app-launch-context object that handles launching an application
in a graphical context. ...
Sets the workspace on which applications will be launched when using this
context when running under a window manager that supports multiple
workspaces, as described in the Extended Window Manager Hints. ... Sets the timestamp of context. ...
Sets the icon for applications that are launched with this context. ...
Sets the icon for applications that are launched with this context. ... MiscellaneousEvents
Represents the current time, and can be used anywhere a time is expected. ...
Use this value as the return value for continuing the propagation of an
event handler. ...
Use this value as the return value for stopping the propagation of an event
handler. ...
The primary button. ...
The middle button. ...
The secondary button. ...
Describes how well an event matches a given keyval and modifiers. ... The gdk:touchpad-gesture-phase enumeration specifies the current
state of a touchpad gesture. ... Specifies the direction for a gdk:scroll-event event. ... Specifies the crossing mode for enter and leave events. ...
Specifies the unit of scroll deltas. ... Specifies the kind of crossing for enter and leave events. ... The gdk:event-sequence structure is an opaque type representing a
sequence of related touch events. ...
The base type of an event. ...
An event related to a button on a pointer device. ...
An event related to a scrolling motion. ...
An event related to a pointer or touch device motion. ...
An event related to a key-based device. ...
An event related to a focus change. ...
An event caused by a pointing device moving between surfaces. ...
An event related to a broken windowing system grab. ...
An event related to closing a toplevel surface. ...
An event related to drag and drop operations. ...
An event related to a touch-based device. ...
An event related to a touchpad device. ...
An event related to a pad-based device. ...
An event related to the proximity of a tool to a device. ... Retrieves the type of the event. ... Extracts the surface associated with an event. ... Returns the device of an event. ...
If the event was generated by a device that supports different tools, for example a tablet, this function will return a gdk:device-tool object
representing the tool that caused the event. ... Retrieves the display associated to the event. ... Returns the seat that originated the event. ... If the event is a touch event, returns the gdk:event-sequence instance to which the event belongs. Otherwise, return nil. ... Returns the modifier state field of an event. ... Extract the event surface relative x/y coordinates from an event. ... Extracts all axis values from an event. ...
Extract the axis value for a particular axis use from an event instance. ...
Returns whether this event is an emulated pointer event, typically from a
touch event, as opposed to a real one. ...
This function returns whether an event should trigger a context menu,
according to platform conventions. ... Extract the button number from a button event. ... Extracts the direction of a scroll event. ...
Extracts the scroll deltas of a scroll event. ...
Check whether a scroll event is a stop scroll event. ...
Extracts the scroll delta unit of a scroll event. ... Extracts the keyval from a key event. ... Extracts the keycode from a key event. ... Extracts the consumed modifiers from a key event. ... Extracts the layout from a key event. ... Extracts the shift level from a key event. ... Extracts whether the key event is for a modifier key. ...
Matches a key event against a keyboard shortcut that is specified as a
keyval and modifiers. ...
Gets a keyval and modifier combination that will cause the gdk:key-event-matches function to successfully match the given event. ...
Extracts whether this event is about focus entering or leaving the surface. ...
Extracts whether a touch event is emulating a pointer event. ... Extracts the crossing mode from a crossing event. ... Extracts the notify detail from a crossing event. ... Checks if the event surface is the focus surface. ... Extracts the grab surface from a grab broken event. ... Checks whether the grab broken event is for an implicit grab. ... Extracts the touchpad gesture phase from a touchpad event. ... Extracts the number of fingers from a touchpad event. ... Extracts delta information from a touchpad event. ... Extracts the angle delta from a touchpad pinch event. ... Extracts the scale from a touchpad pinch event. ... Extracts the information from a pad strip or ring event. ... Extracts information about the pressed button from a pad event. ... Extracts group and mode information from a pad event. ...
If both events contain X/Y information, this function will return the relative angle from event1 to event2. ...
If both events contain X/Y information, the center of both coordinates will be returned in x and y. ...
If both events have X/Y information, the distance between both coordinates, as in a straight line going from event1 to event2, will be
returned. ... Cursors The gdk:cursor object represents a cursor. ... Creates a new cursor from a gdk:texture object. ... Creates a new cursor by looking up name in the current cursor theme. ... GdkFrameTimings The gdk:frame-timings structure holds timing information for a
single frame of the application’s displays. ...
Gets the frame counter value of the frame clock when this frame was drawn. ... The timing information in a gdk:frame-timings instance is filled in
incrementally as the frame as drawn and passed off to the window system for
processing and display to the user. ...
Returns the frame time for the frame. ...
Returns the presentation time. ...
Gets the natural interval between presentation times for the display that
this frame was displayed on. ...
Gets the predicted time at which this frame will be displayed. ... GdkFrameClock The gdk:frame-clock-phase enumeration is used to represent the
different paint clock phases that can be requested. ... The gdk:frame-clock object tells the application when to update and
repaint a surface. ...
Gets the time that should currently be used for animations. ...
Asks the frame clock to run a particular phase. ...
Starts updates for an animation. ...
Stops updates for an animation. ...
A frame clock maintains a 64-bit counter that increments for each frame
drawn. ... The frame clock internally keeps a history of gdk:frame-timings
objects for recent frames that can be retrieved with the gdk:frame-clock-timings function. ... Retrieves a gdk:frame-timings instance holding timing information for
the current frame or a recent frame. ...
Gets the frame timings for the current frame. ...
Using the frame history stored in the frame clock, finds the last known
presentation time and refresh interval, and assuming that presentation times
are separated by the refresh interval, predicts a presentation time that is
a multiple of the refresh interval after the last presentation time, and later than time. ...
Calculates the current frames-per-second, based on the frame timings of clock. ... Pixbuf, Pango, and Backends interactionIntroduction to GdkPixbuf Interaction
Pixbufs are client-side images. For details on how to create and
manipulate pixbufs, see the GdkPixbuf API documentation. The functions
described here allow to obtain pixbufs from GdkSurfaces and Cairo
surfaces. Functions for GDKPixbuf Interaction Transfers image data from a cairo:surface-t instance and converts it to an RGB(A) representation inside a gdk-pixbuf:pixbuf object. ... Introduction to Pango Interaction
Pango is the text layout system used by GDK and GTK. The functions and
types in this section are used to obtain clip regions for Pango Layouts, and to get pango:context objects that can be used with GDK. Creating a pango:layout object is the first step in rendering text, and requires getting a handle to a pango:context object. For GTK programs, you will usually want to use the gtk:widget-pango-context function, or the gtk:widget-create-pango-layout function. Once you have a pango:layout object, you can set the text and attributes of it with Pango functions like the pango:layout-text function and get its size with the pango:layout-size function. Note that Pango uses a fixed point system internally, so converting between Pango units and pixels using the pango:+scale+ value or the pango:pixels function. Rendering a Pango layout is done most simply with the pango:cairo-show-layout function. You can also draw pieces of the layout with the pango:cairo-show-layout-line function. Functions for Pango InteractionIntroduction to Cairo Interaction
Functions to support using Cairo. GDK does not wrap the Cairo API,
instead it allows to create Cairo contexts which can be used to draw on
GdkSurfaces. Additional functions allow to use GdkRectangles with Cairo
and to use GdkRGBAs, GdkPixbufs and GdkSurfaces as sources for drawing
operations. | Exported Symbol Index |