Commit d925a72d authored by Matthias Clasen's avatar Matthias Clasen

Additions.

        * gtk/tmpl/gtkpixmap.sgml, gtk/tmpl/gtkscale.sgml,
        gtk/tmpl/gtkmain.sgml, gtk/tmpl/gtkimcontextsimple.sgml: Additions.

        * gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks.
parent c7401dec
2001-12-30 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks.
2001-12-28 Matthias Clasen <matthiasc@poet.de>
* gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
......
2001-12-30 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks.
2001-12-28 Matthias Clasen <matthiasc@poet.de>
* gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
......
2001-12-30 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks.
2001-12-28 Matthias Clasen <matthiasc@poet.de>
* gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
......
2001-12-30 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks.
2001-12-28 Matthias Clasen <matthiasc@poet.de>
* gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
......
2001-12-30 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks.
2001-12-28 Matthias Clasen <matthiasc@poet.de>
* gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
......
2001-12-30 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks.
2001-12-28 Matthias Clasen <matthiasc@poet.de>
* gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
......
2001-12-30 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks.
2001-12-28 Matthias Clasen <matthiasc@poet.de>
* gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
......
2001-12-30 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtkpixmap.sgml, gtk/tmpl/gtkscale.sgml,
gtk/tmpl/gtkmain.sgml, gtk/tmpl/gtkimcontextsimple.sgml: Additions.
2001-12-28 Matthias Clasen <matthiasc@poet.de>
* gdk/tmpl/properties.sgml, gdk/tmpl/selections.sgml: Additions.
......
......@@ -41,7 +41,7 @@ GtkIMContextSimple
<!-- ##### MACRO GTK_MAX_COMPOSE_LEN ##### -->
<para>
The maximum length of sequences in compose tables.
</para>
......
......@@ -279,7 +279,7 @@ the event:
</para></listitem>
</itemizedlist>
Another point of interest might be that all keypresses are first passed
Another point of interest might be that all key events are first passed
through the key snooper functions if there are any. Read the description
of gtk_key_snooper_install() if you need this feature.
</para></listitem>
......@@ -556,24 +556,26 @@ Removes the idle function identified by the user data.
<!-- ##### FUNCTION gtk_input_add_full ##### -->
<para>
Registers a function to be called when a condition becomes true
on a file descriptor.
</para>
@source:
@condition:
@function:
@marshal:
@data:
@destroy:
@Returns:
@source: a file descriptor.
@condition: the condition.
@function: The function to call.
@marshal: The marshaller to use instead of the function (if non-%NULL).
@data: callback data passed to @function.
@destroy: callback function to call with @data when the input
handler is removed, or %NULL.
@Returns: A unique id for the event source; to be used with gtk_input_remove().
<!-- ##### FUNCTION gtk_input_remove ##### -->
<para>
Removes the function with the given id.
</para>
@input_handler_id:
@input_handler_id: Identifies the function to remove.
<!-- ##### MACRO GTK_PRIORITY_REDRAW ##### -->
......@@ -636,31 +638,33 @@ This macro is deprecated. You should use %G_PRIORITY_LOW instead.
<!-- ##### FUNCTION gtk_key_snooper_install ##### -->
<para>
Installs a key snooper function, which will get called on all key events
before delivering them normally.
</para>
@snooper:
@func_data:
@Returns:
@snooper: a #GtkKeySnoopFunc.
@func_data: data to pass to @snooper.
@Returns: a unique id for this key snooper for use with gtk_key_snooper_remove().
<!-- ##### USER_FUNCTION GtkKeySnoopFunc ##### -->
<para>
Key snooper functions are called before normal event delivery.
They can be used to implement custom key event handling.
</para>
@grab_widget:
@event:
@func_data:
@Returns:
@grab_widget: the widget to which the event will be delivered.
@event: the key event.
@func_data: the @func_data supplied to gtk_key_snooper_install().
@Returns: %TRUE to stop further processing of @event, %FALSE to continue.
<!-- ##### FUNCTION gtk_key_snooper_remove ##### -->
<para>
Removes the key snooper function with the given id.
</para>
@snooper_handler_id:
@snooper_handler_id: Identifies the key snooper to remove.
<!-- ##### FUNCTION gtk_get_current_event ##### -->
......
......@@ -65,7 +65,8 @@ Gets the current #GdkPixmap and #GdkBitmap mask.
<!-- ##### FUNCTION gtk_pixmap_set_build_insensitive ##### -->
<para>
Sets wether an extra pixmap should be automatically created and used
when the pixmap is insensitive. The default value is %TRUE.
</para>
@pixmap: a #GtkPixmap.
......
......@@ -69,7 +69,7 @@ slider.
</para>
@scale: a #GtkScale.
@draw_value:
@draw_value: a boolean.
<!-- ##### FUNCTION gtk_scale_set_value_pos ##### -->
......@@ -83,29 +83,30 @@ Sets the position in which the current value is displayed.
<!-- ##### FUNCTION gtk_scale_get_digits ##### -->
<para>
Gets the number of decimal places that are displayed in the value.
</para>
@scale:
@Returns:
@scale: a #GtkScale.
@Returns: the number of decimal places that are displayed.
<!-- ##### FUNCTION gtk_scale_get_draw_value ##### -->
<para>
Returns whether the current value is displayed as a string next to the
slider.
</para>
@scale:
@Returns:
@scale: a #GtkScale.
@Returns: whether the current value is displayed as a string.
<!-- ##### FUNCTION gtk_scale_get_value_pos ##### -->
<para>
Gets the position in which the current value is displayed.
</para>
@scale:
@Returns:
@scale: a #GtkScale.
@Returns: the position in which the current value is displayed.
<!-- ##### SIGNAL GtkScale::format-value ##### -->
......
......@@ -1277,17 +1277,17 @@ gtk_im_context_simple_get_preedit_string (GtkIMContext *context,
* @context_simple: A #GtkIMContextSimple
* @data: the table
* @max_seq_len: Maximum length of a sequence in the table
* (cannot be greater than 7)
* (cannot be greater than #GTK_MAX_COMPOSE_LEN)
* @n_seqs: number of sequences in the table
*
* Add an additional table to search to the input context.
* Each row of the table consists of max_seq_len key symbols
* followed by two guint16 interpreted as the high and low
* words of a gunicode value. Tables are searched starting
* Adds an additional table to search to the input context.
* Each row of the table consists of @max_seq_len key symbols
* followed by two #guint16 interpreted as the high and low
* words of a #gunicode value. Tables are searched starting
* from the last added.
*
* The table must be sorted in dictionary order on the
* by numeric value of the key symbol fields. (Values beyond
* numeric value of the key symbol fields. (Values beyond
* the length of the sequence should be zero.)
**/
void
......
......@@ -845,7 +845,7 @@ gtk_window_get_title (GtkWindow *window)
* Don't use this function. It sets the X Window System "class" and
* "name" hints for a window. According to the ICCCM, you should
* always set these to the same value for all windows in an
* application, and GTK sets them to that value by default, so calling
* application, and GTK+ sets them to that value by default, so calling
* this function is sort of pointless. However, you may want to call
* gtk_window_set_role() on each window in your application, for the
* benefit of the session manager. Setting the role allows the window
......@@ -1318,7 +1318,7 @@ gtk_window_activate_focus (GtkWindow *window)
* Retrieves the current focused widget within the window.
* Note that this is the widget that would have the focus
* if the toplevel window focused; if the toplevel window
* is not focused the GTK_WIDGET_HAS_FOCUS(widget) will
* is not focused then <literal>GTK_WIDGET_HAS_FOCUS (widget)</literal> will
* not be %TRUE for the widget.
*
* Return value: the currently focused widget.
......@@ -1406,8 +1406,8 @@ gtk_window_get_modal (GtkWindow *window)
* Returns a list of all existing toplevel windows. The widgets
* in the list are not individually referenced. If you want
* to iterate through the list and perform actions involving
* callbacks that might destroy the widgets, you MUST call
* g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and
* callbacks that might destroy the widgets, you <emphasis>must</emphasis> call
* <literal>g_list_foreach (result, (GFunc)g_object_ref, NULL)</literal> first, and
* then unref all the widgets afterwards.
*
* Return value: list of toplevel widgets
......@@ -1683,7 +1683,7 @@ gtk_window_get_type_hint (GtkWindow *window)
* @window: a #GtkWindow
* @setting: whether to destroy @window with its transient parent
*
* If @setting is TRUE, then destroying the transient parent of @window
* If @setting is %TRUE, then destroying the transient parent of @window
* will also destroy @window itself. This is useful for dialogs that
* shouldn't persist beyond the lifetime of the main window they're
* associated with, for example.
......@@ -2513,7 +2513,7 @@ gtk_window_resize (GtkWindow *window,
* "configure_event" on the window and adjust your size-dependent
* state to match the size delivered in the #GdkEventConfigure.
*
* Note 2: The returned size does NOT include the size of the window
* Note 2: The returned size does <emphasis>not</emphasis> include the size of the window
* manager decorations (aka the window frame or border). Those
* are not drawn by GTK+ and GTK+ has no reliable method of
* determining their size.
......@@ -2533,7 +2533,7 @@ gtk_window_resize (GtkWindow *window,
* application cannot.
*
* In any case, if you insist on application-specified window
* positioning, there's STILL a better way than doing it yourself -
* positioning, there's <emphasis>still</emphasis> a better way than doing it yourself -
* gtk_window_set_position() will frequently handle the details
* for you.
*
......@@ -2607,8 +2607,8 @@ gtk_window_get_size (GtkWindow *window,
* the bottom-right corner of the window border will be placed at that
* reference point. So, to place a window in the bottom right corner
* you would first set gravity to south east, then write:
* gtk_window_move (window, gdk_screen_width () - window_width,
* gdk_screen_height () - window_height).
* <literal>gtk_window_move (window, gdk_screen_width () - window_width,
* gdk_screen_height () - window_height)</literal>.
*
* The extended window manager hints specification at <ulink
* url="http://www.freedesktop.org/standards/wm-spec.html"
......@@ -4100,7 +4100,7 @@ gtk_window_move_resize (GtkWindow *window)
* or gtk_window_move().
*
* If the configure request has changed, we send off a new one. To
* ensure GTK invariants are maintained (resize queue does what it
* ensure GTK+ invariants are maintained (resize queue does what it
* should), we go ahead and size_allocate the requested size in this
* function.
*
......@@ -4692,9 +4692,9 @@ gtk_window_expose (GtkWidget *widget,
* you want gtk_window_set_decorated() instead, which tells the window
* manager whether to draw the window border.)
*
* If this function is called on a window with setting of TRUE, before
* If this function is called on a window with setting of %TRUE, before
* it is realized or showed, it will have a "frame" window around
* widget->window, accessible in window->frame. Using the signal
* @window->window, accessible in @window->frame. Using the signal
* frame_event you can recieve all events targeted at the frame.
*
* This function is used by the linux-fb port to implement managed
......@@ -4717,10 +4717,10 @@ gtk_window_set_has_frame (GtkWindow *window,
* @window: a #GtkWindow
*
* Accessor for whether the window has a frame window exterior to
* widget->window. Gets the value set by gtk_window_set_has_frame ().
* @window->window. Gets the value set by gtk_window_set_has_frame ().
*
* Return value: %TRUE if a frame has been added to the window
* via gtk_widow_has_frame
* via gtk_window_set_has_frame().
**/
gboolean
gtk_window_get_has_frame (GtkWindow *window)
......@@ -4743,7 +4743,7 @@ gtk_window_get_has_frame (GtkWindow *window)
* window border drawn by the window manager, which is the normal
* case when using the X Window system.)
*
* For windows with frames (see #gtk_window_set_has_frame) this function
* For windows with frames (see gtk_window_set_has_frame()) this function
* can be used to change the size of the frame border.
**/
void
......
Markdown is supported
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