Commit 75a4ce91 authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann
Browse files

documentation fixes.

2003-10-11  Sven Neumann  <sven@gimp.org>

	* app/config/gimpconfig-deserialize.c: documentation fixes.

2003-10-11  Sven Neumann  <sven@gimp.org>

	* app/app-docs.sgml
	* app/app-sections.txt
	* app/app.types: updated.

	* app/app.prerequisites: removed, it's a generated file.
parent a88e11af
2003-10-11 Sven Neumann <sven@gimp.org>
* app/config/gimpconfig-deserialize.c: documentation fixes.
2003-10-11 Sven Neumann <sven@gimp.org>
 
* app/widgets/gimpdocked.[ch]
......@@ -54,13 +54,13 @@
* couldn't parse it.
*/
static GTokenType gimp_config_deserialize_unknown (GimpConfig *object,
static GTokenType gimp_config_deserialize_unknown (GimpConfig *config,
GScanner *scanner);
static GTokenType gimp_config_deserialize_property (GimpConfig *object,
static GTokenType gimp_config_deserialize_property (GimpConfig *config,
GScanner *scanner,
gint nest_level);
static GTokenType gimp_config_deserialize_value (GValue *value,
GimpConfig *object,
GimpConfig *config,
GParamSpec *prop_spec,
GScanner *scanner);
static GTokenType gimp_config_deserialize_fundamental (GValue *value,
......@@ -82,12 +82,12 @@ static GTokenType gimp_config_deserialize_matrix2 (GValue *value,
GParamSpec *prop_spec,
GScanner *scanner);
static GTokenType gimp_config_deserialize_object (GValue *value,
GimpConfig *object,
GimpConfig *config,
GParamSpec *prop_spec,
GScanner *scanner,
gint nest_level);
static GTokenType gimp_config_deserialize_value_array (GValue *value,
GimpConfig *object,
GimpConfig *config,
GParamSpec *prop_spec,
GScanner *scanner);
static GTokenType gimp_config_deserialize_any (GValue *value,
......@@ -100,16 +100,16 @@ static inline gboolean scanner_string_utf8_valid (GScanner *scanner,
/**
* gimp_config_deserialize_properties:
* @object: a #GimpConfig.
* @config: a #GimpConfig.
* @scanner: a #GScanner.
* @nest_level:
* @store_unknown_tokens: %TRUE if you want to store unknown tokens.
*
* This function uses the @scanner to configure the properties of @object.
* This function uses the @scanner to configure the properties of @config.
*
* The store_unknown_tokens parameter is a special feature for #GimpRc.
* If it set to %TRUE, unknown tokens (e.g. tokens that don't refer to
* a property of @object) with string values are attached to @object as
* a property of @config) with string values are attached to @config as
* unknown tokens. GimpConfig has a couple of functions to handle the
* attached key/value pairs.
*
......@@ -214,7 +214,7 @@ gimp_config_deserialize_properties (GimpConfig *config,
}
static GTokenType
gimp_config_deserialize_unknown (GimpConfig *object,
gimp_config_deserialize_unknown (GimpConfig *config,
GScanner *scanner)
{
gchar *key;
......@@ -232,7 +232,7 @@ gimp_config_deserialize_unknown (GimpConfig *object,
return G_TOKEN_NONE;
}
gimp_config_add_unknown_token (object, key, scanner->value.v_string);
gimp_config_add_unknown_token (config, key, scanner->value.v_string);
g_free (key);
return G_TOKEN_RIGHT_PAREN;
......@@ -325,7 +325,7 @@ gimp_config_deserialize_property (GimpConfig *config,
static GTokenType
gimp_config_deserialize_value (GValue *value,
GimpConfig *object,
GimpConfig *config,
GParamSpec *prop_spec,
GScanner *scanner)
{
......@@ -356,7 +356,7 @@ gimp_config_deserialize_value (GValue *value,
else if (prop_spec->value_type == G_TYPE_VALUE_ARRAY)
{
return gimp_config_deserialize_value_array (value,
object, prop_spec, scanner);
config, prop_spec, scanner);
}
/* This fallback will only work for value_types that
......
2003-10-11 Sven Neumann <sven@gimp.org>
* app/app-docs.sgml
* app/app-sections.txt
* app/app.types: updated.
* app/app.prerequisites: removed, it's a generated file.
2003-10-09 Sven Neumann <sven@gimp.org>
* app/app-sections.txt: updated.
......
......@@ -4,6 +4,7 @@ deprecated
app.args
app.hierarchy
app.interfaces
app.prerequisites
app.signals
app-decl.txt
app-decl-list.txt
......
......@@ -571,6 +571,7 @@
<chapter id="app-widgets-docks">
<title>Dock Windows &amp; Widgets</title>
<xi:include href="xml/gimpdocked.xml"/>
<xi:include href="xml/gimpdock.xml"/>
<xi:include href="xml/gimpimagedock.xml"/>
<xi:include href="xml/gimptoolbox.xml"/>
......@@ -587,6 +588,7 @@
<xi:include href="xml/gimpcoloreditor.xml"/>
<xi:include href="xml/gimpdevicestatus.xml"/>
<xi:include href="xml/gimperrorconsole.xml"/>
<xi:include href="xml/gimpgrideditor.xml"/>
<xi:include href="xml/gimpstrokeeditor.xml"/>
<xi:include href="xml/gimptemplateeditor.xml"/>
<xi:include href="xml/gimptooloptionseditor.xml"/>
......@@ -702,6 +704,7 @@
<xi:include href="xml/gimpdialogfactory.xml"/>
<xi:include href="xml/gimpdnd.xml"/>
<xi:include href="xml/gimphelp.xml"/>
<xi:include href="xml/gimpsessioninfo.xml"/>
<xi:include href="xml/gimpwidgets-utils.xml"/>
</chapter>
......
......@@ -3692,6 +3692,8 @@ gimp_dock_add
gimp_dock_remove
gimp_dock_add_book
gimp_dock_remove_book
gimp_dock_set_aux_info
gimp_dock_get_aux_info
<SUBSECTION Standard>
GimpDockClass
GIMP_DOCK
......@@ -3705,15 +3707,14 @@ GIMP_DOCK_GET_CLASS
<SECTION>
<FILE>gimpdockable</FILE>
GimpDockableGetMenuFunc
GimpDockableGetPreviewFunc
GimpDockableSetContextFunc
<TITLE>GimpDockable</TITLE>
GimpDockable
gimp_dockable_new
gimp_dockable_get_menu
gimp_dockable_get_tab_widget
gimp_dockable_set_context
gimp_dockable_set_aux_info
gimp_dockable_get_aux_info
gimp_dockable_detach
<SUBSECTION Standard>
GimpDockableClass
......@@ -3726,6 +3727,24 @@ GIMP_IS_DOCKABLE_CLASS
GIMP_DOCKABLE_GET_CLASS
</SECTION>
<SECTION>
<FILE>gimpdocked</FILE>
<TITLE>GimpDocked</TITLE>
GimpDocked
GimpDockedInterface
GIMP_DOCKED_GET_INTERFACE
gimp_docked_set_aux_info
gimp_docked_get_aux_info
gimp_docked_get_preview
gimp_docked_set_context
gimp_docked_get_menu
<SUBSECTION Standard>
GIMP_DOCKED
GIMP_IS_DOCKED
GIMP_TYPE_DOCKED
gimp_docked_interface_get_type
</SECTION>
<SECTION>
<FILE>gimpdockbook</FILE>
<TITLE>GimpDockbook</TITLE>
......@@ -3884,6 +3903,22 @@ GIMP_IS_GRADIENT_EDITOR_CLASS
GIMP_GRADIENT_EDITOR_GET_CLASS
</SECTION>
<SECTION>
<FILE>gimpgrideditor</FILE>
<TITLE>GimpGridEditor</TITLE>
GimpGridEditor
gimp_grid_editor_new
<SUBSECTION Standard>
GimpGridEditorClass
GIMP_GRID_EDITOR
GIMP_IS_GRID_EDITOR
GIMP_TYPE_GRID_EDITOR
gimp_grid_editor_get_type
GIMP_GRID_EDITOR_CLASS
GIMP_IS_GRID_EDITOR_CLASS
GIMP_GRID_EDITOR_GET_CLASS
</SECTION>
<SECTION>
<FILE>gimphistogrambox</FILE>
<TITLE>GimpHistogramBox</TITLE>
......@@ -4294,6 +4329,22 @@ GIMP_IS_SELECTION_EDITOR_CLASS
GIMP_SELECTION_EDITOR_GET_CLASS
</SECTION>
<SECTION>
<FILE>gimpsessioninfo</FILE>
<TITLE>GimpSessionInfo</TITLE>
GimpSessionInfo
GimpSessionInfoBook
GimpSessionInfoDockable
gimp_session_info_free
gimp_session_info_book_free
gimp_session_info_dockable_free
gimp_session_info_save
gimp_session_info_deserialize
gimp_session_info_restore
gimp_session_info_set_geometry
gimp_session_info_get_geometry
</SECTION>
<SECTION>
<FILE>gimpstrokeeditor</FILE>
<TITLE>GimpStrokeEditor</TITLE>
......@@ -5051,8 +5102,9 @@ gimp_config_build_plug_in_path
<SECTION>
<FILE>gimpconfig</FILE>
GIMP_TYPE_CONFIG_INTERFACE
GIMP_GET_CONFIG_INTERFACE
GimpConfig
GIMP_TYPE_CONFIG
GIMP_CONFIG_GET_INTERFACE
GimpConfigInterface
GimpConfigForeachFunc
gimp_config_interface_get_type
......@@ -5068,6 +5120,9 @@ gimp_config_reset
gimp_config_add_unknown_token
gimp_config_lookup_unknown_token
gimp_config_foreach_unknown_token
<SUBSECTION Standard>
GIMP_CONFIG
GIMP_IS_CONFIG
</SECTION>
<SECTION>
......
......@@ -93,6 +93,7 @@ gimp_get_type
gimp_gradient_editor_get_type
gimp_gradient_get_type
gimp_grid_get_type
gimp_grid_editor_get_type
gimp_gui_config_get_type
gimp_histogram_box_get_type
gimp_histogram_tool_get_type
......
......@@ -54,13 +54,13 @@
* couldn't parse it.
*/
static GTokenType gimp_config_deserialize_unknown (GimpConfig *object,
static GTokenType gimp_config_deserialize_unknown (GimpConfig *config,
GScanner *scanner);
static GTokenType gimp_config_deserialize_property (GimpConfig *object,
static GTokenType gimp_config_deserialize_property (GimpConfig *config,
GScanner *scanner,
gint nest_level);
static GTokenType gimp_config_deserialize_value (GValue *value,
GimpConfig *object,
GimpConfig *config,
GParamSpec *prop_spec,
GScanner *scanner);
static GTokenType gimp_config_deserialize_fundamental (GValue *value,
......@@ -82,12 +82,12 @@ static GTokenType gimp_config_deserialize_matrix2 (GValue *value,
GParamSpec *prop_spec,
GScanner *scanner);
static GTokenType gimp_config_deserialize_object (GValue *value,
GimpConfig *object,
GimpConfig *config,
GParamSpec *prop_spec,
GScanner *scanner,
gint nest_level);
static GTokenType gimp_config_deserialize_value_array (GValue *value,
GimpConfig *object,
GimpConfig *config,
GParamSpec *prop_spec,
GScanner *scanner);
static GTokenType gimp_config_deserialize_any (GValue *value,
......@@ -100,16 +100,16 @@ static inline gboolean scanner_string_utf8_valid (GScanner *scanner,
/**
* gimp_config_deserialize_properties:
* @object: a #GimpConfig.
* @config: a #GimpConfig.
* @scanner: a #GScanner.
* @nest_level:
* @store_unknown_tokens: %TRUE if you want to store unknown tokens.
*
* This function uses the @scanner to configure the properties of @object.
* This function uses the @scanner to configure the properties of @config.
*
* The store_unknown_tokens parameter is a special feature for #GimpRc.
* If it set to %TRUE, unknown tokens (e.g. tokens that don't refer to
* a property of @object) with string values are attached to @object as
* a property of @config) with string values are attached to @config as
* unknown tokens. GimpConfig has a couple of functions to handle the
* attached key/value pairs.
*
......@@ -214,7 +214,7 @@ gimp_config_deserialize_properties (GimpConfig *config,
}
static GTokenType
gimp_config_deserialize_unknown (GimpConfig *object,
gimp_config_deserialize_unknown (GimpConfig *config,
GScanner *scanner)
{
gchar *key;
......@@ -232,7 +232,7 @@ gimp_config_deserialize_unknown (GimpConfig *object,
return G_TOKEN_NONE;
}
gimp_config_add_unknown_token (object, key, scanner->value.v_string);
gimp_config_add_unknown_token (config, key, scanner->value.v_string);
g_free (key);
return G_TOKEN_RIGHT_PAREN;
......@@ -325,7 +325,7 @@ gimp_config_deserialize_property (GimpConfig *config,
static GTokenType
gimp_config_deserialize_value (GValue *value,
GimpConfig *object,
GimpConfig *config,
GParamSpec *prop_spec,
GScanner *scanner)
{
......@@ -356,7 +356,7 @@ gimp_config_deserialize_value (GValue *value,
else if (prop_spec->value_type == G_TYPE_VALUE_ARRAY)
{
return gimp_config_deserialize_value_array (value,
object, prop_spec, scanner);
config, prop_spec, scanner);
}
/* This fallback will only work for value_types that
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment