From 16863d91ec98d17a3ec36c37f73e7859bf97841b Mon Sep 17 00:00:00 2001 From: Dmitry Kalyanov Date: Sat, 11 Jul 2009 14:35:44 +0400 Subject: [PATCH] Generated documentation for gobject.type-info --- doc/references/gobject.type-info/.atdoc.xml | 44 +++++++ doc/references/gobject.type-info/header.gif | Bin 0 -> 276 bytes doc/references/gobject.type-info/index.css | 179 +++++++++++++++++++++++++++ doc/references/gobject.type-info/index.html | 48 +++++++ 4 files changed, 271 insertions(+) create mode 100644 doc/references/gobject.type-info/.atdoc.xml create mode 100644 doc/references/gobject.type-info/header.gif create mode 100644 doc/references/gobject.type-info/index.css create mode 100644 doc/references/gobject.type-info/index.html diff --git a/doc/references/gobject.type-info/.atdoc.xml b/doc/references/gobject.type-info/.atdoc.xml new file mode 100644 index 0000000..1d58b7d --- /dev/null +++ b/doc/references/gobject.type-info/.atdoc.xml @@ -0,0 +1,44 @@ + +This package contains functions for querying the basic type information from GObject type system. For an overview of GObject type system, see GObject documentationTypes are identified by GType designators that are specified in g-type-designator. Functions of this package provide means to query basic information about type.g-type-name and g-type-from-name convert between numeric and string representation of GType.g-type-parent, g-type-children and g-type-interfaces traverse across the type hierarchy.g-type-depth, g-type-fundamental, g-type-is-a, g-type-next-base are convenience functions that provide useful information from type hierarchy +This is a list of variables and functions that correspond to basic types:g-closure-get-typeg-strv-get-type+g-type-invalid++g-type-void++g-type-interface++g-type-char++g-type-uchar++g-type-boolean++g-type-int++g-type-uint++g-type-long++g-type-ulong++g-type-int64++g-type-uint64++g-type-enum++g-type-flags++g-type-float++g-type-double++g-type-string++g-type-pointer++g-type-boxed++g-type-param++g-type-object+Returns the type designator (see g-type-designator) for GStrv type. As a side effect, ensures that the type is registered.The fundamental type corresponding to gint64.The fundamental type from which all GParamSpec types are derived.The fundamental type corresponding to gboolean.leaf-typeroot-typeDetermines the type that is derived directly from root-type which is also a base class of leaf-type. +Example:
+(g-type-next-base "GtkButton" "GtkWidget")
+=> "GtkContainer"
GType designator (see g-type-designator)GType designatorGType designatorThe fundamental type from which all boxed types are derived.The fundamental type corresponding to guchar.The fundamental type corresponding to guint64.g-typeReturns the prerequisites of an interface type. Prerequisite is a type that must be a superclass of an implementing class or an interface that the object must also implement. +Example:
+(g-type-interface-prerequisites "GtkTreeModel")
+=> ("GObject")
GType designator (see g-type-designator)list of GType designatorsAn invalid GType used as error return value in some functions which return a GType.The fundamental type from which all interfaces are derived.Values of this CFFI foreign type identify the GType. GType is designated by a its name (a string) or a numeric identifier. Functions accept GType designators as a string or integer and return them as a string. Functions g-type-name and g-type-from-name are used to convert between name and numeric identifier.Numeric identifier of GType may be different between different program runs. But string identifier of GType does not change.The fundamental type for GObject.The fundamental type corresponding to gchar. The type designated by +g-type-char+ is unconditionally an 8-bit signed integer. This may or may not be the same type a the C type gchar.The fundamental type corresponding to gint.The fundamental type corresponding to gpointer.g-typeReturns the list of types inherited from g-type.g-type-parent +Example:
+(g-type-children "GtkObject")
+=> ("GtkWidget" "GtkAdjustment" "GtkTreeViewColumn" "GtkCellRenderer"
+    "GtkFileFilter" "GtkRecentFilter" "GtkTooltips")
GType designator (see g-type-designator)list of GType designatorsReturns the type designator (see g-type-designator) for GClosure type. As a side effect, ensure that the type is registered.The fundamental type corresponding to guint.A fundamental type which is used as a replacement for the C void return type.The fundamental type from which all enumeration types are derived.typeReturns the name of a GType.g-type-from-name +Example:
+(g-type-from-name "GtkLabel")
+=> 7151952
+(g-type-name 7151952)
+=> "GtkLabel"
GType designator (see g-type-designator)a stringThe fundamental type corresponding to gfloat.The fundamental type corresponding to gdouble.typeReturns the length of the ancestry of type. This includes the type itself, so that e.g. a fundamental type has depth 1. +Example:
+(g-type-depth "GtkLabel")
+=> 6
GType designator (see g-type-designator)an integerThe fundamental type corresponding to glong.typeReturns the parent of a GType. g-type-chilren +Example:
+(g-type-parent "GtkLabel")
+=> "GtkMisc"
GType designator (see g-type-designator)GType designatorThe fundamental type corresponding to gulong.The fundamental type corresponding to null-terminated C strings.typeis-a-typeIf is-a-type is a derivable type, check whether type is a descendant of is-a-type. If is-a-type is an interface, check whether type conforms to it. +Example:
+(g-type-is-a "GtkButton" "GtkWidget")
+=> T
+(g-type-is-a "GtkButton" "AtkImplementorIface")
+=> T
+(g-type-is-a "GtkButton" "GtkLabel")
+=> NIL
GType designator (see g-type-designator)GType designatorbooleantypeReturns the fundamental type which is the ancestor of type. +Example:
+(g-type-fundamental "GtkWindowType")
+=> "GEnum"
+(g-type-fundamental "GtkLabel")
+=> "GObject"
GType designator (see g-type-designator)GType designatornameReturns the numeric identifier of a GType by its name. g-type-name +Example:
+(g-type-from-name "GtkLabel")
+=> 7151952
+(g-type-name 7151952)
+=> "GtkLabel"
a string - name of GTypean integerThe fundamental type from which all flags types are derived.g-typeReturns the list of interfaces the g-type conforms to. +Example:
+(g-type-interfaces "GtkButton")
+=> ("AtkImplementorIface" "GtkBuildable" "GtkActivatable")
GType designator (see g-type-designator)list of GType designatorsxtypen-interfacesinterfacetypetypen-childrentypen-interface-prerequisites \ No newline at end of file diff --git a/doc/references/gobject.type-info/header.gif b/doc/references/gobject.type-info/header.gif new file mode 100644 index 0000000000000000000000000000000000000000..8fa784751e5b2e765bdcf56b7388b9d9699b62d8 GIT binary patch literal 276 zcmZ?wbhEHbWMpt-SgOge`q9tl&!4{lftMf%LN8x|5D-GZYan<7!XWS#ghAjP7{7b> z?mY;-e-Fm*KL7!U_y|NFf#~BWAOeBUpFtQ1zI*`@K(1_h26 IjE)S}0D_shG5`Po literal 0 HcmV?d00001 diff --git a/doc/references/gobject.type-info/index.css b/doc/references/gobject.type-info/index.css new file mode 100644 index 0000000..85e4d5b --- /dev/null +++ b/doc/references/gobject.type-info/index.css @@ -0,0 +1,179 @@ +div.sidebar { + float: right; + min-width: 15%; + padding: 0pt 5pt 5pt 5pt; + font-family: verdana, arial; +} + +a { + text-decoration: none; + color: black; + border-bottom: 1px solid #0070a0; +} + +.nonlink { + border-bottom: 1px solid white; + border-top: 1px solid white; + border-left: 1px solid white; + border-right: 1px solid white; + padding-top: 1px; + padding-bottom: 1px; +} + +.sidebar a { + border-top: 1px solid #eeeeee; + border-left: 1px solid #eeeeee; + border-right: 1px solid #eeeeee; +} + +#headerlink { + border: none; +} + +#headerlink:hover { + border: none; +} + +body { + color: #000000; + background-color: #ffffff; + margin: 0 0 0 0; +/* + margin-top: 2em; + margin-right: 20pt; + margin-bottom: 10%; + */ + font-family: verdana, arial; + font-size: 8pt; +} + +.main { + margin-top: 20px; + margin-left: 40px; +} + +.padded { + padding-left: 30px; +} + +.padded h1,h2 { + margin-left: -30px; +} + +h2 { + color: #0070a0; +} + +.page-title { + color: black; +} + +h3 { + background-color: #f4f4f4; + padding-top: 4px; + padding-bottom: 4px; + border-bottom: 1px solid #80d8fd; + color: #000000; + width: 90%; + margin-top: 2em; + margin-left: -3px; + padding-left: 3px; + font-weight: bold; +} + +h4 { +} + +.grau { + padding-top: 1em; +} + +pre { + background-color: #eeeeee; + border: solid 1px #d0d0d0; + padding: 1em; + margin-right: 10%; +} + +.code { + border: solid 1px #d0d0d0; + padding: 1em; + margin-right: 10%; +} + +.indent { + margin-left: 20px; + padding-bottom: 1em; +} + +.def { + padding: 1px 1px 1px 1px; + margin-bottom: 1px; + font-weight: bold; + margin-right: 40px; +} + +.nomargin { + margin-bottom: 0; + margin-top: 0; +} + +.noindent { + margin-left: -30px; + padding-bottom: 1em; +} + +#header table { + width: 95%; + position: absolute; + bottom: 10px; + margin-right: 1em; +} + +#header { + background: url(header.gif); + position: relative; /* so that the table is relativ to this */ + width: 100%; + height: 70px; + font-family: verdana, arial; + font-size: 12pt; + padding-bottom: 1px; +} + +#sp-package-list { + /* ... */ +} + +#sp-about-packages { + /* ... */ +} + +.sp-lambda-list { + width: 90%; + background-color: #f4f4f4; + padding: 3px 3px 3px 3px; +} + +.sp-definition { + width: 90%; + border: 1px solid #cccccc; + padding: 3px 3px 3px 3px; +} + +.sp-definition-body { + padding-left: 10%; + padding-bottom: 2em; +} + +.sp-definition-body ul { + margin-top: 0; + margin-bottom: 0; +} + +.sp-return { +} + +.sph3 { + padding-top: 1em; + font-weight: bold; +} diff --git a/doc/references/gobject.type-info/index.html b/doc/references/gobject.type-info/index.html new file mode 100644 index 0000000..254b103 --- /dev/null +++ b/doc/references/gobject.type-info/index.html @@ -0,0 +1,48 @@ + +gobject.type-info API reference

About gobject.type-info:

This package contains functions for querying the basic type information from GObject type system. For an overview of GObject type system, see GObject documentation

Types are identified by GType designators that are specified in g-type-designator. Functions of this package provide means to query basic information about type.



+This is a list of variables and functions that correspond to basic types:

Other functions in gobject.type-info

Function g-closure-get-type ()
Details:
Returns the type designator (see g-type-designator) for GClosure type. As a side effect, ensure that the type is registered.
See also:

Function g-strv-get-type ()
Details:
Returns the type designator (see g-type-designator) for GStrv type. As a side effect, ensures that the type is registered.
See also:

Function g-type-children (g-type)
Arguments:
Returns:
list of GType designators
Details:
Returns the list of types inherited from g-type.

+Example:
+(g-type-children "GtkObject")
+=> ("GtkWidget" "GtkAdjustment" "GtkTreeViewColumn" "GtkCellRenderer"
+    "GtkFileFilter" "GtkRecentFilter" "GtkTooltips")
See also:

Function g-type-depth (type)
Arguments:
Returns:
an integer
Details:
Returns the length of the ancestry of type. This includes the type itself, so that e.g. a fundamental type has depth 1.

+Example:
+(g-type-depth "GtkLabel")
+=> 6
See also:

Function g-type-from-name (name)
Arguments:
  • name -- a string - name of GType
Returns:
an integer
Details:
Returns the numeric identifier of a GType by its name.

+Example:
+(g-type-from-name "GtkLabel")
+=> 7151952
+(g-type-name 7151952)
+=> "GtkLabel"
See also:

Function g-type-fundamental (type)
Arguments:
Returns:
GType designator
Details:
Returns the fundamental type which is the ancestor of type.

+Example:
+(g-type-fundamental "GtkWindowType")
+=> "GEnum"
+(g-type-fundamental "GtkLabel")
+=> "GObject"
See also:

Function g-type-interface-prerequisites (g-type)
Arguments:
Returns:
list of GType designators
Details:
Returns the prerequisites of an interface type. Prerequisite is a type that must be a superclass of an implementing class or an interface that the object must also implement.

+Example:
+(g-type-interface-prerequisites "GtkTreeModel")
+=> ("GObject")
See also:

Function g-type-interfaces (g-type)
Arguments:
Returns:
list of GType designators
Details:
Returns the list of interfaces the g-type conforms to.

+Example:
+(g-type-interfaces "GtkButton")
+=> ("AtkImplementorIface" "GtkBuildable" "GtkActivatable")
See also:

Function g-type-is-a (type is-a-type)
Arguments:
Returns:
boolean
Details:
If is-a-type is a derivable type, check whether type is a descendant of is-a-type. If is-a-type is an interface, check whether type conforms to it.

+Example:
+(g-type-is-a "GtkButton" "GtkWidget")
+=> T
+(g-type-is-a "GtkButton" "AtkImplementorIface")
+=> T
+(g-type-is-a "GtkButton" "GtkLabel")
+=> NIL
See also:

Function g-type-name (type)
Arguments:
Returns:
a string
Details:
Returns the name of a GType.

+Example:
+(g-type-from-name "GtkLabel")
+=> 7151952
+(g-type-name 7151952)
+=> "GtkLabel"
See also:

Function g-type-next-base (leaf-type root-type)
Arguments:
Returns:
GType designator
Details:
Determines the type that is derived directly from root-type which is also a base class of leaf-type.

+Example:
+(g-type-next-base "GtkButton" "GtkWidget")
+=> "GtkContainer"
See also:

Function g-type-parent (type)
Arguments:
Returns:
GType designator
Details:
Returns the parent of a GType.

+Example:
+(g-type-parent "GtkLabel")
+=> "GtkMisc"
See also:

Other classes in gobject.type-info

Class g-type-designator
Superclasses:
cffi::enhanced-foreign-type, cffi::foreign-type-alias, cffi::foreign-type, common-lisp:standard-object, sb-pcl::slot-object, common-lisp:t
Documented Subclasses:
+ None +
Details:
Values of this CFFI foreign type identify the GType. GType is designated by a its name (a string) or a numeric identifier. Functions accept GType designators as a string or integer and return them as a string. Functions g-type-name and g-type-from-name are used to convert between name and numeric identifier.

Numeric identifier of GType may be different between different program runs. But string identifier of GType does not change.
See also:

Other variables in gobject.type-info

Variable +g-type-boolean+
Details:
The fundamental type corresponding to gboolean.

Variable +g-type-boxed+
Details:
The fundamental type from which all boxed types are derived.

Variable +g-type-char+
Details:
The fundamental type corresponding to gchar. The type designated by +g-type-char+ is unconditionally an 8-bit signed integer. This may or may not be the same type a the C type gchar.
See also:

Variable +g-type-double+
Details:
The fundamental type corresponding to gdouble.

Variable +g-type-enum+
Details:
The fundamental type from which all enumeration types are derived.

Variable +g-type-flags+
Details:
The fundamental type from which all flags types are derived.

Variable +g-type-float+
Details:
The fundamental type corresponding to gfloat.

Variable +g-type-int+
Details:
The fundamental type corresponding to gint.

Variable +g-type-int64+
Details:
The fundamental type corresponding to gint64.

Variable +g-type-interface+
Details:
The fundamental type from which all interfaces are derived.

Variable +g-type-invalid+
Details:
An invalid GType used as error return value in some functions which return a GType.

Variable +g-type-long+
Details:
The fundamental type corresponding to glong.

Variable +g-type-object+
Details:
The fundamental type for GObject.

Variable +g-type-param+
Details:
The fundamental type from which all GParamSpec types are derived.

Variable +g-type-pointer+
Details:
The fundamental type corresponding to gpointer.

Variable +g-type-string+
Details:
The fundamental type corresponding to null-terminated C strings.

Variable +g-type-uchar+
Details:
The fundamental type corresponding to guchar.

Variable +g-type-uint+
Details:
The fundamental type corresponding to guint.

Variable +g-type-uint64+
Details:
The fundamental type corresponding to guint64.

Variable +g-type-ulong+
Details:
The fundamental type corresponding to gulong.

Variable +g-type-void+
Details:
A fundamental type which is used as a replacement for the C void return type.

Index of exported symbols

gobject.type-info:+g-type-boolean+, variable
gobject.type-info:+g-type-boxed+, variable
gobject.type-info:+g-type-char+, variable
gobject.type-info:+g-type-double+, variable
gobject.type-info:+g-type-enum+, variable
gobject.type-info:+g-type-flags+, variable
gobject.type-info:+g-type-float+, variable
gobject.type-info:+g-type-int+, variable
gobject.type-info:+g-type-int64+, variable
gobject.type-info:+g-type-interface+, variable
gobject.type-info:+g-type-invalid+, variable
gobject.type-info:+g-type-long+, variable
gobject.type-info:+g-type-object+, variable
gobject.type-info:+g-type-param+, variable
gobject.type-info:+g-type-pointer+, variable
gobject.type-info:+g-type-string+, variable
gobject.type-info:+g-type-uchar+, variable
gobject.type-info:+g-type-uint+, variable
gobject.type-info:+g-type-uint64+, variable
gobject.type-info:+g-type-ulong+, variable
gobject.type-info:+g-type-void+, variable
gobject.type-info:g-closure-get-type, function
gobject.type-info:g-strv-get-type, function
gobject.type-info:g-type-children, function
gobject.type-info:g-type-depth, function
gobject.type-info:g-type-designator, class
gobject.type-info:g-type-from-name, function
gobject.type-info:g-type-fundamental, function
gobject.type-info:g-type-interface-prerequisites, function
gobject.type-info:g-type-interfaces, function
gobject.type-info:g-type-is-a, function
gobject.type-info:g-type-name, function
gobject.type-info:g-type-next-base, function
gobject.type-info:g-type-parent, function
\ No newline at end of file -- 1.7.10.4