diff options
| author | Havoc Pennington <hp@redhat.com> | 2001-03-12 18:46:53 +0000 |
|---|---|---|
| committer | Havoc Pennington <hp@src.gnome.org> | 2001-03-12 18:46:53 +0000 |
| commit | 10a173fedf26019270363b2a8e86286e9ca4b437 (patch) | |
| tree | 99c3a1ca5ba65a84b21a06ba70994be04985938c /docs | |
| parent | a647514c3393ef5d59b7b9ba11bcee1149519916 (diff) | |
| download | gtk+-10a173fedf26019270363b2a8e86286e9ca4b437.tar.gz | |
Switch to using an enum with registration for icon sizes, instead of
2001-03-12 Havoc Pennington <hp@redhat.com>
* gtk/gtkiconfactory.h, gtk/gtkiconfactory.c: Switch to using an
enum with registration for icon sizes, instead of strings.
* gtkimage.h, gtkimage.c, gtkstyle.h, gtkstyle.c, gtkwidget.h,
gtkwidget.c: Fix to reflect GtkIconSize
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference/gtk/tmpl/gtk-unused.sgml | 78 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtkiconfactory.sgml | 44 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtksignal.sgml | 219 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtktypeutils.sgml | 20 |
4 files changed, 182 insertions, 179 deletions
diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml index fb4d6b3765..a7061119f1 100644 --- a/docs/reference/gtk/tmpl/gtk-unused.sgml +++ b/docs/reference/gtk/tmpl/gtk-unused.sgml @@ -110,6 +110,36 @@ has the focus. @clist: The #GtkCList widget to check. +<!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### --> +<para> + +</para> + + +<!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### --> +<para> + +</para> + + +<!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### --> +<para> + +</para> + + +<!-- ##### MACRO GTK_ICON_SIZE_MENU ##### --> +<para> + +</para> + + +<!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### --> +<para> + +</para> + + <!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### --> <para> Test whether a GtkObject's arguments have been prepared. @@ -395,6 +425,24 @@ The position of the cursor. </para> +<!-- ##### USER_FUNCTION GtkEmissionHook ##### --> +<para> +A simple function pointer to get invoked when the +signal is emitted. This allows you tie a hook to the signal type, +so that it will trap all emissions of that signal, from any object. +</para> +<para> +You may not attach these to signals created with the +#GTK_RUN_NO_HOOKS flag. +</para> + +@object: +@signal_id: +@n_params: +@params: +@data: +@Returns: + <!-- ##### ENUM GtkFontFilterType ##### --> <para> A set of bit flags used to specify the filter being set @@ -970,6 +1018,20 @@ Internal function. @ruler: the gtkruler +<!-- ##### FUNCTION gtk_signal_add_emission_hook ##### --> +<para> +Add an emission hook for a type of signal, for any object. +</para> + +@signal_id: the type of signal to hook for. +@hook_func: the function to invoke to handle the emission hook. +@data: the user data passed in to hook_func. +@Returns: the id (that you may pass as a parameter +to gtk_signal_remove_emission_hook()). +@i: +@h: +@d: + <!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### --> <para> Add an emission hook for a type of signal, for any object. @@ -1009,6 +1071,12 @@ This function is labeled private. @object: the object whose signal handlers should be destroyed. +<!-- ##### FUNCTION gtk_signal_init ##### --> +<para> + +</para> + + <!-- ##### FUNCTION gtk_signal_n_emissions ##### --> <para> Find out the recursion depth of emissions for a particular type @@ -1050,6 +1118,16 @@ Obtain information about a signal. which contains all the information, or NULL. The pointer is allocated just for you: you must g_free() it. +<!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### --> +<para> +Delete an emission hook. (see gtk_signal_add_emission_hook()) +</para> + +@signal_id: the id of the signal type. +@hook_id: the id of the emission handler, returned by add_emission_hook(). +@i: +@h: + <!-- ##### FUNCTION gtk_signal_set_funcs ##### --> <para> These set default functions to call when the user didn't diff --git a/docs/reference/gtk/tmpl/gtkiconfactory.sgml b/docs/reference/gtk/tmpl/gtkiconfactory.sgml index d617f266bb..07f48c092a 100644 --- a/docs/reference/gtk/tmpl/gtkiconfactory.sgml +++ b/docs/reference/gtk/tmpl/gtkiconfactory.sgml @@ -188,50 +188,17 @@ looking up the icon to use for a given stock ID. @icon_set: -<!-- ##### MACRO GTK_ICON_SIZE_MENU ##### --> -<para> - -</para> - - - -<!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### --> -<para> - -</para> - - - -<!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### --> -<para> - -</para> - - - -<!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### --> -<para> - -</para> - - - -<!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### --> -<para> - -</para> - - - <!-- ##### FUNCTION gtk_icon_size_lookup ##### --> <para> </para> -@alias: +@size: @width: @height: @Returns: +<!-- # Unused Parameters # --> +@alias: <!-- ##### FUNCTION gtk_icon_size_register ##### --> @@ -239,9 +206,12 @@ looking up the icon to use for a given stock ID. </para> -@alias: +@name: @width: @height: +@Returns: +<!-- # Unused Parameters # --> +@alias: <!-- ##### FUNCTION gtk_icon_size_register_alias ##### --> diff --git a/docs/reference/gtk/tmpl/gtksignal.sgml b/docs/reference/gtk/tmpl/gtksignal.sgml index 11705206fd..1bb805c8ba 100644 --- a/docs/reference/gtk/tmpl/gtksignal.sgml +++ b/docs/reference/gtk/tmpl/gtksignal.sgml @@ -157,25 +157,6 @@ you might have to write a marshaller. @field: -<!-- ##### USER_FUNCTION GtkEmissionHook ##### --> -<para> -A simple function pointer to get invoked when the -signal is emitted. This allows you tie a hook to the signal type, -so that it will trap all emissions of that signal, from any object. -</para> -<para> -You may not attach these to signals created with the -#GTK_RUN_NO_HOOKS flag. -</para> - -@object: -@signal_id: -@n_params: -@params: -@data: -@Returns: - - <!-- ##### ENUM GtkSignalRunType ##### --> <para> These configure the signal's emission. They control @@ -251,13 +232,6 @@ to the signal. @GTK_RUN_ACTION: @GTK_RUN_NO_HOOKS: -<!-- ##### FUNCTION gtk_signal_init ##### --> -<para> - -</para> - - - <!-- ##### FUNCTION gtk_signal_new ##### --> <para> Create a new signal type. (This is usually done in the @@ -315,7 +289,7 @@ you don't want a return value. the callbacks. -<!-- ##### FUNCTION gtk_signal_lookup ##### --> +<!-- ##### MACRO gtk_signal_lookup ##### --> <para> Given the name of the signal and the type of object it connects to, get the signal's identifying integer. Emitting the signal @@ -325,12 +299,13 @@ by number is somewhat faster than using the name each time. It also tries the ancestors of the given type. </para> +@Returns: the signal's identifying number, or 0 if no signal was found. +<!-- # Unused Parameters # --> @name: the signal's name, e.g. clicked. @object_type: the type that the signal operates on, e.g. #GTK_TYPE_BUTTON. -@Returns: the signal's identifying number, or 0 if no signal was found. -<!-- ##### FUNCTION gtk_signal_name ##### --> +<!-- ##### MACRO gtk_signal_name ##### --> <para> Given the signal's identifier, find its name. </para> @@ -338,8 +313,9 @@ Given the signal's identifier, find its name. Two different signals may have the same name, if they have differing types. </para> -@signal_id: the signal's identifying number. @Returns: the signal name, or NULL if the signal number was invalid. +<!-- # Unused Parameters # --> +@signal_id: the signal's identifying number. <!-- ##### FUNCTION gtk_signal_emit ##### --> @@ -407,7 +383,7 @@ an array of GtkArgs instead of using C's varargs mechanism. followed by one which is a pointer to the return type. -<!-- ##### FUNCTION gtk_signal_emit_stop ##### --> +<!-- ##### MACRO gtk_signal_emit_stop ##### --> <para> This function aborts a signal's current emission. </para> @@ -421,11 +397,11 @@ It will print a warning if used on a signal which isn't being emitted. </para> -@object: the object whose signal handlers you wish to stop. -@signal_id: the signal identifier, as returned by gtk_signal_lookup(). -<!-- # Unused Parameters # --> @i: @s: +<!-- # Unused Parameters # --> +@object: the object whose signal handlers you wish to stop. +@signal_id: the signal identifier, as returned by gtk_signal_lookup(). <!-- ##### FUNCTION gtk_signal_emit_stop_by_name ##### --> @@ -441,7 +417,7 @@ except it will lookup the signal id for you. @name: the name of the signal you wish to stop. -<!-- ##### FUNCTION gtk_signal_connect ##### --> +<!-- ##### MACRO gtk_signal_connect ##### --> <para> Attach a function pointer and user data to a signal for a particular object. @@ -480,38 +456,38 @@ static void attach_print_signal(GtkButton* button, gint to_print) </programlisting> </informalexample> +@o: +@s: +@f: +@d: +@Returns: the connection id. +<!-- # Unused Parameters # --> @object: the object associated with the signal, e.g. if a button is getting pressed, this is that button. @name: name of the signal. @func: function pointer to attach to the signal. @func_data: value to pass as to your function (through the marshaller). -@Returns: the connection id. -<!-- # Unused Parameters # --> -@o: -@s: -@f: -@d: -<!-- ##### FUNCTION gtk_signal_connect_after ##### --> +<!-- ##### MACRO gtk_signal_connect_after ##### --> <para> Attach a function pointer and user data to a signal so that this handler will be called after the other handlers. </para> -@object: the object associated with the signal. -@name: name of the signal. -@func: function pointer to attach to the signal. -@func_data: value to pass as to your function (through the marshaller). -@Returns: the unique identifier for this attachment: the connection id. -<!-- # Unused Parameters # --> @o: @s: @f: @d: +@Returns: the unique identifier for this attachment: the connection id. +<!-- # Unused Parameters # --> +@object: the object associated with the signal. +@name: name of the signal. +@func: function pointer to attach to the signal. +@func_data: value to pass as to your function (through the marshaller). -<!-- ##### FUNCTION gtk_signal_connect_object ##### --> +<!-- ##### MACRO gtk_signal_connect_object ##### --> <para> This function is for registering a callback that will call another object's callback. That is, @@ -532,21 +508,21 @@ gtk_signal_connect_object(button, "clicked", gtk_widget_show, window); </programlisting> </informalexample> +@o: +@s: +@f: +@d: +@Returns: the connection id. +<!-- # Unused Parameters # --> @object: the object which emits the signal. @name: the name of the signal. @func: the function to callback. @slot_object: the object to pass as the first parameter to func. (Though it pretends to take an object, you can really pass any gpointer as the #slot_object .) -@Returns: the connection id. -<!-- # Unused Parameters # --> -@o: -@s: -@f: -@d: -<!-- ##### FUNCTION gtk_signal_connect_object_after ##### --> +<!-- ##### MACRO gtk_signal_connect_object_after ##### --> <para> Attach a signal hook to a signal, passing in an alternate object as the first parameter, and guaranteeing @@ -554,16 +530,16 @@ that the default handler and all normal handlers are called first. </para> -@object: the object associated with the signal. -@name: name of the signal. -@func: function pointer to attach to the signal. -@slot_object: the object to pass as the first parameter to #func. -@Returns: the connection id. -<!-- # Unused Parameters # --> @o: @s: @f: @d: +@Returns: the connection id. +<!-- # Unused Parameters # --> +@object: the object associated with the signal. +@name: name of the signal. +@func: function pointer to attach to the signal. +@slot_object: the object to pass as the first parameter to #func. <!-- ##### FUNCTION gtk_signal_connect_full ##### --> @@ -652,95 +628,98 @@ should signal the removal of this signal. @name: name of the signal. -<!-- ##### FUNCTION gtk_signal_disconnect ##### --> +<!-- ##### MACRO gtk_signal_disconnect ##### --> <para> Destroy a user-defined handler connection. </para> +<!-- # Unused Parameters # --> @object: the object which the handler pertains to. @handler_id: the connection id. -<!-- ##### FUNCTION gtk_signal_disconnect_by_func ##### --> +<!-- ##### MACRO gtk_signal_disconnect_by_func ##### --> <para> Destroy all connections for a particular object, with the given function-pointer and user-data. </para> -@object: the object which emits the signal. -@func: the function pointer to search for. -@data: the user data to search for. -<!-- # Unused Parameters # --> @o: @f: @d: +<!-- # Unused Parameters # --> +@object: the object which emits the signal. +@func: the function pointer to search for. +@data: the user data to search for. -<!-- ##### FUNCTION gtk_signal_disconnect_by_data ##### --> +<!-- ##### MACRO gtk_signal_disconnect_by_data ##### --> <para> Destroy all connections for a particular object, with the given user-data. </para> -@object: the object which emits the signal. -@data: the user data to search for. -<!-- # Unused Parameters # --> @o: @d: +<!-- # Unused Parameters # --> +@object: the object which emits the signal. +@data: the user data to search for. -<!-- ##### FUNCTION gtk_signal_handler_block ##### --> +<!-- ##### MACRO gtk_signal_handler_block ##### --> <para> Prevent an user-defined handler from being invoked. All other signal processing will go on as normal, but this particular handler will ignore it. </para> +<!-- # Unused Parameters # --> @object: the object which emits the signal to block. @handler_id: the connection id. -<!-- ##### FUNCTION gtk_signal_handler_block_by_func ##### --> +<!-- ##### MACRO gtk_signal_handler_block_by_func ##### --> <para> Prevent a user-defined handler from being invoked, by reference to the user-defined handler's function pointer and user data. (It may result in multiple hooks being blocked, if you've called connect multiple times.) </para> -@object: the object which emits the signal to block. -@func: the function pointer of the handler to block. -@data: the user data of the handler to block. -<!-- # Unused Parameters # --> @o: @f: @d: +<!-- # Unused Parameters # --> +@object: the object which emits the signal to block. +@func: the function pointer of the handler to block. +@data: the user data of the handler to block. -<!-- ##### FUNCTION gtk_signal_handler_block_by_data ##### --> +<!-- ##### MACRO gtk_signal_handler_block_by_data ##### --> <para> Prevent all user-defined handlers with a certain user data from being invoked. </para> -@object: the object which emits the signal we want to block. -@data: the user data of the handlers to block. -<!-- # Unused Parameters # --> @o: @d: +<!-- # Unused Parameters # --> +@object: the object which emits the signal we want to block. +@data: the user data of the handlers to block. -<!-- ##### FUNCTION gtk_signal_handler_unblock ##### --> +<!-- ##### MACRO gtk_signal_handler_unblock ##### --> <para> Undo a block, by connection id. Note that undoing a block doesn't necessarily make the hook callable, because if you block a hook twice, you must unblock it twice. </para> +<!-- # Unused Parameters # --> @object: the object which emits the signal we want to unblock. @handler_id: the emission handler identifier, as returned by gtk_signal_connect(), etc. -<!-- ##### FUNCTION gtk_signal_handler_unblock_by_func ##### --> +<!-- ##### MACRO gtk_signal_handler_unblock_by_func ##### --> <para> Undo a block, by function pointer and data. Note that undoing a block doesn't @@ -748,29 +727,29 @@ necessarily make the hook callable, because if you block a hook twice, you must unblock it twice. </para> -@object: the object which emits the signal we want to unblock. -@func: the function pointer to search for. -@data: the user data to search for. -<!-- # Unused Parameters # --> @o: @f: @d: +<!-- # Unused Parameters # --> +@object: the object which emits the signal we want to unblock. +@func: the function pointer to search for. +@data: the user data to search for. -<!-- ##### FUNCTION gtk_signal_handler_unblock_by_data ##### --> +<!-- ##### MACRO gtk_signal_handler_unblock_by_data ##### --> <para> Undo block(s), to all signals for a particular object with a particular user-data pointer </para> -@object: the object which emits the signal we want to unblock. -@data: the user data to search for. -<!-- # Unused Parameters # --> @o: @d: +<!-- # Unused Parameters # --> +@object: the object which emits the signal we want to unblock. +@data: the user data to search for. -<!-- ##### FUNCTION gtk_signal_handler_pending ##### --> +<!-- ##### MACRO gtk_signal_handler_pending ##### --> <para> Returns a connection id corresponding to a given signal id and object. </para> @@ -781,64 +760,36 @@ may opt to not emit the signal if no one is attached anyway, thus saving the cost of building the arguments. </para> +@i: +@s: +@b: +@Returns: the connection id, if a connection was found. 0 otherwise. +<!-- # Unused Parameters # --> @object: the object to search for the desired user-defined handler. @signal_id: the number of the signal to search for. @may_be_blocked: whether it is acceptable to return a blocked handler. -@Returns: the connection id, if a connection was found. 0 otherwise. -<!-- # Unused Parameters # --> -@i: -@s: -@b: -<!-- ##### FUNCTION gtk_signal_handler_pending_by_func ##### --> +<!-- ##### MACRO gtk_signal_handler_pending_by_func ##### --> <para> Returns a connection id corresponding to a given signal id, object, function pointer and user data. </para> -@object: the object to search for the desired handler. -@signal_id: the number of the signal to search for. -@may_be_blocked: whether it is acceptable to return a blocked -handler. -@func: the function pointer to search for. -@data: the user data to search for. -@Returns: the connection id, if a handler was found. 0 otherwise. -<!-- # Unused Parameters # --> @o: @s: @b: @f: @d: - - -<!-- ##### FUNCTION gtk_signal_add_emission_hook ##### --> -<para> -Add an emission hook for a type of signal, for any object. -</para> - -@signal_id: the type of signal to hook for. -@hook_func: the function to invoke to handle the emission hook. -@data: the user data passed in to hook_func. -@Returns: the id (that you may pass as a parameter -to gtk_signal_remove_emission_hook()). -<!-- # Unused Parameters # --> -@i: -@h: -@d: - - -<!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### --> -<para> -Delete an emission hook. (see gtk_signal_add_emission_hook()) -</para> - -@signal_id: the id of the signal type. -@hook_id: the id of the emission handler, returned by add_emission_hook(). +@Returns: the connection id, if a handler was found. 0 otherwise. <!-- # Unused Parameters # --> -@i: -@h: +@object: the object to search for the desired handler. +@signal_id: the number of the signal to search for. +@may_be_blocked: whether it is acceptable to return a blocked +handler. +@func: the function pointer to search for. +@data: the user data to search for. <!-- ##### MACRO gtk_signal_default_marshaller ##### --> diff --git a/docs/reference/gtk/tmpl/gtktypeutils.sgml b/docs/reference/gtk/tmpl/gtktypeutils.sgml index 6295e2dfa1..16a7e543fe 100644 --- a/docs/reference/gtk/tmpl/gtktypeutils.sgml +++ b/docs/reference/gtk/tmpl/gtktypeutils.sgml @@ -560,30 +560,33 @@ Create a new, unique type. @type_info: must not be null, and @type_info->type_name must also not be null. -<!-- ##### FUNCTION gtk_type_name ##### --> +<!-- ##### MACRO gtk_type_name ##### --> <para> </para> -@type: a GtkType @Returns: a pointer to the name of a type, or NULL if it has none. +<!-- # Unused Parameters # --> +@type: a GtkType -<!-- ##### FUNCTION gtk_type_from_name ##### --> +<!-- ##### MACRO gtk_type_from_name ##### --> <para> Get the internal representation of a type given its name. </para> -@name: the name of a gtk type @Returns: a GtkType +<!-- # Unused Parameters # --> +@name: the name of a gtk type -<!-- ##### FUNCTION gtk_type_parent ##### --> +<!-- ##### MACRO gtk_type_parent ##### --> <para> </para> -@type: a GtkType @Returns: the GtkType of the parent +<!-- # Unused Parameters # --> +@type: a GtkType <!-- ##### FUNCTION gtk_type_class ##### --> @@ -608,15 +611,16 @@ has all the proper initializers called. @Returns: gpointer to a GtkTypeObject -<!-- ##### FUNCTION gtk_type_is_a ##### --> +<!-- ##### MACRO gtk_type_is_a ##### --> <para> Look in the type hierarchy to see if @type has @is_a_type among its ancestors. Do so with a simple lookup, not a loop. </para> +@Returns: +<!-- # Unused Parameters # --> @type: GtkType @is_a_type: GtkType -@Returns: <!-- ##### FUNCTION gtk_type_enum_get_values ##### --> |