diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/gir-1.2.rnc | 328 |
1 files changed, 164 insertions, 164 deletions
diff --git a/docs/gir-1.2.rnc b/docs/gir-1.2.rnc index 22f5888f..d7198688 100644 --- a/docs/gir-1.2.rnc +++ b/docs/gir-1.2.rnc @@ -8,14 +8,14 @@ grammar { ## Root node of a GIR repository. It contains namespaces, which can in turn be implemented in several libraries Repository = element repository { - ## version number of the repository + ## version number of the repository attribute version { xsd:string }?, - ## prefixes to filter out from C identifiers for data structures and types. For example, GtkWindow will be Window. If c:symbol-prefixes is not used, then this element is used for both + ## prefixes to filter out from C identifiers for data structures and types. For example, GtkWindow will be Window. If c:symbol-prefixes is not used, then this element is used for both attribute c:identifier-prefixes { xsd:string }?, - ## prefixes to filter out from C functions. For example, gtk_window_new will loose gtk_ + ## prefixes to filter out from C functions. For example, gtk_window_new will loose gtk_ attribute c:symbol-prefixes { xsd:string }?, - # Other elements a repository can contain + # Other elements a repository can contain (Include* & CInclude* & Package* @@ -25,20 +25,20 @@ grammar { ## Namespace which maps metadata entries to C functionality. This a similar concept to namespace in C++, but for GObject-based C libraries Namespace = element namespace { - ## name of the namespace. For example, 'Gtk' + ## name of the namespace. For example, 'Gtk' attribute name { xsd:string }?, - ## version number of the namespace + ## version number of the namespace attribute version { xsd:string }?, - ## prefixes to filter out from C identifiers for data structures and types. For example, GtkWindow will be Window. If c:symbol-prefixes is not used, then this element is used for both + ## prefixes to filter out from C identifiers for data structures and types. For example, GtkWindow will be Window. If c:symbol-prefixes is not used, then this element is used for both attribute c:identifier-prefixes { xsd:string }?, - ## prefixes to filter out from C functions. For example, gtk_window_new will loose gtk_ + ## prefixes to filter out from C functions. For example, gtk_window_new will loose gtk_ attribute c:symbol-prefixes { xsd:string }?, - ## Deprecated: the same as c:identifier-prefixes. Only used for backward compatibility + ## Deprecated: the same as c:identifier-prefixes. Only used for backward compatibility attribute c:prefix { xsd:string }?, - ## Path to the shared library implementing the namespace. It can be a comma-separated list, with relative path only + ## Path to the shared library implementing the namespace. It can be a comma-separated list, with relative path only attribute shared-library { xsd:string }?, - # Other elements a namespace can contain + # Other elements a namespace can contain (Alias* & Class* & Interface* @@ -54,18 +54,18 @@ grammar { } Annotation = - ## element defining an annotation from the source code, usually a user-defined annotation associated to a parameter or a return value + ## element defining an annotation from the source code, usually a user-defined annotation associated to a parameter or a return value element attribute { - ## name of the attribute + ## name of the attribute attribute name { xsd:string }, - ## value of the attribute + ## value of the attribute attribute value { xsd:string } } CInclude = ## Dependant C header file which should be included in C programs element c:include { - ## File name of the C header file. The path can be relative. + ## File name of the C header file. The path can be relative. attribute name { xsd:string }, empty @@ -74,18 +74,18 @@ grammar { Include = ## Dependant namespace to include with the current namespace. For example, Gtk will need the namespace GLib element include { - ## name of the dependant namespace to include + ## name of the dependant namespace to include attribute name { xsd:string }, - ## version of the dependant namespace to use + ## version of the dependant namespace to use attribute version { xsd:string }?, empty } Package = - ## Deprecated: package name containing the library + ## Deprecated: package name containing the library element package { - ## name of the package + ## name of the package attribute name { xsd:string }, empty @@ -94,14 +94,14 @@ grammar { Alias = ## Type's name substitution, representing a typedef in C element alias { - # Attributes of an Alias (see definition below) + # Attributes of an Alias (see definition below) Info.attrs, - ## the new name or typedef'd name + ## the new name or typedef'd name attribute name { xsd:string }, - ## the corresponding C type's name + ## the corresponding C type's name attribute c:type { xsd:string }, - # Other elements an alias can contain + # Other elements an alias can contain (Info.elements & Type) } @@ -109,22 +109,22 @@ grammar { Interface = ## Abstract interface to other classes element interface { - # Attributes of an Interface (see definition below) + # Attributes of an Interface (see definition below) Info.attrs, - ## name of the interface + ## name of the interface attribute name { xsd:string }, - ## Type name compatible with the GObject type system + ## Type name compatible with the GObject type system attribute glib:type-name { xsd:string }, - ## Function to get the GObject compatible type of the interface + ## Function to get the GObject compatible type of the interface attribute glib:get-type { xsd:string }, - ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ + ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ attribute c:symbol-prefix { xsd:string }?, - ## Corresponding C type + ## Corresponding C type attribute c:type { xsd:string }?, - ## GObject compatible C structure defining the Interface + ## GObject compatible C structure defining the Interface attribute glib:type-struct { xsd:string }?, - # Other elements an interface can contain + # Other elements an interface can contain (Info.elements & Prerequisite* & Implements* @@ -143,32 +143,32 @@ grammar { ## GObject inherited class definition element class { Info.attrs, - - ## Name of the class + + ## Name of the class attribute name { xsd:string }, - ## GObject compatible type name of the class + ## GObject compatible type name of the class attribute glib:type-name { xsd:string }, ## Function to get the GObject compatible type of the class attribute glib:get-type { xsd:string }, - ## Name of the parent class if any + ## Name of the parent class if any attribute parent { xsd:string }?, - ## GObject compatible C structure defining the class + ## GObject compatible C structure defining the class attribute glib:type-struct { xsd:string }?, - ## GObject compatible function to reference or increase the reference count of the class + ## GObject compatible function to reference or increase the reference count of the class attribute glib:ref-func { xsd:string }?, - ## GObject compatible function to unreference or decrease the reference count of the class + ## GObject compatible function to unreference or decrease the reference count of the class attribute glib:unref-func { xsd:string }?, - ## GObject compatible function to set a value of a property of the class + ## GObject compatible function to set a value of a property of the class attribute glib:set-value-func { xsd:string }?, - ## GObject compatible function to get a value of a property of the class + ## GObject compatible function to get a value of a property of the class attribute glib:get-value-func { xsd:string }?, - ## C type of the class + ## C type of the class attribute c:type { xsd:string }?, - ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ + ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ attribute c:symbol-prefix { xsd:string }?, - ## Binary attribute to declare the class abstract or not + ## Binary attribute to declare the class abstract or not attribute abstract { "0" | "1" }?, - ## Binary attribute to declare the class fundamental or not (top-level class which do not derives from any other type) + ## Binary attribute to declare the class fundamental or not (top-level class which do not derives from any other type) attribute glib:fundamental { "0" | "1" }?, # Other elements a class can contain @@ -191,43 +191,43 @@ grammar { ## Boxed type (wrapper to opaque C structures registered by the type system) element glib:boxed { Info.attrs, - ## GObject compatible type name of the boxed type + ## GObject compatible type name of the boxed type attribute glib:name { xsd:string }, - ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ + ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ attribute c:symbol-prefix { xsd:string }?, - ## GObject compatible type name of the boxed type + ## GObject compatible type name of the boxed type attribute glib:type-name { xsd:string }?, ## Function to get the GObject compatible type of the boxed type attribute glib:get-type { xsd:string }?, - # Other elements a Boxed type can contain + # Other elements a Boxed type can contain (Info.elements & Function*) } Record = - ## Record definition, equivalent to a C struct, that is a simple structure, not a class + ## Record definition, equivalent to a C struct, that is a simple structure, not a class element record { Info.attrs, - ## name of the record + ## name of the record attribute name { xsd:string }, - ## Corresponding C type of the record + ## Corresponding C type of the record attribute c:type { xsd:string }?, - ## Binary attribute to tell if the record is disguised, that is where the c:type is a typedef that doesn't look like a pointer, but is internally + ## Binary attribute to tell if the record is disguised, that is where the c:type is a typedef that doesn't look like a pointer, but is internally attribute disguised { "0" | "1" }?, - ## GObject compatible C type of the record + ## GObject compatible C type of the record attribute glib:type-name { xsd:string }?, ## Function to get the GObject compatible type of the record attribute glib:get-type { xsd:string }?, - ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ + ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ attribute c:symbol-prefix { xsd:string }?, - ## Binary attribute to tell if the record is foreign, that is it is not available in a g-i supported library + ## Binary attribute to tell if the record is foreign, that is it is not available in a g-i supported library attribute foreign { "0" | "1" }?, - ## Name of the GObject compatible gtype this record represents. If empty, this record will be hidden from generated public APIs. + ## Name of the GObject compatible gtype this record represents. If empty, this record will be hidden from generated public APIs. attribute glib:is-gtype-struct-for { xsd:string }?, - # Other elements a record can contain - # mandatory + # Other elements a record can contain + # mandatory (Info.elements & Field* & Function* @@ -243,11 +243,11 @@ grammar { attribute introspectable { "0" | "1" }?, ## Binary attribute which is "1" (true) if the element has been deprecated attribute deprecated { xsd:string }?, - ## Version number from which this element is deprecated + ## Version number from which this element is deprecated attribute deprecated-version { xsd:string }?, ## version number of an element attribute version { xsd:string }?, - ## give the statibility status of the element. Can take the values "Stable", "Unstable" or "Private" + ## give the statibility status of the element. Can take the values "Stable", "Unstable" or "Private" attribute stability { xsd:string }? ) @@ -255,53 +255,53 @@ grammar { DocElements = ( ## Version of the documentation element doc-version { - ## Preserve the original formatting of the documentation from the source code + ## Preserve the original formatting of the documentation from the source code attribute xml:space { "preserve" }?, - ## Preserve the original formatting of the documentation from the source code. Recommended to use this instead of xml:space + ## Preserve the original formatting of the documentation from the source code. Recommended to use this instead of xml:space attribute xml:whitespace { "preserve" }?, - ## the text of the version of the documentation + ## the text of the version of the documentation text }? ## give the stability of the documentation & element doc-stability { - ## Preserve the original formatting of the documentation from the source code + ## Preserve the original formatting of the documentation from the source code attribute xml:space { "preserve" }?, - ## Preserve the original formatting of the documentation from the source code. Recommended to use this instead of xml:space + ## Preserve the original formatting of the documentation from the source code. Recommended to use this instead of xml:space attribute xml:whitespace { "preserve" }?, ## a text value about the stability of the documentation. Usually a simple description like stable or unstable text }? ## documentation of an element & element doc { - ## Preserve the original formatting of the documentation from the source code + ## Preserve the original formatting of the documentation from the source code attribute xml:space { "preserve" }?, ## Keep the whitespace as they were in the source code attribute xml:whitespace { "preserve" }?, - ## The file containing this documentation + ## The file containing this documentation attribute filename { xsd:string }, - ## The first line of the documentation in the source code + ## The first line of the documentation in the source code attribute line { xsd:string }, - ## The first column of the documentation in the source code + ## The first column of the documentation in the source code attribute column { xsd:string }, - ## the text of the documentation + ## the text of the documentation text }? - ## Deprecated documentation of an element. Kept for historical reasons in general + ## Deprecated documentation of an element. Kept for historical reasons in general & element doc-deprecated { - ## Preserve the original formatting of the documentation from the source code + ## Preserve the original formatting of the documentation from the source code attribute xml:space { "preserve" }?, ## Keep the whitespace as they were in the source code attribute xml:whitespace { "preserve" }?, - ## the text of the deprecated documentation + ## the text of the deprecated documentation text }? ## Position of the documentation in the original source code & element source-position { - ## File name of the source of the documentation + ## File name of the source of the documentation attribute filename { xsd:string }, - ## The first line of the documentation in the source code + ## The first line of the documentation in the source code attribute line { xsd:string }, - ## The first column of the documentation in the source code + ## The first column of the documentation in the source code attribute column { xsd:string }, }? ) @@ -316,16 +316,16 @@ grammar { ## A constant entity, similar to const variable in C element constant { Info.attrs, - ## name of the constant + ## name of the constant attribute name { xsd:string }, - ## value of the constant + ## value of the constant attribute value { xsd:string }, - ## corresponding C type of the constant in C + ## corresponding C type of the constant in C attribute c:type { xsd:string }?, - ## corresponding C identifier in the source code + ## corresponding C identifier in the source code attribute c:identifier { xsd:string }?, - # Other elements a record can contain + # Other elements a record can contain (Info.elements & AnyType?) } @@ -334,20 +334,20 @@ grammar { ## Property, that is a variable or members with getter and setter functions element property { Info.attrs, - ## name of the property + ## name of the property attribute name { xsd:string }, - ## Binary attribute, true if the property is writeable, that is it has a setter function + ## Binary attribute, true if the property is writeable, that is it has a setter function attribute writable { "0" | "1" }?, - ## Binary attribute, true if the property is readable, that is it has a getter function + ## Binary attribute, true if the property is readable, that is it has a getter function attribute readable { "0" | "1" }?, - ## Binary attribute, true if the property will be set upon construction + ## Binary attribute, true if the property will be set upon construction attribute construct { "0" | "1" }?, - ## Binary attribute, true if the property can only be set upon construction + ## Binary attribute, true if the property can only be set upon construction attribute construct-only { "0" | "1" }?, - # Define the transfer of ownership of the property element + # Define the transfer of ownership of the property element TransferOwnership?, - # Other elements a property can contain + # Other elements a property can contain (Info.elements & AnyType) } @@ -356,20 +356,20 @@ grammar { ## A signal as defined in the GObject system (https://developer.gnome.org/gobject/stable/signal.html) element glib:signal { Info.attrs, - ## name of the signal + ## name of the signal attribute name { xsd:string }, - ## Binary attribute, true if the signal has a detailed parameter (https://developer.gnome.org/gobject/stable/signal.html#signal-detail# and https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) + ## Binary attribute, true if the signal has a detailed parameter (https://developer.gnome.org/gobject/stable/signal.html#signal-detail# and https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) attribute detailed { "0" | "1" }?, - ## When to run the signal during the 5 steps of signal emission (https://developer.gnome.org/gobject/stable/signal.html#signal-emission and https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) + ## When to run the signal during the 5 steps of signal emission (https://developer.gnome.org/gobject/stable/signal.html#signal-emission and https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) attribute when { "first" | "last" | "cleanup" }?, - ## Binary attribute, true if the signal can be freely emitted on alive objects from user code (https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) + ## Binary attribute, true if the signal can be freely emitted on alive objects from user code (https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) attribute action { "0" | "1" }?, - ## Binary attribute, true if no emission hooks are supported for this signal (https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) + ## Binary attribute, true if no emission hooks are supported for this signal (https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) attribute no-hooks { "0" | "1" }?, - ## Binary attribute, true if signals emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted (https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) + ## Binary attribute, true if signals emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted (https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) attribute no-recurse { "0" | "1" }?, - # Other elements a property can contain + # Other elements a property can contain (Info.elements & Callable.params? & Callable.return?) @@ -379,18 +379,18 @@ grammar { ## A field of struct of union structure, that is a C bit field, that is a fixed length in bits variable element field { Info.attrs, - ## name of the field + ## name of the field attribute name { xsd:string }, - ## Binary attribute, true if the field is writeable + ## Binary attribute, true if the field is writeable attribute writable { "0" | "1" }?, - ## Binary attribute, true if the field is readable + ## Binary attribute, true if the field is readable attribute readable { "0" | "1" }?, - ## Binary attribute, true if the field is private to the structure or has public ("0") visibility + ## Binary attribute, true if the field is private to the structure or has public ("0") visibility attribute private { "0" | "1" }?, - ## number of bits of the field + ## number of bits of the field attribute bits { xsd:integer }?, - # Other elements a property can contain + # Other elements a property can contain (Info.elements & (Callback | AnyType)) } @@ -399,30 +399,30 @@ grammar { ## A callback closure, that is a function called when a signal is emitted (as an answer to that signal) element callback { Info.attrs, - ## name of the callback + ## name of the callback attribute name { xsd:string }, - ## the C type returned by the callback closure (i.e. function) + ## the C type returned by the callback closure (i.e. function) attribute c:type { xsd:string }?, - ## Binary attribute, true if the callback can throw an error + ## Binary attribute, true if the callback can throw an error attribute throws { "0" | "1" }?, - # Other elements a property can contain + # Other elements a property can contain (Info.elements & Callable.params? & Callable.return?) } Implements = - ## Give the name of the interface it implements. This element is generally used within a class element + ## Give the name of the interface it implements. This element is generally used within a class element element implements { - ## name of the interface implemented by a class + ## name of the interface implemented by a class attribute name { xsd:string } } Prerequisite = ## Interface which is pre-required to implement another interface. This node is generally using within an interface element element prerequisite { - ## name of the required interface + ## name of the required interface attribute name { xsd:string } } @@ -432,9 +432,9 @@ grammar { Type = # A simple type of data (as opposed to an array) element type { - ## name of the type + ## name of the type attribute name { xsd:string }?, - ## the C representation of the type + ## the C representation of the type attribute c:type { xsd:string }?, ## Binary attribute which is "0" (false) if the element is not introspectable. It doesn't exist in the bindings, due in general to missing information in the annotations in the original C code attribute introspectable { "0" | "1" }?, @@ -445,20 +445,20 @@ grammar { ArrayType = ## An array type of data where each element is of the same type element array { - ## name of the array type + ## name of the array type attribute name { xsd:string }?, - ## Binary attribute, true if the last element of the array is zero. For example, in an array of pointers, the last pointer would be NULL + ## Binary attribute, true if the last element of the array is zero. For example, in an array of pointers, the last pointer would be NULL attribute zero-terminated { "0" | "1" }?, - ## size of an array of predetermined fixed size. For example a C array declared as char arr[5]. + ## size of an array of predetermined fixed size. For example a C array declared as char arr[5]. attribute fixed-size { xsd:integer }?, ## Binary attribute which is "0" (false) if the element is not introspectable. It doesn't exist in the bindings, due in general to missing information in the annotations in the original C code attribute introspectable { "0" | "1" }?, - ## the initial length of the array. If the value is 0 (zero) it means the length is unknown (as it is the case with zero-terminated arrays) + ## the initial length of the array. If the value is 0 (zero) it means the length is unknown (as it is the case with zero-terminated arrays) attribute length { xsd:integer }?, - ## the C representation of the array type + ## the C representation of the array type attribute c:type { xsd:string }?, - # Type of the values contained in the array + # Type of the values contained in the array AnyType } @@ -479,17 +479,17 @@ grammar { ## Attributes of a Callable (functions, callbacks, closures, etc...) Callable.attrs = ( Info.attrs, - ## name of the Callable + ## name of the Callable attribute name { xsd:string }, - # C identifier in the source code of the Callable + # C identifier in the source code of the Callable attribute c:identifier { xsd:string }?, - ## Callable it is shadowed by. For example, in C++, only one version of an overloaded callable will appear + ## Callable it is shadowed by. For example, in C++, only one version of an overloaded callable will appear attribute shadowed-by { xsd:string }?, - ## Callable it shadows. For example, in C++, only one version of an overloaded callable will appear + ## Callable it shadows. For example, in C++, only one version of an overloaded callable will appear attribute shadows { xsd:string }?, - ## Binary attribute, true if the callable can throw an error + ## Binary attribute, true if the callable can throw an error attribute throws { "0" | "1" }?, - ## if for backward compatibility reason the callable has a name in the source code but should be known by another one, this attribute contains the new name + ## if for backward compatibility reason the callable has a name in the source code but should be known by another one, this attribute contains the new name attribute moved-to { xsd:string }? ) @@ -503,29 +503,29 @@ grammar { Callable.params = ## parameters element of a callable, that is in general parameters of a function or similar element parameters { - ## parameter element of a list of parameters + ## parameter element of a list of parameters element parameter { - ## name of the parameter + ## name of the parameter attribute name { xsd:string }?, - ## Binary attribute, true if the parameter can have a null value + ## Binary attribute, true if the parameter can have a null value attribute nullable { "0" | "1" }?, - ## Deprecated. Replaced by nullable and optional + ## Deprecated. Replaced by nullable and optional attribute allow-none { "0" | "1" }?, ## Binary attribute which is "0" (false) if the element is not introspectable. It doesn't exist in the bindings, due in general to missing information in the annotations in the original C code attribute introspectable { "0" | "1" }?, - ## the parameter is a user_data for callbacks. The value points to a different parameter that is the actual callback + ## the parameter is a user_data for callbacks. The value points to a different parameter that is the actual callback attribute closure { xsd:integer }?, - ## the parameter is a destroy_data for callbacks. The value points to a different parameter that is the actual callback + ## the parameter is a destroy_data for callbacks. The value points to a different parameter that is the actual callback attribute destroy { xsd:integer }?, - ## the parameter is a callback, the value indicates the lifetime of the call. For language bindings which want to know when the resources required to do the call can be freed. "notified" valid until a GDestroyNotify argument is called, "async" only valid for the duration of the first callback invocationi (can only be called once), "call" only valid for the duration of the call, can be called multiple times during the call. + ## the parameter is a callback, the value indicates the lifetime of the call. For language bindings which want to know when the resources required to do the call can be freed. "notified" valid until a GDestroyNotify argument is called, "async" only valid for the duration of the first callback invocationi (can only be called once), "call" only valid for the duration of the call, can be called multiple times during the call. attribute scope { "notified" | "async" | "call" }?, - ## direction of the parameter. "in" goes into the callable, "out" for output parameters from the callable (reference in C++, var in Pascal, etc...), "inout" for both (like a pre-allocated structure which will be filled-in by the callable) + ## direction of the parameter. "in" goes into the callable, "out" for output parameters from the callable (reference in C++, var in Pascal, etc...), "inout" for both (like a pre-allocated structure which will be filled-in by the callable) attribute direction { "out" | "in" | "inout" }?, - ## Binary attribute, true if the caller should allocate the parameter before calling the callable + ## Binary attribute, true if the caller should allocate the parameter before calling the callable attribute caller-allocates { "0" | "1" }?, - ## Binary attribute, true if the parameter is optional + ## Binary attribute, true if the parameter is optional attribute optional { "0" | "1" }?, - ## Binary attribute, true if the parameter can be omitted from the introspected output + ## Binary attribute, true if the parameter can be omitted from the introspected output attribute skip { "0" | "1" }?, TransferOwnership?, @@ -533,17 +533,17 @@ grammar { & (AnyType | VarArgs)) }* - ## instance-parameter is a parameter of a C function which is an instance of an existing object. So the callable is surely a method of a class, and this parameter points to the instance of the object. In C++, this would be equivalent to the pointer this which is not passed to the method, in Python it's equivalent to self. + ## instance-parameter is a parameter of a C function which is an instance of an existing object. So the callable is surely a method of a class, and this parameter points to the instance of the object. In C++, this would be equivalent to the pointer this which is not passed to the method, in Python it's equivalent to self. & element instance-parameter { - ## name of the instance-parameter + ## name of the instance-parameter attribute name { xsd:string }, - ## Binary attribute, true if the parameter can have a null value + ## Binary attribute, true if the parameter can have a null value attribute nullable { "0" | "1" }?, - ## Deprecated. Replaced by nullable and optional + ## Deprecated. Replaced by nullable and optional attribute allow-none { "0" | "1" }?, - ## direction of the parameter. "in" goes into the callable, "out" for output parameters from the callable (reference in C++, var in Pascal, etc...), "inout" for both (like a pre-allocated structure which will be filled-in by the callable) + ## direction of the parameter. "in" goes into the callable, "out" for output parameters from the callable (reference in C++, var in Pascal, etc...), "inout" for both (like a pre-allocated structure which will be filled-in by the callable) attribute direction { "out" | "in" | "inout" }?, - ## Binary attribute, true if the caller should allocate the parameter before calling the callable + ## Binary attribute, true if the caller should allocate the parameter before calling the callable attribute caller-allocates { "0" | "1" }?, TransferOwnership?, @@ -557,17 +557,17 @@ grammar { element return-value { ## Binary attribute which is "0" (false) if the element is not introspectable. It doesn't exist in the bindings, due in general to missing information in the annotations in the original C code attribute introspectable { "0" | "1" }?, - ## Binary attribute, true if the parameter can have a null value + ## Binary attribute, true if the parameter can have a null value attribute nullable { "0" | "1" }?, - ## the parameter is a user_data for callbacks. The value points to a different parameter that is the actual callback + ## the parameter is a user_data for callbacks. The value points to a different parameter that is the actual callback attribute closure { xsd:integer }?, - ## the parameter is a callback, the value indicates the lifetime of the call. For language bindings which want to know when the resources required to do the call can be freed. "notified" valid until a GDestroyNotify argument is called, "async" only valid for the duration of the first callback invocationi (can only be called once), "call" only valid for the duration of the call, can be called multiple times during the call. + ## the parameter is a callback, the value indicates the lifetime of the call. For language bindings which want to know when the resources required to do the call can be freed. "notified" valid until a GDestroyNotify argument is called, "async" only valid for the duration of the first callback invocationi (can only be called once), "call" only valid for the duration of the call, can be called multiple times during the call. attribute scope { "notified" | "async" | "call" }?, - ## the parameter is a destroy_data for callbacks. The value points to a different parameter that is the actual callback + ## the parameter is a destroy_data for callbacks. The value points to a different parameter that is the actual callback attribute destroy { xsd:integer }?, - ## Binary attribute, true if the parameter can be omitted from the introspected output + ## Binary attribute, true if the parameter can be omitted from the introspected output attribute skip { "0" | "1" }?, - ## Deprecated. Replaced by nullable and optional + ## Deprecated. Replaced by nullable and optional attribute allow-none { "0" | "1" }?, TransferOwnership?, @@ -599,7 +599,7 @@ grammar { ## element defining a virtual method from a class, concept similar to C++ element virtual-method { Callable.attrs, - ## name of the callable called when invoking this virtual method + ## name of the callable called when invoking this virtual method attribute invoker { xsd:string }?, (Info.elements @@ -611,15 +611,15 @@ grammar { ## element defining a type of data being a union of type, similar to union in C/C++ but extended with fields and methods element union { Info.attrs, - ## name of the union + ## name of the union attribute name { xsd:string }?, - ## C type defining the union + ## C type defining the union attribute c:type { xsd:string }?, - ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ + ## prefix to filter out from C functions. For example, gtk_window_new will loose gtk_ attribute c:symbol-prefix { xsd:string }?, - ## GObject compatible type name + ## GObject compatible type name attribute glib:type-name { xsd:string }?, - ## function to retrieve the GObject compatible type of the element + ## function to retrieve the GObject compatible type of the element attribute glib:get-type { xsd:string }?, (Info.elements @@ -631,16 +631,16 @@ grammar { } BitField = - ## element defining a bit field (as in C) + ## element defining a bit field (as in C) element bitfield { Info.attrs, ## name of the bit field attribute name { xsd:string }, - ## corresponding C type of the bit field type + ## corresponding C type of the bit field type attribute c:type { xsd:string }, - ## GObject compatible type name + ## GObject compatible type name attribute glib:type-name { xsd:string }?, - ## function to retrieve the GObject compatible type of the element + ## function to retrieve the GObject compatible type of the element attribute glib:get-type { xsd:string }?, (Info.elements @@ -652,15 +652,15 @@ grammar { ## element defining a enumeration type similar to enum in C/C++ element enumeration { Info.attrs, - ## name of the enumeration + ## name of the enumeration attribute name { xsd:string }, - ## corresponding C type of the enumeration type + ## corresponding C type of the enumeration type attribute c:type { xsd:string }, - ## GObject compatible type name + ## GObject compatible type name attribute glib:type-name { xsd:string }?, - ## function to retrieve the GObject compatible type of the element + ## function to retrieve the GObject compatible type of the element attribute glib:get-type { xsd:string }?, - ## Error domain of the enumeration, usually a string which can then be converted to a GQuark + ## Error domain of the enumeration, usually a string which can then be converted to a GQuark attribute glib:error-domain { xsd:string }?, (Info.elements @@ -672,13 +672,13 @@ grammar { ## element defining a member of a bit field or an enumeration element member { Info.attrs, - ## name of the member + ## name of the member attribute name { xsd:string }, - ## value of the member + ## value of the member attribute value { xsd:string }, - ## corresponding C type of the member + ## corresponding C type of the member attribute c:identifier { xsd:string }, - ## short nickname of the member + ## short nickname of the member attribute glib:nick { xsd:string }?, Info.elements |