gtk2/docs/reference/gtk/tmpl/gtkwidget.sgml

2369 lines
38 KiB
Plaintext
Raw Normal View History

1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
GtkWidget
<!-- ##### SECTION Short_Description ##### -->
Base class for all widgets
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Long_Description ##### -->
<para id="style-properties">
<structname>GtkWidget</structname> introduces <firstterm>style
properties</firstterm> - these are basically object properties that are stored
not on the object, but in the style object associated to the widget. Style
properties are set in <link linkend="gtk-Resource-Files">resource files</link>.
This mechanism is used for configuring such things as the location of the
scrollbar arrows through the theme, giving theme authors more control over the
look of applications without the need to write a theme engine in C.
</para>
1999-08-16 18:51:52 +00:00
<para>
Use gtk_widget_class_install_style_property() to install style properties for
a widget class, gtk_widget_class_find_style_property() or
gtk_widget_class_list_style_properties() to get information about existing
style properties and gtk_widget_style_get_property(), gtk_widget_style_get() or
gtk_widget_style_get_valist() to obtain the value of a style property.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkWidget ##### -->
<para>
</para>
@style: The style for the widget. The style contains the colors the widget should be
drawn in for each state along with graphics contexts used to draw with and the font
to use for text.
@requisition: The widgets desired size.
@allocation: The widgets allocated size.
@window: The widgets window or its parent window if it does not have a window. (Which
will be indicated by the #GTK_NO_WINDOW flag being set).
@parent:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::accel-closures-changed ##### -->
2002-04-20 23:57:41 +00:00
<para>
</para>
@widget: the object which received the signal.
2002-04-20 23:57:41 +00:00
<!-- ##### SIGNAL GtkWidget::button-press-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::button-release-event ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::can-activate-accel ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@arg1:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::child-notify ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@arg1:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::client-event ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::configure-event ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::delete-event ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::destroy-event ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::direction-changed ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@arg1:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::drag-begin ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@drag_context:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::drag-data-delete ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@drag_context:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::drag-data-get ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@drag_context:
@data:
@info:
@time:
<!-- # Unused Parameters # -->
@time_:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::drag-data-received ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@drag_context:
@x:
@y:
@data:
@info:
@time:
<!-- # Unused Parameters # -->
@time_:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::drag-drop ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@drag_context:
@x:
@y:
@time:
@Returns:
<!-- # Unused Parameters # -->
@time_:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::drag-end ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@drag_context:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::drag-leave ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@drag_context:
@time:
<!-- # Unused Parameters # -->
@time_:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::drag-motion ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@widget: the object which received the signal.
@drag_context:
@x:
@y:
@time:
@Returns:
<!-- # Unused Parameters # -->
@time_:
<!-- ##### SIGNAL GtkWidget::enter-notify-event ##### -->
<para>
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::event ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::event-after ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@widget: the object which received the signal.
@event:
<!-- ##### SIGNAL GtkWidget::expose-event ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::focus ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@widget: the object which received the signal.
@arg1:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::focus-in-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::focus-out-event ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::grab-focus ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::grab-notify ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@widget: the object which received the signal.
@arg1:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::hide ##### -->
1999-08-16 18:51:52 +00:00
<para>
1999-08-16 18:51:52 +00:00
</para>
@widget: the object which received the signal.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::hierarchy-changed ##### -->
1999-08-16 18:51:52 +00:00
<para>
Emitted when there is a chance in the hierarchy to
which a widget belong. More precisely, a widget is
<firstterm>anchored</firstterm> when its toplevel
ancestor is a #GtkWindow. This signal is emitted when
a widget changes from un-anchored to anchored or vice-versa.
1999-08-16 18:51:52 +00:00
</para>
@widget: the object which received the signal.
@widget2:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::key-press-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::key-release-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::leave-notify-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::map ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::map-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::mnemonic-activate ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@arg1:
@Returns:
<!-- ##### SIGNAL GtkWidget::motion-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::no-expose-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::parent-set ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@old_parent:
<!-- ##### SIGNAL GtkWidget::popup-menu ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@Returns:
<!-- ##### SIGNAL GtkWidget::property-notify-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::proximity-in-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::proximity-out-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::realize ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::screen-changed ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkWidget::scroll-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::selection-clear-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::selection-get ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@data:
@info:
@time:
<!-- # Unused Parameters # -->
@time_:
<!-- ##### SIGNAL GtkWidget::selection-notify-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::selection-received ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@data:
@time:
<!-- # Unused Parameters # -->
@time_:
<!-- ##### SIGNAL GtkWidget::selection-request-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::show ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::show-help ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@arg1:
@Returns:
<!-- ##### SIGNAL GtkWidget::size-allocate ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@allocation:
<!-- ##### SIGNAL GtkWidget::size-request ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@requisition:
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkWidget::state-changed ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@state:
<!-- ##### SIGNAL GtkWidget::style-set ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@previous_style:
<!-- ##### SIGNAL GtkWidget::unmap ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::unmap-event ##### -->
applied patch from owen to get rid of accel map notifiers. changed things Tue Nov 20 21:25:08 2001 Tim Janik <timj@gtk.org> * applied patch from owen to get rid of accel map notifiers. changed things to fix reentrancy and API as discussed on gtk-devel. * gtk/gtkaccelgroup.[hc]: (gtk_accel_group_finalize): unregister this accel group from all accel map paths. (accel_closure_invalidate): handle invalidation of closures by disconnecting their accelerators. (quick_accel_add): move closure connection and changed notification into this function to reduce code duplication. don't emit change notification on closurers without accelerators. (quick_accel_remove): rewrite, do the exact opposite of quick_accel_add for a GtkAccelGroupEntry. (gtk_accel_group_connect): get rid of the accel_path_quark argument. (gtk_accel_group_connect_by_path): new function to add accelerators with an accel path. (gtk_accel_group_disconnect_closure): new function, disconnect a closure from of an accel group. (gtk_accel_group_disconnect): loop over all closure for a accel_ley, accel_mods pair and remove them. (_gtk_accel_group_reconnect): new function that basically does gtk_accel_group_disconnect_closure() and gtk_accel_group_connect_by_path() once an accel path changed. (gtk_accel_groups_disconnect_closure): remove this, there's gtk_accel_group_disconnect_closure(). * gtk/gtkaccelmap.[hc]: keep list of accel groups per entry now, nuke notifiers. (_gtk_accel_path_is_valid): make this non-static for gtkwidget.c and gtkaccelgroup.c assertions. (gtk_accel_map_add_notifer): removed this function. (gtk_accel_map_remove_notifer): same. (_gtk_accel_map_add_group): (_gtk_accel_map_remove_group): (un-)register accel groups, with accel paths for correct propagation. (gtk_accel_map_add_entry): return void. (gtk_accel_map_lookup): return gboolean instead of GQuark. * gtk/gtkitemfactory.c (gtk_item_factory_add_foreign): always set accel_path on widgets. * gtk/gtkwidget.[hc]: (accel_path_changed): got rid of this, changes are handled by accel maps internally now. (_gtk_widget_set_accel_path): get things to work without notifiers. (gtk_widget_list_accel_closures): list accel closures of a widget. * gtk/gtkwindow.[hc]: rename ::accels_changed, to ::keys_changed.
2001-11-20 23:43:03 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::unrealize ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::visibility-notify-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### SIGNAL GtkWidget::window-state-event ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
<!-- ##### ARG GtkWidget:app-paintable ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:can-default ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:can-focus ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:composite-child ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:events ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:extension-events ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:has-default ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:has-focus ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:height-request ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:is-focus ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:name ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:no-show-all ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:parent ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:receives-default ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:sensitive ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:style ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- ##### ARG GtkWidget:visible ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:width-request ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:cursor-aspect-ratio ##### -->
<para>
</para>
<!-- ##### ARG GtkWidget:cursor-color ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- ##### ARG GtkWidget:focus-line-pattern ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:focus-line-width ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- ##### ARG GtkWidget:focus-padding ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkWidget:interior-focus ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- ##### ARG GtkWidget:secondary-cursor-color ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### STRUCT GtkWidgetClass ##### -->
1999-08-16 18:51:52 +00:00
<para>
<structfield>activate_signal</structfield>
The signal to emit when a widget of this class is activated,
gtk_widget_activate() handles the emission. Implementation of this
signal is optional.
1999-08-16 18:51:52 +00:00
</para>
<para>
<structfield>set_scroll_adjustment_signal</structfield>
This signal is emitted when a widget of this class is added
to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
handles the emission.
Implementation of this signal is optional.
</para>
1999-08-16 18:51:52 +00:00
@parent_class:
@activate_signal:
@set_scroll_adjustments_signal:
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkWidgetFlags ##### -->
1999-08-16 18:51:52 +00:00
<para>
Tells about certain properties of the widget.
</para>
@GTK_TOPLEVEL:
widgets without a real parent, as there are #GtkWindow<!-- -->s and
#GtkMenu<!-- -->s have this flag set throughout their lifetime.
Toplevel widgets always contain their own #GdkWindow.
@GTK_NO_WINDOW:
Indicative for a widget that does not provide its own #GdkWindow.
Visible action (e.g. drawing) is performed on the parent's #GdkWindow.
@GTK_REALIZED:
Set by gtk_widget_realize(), unset by gtk_widget_unrealize().
A realized widget has an associated #GdkWindow.
@GTK_MAPPED:
Set by gtk_widget_map(), unset by gtk_widget_unmap().
Only realized widgets can be mapped. It means that gdk_window_show()
has been called on the widgets window(s).
@GTK_VISIBLE:
Set by gtk_widget_show(), unset by gtk_widget_hide(). Implies that a
widget will be mapped as soon as its parent is mapped.
@GTK_SENSITIVE:
Set and unset by gtk_widget_set_sensitive().
The sensitivity of a widget determines whether it will receive
certain events (e.g. button or key presses). One premise for
the widgets sensitivity is to have this flag set.
@GTK_PARENT_SENSITIVE:
Set and unset by gtk_widget_set_sensitive() operations on the
parents of the widget.
This is the second premise for the widgets sensitivity. Once
it has %GTK_SENSITIVE and %GTK_PARENT_SENSITIVE set, its state is
effectively sensitive. This is expressed (and can be examined) by
the #GTK_WIDGET_IS_SENSITIVE macro.
@GTK_CAN_FOCUS:
Determines whether a widget is able to handle focus grabs.
@GTK_HAS_FOCUS:
Set by gtk_widget_grab_focus() for widgets that also
have %GTK_CAN_FOCUS set. The flag will be unset once another widget
grabs the focus.
@GTK_CAN_DEFAULT:
The widget is allowed to receive the default action via
gtk_widget_grab_default().
@GTK_HAS_DEFAULT:
The widget currently is receiving the default action.
@GTK_HAS_GRAB:
Set by gtk_grab_add(), unset by gtk_grab_remove(). It means that the
widget is in the grab_widgets stack, and will be the preferred one for
receiving events other than ones of cosmetic value.
@GTK_RC_STYLE:
Indicates that the widgets style has been looked up through the rc
mechanism. It does not imply that the widget actually had a style
defined through the rc mechanism.
@GTK_COMPOSITE_CHILD:
Indicates that the widget is a composite child of its parent; see
gtk_widget_push_composite_child(), gtk_widget_pop_composite_child().
@GTK_NO_REPARENT:
Unused since before GTK+ 1.2, will be removed in a future version.
@GTK_APP_PAINTABLE:
Set and unset by gtk_widget_set_app_paintable().
Must be set on widgets whose window the application directly draws on,
in order to keep GTK+ from overwriting the drawn stuff.
@GTK_RECEIVES_DEFAULT:
The widget when focused will receive the default action and have
%GTK_HAS_DEFAULT set even if there is a different widget set as default.
@GTK_DOUBLE_BUFFERED:
Set and unset by gtk_widget_set_double_buffered().
Indicates that exposes done on the widget should be double-buffered.
@GTK_NO_SHOW_ALL:
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_TYPE ##### -->
<para>
Gets the type of a widget.
</para>
1999-08-16 18:51:52 +00:00
@wid: a #GtkWidget.
<!-- ##### MACRO GTK_WIDGET_STATE ##### -->
1999-08-16 18:51:52 +00:00
<para>
Returns the current state of the widget, as a #GtkStateType.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
<!-- ##### MACRO GTK_WIDGET_SAVED_STATE ##### -->
1999-08-16 18:51:52 +00:00
<para>
Returns the saved state of the widget, as a #GtkStateType.
</para>
<para>
The saved state will be restored when a widget gets sensitive
again, after it has been made insensitive with gtk_widget_set_state()
or gtk_widget_set_sensitive().
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_FLAGS ##### -->
1999-08-16 18:51:52 +00:00
<para>
Returns the widget flags from @wid.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_TOPLEVEL ##### -->
<para>
Evaluates to %TRUE if the widget is a toplevel widget.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_NO_WINDOW ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget doesn't have an own #GdkWindow.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_REALIZED ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget is realized.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_MAPPED ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget is mapped.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_VISIBLE ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget is visible.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_DRAWABLE ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget is mapped and visible.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_SENSITIVE ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the #GTK_SENSITIVE flag has be set on the widget.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_PARENT_SENSITIVE ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the #GTK_PARENT_SENSITIVE flag has be set on the widget.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_IS_SENSITIVE ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget is effectively sensitive.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_CAN_FOCUS ##### -->
<para>
Evaluates to %TRUE if the widget is able to handle focus grabs.
</para>
@wid: a #GtkWidget.
<!-- ##### MACRO GTK_WIDGET_HAS_FOCUS ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget has grabbed the focus and no other
widget has done so more recently.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_CAN_DEFAULT ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget is allowed to receive the default action
via gtk_widget_grab_default().
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_RECEIVES_DEFAULT ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget when focused will receive the default action
even if there is a different widget set as default.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_HAS_DEFAULT ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget currently is receiving the default action.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_HAS_GRAB ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widget is in the grab_widgets stack, and will be
the preferred one for receiving events other than ones of cosmetic value.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_RC_STYLE ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the widgets style has been looked up through the rc
mechanism.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_COMPOSITE_CHILD ##### -->
<para>
Evaluates to %TRUE if the widget is a composite child of its parent.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_APP_PAINTABLE ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the #GTK_APP_PAINTABLE flag has been set on the widget.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_DOUBLE_BUFFERED ##### -->
1999-08-16 18:51:52 +00:00
<para>
Evaluates to %TRUE if the #GTK_DOUBLE_BUFFERED flag has been set on the widget.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_SET_FLAGS ##### -->
1999-08-16 18:51:52 +00:00
<para>
Turns on certain widget flags.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
@flag: the flags to set.
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO GTK_WIDGET_UNSET_FLAGS ##### -->
1999-08-16 18:51:52 +00:00
<para>
Turns off certain widget flags.
1999-08-16 18:51:52 +00:00
</para>
@wid: a #GtkWidget.
@flag: the flags to unset.
1999-08-16 18:51:52 +00:00
<!-- ##### USER_FUNCTION GtkCallback ##### -->
1999-08-16 18:51:52 +00:00
<para>
The type of the callback functions used for e.g. iterating over
the children of a container, see gtk_container_foreach().
1999-08-16 18:51:52 +00:00
</para>
@widget: the widget to operate on
@data: user-supplied data
1999-08-16 18:51:52 +00:00
<!-- ##### STRUCT GtkRequisition ##### -->
1999-08-16 18:51:52 +00:00
<para>
A <structname>GtkRequisition</structname> represents the desired size of a widget. See
<xref linkend="size-requisition"/> for more information.
1999-08-16 18:51:52 +00:00
</para>
@width: the widget's desired width
@height: the widget's desired height
1999-08-16 18:51:52 +00:00
<!-- ##### STRUCT GtkAllocation ##### -->
<para>
A <structname>GtkAllocation</structname> of a widget represents region which has been allocated to the
widget by its parent. It is a subregion of its parents allocation. See
<xref linkend="size-allocation"/> for more information.
</para>
@x: the X position of the widgets area relative to its parents allocation.
@y: the Y position of the widgets area relative to its parents allocation.
@width: the width of the widgets allocated area.
@height: the height of the widgets allocated area.
<!-- ##### STRUCT GtkSelectionData ##### -->
<para>
</para>
@selection:
@target:
@type:
@format:
@data:
@length:
@display:
<!-- ##### STRUCT GtkWidgetAuxInfo ##### -->
<para>
</para>
@x:
@y:
@width:
@height:
@x_set:
@y_set:
<!-- ##### STRUCT GtkWidgetShapeInfo ##### -->
<para>
</para>
@offset_x:
@offset_y:
@shape_mask:
<!-- ##### ENUM GtkWidgetHelpType ##### -->
<para>
</para>
@GTK_WIDGET_HELP_TOOLTIP:
@GTK_WIDGET_HELP_WHATS_THIS:
<!-- ##### FUNCTION gtk_widget_new ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@type:
@first_property_name:
@Varargs:
@Returns:
<!-- # Unused Parameters # -->
@first_arg_name:
<!-- ##### FUNCTION gtk_widget_ref ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_unref ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_destroy ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_destroyed ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@widget_pointer:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_set ##### -->
<para>
</para>
@widget:
@first_property_name:
@Varargs:
<!-- # Unused Parameters # -->
@first_arg_name:
<!-- ##### FUNCTION gtk_widget_unparent ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_show ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_show_now ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_hide ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_show_all ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_hide_all ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_map ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_unmap ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_realize ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_unrealize ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_queue_draw ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_queue_resize ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_queue_resize_no_redraw ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_draw ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@area:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_size_request ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@requisition:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_get_child_requisition ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@requisition:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_size_allocate ##### -->
<para>
</para>
@widget:
@allocation:
<!-- ##### FUNCTION gtk_widget_add_accelerator ##### -->
<para>
</para>
@widget:
@accel_signal:
@accel_group:
@accel_key:
@accel_mods:
@accel_flags:
<!-- ##### FUNCTION gtk_widget_remove_accelerator ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@accel_group:
@accel_key:
@accel_mods:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_set_accel_path ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@accel_path:
@accel_group:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_list_accel_closures ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_can_activate_accel ##### -->
<para>
</para>
@widget:
@signal_id:
@Returns:
<!-- ##### FUNCTION gtk_widget_event ##### -->
<para>
</para>
@widget:
@event:
@Returns:
<!-- ##### FUNCTION gtk_widget_activate ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_reparent ##### -->
<para>
</para>
@widget:
@new_parent:
<!-- ##### FUNCTION gtk_widget_intersect ##### -->
<para>
</para>
@widget:
@area:
@intersection:
@Returns:
<!-- ##### FUNCTION gtk_widget_is_focus ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_grab_focus ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_grab_default ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_set_name ##### -->
<para>
</para>
@widget:
@name:
<!-- ##### FUNCTION gtk_widget_get_name ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_set_state ##### -->
<para>
</para>
@widget:
@state:
<!-- ##### FUNCTION gtk_widget_set_sensitive ##### -->
<para>
</para>
@widget:
@sensitive:
<!-- ##### FUNCTION gtk_widget_set_parent ##### -->
<para>
</para>
@widget:
@parent:
<!-- ##### FUNCTION gtk_widget_set_parent_window ##### -->
<para>
</para>
@widget:
@parent_window:
<!-- ##### FUNCTION gtk_widget_get_parent_window ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_set_uposition ##### -->
<para>
</para>
@widget:
@x:
@y:
<!-- ##### FUNCTION gtk_widget_set_usize ##### -->
<para>
</para>
@widget:
@width:
@height:
<!-- ##### FUNCTION gtk_widget_set_events ##### -->
<para>
</para>
@widget:
@events:
<!-- ##### FUNCTION gtk_widget_add_events ##### -->
<para>
</para>
@widget:
@events:
<!-- ##### FUNCTION gtk_widget_set_extension_events ##### -->
<para>
</para>
@widget:
@mode:
<!-- ##### FUNCTION gtk_widget_get_extension_events ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_toplevel ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_ancestor ##### -->
<para>
</para>
@widget:
@widget_type:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_colormap ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_set_colormap ##### -->
<para>
</para>
@widget:
@colormap:
<!-- ##### FUNCTION gtk_widget_get_visual ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_events ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_pointer ##### -->
<para>
</para>
@widget:
@x:
@y:
<!-- ##### FUNCTION gtk_widget_is_ancestor ##### -->
<para>
</para>
@widget:
@ancestor:
@Returns:
<!-- ##### FUNCTION gtk_widget_translate_coordinates ##### -->
<para>
</para>
@src_widget:
@dest_widget:
@src_x:
@src_y:
@dest_x:
@dest_y:
@Returns:
<!-- ##### FUNCTION gtk_widget_hide_on_delete ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_set_style ##### -->
<para>
</para>
@widget:
@style:
<!-- ##### MACRO gtk_widget_set_rc_style ##### -->
<para>
Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
</para>
@widget: a #GtkWidget.
<!-- ##### FUNCTION gtk_widget_ensure_style ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_get_style ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
<!-- ##### MACRO gtk_widget_restore_default_style ##### -->
<para>
Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
</para>
1999-08-16 18:51:52 +00:00
@widget: a #GtkWidget.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_reset_rc_styles ##### -->
<para>
Reset the styles of @widget and all descendents, so when
they are looked up again, they get the correct values
for the currently loaded RC file settings.
</para>
<para>
This function is not useful for applications.
</para>
@widget: a #GtkWidget.
<!-- ##### FUNCTION gtk_widget_push_colormap ##### -->
<para>
</para>
@cmap:
<!-- ##### FUNCTION gtk_widget_pop_colormap ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- ##### FUNCTION gtk_widget_set_default_colormap ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@colormap:
<!-- ##### FUNCTION gtk_widget_get_default_style ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_widget_get_default_colormap ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_widget_get_default_visual ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_widget_set_direction ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@dir:
<!-- ##### ENUM GtkTextDirection ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@GTK_TEXT_DIR_NONE:
@GTK_TEXT_DIR_LTR:
@GTK_TEXT_DIR_RTL:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_get_direction ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_set_default_direction ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@dir:
<!-- ##### FUNCTION gtk_widget_get_default_direction ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_shape_combine_mask ##### -->
<para>
</para>
@widget:
@shape_mask:
@offset_x:
@offset_y:
<!-- ##### FUNCTION gtk_widget_path ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@path_length:
@path:
@path_reversed:
<!-- ##### FUNCTION gtk_widget_class_path ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@path_length:
@path:
@path_reversed:
<!-- ##### FUNCTION gtk_widget_get_composite_name ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_modify_style ##### -->
<para>
</para>
@widget:
@style:
<!-- ##### FUNCTION gtk_widget_get_modifier_style ##### -->
Clip the retrieved image data to the screen, using a server grab to avoid 2001-06-28 Havoc Pennington <hp@pobox.com> * gdk/x11/gdkimage-x11.c (_gdk_x11_get_image): Clip the retrieved image data to the screen, using a server grab to avoid race conditions. * gtk/gtkitemfactory.c (gtk_item_factory_create_item): remove check for NULL return from gtk_image_new_from_stock(), it never returns NULL. (gtk_item_factory_create_item): fix bug where we parsed the stock ID as an inline pixbuf * gtk/gtktext.c (gtk_text_key_press): numeric keypad support * gtk/gtkspinbutton.c (gtk_spin_button_key_press): numeric keypad support (should be using binding set here) * gtk/gtkoptionmenu.c (gtk_option_menu_key_press): numeric keypad support (should be using binding set here) * gtk/gtkmenushell.c (gtk_menu_shell_class_init): numeric keypad support * gtk/gtkmenu.c (gtk_menu_class_init): numeric keypad support * gtk/gtkmenubar.c (gtk_menu_bar_class_init): numeric keypad * gtk/gtklistitem.c (gtk_list_item_class_init): numeric keypad * gtk/gtkimcontextsimple.c (gtk_im_context_simple_filter_keypress): keypad * gtk/gtkfilesel.c (gtk_file_selection_key_press): keypad * gtk/gtkentry.c (gtk_entry_class_init): numeric keypad fixes * gtk/gtkctree.c (gtk_ctree_class_init): numeric keypad support * gtk/gtkcolorsel.c (palette_activate): keypad support (of course, should be binding-setted) * gtk/gtkwindow.c (gtk_window_class_init): numeric keypad fixes * gtk/gtkclist.c (gtk_clist_class_init): numeric keypad fixes * gtk/gtkcalendar.c: numeric keypad fixes * gtk/gtktextview.c (gtk_text_view_class_init): numeric keypad support * gdk/gdkwindow.c (gdk_window_get_clip_region): fix infinite loop screwup * gdk/gdkpixbuf-render.c (gdk_pixbuf_render_to_drawable_alpha): clip the render area to the drawable's clip region in advance, so we don't get data from the server that we don't need. * gdk/gdkpixbuf-render.c (gdk_pixbuf_render_to_drawable_alpha): check return value of gdk_pixbuf_get_from_drawable(), fall back to bilevel alpha if we can't get the pixbuf to composite against. * gdk/gdkdraw.c (gdk_drawable_get_image): set the image colormap * gdk/gdkimage.c (gdk_image_get_colormap): add gdk_image_set_colormap, gdk_image_get_colormap * gdk/gdkpixbuf-drawable.c (rgbconvert): Change all converters to take a region of the image, instead of converting the entire image. * gtk/gtkwidget.h (struct _GtkWidgetClass): add show_help keybinding signal. Add default bindings for it. Add default handler for show_help that shows the tooltip for the widget. * gtk/gtkdialog.c (gtk_dialog_class_init): add binding set and "close" keybinding signal, remove key press handler. * gtk/gtktooltips.c (gtk_tooltips_set_colors): Just remove this, it's not our usual practice to leave a deprecated function around with a runtime warning, plus we don't want it to appear in docs, plus if we make them yellow no one will want to change them anyhow.
2001-06-29 01:59:02 +00:00
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_modify_fg ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@state:
@color:
<!-- ##### FUNCTION gtk_widget_modify_bg ##### -->
<para>
</para>
@widget:
@state:
@color:
<!-- ##### FUNCTION gtk_widget_modify_text ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@state:
@color:
<!-- ##### FUNCTION gtk_widget_modify_base ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@state:
@color:
<!-- ##### FUNCTION gtk_widget_modify_font ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@font_desc:
<!-- ##### FUNCTION gtk_widget_create_pango_context ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_pango_context ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_create_pango_layout ##### -->
<para>
</para>
@widget:
@text:
@Returns:
<!-- ##### FUNCTION gtk_widget_render_icon ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@stock_id:
@size:
@detail:
@Returns:
<!-- ##### FUNCTION gtk_widget_pop_composite_child ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- ##### FUNCTION gtk_widget_push_composite_child ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- ##### FUNCTION gtk_widget_queue_clear ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_queue_clear_area ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@x:
@y:
@width:
@height:
<!-- ##### FUNCTION gtk_widget_queue_draw_area ##### -->
<para>
</para>
@widget:
@x:
@y:
@width:
@height:
<!-- ##### FUNCTION gtk_widget_reset_shapes ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_set_app_paintable ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@app_paintable:
<!-- ##### FUNCTION gtk_widget_set_double_buffered ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@double_buffered:
<!-- ##### FUNCTION gtk_widget_set_redraw_on_allocate ##### -->
2001-03-29 21:17:45 +00:00
<para>
</para>
@widget:
@redraw_on_allocate:
<!-- ##### FUNCTION gtk_widget_set_composite_name ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@name:
<!-- ##### FUNCTION gtk_widget_set_scroll_adjustments ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@hadjustment:
@vadjustment:
@Returns:
<!-- ##### FUNCTION gtk_widget_mnemonic_activate ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@group_cycling:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_class_install_style_property ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@klass:
@pspec:
<!-- # Unused Parameters # -->
@class:
<!-- ##### FUNCTION gtk_widget_class_install_style_property_parser ##### -->
docs/reference/gdk/tmpl/dnd.sgml docs/reference/gdk/tmpl/drawing.sgml Fri Nov 8 20:14:52 2002 Soeren Sandmann <sandmann@daimi.au.dk> * docs/reference/gdk/tmpl/dnd.sgml docs/reference/gdk/tmpl/drawing.sgml docs/reference/gdk/tmpl/gdk-unused.sgml docs/reference/gdk/tmpl/gdkdisplay.sgml docs/reference/gdk/tmpl/general.sgml docs/reference/gdk/tmpl/input_devices.sgml docs/reference/gdk/tmpl/selections.sgml docs/reference/gtk/tmpl/gtkcellrenderer.sgml docs/reference/gtk/tmpl/gtkcurve.sgml docs/reference/gtk/tmpl/gtkdnd.sgml docs/reference/gtk/tmpl/gtkitemfactory.sgml docs/reference/gtk/tmpl/gtkmenu.sgml docs/reference/gtk/tmpl/gtkoldeditable.sgml docs/reference/gtk/tmpl/gtkoptionmenu.sgml docs/reference/gtk/tmpl/gtkpreview.sgml docs/reference/gtk/tmpl/gtkselection.sgml docs/reference/gtk/tmpl/gtksocket.sgml docs/reference/gtk/tmpl/gtkstyle.sgml docs/reference/gtk/tmpl/gtktextbuffer.sgml docs/reference/gtk/tmpl/gtktreemodel.sgml docs/reference/gtk/tmpl/gtkwidget.sgml gdk/gdk.h gdk/gdkdisplay.c gdk/gdkdisplay.h gdk/gdkdnd.h gdk/gdkdraw.c gdk/gdkdrawable.h gdk/gdkinput.h gdk/gdkselection.h gdk/x11/gdkdisplay-x11.c gdk/x11/gdkdnd-x11.c gdk/x11/gdkselection-x11.c gtk/gtkcurve.h gtk/gtkdnd.h gtk/gtkitemfactory.c gtk/gtkitemfactory.h gtk/gtkmenu.h gtk/gtkoldeditable.c gtk/gtkoldeditable.h gtk/gtkoptionmenu.h gtk/gtkplug.c gtk/gtkplug.h gtk/gtkpreview.h gtk/gtkrange.h gtk/gtkselection.c gtk/gtkselection.h gtk/gtksocket.c gtk/gtksocket.h gtk/gtkstyle.c gtk/gtkstyle.h gtk/gtktextlayout.c gtk/gtktextlayout.h gtk/gtktreemodel.c gtk/gtktreemodel.h gtk/gtkwidget.h Trivial s/foo/foo_/ fixes to make gtk.h includable with -Wshadow without warnings. (#91680)
2002-11-08 19:41:50 +00:00
<para>
</para>
@klass:
@pspec:
@parser:
<!-- # Unused Parameters # -->
@class:
<!-- ##### FUNCTION gtk_widget_class_find_style_property ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@klass:
@property_name:
@Returns:
<!-- # Unused Parameters # -->
@class:
<!-- ##### FUNCTION gtk_widget_class_list_style_properties ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@klass:
@n_properties:
@Returns:
<!-- # Unused Parameters # -->
@class:
<!-- ##### FUNCTION gtk_widget_region_intersect ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@region:
@Returns:
<!-- ##### FUNCTION gtk_widget_send_expose ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@event:
@Returns:
<!-- ##### FUNCTION gtk_widget_style_get ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@first_property_name:
@Varargs:
<!-- ##### FUNCTION gtk_widget_style_get_property ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@property_name:
@value:
<!-- ##### FUNCTION gtk_widget_style_get_valist ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@first_property_name:
@var_args:
<!-- ##### FUNCTION gtk_widget_get_accessible ##### -->
Clip the retrieved image data to the screen, using a server grab to avoid 2001-06-28 Havoc Pennington <hp@pobox.com> * gdk/x11/gdkimage-x11.c (_gdk_x11_get_image): Clip the retrieved image data to the screen, using a server grab to avoid race conditions. * gtk/gtkitemfactory.c (gtk_item_factory_create_item): remove check for NULL return from gtk_image_new_from_stock(), it never returns NULL. (gtk_item_factory_create_item): fix bug where we parsed the stock ID as an inline pixbuf * gtk/gtktext.c (gtk_text_key_press): numeric keypad support * gtk/gtkspinbutton.c (gtk_spin_button_key_press): numeric keypad support (should be using binding set here) * gtk/gtkoptionmenu.c (gtk_option_menu_key_press): numeric keypad support (should be using binding set here) * gtk/gtkmenushell.c (gtk_menu_shell_class_init): numeric keypad support * gtk/gtkmenu.c (gtk_menu_class_init): numeric keypad support * gtk/gtkmenubar.c (gtk_menu_bar_class_init): numeric keypad * gtk/gtklistitem.c (gtk_list_item_class_init): numeric keypad * gtk/gtkimcontextsimple.c (gtk_im_context_simple_filter_keypress): keypad * gtk/gtkfilesel.c (gtk_file_selection_key_press): keypad * gtk/gtkentry.c (gtk_entry_class_init): numeric keypad fixes * gtk/gtkctree.c (gtk_ctree_class_init): numeric keypad support * gtk/gtkcolorsel.c (palette_activate): keypad support (of course, should be binding-setted) * gtk/gtkwindow.c (gtk_window_class_init): numeric keypad fixes * gtk/gtkclist.c (gtk_clist_class_init): numeric keypad fixes * gtk/gtkcalendar.c: numeric keypad fixes * gtk/gtktextview.c (gtk_text_view_class_init): numeric keypad support * gdk/gdkwindow.c (gdk_window_get_clip_region): fix infinite loop screwup * gdk/gdkpixbuf-render.c (gdk_pixbuf_render_to_drawable_alpha): clip the render area to the drawable's clip region in advance, so we don't get data from the server that we don't need. * gdk/gdkpixbuf-render.c (gdk_pixbuf_render_to_drawable_alpha): check return value of gdk_pixbuf_get_from_drawable(), fall back to bilevel alpha if we can't get the pixbuf to composite against. * gdk/gdkdraw.c (gdk_drawable_get_image): set the image colormap * gdk/gdkimage.c (gdk_image_get_colormap): add gdk_image_set_colormap, gdk_image_get_colormap * gdk/gdkpixbuf-drawable.c (rgbconvert): Change all converters to take a region of the image, instead of converting the entire image. * gtk/gtkwidget.h (struct _GtkWidgetClass): add show_help keybinding signal. Add default bindings for it. Add default handler for show_help that shows the tooltip for the widget. * gtk/gtkdialog.c (gtk_dialog_class_init): add binding set and "close" keybinding signal, remove key press handler. * gtk/gtktooltips.c (gtk_tooltips_set_colors): Just remove this, it's not our usual practice to leave a deprecated function around with a runtime warning, plus we don't want it to appear in docs, plus if we make them yellow no one will want to change them anyhow.
2001-06-29 01:59:02 +00:00
<para>
</para>
@widget:
@Returns:
Clip the retrieved image data to the screen, using a server grab to avoid 2001-06-28 Havoc Pennington <hp@pobox.com> * gdk/x11/gdkimage-x11.c (_gdk_x11_get_image): Clip the retrieved image data to the screen, using a server grab to avoid race conditions. * gtk/gtkitemfactory.c (gtk_item_factory_create_item): remove check for NULL return from gtk_image_new_from_stock(), it never returns NULL. (gtk_item_factory_create_item): fix bug where we parsed the stock ID as an inline pixbuf * gtk/gtktext.c (gtk_text_key_press): numeric keypad support * gtk/gtkspinbutton.c (gtk_spin_button_key_press): numeric keypad support (should be using binding set here) * gtk/gtkoptionmenu.c (gtk_option_menu_key_press): numeric keypad support (should be using binding set here) * gtk/gtkmenushell.c (gtk_menu_shell_class_init): numeric keypad support * gtk/gtkmenu.c (gtk_menu_class_init): numeric keypad support * gtk/gtkmenubar.c (gtk_menu_bar_class_init): numeric keypad * gtk/gtklistitem.c (gtk_list_item_class_init): numeric keypad * gtk/gtkimcontextsimple.c (gtk_im_context_simple_filter_keypress): keypad * gtk/gtkfilesel.c (gtk_file_selection_key_press): keypad * gtk/gtkentry.c (gtk_entry_class_init): numeric keypad fixes * gtk/gtkctree.c (gtk_ctree_class_init): numeric keypad support * gtk/gtkcolorsel.c (palette_activate): keypad support (of course, should be binding-setted) * gtk/gtkwindow.c (gtk_window_class_init): numeric keypad fixes * gtk/gtkclist.c (gtk_clist_class_init): numeric keypad fixes * gtk/gtkcalendar.c: numeric keypad fixes * gtk/gtktextview.c (gtk_text_view_class_init): numeric keypad support * gdk/gdkwindow.c (gdk_window_get_clip_region): fix infinite loop screwup * gdk/gdkpixbuf-render.c (gdk_pixbuf_render_to_drawable_alpha): clip the render area to the drawable's clip region in advance, so we don't get data from the server that we don't need. * gdk/gdkpixbuf-render.c (gdk_pixbuf_render_to_drawable_alpha): check return value of gdk_pixbuf_get_from_drawable(), fall back to bilevel alpha if we can't get the pixbuf to composite against. * gdk/gdkdraw.c (gdk_drawable_get_image): set the image colormap * gdk/gdkimage.c (gdk_image_get_colormap): add gdk_image_set_colormap, gdk_image_get_colormap * gdk/gdkpixbuf-drawable.c (rgbconvert): Change all converters to take a region of the image, instead of converting the entire image. * gtk/gtkwidget.h (struct _GtkWidgetClass): add show_help keybinding signal. Add default bindings for it. Add default handler for show_help that shows the tooltip for the widget. * gtk/gtkdialog.c (gtk_dialog_class_init): add binding set and "close" keybinding signal, remove key press handler. * gtk/gtktooltips.c (gtk_tooltips_set_colors): Just remove this, it's not our usual practice to leave a deprecated function around with a runtime warning, plus we don't want it to appear in docs, plus if we make them yellow no one will want to change them anyhow.
2001-06-29 01:59:02 +00:00
<!-- ##### FUNCTION gtk_widget_child_focus ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@direction:
@Returns:
<!-- ##### FUNCTION gtk_widget_child_notify ##### -->
<para>
</para>
@widget:
@child_property:
<!-- ##### FUNCTION gtk_widget_freeze_child_notify ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_get_child_visible ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_parent ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_settings ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_clipboard ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@selection:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_display ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_root_window ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_screen ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@widget:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_has_screen ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_get_size_request ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@widget:
@width:
@height:
<!-- ##### MACRO gtk_widget_pop_visual ##### -->
<para>
This function is deprecated; it does nothing.
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO gtk_widget_push_visual ##### -->
<para>
This function is deprecated; it does nothing.
</para>
1999-08-16 18:51:52 +00:00
@visual:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_widget_set_child_visible ##### -->
<para>
</para>
1999-08-16 18:51:52 +00:00
@widget:
@is_visible:
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO gtk_widget_set_default_visual ##### -->
<para>
This function is deprecated; it does nothing.
</para>
@visual:
<!-- ##### FUNCTION gtk_widget_set_size_request ##### -->
<para>
</para>
@widget:
@width:
@height:
<!-- ##### MACRO gtk_widget_set_visual ##### -->
<para>
This function is deprecated; it does nothing.
</para>
@widget:
@visual:
<!-- ##### FUNCTION gtk_widget_thaw_child_notify ##### -->
<para>
</para>
@widget:
<!-- ##### FUNCTION gtk_widget_set_no_show_all ##### -->
<para>
</para>
@widget:
@no_show_all:
<!-- ##### FUNCTION gtk_widget_get_no_show_all ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_list_mnemonic_labels ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_widget_add_mnemonic_label ##### -->
<para>
</para>
@widget:
@label:
<!-- ##### FUNCTION gtk_widget_remove_mnemonic_label ##### -->
<para>
</para>
@widget:
@label:
<!-- ##### FUNCTION gtk_requisition_copy ##### -->
<para>
</para>
@requisition:
@Returns:
<!-- ##### FUNCTION gtk_requisition_free ##### -->
<para>
</para>
@requisition: