-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): Add interface XML and generated documentation
- Loading branch information
1 parent
f43200c
commit 8b5c562
Showing
12 changed files
with
899 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
bindings/dbus-xml/org.shadowblip.Input.CompositeDevice.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
|
|
||
| <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" | ||
| "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
| <node> | ||
| <interface name="org.shadowblip.Input.CompositeDevice"> | ||
| <!-- | ||
| Target dbus devices that this [CompositeDevice] is managing | ||
| --> | ||
| <property name="DbusDevices" type="as" access="read"/> | ||
| <!-- | ||
| The intercept mode of the composite device. | ||
| --> | ||
| <property name="InterceptMode" type="u" access="readwrite"/> | ||
| <!-- | ||
| Name of the composite device | ||
| --> | ||
| <property name="Name" type="s" access="read"/> | ||
| <!-- | ||
| List of source devices that this composite device is processing inputs for | ||
| --> | ||
| <property name="SourceDevicePaths" type="as" access="read"/> | ||
| <!-- | ||
| Target devices that this [CompositeDevice] is managing | ||
| --> | ||
| <property name="TargetDevices" type="as" access="read"/> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Introspectable"> | ||
| <method name="Introspect"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Peer"> | ||
| <method name="Ping"> | ||
| </method> | ||
| <method name="GetMachineId"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Properties"> | ||
| <method name="Get"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg type="v" direction="out"/> | ||
| </method> | ||
| <method name="Set"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg name="value" type="v" direction="in"/> | ||
| </method> | ||
| <method name="GetAll"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg type="a{sv}" direction="out"/> | ||
| </method> | ||
| <!-- | ||
| Emits the `org.freedesktop.DBus.Properties.PropertiesChanged` signal. | ||
| --> | ||
| <signal name="PropertiesChanged"> | ||
| <arg name="interface_name" type="s"/> | ||
| <arg name="changed_properties" type="a{sv}"/> | ||
| <arg name="invalidated_properties" type="as"/> | ||
| </signal> | ||
| </interface> | ||
| </node> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
|
|
||
| <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" | ||
| "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
| <node> | ||
| <interface name="org.freedesktop.DBus.Properties"> | ||
| <method name="Get"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg type="v" direction="out"/> | ||
| </method> | ||
| <method name="Set"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg name="value" type="v" direction="in"/> | ||
| </method> | ||
| <method name="GetAll"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg type="a{sv}" direction="out"/> | ||
| </method> | ||
| <!-- | ||
| Emits the `org.freedesktop.DBus.Properties.PropertiesChanged` signal. | ||
| --> | ||
| <signal name="PropertiesChanged"> | ||
| <arg name="interface_name" type="s"/> | ||
| <arg name="changed_properties" type="a{sv}"/> | ||
| <arg name="invalidated_properties" type="as"/> | ||
| </signal> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Introspectable"> | ||
| <method name="Introspect"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.shadowblip.Input.Keyboard"> | ||
| <!-- | ||
| Send the given key to the virtual keyboard | ||
| --> | ||
| <method name="SendKey"> | ||
| <arg name="key" type="s" direction="in"/> | ||
| <arg name="value" type="b" direction="in"/> | ||
| </method> | ||
| <!-- | ||
| Name of the composite device | ||
| --> | ||
| <property name="Name" type="s" access="read"/> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Peer"> | ||
| <method name="Ping"> | ||
| </method> | ||
| <method name="GetMachineId"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| </node> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
|
|
||
| <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" | ||
| "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
| <node> | ||
| <interface name="org.freedesktop.DBus.Peer"> | ||
| <method name="Ping"> | ||
| </method> | ||
| <method name="GetMachineId"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Introspectable"> | ||
| <method name="Introspect"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.shadowblip.InputManager"> | ||
| <!-- | ||
| Create a composite device using the give composite device config. The | ||
| path should be the absolute path to a composite device configuration file. | ||
| --> | ||
| <method name="CreateCompositeDevice"> | ||
| <arg name="config_path" type="s" direction="in"/> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| <property name="InterceptMode" type="s" access="read"/> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Properties"> | ||
| <method name="Get"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg type="v" direction="out"/> | ||
| </method> | ||
| <method name="Set"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg name="value" type="v" direction="in"/> | ||
| </method> | ||
| <method name="GetAll"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg type="a{sv}" direction="out"/> | ||
| </method> | ||
| <!-- | ||
| Emits the `org.freedesktop.DBus.Properties.PropertiesChanged` signal. | ||
| --> | ||
| <signal name="PropertiesChanged"> | ||
| <arg name="interface_name" type="s"/> | ||
| <arg name="changed_properties" type="a{sv}"/> | ||
| <arg name="invalidated_properties" type="as"/> | ||
| </signal> | ||
| </interface> | ||
| </node> | ||
|
|
53 changes: 53 additions & 0 deletions
53
bindings/dbus-xml/org.shadowblip.Input.Source.EventDevice.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
|
|
||
| <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" | ||
| "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
| <node> | ||
| <interface name="org.freedesktop.DBus.Peer"> | ||
| <method name="Ping"> | ||
| </method> | ||
| <method name="GetMachineId"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Introspectable"> | ||
| <method name="Introspect"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.shadowblip.Input.Source.EventDevice"> | ||
| <!-- | ||
| Returns the full path to the device handler (e.g. /dev/input/event3) | ||
| --> | ||
| <property name="DevicePath" type="s" access="read"/> | ||
| <property name="Handlers" type="as" access="read"/> | ||
| <property name="Name" type="s" access="read"/> | ||
| <property name="PhysPath" type="s" access="read"/> | ||
| <property name="SysfsPath" type="s" access="read"/> | ||
| <property name="UniqueId" type="s" access="read"/> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Properties"> | ||
| <method name="Get"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg type="v" direction="out"/> | ||
| </method> | ||
| <method name="Set"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg name="value" type="v" direction="in"/> | ||
| </method> | ||
| <method name="GetAll"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg type="a{sv}" direction="out"/> | ||
| </method> | ||
| <!-- | ||
| Emits the `org.freedesktop.DBus.Properties.PropertiesChanged` signal. | ||
| --> | ||
| <signal name="PropertiesChanged"> | ||
| <arg name="interface_name" type="s"/> | ||
| <arg name="changed_properties" type="a{sv}"/> | ||
| <arg name="invalidated_properties" type="as"/> | ||
| </signal> | ||
| </interface> | ||
| </node> | ||
|
|
52 changes: 52 additions & 0 deletions
52
bindings/dbus-xml/org.shadowblip.Input.Source.HIDRawDevice.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
|
|
||
| <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" | ||
| "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
| <node> | ||
| <interface name="org.freedesktop.DBus.Properties"> | ||
| <method name="Get"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg type="v" direction="out"/> | ||
| </method> | ||
| <method name="Set"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg name="value" type="v" direction="in"/> | ||
| </method> | ||
| <method name="GetAll"> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg type="a{sv}" direction="out"/> | ||
| </method> | ||
| <!-- | ||
| Emits the `org.freedesktop.DBus.Properties.PropertiesChanged` signal. | ||
| --> | ||
| <signal name="PropertiesChanged"> | ||
| <arg name="interface_name" type="s"/> | ||
| <arg name="changed_properties" type="a{sv}"/> | ||
| <arg name="invalidated_properties" type="as"/> | ||
| </signal> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Introspectable"> | ||
| <method name="Introspect"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.shadowblip.Input.Source.HIDRawDevice"> | ||
| <property name="InterfaceNumber" type="i" access="read"/> | ||
| <property name="Manufacturer" type="s" access="read"/> | ||
| <property name="Path" type="s" access="read"/> | ||
| <property name="Product" type="s" access="read"/> | ||
| <property name="ProductId" type="s" access="read"/> | ||
| <property name="ReleaseNumber" type="s" access="read"/> | ||
| <property name="SerialNumber" type="s" access="read"/> | ||
| <property name="VendorId" type="s" access="read"/> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Peer"> | ||
| <method name="Ping"> | ||
| </method> | ||
| <method name="GetMachineId"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| </node> | ||
|
|
Oops, something went wrong.