summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorCST 1998 Shawn T. Amundson <amundson@gimp.org>1998-03-01 20:24:39 +0000
committerShawn Amundson <amundson@src.gnome.org>1998-03-01 20:24:39 +0000
commitb7056ea129d99af0ff4e525b736e2a9e801beb95 (patch)
tree2548c00ce0b4cc5dff631234cd471488f82198c8 /docs
parent60870d3407da61b296c99262ce6fb5f672512cc7 (diff)
downloadgdk-pixbuf-b7056ea129d99af0ff4e525b736e2a9e801beb95.tar.gz
I forgot to *commit* these before. Note to self: commit after applying
I forgot to *commit* these before. Note to self: commit after applying patches. -Shawn Sun Mar 1 15:08:13 CST 1998 Shawn T. Amundson <amundson@gimp.org> * docs/*.texi changes from Greg Mclean.
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am2
-rw-r--r--docs/gdk.texi8
-rw-r--r--docs/glib.texi455
-rw-r--r--docs/gtk.texi178
4 files changed, 623 insertions, 20 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 5c8cb93af..8d4592b42 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,6 +1,6 @@
## Process this file with automake to produce Makefile.in
-info_TEXINFOS = gdk.texi gtk.texi
+info_TEXINFOS = gdk.texi gtk.texi glib.texi
EXTRA_DIST = \
texinfo.tex \
diff --git a/docs/gdk.texi b/docs/gdk.texi
index 4942fe29b..4e4b84f5d 100644
--- a/docs/gdk.texi
+++ b/docs/gdk.texi
@@ -324,3 +324,11 @@ handle_event ()
@summarycontents
@contents
@bye
+
+
+
+
+
+
+
+
diff --git a/docs/glib.texi b/docs/glib.texi
new file mode 100644
index 000000000..1bf23e191
--- /dev/null
+++ b/docs/glib.texi
@@ -0,0 +1,455 @@
+\input texinfo @c -*-texinfo-*-
+@c %**start of header
+@setfilename glib.info
+@settitle GLIB
+@setchapternewpage odd
+
+@set edition 1.0
+@set update-date 3 Feburary 1998
+@set update-month Feburary 1998
+@c %**end of header
+
+@ifinfo
+This file documents GLIB, A library of useful routines for C programming
+
+Copyright (C) 1998 Gregory A McLean
+
+Permission is granted to make and distributed verbatim copies of this
+manual, provided the copyright notice and this permission notice are
+preserved on all copies.
+
+@ignore
+Permission is granted to process this file throught TeX and print the
+results, provided the printed document carries copying permission notice
+identical to this one except for the removal of this paragraph (this
+paragraph not being relevant to the printed manual).
+
+@end ignore
+Permission is granted to copy and distribute modified versions of this
+manual under the conditions for verbatim copying, provided that the
+entire resulting derived work is distributed under the terms of a
+permission notice identical to this one.
+
+Permission is granted to copy and distribute translations of this manual
+into another language, under the above conditions for modified versions,
+except that this permission notice may be stated in a translation
+approved by Gregory McLean.
+@end ifinfo
+
+@titlepage
+@title GLIB, Useful routines for C programming
+@subtitle Version 1.0
+@subtitle @value{update-month}
+@author by Gregory McLean
+
+@page
+@vskip 0pt plus 1filll
+Copyright @copyright{} 1998 Gregory McLean
+
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+
+Permission is granted to copy and distribute modified versions of this
+manual under the conditions for verbatim copying, provided that the
+entire resulting derived work is distributed under the terms of a
+permission notice identical to this one.
+
+Permission is granted to copy and distribute translations of this manual
+into another language, under the above conditions for modified versions,
+except that this permission notice may be stated in a translation
+approved by Gregory McLean.
+@end titlepage
+
+@dircategory Library of useful routines for 'C' programing
+@direntry
+* GLIB: (glib). useful routines for 'C' programming
+@end direntry
+
+@node Top, Copying, (dir), (dir)
+@top useful routines for 'C' programming
+@ifinfo
+This is edition @value{edition} of the GLIB documentation,
+@w{@value{update-date}}.
+@end ifinfo
+
+@menu
+* Copying:: Your rights.
+* Overview:: What is GLIB?
+* Doubly linked lists:: Doubly linked lists
+* Signly linked lists:: Singly linked lists
+* List allocators:: List Allocators
+* Hash tables:: Hash tables
+* Caches:: Cache handling
+* Trees:: Tree handling
+* Memory:: Memory handling
+* Timers:: Timer functions
+* Output:: Output handling
+* Utilities:: Utilitiy functions
+* Errors:: Error handling
+* String Chunks:: String Chunks
+* Strings:: String handling
+* Resizable arrays:: Resizeable arrays
+* GScanner:: Flexible lexical scanner
+* Miscellany:: Other stuff
+* Function Index:: Index of functions
+* Concept Index:: Index of concepts
+@end menu
+
+@node Copying, Overview, Top, Top
+@comment node-name, next, previous, up
+@chapter Copying
+
+@node Overview, Doubly linked lists, Copying, Top
+@comment node-name, next, previous, up
+@chapter What is GLIB
+
+@node Doubly linked lists, Signly linked lists, Overview, Top
+@comment node-name, next, previous, up
+@chapter Doubly linked lists
+
+@subsection Functions
+
+@deftypefun GList* g_list_alloc (void)
+@end deftypefun
+
+@deftypefun void g_list_free (GList *@var{list})
+@end deftypefun
+
+@deftypefun void g_list_free_1 (GList *@var{list})
+@end deftypefun
+
+@deftypefun GList* g_list_append (GList *@var{list}, gpointer @var{data})
+@end deftypefun
+
+@deftypefun GList* g_list_prepend (GList *@var{list}, gpointer @var{data})
+@end deftypefun
+
+@deftypefun GList* g_list_insert (GList *@var{list}, gpointer @var{data}, gint @var{position})
+@end deftypefun
+
+@deftypefun GList* g_list_insert_sorted (GList *@var{list}, gpointer @var{data}, GCompareFunc @var{func})
+@end deftypefun
+
+@deftypefun GList* g_list_concat (GList *@var{list1}, GList *@var{list2})
+@end deftypefun
+
+@deftypefun GList* g_list_remove (GList *@var{list}, gpointer @var{data})
+@end deftypefun
+
+@deftypefun GList* g_list_remove_link (GList *@var{list}, GList *@var{link})
+@end deftypefun
+
+@deftypefun GList* g_list_reverse (GList *@var{list})
+@end deftypefun
+
+@deftypefun GList* g_list_nth (GList *@var{list}, gint @var{n})
+@end deftypefun
+
+@deftypefun GList* g_list_find (GList *@var{list}, gpointer @var{data})
+@end deftypefun
+
+@deftypefun GList* g_list_last (GList *@var{list})
+@end deftypefun
+
+@deftypefun GList* g_list_first (GList *@var{list})
+@end deftypefun
+
+@deftypefun gint g_list_length (GList *@var{list})
+@end deftypefun
+
+@deftypefun void g_list_foreach (GList *@var{list}, GFunc @var{func}, gpointer @var{user_data})
+@end deftypefun
+
+@node Signly linked lists, List allocators, Doubly linked lists, Top
+@comment node-name, next, previous, up
+@chapter Signly linked lists
+
+@subsection Functions
+@deftypefun GSList* g_slist_alloc (void)
+@end deftypefun
+
+@deftypefun void g_slist_free (GSList *@var{list})
+@end deftypefun
+
+@deftypefun void g_slist_free_1 (GSList *@var{list})
+@end deftypefun
+
+@deftypefun GSList* g_slist_append (GSList *@var{list}, gpointer @var{data})
+@end deftypefun
+
+@deftypefun GSList* g_slist_prepend (GSList *@var{list}, gpointer @var{data})
+@end deftypefun
+
+@deftypefun GSList* g_slist_insert (GSList *@var{list}, gpointer @var{data}, gint @var{position})
+@end deftypefun
+
+@deftypefun GSList* g_slist_insert_sorted (GSList *@var{list}, gpointer @var{data}, GCompareFunc @var{func})
+@end deftypefun
+
+@deftypefun GSList* g_slist_concat (GSList *@var{list1}, GSList *@var{list2})
+@end deftypefun
+
+@deftypefun GSList* g_slist_remove (GSList *@var{list}, gpointer @var{data})
+@end deftypefun
+
+@deftypefun GSList* g_slist_remove_link (GSList *@var{list}, GSList *@var{link})
+@end deftypefun
+
+@deftypefun GSList* g_slist_reverse (GSList *@var{list})
+@end deftypefun
+
+@deftypefun GSList* g_slist_nth (GSList *@var{list}, gint @var{n})
+@end deftypefun
+
+@deftypefun GSList* g_slist_find (GSList *@var{list}, gpointer @var{data})
+@end deftypefun
+
+@deftypefun GSList* g_slist_last (GSList *@var{list})
+@end deftypefun
+
+@deftypefun gint g_slist_length (GSList *@var{list})
+@end deftypefun
+
+@deftypefun void g_slist_foreach (GSList *@var{list}, GFunc @var{func}, gpointer @var{user_data})
+@end deftypefun
+
+@node List allocators, Hash tables, Signly linked lists, Top
+@comment node-name, next, previous, up
+@chapter List allocators
+
+@subsection Functions
+
+@deftypefun GListAllocator* g_list_allocator_new (void)
+@end deftypefun
+
+@deftypefun void g_list_allocator_free (GListAllocator *@var{allocator})
+@end deftypefun
+
+@deftypefun GListAllocator* g_slist_set_allocator (GListAllocator *@var{allocator})
+@end deftypefun
+
+@deftypefun GListAllocator* g_list_set_allocator (GListAllocator *@var{allocator})
+@end deftypefun
+
+@node Hash tables, Caches, List allocators, Top
+@comment node-name, next, previous, up
+@chapter Hash tables
+
+@subsection Functions
+
+@deftypefun GHashTable* g_hash_table_new (GHashFunc @var{hash_func}, GCompareFunc @var{key_compare_func})
+@end deftypefun
+
+@deftypefun void g_hash_table_destroy (GHashTable *@var{hash_table})
+@end deftypefun
+
+@deftypefun void g_hash_table_insert (GHashTable *@var{hash_table}, gpointer @var{key}, gpointer @var{value})
+@end deftypefun
+
+@deftypefun void g_hash_table_remove (GHashTable *@var{hash_table}, gpointer @var{key})
+@end deftypefun
+
+@deftypefun gpointer g_hash_table_lookup (GHashTable *@var{hash_table}, gpointer @var{key})
+@end deftypefun
+
+@deftypefun void g_hash_table_freeze (GHashTable *@var{hash_table})
+@end deftypefun
+
+@deftypefun void g_hash_table_thaw (GHashTable *@var{hash_table})
+@end deftypefun
+
+@deftypefun void g_hash_table_foreach (GHashTable *@var{hash_table}, GHFunc @var{func}, gpointer @var{user_data})
+@end deftypefun
+
+@node Caches, Trees, Hash tables, Top
+@comment node-name, next, previous, up
+@chapter Cache handling
+
+@subsection Functions
+
+@deftypefun GCache* g_cache_new (GCacheNewFunc @var{value_new_func}, GCacheDestroyFunc @var{value_destroy_func}, GCacheDupFunc @var{key_dup_func}, GCacheDestroyFunc @var{key_destroy_func}, GHashFunc @var{hash_key_func}, GHashFunc @var{hash_value_func}, GCompareFunc @var{key_compare_func})
+@end deftypefun
+
+@deftypefun void g_cache_destroy (GCache *@var{cache})
+@end deftypefun
+
+@deftypefun gpointer g_cache_insert (GCache *@var{cache}, gpointer @var{key})
+@end deftypefun
+
+@deftypefun void g_cache_remove (GCache *@var{cache}, gpointer @var{key})
+@end deftypefun
+
+@deftypefun void g_cache_key_foreach (GCache *@var{cache}, GHFunc @var{func}, gpointer @var{user_data})
+@end deftypefun
+
+@deftypefun void g_cache_value_foreach (GCache *@var{cache}, GHFunc @var{func}, gpointer @var{user_data})
+@end deftypefun
+
+@node Trees, Memory, Caches, Top
+@comment node-name, next, previous, up
+@chapter Tree handling
+
+@subsection Functions
+
+@deftypefun GTree* g_tree_new (GCompareFunc @var{key_compare_func})
+@end deftypefun
+
+@deftypefun void g_tree_destroy (GTree *@var{tree})
+@end deftypefun
+
+@deftypefun void g_tree_remove (GTree *@var{tree}, gpointer @var{key}, gpointer @var{value})
+@end deftypefun
+
+@deftypefun gpointer g_tree_lookup (GTree *@var{tree}, gpointer @var{key})
+@end deftypefun
+
+@deftypefun void g_tree_traverse (GTree *@var{tree}, GTraverseFunc @var{traverse_func}, GTraverseType @var{traverse_type}, gpointer @var{data}
+@end deftypefun
+
+@deftypefun gpointer g_tree_search (GTree *@var{tree}, GSearchFunc @var{search_func}, gpointer @var{data})
+@end deftypefun
+
+@deftypefun gint g_tree_height (GTree *@var{tree})
+@end deftypefun
+
+@deftypefun gint g_tree_nnodes (GTree *@var{tree})
+@end deftypefun
+
+@node Memory, Timers, Trees, Top
+@comment node-name, next, previous, up
+@chapter Memory handling
+
+@subsection Functions
+
+@deftypefun gpointer g_malloc (gulong @var{size})
+@end deftypefun
+
+@deftypefun gpointer g_malloc0 (gulong @var{size})
+@end deftypefun
+
+@deftypefun gpointer g_realloc (gpointer @var{mem}, gulong @var{size})
+@end deftypefun
+
+@deftypefun void g_mem_profile (void)
+@end deftypefun
+
+@deftypefun void g_mem_check (gpointer @var{mem})
+@end deftypefun
+
+@deftypefun GMemChunk* g_mem_chunk_new (gchar *@var{name}, gint @var{atom_size}, gulong @var{area_size}, gint @var{type})
+@end deftypefun
+
+@deftypefun void g_mem_chunk_destroy (GMemChunk *@var{mem_chunk})
+@end deftypefun
+
+@deftypefun gpointer g_mem_chunk_alloc (GMemChunk *@var{mem_chunk})
+@end deftypefun
+
+@deftypefun void g_mem_chunk_free (GMemChunk *@var{mem_chunk}, gpointer @var{mem})
+@end deftypefun
+
+@deftypefun void g_mem_chunk_clean (GMemChunk *@var{mem_chunk})
+@end deftypefun
+
+@deftypefun void g_mem_chunk_reset (GMemChunk *@var{mem_chunk})
+@end deftypefun
+
+@deftypefun void g_mem_chunk_print (GMemChunk *@var{mem_chunk})
+@end deftypefun
+
+@deftypefun void g_mem_chunk_info (void)
+@end deftypefun
+
+@deftypefun void g_blow_chunks (void)
+Not what you might be thinking, @code{g_blow_chunks()} simply compresses all
+the chunks. This operation consists of freeing every memory area that should
+be freed (but which we haven't gotten around to doing yet).
+@end deftypefun
+
+@node Timers, Output, Memory, Top
+@comment node-name, next, previous, up
+@chapter Timer functions
+
+@subsection Functions
+
+@deftypefun GTimer* g_timer_new (void)
+@end deftypefun
+
+@deftypefun void g_timer_destroy (GTimer *@var{timer})
+@end deftypefun
+
+@deftypefun void g_timer_start (GTimer *@var{timer})
+@end deftypefun
+
+@deftypefun void g_timer_stop (GTimer *@var{timer})
+@end deftypefun
+
+@deftypefun void g_timer_reset (GTimer *@var{timer})
+@end deftypefun
+
+@deftypefun gdouble g_timer_elapsed (GTimer *@var{timer}, gulong *@var{microseconds})
+@end deftypefun
+
+@node Output, Utilities, Timers, Top
+@comment node-name, next, previous, up
+@chapter Output functions
+
+@subsection Functions
+
+@deftypefun void g_error (gchar *@var{format}, @dots{})
+@end deftypefun
+
+@deftypefun void g_warning (gchar *@var{format}, @dots{})
+@end deftypefun
+
+@deftypefun void g_message (gchar *@var{format}, @dots{})
+@end deftypefun
+
+@deftypefun void g_print (gchar *@var{format}, @dots{})
+@end deftypefun
+
+@node Utilities, Errors, Output, Top
+@comment node-name, next, previous, up
+@chapter Utility functions
+
+@node Errors, String Chunks, Utilities, Top
+@comment node-name, next, previous, up
+@chapter Error handling
+
+@node String Chunks, Strings, Errors, Top
+@comment node-name, next, previous, up
+@chapter String chunks
+
+@node Strings, Resizable arrays, String Chunks, Top
+@comment node-name, next, previous, up
+@chapter String handling
+
+@node Resizable arrays, GScanner, Strings, Top
+@comment node-name, next, previous, up
+@chapter Resizable arrays
+
+@node GScanner, Miscellany, Resizable arrays, Top
+@comment node-name, next, previous, up
+@chapter Flexible lexical scanner
+
+@node Miscellany, Function Index, GScanner, Top
+@comment node-name, next, previous, up
+@chapter Other stuff
+
+@node Function Index, Concept Index, Miscellany, Top
+@comment node-name, next, previous, up
+@unnumbered Function Index
+
+@printindex fn
+
+@node Concept Index, , Function Index, Top
+@comment node-name, next, previous, up
+@unnumbered Concept Index
+
+@printindex cp
+
+@summarycontents
+@contents
+@bye
+
diff --git a/docs/gtk.texi b/docs/gtk.texi
index 373e1e23e..8e018abd4 100644
--- a/docs/gtk.texi
+++ b/docs/gtk.texi
@@ -9,7 +9,7 @@
@c %**end of header
@set edition 1.0
-@set update-date 16 January 1998
+@set update-date 29 January 1998
@set update-month January 1998
@ifinfo
@@ -186,7 +186,8 @@ struct _GtkTypeInfo
guint class_size;
GtkClassInitFunc class_init_func;
GtkObjectInitFunc object_init_func;
- GtkArgFunc arg_func;
+ GtkArgSetFunc arg_set_func;
+ GtkArgGetFunc arg_get_func;
@}
@end example
@@ -219,6 +220,8 @@ The @code{object_init_func} field is a callback which is used by the
type mechanism to initialize object specific fields. The single argument
this functions takes is a pointer to an object structure.
+@c FIXME!! Document the arg_set_func and arg_get_func..
+
@end itemize
@deftypefun guint gtk_type_unique (guint @var{parent_type}, GtkTypeInfo *@var{type_info})
@@ -288,6 +291,12 @@ A predicate function which determines whether the relation @var{type}
is_a @var{is_a_type} is true.
@end deftypefun
+@deftypefun void gtk_type_get_arg (GtkObject *@var{object}, GtkType @var{type}, GtkArg *@var{arg}, guint @var{arg_id})
+@end deftypefun
+
+@deftypefun void gtk_type_set_arg (GtkObject *@var{object}, GtkType @var{type}, GtkArg *@var{arg}, guint @var{arg_id})
+@end deftypefun
+
@section Object functions
The GtkObject type is the root of the type hierarchy used by GTK. It
@@ -306,6 +315,37 @@ Adds @var{signals} to the @code{signals} field in the GtkObjectClass
structure @var{class}. @xref{Signals}.
@end deftypefun
+@deftypefun GtkObject* gtk_object_new (guint @var{type}, @dots{})
+@end deftypefun
+
+@deftypefun GtkObject* gtk_object_newv (guint @var{type}, guint @var{nargs}, GtkArg *@var{args})
+@end deftypefun
+
+@deftypefun void gtk_object_ref (GtkObject *@var{object});
+@end deftypefun
+
+@deftypefun void gtk_object_unref (GtkObject *@var{object});
+@end deftypefun
+
+@deftypefun void gtk_object_getv (GtkObject *@var{object}, guint @var{nargs}, GtkArg *@var{args})
+@end deftypefun
+
+@deftypefun void gtk_object_set (GtkObject *@var{object}, @dots{})
+@end deftypefun
+
+@deftypefun void gtk_object_setv (GtkObject *@var{object}, guint @var{nargs}, GtArg *@var{args})
+@end deftypefun
+
+@deftypefun GtkArg* gtk_object_query_args (GtkType @var{class_type}, guint *@var{nargs})
+@end deftypefun
+
+@deftypefun void gtk_object_add_arg_type (gchar *@var{arg_name}, GtkType @var{arg_type}, guint @var{arg_id})
+@end deftypefun
+
+@deftypefun GtkType gtk_object_get_arg_type (gchar *@var{arg_name})
+@end deftypefun
+
+
@deftypefun void gtk_object_destroy (GtkObject *@var{object})
Performs checks to make sure it is alright to destroy @var{object} and
then emits the @code{destroy} signal. The check which is performed is to
@@ -346,6 +386,8 @@ Sets @var{data} into the @code{user_data} field of @var{object}.
Returns the @code{user_data} field of @var{object}.
@end deftypefun
+@c ------------ Is this depreceated? -----------------
+
The GtkObject type also provides a mechanism for specifying
initialization values for fields. This general mechanism is called
object value stacks. The reason for using value stacks is that they can
@@ -480,6 +522,9 @@ and @var{object_type}. If @var{object_type} does not define the signal
type recursively.
@end deftypefun
+@deftypefun gchar* gtk_signal_name (gint @var{signal_num})
+@end deftypefun
+
@deftypefun gint gtk_signal_emit (GtkObject *@var{object}, gint @var{signal_type}, @dots{})
Emit the signal specified by the integer identifier @var{signal_type}
from @var{object}. If an error occurs, @code{gtk_signal_emit} will
@@ -586,6 +631,9 @@ the signal. Returns an integer identifier which can be used to refer to
the connection.
@end deftypefun
+@deftypefun gint gtk_signal_connect_interp (GtkObject *@var{object}, gchar *@var{name}, GtkCallbackMarshal @var{func}, gpointer @var{data}, GtkDestroyNotify @var{destroy_func}, gint @var{after})
+@end deftypefun
+
@deftypefun void gtk_signal_disconnect (GtkObject *@var{object}, gint @var{id})
Disconnects a signal handler from an object. The signal handler is
identified by the integer @var{id} which is returned by the
@@ -666,6 +714,9 @@ of the particular form:
marshals arguments for a signal of that form.
@end deftypefun
+@deftypefun void gtk_signal_set_funcs (GtkSignalMarshal @var{marshal_func}, GtkSignalDestroy @var{destroy_fun})
+@end deftypefun
+
@node Widgets, Other Objects, Signals, Top
@comment node-name, next, previous, up
@@ -709,7 +760,7 @@ The available widgets (in alphabetical order):
* GtkCheckMenuItem:: The check menu item widget.
* GtkCList:: The compound list widget.
* GtkColorSelection:: The color selector widget.
-* GtkComboBox:: The combobox widget.
+* GtkCombo:: The combo box widget.
* GtkContainer:: The container widget.
* GtkCurve:: The curve widget.
* GtkDialog:: The dialog widget.
@@ -859,7 +910,8 @@ all the space it is allocated.
@defopt arrow_type
The @var{arrow_type} option specifies which direction the arrow will
point. It can be one of @code{GTK_ARROW_UP}, @code{GTK_ARROW_DOWN},
-@code{GTK_ARROW_LEFT} or @code{GTK_ARROW_RIGHT}.
+@code{GTK_ARROW_LEFT} or @code{GTK_ARROW_RIGHT}. This will set the arrow
+pointing in the direction specified.
@end defopt
@defopt shadow_type
@@ -1107,6 +1159,22 @@ A convenience function which is equivalent to the following:
@end example
@end deftypefun
+@deftypefun void gtk_box_set_homogeneous (GtkBox *@var{box}, gint @var{homogeneous})
+Set the homogeneous setting of this box to @var{homogeneous}.
+@end deftypefun
+
+@deftypefun void gtk_box_set_spacing (GtkBox *@var{box}, gint @var{spacing})
+@end deftypefun
+
+@deftypefun void gtk_box_reorder_child (GtkBox *@var{box}, GtkWidget *@var{child}, guint @var{pos})
+@end deftypefun
+
+@deftypefun void gtk_box_query_child_packing (GtkBox *@var{box}, GtkWidget *@var{child}, gint *@var{expand}, gint *@var{fill}, gint *@var{padding}, GtkPackType *@var{pack_type})
+@end deftypefun
+
+@deftypefun void gtk_box_set_child_packing (GtkBox *@var{box}, GtkWidget *@var{child}, gint @var{expand}, gint @var{fill}, gint @var{padding}, GtkPackType *@var{pack_type})
+@end deftypefun
+
@gtkstdmacros{Box, BOX}
@@ -1121,9 +1189,21 @@ The button box widget is a container (@pxref{GtkContainer}) derived from the
button box (@pxref{GtkHButtonBox}) and the vertical button box
(@pxref{GtkVButtonBox}) widgets to provide a base of common functionality.
+The button box, like the box widget, (@pxref{GtkBox}) provides an abstraction
+for organizing position and size of wigets. In the case of the button box
+it is targeted at the button widget,(@pxref{GtkButton}). Button widgets are
+layed in the box horizontally or vertically. By using a button box widget
+appropeiately, a programmer can control how the button widgets are positioned
+and how they will be allocated space when a window gets resized.
+
@subsection Options
@defopt layout_style
@itemize @bullet
+@itemize @bullet
+@item
+@code{GTK_BUTTONBOX_SPREAD}
+@end itemize
+
@item
The layout style @code{GTK_BUTTONBOX_SPREAD} will spread the buttons out
evenly within the button box. When the parent window is resized they will
@@ -1131,14 +1211,27 @@ re-adjust to the new window dimensions. The @code{gtk_button_box_set_spacing}
function will set the minimum space that the buttons will leave between
themselves.
+@itemize @bullet
@item
@code{GTK_BUTTONBOX_EDGE}
+@end itemize
+@item
+
+@itemize @bullet
+@item
+@code{GTK_BUTTONBOX_START}
+@end itemize
@item
The layout style @code{GTK_BUTTONBOX_START} will place the buttons at the
start of the button box, taking into account the spacing as set by the
@code{gtk_button_box_set_spacing} function. The buttons will not move
-when the parent window is re-sized.
+when the parent window is re-sized.
+
+@itemize @bullet
+@item
+@code{GTK_BUTTONBOX_END}
+@end itemize
@item
The layout style @code{GTK_BUTTONBOX_END} will place the buttons at the
@@ -1152,6 +1245,13 @@ the parent window is re-sized.
@defopt width
@end defopt
+@defopt height
+@end defopt
+
+@defopt ipad_x
+@defoptx ipad_y
+@end defopt
+
@subsection Signals
@subsection Functions
@@ -1183,11 +1283,13 @@ This will set the layout style of the buttons within this box. Currently it can
be set to one of @code{GTK_BUTTONBOX_SPREAD}, @code{GTK_BUTTONBOX_EDGE},
@code{GTK_BUTTONBOX_START} or @code{GTK_BUTTONBOX_END}.
+The following example:
@example
gtk_button_box_set_layout (GTK_BUTTON_BOX (box),
GTK_BUTTONBOX_SPREAD);
@end example
-
+Will set the @var{box} argument to the @dfn{SPREAD} layout style described
+above.
@end deftypefun
@deftypefun gint gtk_button_box_get_spacing (GtkButtonBox *@var{widget})
@@ -1282,7 +1384,6 @@ pointer to a @code{GtkWidget} object. @code{NULL} is returned on failure.
@section The check button widget
-
@subsection Description
@subsection Options
@@ -1533,7 +1634,7 @@ This is much faster then removing each item seperatly with
@gtkstdmacros{CList, CLIST}
@page
-@node GtkColorSelection, GtkComboBox, GtkCList, Widgets
+@node GtkColorSelection, GtkCombo, GtkCList, Widgets
@comment node-name, next, previous, up
@section The color selector widget
@@ -1586,17 +1687,21 @@ pointer to a @code{GtkWidget} object. @code{NULL} is returned on failure.
@end deftypefun
@deftypefun guint gtk_color_selection_dialog_get_type (void)
+Returns the @code{GtkColorSelection} type identifier.
@end deftypefun
@deftypefun GtkWidget* gtk_color_selection_dialog_new (gchar *@var{title})
+Create a new @code{GtkColorSelection} object initilizing the title bar of
+the resulting dialog to @var{title}. The new widget is returned as a pointer
+to a @code{GtkWidget} object. @code{NULL} is returned on failure.
@end deftypefun
@gtkstdmacros{ColorSelection, COLOR_SELECTION}
@page
-@node GtkComboBox, GtkContainer, GtkColorSelection, Widgets
+@node GtkCombo, GtkContainer, GtkColorSelection, Widgets
@comment node-name, next, previous, up
-@section The combobox widget
+@section The combo widget
@subsection Description
@@ -1606,23 +1711,37 @@ pointer to a @code{GtkWidget} object. @code{NULL} is returned on failure.
@subsection Functions
-@deftypefun guint gtk_combo_box_get_type (void)
-Returns the @code{GtkComboBox} type identifier.
+@deftypefun guint gtk_combo_get_type (void)
+Returns the @code{GtkCombo} type identifier.
+@end deftypefun
+
+@deftypefun GtkWidget* gtk_combo_new (void)
+Create a new @code{GtkCombo} object returning the new widget as a pointer to
+a @code{GtkWidget} object. @code{NULL} is returned on failure.
@end deftypefun
-@deftypefun GtkWidget* gtk_combo_box_new (GList *@var{popdown_strings})
+@deftypefun void gtk_combo_set_value_in_list (GtkCombo *@var{combo}, gint @var{val}, gint @var{ok_if_empty})
@end deftypefun
-@deftypefun GtkWidget* gtk_combo_box_new_with_max_length (GList *@var{popdown_strings}, guint16 @var{max})
+@deftypefun void gtk_combo_set_use_arrows (GtkCombo *@var{combo}, gint @var{val})
@end deftypefun
-@deftypefun void gtk_combo_box_set_popdown_strings(GtkComboBox *@var{combobox}, GList *@var{popdown_strings})
+@deftypefun void gtk_combo_set_use_arrows_always (GtkCombo *@var{combo}, gint @var{val})
@end deftypefun
-@gtkstdmacros{ComboBox, COMBO_BOX}
+@deftypefun void gtk_combo_set_case_sensitive (GtkCombo *@var{combo}, gint @var{val})
+@end deftypefun
+
+@deftypefun void gtk_combo_set_item_string (GtkCombo *@var{combo}, GtkItem *@var{item}, gchar *@var{item_value})
+@end deftypefun
+
+@deftypefun void gtk_combo_set_popdown_strings (GtkCombo *@var{combo}, GList *@var{strings})
+@end deftypefun
+
+@gtkstdmacros{Combo, COMBO}
@page
-@node GtkContainer, GtkCurve, GtkComboBox, Widgets
+@node GtkContainer, GtkCurve, GtkCombo, Widgets
@comment node-name, next, previous, up
@section The container widget
@@ -1804,6 +1923,7 @@ pointer to a @code{GtwWidget} object. @code{NULL} is returned on failure.
@end deftypefun
@deftypefun void gtk_drawing_area_size (GtkDrawingArea *@var{darea}, gint @var{width}, gint @var{height})
+Set the size of the @var{darea} widget, created previously, to @var{width} and @var{height}.
@end deftypefun
@gtkstdmacros{DrawingArea, DRAWING_AREA}
@@ -1825,6 +1945,8 @@ value speified in the @var{max} option. This value is a guint16 value.
@end defopt
@defopt text
+With this option it is possible to 'preload' the text that will be displayed
+in the @code{entry} widget to the string pointed to by @var{text}.
@end defopt
@subsection Signals
@@ -4499,15 +4621,33 @@ int main (int argc, char *argv[])
@{
@dots{Any local variables or non GTK/GDK initilization}
+ /* Initalize GTK. */
gtk_init(&argc, &argc);
-
+
@}
@end example
@end deftypefun
+@deftypefun void gtk_exit (int @var{error_code})
+Exit GTK and perform any necessary cleanup. @code{gtk_exit} will call the
+systems @code{exit} function passing @var{error_code} as the parameter.
+@end deftypefun
+
+@deftypefun gint gtk_events_pending (void)
+Returns the number of events pending on the event queue.
+@end deftypefun
+
@deftypefun void gtk_main (void)
@end deftypefun
+@deftypefun guint gtk_main_level (void)
+@end deftypefun
+
+@deftypefun void gtk_main_quit (void)
+A call to this function will cause the @code{gtk_main} function to exit,
+thereby allowing your application to exit.
+@end deftypefun
+
@page
@node Customization, Menu Factories, Initialization and exit, Miscellaneous
@comment node-name, next, previous, up
@@ -4531,7 +4671,7 @@ argument. It will use the style settings for the widget types defined there.
@deftypefun void gtk_rc_init (void)
This function will initilize the rc file parser, normally this need not
-be called directly as the @code{gtk_init} function will handle this for
+be called directly as the @code{gtk_rc_parse} function will handle this for
you.
@end deftypefun