| Top |
| gfloat | cursor-aspect-ratio | Read |
| GdkColor * | cursor-color | Read |
| gchar * | focus-line-pattern | Read |
| gint | focus-line-width | Read |
| gint | focus-padding | Read |
| gboolean | interior-focus | Read |
| GdkColor * | link-color | Read |
| gint | scroll-arrow-hlength | Read |
| gint | scroll-arrow-vlength | Read |
| GdkColor * | secondary-cursor-color | Read |
| gint | separator-height | Read |
| gint | separator-width | Read |
| gint | text-handle-height | Read |
| gint | text-handle-width | Read |
| GdkColor * | visited-link-color | Read |
| gboolean | wide-separators | Read |
| gboolean | window-dragging | Read |
| GtkWidget | |
| struct | GtkWidgetClass |
| GtkRequisition | |
| typedef | GtkAllocation |
| enum | GtkWidgetHelpType |
| enum | GtkTextDirection |
| enum | GtkStateType |
| enum | GtkSizeRequestMode |
| struct | GtkRequestedSize |
| enum | GtkAlign |
GBoxed ╰── GtkRequisition GObject ╰── GInitiallyUnowned ╰── GtkWidget ├── GtkContainer ├── GtkMisc ├── GtkCalendar ├── GtkCellView ├── GtkDrawingArea ├── GtkEntry ├── GtkGLArea ├── GtkRange ├── GtkSeparator ├── GtkHSV ├── GtkInvisible ├── GtkProgressBar ├── GtkSpinner ├── GtkSwitch ╰── GtkLevelBar
GtkWidget is required by GtkActionable, GtkAppChooser, GtkCellEditable and GtkToolShell.
GtkWidget is the base class all widgets in GTK+ derive from. It manages the widget lifecycle, states and style.
GTK+ uses a height-for-width (and width-for-height) geometry management system. Height-for-width means that a widget can change how much vertical space it needs, depending on the amount of horizontal space that it is given (and similar for width-for-height). The most common example is a label that reflows to fill up the available width, wraps to fewer lines, and therefore needs less height.
Height-for-width geometry management is implemented in GTK+ by way of five virtual methods:
There are some important things to keep in mind when implementing height-for-width and when using it in container implementations.
The geometry management system will query a widget hierarchy in only one orientation at a time. When widgets are initially queried for their minimum sizes it is generally done in two initial passes in the GtkSizeRequestMode chosen by the toplevel.
For example, when queried in the normal
GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH
mode:
First, the default minimum and natural width for each widget
in the interface will be computed using gtk_widget_get_preferred_width()
.
Because the preferred widths for each container depend on the preferred
widths of their children, this information propagates up the hierarchy,
and finally a minimum and natural width is determined for the entire
toplevel. Next, the toplevel will use the minimum width to query for the
minimum height contextual to that width using
gtk_widget_get_preferred_height_for_width()
, which will also be a highly
recursive operation. The minimum height for the minimum width is normally
used to set the minimum size constraint on the toplevel
(unless gtk_window_set_geometry_hints()
is explicitly used instead).
After the toplevel window has initially requested its size in both
dimensions it can go on to allocate itself a reasonable size (or a size
previously specified with gtk_window_set_default_size()
). During the
recursive allocation process it’s important to note that request cycles
will be recursively executed while container widgets allocate their children.
Each container widget, once allocated a size, will go on to first share the
space in one orientation among its children and then request each child's
height for its target allocated width or its width for allocated height,
depending. In this way a GtkWidget will typically be requested its size
a number of times before actually being allocated a size. The size a
widget is finally allocated can of course differ from the size it has
requested. For this reason, GtkWidget caches a small number of results
to avoid re-querying for the same sizes in one allocation cycle.
See GtkContainer’s geometry management section to learn more about how height-for-width allocations are performed by container widgets.
If a widget does move content around to intelligently use up the allocated size then it must support the request in both GtkSizeRequestModes even if the widget in question only trades sizes in a single orientation.
For instance, a GtkLabel that does height-for-width word wrapping
will not expect to have GtkWidgetClass.get_preferred_height()
called
because that call is specific to a width-for-height request. In this
case the label must return the height required for its own minimum
possible width. By following this rule any widget that handles
height-for-width or width-for-height requests will always be allocated
at least enough space to fit its own content.
Here are some examples of how a GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH
widget
generally deals with width-for-height requests, for GtkWidgetClass.get_preferred_height()
it will do:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
static void foo_widget_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height) { if (i_am_in_height_for_width_mode) { gint min_width, nat_width; GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, &nat_width); GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width, min_height, nat_height); } else { ... some widgets do both. For instance, if a GtkLabel is rotated to 90 degrees it will return the minimum and natural height for the rotated label here. } } |
And in GtkWidgetClass.get_preferred_width_for_height()
it will simply return
the minimum and natural width:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
static void foo_widget_get_preferred_width_for_height (GtkWidget *widget, gint for_height, gint *min_width, gint *nat_width) { if (i_am_in_height_for_width_mode) { GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width); } else { ... again if a widget is sometimes operating in width-for-height mode (like a rotated GtkLabel) it can go ahead and do its real width for height calculation here. } } |
Often a widget needs to get its own request during size request or allocation. For example, when computing height it may need to also compute width. Or when deciding how to use an allocation, the widget may need to know its natural size. In these cases, the widget should be careful to call its virtual methods directly, like this:
1 2 3 |
GTK_WIDGET_GET_CLASS(widget)->get_preferred_width (widget, &min, &natural); |
It will not work to use the wrapper functions, such as
gtk_widget_get_preferred_width()
inside your own size request
implementation. These return a request adjusted by GtkSizeGroup
and by the GtkWidgetClass.adjust_size_request()
virtual method. If a
widget used the wrappers inside its virtual method implementations,
then the adjustments (such as widget margins) would be applied
twice. GTK+ therefore does not allow this and will warn if you try
to do it.
Of course if you are getting the size request for another widget, such as a child of a container, you must use the wrapper APIs. Otherwise, you would not properly consider widget margins, GtkSizeGroup, and so forth.
Since 3.10 GTK+ also supports baseline vertical alignment of widgets. This
means that widgets are positioned such that the typographical baseline of
widgets in the same row are aligned. This happens if a widget supports baselines,
has a vertical alignment of GTK_ALIGN_BASELINE
, and is inside a container
that supports baselines and has a natural “row” that it aligns to the baseline,
or a baseline assigned to it by the grandparent.
Baseline alignment support for a widget is done by the GtkWidgetClass.get_preferred_height_and_baseline_for_width()
virtual function. It allows you to report a baseline in combination with the
minimum and natural height. If there is no baseline you can return -1 to indicate
this. The default implementation of this virtual function calls into the
GtkWidgetClass.get_preferred_height()
and GtkWidgetClass.get_preferred_height_for_width()
,
so if baselines are not supported it doesn’t need to be implemented.
If a widget ends up baseline aligned it will be allocated all the space in the parent
as if it was GTK_ALIGN_FILL
, but the selected baseline can be found via gtk_widget_get_allocated_baseline()
.
If this has a value other than -1 you need to align the widget such that the baseline
appears at the position.
GtkWidget introduces “style properties” - 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 resource files. 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.
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.
The GtkWidget implementation of the GtkBuildable interface supports a custom <accelerator> element, which has attributes named ”key”, ”modifiers” and ”signal” and allows to specify accelerators.
An example of a UI definition fragment specifying an accelerator:
1 2 3 |
<object class="GtkButton"> <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/> </object> |
In addition to accelerators, GtkWidget also support a custom <accessible> element, which supports actions and relations. Properties on the accessible implementation of an object can be set by accessing the internal child “accessible” of a GtkWidget.
An example of a UI definition fragment specifying an accessible:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
<object class="GtkButton" id="label1"/> <property name="label">I am a Label for a Button</property> </object> <object class="GtkButton" id="button1"> <accessibility> <action action_name="click" translatable="yes">Click the button.</action> <relation target="label1" type="labelled-by"/> </accessibility> <child internal-child="accessible"> <object class="AtkObject" id="a11y-button1"> <property name="accessible-name">Clickable Button</property> </object> </child> </object> |
Finally, GtkWidget allows style information such as style classes to be associated with widgets, using the custom <style> element:
1 2 3 4 5 6 |
<object class="GtkButton" id="button1"> <style> <class name="my-special-button-class"/> <class name="dark-button"/> </style> </object> |
GtkWidget exposes some facilities to automate the procedure of creating composite widgets using GtkBuilder interface description language.
To create composite widgets with GtkBuilder XML, one must associate
the interface description with the widget class at class initialization
time using gtk_widget_class_set_template()
.
The interface description semantics expected in composite template descriptions is slightly different from regular GtkBuilder XML.
Unlike regular interface descriptions, gtk_widget_class_set_template()
will
expect a <template> tag as a direct child of the toplevel <interface>
tag. The <template> tag must specify the “class” attribute which must be
the type name of the widget. Optionally, the “parent” attribute may be
specified to specify the direct parent type of the widget type, this is
ignored by the GtkBuilder but required for Glade to introspect what kind
of properties and internal children exist for a given type when the actual
type does not exist.
The XML which is contained inside the <template> tag behaves as if it were
added to the <object> tag defining widget
itself. You may set properties
on widget
by inserting <property> tags into the <template> tag, and also
add <child> tags to add children and extend widget
in the normal way you
would with <object> tags.
Additionally, <object> tags can also be added before and after the initial <template> tag in the normal way, allowing one to define auxiliary objects which might be referenced by other widgets declared as children of the <template> tag.
An example of a GtkBuilder Template Definition:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
<interface> <template class="FooWidget" parent="GtkBox"> <property name="orientation">GTK_ORIENTATION_HORIZONTAL</property> <property name="spacing">4</property> <child> <object class="GtkButton" id="hello_button"> <property name="label">Hello World</property> <signal name="clicked" handler="hello_button_clicked" object="FooWidget" swapped="yes"/> </object> </child> <child> <object class="GtkButton" id="goodbye_button"> <property name="label">Goodbye World</property> </object> </child> </template> </interface> |
Typically, you'll place the template fragment into a file that is
bundled with your project, using GResource. In order to load the
template, you need to call gtk_widget_class_set_template_from_resource()
from the class initialization of your GtkWidget type:
1 2 3 4 5 6 7 8 |
static void foo_widget_class_init (FooWidgetClass *klass) { // ... gtk_widget_class_set_template_from_resource (GTK_WIDGET_CLASS (klass), "/com/example/ui/foowidget.ui"); } |
You will also need to call gtk_widget_init_template()
from the instance
initialization function:
1 2 3 4 5 6 |
static void foo_widget_init (FooWidget *self) { // ... gtk_widget_init_template (GTK_WIDGET (self)); } |
You can access widgets defined in the template using the
gtk_widget_get_template_child()
function, but you will typically declare
a pointer in the instance private data structure of your type using the same
name as the widget in the template definition, and call
gtk_widget_class_bind_template_child_private()
with that name, e.g.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
typedef struct { GtkWidget *hello_button; GtkWidget *goodbye_button; } FooWidgetPrivate; G_DEFINE_TYPE_WITH_PRIVATE (FooWidget, foo_widget, GTK_TYPE_BOX) static void foo_widget_class_init (FooWidgetClass *klass) { // ... gtk_widget_class_set_template_from_resource (GTK_WIDGET_CLASS (klass), "/com/example/ui/foowidget.ui"); gtk_widget_class_bind_template_child_private (GTK_WIDGET_CLASS (klass), FooWidget, hello_button); gtk_widget_class_bind_template_child_private (GTK_WIDGET_CLASS (klass), FooWidget, goodbye_button); } |
You can also use gtk_widget_class_bind_template_callback()
to connect a signal
callback defined in the template with a function visible in the scope of the
class, e.g.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
// the signal handler has the instance and user data swapped // because of the swapped="yes" attribute in the template XML static void hello_button_clicked (FooWidget *self, GtkButton *button) { g_print ("Hello, world!\n"); } static void foo_widget_class_init (FooWidgetClass *klass) { // ... gtk_widget_class_set_template_from_resource (GTK_WIDGET_CLASS (klass), "/com/example/ui/foowidget.ui"); gtk_widget_class_bind_template_callback (GTK_WIDGET_CLASS (klass), hello_button_clicked); } |
void (*GtkCallback) (GtkWidget *widget
,gpointer data
);
The type of the callback functions used for e.g. iterating over
the children of a container, see gtk_container_foreach()
.
GtkWidget * gtk_widget_new (GType type
,const gchar *first_property_name
,...
);
This is a convenience function for creating a widget and setting
its properties in one go. For example you might write:
gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
0.0, NULL)
to create a left-aligned label. Equivalent to
g_object_new()
, but returns a widget so you don’t have to
cast the object yourself.
type |
type ID of the widget to create |
|
first_property_name |
name of first property to set |
|
... |
value of first property, followed by more properties,
|
void
gtk_widget_destroy (GtkWidget *widget
);
Destroys a widget.
When a widget is destroyed all references it holds on other objects will be released:
if the widget is inside a container, it will be removed from its parent
if the widget is a container, all its children will be destroyed, recursively
if the widget is a top level, it will be removed from the list of top level widgets that GTK+ maintains internally
It's expected that all references held on the widget will also
be released; you should connect to the “destroy” signal
if you hold a reference to widget
and you wish to remove it when
this function is called. It is not necessary to do so if you are
implementing a GtkContainer, as you'll be able to use the
GtkContainerClass.remove()
virtual function for that.
It's important to notice that gtk_widget_destroy()
will only cause
the widget
to be finalized if no additional references, acquired
using g_object_ref()
, are held on it. In case additional references
are in place, the widget
will be in an "inert" state after calling
this function; widget
will still point to valid memory, allowing you
to release the references you hold, but you may not query the widget's
own state.
You should typically call this function on top level widgets, and rarely on child widgets.
See also: gtk_container_remove()
gboolean
gtk_widget_in_destruction (GtkWidget *widget
);
Returns whether the widget is currently being destroyed. This information can sometimes be used to avoid doing unnecessary work.
void gtk_widget_destroyed (GtkWidget *widget
,GtkWidget **widget_pointer
);
This function sets *widget_pointer
to NULL
if widget_pointer
!=
NULL
. It’s intended to be used as a callback connected to the
“destroy” signal of a widget. You connect gtk_widget_destroyed()
as a signal handler, and pass the address of your widget variable
as user data. Then when the widget is destroyed, the variable will
be set to NULL
. Useful for example to avoid multiple copies
of the same dialog.
void
gtk_widget_unparent (GtkWidget *widget
);
This function is only for use in widget implementations. Should be called by implementations of the remove method on GtkContainer, to dissociate a child from the container.
void
gtk_widget_show (GtkWidget *widget
);
Flags a widget to be displayed. Any widget that isn’t shown will
not appear on the screen. If you want to show all the widgets in a
container, it’s easier to call gtk_widget_show_all()
on the
container, instead of individually showing the widgets.
Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen.
When a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped.
void
gtk_widget_show_now (GtkWidget *widget
);
Shows a widget. If the widget is an unmapped toplevel widget (i.e. a GtkWindow that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during this function.
void
gtk_widget_hide (GtkWidget *widget
);
Reverses the effects of gtk_widget_show()
, causing the widget to be
hidden (invisible to the user).
void
gtk_widget_show_all (GtkWidget *widget
);
Recursively shows a widget, and any child widgets (if the widget is a container).
void
gtk_widget_map (GtkWidget *widget
);
This function is only for use in widget implementations. Causes a widget to be mapped if it isn’t already.
void
gtk_widget_unmap (GtkWidget *widget
);
This function is only for use in widget implementations. Causes a widget to be unmapped if it’s currently mapped.
void
gtk_widget_realize (GtkWidget *widget
);
Creates the GDK (windowing system) resources associated with a
widget. For example, widget->window
will be created when a widget
is realized. Normally realization happens implicitly; if you show
a widget and all its parent containers, then the widget will be
realized and mapped automatically.
Realizing a widget requires all
the widget’s parent widgets to be realized; calling
gtk_widget_realize()
realizes the widget’s parents in addition to
widget
itself. If a widget is not yet inside a toplevel window
when you realize it, bad things will happen.
This function is primarily used in widget implementations, and
isn’t very useful otherwise. Many times when you think you might
need it, a better approach is to connect to a signal that will be
called after the widget is realized automatically, such as
“draw”. Or simply g_signal_connect()
to the
“realize” signal.
void
gtk_widget_unrealize (GtkWidget *widget
);
This function is only useful in widget implementations.
Causes a widget to be unrealized (frees all GDK resources
associated with the widget, such as widget->window
).
void gtk_widget_draw (GtkWidget *widget
,cairo_t *cr
);
Draws widget
to cr
. The top left corner of the widget will be
drawn to the currently set origin point of cr
.
You should pass a cairo context as cr
argument that is in an
original state. Otherwise the resulting drawing is undefined. For
example changing the operator using cairo_set_operator()
or the
line width using cairo_set_line_width()
might have unwanted side
effects.
You may however change the context’s transform matrix - like with
cairo_scale()
, cairo_translate()
or cairo_set_matrix()
and clip
region with cairo_clip()
prior to calling this function. Also, it
is fine to modify the context with cairo_save()
and
cairo_push_group()
prior to calling this function.
Note that special-purpose widgets may contain special code for
rendering to the screen and might appear differently on screen
and when rendered using gtk_widget_draw()
.
widget |
the widget to draw. It must be drawable (see
|
|
cr |
a cairo context to draw to |
Since: 3.0
void
gtk_widget_queue_draw (GtkWidget *widget
);
Equivalent to calling gtk_widget_queue_draw_area()
for the
entire area of a widget.
void
gtk_widget_queue_resize (GtkWidget *widget
);
This function is only for use in widget implementations. Flags a widget to have its size renegotiated; should be called when a widget for some reason has a new size request. For example, when you change the text in a GtkLabel, GtkLabel queues a resize to ensure there’s enough space for the new text.
Note that you cannot call gtk_widget_queue_resize()
on a widget
from inside its implementation of the GtkWidgetClass::size_allocate
virtual method. Calls to gtk_widget_queue_resize()
from inside
GtkWidgetClass::size_allocate will be silently ignored.
void
gtk_widget_queue_resize_no_redraw (GtkWidget *widget
);
This function works like gtk_widget_queue_resize()
,
except that the widget is not invalidated.
Since: 2.4
void
gtk_widget_queue_allocate (GtkWidget *widget
);
This function is only for use in widget implementations.
Flags the widget for a rerun of the GtkWidgetClass::size_allocate
function. Use this function instead of gtk_widget_queue_resize()
when the widget
's size request didn't change but it wants to
reposition its contents.
An example user of this function is gtk_widget_set_halign()
.
Since: 3.20
GdkFrameClock *
gtk_widget_get_frame_clock (GtkWidget *widget
);
Obtains the frame clock for a widget. The frame clock is a global
“ticker” that can be used to drive animations and repaints. The
most common reason to get the frame clock is to call
gdk_frame_clock_get_frame_time()
, in order to get a time to use for
animating. For example you might record the start of the animation
with an initial value from gdk_frame_clock_get_frame_time()
, and
then update the animation by calling
gdk_frame_clock_get_frame_time()
again during each repaint.
gdk_frame_clock_request_phase() will result in a new frame on the
clock, but won’t necessarily repaint any widgets. To repaint a
widget, you have to use gtk_widget_queue_draw()
which invalidates
the widget (thus scheduling it to receive a draw on the next
frame). gtk_widget_queue_draw()
will also end up requesting a frame
on the appropriate frame clock.
A widget’s frame clock will not change while the widget is mapped. Reparenting a widget (which implies a temporary unmap) can change the widget’s frame clock.
Unrealized widgets do not have a frame clock.
Since: 3.8
gint
gtk_widget_get_scale_factor (GtkWidget *widget
);
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. On traditional systems this is 1, on high density outputs, it can be a higher value (typically 2).
See gdk_window_get_scale_factor()
.
Since: 3.10
gboolean (*GtkTickCallback) (GtkWidget *widget
,GdkFrameClock *frame_clock
,gpointer user_data
);
Callback type for adding a function to update animations. See gtk_widget_add_tick_callback()
.
widget |
the widget |
|
frame_clock |
the frame clock for the widget (same as calling |
|
user_data |
user data passed to |
G_SOURCE_CONTINUE
if the tick callback should continue to be called,
G_SOURCE_REMOVE
if the tick callback should be removed.
Since: 3.8
guint gtk_widget_add_tick_callback (GtkWidget *widget
,GtkTickCallback callback
,gpointer user_data
,GDestroyNotify notify
);
Queues an animation frame update and adds a callback to be called
before each frame. Until the tick callback is removed, it will be
called frequently (usually at the frame rate of the output device
or as quickly as the application can be repainted, whichever is
slower). For this reason, is most suitable for handling graphics
that change every frame or every few frames. The tick callback does
not automatically imply a relayout or repaint. If you want a
repaint or relayout, and aren’t changing widget properties that
would trigger that (for example, changing the text of a GtkLabel),
then you will have to call gtk_widget_queue_resize()
or
gtk_widget_queue_draw_area()
yourself.
gdk_frame_clock_get_frame_time() should generally be used for timing
continuous animations and
gdk_frame_timings_get_predicted_presentation_time()
if you are
trying to display isolated frames at particular times.
This is a more convenient alternative to connecting directly to the “update” signal of GdkFrameClock, since you don't have to worry about when a GdkFrameClock is assigned to a widget.
widget |
||
callback |
function to call for updating animations |
|
user_data |
data to pass to |
|
notify |
function to call to free |
an id for the connection of this callback. Remove the callback
by passing it to gtk_widget_remove_tick_callback()
Since: 3.8
void gtk_widget_remove_tick_callback (GtkWidget *widget
,guint id
);
Removes a tick callback previously registered with
gtk_widget_add_tick_callback()
.
Since: 3.8
void gtk_widget_size_request (GtkWidget *widget
,GtkRequisition *requisition
);
gtk_widget_size_request
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_get_preferred_size()
instead.
This function is typically used when implementing a GtkContainer
subclass. Obtains the preferred size of a widget. The container
uses this information to arrange its child widgets and decide what
size allocations to give them with gtk_widget_size_allocate()
.
You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind.
Also remember that the size request is not necessarily the size a widget will actually be allocated.
void gtk_widget_get_child_requisition (GtkWidget *widget
,GtkRequisition *requisition
);
gtk_widget_get_child_requisition
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_get_preferred_size()
instead.
This function is only for use in widget implementations. Obtains
widget->requisition
, unless someone has forced a particular
geometry on the widget (e.g. with gtk_widget_set_size_request()
),
in which case it returns that geometry instead of the widget's
requisition.
This function differs from gtk_widget_size_request()
in that
it retrieves the last size request value from widget->requisition
,
while gtk_widget_size_request()
actually calls the "size_request" method
on widget
to compute the size request and fill in widget->requisition
,
and only then returns widget->requisition
.
Because this function does not call the “size_request” method, it
can only be used when you know that widget->requisition
is
up-to-date, that is, gtk_widget_size_request()
has been called
since the last time a resize was queued. In general, only container
implementations have this information; applications should use
gtk_widget_size_request()
.
void gtk_widget_size_allocate (GtkWidget *widget
,GtkAllocation *allocation
);
This function is only used by GtkContainer subclasses, to assign a size and position to their child widgets.
In this function, the allocation may be adjusted. It will be forced to a 1x1 minimum size, and the adjust_size_allocation virtual method on the child will be used to adjust the allocation. Standard adjustments include removing the widget’s margins, and applying the widget’s “halign” and “valign” properties.
For baseline support in containers you need to use gtk_widget_size_allocate_with_baseline()
instead.
void gtk_widget_size_allocate_with_baseline (GtkWidget *widget
,GtkAllocation *allocation
,gint baseline
);
This function is only used by GtkContainer subclasses, to assign a size, position and (optionally) baseline to their child widgets.
In this function, the allocation and baseline may be adjusted. It will be forced to a 1x1 minimum size, and the adjust_size_allocation virtual and adjust_baseline_allocation methods on the child will be used to adjust the allocation and baseline. Standard adjustments include removing the widget's margins, and applying the widget’s “halign” and “valign” properties.
If the child widget does not have a valign of GTK_ALIGN_BASELINE
the
baseline argument is ignored and -1 is used instead.
widget |
||
allocation |
position and size to be allocated to |
|
baseline |
The baseline of the child, or -1 |
Since: 3.10
void gtk_widget_add_accelerator (GtkWidget *widget
,const gchar *accel_signal
,GtkAccelGroup *accel_group
,guint accel_key
,GdkModifierType accel_mods
,GtkAccelFlags accel_flags
);
Installs an accelerator for this widget
in accel_group
that causes
accel_signal
to be emitted if the accelerator is activated.
The accel_group
needs to be added to the widget’s toplevel via
gtk_window_add_accel_group()
, and the signal must be of type G_SIGNAL_ACTION
.
Accelerators added through this function are not user changeable during
runtime. If you want to support accelerators that can be changed by the
user, use gtk_accel_map_add_entry()
and gtk_widget_set_accel_path()
or
gtk_menu_item_set_accel_path()
instead.
widget |
widget to install an accelerator on |
|
accel_signal |
widget signal to emit on accelerator activation |
|
accel_group |
accel group for this widget, added to its toplevel |
|
accel_key |
GDK keyval of the accelerator |
|
accel_mods |
modifier key combination of the accelerator |
|
accel_flags |
flag accelerators, e.g. |
gboolean gtk_widget_remove_accelerator (GtkWidget *widget
,GtkAccelGroup *accel_group
,guint accel_key
,GdkModifierType accel_mods
);
Removes an accelerator from widget
, previously installed with
gtk_widget_add_accelerator()
.
void gtk_widget_set_accel_path (GtkWidget *widget
,const gchar *accel_path
,GtkAccelGroup *accel_group
);
Given an accelerator group, accel_group
, and an accelerator path,
accel_path
, sets up an accelerator in accel_group
so whenever the
key binding that is defined for accel_path
is pressed, widget
will be activated. This removes any accelerators (for any
accelerator group) installed by previous calls to
gtk_widget_set_accel_path()
. Associating accelerators with
paths allows them to be modified by the user and the modifications
to be saved for future use. (See gtk_accel_map_save()
.)
This function is a low level function that would most likely be used by a menu creation system like GtkUIManager. If you use GtkUIManager, setting up accelerator paths will be done automatically.
Even when you you aren’t using GtkUIManager, if you only want to
set up accelerators on menu items gtk_menu_item_set_accel_path()
provides a somewhat more convenient interface.
Note that accel_path
string will be stored in a GQuark. Therefore, if you
pass a static string, you can save some memory by interning it first with
g_intern_static_string()
.
GList *
gtk_widget_list_accel_closures (GtkWidget *widget
);
Lists the closures used by widget
for accelerator group connections
with gtk_accel_group_connect_by_path()
or gtk_accel_group_connect()
.
The closures can be used to monitor accelerator changes on widget
,
by connecting to the GtkAccelGroup
::accel-changed signal of the
GtkAccelGroup of a closure which can be found out with
gtk_accel_group_from_accel_closure()
.
gboolean gtk_widget_can_activate_accel (GtkWidget *widget
,guint signal_id
);
Determines whether an accelerator that activates the signal
identified by signal_id
can currently be activated.
This is done by emitting the “can-activate-accel”
signal on widget
; if the signal isn’t overridden by a
handler or in a derived widget, then the default check is
that the widget must be sensitive, and the widget and all
its ancestors mapped.
Since: 2.4
gboolean gtk_widget_event (GtkWidget *widget
,GdkEvent *event
);
Rarely-used function. This function is used to emit
the event signals on a widget (those signals should never
be emitted without using this function to do so).
If you want to synthesize an event though, don’t use this function;
instead, use gtk_main_do_event()
so the event will behave as if
it were in the event queue. Don’t synthesize expose events; instead,
use gdk_window_invalidate_rect()
to invalidate a region of the
window.
gboolean
gtk_widget_activate (GtkWidget *widget
);
For widgets that can be “activated” (buttons, menu items, etc.)
this function activates them. Activation is what happens when you
press Enter on a widget during key navigation. If widget
isn't
activatable, the function returns FALSE
.
void gtk_widget_reparent (GtkWidget *widget
,GtkWidget *new_parent
);
gtk_widget_reparent
has been deprecated since version 3.14 and should not be used in newly-written code.
Moves a widget from one GtkContainer to another, handling reference count issues to avoid destroying the widget.
gboolean gtk_widget_intersect (GtkWidget *widget
,const GdkRectangle *area
,GdkRectangle *intersection
);
Computes the intersection of a widget
’s area and area
, storing
the intersection in intersection
, and returns TRUE
if there was
an intersection. intersection
may be NULL
if you’re only
interested in whether there was an intersection.
gboolean
gtk_widget_is_focus (GtkWidget *widget
);
Determines if the widget is the focus widget within its toplevel. (This does not mean that the “has-focus” property is necessarily set; “has-focus” will only be set if the toplevel widget additionally has the global input focus.)
void
gtk_widget_grab_focus (GtkWidget *widget
);
Causes widget
to have the keyboard focus for the GtkWindow it's
inside. widget
must be a focusable widget, such as a GtkEntry;
something like GtkFrame won’t work.
More precisely, it must have the GTK_CAN_FOCUS
flag set. Use
gtk_widget_set_can_focus()
to modify that flag.
The widget also needs to be realized and mapped. This is indicated by the related signals. Grabbing the focus immediately after creating the widget will likely fail and cause critical warnings.
void
gtk_widget_grab_default (GtkWidget *widget
);
Causes widget
to become the default widget. widget
must be able to be
a default widget; typically you would ensure this yourself
by calling gtk_widget_set_can_default()
with a TRUE
value.
The default widget is activated when
the user presses Enter in a window. Default widgets must be
activatable, that is, gtk_widget_activate()
should affect them. Note
that GtkEntry widgets require the “activates-default” property
set to TRUE
before they activate the default widget when Enter
is pressed and the GtkEntry is focused.
void gtk_widget_set_name (GtkWidget *widget
,const gchar *name
);
Widgets can be named, which allows you to refer to them from a CSS file. You can apply a style to widgets with a particular name in the CSS file. See the documentation for the CSS syntax (on the same page as the docs for GtkStyleContext).
Note that the CSS syntax has certain special characters to delimit and represent elements in a selector (period, #, >, *...), so using these will make your widget impossible to match by name. Any combination of alphanumeric symbols, dashes and underscores will suffice.
const gchar *
gtk_widget_get_name (GtkWidget *widget
);
Retrieves the name of a widget. See gtk_widget_set_name()
for the
significance of widget names.
void gtk_widget_set_state (GtkWidget *widget
,GtkStateType state
);
gtk_widget_set_state
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_set_state_flags()
instead.
This function is for use in widget implementations. Sets the state
of a widget (insensitive, prelighted, etc.) Usually you should set
the state using wrapper functions such as gtk_widget_set_sensitive()
.
void gtk_widget_set_sensitive (GtkWidget *widget
,gboolean sensitive
);
Sets the sensitivity of a widget. A widget is sensitive if the user can interact with it. Insensitive widgets are “grayed out” and the user can’t interact with them. Insensitive widgets are known as “inactive”, “disabled”, or “ghosted” in some other toolkits.
void gtk_widget_set_parent (GtkWidget *widget
,GtkWidget *parent
);
This function is useful only when implementing subclasses of
GtkContainer.
Sets the container as the parent of widget
, and takes care of
some details such as updating the state and style of the child
to reflect its new location. The opposite function is
gtk_widget_unparent()
.
void gtk_widget_set_parent_window (GtkWidget *widget
,GdkWindow *parent_window
);
Sets a non default parent window for widget
.
For GtkWindow classes, setting a parent_window
effects whether
the window is a toplevel window or can be embedded into other
widgets.
For GtkWindow classes, this needs to be called before the window is realized.
GdkWindow *
gtk_widget_get_parent_window (GtkWidget *widget
);
Gets widget
’s parent window.
void gtk_widget_set_events (GtkWidget *widget
,gint events
);
Sets the event mask (see GdkEventMask) for a widget. The event
mask determines which events a widget will receive. Keep in mind
that different widgets have different default event masks, and by
changing the event mask you may disrupt a widget’s functionality,
so be careful. This function must be called while a widget is
unrealized. Consider gtk_widget_add_events()
for widgets that are
already realized, or if you want to preserve the existing event
mask. This function can’t be used with widgets that have no window.
(See gtk_widget_get_has_window()
). To get events on those widgets,
place them inside a GtkEventBox and receive events on the event
box.
gint
gtk_widget_get_events (GtkWidget *widget
);
Returns the event mask (see GdkEventMask) for the widget. These are the events that the widget will receive.
Note: Internally, the widget event mask will be the logical OR of the event
mask set through gtk_widget_set_events()
or gtk_widget_add_events()
, and the
event mask necessary to cater for every GtkEventController created for the
widget.
void gtk_widget_add_events (GtkWidget *widget
,gint events
);
Adds the events in the bitfield events
to the event mask for
widget
. See gtk_widget_set_events()
and the
input handling overview for details.
void gtk_widget_set_device_events (GtkWidget *widget
,GdkDevice *device
,GdkEventMask events
);
Sets the device event mask (see GdkEventMask) for a widget. The event
mask determines which events a widget will receive from device
. Keep
in mind that different widgets have different default event masks, and by
changing the event mask you may disrupt a widget’s functionality,
so be careful. This function must be called while a widget is
unrealized. Consider gtk_widget_add_device_events()
for widgets that are
already realized, or if you want to preserve the existing event
mask. This function can’t be used with windowless widgets (which return
FALSE
from gtk_widget_get_has_window()
);
to get events on those widgets, place them inside a GtkEventBox
and receive events on the event box.
Since: 3.0
GdkEventMask gtk_widget_get_device_events (GtkWidget *widget
,GdkDevice *device
);
Returns the events mask for the widget corresponding to an specific device. These
are the events that the widget will receive when device
operates on it.
Since: 3.0
void gtk_widget_add_device_events (GtkWidget *widget
,GdkDevice *device
,GdkEventMask events
);
Adds the device events in the bitfield events
to the event mask for
widget
. See gtk_widget_set_device_events()
for details.
Since: 3.0
void gtk_widget_set_device_enabled (GtkWidget *widget
,GdkDevice *device
,gboolean enabled
);
Enables or disables a GdkDevice to interact with widget
and all its children.
It does so by descending through the GdkWindow hierarchy
and enabling the same mask that is has for core events
(i.e. the one that gdk_window_get_events()
returns).
Since: 3.0
gboolean gtk_widget_get_device_enabled (GtkWidget *widget
,GdkDevice *device
);
Returns whether device
can interact with widget
and its
children. See gtk_widget_set_device_enabled()
.
Since: 3.0
GtkWidget *
gtk_widget_get_toplevel (GtkWidget *widget
);
This function returns the topmost widget in the container hierarchy
widget
is a part of. If widget
has no parent widgets, it will be
returned as the topmost widget. No reference will be added to the
returned widget; it should not be unreferenced.
Note the difference in behavior vs. gtk_widget_get_ancestor()
;
gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)
would return
NULL
if widget
wasn’t inside a toplevel window, and if the
window was inside a GtkWindow-derived widget which was in turn
inside the toplevel GtkWindow. While the second case may
seem unlikely, it actually happens when a GtkPlug is embedded
inside a GtkSocket within the same application.
To reliably find the toplevel GtkWindow, use
gtk_widget_get_toplevel()
and call gtk_widget_is_toplevel()
on the result.
1 2 3 4 5 |
GtkWidget *toplevel = gtk_widget_get_toplevel (widget); if (gtk_widget_is_toplevel (toplevel)) { // Perform action on toplevel. } |
GtkWidget * gtk_widget_get_ancestor (GtkWidget *widget
,GType widget_type
);
Gets the first ancestor of widget
with type widget_type
. For example,
gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)
gets
the first GtkBox that’s an ancestor of widget
. No reference will be
added to the returned widget; it should not be unreferenced. See note
about checking for a toplevel GtkWindow in the docs for
gtk_widget_get_toplevel()
.
Note that unlike gtk_widget_is_ancestor()
, gtk_widget_get_ancestor()
considers widget
to be an ancestor of itself.
GdkVisual *
gtk_widget_get_visual (GtkWidget *widget
);
Gets the visual that will be used to render widget
.
void gtk_widget_set_visual (GtkWidget *widget
,GdkVisual *visual
);
Sets the visual that should be used for by widget and its children for
creating GdkWindows. The visual must be on the same GdkScreen as
returned by gtk_widget_get_screen()
, so handling the
“screen-changed” signal is necessary.
Setting a new visual
will not cause widget
to recreate its windows,
so you should call this function before widget
is realized.
void gtk_widget_get_pointer (GtkWidget *widget
,gint *x
,gint *y
);
gtk_widget_get_pointer
has been deprecated since version 3.4 and should not be used in newly-written code.
Use gdk_window_get_device_position()
instead.
Obtains the location of the mouse pointer in widget coordinates.
Widget coordinates are a bit odd; for historical reasons, they are
defined as widget->window
coordinates for widgets that return TRUE
for
gtk_widget_get_has_window()
; and are relative to widget->allocation.x
,
widget->allocation.y
otherwise.
gboolean gtk_widget_is_ancestor (GtkWidget *widget
,GtkWidget *ancestor
);
Determines whether widget
is somewhere inside ancestor
, possibly with
intermediate containers.
gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget
,GtkWidget *dest_widget
,gint src_x
,gint src_y
,gint *dest_x
,gint *dest_y
);
Translate coordinates relative to src_widget
’s allocation to coordinates
relative to dest_widget
’s allocations. In order to perform this
operation, both widgets must be realized, and must share a common
toplevel.
gboolean
gtk_widget_hide_on_delete (GtkWidget *widget
);
Utility function; intended to be connected to the “delete-event”
signal on a GtkWindow. The function calls gtk_widget_hide()
on its
argument, then returns TRUE
. If connected to ::delete-event, the
result is that clicking the close button for a window (on the
window frame, top right corner usually) will hide but not destroy
the window. By default, GTK+ destroys windows when ::delete-event
is received.
void gtk_widget_set_style (GtkWidget *widget
,GtkStyle *style
);
gtk_widget_set_style
has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead
Used to set the GtkStyle for a widget (widget->style
). Since
GTK 3, this function does nothing, the passed in style is ignored.
widget |
||
style |
a GtkStyle, or |
[allow-none] |
void
gtk_widget_ensure_style (GtkWidget *widget
);
gtk_widget_ensure_style
has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead
Ensures that widget
has a style (widget->style
).
Not a very useful function; most of the time, if you want the style, the widget is realized, and realized widgets are guaranteed to have a style already.
GtkStyle *
gtk_widget_get_style (GtkWidget *widget
);
gtk_widget_get_style
has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead
Simply an accessor function that returns widget->style
.
void
gtk_widget_reset_rc_styles (GtkWidget *widget
);
gtk_widget_reset_rc_styles
has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead, and gtk_widget_reset_style()
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.
This function is not useful for applications.
GtkStyle *
gtk_widget_get_default_style (void
);
gtk_widget_get_default_style
has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead, and
gtk_css_provider_get_default()
to obtain a GtkStyleProvider
with the default widget style information.
Returns the default style used by all widgets initially.
the default style. This GtkStyle object is owned by GTK+ and should not be modified or freed.
[transfer none]
void gtk_widget_set_direction (GtkWidget *widget
,GtkTextDirection dir
);
Sets the reading direction on a particular widget. This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).
If the direction is set to GTK_TEXT_DIR_NONE
, then the value
set by gtk_widget_set_default_direction()
will be used.
GtkTextDirection
gtk_widget_get_direction (GtkWidget *widget
);
Gets the reading direction for a particular widget. See
gtk_widget_set_direction()
.
void
gtk_widget_set_default_direction (GtkTextDirection dir
);
Sets the default reading direction for widgets where the
direction has not been explicitly set by gtk_widget_set_direction()
.
GtkTextDirection
gtk_widget_get_default_direction (void
);
Obtains the current default reading direction. See
gtk_widget_set_default_direction()
.
void gtk_widget_shape_combine_region (GtkWidget *widget
,cairo_region_t *region
);
Sets a shape for this widget’s GDK window. This allows for
transparent windows etc., see gdk_window_shape_combine_region()
for more information.
Since: 3.0
void gtk_widget_input_shape_combine_region (GtkWidget *widget
,cairo_region_t *region
);
Sets an input shape for this widget’s GDK window. This allows for
windows which react to mouse click in a nonrectangular region, see
gdk_window_input_shape_combine_region()
for more information.
Since: 3.0
void gtk_widget_path (GtkWidget *widget
,guint *path_length
,gchar **path
,gchar **path_reversed
);
gtk_widget_path
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_get_path()
instead
Obtains the full path to widget
. The path is simply the name of a
widget and all its parents in the container hierarchy, separated by
periods. The name of a widget comes from
gtk_widget_get_name()
. Paths are used to apply styles to a widget
in gtkrc configuration files. Widget names are the type of the
widget by default (e.g. “GtkButton”) or can be set to an
application-specific value with gtk_widget_set_name()
. By setting
the name of a widget, you allow users or theme authors to apply
styles to that specific widget in their gtkrc
file. path_reversed_p
fills in the path in reverse order,
i.e. starting with widget
’s name instead of starting with the name
of widget
’s outermost ancestor.
void gtk_widget_class_path (GtkWidget *widget
,guint *path_length
,gchar **path
,gchar **path_reversed
);
gtk_widget_class_path
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_get_path()
instead
Same as gtk_widget_path()
, but always uses the name of a widget’s type,
never uses a custom name set with gtk_widget_set_name()
.
gchar *
gtk_widget_get_composite_name (GtkWidget *widget
);
gtk_widget_get_composite_name
has been deprecated since version 3.10 and should not be used in newly-written code.
Use gtk_widget_class_set_template()
, or don’t use this API at all.
Obtains the composite name of a widget.
the composite name of widget
, or NULL
if widget
is not
a composite child. The string should be freed when it is no
longer needed.
void gtk_widget_override_background_color (GtkWidget *widget
,GtkStateFlags state
,const GdkRGBA *color
);
gtk_widget_override_background_color
has been deprecated since version 3.16 and should not be used in newly-written code.
This function is not useful in the context of CSS-based rendering. If you wish to change the way a widget renders its background you should use a custom CSS style, through an application-specific GtkStyleProvider and a CSS style class. You can also override the default drawing of a widget through the “draw” signal, and use Cairo to draw a specific color, regardless of the CSS style.
Sets the background color to use for a widget.
All other style values are left untouched.
See gtk_widget_override_color()
.
widget |
||
state |
the state for which to set the background color |
|
color |
the color to assign, or |
[allow-none] |
Since: 3.0
void gtk_widget_override_color (GtkWidget *widget
,GtkStateFlags state
,const GdkRGBA *color
);
gtk_widget_override_color
has been deprecated since version 3.16 and should not be used in newly-written code.
Use a custom style provider and style classes instead
Sets the color to use for a widget.
All other style values are left untouched.
This function does not act recursively. Setting the color of a container does not affect its children. Note that some widgets that you may not think of as containers, for instance GtkButtons, are actually containers.
This API is mostly meant as a quick way for applications to
change a widget appearance. If you are developing a widgets
library and intend this change to be themeable, it is better
done by setting meaningful CSS classes in your
widget/container implementation through gtk_style_context_add_class()
.
This way, your widget library can install a GtkCssProvider
with the GTK_STYLE_PROVIDER_PRIORITY_FALLBACK
priority in order
to provide a default styling for those widgets that need so, and
this theming may fully overridden by the user’s theme.
Note that for complex widgets this may bring in undesired
results (such as uniform background color everywhere), in
these cases it is better to fully style such widgets through a
GtkCssProvider with the GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
priority.
widget |
||
state |
the state for which to set the color |
|
color |
the color to assign, or |
[allow-none] |
Since: 3.0
void gtk_widget_override_font (GtkWidget *widget
,const PangoFontDescription *font_desc
);
gtk_widget_override_font
has been deprecated since version 3.16 and should not be used in newly-written code.
This function is not useful in the context of CSS-based rendering. If you wish to change the font a widget uses to render its text you should use a custom CSS style, through an application-specific GtkStyleProvider and a CSS style class.
Sets the font to use for a widget. All other style values are
left untouched. See gtk_widget_override_color()
.
widget |
||
font_desc |
the font description to use, or |
[allow-none] |
Since: 3.0
void gtk_widget_override_symbolic_color (GtkWidget *widget
,const gchar *name
,const GdkRGBA *color
);
gtk_widget_override_symbolic_color
has been deprecated since version 3.16 and should not be used in newly-written code.
This function is not useful in the context of CSS-based rendering. If you wish to change the color used to render symbolic icons you should use a custom CSS style, through an application-specific GtkStyleProvider and a CSS style class.
Sets a symbolic color for a widget.
All other style values are left untouched.
See gtk_widget_override_color()
for overriding the foreground
or background color.
widget |
||
name |
the name of the symbolic color to modify |
|
color |
the color to assign (does not need
to be allocated), or |
[allow-none] |
Since: 3.0
void gtk_widget_override_cursor (GtkWidget *widget
,const GdkRGBA *cursor
,const GdkRGBA *secondary_cursor
);
gtk_widget_override_cursor
has been deprecated since version 3.16 and should not be used in newly-written code.
This function is not useful in the context of CSS-based rendering. If you wish to change the color used to render the primary and secondary cursors you should use a custom CSS style, through an application-specific GtkStyleProvider and a CSS style class.
Sets the cursor color to use in a widget, overriding the
cursor-color and secondary-cursor-color
style properties. All other style values are left untouched.
See also gtk_widget_modify_style()
.
Note that the underlying properties have the GdkColor type,
so the alpha value in primary
and secondary
will be ignored.
widget |
||
cursor |
the color to use for primary cursor (does not need to be
allocated), or |
[allow-none] |
secondary_cursor |
the color to use for secondary cursor (does not
need to be allocated), or |
[allow-none] |
Since: 3.0
void gtk_widget_modify_style (GtkWidget *widget
,GtkRcStyle *style
);
gtk_widget_modify_style
has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext with a custom GtkStyleProvider instead
Modifies style values on the widget.
Modifications made using this technique take precedence over
style values set via an RC file, however, they will be overridden
if a style is explicitly set on the widget using gtk_widget_set_style()
.
The GtkRcStyle is designed so each field can either be
set or unset, so it is possible, using this function, to modify some
style values and leave the others unchanged.
Note that modifications made with this function are not cumulative
with previous calls to gtk_widget_modify_style()
or with such
functions as gtk_widget_modify_fg()
. If you wish to retain
previous values, you must first call gtk_widget_get_modifier_style()
,
make your modifications to the returned style, then call
gtk_widget_modify_style()
with that style. On the other hand,
if you first call gtk_widget_modify_style()
, subsequent calls
to such functions gtk_widget_modify_fg()
will have a cumulative
effect with the initial modifications.
GtkRcStyle *
gtk_widget_get_modifier_style (GtkWidget *widget
);
gtk_widget_get_modifier_style
has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext with a custom GtkStyleProvider instead
Returns the current modifier style for the widget. (As set by
gtk_widget_modify_style()
.) If no style has previously set, a new
GtkRcStyle will be created with all values unset, and set as the
modifier style for the widget. If you make changes to this rc
style, you must call gtk_widget_modify_style()
, passing in the
returned rc style, to make sure that your changes take effect.
Caution: passing the style back to gtk_widget_modify_style()
will
normally end up destroying it, because gtk_widget_modify_style()
copies
the passed-in style and sets the copy as the new modifier style,
thus dropping any reference to the old modifier style. Add a reference
to the modifier style if you want to keep it alive.
the modifier style for the widget.
This rc style is owned by the widget. If you want to keep a
pointer to value this around, you must add a refcount using
g_object_ref()
.
[transfer none]
void gtk_widget_modify_fg (GtkWidget *widget
,GtkStateType state
,const GdkColor *color
);
gtk_widget_modify_fg
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_override_color()
instead
Sets the foreground color for a widget in a particular state.
All other style values are left untouched.
See also gtk_widget_modify_style()
.
widget |
||
state |
the state for which to set the foreground color |
|
color |
the color to assign (does not need to be allocated),
or |
[allow-none] |
void gtk_widget_modify_bg (GtkWidget *widget
,GtkStateType state
,const GdkColor *color
);
gtk_widget_modify_bg
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_override_background_color()
instead
Sets the background color for a widget in a particular state.
All other style values are left untouched.
See also gtk_widget_modify_style()
.
Note that “no window” widgets (which have the
GTK_NO_WINDOW
flag set) draw on their parent container’s window and thus may not draw any background themselves. This is the case for e.g. GtkLabel.To modify the background of such widgets, you have to set the background color on their parent; if you want to set the background of a rectangular area around a label, try placing the label in a GtkEventBox widget and setting the background color on that.
widget |
||
state |
the state for which to set the background color |
|
color |
the color to assign (does not need
to be allocated), or |
[allow-none] |
void gtk_widget_modify_text (GtkWidget *widget
,GtkStateType state
,const GdkColor *color
);
gtk_widget_modify_text
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_override_color()
instead
Sets the text color for a widget in a particular state.
All other style values are left untouched.
The text color is the foreground color used along with the
base color (see gtk_widget_modify_base()
) for widgets such
as GtkEntry and GtkTextView.
See also gtk_widget_modify_style()
.
widget |
||
state |
the state for which to set the text color |
|
color |
the color to assign (does not need to
be allocated), or |
[allow-none] |
void gtk_widget_modify_base (GtkWidget *widget
,GtkStateType state
,const GdkColor *color
);
gtk_widget_modify_base
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_override_background_color()
instead
Sets the base color for a widget in a particular state.
All other style values are left untouched. The base color
is the background color used along with the text color
(see gtk_widget_modify_text()
) for widgets such as GtkEntry
and GtkTextView. See also gtk_widget_modify_style()
.
Note that “no window” widgets (which have the
GTK_NO_WINDOW
flag set) draw on their parent container’s window and thus may not draw any background themselves. This is the case for e.g. GtkLabel.To modify the background of such widgets, you have to set the base color on their parent; if you want to set the background of a rectangular area around a label, try placing the label in a GtkEventBox widget and setting the base color on that.
widget |
||
state |
the state for which to set the base color |
|
color |
the color to assign (does not need to
be allocated), or |
[allow-none] |
void gtk_widget_modify_font (GtkWidget *widget
,PangoFontDescription *font_desc
);
gtk_widget_modify_font
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_override_font()
instead
Sets the font to use for a widget.
All other style values are left untouched.
See also gtk_widget_modify_style()
.
widget |
||
font_desc |
the font description to use, or |
[allow-none] |
void gtk_widget_modify_cursor (GtkWidget *widget
,const GdkColor *primary
,const GdkColor *secondary
);
gtk_widget_modify_cursor
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_override_cursor()
instead.
Sets the cursor color to use in a widget, overriding the GtkWidget cursor-color and secondary-cursor-color style properties.
All other style values are left untouched.
See also gtk_widget_modify_style()
.
widget |
||
primary |
the color to use for primary cursor (does not
need to be allocated), or |
[nullable] |
secondary |
the color to use for secondary cursor (does
not need to be allocated), or |
[nullable] |
Since: 2.12
PangoContext *
gtk_widget_create_pango_context (GtkWidget *widget
);
Creates a new PangoContext with the appropriate font map,
font options, font description, and base direction for drawing
text for this widget. See also gtk_widget_get_pango_context()
.
PangoContext *
gtk_widget_get_pango_context (GtkWidget *widget
);
Gets a PangoContext with the appropriate font map, font description,
and base direction for this widget. Unlike the context returned
by gtk_widget_create_pango_context()
, this context is owned by
the widget (it can be used until the screen for the widget changes
or the widget is removed from its toplevel), and will be updated to
match any changes to the widget’s attributes. This can be tracked
by using the “screen-changed” signal on the widget.
void gtk_widget_set_font_options (GtkWidget *widget
,const cairo_font_options_t *options
);
Sets the cairo_font_options_t used for Pango rendering in this widget. When not set, the default font options for the GdkScreen will be used.
widget |
||
options |
a cairo_font_options_t, or |
[allow-none] |
Since: 3.18
const cairo_font_options_t *
gtk_widget_get_font_options (GtkWidget *widget
);
Returns the cairo_font_options_t used for Pango rendering. When not set, the defaults font options for the GdkScreen will be used.
Since: 3.18
void gtk_widget_set_font_map (GtkWidget *widget
,PangoFontMap *font_map
);
Sets the font map to use for Pango rendering. When not set, the widget will inherit the font map from its parent.
widget |
||
font_map |
a PangoFontMap, or |
[allow-none] |
Since: 3.18
PangoFontMap *
gtk_widget_get_font_map (GtkWidget *widget
);
Gets the font map that has been set with gtk_widget_set_font_map()
.
Since: 3.18
PangoLayout * gtk_widget_create_pango_layout (GtkWidget *widget
,const gchar *text
);
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
If you keep a PangoLayout created in this way around, you need to re-create it when the widget PangoContext is replaced. This can be tracked by using the “screen-changed” signal on the widget.
GdkPixbuf * gtk_widget_render_icon (GtkWidget *widget
,const gchar *stock_id
,GtkIconSize size
,const gchar *detail
);
gtk_widget_render_icon
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_render_icon_pixbuf()
instead.
A convenience function that uses the theme settings for widget
to look up stock_id
and render it to a pixbuf. stock_id
should
be a stock icon ID such as GTK_STOCK_OPEN or GTK_STOCK_OK. size
should be a size such as GTK_ICON_SIZE_MENU. detail
should be a
string that identifies the widget or code doing the rendering, so
that theme engines can special-case rendering for that widget or
code.
The pixels in the returned GdkPixbuf are shared with the rest of
the application and should not be modified. The pixbuf should be
freed after use with g_object_unref()
.
widget |
||
stock_id |
a stock ID |
|
size |
a stock size (GtkIconSize). A size of |
[type int] |
detail |
render detail to pass to theme engine. |
[allow-none] |
GdkPixbuf * gtk_widget_render_icon_pixbuf (GtkWidget *widget
,const gchar *stock_id
,GtkIconSize size
);
gtk_widget_render_icon_pixbuf
has been deprecated since version 3.10 and should not be used in newly-written code.
Use gtk_icon_theme_load_icon()
instead.
A convenience function that uses the theme engine and style
settings for widget
to look up stock_id
and render it to
a pixbuf. stock_id
should be a stock icon ID such as
GTK_STOCK_OPEN or GTK_STOCK_OK. size
should be a size
such as GTK_ICON_SIZE_MENU.
The pixels in the returned GdkPixbuf are shared with the rest of
the application and should not be modified. The pixbuf should be freed
after use with g_object_unref()
.
widget |
||
stock_id |
a stock ID |
|
size |
a stock size (GtkIconSize). A size of |
[type int] |
Since: 3.0
void
gtk_widget_pop_composite_child (void
);
gtk_widget_pop_composite_child
has been deprecated since version 3.10 and should not be used in newly-written code.
Use gtk_widget_class_set_template()
, or don’t use this API at all.
Cancels the effect of a previous call to gtk_widget_push_composite_child()
.
void
gtk_widget_push_composite_child (void
);
gtk_widget_push_composite_child
has been deprecated since version 3.10 and should not be used in newly-written code.
This API never really worked well and was mostly unused, now
we have a more complete mechanism for composite children, see gtk_widget_class_set_template()
.
Makes all newly-created widgets as composite children until
the corresponding gtk_widget_pop_composite_child()
call.
A composite child is a child that’s an implementation detail of the
container it’s inside and should not be visible to people using the
container. Composite children aren’t treated differently by GTK+ (but
see gtk_container_foreach()
vs. gtk_container_forall()
), but e.g. GUI
builders might want to treat them in a different way.
void gtk_widget_queue_draw_area (GtkWidget *widget
,gint x
,gint y
,gint width
,gint height
);
Convenience function that calls gtk_widget_queue_draw_region()
on
the region created from the given coordinates.
The region here is specified in widget coordinates.
Widget coordinates are a bit odd; for historical reasons, they are
defined as widget->window
coordinates for widgets that return TRUE
for
gtk_widget_get_has_window()
, and are relative to widget->allocation.x
,
widget->allocation.y
otherwise.
width
or height
may be 0, in this case this function does
nothing. Negative values for width
and height
are not allowed.
void gtk_widget_queue_draw_region (GtkWidget *widget
,const cairo_region_t *region
);
Invalidates the area of widget
defined by region
by calling
gdk_window_invalidate_region()
on the widget’s window and all its
child windows. Once the main loop becomes idle (after the current
batch of events has been processed, roughly), the window will
receive expose events for the union of all regions that have been
invalidated.
Normally you would only use this function in widget implementations. You might also use it to schedule a redraw of a GtkDrawingArea or some portion thereof.
Since: 3.0
void gtk_widget_set_app_paintable (GtkWidget *widget
,gboolean app_paintable
);
Sets whether the application intends to draw on the widget in an “draw” handler.
This is a hint to the widget and does not affect the behavior of the GTK+ core; many widgets ignore this flag entirely. For widgets that do pay attention to the flag, such as GtkEventBox and GtkWindow, the effect is to suppress default themed drawing of the widget's background. (Children of the widget will still be drawn.) The application is then entirely responsible for drawing the widget background.
Note that the background is still drawn when the widget is mapped.
void gtk_widget_set_double_buffered (GtkWidget *widget
,gboolean double_buffered
);
gtk_widget_set_double_buffered
has been deprecated since version 3.14 and should not be used in newly-written code.
This function does not work under non-X11 backends or with non-native windows. It should not be used in newly written code.
Widgets are double buffered by default; you can use this function
to turn off the buffering. “Double buffered” simply means that
gdk_window_begin_draw_frame()
and gdk_window_end_draw_frame()
are called
automatically around expose events sent to the
widget. gdk_window_begin_draw_frame()
diverts all drawing to a widget's
window to an offscreen buffer, and gdk_window_end_draw_frame()
draws the
buffer to the screen. The result is that users see the window
update in one smooth step, and don’t see individual graphics
primitives being rendered.
In very simple terms, double buffered widgets don’t flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing.
Note: if you turn off double-buffering, you have to handle
expose events, since even the clearing to the background color or
pixmap will not happen automatically (as it is done in
gdk_window_begin_draw_frame()
).
In 3.10 GTK and GDK have been restructured for translucent drawing. Since then expose events for double-buffered widgets are culled into a single event to the toplevel GDK window. If you now unset double buffering, you will cause a separate rendering pass for every widget. This will likely cause rendering problems - in particular related to stacking - and usually increases rendering times significantly.
void gtk_widget_set_redraw_on_allocate (GtkWidget *widget
,gboolean redraw_on_allocate
);
Sets whether the entire widget is queued for drawing when its size
allocation changes. By default, this setting is TRUE
and
the entire widget is redrawn on every size change. If your widget
leaves the upper left unchanged when made bigger, turning this
setting off will improve performance.
Note that for widgets where gtk_widget_get_has_window()
is FALSE
setting this flag to FALSE
turns off all allocation on resizing:
the widget will not even redraw if its position changes; this is to
allow containers that don’t draw anything to avoid excess
invalidations. If you set this flag on a widget with no window that
does draw on widget->window
, you are
responsible for invalidating both the old and new allocation of the
widget when the widget is moved and responsible for invalidating
regions newly when the widget increases size.
void gtk_widget_set_composite_name (GtkWidget *widget
,const gchar *name
);
gtk_widget_set_composite_name
has been deprecated since version 3.10 and should not be used in newly-written code.
Use gtk_widget_class_set_template()
, or don’t use this API at all.
Sets a widgets composite name. The widget must be
a composite child of its parent; see gtk_widget_push_composite_child()
.
gboolean gtk_widget_mnemonic_activate (GtkWidget *widget
,gboolean group_cycling
);
Emits the “mnemonic-activate” signal.
void gtk_widget_class_install_style_property (GtkWidgetClass *klass
,GParamSpec *pspec
);
Installs a style property on a widget class. The parser for the
style property is determined by the value type of pspec
.
void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass
,GParamSpec *pspec
,GtkRcPropertyParser parser
);
Installs a style property on a widget class.
[skip]
klass |
||
pspec |
the GParamSpec for the style property |
|
parser |
the parser for the style property |
GParamSpec * gtk_widget_class_find_style_property (GtkWidgetClass *klass
,const gchar *property_name
);
Finds a style property of a widget class by name.
the GParamSpec of the style property or
NULL
if class
has no style property with that name.
[transfer none]
Since: 2.2
GParamSpec ** gtk_widget_class_list_style_properties (GtkWidgetClass *klass
,guint *n_properties
);
Returns all style properties of a widget class.
a
newly allocated array of GParamSpec*. The array must be
freed with g_free()
.
[array length=n_properties][transfer container]
Since: 2.2
cairo_region_t * gtk_widget_region_intersect (GtkWidget *widget
,const cairo_region_t *region
);
gtk_widget_region_intersect
has been deprecated since version 3.14 and should not be used in newly-written code.
Use gtk_widget_get_allocation()
and
cairo_region_intersect_rectangle()
to get the same behavior.
Computes the intersection of a widget
’s area and region
, returning
the intersection. The result may be empty, use cairo_region_is_empty()
to
check.
widget |
||
region |
a cairo_region_t, in the same coordinate system as
|
gint gtk_widget_send_expose (GtkWidget *widget
,GdkEvent *event
);
gtk_widget_send_expose
has been deprecated since version 3.22 and should not be used in newly-written code.
Application and widget code should not handle expose events directly; invalidation should use the GtkWidget API, and drawing should only happen inside “draw” implementations
Very rarely-used function. This function is used to emit
an expose event on a widget. This function is not normally used
directly. The only time it is used is when propagating an expose
event to a windowless child widget (gtk_widget_get_has_window()
is FALSE
),
and that is normally done using gtk_container_propagate_draw()
.
If you want to force an area of a window to be redrawn,
use gdk_window_invalidate_rect()
or gdk_window_invalidate_region()
.
To cause the redraw to be done immediately, follow that call
with a call to gdk_window_process_updates()
.
gboolean gtk_widget_send_focus_change (GtkWidget *widget
,GdkEvent *event
);
Sends the focus change event
to widget
This function is not meant to be used by applications. The only time it should be used is when it is necessary for a GtkWidget to assign focus to a widget that is semantically owned by the first widget even though it’s not a direct child - for instance, a search entry in a floating window similar to the quick search in GtkTreeView.
An example of its usage is:
1 2 3 4 5 6 7 8 9 10 11 |
GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE); fevent->focus_change.type = GDK_FOCUS_CHANGE; fevent->focus_change.in = TRUE; fevent->focus_change.window = _gtk_widget_get_window (widget); if (fevent->focus_change.window != NULL) g_object_ref (fevent->focus_change.window); gtk_widget_send_focus_change (widget, fevent); gdk_event_free (event); |
the return value from the event signal emission: TRUE
if the event was handled, and FALSE
otherwise
Since: 2.20
void gtk_widget_style_get (GtkWidget *widget
,const gchar *first_property_name
,...
);
Gets the values of a multiple style properties of widget
.
void gtk_widget_style_get_property (GtkWidget *widget
,const gchar *property_name
,GValue *value
);
Gets the value of a style property of widget
.
void gtk_widget_style_get_valist (GtkWidget *widget
,const gchar *first_property_name
,va_list var_args
);
Non-vararg variant of gtk_widget_style_get()
. Used primarily by language
bindings.
void
gtk_widget_style_attach (GtkWidget *widget
);
gtk_widget_style_attach
has been deprecated since version 3.0 and should not be used in newly-written code.
This step is unnecessary with GtkStyleContext.
This function attaches the widget’s GtkStyle to the widget's GdkWindow. It is a replacement for
1 |
widget->style = gtk_style_attach (widget->style, widget->window); |
and should only ever be called in a derived widget’s “realize” implementation which does not chain up to its parent class' “realize” implementation, because one of the parent classes (finally GtkWidget) would attach the style itself.
Since: 2.20
void gtk_widget_class_set_accessible_type (GtkWidgetClass *widget_class
,GType type
);
Sets the type to be used for creating accessibles for widgets of
widget_class
. The given type
must be a subtype of the type used for
accessibles of the parent class.
This function should only be called from class init functions of widgets.
widget_class |
class to set the accessible type for |
|
type |
The object type that implements the accessible for |
Since: 3.2
void gtk_widget_class_set_accessible_role (GtkWidgetClass *widget_class
,AtkRole role
);
Sets the default AtkRole to be set on accessibles created for
widgets of widget_class
. Accessibles may decide to not honor this
setting if their role reporting is more refined. Calls to
gtk_widget_class_set_accessible_type()
will reset this value.
In cases where you want more fine-grained control over the role of
accessibles created for widget_class
, you should provide your own
accessible type and use gtk_widget_class_set_accessible_type()
instead.
If role
is ATK_ROLE_INVALID, the default role will not be changed
and the accessible’s default role will be used instead.
This function should only be called from class init functions of widgets.
widget_class |
class to set the accessible role for |
|
role |
The role to use for accessibles created for |
Since: 3.2
AtkObject *
gtk_widget_get_accessible (GtkWidget *widget
);
Returns the accessible object that describes the widget to an assistive technology.
If accessibility support is not available, this AtkObject instance may be a no-op. Likewise, if no class-specific AtkObject implementation is available for the widget instance in question, it will inherit an AtkObject implementation from the first ancestor class for which such an implementation is defined.
The documentation of the ATK library contains more information about accessible objects and their uses.
gboolean gtk_widget_child_focus (GtkWidget *widget
,GtkDirectionType direction
);
This function is used by custom widget implementations; if you're
writing an app, you’d use gtk_widget_grab_focus()
to move the focus
to a particular widget, and gtk_container_set_focus_chain()
to
change the focus tab order. So you may want to investigate those
functions instead.
gtk_widget_child_focus() is called by containers as the user moves
around the window using keyboard shortcuts. direction
indicates
what kind of motion is taking place (up, down, left, right, tab
forward, tab backward). gtk_widget_child_focus()
emits the
“focus” signal; widgets override the default handler
for this signal in order to implement appropriate focus behavior.
The default ::focus handler for a widget should return TRUE
if
moving in direction
left the focus on a focusable location inside
that widget, and FALSE
if moving in direction
moved the focus
outside the widget. If returning TRUE
, widgets normally
call gtk_widget_grab_focus()
to place the focus accordingly;
if returning FALSE
, they don’t modify the current focus location.
void gtk_widget_child_notify (GtkWidget *widget
,const gchar *child_property
);
Emits a “child-notify” signal for the
child property child_property
on widget
.
This is the analogue of g_object_notify()
for child properties.
Also see gtk_container_child_notify()
.
void
gtk_widget_freeze_child_notify (GtkWidget *widget
);
Stops emission of “child-notify” signals on widget
. The
signals are queued until gtk_widget_thaw_child_notify()
is called
on widget
.
This is the analogue of g_object_freeze_notify()
for child properties.
gboolean
gtk_widget_get_child_visible (GtkWidget *widget
);
Gets the value set with gtk_widget_set_child_visible()
.
If you feel a need to use this function, your code probably
needs reorganization.
This function is only useful for container implementations and never should be called by an application.
GtkWidget *
gtk_widget_get_parent (GtkWidget *widget
);
Returns the parent container of widget
.
GtkSettings *
gtk_widget_get_settings (GtkWidget *widget
);
Gets the settings object holding the settings used for this widget.
Note that this function can only be called when the GtkWidget is attached to a toplevel, since the settings object is specific to a particular GdkScreen.
GtkClipboard * gtk_widget_get_clipboard (GtkWidget *widget
,GdkAtom selection
);
Returns the clipboard object for the given selection to
be used with widget
. widget
must have a GdkDisplay
associated with it, so must be attached to a toplevel
window.
widget |
||
selection |
a GdkAtom which identifies the clipboard
to use. |
the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent for all time.
[transfer none]
Since: 2.2
GdkDisplay *
gtk_widget_get_display (GtkWidget *widget
);
Get the GdkDisplay for the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a GtkWindow at the top.
In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.
Since: 2.2
GdkWindow *
gtk_widget_get_root_window (GtkWidget *widget
);
gtk_widget_get_root_window
has been deprecated since version 3.12 and should not be used in newly-written code.
Use gdk_screen_get_root_window()
instead
Get the root window where this widget is located. This function can only be called after the widget has been added to a widget hierarchy with GtkWindow at the top.
The root window is useful for such purposes as creating a popup GdkWindow associated with the window. In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.
Since: 2.2
GdkScreen *
gtk_widget_get_screen (GtkWidget *widget
);
Get the GdkScreen from the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a GtkWindow at the top.
In general, you should only create screen specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.
Since: 2.2
gboolean
gtk_widget_has_screen (GtkWidget *widget
);
Checks whether there is a GdkScreen is associated with this widget. All toplevel widgets have an associated screen, and all widgets added into a hierarchy with a toplevel window at the top.
Since: 2.2
void gtk_widget_get_size_request (GtkWidget *widget
,gint *width
,gint *height
);
Gets the size request that was explicitly set for the widget using
gtk_widget_set_size_request()
. A value of -1 stored in width
or
height
indicates that that dimension has not been set explicitly
and the natural requisition of the widget will be used instead. See
gtk_widget_set_size_request()
. To get the size a widget will
actually request, call gtk_widget_get_preferred_size()
instead of
this function.
void gtk_widget_set_child_visible (GtkWidget *widget
,gboolean is_visible
);
Sets whether widget
should be mapped along with its when its parent
is mapped and widget
has been shown with gtk_widget_show()
.
The child visibility can be set for widget before it is added to
a container with gtk_widget_set_parent()
, to avoid mapping
children unnecessary before immediately unmapping them. However
it will be reset to its default state of TRUE
when the widget
is removed from a container.
Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself.
This function is only useful for container implementations and never should be called by an application.
void gtk_widget_set_size_request (GtkWidget *widget
,gint width
,gint height
);
Sets the minimum size of a widget; that is, the widget’s size
request will be at least width
by height
. You can use this
function to force a widget to be larger than it normally would be.
In most cases, gtk_window_set_default_size()
is a better choice for
toplevel windows than this function; setting the default size will
still allow users to shrink the window. Setting the size request
will force them to leave the window at least as large as the size
request. When dealing with window sizes,
gtk_window_set_geometry_hints()
can be a useful function as well.
Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it's basically impossible to hardcode a size that will always be correct.
The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it requested.
If the size request in a given direction is -1 (unset), then the “natural” size request of the widget will be used instead.
The size request set here does not include any margin from the GtkWidget properties margin-left, margin-right, margin-top, and margin-bottom, but it does include pretty much all other padding or border properties set by any subclass of GtkWidget.
void
gtk_widget_thaw_child_notify (GtkWidget *widget
);
Reverts the effect of a previous call to gtk_widget_freeze_child_notify()
.
This causes all queued “child-notify” signals on widget
to be
emitted.
void gtk_widget_set_no_show_all (GtkWidget *widget
,gboolean no_show_all
);
Sets the “no-show-all” property, which determines whether
calls to gtk_widget_show_all()
will affect this widget.
This is mostly for use in constructing widget hierarchies with externally controlled visibility, see GtkUIManager.
Since: 2.4
gboolean
gtk_widget_get_no_show_all (GtkWidget *widget
);
Returns the current value of the “no-show-all” property,
which determines whether calls to gtk_widget_show_all()
will affect this widget.
Since: 2.4
GList *
gtk_widget_list_mnemonic_labels (GtkWidget *widget
);
Returns a newly allocated list of the widgets, normally labels, for
which this widget is the target of a mnemonic (see for example,
gtk_label_set_mnemonic_widget()
).
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 then unref all the
widgets afterwards.
the list of
mnemonic labels; free this list
with g_list_free()
when you are done with it.
[element-type GtkWidget][transfer container]
Since: 2.4
void gtk_widget_add_mnemonic_label (GtkWidget *widget
,GtkWidget *label
);
Adds a widget to the list of mnemonic labels for
this widget. (See gtk_widget_list_mnemonic_labels()
). Note the
list of mnemonic labels for the widget is cleared when the
widget is destroyed, so the caller must make sure to update
its internal state at this point as well, by using a connection
to the “destroy” signal or a weak notifier.
Since: 2.4
void gtk_widget_remove_mnemonic_label (GtkWidget *widget
,GtkWidget *label
);
Removes a widget from the list of mnemonic labels for
this widget. (See gtk_widget_list_mnemonic_labels()
). The widget
must have previously been added to the list with
gtk_widget_add_mnemonic_label()
.
widget |
||
label |
a GtkWidget that was previously set as a mnemonic label for
|
Since: 2.4
gboolean
gtk_widget_is_composited (GtkWidget *widget
);
gtk_widget_is_composited
has been deprecated since version 3.22 and should not be used in newly-written code.
Use gdk_screen_is_composited()
instead.
Whether widget
can rely on having its alpha channel
drawn correctly. On X11 this function returns whether a
compositing manager is running for widget
’s screen.
Please note that the semantics of this call will change
in the future if used on a widget that has a composited
window in its hierarchy (as set by gdk_window_set_composited()
).
Since: 2.10
void
gtk_widget_error_bell (GtkWidget *widget
);
Notifies the user about an input-related error on this widget.
If the “gtk-error-bell” setting is TRUE
, it calls
gdk_window_beep()
, otherwise it does nothing.
Note that the effect of gdk_window_beep()
can be configured in many
ways, depending on the windowing backend and the desktop environment
or window manager that is used.
Since: 2.12
gboolean gtk_widget_keynav_failed (GtkWidget *widget
,GtkDirectionType direction
);
This function should be called whenever keyboard navigation within
a single widget hits a boundary. The function emits the
“keynav-failed” signal on the widget and its return
value should be interpreted in a way similar to the return value of
gtk_widget_child_focus()
:
When TRUE
is returned, stay in the widget, the failed keyboard
navigation is OK and/or there is nowhere we can/should move the
focus to.
When FALSE
is returned, the caller should continue with keyboard
navigation outside the widget, e.g. by calling
gtk_widget_child_focus()
on the widget’s toplevel.
The default ::keynav-failed handler returns TRUE
for
GTK_DIR_TAB_FORWARD
and GTK_DIR_TAB_BACKWARD
. For the other
values of GtkDirectionType it returns FALSE
.
Whenever the default handler returns TRUE
, it also calls
gtk_widget_error_bell()
to notify the user of the failed keyboard
navigation.
A use case for providing an own implementation of ::keynav-failed (either by connecting to it or by overriding it) would be a row of GtkEntry widgets where the user should be able to navigate the entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys.
TRUE
if stopping keyboard navigation is fine, FALSE
if the emitting widget should try to handle the keyboard
navigation attempt in its parent container(s).
Since: 2.12
gchar *
gtk_widget_get_tooltip_markup (GtkWidget *widget
);
Gets the contents of the tooltip for widget
.
the tooltip text, or NULL
. You should free the
returned string with g_free()
when done.
[nullable]
Since: 2.12
void gtk_widget_set_tooltip_markup (GtkWidget *widget
,const gchar *markup
);
Sets markup
as the contents of the tooltip, which is marked up with
the Pango text markup language.
This function will take care of setting “has-tooltip” to TRUE
and of the default handler for the “query-tooltip” signal.
See also the “tooltip-markup” property and
gtk_tooltip_set_markup()
.
Since: 2.12
gchar *
gtk_widget_get_tooltip_text (GtkWidget *widget
);
Gets the contents of the tooltip for widget
.
the tooltip text, or NULL
. You should free the
returned string with g_free()
when done.
[nullable]
Since: 2.12
void gtk_widget_set_tooltip_text (GtkWidget *widget
,const gchar *text
);
Sets text
as the contents of the tooltip. This function will take
care of setting “has-tooltip” to TRUE
and of the default
handler for the “query-tooltip” signal.
See also the “tooltip-text” property and gtk_tooltip_set_text()
.
Since: 2.12
GtkWindow *
gtk_widget_get_tooltip_window (GtkWidget *widget
);
Returns the GtkWindow of the current tooltip. This can be the
GtkWindow created by default, or the custom tooltip window set
using gtk_widget_set_tooltip_window()
.
Since: 2.12
void gtk_widget_set_tooltip_window (GtkWidget *widget
,GtkWindow *custom_window
);
Replaces the default, usually yellow, window used for displaying
tooltips with custom_window
. GTK+ will take care of showing and
hiding custom_window
at the right moment, to behave likewise as
the default tooltip window. If custom_window
is NULL
, the default
tooltip window will be used.
If the custom window should have the default theming it needs to
have the name “gtk-tooltip”, see gtk_widget_set_name()
.
Since: 2.12
gboolean
gtk_widget_get_has_tooltip (GtkWidget *widget
);
Returns the current value of the has-tooltip property. See “has-tooltip” for more information.
Since: 2.12
void gtk_widget_set_has_tooltip (GtkWidget *widget
,gboolean has_tooltip
);
Sets the has-tooltip property on widget
to has_tooltip
. See
“has-tooltip” for more information.
Since: 2.12
void
gtk_widget_trigger_tooltip_query (GtkWidget *widget
);
Triggers a tooltip query on the display where the toplevel of widget
is located. See gtk_tooltip_trigger_tooltip_query()
for more
information.
Since: 2.12
GdkWindow *
gtk_widget_get_window (GtkWidget *widget
);
Returns the widget’s window if it is realized, NULL
otherwise
Since: 2.14
void gtk_widget_register_window (GtkWidget *widget
,GdkWindow *window
);
Registers a GdkWindow with the widget and sets it up so that
the widget receives events for it. Call gtk_widget_unregister_window()
when destroying the window.
 This is now deprecated and you should use gtk_widget_register_window()
instead. Old code will keep working as is, although some new features like
transparency might not work perfectly.
Since: 3.8
void gtk_widget_unregister_window (GtkWidget *widget
,GdkWindow *window
);
Unregisters a GdkWindow from the widget that was previously set up with
gtk_widget_register_window()
. You need to call this when the window is
no longer used by the widget, such as when you destroy it.
Since: 3.8
gboolean gtk_cairo_should_draw_window (cairo_t *cr
,GdkWindow *window
);
This function is supposed to be called in “draw”
implementations for widgets that support multiple windows.
cr
must be untransformed from invoking of the draw function.
This function will return TRUE
if the contents of the given
window
are supposed to be drawn and FALSE
otherwise. Note
that when the drawing was not initiated by the windowing
system this function will return TRUE
for all windows, so
you need to draw the bottommost window first. Also, do not
use “else if” statements to check which window should be drawn.
Since: 3.0
void gtk_cairo_transform_to_window (cairo_t *cr
,GtkWidget *widget
,GdkWindow *window
);
Transforms the given cairo context cr
that from widget
-relative
coordinates to window
-relative coordinates.
If the widget
’s window is not an ancestor of window
, no
modification will be applied.
This is the inverse to the transformation GTK applies when preparing an expose event to be emitted with the “draw” signal. It is intended to help porting multiwindow widgets from GTK+ 2 to the rendering architecture of GTK+ 3.
cr |
the cairo context to transform |
|
widget |
the widget the context is currently centered for |
|
window |
the window to transform the context to |
Since: 3.0
int
gtk_widget_get_allocated_width (GtkWidget *widget
);
Returns the width that has currently been allocated to widget
.
This function is intended to be used when implementing handlers
for the “draw” function.
int
gtk_widget_get_allocated_height (GtkWidget *widget
);
Returns the height that has currently been allocated to widget
.
This function is intended to be used when implementing handlers
for the “draw” function.
void gtk_widget_get_allocation (GtkWidget *widget
,GtkAllocation *allocation
);
Retrieves the widget’s allocation.
Note, when implementing a GtkContainer: a widget’s allocation will
be its “adjusted” allocation, that is, the widget’s parent
container typically calls gtk_widget_size_allocate()
with an
allocation, and that allocation is then adjusted (to handle margin
and alignment for example) before assignment to the widget.
gtk_widget_get_allocation()
returns the adjusted allocation that
was actually assigned to the widget. The adjusted allocation is
guaranteed to be completely contained within the
gtk_widget_size_allocate()
allocation, however. So a GtkContainer
is guaranteed that its children stay inside the assigned bounds,
but not that they have exactly the bounds the container assigned.
There is no way to get the original allocation assigned by
gtk_widget_size_allocate()
, since it isn’t stored; if a container
implementation needs that information it will have to track it itself.
Since: 2.18
void gtk_widget_set_allocation (GtkWidget *widget
,const GtkAllocation *allocation
);
Sets the widget’s allocation. This should not be used directly, but from within a widget’s size_allocate method.
The allocation set should be the “adjusted” or actual
allocation. If you’re implementing a GtkContainer, you want to use
gtk_widget_size_allocate()
instead of gtk_widget_set_allocation()
.
The GtkWidgetClass::adjust_size_allocation virtual method adjusts the
allocation inside gtk_widget_size_allocate()
to create an adjusted
allocation.
Since: 2.18
int
gtk_widget_get_allocated_baseline (GtkWidget *widget
);
Returns the baseline that has currently been allocated to widget
.
This function is intended to be used when implementing handlers
for the “draw” function, and when allocating child
widgets in “size_allocate”.
Since: 3.10
void gtk_widget_get_allocated_size (GtkWidget *widget
,GtkAllocation *allocation
,int *baseline
);
Retrieves the widget’s allocated size.
This function returns the last values passed to
gtk_widget_size_allocate_with_baseline()
. The value differs from
the size returned in gtk_widget_get_allocation()
in that functions
like gtk_widget_set_halign()
can adjust the allocation, but not
the value returned by this function.
If a widget is not visible, its allocated size is 0.
widget |
||
allocation |
a pointer to a GtkAllocation to copy to. |
[out] |
baseline |
a pointer to an integer to copy to. |
[out][allow-none] |
Since: 3.20
void gtk_widget_get_clip (GtkWidget *widget
,GtkAllocation *clip
);
Retrieves the widget’s clip area.
The clip area is the area in which all of widget
's drawing will
happen. Other toolkits call it the bounding box.
Historically, in GTK+ the clip area has been equal to the allocation
retrieved via gtk_widget_get_allocation()
.
Since: 3.14
void gtk_widget_set_clip (GtkWidget *widget
,const GtkAllocation *clip
);
Sets the widget’s clip. This must not be used directly,
but from within a widget’s size_allocate method.
It must be called after gtk_widget_set_allocation()
(or after chaining up
to the parent class), because that function resets the clip.
The clip set should be the area that widget
draws on. If widget
is a
GtkContainer, the area must contain all children's clips.
If this function is not called by widget
during a ::size-allocate handler,
the clip will be set to widget
's allocation.
Since: 3.14
gboolean
gtk_widget_get_app_paintable (GtkWidget *widget
);
Determines whether the application intends to draw on the widget in an “draw” handler.
See gtk_widget_set_app_paintable()
Since: 2.18
gboolean
gtk_widget_get_can_default (GtkWidget *widget
);
Determines whether widget
can be a default widget. See
gtk_widget_set_can_default()
.
Since: 2.18
void gtk_widget_set_can_default (GtkWidget *widget
,gboolean can_default
);
Specifies whether widget
can be a default widget. See
gtk_widget_grab_default()
for details about the meaning of
“default”.
Since: 2.18
gboolean
gtk_widget_get_can_focus (GtkWidget *widget
);
Determines whether widget
can own the input focus. See
gtk_widget_set_can_focus()
.
Since: 2.18
void gtk_widget_set_can_focus (GtkWidget *widget
,gboolean can_focus
);
Specifies whether widget
can own the input focus. See
gtk_widget_grab_focus()
for actually setting the input focus on a
widget.
Since: 2.18
gboolean
gtk_widget_get_focus_on_click (GtkWidget *widget
);
Returns whether the widget should grab focus when it is clicked with the mouse.
See gtk_widget_set_focus_on_click()
.
Since: 3.20
void gtk_widget_set_focus_on_click (GtkWidget *widget
,gboolean focus_on_click
);
Sets whether the widget should grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.
Since: 3.20
gboolean
gtk_widget_get_double_buffered (GtkWidget *widget
);
gtk_widget_get_double_buffered
is deprecated and should not be used in newly-written code.
Determines whether the widget is double buffered.
See gtk_widget_set_double_buffered()
Since: 2.18
gboolean
gtk_widget_get_has_window (GtkWidget *widget
);
Determines whether widget
has a GdkWindow of its own. See
gtk_widget_set_has_window()
.
Since: 2.18
void gtk_widget_set_has_window (GtkWidget *widget
,gboolean has_window
);
Specifies whether widget
has a GdkWindow of its own. Note that
all realized widgets have a non-NULL
“window” pointer
(gtk_widget_get_window()
never returns a NULL
window when a widget
is realized), but for many of them it’s actually the GdkWindow of
one of its parent widgets. Widgets that do not create a window
for
themselves in “realize” must announce this by
calling this function with has_window
= FALSE
.
This function should only be called by widget implementations,
and they should call it in their init()
function.
Since: 2.18
gboolean
gtk_widget_get_sensitive (GtkWidget *widget
);
Returns the widget’s sensitivity (in the sense of returning
the value that has been set using gtk_widget_set_sensitive()
).
The effective sensitivity of a widget is however determined by both its
own and its parent widget’s sensitivity. See gtk_widget_is_sensitive()
.
Since: 2.18
gboolean
gtk_widget_is_sensitive (GtkWidget *widget
);
Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive
Since: 2.18
GtkStateType
gtk_widget_get_state (GtkWidget *widget
);
gtk_widget_get_state
has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_get_state_flags()
instead.
Returns the widget’s state. See gtk_widget_set_state()
.
Since: 2.18
gboolean
gtk_widget_get_visible (GtkWidget *widget
);
Determines whether the widget is visible. If you want to
take into account whether the widget’s parent is also marked as
visible, use gtk_widget_is_visible()
instead.
This function does not check if the widget is obscured in any way.
Since: 2.18
gboolean
gtk_widget_is_visible (GtkWidget *widget
);
Determines whether the widget and all its parents are marked as visible.
This function does not check if the widget is obscured in any way.
See also gtk_widget_get_visible()
and gtk_widget_set_visible()
Since: 3.8
void gtk_widget_set_visible (GtkWidget *widget
,gboolean visible
);
Sets the visibility state of widget
. Note that setting this to
TRUE
doesn’t mean the widget is actually viewable, see
gtk_widget_get_visible()
.
This function simply calls gtk_widget_show()
or gtk_widget_hide()
but is nicer to use when the visibility of the widget depends on
some condition.
Since: 2.18
void gtk_widget_set_state_flags (GtkWidget *widget
,GtkStateFlags flags
,gboolean clear
);
This function is for use in widget implementations. Turns on flag values in the current widget state (insensitive, prelighted, etc.).
This function accepts the values GTK_STATE_FLAG_DIR_LTR
and
GTK_STATE_FLAG_DIR_RTL
but ignores them. If you want to set the widget's
direction, use gtk_widget_set_direction()
.
It is worth mentioning that any other state than GTK_STATE_FLAG_INSENSITIVE
,
will be propagated down to all non-internal children if widget
is a
GtkContainer, while GTK_STATE_FLAG_INSENSITIVE
itself will be propagated
down to all GtkContainer children by different means than turning on the
state flag down the hierarchy, both gtk_widget_get_state_flags()
and
gtk_widget_is_sensitive()
will make use of these.
Since: 3.0
void gtk_widget_unset_state_flags (GtkWidget *widget
,GtkStateFlags flags
);
This function is for use in widget implementations. Turns off flag
values for the current widget state (insensitive, prelighted, etc.).
See gtk_widget_set_state_flags()
.
Since: 3.0
GtkStateFlags
gtk_widget_get_state_flags (GtkWidget *widget
);
Returns the widget state as a flag set. It is worth mentioning
that the effective GTK_STATE_FLAG_INSENSITIVE
state will be
returned, that is, also based on parent insensitivity, even if
widget
itself is sensitive.
Also note that if you are looking for a way to obtain the
GtkStateFlags to pass to a GtkStyleContext method, you
should look at gtk_style_context_get_state()
.
Since: 3.0
gboolean
gtk_widget_has_default (GtkWidget *widget
);
Determines whether widget
is the current default widget within its
toplevel. See gtk_widget_set_can_default()
.
Since: 2.18
gboolean
gtk_widget_has_focus (GtkWidget *widget
);
Determines if the widget has the global input focus. See
gtk_widget_is_focus()
for the difference between having the global
input focus, and only having the focus within a toplevel.
Since: 2.18
gboolean
gtk_widget_has_visible_focus (GtkWidget *widget
);
Determines if the widget should show a visible indication that
it has the global input focus. This is a convenience function for
use in ::draw handlers that takes into account whether focus
indication should currently be shown in the toplevel window of
widget
. See gtk_window_get_focus_visible()
for more information
about focus indication.
To find out if the widget has the global input focus, use
gtk_widget_has_focus()
.
Since: 3.2
gboolean
gtk_widget_has_grab (GtkWidget *widget
);
Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse).
See also gtk_grab_add()
.
Since: 2.18
gboolean
gtk_widget_has_rc_style (GtkWidget *widget
);
gtk_widget_has_rc_style
has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead
Determines if the widget style has been looked up through the rc mechanism.
Since: 2.20
gboolean
gtk_widget_is_drawable (GtkWidget *widget
);
Determines whether widget
can be drawn to. A widget can be drawn
to if it is mapped and visible.
Since: 2.18
gboolean
gtk_widget_is_toplevel (GtkWidget *widget
);
Determines whether widget
is a toplevel widget.
Currently only GtkWindow and GtkInvisible (and out-of-process GtkPlugs) are toplevel widgets. Toplevel widgets have no parent widget.
Since: 2.18
void gtk_widget_set_window (GtkWidget *widget
,GdkWindow *window
);
Sets a widget’s window. This function should only be used in a
widget’s “realize” implementation. The window
passed is
usually either new window created with gdk_window_new()
, or the
window of its parent widget as returned by
gtk_widget_get_parent_window()
.
Widgets must indicate whether they will create their own GdkWindow
by calling gtk_widget_set_has_window()
. This is usually done in the
widget’s init()
function.
Note that this function does not add any reference to window
.
Since: 2.18
void gtk_widget_set_receives_default (GtkWidget *widget
,gboolean receives_default
);
Specifies whether widget
will be treated as the default widget
within its toplevel when it has the focus, even if another widget
is the default.
See gtk_widget_grab_default()
for details about the meaning of
“default”.
Since: 2.18
gboolean
gtk_widget_get_receives_default (GtkWidget *widget
);
Determines whether widget
is always treated as the default widget
within its toplevel when it has the focus, even if another widget
is the default.
See gtk_widget_set_receives_default()
.
Since: 2.18
void gtk_widget_set_support_multidevice (GtkWidget *widget
,gboolean support_multidevice
);
Enables or disables multiple pointer awareness. If this setting is TRUE
,
widget
will start receiving multiple, per device enter/leave events. Note
that if custom GdkWindows are created in “realize”,
gdk_window_set_support_multidevice()
will have to be called manually on them.
Since: 3.0
gboolean
gtk_widget_get_support_multidevice (GtkWidget *widget
);
Returns TRUE
if widget
is multiple pointer aware. See
gtk_widget_set_support_multidevice()
for more information.
void gtk_widget_set_realized (GtkWidget *widget
,gboolean realized
);
Marks the widget as being realized. This function must only be
called after all GdkWindows for the widget
have been created
and registered.
This function should only ever be called in a derived widget's “realize” or “unrealize” implementation.
Since: 2.20
gboolean
gtk_widget_get_realized (GtkWidget *widget
);
Determines whether widget
is realized.
Since: 2.20
void gtk_widget_set_mapped (GtkWidget *widget
,gboolean mapped
);
Marks the widget as being realized.
This function should only ever be called in a derived widget's “map” or “unmap” implementation.
Since: 2.20
gboolean
gtk_widget_get_mapped (GtkWidget *widget
);
Whether the widget is mapped.
Since: 2.20
void gtk_widget_get_requisition (GtkWidget *widget
,GtkRequisition *requisition
);
gtk_widget_get_requisition
has been deprecated since version 3.0 and should not be used in newly-written code.
The GtkRequisition cache on the widget was removed, If you need to cache sizes across requests and allocations, add an explicit cache to the widget in question instead.
Retrieves the widget’s requisition.
This function should only be used by widget implementations in
order to figure whether the widget’s requisition has actually
changed after some internal state change (so that they can call
gtk_widget_queue_resize()
instead of gtk_widget_queue_draw()
).
Normally, gtk_widget_size_request()
should be used.
Since: 2.20
gboolean gtk_widget_device_is_shadowed (GtkWidget *widget
,GdkDevice *device
);
Returns TRUE
if device
has been shadowed by a GTK+
device grab on another widget, so it would stop sending
events to widget
. This may be used in the
“grab-notify” signal to check for specific
devices. See gtk_device_grab_add()
.
Since: 3.0
GdkModifierType gtk_widget_get_modifier_mask (GtkWidget *widget
,GdkModifierIntent intent
);
Returns the modifier mask the widget
’s windowing system backend
uses for a particular purpose.
See gdk_keymap_get_modifier_mask()
.
Since: 3.4
void gtk_widget_insert_action_group (GtkWidget *widget
,const gchar *name
,GActionGroup *group
);
Inserts group
into widget
. Children of widget
that implement
GtkActionable can then be associated with actions in group
by
setting their “action-name” to
prefix
.action-name
.
If group
is NULL
, a previously inserted group for name
is removed
from widget
.
Since: 3.6
double
gtk_widget_get_opacity (GtkWidget *widget
);
Fetches the requested opacity for this widget.
See gtk_widget_set_opacity()
.
Since: 3.8
void gtk_widget_set_opacity (GtkWidget *widget
,double opacity
);
Request the widget
to be rendered partially transparent,
with opacity 0 being fully transparent and 1 fully opaque. (Opacity values
are clamped to the [0,1] range.).
This works on both toplevel widget, and child widgets, although there
are some limitations:
For toplevel widgets this depends on the capabilities of the windowing
system. On X11 this has any effect only on X screens with a compositing manager
running. See gtk_widget_is_composited()
. On Windows it should work
always, although setting a window’s opacity after the window has been
shown causes it to flicker once on Windows.
For child widgets it doesn’t work if any affected widget has a native window, or disables double buffering.
Since: 3.8
const gchar **
gtk_widget_list_action_prefixes (GtkWidget *widget
);
Retrieves a NULL
-terminated array of strings containing the prefixes of
GActionGroup's available to widget
.
Since: 3.16
GActionGroup * gtk_widget_get_action_group (GtkWidget *widget
,const gchar *prefix
);
Retrieves the GActionGroup that was registered using prefix
. The resulting
GActionGroup may have been registered to widget
or any GtkWidget in its
ancestry.
If no action group was found matching prefix
, then NULL
is returned.
Since: 3.16
GtkWidgetPath *
gtk_widget_get_path (GtkWidget *widget
);
Returns the GtkWidgetPath representing widget
, if the widget
is not connected to a toplevel widget, a partial path will be
created.
GtkStyleContext *
gtk_widget_get_style_context (GtkWidget *widget
);
Returns the style context associated to widget
. The returned object is
guaranteed to be the same for the lifetime of widget
.
void
gtk_widget_reset_style (GtkWidget *widget
);
Updates the style context of widget
and all descendants
by updating its widget path. GtkContainers may want
to use this on a child when reordering it in a way that a different
style might apply to it. See also gtk_container_get_path_for_child()
.
Since: 3.0
const char *
gtk_widget_class_get_css_name (GtkWidgetClass *widget_class
);
Gets the name used by this class for matching in CSS code. See
gtk_widget_class_set_css_name()
for details.
Since: 3.20
void gtk_widget_class_set_css_name (GtkWidgetClass *widget_class
,const char *name
);
Sets the name to be used for CSS matching of widgets.
If this function is not called for a given class, the name of the parent class is used.
Since: 3.20
GtkRequisition *
gtk_requisition_new (void
);
Allocates a new GtkRequisition and initializes its elements to zero.
a new empty GtkRequisition. The newly allocated GtkRequisition should
be freed with gtk_requisition_free()
.
Since: 3.0
GtkRequisition *
gtk_requisition_copy (const GtkRequisition *requisition
);
Copies a GtkRequisition.
void
gtk_requisition_free (GtkRequisition *requisition
);
Frees a GtkRequisition.
void gtk_widget_get_preferred_height (GtkWidget *widget
,gint *minimum_height
,gint *natural_height
);
Retrieves a widget’s initial minimum and natural height.
This call is specific to width-for-height requests.
The returned request will be modified by the GtkWidgetClass::adjust_size_request virtual method and by any GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.
Since: 3.0
void gtk_widget_get_preferred_width (GtkWidget *widget
,gint *minimum_width
,gint *natural_width
);
Retrieves a widget’s initial minimum and natural width.
This call is specific to height-for-width requests.
The returned request will be modified by the GtkWidgetClass::adjust_size_request virtual method and by any GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.
Since: 3.0
void gtk_widget_get_preferred_height_for_width (GtkWidget *widget
,gint width
,gint *minimum_height
,gint *natural_height
);
Retrieves a widget’s minimum and natural height if it would be given
the specified width
.
The returned request will be modified by the GtkWidgetClass::adjust_size_request virtual method and by any GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.
Since: 3.0
void gtk_widget_get_preferred_width_for_height (GtkWidget *widget
,gint height
,gint *minimum_width
,gint *natural_width
);
Retrieves a widget’s minimum and natural width if it would be given
the specified height
.
The returned request will be modified by the GtkWidgetClass::adjust_size_request virtual method and by any GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.
Since: 3.0
void gtk_widget_get_preferred_height_and_baseline_for_width (GtkWidget *widget
,gint width
,gint *minimum_height
,gint *natural_height
,gint *minimum_baseline
,gint *natural_baseline
);
Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given
the specified width
, or the default height if width
is -1. The baselines may be -1 which means
that no baseline is requested for this widget.
The returned request will be modified by the GtkWidgetClass::adjust_size_request and GtkWidgetClass::adjust_baseline_request virtual methods and by any GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.
widget |
a GtkWidget instance |
|
width |
the width which is available for allocation, or -1 if none |
|
minimum_height |
location for storing the minimum height, or |
[out][allow-none] |
natural_height |
location for storing the natural height, or |
[out][allow-none] |
minimum_baseline |
location for storing the baseline for the minimum height, or |
[out][allow-none] |
natural_baseline |
location for storing the baseline for the natural height, or |
[out][allow-none] |
Since: 3.10
GtkSizeRequestMode
gtk_widget_get_request_mode (GtkWidget *widget
);
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
GtkBin widgets generally propagate the preference of their child, container widgets need to request something either in context of their children or in context of their allocation capabilities.
Since: 3.0
void gtk_widget_get_preferred_size (GtkWidget *widget
,GtkRequisition *minimum_size
,GtkRequisition *natural_size
);
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
This is used to retrieve a suitable size by container widgets which do not impose any restrictions on the child placement. It can be used to deduce toplevel window and menu sizes as well as child widgets in free-form containers such as GtkLayout.
Handle with care. Note that the natural height of a height-for-width widget will generally be a smaller size than the minimum height, since the required height for the natural width is generally smaller than the required height for the minimum width.
Use gtk_widget_get_preferred_height_and_baseline_for_width()
if you want to support
baseline alignment.
Since: 3.0
gint gtk_distribute_natural_allocation (gint extra_space
,guint n_requested_sizes
,GtkRequestedSize *sizes
);
Distributes extra_space
to child sizes
by bringing smaller
children up to natural size first.
The remaining space will be added to the minimum_size
member of the
GtkRequestedSize struct. If all sizes reach their natural size then
the remaining space is returned.
extra_space |
Extra space to redistribute among children after subtracting minimum sizes and any child padding from the overall allocation |
|
n_requested_sizes |
Number of requests to fit into the allocation |
|
sizes |
An array of structs with a client pointer and a minimum/natural size in the orientation of the allocation. |
GtkAlign
gtk_widget_get_halign (GtkWidget *widget
);
Gets the value of the “halign” property.
For backwards compatibility reasons this method will never return
GTK_ALIGN_BASELINE
, but instead it will convert it to
GTK_ALIGN_FILL
. Baselines are not supported for horizontal
alignment.
void gtk_widget_set_halign (GtkWidget *widget
,GtkAlign align
);
Sets the horizontal alignment of widget
.
See the “halign” property.
GtkAlign
gtk_widget_get_valign (GtkWidget *widget
);
Gets the value of the “valign” property.
For backwards compatibility reasons this method will never return
GTK_ALIGN_BASELINE
, but instead it will convert it to
GTK_ALIGN_FILL
. If your widget want to support baseline aligned
children it must use gtk_widget_get_valign_with_baseline()
, or
g_object_get (widget, "valign", &value, NULL)
, which will
also report the true value.
GtkAlign
gtk_widget_get_valign_with_baseline (GtkWidget *widget
);
Gets the value of the “valign” property, including
GTK_ALIGN_BASELINE
.
Since: 3.10
void gtk_widget_set_valign (GtkWidget *widget
,GtkAlign align
);
Sets the vertical alignment of widget
.
See the “valign” property.
gint
gtk_widget_get_margin_left (GtkWidget *widget
);
gtk_widget_get_margin_left
has been deprecated since version 3.12 and should not be used in newly-written code.
Use gtk_widget_get_margin_start()
instead.
Gets the value of the “margin-left” property.
Since: 3.0
void gtk_widget_set_margin_left (GtkWidget *widget
,gint margin
);
gtk_widget_set_margin_left
has been deprecated since version 3.12 and should not be used in newly-written code.
Use gtk_widget_set_margin_start()
instead.
Sets the left margin of widget
.
See the “margin-left” property.
Since: 3.0
gint
gtk_widget_get_margin_right (GtkWidget *widget
);
gtk_widget_get_margin_right
has been deprecated since version 3.12 and should not be used in newly-written code.
Use gtk_widget_get_margin_end()
instead.
Gets the value of the “margin-right” property.
Since: 3.0
void gtk_widget_set_margin_right (GtkWidget *widget
,gint margin
);
gtk_widget_set_margin_right
has been deprecated since version 3.12 and should not be used in newly-written code.
Use gtk_widget_set_margin_end()
instead.
Sets the right margin of widget
.
See the “margin-right” property.
Since: 3.0
gint
gtk_widget_get_margin_start (GtkWidget *widget
);
Gets the value of the “margin-start” property.
Since: 3.12
void gtk_widget_set_margin_start (GtkWidget *widget
,gint margin
);
Sets the start margin of widget
.
See the “margin-start” property.
Since: 3.12
gint
gtk_widget_get_margin_end (GtkWidget *widget
);
Gets the value of the “margin-end” property.
Since: 3.12
void gtk_widget_set_margin_end (GtkWidget *widget
,gint margin
);
Sets the end margin of widget
.
See the “margin-end” property.
Since: 3.12
gint
gtk_widget_get_margin_top (GtkWidget *widget
);
Gets the value of the “margin-top” property.
Since: 3.0
void gtk_widget_set_margin_top (GtkWidget *widget
,gint margin
);
Sets the top margin of widget
.
See the “margin-top” property.
Since: 3.0
gint
gtk_widget_get_margin_bottom (GtkWidget *widget
);
Gets the value of the “margin-bottom” property.
Since: 3.0
void gtk_widget_set_margin_bottom (GtkWidget *widget
,gint margin
);
Sets the bottom margin of widget
.
See the “margin-bottom” property.
Since: 3.0
gboolean
gtk_widget_get_hexpand (GtkWidget *widget
);
Gets whether the widget would like any available extra horizontal space. When a user resizes a GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
Containers should use gtk_widget_compute_expand()
rather than
this function, to see whether a widget, or any of its children,
has the expand flag set. If any child of a widget wants to
expand, the parent may ask to expand also.
This function only looks at the widget’s own hexpand flag, rather than computing whether the entire widget tree rooted at this widget wants to expand.
void gtk_widget_set_hexpand (GtkWidget *widget
,gboolean expand
);
Sets whether the widget would like any available extra horizontal space. When a user resizes a GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
Call this function to set the expand flag if you would like your widget to become larger horizontally when the window has extra room.
By default, widgets automatically expand if any of their children
want to expand. (To see if a widget will automatically expand given
its current children and state, call gtk_widget_compute_expand()
. A
container can decide how the expandability of children affects the
expansion of the container by overriding the compute_expand virtual
method on GtkWidget.).
Setting hexpand explicitly with this function will override the automatic expand behavior.
This function forces the widget to expand or not to expand,
regardless of children. The override occurs because
gtk_widget_set_hexpand()
sets the hexpand-set property (see
gtk_widget_set_hexpand_set()
) which causes the widget’s hexpand
value to be used, rather than looking at children and widget state.
gboolean
gtk_widget_get_hexpand_set (GtkWidget *widget
);
Gets whether gtk_widget_set_hexpand()
has been used to
explicitly set the expand flag on this widget.
If hexpand is set, then it overrides any computed expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand.
There are few reasons to use this function, but it’s here for completeness and consistency.
void gtk_widget_set_hexpand_set (GtkWidget *widget
,gboolean set
);
Sets whether the hexpand flag (see gtk_widget_get_hexpand()
) will
be used.
The hexpand-set property will be set automatically when you call
gtk_widget_set_hexpand()
to set hexpand, so the most likely
reason to use this function would be to unset an explicit expand
flag.
If hexpand is set, then it overrides any computed expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand.
There are few reasons to use this function, but it’s here for completeness and consistency.
gboolean
gtk_widget_get_vexpand (GtkWidget *widget
);
Gets whether the widget would like any available extra vertical space.
See gtk_widget_get_hexpand()
for more detail.
void gtk_widget_set_vexpand (GtkWidget *widget
,gboolean expand
);
Sets whether the widget would like any available extra vertical space.
See gtk_widget_set_hexpand()
for more detail.
gboolean
gtk_widget_get_vexpand_set (GtkWidget *widget
);
Gets whether gtk_widget_set_vexpand()
has been used to
explicitly set the expand flag on this widget.
See gtk_widget_get_hexpand_set()
for more detail.
void gtk_widget_set_vexpand_set (GtkWidget *widget
,gboolean set
);
Sets whether the vexpand flag (see gtk_widget_get_vexpand()
) will
be used.
See gtk_widget_set_hexpand_set()
for more detail.
void
gtk_widget_queue_compute_expand (GtkWidget *widget
);
Mark widget
as needing to recompute its expand flags. Call
this function when setting legacy expand child properties
on the child of a container.
gboolean gtk_widget_compute_expand (GtkWidget *widget
,GtkOrientation orientation
);
Computes whether a container should give this widget extra space
when possible. Containers should check this, rather than
looking at gtk_widget_get_hexpand()
or gtk_widget_get_vexpand()
.
This function already checks whether the widget is visible, so visibility does not need to be checked separately. Non-visible widgets are not expanded.
The computed expand value uses either the expand setting explicitly set on the widget itself, or, if none has been explicitly set, the widget may expand if some of its children do.
void
gtk_widget_init_template (GtkWidget *widget
);
Creates and initializes child widgets defined in templates. This
function must be called in the instance initializer for any
class which assigned itself a template using gtk_widget_class_set_template()
It is important to call this function in the instance initializer
of a GtkWidget subclass and not in GObject.constructed()
or
GObject.constructor()
for two reasons.
One reason is that generally derived widgets will assume that parent class composite widgets have been created in their instance initializers.
Another reason is that when calling g_object_new()
on a widget with
composite templates, it’s important to build the composite widgets
before the construct properties are set. Properties passed to g_object_new()
should take precedence over properties set in the private template XML.
Since: 3.10
void gtk_widget_class_set_template (GtkWidgetClass *widget_class
,GBytes *template_bytes
);
This should be called at class initialization time to specify the GtkBuilder XML to be used to extend a widget.
For convenience, gtk_widget_class_set_template_from_resource()
is also provided.
Note that any class that installs templates must call gtk_widget_init_template()
in the widget’s instance initializer.
Since: 3.10
void gtk_widget_class_set_template_from_resource (GtkWidgetClass *widget_class
,const gchar *resource_name
);
A convenience function to call gtk_widget_class_set_template()
.