diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index b171b57..ea66124 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-08-22T16:57:11","documenter_version":"1.6.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-08-22T16:57:25","documenter_version":"1.6.0"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index 497f2d4..abd1717 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,6 +1,6 @@ -API · XCB.jl

API

XCB.Connection — Type

Connection to the X server.

mutable struct Connection <: XCB.Handle
  • h::Ptr{Nothing}: Opaque handle to the connection, used for API calls.
source
XCB.Connection — Method

Initialize a connection to the X server.

Connection(; display) -> Connection
-
source
XCB.ConnectionError — Type

The X Server reported a connection error.

struct ConnectionError <: Exception

  • msg::Any

  • code::Any

source
XCB.FlushError — Type

Error when flushing a connection to the X Server.

struct FlushError <: Exception
  • code::Any
source
XCB.GraphicsContext — Type

Graphics context attached to a window. Used to register drawing commands on the window surface.

mutable struct GraphicsContext

  • conn::Connection

  • id::UInt32

source
XCB.Handle — Type

Structures which contain a handle (opaque pointer) as primary data. Those structures are usually defined as mutable so that a finalizer can be registered. Any Handle structure is automatically converted to its handle data on ccalls, through unsafe_convert.

abstract type Handle
source
XCB.RequestError — Type

A request to the X Server returned with an error.

struct RequestError <: Exception
  • msg::Any
source
XCB.Setup — Type

Connection setup handle and data.

struct Setup <: XCB.Handle
  • h::Ptr{xcb_setup_t}: Handle to the setup, used for API calls.
  • value::xcb_setup_t: Setup value, obtained when dereferencing its handle.
source
XCB.XCBWindow — Type

Window type used with the XCB API.

mutable struct XCBWindow <: AbstractWindow

  • conn::Connection

  • id::UInt32

  • parent_id::UInt32

  • visual_id::UInt32

  • delete_request::UInt32

  • gc::Union{Nothing, GraphicsContext}

source
XCB.XCBWindow — Method

Create a new window whose parent is given by parent_id and visual by visual_id.

XCBWindow(
+API · XCB.jl
API
XCB.Connection — Type
Connection to the X server.
mutable struct Connection <: XCB.Handle
  • h::Ptr{Nothing}: Opaque handle to the connection, used for API calls.
source
XCB.Connection — Method
Initialize a connection to the X server.
Connection(; display) -> Connection
+
source
XCB.ConnectionError — Type
The X Server reported a connection error.
struct ConnectionError <: Exception
  • msg::Any
  • code::Any
source
XCB.FlushError — Type
Error when flushing a connection to the X Server.
struct FlushError <: Exception
  • code::Any
source
XCB.GraphicsContext — Type
Graphics context attached to a window. Used to register drawing commands on the window surface.
mutable struct GraphicsContext
  • conn::Connection
  • id::UInt32
source
XCB.Handle — Type
Structures which contain a handle (opaque pointer) as primary data. Those structures are usually defined as mutable so that a finalizer can be registered. Any Handle structure is automatically converted to its handle data on ccalls, through unsafe_convert.
abstract type Handle
source
XCB.RequestError — Type
A request to the X Server returned with an error.
struct RequestError <: Exception
  • msg::Any
source
XCB.Setup — Type
Connection setup handle and data.
struct Setup <: XCB.Handle
  • h::Ptr{xcb_setup_t}: Handle to the setup, used for API calls.
  • value::xcb_setup_t: Setup value, obtained when dereferencing its handle.
source
XCB.XCBWindow — Type
Window type used with the XCB API.
mutable struct XCBWindow <: AbstractWindow
  • conn::Connection
  • id::UInt32
  • parent_id::UInt32
  • visual_id::UInt32
  • delete_request::UInt32
  • gc::Union{Nothing, GraphicsContext}
source
XCB.XCBWindow — Method
Create a new window whose parent is given by parent_id and visual by visual_id.
XCBWindow(
     conn,
     parent_id,
     visual_id;
@@ -17,18 +17,18 @@
     attributes,
     values
 ) -> XCBWindow
-
source
XCB.XCBWindow — Method
Create a new window on the provided screen.
XCBWindow(conn::Connection, screen; kwargs...) -> XCBWindow
-
source
XCB.XCBWindow — Method
Create a new window on the current screen.
XCBWindow(conn::Connection; kwargs...) -> XCBWindow
-
source
XCB.check — Method
Check that the connection to the X server was successful. Throws a ConnectionError if the connection failed.
check(connection::Connection) -> Connection
-
source
XCB.check_request — Method
Check that the request was successfully handled by the server, throwing a RequestError if the request failed.
The severity level can be set via level with one of the two following values:
- `:warn`: logs a warning with `@warn` (default).
+
source
XCB.XCBWindow — Method
Create a new window on the provided screen.
XCBWindow(conn::Connection, screen; kwargs...) -> XCBWindow
+
source
XCB.XCBWindow — Method
Create a new window on the current screen.
XCBWindow(conn::Connection; kwargs...) -> XCBWindow
+
source
XCB.check — Method
Check that the connection to the X server was successful. Throws a ConnectionError if the connection failed.
check(connection::Connection) -> Connection
+
source
XCB.check_request — Method
Check that the request was successfully handled by the server, throwing a RequestError if the request failed.
The severity level can be set via level with one of the two following values:
- `:warn`: logs a warning with `@warn` (default).
 - `:error`: raise a `RequestError`.
check_request(conn, request; level)
-
source
XCB.state_xcb — Method
Translate mouse or modifier state into the corresponding XCB value.
state_xcb(
+
source
XCB.state_xcb — Method
Translate mouse or modifier state into the corresponding XCB value.
state_xcb(
     event::Event
 ) -> Union{Int64, UInt64, xcb_mod_mask_t}
-
source
XCB.@check — Macro
Check the value returned by the function call request with check_request.
The severity level (:error or :warn) can be supplied as first argument. By default, the severity level is :warn.
Wraps request with check_request. The Connection argument is taken as the first argument of the function call expression request. The request is transformed to be checkable, through the functions xcb*checked (or xcb* if there exists a xcb*_unchecked version). If no checkable substitute is found, an ArgumentError is raised.
TODO: @macroexpand example
source
XCB.@flush — Macro
Flush a connection attached to a request expr.
The connection is taken to be the first argument of expr. expr can be a call to XCB.@check.
Examples
julia> @macroexpand @flush xcb_unmap_window(win.conn, win.id)
+
source
XCB.@check — Macro
Check the value returned by the function call request with check_request.
The severity level (:error or :warn) can be supplied as first argument. By default, the severity level is :warn.
Wraps request with check_request. The Connection argument is taken as the first argument of the function call expression request. The request is transformed to be checkable, through the functions xcb*checked (or xcb* if there exists a xcb*_unchecked version). If no checkable substitute is found, an ArgumentError is raised.
TODO: @macroexpand example
source
XCB.@flush — Macro
Flush a connection attached to a request expr.
The connection is taken to be the first argument of expr. expr can be a call to XCB.@check.
Examples
julia> @macroexpand @flush xcb_unmap_window(win.conn, win.id)
 quote
     xcb_unmap_window(win.conn, win.id)
     (flush)(win.conn)
-end
source

+end
source
diff --git a/dev/objects.inv b/dev/objects.inv index 9ababac..6e89037 100644 Binary files a/dev/objects.inv and b/dev/objects.inv differ