From 930d11d2af8aba63773d84beeea7a9067360ae49 Mon Sep 17 00:00:00 2001 From: Tim Janik Date: Tue, 13 Nov 2001 18:49:56 +0000 Subject: [PATCH] param spec updates. Tue Nov 13 19:49:16 2001 Tim Janik * gobject/tmpl/gparamspec.sgml: param spec updates. --- docs/reference/ChangeLog | 4 + docs/reference/gobject/gobject-docs.sgml | 4 +- docs/reference/gobject/gobject-sections.txt | 25 +-- docs/reference/gobject/tmpl/gobject-unused.sgml | 20 +++ .../tmpl/{param_specs.sgml => gparamspec.sgml} | 168 ++++++++++++--------- 5 files changed, 136 insertions(+), 85 deletions(-) rename docs/reference/gobject/tmpl/{param_specs.sgml => gparamspec.sgml} (55%) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index df5329f..cb60bf6 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,7 @@ +Tue Nov 13 19:49:16 2001 Tim Janik + + * gobject/tmpl/gparamspec.sgml: param spec updates. + 2001-11-12 Matthias Clasen * glib/tmpl/markup.sgml: Remove excess listitem from long diff --git a/docs/reference/gobject/gobject-docs.sgml b/docs/reference/gobject/gobject-docs.sgml index 5c856df..b6d109b 100644 --- a/docs/reference/gobject/gobject-docs.sgml +++ b/docs/reference/gobject/gobject-docs.sgml @@ -7,7 +7,7 @@ - + @@ -75,7 +75,7 @@ &gobject-Generic-values; &gobject-Standard-value-types; &gobject-Varargs-Value-Collection; - &gobject-Parameter-Specifications; + &gobject-GParamSpec; &gobject-Standard-Parameter-Types; &gobject-Signals; &gobject-Closures; diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt index 6567f45..86da504 100644 --- a/docs/reference/gobject/gobject-sections.txt +++ b/docs/reference/gobject/gobject-sections.txt @@ -337,32 +337,35 @@ g_value_set_instance
-Parameter Specifications -param_specs -GParamSpec -GParamSpecClass +GParamSpec +gparamspec G_PARAM_SPEC_TYPE -G_PARAM_SPEC_TYPE_NAME +G_TYPE_IS_PARAM G_PARAM_SPEC G_IS_PARAM_SPEC +G_PARAM_SPEC_CLASS +G_IS_PARAM_SPEC_CLASS G_PARAM_SPEC_GET_CLASS +G_PARAM_SPEC_TYPE_NAME G_PARAM_SPEC_VALUE_TYPE -G_TYPE_IS_PARAM +GParamSpec +GParamSpecClass +GParamFlags G_PARAM_READWRITE G_PARAM_MASK G_PARAM_USER_SHIFT -GParamFlags g_param_spec_ref g_param_spec_unref g_param_spec_sink -g_param_spec_get_qdata -g_param_spec_set_qdata -g_param_spec_set_qdata_full -g_param_spec_steal_qdata g_param_value_set_default g_param_value_defaults g_param_value_validate +g_param_value_convert g_param_values_cmp +g_param_spec_get_qdata +g_param_spec_set_qdata +g_param_spec_set_qdata_full +g_param_spec_steal_qdata GParamSpecTypeInfo g_param_type_register_static GParamSpecPool diff --git a/docs/reference/gobject/tmpl/gobject-unused.sgml b/docs/reference/gobject/tmpl/gobject-unused.sgml index 7181f37..64866a3 100644 --- a/docs/reference/gobject/tmpl/gobject-unused.sgml +++ b/docs/reference/gobject/tmpl/gobject-unused.sgml @@ -1,3 +1,23 @@ + + + + + + + + + + + + + + + + + +Parameter Specifications + + diff --git a/docs/reference/gobject/tmpl/param_specs.sgml b/docs/reference/gobject/tmpl/gparamspec.sgml similarity index 55% rename from docs/reference/gobject/tmpl/param_specs.sgml rename to docs/reference/gobject/tmpl/gparamspec.sgml index 253b12c..aa570e3 100644 --- a/docs/reference/gobject/tmpl/param_specs.sgml +++ b/docs/reference/gobject/tmpl/gparamspec.sgml @@ -1,228 +1,252 @@ -Parameter Specifications - + +Parameter Specifications - +#GParamSpec is an object structure that encapsulates the meta data +required to specify parameters, such as e.g. #GObject properties. - +g_object_class_install_property(), g_object_set(), g_object_get(), +g_object_set_property(), g_object_get_property() - + - +Retrive the #GType of this @pspec. -@g_type_instance: -@name: -@flags: -@value_type: -@owner_type: +@pspec: a valid #GParamSpec - + + +@type: - - + + +Cast a derived #GParamSpec object (e.g. of type #GParamSpecInt) into +a #GParamSpec object. -@pspec: +@pspec: a valid #GParamSpec - + -@pspec: +@pspec: a valid #GParamSpec - + -@pspec: +@pspec: a valid #GParamSpec - + - +Retrive the #GType name of this @pspec. -@pspec: +@pspec: a valid #GParamSpec - + - +Retrive the #GType to intiialize a #GValue for this parameter. -@pspec: +@pspec: a valid #GParamSpec - + -@pspec: +@g_type_instance: private #GTypeInstance portion +@name: name of this parameter +@flags: #GParamFlags flags for this parameter +@value_type: the #GValue type for this parameter +@owner_type: #GType type that uses (introduces) this paremeter - - + -@type: + + +Through the #GParamFlags flag values, certain aspects of parameters +can be configured. + + +@G_PARAM_READABLE: the parameter is readable +@G_PARAM_WRITABLE: the parameter is writable +@G_PARAM_CONSTRUCT: the parameter will be set upon object construction +@G_PARAM_CONSTRUCT_ONLY: the parameter will only be set upon object construction +@G_PARAM_LAX_VALIDATION: upon parameter conversion (see g_param_value_convert()) + strict validation is not required +@G_PARAM_PRIVATE: - +#GParamFlags value alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE. - +Mask containing the bits of #GParamSpec.flags which are reserved for GLib. - +Minimum shift count to be used for user defined flags, to be stored in +#GParamSpec.flags. - + - +Increment the reference count of @pspec. -@G_PARAM_READABLE: -@G_PARAM_WRITABLE: -@G_PARAM_CONSTRUCT: -@G_PARAM_CONSTRUCT_ONLY: -@G_PARAM_LAX_VALIDATION: -@G_PARAM_PRIVATE: +@pspec: a valid #GParamSpec +@Returns: the #GParamSpec that was passed into this function - - + + +Decrement the reference count of a @pspec. -@pspec: -@Returns: +@pspec: a valid #GParamSpec - + - +The initial reference count of a newly created #GParamSpec is 1, +eventhough no one has explicitely called g_param_spec_ref() on it yet. +So the einital reference count is flagged as "floating", untill someone +calls: g_param_spec_ref (@pspec); g_param_spec_sink (@pspec); +in sequence on it, taking over the initial reference count (thus +ending up with a @pspec that has a reference count of 1 still, but is +not flagged "floating" anymore). -@pspec: +@pspec: a valid #GParamSpec - + @pspec: +@value: - + @pspec: -@quark: +@value: @Returns: - + @pspec: -@quark: -@data: +@value: +@Returns: - + -@pspec: -@quark: -@data: -@destroy: +@dest_value_spec: +@src_value: +@dest_value: +@strict_validation: +@Returns: - + @pspec: -@quark: +@value1: +@value2: @Returns: - + @pspec: -@value: +@quark: +@Returns: - + @pspec: -@value: -@Returns: +@quark: +@data: - + @pspec: -@value: -@Returns: +@quark: +@data: +@destroy: - + @pspec: -@value1: -@value2: +@quark: @Returns: -- 2.7.4