forked from enlightenment/efl
docs: eldbus: document all eldbus structs and its members
This commit is contained in:
parent
f486be101c
commit
30a049a7b7
|
@ -1,73 +1,82 @@
|
||||||
import eina_types;
|
import eina_types;
|
||||||
|
|
||||||
struct Eldbus.Proxy;
|
struct Eldbus.Proxy; [[Represents a client object bound to an interface]]
|
||||||
struct Eldbus.Connection; [[Represents a connection of one the type of connection with the DBus daemon.]]
|
struct Eldbus.Connection; [[Represents a connection of one the type of connection with the DBus daemon.]]
|
||||||
struct Eldbus.Object; [[Represents an object path already attached with bus name or unique id]]
|
struct Eldbus.Object; [[Represents an object path already attached with bus name or unique id]]
|
||||||
|
|
||||||
enum Eldbus.Introspection.Argument_Direction
|
enum Eldbus.Introspection.Argument_Direction
|
||||||
{
|
{
|
||||||
none = 0,
|
[[Argument direction]]
|
||||||
in,
|
none = 0, [[No direction]]
|
||||||
out,
|
in, [[Incoming direction]]
|
||||||
|
out, [[Outgoing direction]]
|
||||||
}
|
}
|
||||||
|
|
||||||
/* DTD conversion form: http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd */
|
/* DTD conversion form: http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd */
|
||||||
|
|
||||||
enum Eldbus.Introspection.Property_Access
|
enum Eldbus.Introspection.Property_Access
|
||||||
{
|
{
|
||||||
read,
|
[[Property access rights]]
|
||||||
write,
|
read, [[Property can be read]]
|
||||||
readwrite,
|
write, [[Property can be written]]
|
||||||
|
readwrite, [[Property can be read and written]]
|
||||||
}
|
}
|
||||||
|
|
||||||
/* FIXME: Properly type all of these lists. */
|
/* FIXME: Properly type all of these lists. */
|
||||||
struct Eldbus.Introspection.Node
|
struct Eldbus.Introspection.Node
|
||||||
{
|
{
|
||||||
name: stringshare; [[optional]]
|
[[DBus Node]]
|
||||||
nodes: list<void *>;
|
name: stringshare; [[Node name (optional)]]
|
||||||
interfaces: list<void *>;
|
nodes: list<void *>; [[List with nodes]]
|
||||||
|
interfaces: list<void *>; [[List with interfaces]]
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Eldbus.Introspection.Interface
|
struct Eldbus.Introspection.Interface
|
||||||
{
|
{
|
||||||
name: stringshare;
|
[[DBus Interface]]
|
||||||
methods: list<void *>;
|
name: stringshare; [[Interface name]]
|
||||||
signals: list<void *>;
|
methods: list<void *>; [[List with interface methods]]
|
||||||
properties: list<void *>;
|
signals: list<void *>; [[List with interface signals]]
|
||||||
annotations: list<void *>;
|
properties: list<void *>; [[List with interface properties]]
|
||||||
|
annotations: list<void *>; [[List with interface annotations]]
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Eldbus.Introspection.Method
|
struct Eldbus.Introspection.Method
|
||||||
{
|
{
|
||||||
name: stringshare;
|
[[DBus Method]]
|
||||||
arguments: list<void *>;
|
name: stringshare; [[Method name]]
|
||||||
annotations: list<void *>;
|
arguments: list<void *>; [[List with method arguments]]
|
||||||
|
annotations: list<void *>; [[List with method annotations]]
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Eldbus.Introspection.Property
|
struct Eldbus.Introspection.Property
|
||||||
{
|
{
|
||||||
name: stringshare;
|
[[DBus Property]]
|
||||||
type: stringshare;
|
name: stringshare; [[Property name]]
|
||||||
access: Eldbus.Introspection.Property_Access;
|
type: stringshare; [[Property type]]
|
||||||
annotations: list<void *>;
|
access: Eldbus.Introspection.Property_Access; [[Property access rights]]
|
||||||
|
annotations: list<void *>; [[List with property annotations]]
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Eldbus.Introspection.Annotation
|
struct Eldbus.Introspection.Annotation
|
||||||
{
|
{
|
||||||
name: stringshare;
|
[[DBus Annotation]]
|
||||||
value: stringshare;
|
name: stringshare; [[Annotation name]]
|
||||||
|
value: stringshare; [[Annotation value]]
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Eldbus.Introspection.Argument
|
struct Eldbus.Introspection.Argument
|
||||||
{
|
{
|
||||||
name: stringshare; [[Optional]]
|
[[DBus Argument]]
|
||||||
type: stringshare;
|
name: stringshare; [[Argument name (optional)]]
|
||||||
direction: Eldbus.Introspection.Argument_Direction;
|
type: stringshare; [[Argument type]]
|
||||||
|
direction: Eldbus.Introspection.Argument_Direction; [[Argument direction]]
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Eldbus.Introspection.Signal
|
struct Eldbus.Introspection.Signal
|
||||||
{
|
{
|
||||||
name: stringshare;
|
[[DBus Signal]]
|
||||||
arguments: list<Eldbus.Introspection.Argument *>;
|
name: stringshare; [[Signal name]]
|
||||||
annotations: list<Eldbus.Introspection.Annotation *>;
|
arguments: list<Eldbus.Introspection.Argument *>; [[List with signal arguments]]
|
||||||
|
annotations: list<Eldbus.Introspection.Annotation *>; [[List with signal annotations]]
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue