~bratsche/ubuntu/maverick/gtk+2.0/menu-activation-fix

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GtkWidget"><type>GtkWidget</type></link> of type <parameter>widget_type</parameter>

1273

1287

</simpara></listitem></varlistentry>

1274

1288

</variablelist></refsect2>

1275

1289

1276

<title><anchor id="gtk-widget-ref" role="function"/>gtk_widget_ref ()</title>

1277

<indexterm><primary>gtk_widget_ref</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_widget_ref (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

1290

<title><anchor id="gtk-widget-ref" role="function" condition="deprecated:Use g_object_ref() instead."/>gtk_widget_ref ()</title>

1291

<indexterm role="deprecated"><primary>gtk_widget_ref</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_widget_ref (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

1292

<warning><para><literal>gtk_widget_ref</literal> is deprecated and should not be used in newly-written code. Use <link linkend="g-object-ref"><function>g_object_ref()</function></link> instead.</para></warning>

1278

1293

<para>

1279

1294

Adds a reference to a widget. This function is exactly the same

1280

1295

as calling <link linkend="g-object-ref"><function>g_object_ref()</function></link>, and exists mostly for historical

1287

1302

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

1288

1303

</simpara></listitem></varlistentry>

1289

1304

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the widget that was referenced

1305

1290

1306

</simpara></listitem></varlistentry>

1291

1307

</variablelist></refsect2>

1292

1308

1293

<title><anchor id="gtk-widget-unref" role="function"/>gtk_widget_unref ()</title>

1294

<indexterm><primary>gtk_widget_unref</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_unref (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

1309

<title><anchor id="gtk-widget-unref" role="function" condition="deprecated:Use g_object_unref() instead."/>gtk_widget_unref ()</title>

1310

<indexterm role="deprecated"><primary>gtk_widget_unref</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_unref (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

1311

<warning><para><literal>gtk_widget_unref</literal> is deprecated and should not be used in newly-written code. Use <link linkend="g-object-unref"><function>g_object_unref()</function></link> instead.</para></warning>

1295

1312

<para>

1296

1313

Inverse of <link linkend="gtk-widget-ref"><function>gtk_widget_ref()</function></link>. Equivalent to <link linkend="g-object-unref"><function>g_object_unref()</function></link>.</para>

1297

1314

<para>

1350

1367

</simpara></listitem></varlistentry>

1351

1368

</variablelist></refsect2>

1352

1369

1353

<title><anchor id="gtk-widget-set" role="function" condition="deprecated:"/>gtk_widget_set ()</title>

1370

<title><anchor id="gtk-widget-set" role="function" condition="deprecated:Use g_object_set() instead."/>gtk_widget_set ()</title>

1354

1371

<indexterm role="deprecated"><primary>gtk_widget_set</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_set (<link linkend="GtkWidget">GtkWidget</link> *widget,

1355

1372

const <link linkend="gchar">gchar</link> *first_property_name,

1356

1373

...);</programlisting>

1357

<warning><para><literal>gtk_widget_set</literal> is deprecated and should not be used in newly-written code.</para></warning>

1374

<warning><para><literal>gtk_widget_set</literal> is deprecated and should not be used in newly-written code. Use <link linkend="g-object-set"><function>g_object_set()</function></link> instead.</para></warning>

1358

1375

<para>

1359

Like <link linkend="g-object-set"><function>g_object_set()</function></link> - there's no reason to use this instead of

1360

1376

Precursor of <link linkend="g-object-set"><function>g_object_set()</function></link>.</para>

1361

1377

<para>

1362

1378

1363

1379

</para><variablelist role="params">

1368

1384

<listitem><simpara> name of first property to set

1369

1385

</simpara></listitem></varlistentry>

1370

1386

1371

<listitem><simpara> value of first property, followed by more properties, <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated

1387

<listitem><simpara> value of first property, followed by more properties,

1388

1372

1389

</simpara></listitem></varlistentry>

1373

1390

</variablelist></refsect2>

1374

1391

1511

1528

isn't very useful otherwise. Many times when you think you might

1512

1529

need it, a better approach is to connect to a signal that will be

1513

1530

called after the widget is realized automatically, such as

1514

"expose_event". Or simply <link linkend="g-signal-connect-after"><function>g_signal_connect_after()</function></link> to the

1515

"realize" signal.</para>

1531

GtkWidget::expose-event. Or simply <link linkend="g-signal-connect-after"><function>g_signal_connect_after()</function></link> to the

1532

GtkWidget::realize signal.</para>

1516

1533

<para>

1517

1534

1518

1535

</para><variablelist role="params">

1567

1584

<title><anchor id="gtk-widget-queue-resize-no-redraw" role="function" condition="since:2.4"/>gtk_widget_queue_resize_no_redraw ()</title>

1568

1585

<indexterm role="2.4"><primary>gtk_widget_queue_resize_no_redraw</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_queue_resize_no_redraw (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

1569

1586

<para>

1570

This function works like <link linkend="gtk-widget-queue-resize"><function>gtk_widget_queue_resize()</function></link>, except that the

1571

widget is not invalidated.</para>

1587

This function works like <link linkend="gtk-widget-queue-resize"><function>gtk_widget_queue_resize()</function></link>,

1588

except that the widget is not invalidated.</para>

1572

1589

<para>

1573

1590

1574

1591

</para><variablelist role="params">

1767

1784

</para>

1768

1785

<para>

1769

1786

This function is a low level function that would most likely

1770

be used by a menu creation system like <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>. If you

1771

use <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>, setting up accelerator paths will be done

1787

be used by a menu creation system like <link linkend="GtkUIManager"><type>GtkUIManager</type></link>. If you

1788

use <link linkend="GtkUIManager"><type>GtkUIManager</type></link>, setting up accelerator paths will be done

1772

1789

automatically.

1773

1790

</para>

1774

1791

<para>

1775

Even when you you aren't using <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>, if you only want to

1792

Even when you you aren't using <link linkend="GtkUIManager"><type>GtkUIManager</type></link>, if you only want to

1776

1793

set up accelerators on menu items <link linkend="gtk-menu-item-set-accel-path"><function>gtk_menu_item_set_accel_path()</function></link>

1777

1794

provides a somewhat more convenient interface.</para>

1778

1795

<para>

1795

1812

Lists the closures used by <parameter>widget</parameter> for accelerator group connections

1796

1813

with <link linkend="gtk-accel-group-connect-by-path"><function>gtk_accel_group_connect_by_path()</function></link> or <link linkend="gtk-accel-group-connect"><function>gtk_accel_group_connect()</function></link>.

1797

1814

The closures can be used to monitor accelerator changes on <parameter>widget</parameter>,

1798

by connecting to the ::accel_changed signal of the <link linkend="GtkAccelGroup"><type>GtkAccelGroup</type></link> of a

1799

closure which can be found out with <link linkend="gtk-accel-group-from-accel-closure"><function>gtk_accel_group_from_accel_closure()</function></link>.</para>

1815

by connecting to the <parameter>GtkAccelGroup</parameter>::accel-changed signal of the

1816

1817

1800

1818

<para>

1801

1819

1802

1820

</para><variablelist role="params">

1813

1831

<para>

1814

1832

Determines whether an accelerator that activates the signal

1815

1833

identified by <parameter>signal_id</parameter> can currently be activated.

1816

This is done by emitting the GtkWidget::can-activate-accel

1834

This is done by emitting the <link linkend="GtkWidget-can-activate-accel"><type>::can-activate-accel</type></link>

1817

1835

signal on <parameter>widget</parameter>; if the signal isn't overridden by a

1818

1836

handler or in a derived widget, then the default check is

1819

1837

that the widget must be sensitive, and the widget and all

1854

1872

<varlistentry><term><parameter>event</parameter> :</term>

1855

1873

<listitem><simpara> a <link linkend="GdkEvent"><type>GdkEvent</type></link>

1856

1874

</simpara></listitem></varlistentry>

1857

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> return from the event signal emission (<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the event was handled)

1875

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> return from the event signal emission (<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if

1876

the event was handled)

1858

1877

</simpara></listitem></varlistentry>

1859

1878

</variablelist></refsect2>

1860

1879

1955

1974

Causes <parameter>widget</parameter> to become the default widget. <parameter>widget</parameter> must have the

1956

1975

1957

1976

yourself by calling <literal>GTK_WIDGET_SET_FLAGS (<parameter>widget</parameter>,

1958

GTK_CAN_DEFAULT)</literal>. The default widget is activated when the user

1959

presses Enter in a window. Default widgets must be activatable,

1960

that is, <link linkend="gtk-widget-activate"><function>gtk_widget_activate()</function></link> should affect them.</para>

1977

GTK_CAN_DEFAULT)</literal>. The default widget is activated when

1978

the user presses Enter in a window. Default widgets must be

1979

activatable, that is, <link linkend="gtk-widget-activate"><function>gtk_widget_activate()</function></link> should affect them.</para>

1961

1980

<para>

1962

1981

1963

1982

</para><variablelist role="params">

2046

2065

<indexterm><primary>gtk_widget_set_parent</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_set_parent (<link linkend="GtkWidget">GtkWidget</link> *widget,

2047

2066

2048

2067

<para>

2049

This function is useful only when implementing subclasses of <link linkend="GtkContainer"><type>GtkContainer</type></link>.

2068

This function is useful only when implementing subclasses of

2069

2050

2070

Sets the container as the parent of <parameter>widget</parameter>, and takes care of

2051

2071

some details such as updating the state and style of the child

2052

2072

to reflect its new location. The opposite function is

2129

2149

</simpara></listitem></varlistentry>

2130

2150

</variablelist></refsect2>

2131

2151

2132

<title><anchor id="gtk-widget-set-usize" role="function" condition="deprecated:"/>gtk_widget_set_usize ()</title>

2152

<title><anchor id="gtk-widget-set-usize" role="function" condition="deprecated:Use gtk_widget_set_size_request() instead."/>gtk_widget_set_usize ()</title>

2133

2153

<indexterm role="deprecated"><primary>gtk_widget_set_usize</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_set_usize (<link linkend="GtkWidget">GtkWidget</link> *widget,

2134

2154

2135

2155

2136

<warning><para><literal>gtk_widget_set_usize</literal> is deprecated and should not be used in newly-written code.</para></warning>

2156

<warning><para><literal>gtk_widget_set_usize</literal> is deprecated and should not be used in newly-written code. Use <link linkend="gtk-widget-set-size-request"><function>gtk_widget_set_size_request()</function></link> instead.</para></warning>

2137

2157

<para>

2138

2158

Sets the minimum size of a widget; that is, the widget's size

2139

2159

request will be <parameter>width</parameter> by <parameter>height</parameter>. You can use this function to

2152

2172

translations into other languages, different fonts, and user action

2153

2173

can all change the appropriate size for a given widget. So, it's

2154

2174

basically impossible to hardcode a size that will always be

2155

correct.

2156

</para>

2157

<para>

2158

<parameter>Deprecated</parameter>: Use <link linkend="gtk-widget-set-size-request"><function>gtk_widget_set_size_request()</function></link> instead.</para>

2175

correct.</para>

2159

2176

<para>

2160

2177

2161

2178

</para><variablelist role="params">

2279

2296

<varlistentry><term><parameter>widget</parameter> :</term>

2280

2297

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

2281

2298

</simpara></listitem></varlistentry>

2282

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the topmost ancestor of <parameter>widget</parameter>, or <parameter>widget</parameter> itself if there's no ancestor.

2299

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the topmost ancestor of <parameter>widget</parameter>, or <parameter>widget</parameter> itself

2300

if there's no ancestor.

2283

2301

</simpara></listitem></varlistentry>

2284

2302

</variablelist></refsect2>

2285

2303

2288

2306

2289

2307

<para>

2290

2308

Gets the first ancestor of <parameter>widget</parameter> with type <parameter>widget_type</parameter>. For example,

2291

<literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets the

2292

first <link linkend="GtkBox"><type>GtkBox</type></link> that's

2293

an ancestor of <parameter>widget</parameter>. No reference will be added to the returned widget;

2294

it should not be unreferenced. See note about checking for a toplevel

2295

2309

<literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets

2310

the first <link linkend="GtkBox"><type>GtkBox</type></link> that's an ancestor of <parameter>widget</parameter>. No reference will be

2311

added to the returned widget; it should not be unreferenced. See note

2312

about checking for a toplevel <link linkend="GtkWindow"><type>GtkWindow</type></link> in the docs for

2313

2296

2314

</para>

2297

2315

<para>

2298

2316

Note that unlike <link linkend="gtk-widget-is-ancestor"><function>gtk_widget_is_ancestor()</function></link>, <link linkend="gtk-widget-get-ancestor"><function>gtk_widget_get_ancestor()</function></link>

2413

2431

<varlistentry><term><parameter>ancestor</parameter> :</term>

2414

2432

<listitem><simpara> another <link linkend="GtkWidget"><type>GtkWidget</type></link>

2415

2433

</simpara></listitem></varlistentry>

2416

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>ancestor</parameter> contains <parameter>widget</parameter> as a child, grandchild, great grandchild, etc.

2434

2435

grandchild, great grandchild, etc.

2417

2436

</simpara></listitem></varlistentry>

2418

2437

</variablelist></refsect2>

2419

2438

2459

2478

<title><anchor id="gtk-widget-hide-on-delete" role="function"/>gtk_widget_hide_on_delete ()</title>

2460

2479

<indexterm><primary>gtk_widget_hide_on_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gtk_widget_hide_on_delete (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

2461

2480

<para>

2462

Utility function; intended to be connected to the "delete_event"

2481

Utility function; intended to be connected to the <link linkend="GtkWidget-delete-event"><type>::delete-event</type></link>

2463

2482

signal on a <link linkend="GtkWindow"><type>GtkWindow</type></link>. The function calls <link linkend="gtk-widget-hide"><function>gtk_widget_hide()</function></link> on its

2464

argument, then returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. If connected to "delete_event", the

2483

argument, then returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. If connected to ::delete-event, the

2465

2484

result is that clicking the close button for a window (on the

2466

2485

window frame, top right corner usually) will hide but not destroy

2467

the window. By default, GTK+ destroys windows when "delete_event"

2486

the window. By default, GTK+ destroys windows when ::delete-event

2468

2487

is received.</para>

2469

2488

<para>

2470

2489

2614

2633

<para>

2615

2634

2616

2635

</para><variablelist role="params">

2617

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the default style. This <link linkend="GtkStyle"><type>GtkStyle</type></link> object is owned by GTK+ and

2618

should not be modified or freed.

2636

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the default style. This <link linkend="GtkStyle"><type>GtkStyle</type></link> object is owned

2637

by GTK+ and should not be modified or freed.

2619

2638

</simpara></listitem></varlistentry>

2620

2639

</variablelist></refsect2>

2621

2640

2736

2755

2737

2756

</para><variablelist role="params">

2738

2757

<varlistentry><term><parameter>widget</parameter> :</term>

2739

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>.

2758

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

2740

2759

</simpara></listitem></varlistentry>

2741

2760

<varlistentry><term><parameter>shape_mask</parameter> :</term>

2742

<listitem><simpara> shape to be added, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to remove an existing shape.

2761

<listitem><simpara> shape to be added, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to remove an existing shape

2743

2762

</simpara></listitem></varlistentry>

2744

2763

<varlistentry><term><parameter>offset_x</parameter> :</term>

2745

<listitem><simpara> X position of shape mask with respect to <parameter>window</parameter>.

2764

<listitem><simpara> X position of shape mask with respect to <parameter>window</parameter>

2746

2765

</simpara></listitem></varlistentry>

2747

2766

<varlistentry><term><parameter>offset_y</parameter> :</term>

2748

<listitem><simpara> Y position of shape mask with respect to <parameter>window</parameter>.

2767

<listitem><simpara> Y position of shape mask with respect to <parameter>window</parameter>

2749

2768

</simpara></listitem></varlistentry>

2750

2769

</variablelist></refsect2>

2751

2770

2762

2781

2763

2782

</para><variablelist role="params">

2764

2783

<varlistentry><term><parameter>widget</parameter> :</term>

2765

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>.

2784

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

2766

2785

</simpara></listitem></varlistentry>

2767

2786

<varlistentry><term><parameter>shape_mask</parameter> :</term>

2768

<listitem><simpara> shape to be added, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to remove an existing shape.

2787

<listitem><simpara> shape to be added, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to remove an existing shape

2769

2788

</simpara></listitem></varlistentry>

2770

2789

<varlistentry><term><parameter>offset_x</parameter> :</term>

2771

<listitem><simpara> X position of shape mask with respect to <parameter>window</parameter>.

2790

<listitem><simpara> X position of shape mask with respect to <parameter>window</parameter>

2772

2791

</simpara></listitem></varlistentry>

2773

2792

<varlistentry><term><parameter>offset_y</parameter> :</term>

2774

<listitem><simpara> Y position of shape mask with respect to <parameter>window</parameter>.

2793

<listitem><simpara> Y position of shape mask with respect to <parameter>window</parameter>

2775

2794

</simpara></listitem></varlistentry>

2776

2795

</variablelist><para role="since">Since 2.10

2777

2796

</para></refsect2>

2786

2805

widget and all its parents in the container hierarchy, separated by

2787

2806

periods. The name of a widget comes from

2788

2807

2789

in gtkrc configuration files. Widget names are the type of the

2808

in gtkrc configuration files. Widget names are the type of the

2790

2809

widget by default (e.g. "GtkButton") or can be set to an

2791

application-specific value with <link linkend="gtk-widget-set-name"><function>gtk_widget_set_name()</function></link>. By setting

2810

application-specific value with <link linkend="gtk-widget-set-name"><function>gtk_widget_set_name()</function></link>. By setting

2792

2811

the name of a widget, you allow users or theme authors to apply

2793

2812

styles to that specific widget in their gtkrc

2794

2813

file. <parameter>path_reversed_p</parameter> fills in the path in reverse order,

2832

2851

<listitem><simpara> location to store the class path as an allocated string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>

2833

2852

</simpara></listitem></varlistentry>

2834

2853

<varlistentry><term><parameter>path_reversed</parameter> :</term>

2835

<listitem><simpara> location to store the reverse class path as an allocated string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>

2854

<listitem><simpara> location to store the reverse class path as an allocated

2855

string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>

2836

2856

</simpara></listitem></varlistentry>

2837

2857

</variablelist></refsect2>

2838

2858

2844

2864

2845

2865

</para><variablelist role="params">

2846

2866

<varlistentry><term><parameter>widget</parameter> :</term>

2847

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>.

2867

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

2848

2868

</simpara></listitem></varlistentry>

2849

2869

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the composite name of <parameter>widget</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>widget</parameter> is not

2850

2870

a composite child. The string should not be freed when it is no

2918

2938

2919

2939

const <link linkend="GdkColor">GdkColor</link> *color);</programlisting>

2920

2940

<para>

2921

Sets the foreground color for a widget in a particular state. All

2922

other style values are left untouched. See also

2941

Sets the foreground color for a widget in a particular state.

2942

All other style values are left untouched. See also

2923

2943

2924

2944

<para>

2925

2945

2926

2946

</para><variablelist role="params">

2927

2947

<varlistentry><term><parameter>widget</parameter> :</term>

2928

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>.

2948

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

2929

2949

</simpara></listitem></varlistentry>

2930

2950

<varlistentry><term><parameter>state</parameter> :</term>

2931

<listitem><simpara> the state for which to set the foreground color.

2951

<listitem><simpara> the state for which to set the foreground color

2932

2952

</simpara></listitem></varlistentry>

2933

2953

<varlistentry><term><parameter>color</parameter> :</term>

2934

2954

<listitem><simpara> the color to assign (does not need to be allocated),

2942

2962

2943

2963

const <link linkend="GdkColor">GdkColor</link> *color);</programlisting>

2944

2964

<para>

2945

Sets the background color for a widget in a particular state. All

2946

other style values are left untouched. See also

2965

Sets the background color for a widget in a particular state.

2966

All other style values are left untouched. See also

2947

2967

2948

2968

</para>

2949

2969

<para>

2950

2970

Note that "no window" widgets (which have the <link linkend="GTK-NO-WINDOW:CAPS"><literal>GTK_NO_WINDOW</literal></link> flag set)

2951

draw on their parent container's window and thus may not draw any background

2952

themselves. This is the case for e.g. <link linkend="GtkLabel"><type>GtkLabel</type></link>. To modify the background

2953

of such widgets, you have to set the background color on their parent; if you want

2954

to set the background of a rectangular area around a label, try placing the

2955

label in a <link linkend="GtkEventBox"><type>GtkEventBox</type></link> widget and setting the background color on that.</para>

2971

draw on their parent container's window and thus may not draw any

2972

background themselves. This is the case for e.g. <link linkend="GtkLabel"><type>GtkLabel</type></link>. To modify

2973

the background of such widgets, you have to set the background color

2974

on their parent; if you want to set the background of a rectangular

2975

area around a label, try placing the label in a <link linkend="GtkEventBox"><type>GtkEventBox</type></link> widget

2976

and setting the background color on that.</para>

2956

2977

<para>

2957

2978

2958

2979

</para><variablelist role="params">

2959

2980

<varlistentry><term><parameter>widget</parameter> :</term>

2960

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>.

2981

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

2961

2982

</simpara></listitem></varlistentry>

2962

2983

<varlistentry><term><parameter>state</parameter> :</term>

2963

<listitem><simpara> the state for which to set the background color.

2984

<listitem><simpara> the state for which to set the background color

2964

2985

</simpara></listitem></varlistentry>

2965

2986

<varlistentry><term><parameter>color</parameter> :</term>

2966

2987

<listitem><simpara> the color to assign (does not need to be allocated),

2983

3004

2984

3005

</para><variablelist role="params">

2985

3006

<varlistentry><term><parameter>widget</parameter> :</term>

2986

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>.

3007

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

2987

3008

</simpara></listitem></varlistentry>

2988

3009

<varlistentry><term><parameter>state</parameter> :</term>

2989

<listitem><simpara> the state for which to set the text color.

3010

<listitem><simpara> the state for which to set the text color

2990

3011

</simpara></listitem></varlistentry>

2991

3012

<varlistentry><term><parameter>color</parameter> :</term>

2992

3013

<listitem><simpara> the color to assign (does not need to be allocated),

3008

3029

</para>

3009

3030

<para>

3010

3031

Note that "no window" widgets (which have the <link linkend="GTK-NO-WINDOW:CAPS"><literal>GTK_NO_WINDOW</literal></link> flag set)

3011

draw on their parent container's window and thus may not draw any background

3012

themselves. This is the case for e.g. <link linkend="GtkLabel"><type>GtkLabel</type></link>. To modify the background

3013

of such widgets, you have to set the base color on their parent; if you want

3014

to set the background of a rectangular area around a label, try placing the

3015

label in a <link linkend="GtkEventBox"><type>GtkEventBox</type></link> widget and setting the base color on that.</para>

3032

draw on their parent container's window and thus may not draw any

3033

background themselves. This is the case for e.g. <link linkend="GtkLabel"><type>GtkLabel</type></link>. To modify

3034

the background of such widgets, you have to set the base color on their

3035

parent; if you want to set the background of a rectangular area around

3036

a label, try placing the label in a <link linkend="GtkEventBox"><type>GtkEventBox</type></link> widget and setting

3037

the base color on that.</para>

3016

3038

<para>

3017

3039

3018

3040

</para><variablelist role="params">

3019

3041

<varlistentry><term><parameter>widget</parameter> :</term>

3020

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>.

3042

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

3021

3043

</simpara></listitem></varlistentry>

3022

3044

<varlistentry><term><parameter>state</parameter> :</term>

3023

<listitem><simpara> the state for which to set the base color.

3045

<listitem><simpara> the state for which to set the base color

3024

3046

</simpara></listitem></varlistentry>

3025

3047

<varlistentry><term><parameter>color</parameter> :</term>

3026

3048

<listitem><simpara> the color to assign (does not need to be allocated),

3076

3098

<para>

3077

3099

If you create and keep a <link linkend="PangoLayout"><type>PangoLayout</type></link> using this context, you must

3078

3100

deal with changes to the context by calling <link linkend="pango-layout-context-changed"><function>pango_layout_context_changed()</function></link>

3079

on the layout in response to the ::style-set and ::direction-changed signals

3080

for the widget.</para>

3101

on the layout in response to the <link linkend="GtkWidget-style-set"><type>::style-set</type></link> and

3102

3081

3103

<para>

3082

3104

3083

3105

</para><variablelist role="params">

3100

3122

If you keep a <link linkend="PangoLayout"><type>PangoLayout</type></link> created in this way around, in order to

3101

3123

notify the layout of changes to the base direction or font of this

3102

3124

widget, you must call <link linkend="pango-layout-context-changed"><function>pango_layout_context_changed()</function></link> in response to

3103

the ::style-set and ::direction-changed signals for the widget.</para>

3125

the <link linkend="GtkWidget-style-set"><type>::style-set</type></link> and <link linkend="GtkWidget-direction-changed"><type>::direction-changed</type></link> signals

3126

for the widget.</para>

3104

3127

<para>

3105

3128

3106

3129

</para><variablelist role="params">

3108

3131

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

3109

3132

</simpara></listitem></varlistentry>

3110

3133

3111

<listitem><simpara> text to set on the layout (can be <link linkend="NULL:CAPS"><literal>NULL</literal></link>)

3134

<listitem><simpara> text to set on the layout (can be <link linkend="NULL:CAPS"><literal>NULL</literal></link>)

3112

3135

</simpara></listitem></varlistentry>

3113

3136

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="PangoLayout"><type>PangoLayout</type></link>

3114

3137

</simpara></listitem></varlistentry>

3189

3212

3190

3213

</para></refsect2>

3191

3214

3192

<title><anchor id="gtk-widget-queue-clear" role="function" condition="deprecated:"/>gtk_widget_queue_clear ()</title>

3215

<title><anchor id="gtk-widget-queue-clear" role="function" condition="deprecated:Use gtk_widget_queue_draw() instead."/>gtk_widget_queue_clear ()</title>

3193

3216

<indexterm role="deprecated"><primary>gtk_widget_queue_clear</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_queue_clear (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

3194

<warning><para><literal>gtk_widget_queue_clear</literal> is deprecated and should not be used in newly-written code.</para></warning>

3195

<para>

3196

This function does the same as <link linkend="gtk-widget-queue-draw"><function>gtk_widget_queue_draw()</function></link>.

3197

</para>

3198

<para>

3199

<parameter>Deprecated</parameter>: Use <link linkend="gtk-widget-queue-draw"><function>gtk_widget_queue_draw()</function></link> instead.</para>

3217

<warning><para><literal>gtk_widget_queue_clear</literal> is deprecated and should not be used in newly-written code. Use <link linkend="gtk-widget-queue-draw"><function>gtk_widget_queue_draw()</function></link> instead.</para></warning>

3218

<para>

3219

This function does the same as <link linkend="gtk-widget-queue-draw"><function>gtk_widget_queue_draw()</function></link>.</para>

3200

3220

<para>

3201

3221

3202

3222

</para><variablelist role="params">

3205

3225

</simpara></listitem></varlistentry>

3206

3226

</variablelist></refsect2>

3207

3227

3208

<title><anchor id="gtk-widget-queue-clear-area" role="function" condition="deprecated:"/>gtk_widget_queue_clear_area ()</title>

3228

<title><anchor id="gtk-widget-queue-clear-area" role="function" condition="deprecated:Use gtk_widget_queue_draw_area() instead."/>gtk_widget_queue_clear_area ()</title>

3209

3229

<indexterm role="deprecated"><primary>gtk_widget_queue_clear_area</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_queue_clear_area (<link linkend="GtkWidget">GtkWidget</link> *widget,

3210

3230

3211

3231

3212

3232

3213

3233

3214

<warning><para><literal>gtk_widget_queue_clear_area</literal> is deprecated and should not be used in newly-written code.</para></warning>

3234

<warning><para><literal>gtk_widget_queue_clear_area</literal> is deprecated and should not be used in newly-written code. Use <link linkend="gtk-widget-queue-draw-area"><function>gtk_widget_queue_draw_area()</function></link> instead.</para></warning>

3215

3235

<para>

3216

3236

This function is no longer different from

3217

3237

3219

3239

3220

3240

background for <link linkend="GTK-NO-WINDOW:CAPS"><literal>GTK_NO_WINDOW</literal></link> widgets, and

3221

3241

3222

the background will be redrawn.

3223

</para>

3224

<para>

3225

<parameter>Deprecated</parameter>: Use <link linkend="gtk-widget-queue-draw-area"><function>gtk_widget_queue_draw_area()</function></link> instead.</para>

3242

the background will be redrawn.</para>

3226

3243

<para>

3227

3244

3228

3245

</para><variablelist role="params">

3252

3269

<para>

3253

3270

Invalidates the rectangular area of <parameter>widget</parameter> defined by <parameter>x</parameter>, <parameter>y</parameter>,

3254

3271

<parameter>width</parameter> and <parameter>height</parameter> by calling <link linkend="gdk-window-invalidate-rect"><function>gdk_window_invalidate_rect()</function></link> on the

3255

widget's window and all its child windows. Once the main loop

3272

widget's window and all its child windows. Once the main loop

3256

3273

becomes idle (after the current batch of events has been processed,

3257

3274

roughly), the window will receive expose events for the union of

3258

3275

all regions that have been invalidated.

3301

3318

3302

3319

</para><variablelist role="params">

3303

3320

<varlistentry><term><parameter>widget</parameter> :</term>

3304

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>.

3321

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

3305

3322

</simpara></listitem></varlistentry>

3306

3323

</variablelist></refsect2>

3307

3324

3310

3327

3311

3328

<para>

3312

3329

Sets whether the application intends to draw on the widget in

3313

an ::expose-event handler.

3330

an <link linkend="GtkWidget-expose-event"><type>::expose-event</type></link> handler.

3314

3331

</para>

3315

3332

<para>

3316

3333

This is a hint to the widget and does not affect the behavior of

3383

3400

allocation changes. By default, this setting is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> and

3384

3401

the entire widget is redrawn on every size change. If your widget

3385

3402

leaves the upper left unchanged when made bigger, turning this

3386

setting on will improve performance.

3403

setting off will improve performance.

3387

3404

</para>

3388

3405

<para>

3389

3406

Note that for <link linkend="NO-WINDOW:CAPS"><literal>NO_WINDOW</literal></link> widgets setting this flag to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> turns

3420

3437

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>.

3421

3438

</simpara></listitem></varlistentry>

3422

3439

3423

<listitem><simpara> the name to set.

3440

<listitem><simpara> the name to set

3424

3441

</simpara></listitem></varlistentry>

3425

3442

</variablelist></refsect2>

3426

3443

3543

3560

<varlistentry><term><parameter>n_properties</parameter> :</term>

3544

3561

<listitem><simpara> location to return the number of style properties found

3545

3562

</simpara></listitem></varlistentry>

3546

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an newly allocated array of <link linkend="GParamSpec"><type>GParamSpec</type></link>*. The array must be freed with <link linkend="g-free"><function>g_free()</function></link>.

3563

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an newly allocated array of <link linkend="GParamSpec"><type>GParamSpec</type></link>*. The array must

3564

be freed with <link linkend="g-free"><function>g_free()</function></link>.

3547

3565

</simpara></listitem></varlistentry>

3548

3566

</variablelist><para role="since">Since 2.2

3549

3567

</para></refsect2>

3599

3617

<varlistentry><term><parameter>event</parameter> :</term>

3600

3618

<listitem><simpara> a expose <link linkend="GdkEvent"><type>GdkEvent</type></link>

3601

3619

</simpara></listitem></varlistentry>

3602

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> return from the event signal emission (<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the event was handled)

3620

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> return from the event signal emission (<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if

3621

the event was handled)

3603

3622

</simpara></listitem></varlistentry>

3604

3623

</variablelist></refsect2>

3605

3624

3709

3728

3710

3729

around the window using keyboard shortcuts. <parameter>direction</parameter> indicates

3711

3730

what kind of motion is taking place (up, down, left, right, tab

3712

forward, tab backward). <link linkend="gtk-widget-child-focus"><function>gtk_widget_child_focus()</function></link> invokes the

3713

"focus" signal on <link linkend="GtkWidget"><type>GtkWidget</type></link>; widgets override the default handler

3731

forward, tab backward). <link linkend="gtk-widget-child-focus"><function>gtk_widget_child_focus()</function></link> emits the

3732

3714

3733

for this signal in order to implement appropriate focus behavior.

3715

3734

</para>

3716

3735

<para>

3717

The "focus" default handler for a widget should return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if

3736

The default ::focus handler for a widget should return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if

3718

3737

moving in <parameter>direction</parameter> left the focus on a focusable location inside

3719

3738

that widget, and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if moving in <parameter>direction</parameter> moved the focus

3720

3739

outside the widget. If returning <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, widgets normally

3722

3741

if returning <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>, they don't modify the current focus location.

3723

3742

</para>

3724

3743

<para>

3725

This function replaces <link linkend="gtk-container-focus"><function>gtk_container_focus()</function></link> from GTK+ 1.2. It was

3726

necessary to check that the child was visible, sensitive, and

3727

focusable before calling

3728

3729

the widget is not currently in a focusable state, so there's no

3730

need for those checks.</para>

3744

This function replaces <link linkend="gtk-container-focus"><function>gtk_container_focus()</function></link> from GTK+ 1.2.

3745

It was necessary to check that the child was visible, sensitive,

3746

and focusable before calling <link linkend="gtk-container-focus"><function>gtk_container_focus()</function></link>.

3747

3748

currently in a focusable state, so there's no need for those checks.</para>

3731

3749

<para>

3732

3750

3733

3751

</para><variablelist role="params">

3745

3763

<indexterm><primary>gtk_widget_child_notify</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_child_notify (<link linkend="GtkWidget">GtkWidget</link> *widget,

3746

3764

const <link linkend="gchar">gchar</link> *child_property);</programlisting>

3747

3765

<para>

3748

Emits a "child-notify" signal for the

3766

Emits a <link linkend="GtkWidget-child-notify"><type>::child-notify</type></link> signal for the

3749

3767

3750

3768

on <parameter>widget</parameter>.

3751

3769

</para>

3759

3777

</simpara></listitem></varlistentry>

3760

3778

<varlistentry><term><parameter>child_property</parameter> :</term>

3761

3779

<listitem><simpara> the name of a child property installed on the

3762

class of <parameter>widget</parameter>'s parent.

3780

class of <parameter>widget</parameter>'s parent

3763

3781

</simpara></listitem></varlistentry>

3764

3782

</variablelist></refsect2>

3765

3783

3766

3784

<title><anchor id="gtk-widget-freeze-child-notify" role="function"/>gtk_widget_freeze_child_notify ()</title>

3767

3785

<indexterm><primary>gtk_widget_freeze_child_notify</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_freeze_child_notify (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

3768

3786

<para>

3769

Stops emission of "child-notify" signals on <parameter>widget</parameter>. The signals are

3770

queued until <link linkend="gtk-widget-thaw-child-notify"><function>gtk_widget_thaw_child_notify()</function></link> is called on <parameter>widget</parameter>.

3787

Stops emission of <link linkend="GtkWidget-child-notify"><type>::child-notify</type></link> signals on <parameter>widget</parameter>. The

3788

signals are queued until <link linkend="gtk-widget-thaw-child-notify"><function>gtk_widget_thaw_child_notify()</function></link> is called

3789

on <parameter>widget</parameter>.

3771

3790

</para>

3772

3791

<para>

3773

3792

This is the analogue of <link linkend="g-object-freeze-notify"><function>g_object_freeze_notify()</function></link> for child properties.</para>

3960

3979

3961

3980

<para>

3962

3981

Gets the size request that was explicitly set for the widget using

3963

3982

3964

3983

<parameter>height</parameter> indicates that that dimension has not been set explicitly

3965

3984

and the natural requisition of the widget will be used intead. See

3966

3985

4125

4144

<indexterm><primary>gtk_widget_thaw_child_notify</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_thaw_child_notify (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

4126

4145

<para>

4127

4146

Reverts the effect of a previous call to <link linkend="gtk-widget-freeze-child-notify"><function>gtk_widget_freeze_child_notify()</function></link>.

4128

This causes all queued "child-notify" signals on <parameter>widget</parameter> to be emitted.</para>

4147

This causes all queued <link linkend="GtkWidget-child-notify"><type>::child-notify</type></link> signals on <parameter>widget</parameter> to be

4148

emitted.</para>

4129

4149

<para>

4130

4150

4131

4151

</para><variablelist role="params">

4138

4158

<indexterm role="2.4"><primary>gtk_widget_set_no_show_all</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_set_no_show_all (<link linkend="GtkWidget">GtkWidget</link> *widget,

4139

4159

4140

4160

<para>

4141

Sets the "no_show_all" property, which determines whether calls to

4142

4161

Sets the <link linkend="GtkWidget--no-show-all"><type>:no-show-all</type></link> property, which determines whether

4162

calls to <link linkend="gtk-widget-show-all"><function>gtk_widget_show_all()</function></link> and <link linkend="gtk-widget-hide-all"><function>gtk_widget_hide_all()</function></link> will affect

4163

this widget.

4143

4164

</para>

4144

4165

<para>

4145

4166

This is mostly for use in constructing widget hierarchies with externally

4151

4172

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

4152

4173

</simpara></listitem></varlistentry>

4153

4174

4154

<listitem><simpara> the new value for the "no_show_all" property

4175

<listitem><simpara> the new value for the "no-show-all" property

4155

4176

</simpara></listitem></varlistentry>

4156

4177

</variablelist><para role="since">Since 2.4

4157

4178

</para></refsect2>

4159

4180

<title><anchor id="gtk-widget-get-no-show-all" role="function" condition="since:2.4"/>gtk_widget_get_no_show_all ()</title>

4160

4181

<indexterm role="2.4"><primary>gtk_widget_get_no_show_all</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gtk_widget_get_no_show_all (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

4161

4182

<para>

4162

Returns the current value of the "no_show_all" property, which determines

4163

whether calls to <link linkend="gtk-widget-show-all"><function>gtk_widget_show_all()</function></link> and <link linkend="gtk-widget-hide-all"><function>gtk_widget_hide_all()</function></link>

4164

will affect this widget.</para>

4183

Returns the current value of the GtkWidget:no-show-all property,

4184

which determines whether calls to <link linkend="gtk-widget-show-all"><function>gtk_widget_show_all()</function></link> and

4185

4165

4186

<para>

4166

4187

4167

4188

</para><variablelist role="params">

4168

4189

<varlistentry><term><parameter>widget</parameter> :</term>

4169

4190

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

4170

4191

</simpara></listitem></varlistentry>

4171

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current value of the "no_show_all" property.

4192

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current value of the "no-show-all" property.

4172

4193

4173

4194

</simpara></listitem></varlistentry>

4174

4195

</variablelist><para role="since">Since 2.4

4210

4231

list of mnemonic labels for the widget is cleared when the

4211

4232

widget is destroyed, so the caller must make sure to update

4212

4233

its internal state at this point as well, by using a connection

4213

to the ::destroy signal or a weak notifier.</para>

4234

to the <link linkend="GtkWidget-destroy"><type>::destroy</type></link> signal or a weak notifier.</para>

4214

4235

<para>

4215

4236

4216

4237

</para><variablelist role="params">

4218

4239

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

4219

4240

</simpara></listitem></varlistentry>

4220

4241

<varlistentry><term><parameter>label</parameter> :</term>

4221

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> that acts as a mnemonic label for <parameter>widget</parameter>.

4242

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> that acts as a mnemonic label for <parameter>widget</parameter>

4222

4243

</simpara></listitem></varlistentry>

4223

4244

</variablelist><para role="since">Since 2.4

4224

4245

</para></refsect2>

4267

4288

<para>

4268

4289

Whether <parameter>widget</parameter> can rely on having its alpha channel

4269

4290

drawn correctly. On X11 this function returns whether a

4270

compositing manager is running for <parameter>widget</parameter>'s screen</para>

4291

compositing manager is running for <parameter>widget</parameter>'s screen.</para>

4271

4292

<para>

4272

4293

4273

4294

</para><variablelist role="params">

4281

4302

</variablelist><para role="since">Since 2.10

4282

4303

</para></refsect2>

4283

4304

4305

<title><anchor id="gtk-widget-error-bell" role="function" condition="since:2.12"/>gtk_widget_error_bell ()</title>

4306

<indexterm role="2.12"><primary>gtk_widget_error_bell</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_error_bell (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

4307

<para>

4308

Notifies the user about an input-related error on this widget.

4309

If the <link linkend="GtkSettings--gtk-error-bell"><type>:gtk-error-bell</type></link> setting is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, it calls

4310

4311

</para>

4312

<para>

4313

Note that the effect of <link linkend="gdk-window-beep"><function>gdk_window_beep()</function></link> can be configured in many

4314

ways, depending on the windowing backend and the desktop environment

4315

or window manager that is used.</para>

4316

<para>

4317

4318

</para><variablelist role="params">

4319

<varlistentry><term><parameter>widget</parameter> :</term>

4320

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

4321

</simpara></listitem></varlistentry>

4322

</variablelist><para role="since">Since 2.12

4323

</para></refsect2>

4324

4325

<title><anchor id="gtk-widget-keynav-failed" role="function" condition="since:2.12"/>gtk_widget_keynav_failed ()</title>

4326

<indexterm role="2.12"><primary>gtk_widget_keynav_failed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gtk_widget_keynav_failed (<link linkend="GtkWidget">GtkWidget</link> *widget,

4327

4328

<para>

4329

This function should be called whenever keyboard navigation within

4330

a single widget hits a boundary. The function emits the

4331

4332

value should be interpreted in a way similar to the return value of

4333

4334

</para>

4335

<para>

4336

When <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is returned, stay in the widget, the failed keyboard

4337

navigation is Ok and/or there is nowhere we can/should move the

4338

focus to.

4339

</para>

4340

<para>

4341

When <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> is returned, the caller should continue with keyboard

4342

navigation outside the widget, e.g. by calling

4343

4344

</para>

4345

<para>

4346

The default ::keynav-failed handler returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> for

4347

4348

values of <link linkend="GtkDirectionType"><type>GtkDirectionType</type></link>, it looks at the

4349

4350

if the setting is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. This way the entire user interface

4351

becomes cursor-navigatable on input devices such as mobile phones

4352

which only have cursor keys but no tab key.

4353

</para>

4354

<para>

4355

Whenever the default handler returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, it also calls

4356

4357

navigation.

4358

</para>

4359

<para>

4360

A use case for providing an own implementation of ::keynav-failed

4361

(either by connecting to it or by overriding it) would be a row of

4362

4363

entire row with the cursor keys, as e.g. known from user interfaces

4364

that require entering license keys.</para>

4365

<para>

4366

4367

</para><variablelist role="params">

4368

<varlistentry><term><parameter>widget</parameter> :</term>

4369

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

4370

</simpara></listitem></varlistentry>

4371

<varlistentry><term><parameter>direction</parameter> :</term>

4372

<listitem><simpara> direction of focus movement

4373

</simpara></listitem></varlistentry>

4374

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if stopping keyboard navigation is fine, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>

4375

if the emitting widget should try to handle the keyboard

4376

navigation attempt in its parent container(s).

4377

4378

</simpara></listitem></varlistentry>

4379

</variablelist><para role="since">Since 2.12

4380

</para></refsect2>

4381

4382

<title><anchor id="gtk-widget-get-tooltip-window" role="function" condition="since:2.12"/>gtk_widget_get_tooltip_window ()</title>

4383

<indexterm role="2.12"><primary>gtk_widget_get_tooltip_window</primary></indexterm><programlisting><link linkend="GtkWindow">GtkWindow</link>* gtk_widget_get_tooltip_window (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

4384

<para>

4385

Returns the <link linkend="GtkWindow"><type>GtkWindow</type></link> of the current tooltip. This can be the

4386

GtkWindow created by default, or the custom tooltip window set

4387

using <link linkend="gtk-widget-set-tooltip-window"><function>gtk_widget_set_tooltip_window()</function></link>.</para>

4388

<para>

4389

4390

</para><variablelist role="params">

4391

<varlistentry><term><parameter>widget</parameter> :</term>

4392

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

4393

</simpara></listitem></varlistentry>

4394

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="GtkWindow"><type>GtkWindow</type></link> of the current tooltip.

4395

4396

</simpara></listitem></varlistentry>

4397

</variablelist><para role="since">Since 2.12

4398

</para></refsect2>

4399

4400

<title><anchor id="gtk-widget-set-tooltip-window" role="function" condition="since:2.12"/>gtk_widget_set_tooltip_window ()</title>

4401

<indexterm role="2.12"><primary>gtk_widget_set_tooltip_window</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_set_tooltip_window (<link linkend="GtkWidget">GtkWidget</link> *widget,

4402

4403

<para>

4404

Replaces the default, usually yellow, window used for displaying

4405

tooltips with <parameter>custom_window</parameter>. GTK+ will take care of showing and

4406

hiding <parameter>custom_window</parameter> at the right moment, to behave likewise as

4407

the default tooltip window. If <parameter>custom_window</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, the default

4408

tooltip window will be used.</para>

4409

<para>

4410

4411

</para><variablelist role="params">

4412

<varlistentry><term><parameter>widget</parameter> :</term>

4413

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

4414

</simpara></listitem></varlistentry>

4415

<varlistentry><term><parameter>custom_window</parameter> :</term>

4416

<listitem><simpara> a <link linkend="GtkWindow"><type>GtkWindow</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>

4417

</simpara></listitem></varlistentry>

4418

</variablelist><para role="since">Since 2.12

4419

</para></refsect2>

4420

4421

<title><anchor id="gtk-widget-trigger-tooltip-query" role="function" condition="since:2.12"/>gtk_widget_trigger_tooltip_query ()</title>

4422

<indexterm role="2.12"><primary>gtk_widget_trigger_tooltip_query</primary></indexterm><programlisting><link linkend="void">void</link> gtk_widget_trigger_tooltip_query (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>

4423

<para>

4424

Triggers a tooltip query on the display where the toplevel of <parameter>widget</parameter>

4425

is located. See <link linkend="gtk-tooltip-trigger-tooltip-query"><function>gtk_tooltip_trigger_tooltip_query()</function></link> for more

4426

information.</para>

4427

<para>

4428

4429

</para><variablelist role="params">

4430

<varlistentry><term><parameter>widget</parameter> :</term>

4431

<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>

4432

</simpara></listitem></varlistentry>

4433

</variablelist><para role="since">Since 2.12

4434

</para></refsect2>

4435

4284

4436

<title><anchor id="gtk-requisition-copy" role="function"/>gtk_requisition_copy ()</title>

4285

4437

<indexterm><primary>gtk_requisition_copy</primary></indexterm><programlisting><link linkend="GtkRequisition">GtkRequisition</link>* gtk_requisition_copy (const <link linkend="GtkRequisition">GtkRequisition</link> *requisition);</programlisting>

4286

4438

<para>

4289

4441

4290

4442

</para><variablelist role="params">

4291

4443

<varlistentry><term><parameter>requisition</parameter> :</term>

4292

<listitem><simpara> a <link linkend="GtkRequisition"><type>GtkRequisition</type></link>.

4444

<listitem><simpara> a <link linkend="GtkRequisition"><type>GtkRequisition</type></link>

4293

4445

</simpara></listitem></varlistentry>

4294

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a copy of <parameter>requisition</parameter>.

4446

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a copy of <parameter>requisition</parameter>

4295

4447

</simpara></listitem></varlistentry>

4296

4448

</variablelist></refsect2>

4297

4449

4303

4455

4304

4456

</para><variablelist role="params">

4305

4457

<varlistentry><term><parameter>requisition</parameter> :</term>

4306

<listitem><simpara> a <link linkend="GtkRequisition"><type>GtkRequisition</type></link>.

4458

<listitem><simpara> a <link linkend="GtkRequisition"><type>GtkRequisition</type></link>

4307

4459

</simpara></listitem></varlistentry>

4308

4460

</variablelist></refsect2>

4309

4461

4310

4462

</refsect1>

4311

4463

4312

4464

<title role="property_details.title">Property Details</title>

4313

<refsect2><title><anchor id="GtkWidget--app-paintable"/>The "<literal>app-paintable</literal>" property</title>

4314

<indexterm><primary>GtkWidget:app-paintable</primary></indexterm><programlisting> "app-paintable" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4465

<refsect2><title><anchor id="GtkWidget--app-paintable"/>The :<literal>app-paintable</literal> property</title>

4466

<indexterm><primary>GtkWidget:app-paintable</primary></indexterm><programlisting> app-paintable <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4315

4467

<para>Whether the application will paint directly on the widget.</para><para>Default value: FALSE</para>

4316

4468

</refsect2>

4317

<refsect2><title><anchor id="GtkWidget--can-default"/>The "<literal>can-default</literal>" property</title>

4318

<indexterm><primary>GtkWidget:can-default</primary></indexterm><programlisting> "can-default" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4469

<refsect2><title><anchor id="GtkWidget--can-default"/>The :<literal>can-default</literal> property</title>

4470

<indexterm><primary>GtkWidget:can-default</primary></indexterm><programlisting> can-default <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4319

4471

<para>Whether the widget can be the default widget.</para><para>Default value: FALSE</para>

4320

4472

</refsect2>

4321

<refsect2><title><anchor id="GtkWidget--can-focus"/>The "<literal>can-focus</literal>" property</title>

4322

<indexterm><primary>GtkWidget:can-focus</primary></indexterm><programlisting> "can-focus" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4473

<refsect2><title><anchor id="GtkWidget--can-focus"/>The :<literal>can-focus</literal> property</title>

4474

<indexterm><primary>GtkWidget:can-focus</primary></indexterm><programlisting> can-focus <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4323

4475

<para>Whether the widget can accept the input focus.</para><para>Default value: FALSE</para>

4324

4476

</refsect2>

4325

<refsect2><title><anchor id="GtkWidget--composite-child"/>The "<literal>composite-child</literal>" property</title>

4326

<indexterm><primary>GtkWidget:composite-child</primary></indexterm><programlisting> "composite-child" <link linkend="gboolean">gboolean</link> : Read</programlisting>

4477

<refsect2><title><anchor id="GtkWidget--composite-child"/>The :<literal>composite-child</literal> property</title>

4478

<indexterm><primary>GtkWidget:composite-child</primary></indexterm><programlisting> composite-child <link linkend="gboolean">gboolean</link> : Read</programlisting>

4327

4479

<para>Whether the widget is part of a composite widget.</para><para>Default value: FALSE</para>

4328

4480

</refsect2>

4329

<refsect2><title><anchor id="GtkWidget--events"/>The "<literal>events</literal>" property</title>

4330

<indexterm><primary>GtkWidget:events</primary></indexterm><programlisting> "events" <link linkend="GdkEventMask">GdkEventMask</link> : Read / Write</programlisting>

4481

<refsect2><title><anchor id="GtkWidget--events"/>The :<literal>events</literal> property</title>

4482

<indexterm><primary>GtkWidget:events</primary></indexterm><programlisting> events <link linkend="GdkEventMask">GdkEventMask</link> : Read / Write</programlisting>

4331

4483

<para>The event mask that decides what kind of GdkEvents this widget gets.</para><para>Default value: GDK_STRUCTURE_MASK</para>

4332

4484

</refsect2>

4333

<refsect2><title><anchor id="GtkWidget--extension-events"/>The "<literal>extension-events</literal>" property</title>

4334

<indexterm><primary>GtkWidget:extension-events</primary></indexterm><programlisting> "extension-events" <link linkend="GdkExtensionMode">GdkExtensionMode</link> : Read / Write</programlisting>

4485

<refsect2><title><anchor id="GtkWidget--extension-events"/>The :<literal>extension-events</literal> property</title>

4486

<indexterm><primary>GtkWidget:extension-events</primary></indexterm><programlisting> extension-events <link linkend="GdkExtensionMode">GdkExtensionMode</link> : Read / Write</programlisting>

4335

4487

<para>The mask that decides what kind of extension events this widget gets.</para><para>Default value: GDK_EXTENSION_EVENTS_NONE</para>

4336

4488

</refsect2>

4337

<refsect2><title><anchor id="GtkWidget--has-default"/>The "<literal>has-default</literal>" property</title>

4338

<indexterm><primary>GtkWidget:has-default</primary></indexterm><programlisting> "has-default" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4489

<refsect2><title><anchor id="GtkWidget--has-default"/>The :<literal>has-default</literal> property</title>

4490

<indexterm><primary>GtkWidget:has-default</primary></indexterm><programlisting> has-default <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4339

4491

<para>Whether the widget is the default widget.</para><para>Default value: FALSE</para>

4340

4492

</refsect2>

4341

<refsect2><title><anchor id="GtkWidget--has-focus"/>The "<literal>has-focus</literal>" property</title>

4342

<indexterm><primary>GtkWidget:has-focus</primary></indexterm><programlisting> "has-focus" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4493

<refsect2><title><anchor id="GtkWidget--has-focus"/>The :<literal>has-focus</literal> property</title>

4494

<indexterm><primary>GtkWidget:has-focus</primary></indexterm><programlisting> has-focus <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4343

4495

<para>Whether the widget has the input focus.</para><para>Default value: FALSE</para>

4344

4496

</refsect2>

4345

<refsect2><title><anchor id="GtkWidget--height-request"/>The "<literal>height-request</literal>" property</title>

4346

<indexterm><primary>GtkWidget:height-request</primary></indexterm><programlisting> "height-request" <link linkend="gint">gint</link> : Read / Write</programlisting>

4497

<refsect2><title><anchor id="GtkWidget--has-tooltip"/>The :<literal>has-tooltip</literal> property</title>

4498

<indexterm role="2.12"><primary>GtkWidget:has-tooltip</primary></indexterm><programlisting> has-tooltip <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4499

<para>

4500

Enables or disables the emission of <link linkend="GtkWidget-query-tooltip"><type>::query-tooltip</type></link> on <parameter>widget</parameter>.

4501

A value of <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> indicates that <parameter>widget</parameter> can have a tooltip, in this case

4502

the widget will be queried using <link linkend="GtkWidget-query-tooltip"><type>::query-tooltip</type></link> to determine

4503

whether it will provide a tooltip or not.</para>

4504

<para>

4505

4506

</para><para>Default value: FALSE</para>

4507

<para>Since 2.12

4508

</para>

4509

</refsect2>

4510

<refsect2><title><anchor id="GtkWidget--height-request"/>The :<literal>height-request</literal> property</title>

4511

<indexterm><primary>GtkWidget:height-request</primary></indexterm><programlisting> height-request <link linkend="gint">gint</link> : Read / Write</programlisting>

4347

4512

<para>Override for height request of the widget, or -1 if natural request should be used.</para><para>Allowed values: >= -1</para>

4348

4513

<para>Default value: -1</para>

4349

4514

</refsect2>

4350

<refsect2><title><anchor id="GtkWidget--is-focus"/>The "<literal>is-focus</literal>" property</title>

4351

<indexterm><primary>GtkWidget:is-focus</primary></indexterm><programlisting> "is-focus" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4515

<refsect2><title><anchor id="GtkWidget--is-focus"/>The :<literal>is-focus</literal> property</title>

4516

<indexterm><primary>GtkWidget:is-focus</primary></indexterm><programlisting> is-focus <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4352

4517

<para>Whether the widget is the focus widget within the toplevel.</para><para>Default value: FALSE</para>

4353

4518

</refsect2>

4354

<refsect2><title><anchor id="GtkWidget--name"/>The "<literal>name</literal>" property</title>

4355

<indexterm><primary>GtkWidget:name</primary></indexterm><programlisting> "name" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>

4519

<refsect2><title><anchor id="GtkWidget--name"/>The :<literal>name</literal> property</title>

4520

<indexterm><primary>GtkWidget:name</primary></indexterm><programlisting> name <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>

4356

4521

<para>The name of the widget.</para><para>Default value: NULL</para>

4357

4522

</refsect2>

4358

<refsect2><title><anchor id="GtkWidget--no-show-all"/>The "<literal>no-show-all</literal>" property</title>

4359

<indexterm><primary>GtkWidget:no-show-all</primary></indexterm><programlisting> "no-show-all" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4523

<refsect2><title><anchor id="GtkWidget--no-show-all"/>The :<literal>no-show-all</literal> property</title>

4524

<indexterm><primary>GtkWidget:no-show-all</primary></indexterm><programlisting> no-show-all <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4360

4525

<para>Whether gtk_widget_show_all() should not affect this widget.</para><para>Default value: FALSE</para>

4361

4526

</refsect2>

4362

<refsect2><title><anchor id="GtkWidget--parent"/>The "<literal>parent</literal>" property</title>

4363

<indexterm><primary>GtkWidget:parent</primary></indexterm><programlisting> "parent" <link linkend="GtkContainer">GtkContainer</link> : Read / Write</programlisting>

4527

<refsect2><title><anchor id="GtkWidget--parent"/>The :<literal>parent</literal> property</title>

4528

<indexterm><primary>GtkWidget:parent</primary></indexterm><programlisting> parent <link linkend="GtkContainer">GtkContainer</link> : Read / Write</programlisting>

4364

4529

<para>The parent widget of this widget. Must be a Container widget.</para></refsect2>

4365

<refsect2><title><anchor id="GtkWidget--receives-default"/>The "<literal>receives-default</literal>" property</title>

4366

<indexterm><primary>GtkWidget:receives-default</primary></indexterm><programlisting> "receives-default" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4530

<refsect2><title><anchor id="GtkWidget--receives-default"/>The :<literal>receives-default</literal> property</title>

4531

<indexterm><primary>GtkWidget:receives-default</primary></indexterm><programlisting> receives-default <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4367

4532

<para>If TRUE, the widget will receive the default action when it is focused.</para><para>Default value: FALSE</para>

4368

4533

</refsect2>

4369

<refsect2><title><anchor id="GtkWidget--sensitive"/>The "<literal>sensitive</literal>" property</title>

4370

<indexterm><primary>GtkWidget:sensitive</primary></indexterm><programlisting> "sensitive" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4534

<refsect2><title><anchor id="GtkWidget--sensitive"/>The :<literal>sensitive</literal> property</title>

4535

<indexterm><primary>GtkWidget:sensitive</primary></indexterm><programlisting> sensitive <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4371

4536

<para>Whether the widget responds to input.</para><para>Default value: TRUE</para>

4372

4537

</refsect2>

4373

<refsect2><title><anchor id="GtkWidget--style"/>The "<literal>style</literal>" property</title>

4374

<indexterm><primary>GtkWidget:style</primary></indexterm><programlisting> "style" <link linkend="GtkStyle">GtkStyle</link> : Read / Write</programlisting>

4538

<refsect2><title><anchor id="GtkWidget--style"/>The :<literal>style</literal> property</title>

4539

<indexterm><primary>GtkWidget:style</primary></indexterm><programlisting> style <link linkend="GtkStyle">GtkStyle</link> : Read / Write</programlisting>

4375

4540

<para>The style of the widget, which contains information about how it will look (colors etc).</para></refsect2>

4376

<refsect2><title><anchor id="GtkWidget--visible"/>The "<literal>visible</literal>" property</title>

4377

<indexterm><primary>GtkWidget:visible</primary></indexterm><programlisting> "visible" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4541

<refsect2><title><anchor id="GtkWidget--tooltip-markup"/>The :<literal>tooltip-markup</literal> property</title>

4542

<indexterm role="2.12"><primary>GtkWidget:tooltip-markup</primary></indexterm><programlisting> tooltip-markup <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>

4543

<para>

4544

Sets the text of tooltip to be the given string, which is marked up

4545

with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.

4546

Also see <link linkend="gtk-tooltip-set-markup"><function>gtk_tooltip_set_markup()</function></link>.

4547

</para>

4548

<para>

4549

This is a convenience property which will take care of getting the

4550

tooltip shown if the given string is not <link linkend="NULL:CAPS"><literal>NULL</literal></link>: <link linkend="GtkWidget--has-tooltip"><type>:has-tooltip</type></link>

4551

will automatically be set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> and there will be taken care of

4552

4553

<para>

4554

4555

</para><para>Default value: NULL</para>

4556

<para>Since 2.12

4557

</para>

4558

</refsect2>

4559

<refsect2><title><anchor id="GtkWidget--visible"/>The :<literal>visible</literal> property</title>

4560

<indexterm><primary>GtkWidget:visible</primary></indexterm><programlisting> visible <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>

4378

4561

<para>Whether the widget is visible.</para><para>Default value: FALSE</para>

4379

4562

</refsect2>

4380

<refsect2><title><anchor id="GtkWidget--width-request"/>The "<literal>width-request</literal>" property</title>

4381

<indexterm><primary>GtkWidget:width-request</primary></indexterm><programlisting> "width-request" <link linkend="gint">gint</link> : Read / Write</programlisting>

4563

<refsect2><title><anchor id="GtkWidget--width-request"/>The :<literal>width-request</literal> property</title>

4564

<indexterm><primary>GtkWidget:width-request</primary></indexterm><programlisting> width-request <link linkend="gint">gint</link> : Read / Write</programlisting>

4382

4565

<para>Override for width request of the widget, or -1 if natural request should be used.</para><para>Allowed values: >= -1</para>

4383

4566

<para>Default value: -1</para>

4384

4567

</refsect2>

4386

4569

</refsect1>

4387

4570

4388

4571

<title role="style_properties_details.title">Style Property Details</title>

4389

<refsect2><title><anchor id="GtkWidget--cursor-aspect-ratio"/>The "<literal>cursor-aspect-ratio</literal>" style property</title>

4390

<indexterm><primary>GtkWidget:cursor-aspect-ratio</primary></indexterm><programlisting> "cursor-aspect-ratio" <link linkend="gfloat">gfloat</link> : Read</programlisting>

4572

<refsect2><title><anchor id="GtkWidget--cursor-aspect-ratio"/>The :<literal>cursor-aspect-ratio</literal> style property</title>

4573

<indexterm><primary>GtkWidget:cursor-aspect-ratio</primary></indexterm><programlisting> cursor-aspect-ratio <link linkend="gfloat">gfloat</link> : Read</programlisting>

4391

4574

<para>Aspect ratio with which to draw insertion cursor.</para><para>Allowed values: [0,1]</para>

4392

4575

<para>Default value: 0.04</para>

4393

4576

</refsect2>

4394

<refsect2><title><anchor id="GtkWidget--cursor-color"/>The "<literal>cursor-color</literal>" style property</title>

4395

<indexterm><primary>GtkWidget:cursor-color</primary></indexterm><programlisting> "cursor-color" <link linkend="GdkColor">GdkColor</link> : Read</programlisting>

4577

<refsect2><title><anchor id="GtkWidget--cursor-color"/>The :<literal>cursor-color</literal> style property</title>

4578

<indexterm><primary>GtkWidget:cursor-color</primary></indexterm><programlisting> cursor-color <link linkend="GdkColor">GdkColor</link> : Read</programlisting>

4396

4579

<para>Color with which to draw insertion cursor.</para></refsect2>

4397

<refsect2><title><anchor id="GtkWidget--draw-border"/>The "<literal>draw-border</literal>" style property</title>

4398

<indexterm role="2.8"><primary>GtkWidget:draw-border</primary></indexterm><programlisting> "draw-border" <link linkend="GtkBorder">GtkBorder</link> : Read</programlisting>

4580

<refsect2><title><anchor id="GtkWidget--draw-border"/>The :<literal>draw-border</literal> style property</title>

4581

<indexterm role="2.8"><primary>GtkWidget:draw-border</primary></indexterm><programlisting> draw-border <link linkend="GtkBorder">GtkBorder</link> : Read</programlisting>

4399

4582

<para>

4400

The "draw-border" property defines the size of areas outside

4583

The "draw-border" style property defines the size of areas outside

4401

4584

the widget's allocation to draw.</para>

4402

4585

<para>

4403

4586

4404

4587

</para><para>Since 2.8

4405

4588

</para>

4406

4589

</refsect2>

4407

<refsect2><title><anchor id="GtkWidget--focus-line-pattern"/>The "<literal>focus-line-pattern</literal>" style property</title>

4408

<indexterm><primary>GtkWidget:focus-line-pattern</primary></indexterm><programlisting> "focus-line-pattern" <link linkend="gchararray">gchararray</link> : Read</programlisting>

4590

<refsect2><title><anchor id="GtkWidget--focus-line-pattern"/>The :<literal>focus-line-pattern</literal> style property</title>

4591

<indexterm><primary>GtkWidget:focus-line-pattern</primary></indexterm><programlisting> focus-line-pattern <link linkend="gchararray">gchararray</link> : Read</programlisting>

4409

4592

<para>Dash pattern used to draw the focus indicator.</para><para>Default value: "\001\001"</para>

4410

4593

</refsect2>

4411

<refsect2><title><anchor id="GtkWidget--focus-line-width"/>The "<literal>focus-line-width</literal>" style property</title>

4412

<indexterm><primary>GtkWidget:focus-line-width</primary></indexterm><programlisting> "focus-line-width" <link linkend="gint">gint</link> : Read</programlisting>

4594

<refsect2><title><anchor id="GtkWidget--focus-line-width"/>The :<literal>focus-line-width</literal> style property</title>

4595

<indexterm><primary>GtkWidget:focus-line-width</primary></indexterm><programlisting> focus-line-width <link linkend="gint">gint</link> : Read</programlisting>

4413

4596

<para>Width, in pixels, of the focus indicator line.</para><para>Allowed values: >= 0</para>

4414

4597

<para>Default value: 1</para>

4415

4598

</refsect2>

4416

<refsect2><title><anchor id="GtkWidget--focus-padding"/>The "<literal>focus-padding</literal>" style property</title>

4417

<indexterm><primary>GtkWidget:focus-padding</primary></indexterm><programlisting> "focus-padding" <link linkend="gint">gint</link> : Read</programlisting>

4599

<refsect2><title><anchor id="GtkWidget--focus-padding"/>The :<literal>focus-padding</literal> style property</title>

4600

<indexterm><primary>GtkWidget:focus-padding</primary></indexterm><programlisting> focus-padding <link linkend="gint">gint</link> : Read</programlisting>

4418

4601

<para>Width, in pixels, between focus indicator and the widget 'box'.</para><para>Allowed values: >= 0</para>

4419

4602

<para>Default value: 1</para>

4420

4603

</refsect2>

4421

<refsect2><title><anchor id="GtkWidget--interior-focus"/>The "<literal>interior-focus</literal>" style property</title>

4422

<indexterm><primary>GtkWidget:interior-focus</primary></indexterm><programlisting> "interior-focus" <link linkend="gboolean">gboolean</link> : Read</programlisting>

4604

<refsect2><title><anchor id="GtkWidget--interior-focus"/>The :<literal>interior-focus</literal> style property</title>

4605

<indexterm><primary>GtkWidget:interior-focus</primary></indexterm><programlisting> interior-focus <link linkend="gboolean">gboolean</link> : Read</programlisting>

4423

4606

<para>Whether to draw the focus indicator inside widgets.</para><para>Default value: TRUE</para>

4424

4607

</refsect2>

4425

<refsect2><title><anchor id="GtkWidget--link-color"/>The "<literal>link-color</literal>" style property</title>

4426

<indexterm role="2.10"><primary>GtkWidget:link-color</primary></indexterm><programlisting> "link-color" <link linkend="GdkColor">GdkColor</link> : Read</programlisting>

4608

<refsect2><title><anchor id="GtkWidget--link-color"/>The :<literal>link-color</literal> style property</title>

4609

<indexterm role="2.10"><primary>GtkWidget:link-color</primary></indexterm><programlisting> link-color <link linkend="GdkColor">GdkColor</link> : Read</programlisting>

4427

4610

<para>

4428

The "link-color" property defines the color of unvisited links.</para>

4611

The "link-color" style property defines the color of unvisited links.</para>

4429

4612

<para>

4430

4613

4431

4614

</para><para>Since 2.10

4432

4615

</para>

4433

4616

</refsect2>

4434

<refsect2><title><anchor id="GtkWidget--scroll-arrow-hlength"/>The "<literal>scroll-arrow-hlength</literal>" style property</title>

4435

<indexterm role="2.10"><primary>GtkWidget:scroll-arrow-hlength</primary></indexterm><programlisting> "scroll-arrow-hlength" <link linkend="gint">gint</link> : Read</programlisting>

4617

<refsect2><title><anchor id="GtkWidget--scroll-arrow-hlength"/>The :<literal>scroll-arrow-hlength</literal> style property</title>

4618

<indexterm role="2.10"><primary>GtkWidget:scroll-arrow-hlength</primary></indexterm><programlisting> scroll-arrow-hlength <link linkend="gint">gint</link> : Read</programlisting>

4436

4619

<para>

4437

The "scroll-arrow-hlength" property defines the length of

4620

The "scroll-arrow-hlength" style property defines the length of

4438

4621

horizontal scroll arrows.</para>

4439

4622

<para>

4440

4623

4443

4626

<para>Since 2.10

4444

4627

</para>

4445

4628

</refsect2>

4446

<refsect2><title><anchor id="GtkWidget--scroll-arrow-vlength"/>The "<literal>scroll-arrow-vlength</literal>" style property</title>

4447

<indexterm role="2.10"><primary>GtkWidget:scroll-arrow-vlength</primary></indexterm><programlisting> "scroll-arrow-vlength" <link linkend="gint">gint</link> : Read</programlisting>

4629

<refsect2><title><anchor id="GtkWidget--scroll-arrow-vlength"/>The :<literal>scroll-arrow-vlength</literal> style property</title>

4630

<indexterm role="2.10"><primary>GtkWidget:scroll-arrow-vlength</primary></indexterm><programlisting> scroll-arrow-vlength <link linkend="gint">gint</link> : Read</programlisting>

4448

4631

<para>

4449

The "scroll-arrow-vlength" property defines the length of

4632

The "scroll-arrow-vlength" style property defines the length of

4450

4633

vertical scroll arrows.</para>

4451

4634

<para>

4452

4635

4455

4638

<para>Since 2.10

4456

4639

</para>

4457

4640

</refsect2>

4458

<refsect2><title><anchor id="GtkWidget--secondary-cursor-color"/>The "<literal>secondary-cursor-color</literal>" style property</title>

4459

<indexterm><primary>GtkWidget:secondary-cursor-color</primary></indexterm><programlisting> "secondary-cursor-color" <link linkend="GdkColor">GdkColor</link> : Read</programlisting>

4641

<refsect2><title><anchor id="GtkWidget--secondary-cursor-color"/>The :<literal>secondary-cursor-color</literal> style property</title>

4642

<indexterm><primary>GtkWidget:secondary-cursor-color</primary></indexterm><programlisting> secondary-cursor-color <link linkend="GdkColor">GdkColor</link> : Read</programlisting>

4460

4643

<para>Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text.</para></refsect2>

4461

<refsect2><title><anchor id="GtkWidget--separator-height"/>The "<literal>separator-height</literal>" style property</title>

4462

<indexterm role="2.10"><primary>GtkWidget:separator-height</primary></indexterm><programlisting> "separator-height" <link linkend="gint">gint</link> : Read</programlisting>

4463

<para>

4464

The "separator-height" property defines the height of separators.

4465

This property only takes effect if "wide-separators" is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>

4466

<para>

4467

4468

</para><para>Allowed values: >= 0</para>

4469

<para>Default value: 0</para>

4470

<para>Since 2.10

4471

</para>

4472

</refsect2>

4473

<refsect2><title><anchor id="GtkWidget--separator-width"/>The "<literal>separator-width</literal>" style property</title>

4474

<indexterm role="2.10"><primary>GtkWidget:separator-width</primary></indexterm><programlisting> "separator-width" <link linkend="gint">gint</link> : Read</programlisting>

4475

<para>

4476

The "separator-width" property defines the width of separators.

4477

This property only takes effect if "wide-separators" is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>

4478

<para>

4479

4480

</para><para>Allowed values: >= 0</para>

4481

<para>Default value: 0</para>

4482

<para>Since 2.10

4483

</para>

4484

</refsect2>

4485

<refsect2><title><anchor id="GtkWidget--visited-link-color"/>The "<literal>visited-link-color</literal>" style property</title>

4486

<indexterm role="2.10"><primary>GtkWidget:visited-link-color</primary></indexterm><programlisting> "visited-link-color" <link linkend="GdkColor">GdkColor</link> : Read</programlisting>

4487

<para>

4488

The "visited-link-color" property defines the color of visited links.</para>

4644

<refsect2><title><anchor id="GtkWidget--separator-height"/>The :<literal>separator-height</literal> style property</title>

4645

<indexterm role="2.10"><primary>GtkWidget:separator-height</primary></indexterm><programlisting> separator-height <link linkend="gint">gint</link> : Read</programlisting>

4646

<para>

4647

The "separator-height" style property defines the height of separators.

4648

This property only takes effect if <link linkend="GtkWidget--wide-separators"><type>:wide-separators</type></link> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>

4649

<para>

4650

4651

</para><para>Allowed values: >= 0</para>

4652

<para>Default value: 0</para>

4653

<para>Since 2.10

4654

</para>

4655

</refsect2>

4656

<refsect2><title><anchor id="GtkWidget--separator-width"/>The :<literal>separator-width</literal> style property</title>

4657

<indexterm role="2.10"><primary>GtkWidget:separator-width</primary></indexterm><programlisting> separator-width <link linkend="gint">gint</link> : Read</programlisting>

4658

<para>

4659

The "separator-width" style property defines the width of separators.

4660

This property only takes effect if <link linkend="GtkWidget--wide-separators"><type>:wide-separators</type></link> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>

4661

<para>

4662

4663

</para><para>Allowed values: >= 0</para>

4664

<para>Default value: 0</para>

4665

<para>Since 2.10

4666

</para>

4667

</refsect2>

4668

<refsect2><title><anchor id="GtkWidget--visited-link-color"/>The :<literal>visited-link-color</literal> style property</title>

4669

<indexterm role="2.10"><primary>GtkWidget:visited-link-color</primary></indexterm><programlisting> visited-link-color <link linkend="GdkColor">GdkColor</link> : Read</programlisting>

4670

<para>

4671

The "visited-link-color" style property defines the color of visited links.</para>

4489

4672

<para>

4490

4673

4491

4674

</para><para>Since 2.10

4492

4675

</para>

4493

4676

</refsect2>

4494

<refsect2><title><anchor id="GtkWidget--wide-separators"/>The "<literal>wide-separators</literal>" style property</title>

4495

<indexterm role="2.10"><primary>GtkWidget:wide-separators</primary></indexterm><programlisting> "wide-separators" <link linkend="gboolean">gboolean</link> : Read</programlisting>

4677

<refsect2><title><anchor id="GtkWidget--wide-separators"/>The :<literal>wide-separators</literal> style property</title>

4678

<indexterm role="2.10"><primary>GtkWidget:wide-separators</primary></indexterm><programlisting> wide-separators <link linkend="gboolean">gboolean</link> : Read</programlisting>

4496

4679

<para>

4497

The "wide-separators" property defines whether separators have

4680

The "wide-separators" style property defines whether separators have

4498

4681

configurable width and should be drawn using a box instead of a line.</para>

4499

4682

<para>

4500

4683

4507

4690

4508

4691

4509

4692

<title role="signals.title">Signal Details</title>

4510

<refsect2><title><anchor id="GtkWidget-accel-closures-changed"/>The "accel-closures-changed" signal</title>

4693

<refsect2><title><anchor id="GtkWidget-accel-closures-changed"/>The <literal>::accel-closures-changed</literal> signal</title>

4511

4694

<indexterm><primary>GtkWidget::accel-closures-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4512

4695

4513

4696

<para>

4519

4702

</simpara></listitem></varlistentry>

4520

4703

4521

4704

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4522

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-button-press-event"/>The "button-press-event" signal</title>

4705

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-button-press-event"/>The <literal>::button-press-event</literal> signal</title>

4523

4706

<indexterm><primary>GtkWidget::button-press-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4524

4707

4525

4708

4537

4720

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to stop other handlers from being invoked for the event. <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to propagate the event further.

4538

4721

4539

4722

</simpara></listitem></varlistentry>

4540

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-button-release-event"/>The "button-release-event" signal</title>

4723

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-button-release-event"/>The <literal>::button-release-event</literal> signal</title>

4541

4724

<indexterm><primary>GtkWidget::button-release-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4542

4725

4543

4726

4555

4738

4556

4739

4557

4740

</simpara></listitem></varlistentry>

4558

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-can-activate-accel"/>The "can-activate-accel" signal</title>

4741

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-can-activate-accel"/>The <literal>::can-activate-accel</literal> signal</title>

4559

4742

<indexterm><primary>GtkWidget::can-activate-accel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4560

4743

4561

4744

4574

4757

<varlistentry><term><parameter>signal_id</parameter> :</term>

4575

4758

<listitem><simpara> the ID of a signal installed on <parameter>widget</parameter>

4576

4759

</simpara></listitem></varlistentry>

4577

<varlistentry><term><parameter>returns</parameter> :</term>

4578

<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the signal can be activated.

4579

</simpara></listitem></varlistentry>

4580

4760

4581

4761

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4582

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-child-notify"/>The "child-notify" signal</title>

4762

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the signal can be activated.

4763

</simpara></listitem></varlistentry>

4764

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-child-notify"/>The <literal>::child-notify</literal> signal</title>

4583

4765

<indexterm><primary>GtkWidget::child-notify</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4584

4766

4585

4767

4586

4768

<para>

4587

The ::child-notify signal is emitted for each child property that has

4769

The ::child-notify signal is emitted for each

4770

4588

4771

changed on an object. The signal's detail holds the property name.</para>

4589

4772

<para>

4590

4773

4591

4774

</para><variablelist role="params">

4592

4775

<varlistentry><term><parameter>widget</parameter> :</term>

4593

<listitem><simpara> the object which received the signal.

4776

<listitem><simpara> the object which received the signal

4594

4777

</simpara></listitem></varlistentry>

4595

4778

<varlistentry><term><parameter>pspec</parameter> :</term>

4596

<listitem><simpara> the <link linkend="GParamSpec"><type>GParamSpec</type></link> of the changed child property.

4779

<listitem><simpara> the <link linkend="GParamSpec"><type>GParamSpec</type></link> of the changed child property

4597

4780

</simpara></listitem></varlistentry>

4598

4781

4599

4782

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4600

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-client-event"/>The "client-event" signal</title>

4783

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-client-event"/>The <literal>::client-event</literal> signal</title>

4601

4784

<indexterm><primary>GtkWidget::client-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4602

4785

4603

4786

4615

4798

4616

4799

4617

4800

</simpara></listitem></varlistentry>

4618

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-composited-changed"/>The "composited-changed" signal</title>

4801

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-composited-changed"/>The <literal>::composited-changed</literal> signal</title>

4619

4802

<indexterm><primary>GtkWidget::composited-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4620

4803

4621

4804

<para>

4805

The ::composited-changed signal is emitted when the composited

4806

status of <parameter>widget</parameter>s screen changes.

4807

See <link linkend="gdk-screen-is-composited"><function>gdk_screen_is_composited()</function></link>.</para>

4808

<para>

4622

4809

4623

4810

</para><variablelist role="params">

4624

4811

<varlistentry><term><parameter>widget</parameter> :</term>

4625

<listitem><simpara>the object which received the signal.

4626

4812

<listitem><simpara> the object on which the signal is emitted

4627

4813

</simpara></listitem></varlistentry>

4628

4814

4629

4815

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4630

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-configure-event"/>The "configure-event" signal</title>

4816

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-configure-event"/>The <literal>::configure-event</literal> signal</title>

4631

4817

<indexterm><primary>GtkWidget::configure-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4632

4818

4633

4819

4645

4831

4646

4832

4647

4833

</simpara></listitem></varlistentry>

4648

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-delete-event"/>The "delete-event" signal</title>

4834

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-delete-event"/>The <literal>::delete-event</literal> signal</title>

4649

4835

<indexterm><primary>GtkWidget::delete-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4650

4836

4651

4837

4659

4845

4660

4846

</para><variablelist role="params">

4661

4847

<varlistentry><term><parameter>widget</parameter> :</term>

4662

<listitem><simpara> the object which received the signal.

4848

<listitem><simpara> the object which received the signal

4663

4849

</simpara></listitem></varlistentry>

4664

4850

<varlistentry><term><parameter>event</parameter> :</term>

4665

4851

<listitem><simpara> the event which triggered this signal

4669

4855

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to stop other handlers from being invoked for the event.

4670

4856

4671

4857

</simpara></listitem></varlistentry>

4672

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-destroy-event"/>The "destroy-event" signal</title>

4858

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-destroy-event"/>The <literal>::destroy-event</literal> signal</title>

4673

4859

<indexterm><primary>GtkWidget::destroy-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4674

4860

4675

4861

4692

4878

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to stop other handlers from being invoked for the event.

4693

4879

4694

4880

</simpara></listitem></varlistentry>

4695

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-direction-changed"/>The "direction-changed" signal</title>

4881

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-direction-changed"/>The <literal>::direction-changed</literal> signal</title>

4696

4882

<indexterm><primary>GtkWidget::direction-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4697

4698

4883

4884

4885

<para>

4886

The ::direction-changed signal is emitted when the text direction

4887

of a widget changes.</para>

4699

4888

<para>

4700

4889

4701

4890

</para><variablelist role="params">

4702

4891

<varlistentry><term><parameter>widget</parameter> :</term>

4703

<listitem><simpara>the object which received the signal.

4892

<listitem><simpara> the object on which the signal is emitted

4704

4893

</simpara></listitem></varlistentry>

4705

4706

4707

4894

<varlistentry><term><parameter>previous_direction</parameter> :</term>

4895

<listitem><simpara> the previous text direction of <parameter>widget</parameter>

4708

4896

</simpara></listitem></varlistentry>

4709

4897

4710

4898

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4711

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-begin"/>The "drag-begin" signal</title>

4899

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-begin"/>The <literal>::drag-begin</literal> signal</title>

4712

4900

<indexterm><primary>GtkWidget::drag-begin</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4713

4901

4714

4902

4715

4903

<para>

4716

The ::drag-begin signal is emitted on the drag source when a drag is started.

4717

A typical reason to connect to this signal is to set up a custom drag icon with

4718

4904

The ::drag-begin signal is emitted on the drag source when a drag is

4905

started. A typical reason to connect to this signal is to set up a

4906

custom drag icon with <link linkend="gtk-drag-source-set-icon"><function>gtk_drag_source_set_icon()</function></link>.</para>

4719

4907

<para>

4720

4908

4721

4909

</para><variablelist role="params">

4722

4910

<varlistentry><term><parameter>widget</parameter> :</term>

4723

<listitem><simpara> the object which received the signal.

4911

<listitem><simpara> the object which received the signal

4724

4912

</simpara></listitem></varlistentry>

4725

4913

<varlistentry><term><parameter>drag_context</parameter> :</term>

4726

4914

<listitem><simpara> the drag context

4727

4915

</simpara></listitem></varlistentry>

4728

4916

4729

4917

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4730

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-data-delete"/>The "drag-data-delete" signal</title>

4918

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-data-delete"/>The <literal>::drag-data-delete</literal> signal</title>

4731

4919

<indexterm><primary>GtkWidget::drag-data-delete</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4732

4920

4733

4921

4735

4923

The ::drag-data-delete signal is emitted on the drag source when a drag

4736

4924

with the action <link linkend="GDK-ACTION-MOVE:CAPS"><literal>GDK_ACTION_MOVE</literal></link> is successfully completed. The signal

4737

4925

handler is responsible for deleting the data that has been dropped. What

4738

"delete" means, depends on the context of the drag operation.</para>

4926

"delete" means depends on the context of the drag operation.</para>

4739

4927

<para>

4740

4928

4741

4929

</para><variablelist role="params">

4742

4930

<varlistentry><term><parameter>widget</parameter> :</term>

4743

<listitem><simpara> the object which received the signal.

4931

<listitem><simpara> the object which received the signal

4744

4932

</simpara></listitem></varlistentry>

4745

4933

<varlistentry><term><parameter>drag_context</parameter> :</term>

4746

4934

<listitem><simpara> the drag context

4747

4935

</simpara></listitem></varlistentry>

4748

4936

4749

4937

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4750

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-data-get"/>The "drag-data-get" signal</title>

4938

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-data-get"/>The <literal>::drag-data-get</literal> signal</title>

4751

4939

<indexterm><primary>GtkWidget::drag-data-get</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4752

4940

4753

4941

4755

4943

4756

4944

4757

4945

<para>

4758

The ::drag-data-get signal is emitted on the drag source when the drop site

4759

requests the data which is dragged. It is the responsibility of the signal

4760

handler to fill <parameter>data</parameter> with the data in the format which is indicated by <parameter>info</parameter>.

4761

See <link linkend="gtk-selection-data-set"><function>gtk_selection_data_set()</function></link> and <link linkend="gtk-selection-data-set-text"><function>gtk_selection_data_set_text()</function></link>.</para>

4946

The ::drag-data-get signal is emitted on the drag source when the drop

4947

site requests the data which is dragged. It is the responsibility of

4948

the signal handler to fill <parameter>data</parameter> with the data in the format which

4949

is indicated by <parameter>info</parameter>. See <link linkend="gtk-selection-data-set"><function>gtk_selection_data_set()</function></link> and

4950

4762

4951

<para>

4763

4952

4764

4953

</para><variablelist role="params">

4765

4954

<varlistentry><term><parameter>widget</parameter> :</term>

4766

<listitem><simpara> the object which received the signal.

4955

<listitem><simpara> the object which received the signal

4767

4956

</simpara></listitem></varlistentry>

4768

4957

<varlistentry><term><parameter>drag_context</parameter> :</term>

4769

4958

<listitem><simpara> the drag context

4772

4961

<listitem><simpara> the <link linkend="GtkSelectionData"><type>GtkSelectionData</type></link> to be filled with the dragged data

4773

4962

</simpara></listitem></varlistentry>

4774

4963

4775

<listitem><simpara> the info that has been registered with the target in the <link linkend="GtkTargetList"><type>GtkTargetList</type></link>.

4964

<listitem><simpara> the info that has been registered with the target in the

4965

4776

4966

</simpara></listitem></varlistentry>

4777

4967

4778

4968

<listitem><simpara> the timestamp at which the data was requested

4779

4969

</simpara></listitem></varlistentry>

4780

4970

4781

4971

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4782

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-data-received"/>The "drag-data-received" signal</title>

4972

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-data-received"/>The <literal>::drag-data-received</literal> signal</title>

4783

4973

<indexterm><primary>GtkWidget::drag-data-received</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4784

4974

4785

4975

4790

4980

4791

4981

<para>

4792

4982

The ::drag-data-received signal is emitted on the drop site when the dragged

4793

data has been received. If the data was received in order to determine whether

4794

the drop will be accepted, the handler is expected to call <link linkend="gdk-drag-status"><function>gdk_drag_status()</function></link>

4795

and <emphasis>not</emphasis> finish the drag. If the data was received in

4796

response to a ::drag-drop signal (and this is the last target to be received),

4797

the handler for this signal is expected to process the received data and then

4798

call <link linkend="gtk-drag-finish"><function>gtk_drag_finish()</function></link>, setting the <parameter>success</parameter> parameter depending on whether

4799

the data was processed successfully.

4983

data has been received. If the data was received in order to determine

4984

whether the drop will be accepted, the handler is expected to call

4985

4986

data was received in response to a <link linkend="GtkWidget-drag-drop"><type>::drag-drop</type></link> signal (and this

4987

is the last target to be received), the handler for this signal is expected

4988

to process the received data and then call <link linkend="gtk-drag-finish"><function>gtk_drag_finish()</function></link>, setting the

4989

<parameter>success</parameter> parameter depending on whether the data was processed successfully.

4800

4990

</para>

4801

4991

<para>

4802

4992

The handler may inspect and modify <parameter>drag_context->action</parameter> before calling

4803

4804

example:

4993

4994

following example:

4805

4995

4806

4996

void

4807

4997

drag_data_received (GtkWidget *widget,

4845

5035

4846

5036

</para><variablelist role="params">

4847

5037

<varlistentry><term><parameter>widget</parameter> :</term>

4848

<listitem><simpara> the object which received the signal.

5038

<listitem><simpara> the object which received the signal

4849

5039

</simpara></listitem></varlistentry>

4850

5040

<varlistentry><term><parameter>drag_context</parameter> :</term>

4851

5041

<listitem><simpara> the drag context

4860

5050

<listitem><simpara> the received data

4861

5051

</simpara></listitem></varlistentry>

4862

5052

4863

<listitem><simpara> the info that has been registered with the target in the <link linkend="GtkTargetList"><type>GtkTargetList</type></link>.

5053

<listitem><simpara> the info that has been registered with the target in the

5054

4864

5055

</simpara></listitem></varlistentry>

4865

5056

4866

5057

<listitem><simpara> the timestamp at which the data was received

4867

5058

</simpara></listitem></varlistentry>

4868

5059

4869

5060

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4870

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-drop"/>The "drag-drop" signal</title>

5061

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-drop"/>The <literal>::drag-drop</literal> signal</title>

4871

5062

<indexterm><primary>GtkWidget::drag-drop</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4872

5063

4873

5064

4875

5066

4876

5067

4877

5068

<para>

4878

The ::drag-drop signal is emitted on the drop site when the user drops the

4879

data onto the widget. The signal handler must determine whether the cursor

4880

position is in a drop zone or not. If it is not in a drop zone, it returns

4881

4882

4883

to let the source know that the drop is done. The call to <link linkend="gtk-drag-finish"><function>gtk_drag_finish()</function></link>

4884

can be done either directly or in a ::drag-data-received handler which gets

4885

triggered by calling <link linkend="gtk-drop-get-data"><function>gtk_drop_get_data()</function></link> to receive the data for one or more

4886

of the supported targets.</para>

5069

The ::drag-drop signal is emitted on the drop site when the user drops

5070

the data onto the widget. The signal handler must determine whether

5071

the cursor position is in a drop zone or not. If it is not in a drop

5072

zone, it returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> and no further processing is necessary.

5073

Otherwise, the handler returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. In this case, the handler must

5074

ensure that <link linkend="gtk-drag-finish"><function>gtk_drag_finish()</function></link> is called to let the source know that

5075

the drop is done. The call to <link linkend="gtk-drag-finish"><function>gtk_drag_finish()</function></link> can be done either

5076

directly or in a <link linkend="GtkWidget-drag-data-received"><type>::drag-data-received</type></link> handler which gets

5077

triggered by calling <link linkend="gtk-drag-get-data"><function>gtk_drag_get_data()</function></link> to receive the data for one

5078

or more of the supported targets.</para>

4887

5079

<para>

4888

5080

4889

5081

</para><variablelist role="params">

4890

5082

<varlistentry><term><parameter>widget</parameter> :</term>

4891

<listitem><simpara> the object which received the signal.

5083

<listitem><simpara> the object which received the signal

4892

5084

</simpara></listitem></varlistentry>

4893

5085

<varlistentry><term><parameter>drag_context</parameter> :</term>

4894

5086

<listitem><simpara> the drag context

4907

5099

</simpara></listitem></varlistentry>

4908

5100

4909

5101

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4910

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-end"/>The "drag-end" signal</title>

5102

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-end"/>The <literal>::drag-end</literal> signal</title>

4911

5103

<indexterm><primary>GtkWidget::drag-end</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4912

5104

4913

5105

4914

5106

<para>

4915

The ::drag-end signal is emitted on the drag source when a drag is finished.

4916

A typical reason to connect to this signal is to undo things done in ::drag-begin.</para>

4917

<para>

4918

4919

</para><variablelist role="params">

4920

<varlistentry><term><parameter>widget</parameter> :</term>

4921

<listitem><simpara> the object which received the signal.

4922

</simpara></listitem></varlistentry>

4923

<varlistentry><term><parameter>drag_context</parameter> :</term>

4924

<listitem><simpara> the drag context

4925

</simpara></listitem></varlistentry>

4926

4927

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4928

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-leave"/>The "drag-leave" signal</title>

5107

The ::drag-end signal is emitted on the drag source when a drag is

5108

finished. A typical reason to connect to this signal is to undo

5109

things done in <link linkend="GtkWidget-drag-begin"><type>::drag-begin</type></link>.</para>

5110

<para>

5111

5112

</para><variablelist role="params">

5113

<varlistentry><term><parameter>widget</parameter> :</term>

5114

<listitem><simpara> the object which received the signal

5115

</simpara></listitem></varlistentry>

5116

<varlistentry><term><parameter>drag_context</parameter> :</term>

5117

<listitem><simpara> the drag context

5118

</simpara></listitem></varlistentry>

5119

5120

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5121

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-failed"/>The <literal>::drag-failed</literal> signal</title>

5122

<indexterm role="2.12"><primary>GtkWidget::drag-failed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5123

5124

5125

5126

<para>

5127

The ::drag-failed signal is emitted on the drag source when a drag has

5128

failed. The signal handler may hook custom code to handle a failed DND

5129

operation based on the type of error, it returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is the failure has

5130

been already handled (not showing the default "drag operation failed"

5131

animation), otherwise it returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</para>

5132

<para>

5133

5134

</para><variablelist role="params">

5135

<varlistentry><term><parameter>widget</parameter> :</term>

5136

<listitem><simpara> the object which received the signal

5137

</simpara></listitem></varlistentry>

5138

<varlistentry><term><parameter>drag_context</parameter> :</term>

5139

<listitem><simpara> the drag context

5140

</simpara></listitem></varlistentry>

5141

<varlistentry><term><parameter>result</parameter> :</term>

5142

<listitem><simpara> the result of the drag operation

5143

</simpara></listitem></varlistentry>

5144

5145

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5146

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the failed drag operation has been already handled.

5147

5148

</simpara></listitem></varlistentry>

5149

</variablelist><para>Since 2.12

5150

</para></refsect2><refsect2><title><anchor id="GtkWidget-drag-leave"/>The <literal>::drag-leave</literal> signal</title>

4929

5151

<indexterm><primary>GtkWidget::drag-leave</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4930

5152

4931

5153

4933

5155

<para>

4934

5156

The ::drag-leave signal is emitted on the drop site when the cursor

4935

5157

leaves the widget. A typical reason to connect to this signal is to

4936

undo things done in ::drag-motion, e.g. undo highlighting with

4937

5158

undo things done in <link linkend="GtkWidget-drag-motion"><type>::drag-motion</type></link>, e.g. undo highlighting

5159

with <link linkend="gtk-drag-unhighlight"><function>gtk_drag_unhighlight()</function></link></para>

4938

5160

<para>

4939

5161

4940

5162

</para><variablelist role="params">

4949

5171

</simpara></listitem></varlistentry>

4950

5172

4951

5173

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

4952

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-motion"/>The "drag-motion" signal</title>

5174

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-drag-motion"/>The <literal>::drag-motion</literal> signal</title>

4953

5175

<indexterm><primary>GtkWidget::drag-motion</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

4954

5176

4955

5177

4967

5189

decision whether the drop will be accepted or rejected can't be made

4968

5190

based solely on the cursor position and the type of the data, the handler

4969

5191

may inspect the dragged data by calling <link linkend="gtk-drag-get-data"><function>gtk_drag_get_data()</function></link> and defer the

4970

5192

4971

5193

</para>

4972

5194

<para>

4973

Note that there is no ::drag-enter signal. The drag receiver has to keep

4974

track of whether he has received any ::drag-motion signals since the last

4975

::drag-leave and if not, treat the ::drag-motion signal as an "enter" signal.

4976

Upon an "enter", the handler will typically highlight the drop site with

4977

5195

Note that there is no drag-enter signal. The drag receiver has to keep

5196

track of whether he has received any drag-motion signals since the last

5197

5198

"enter" signal. Upon an "enter", the handler will typically highlight

5199

the drop site with <link linkend="gtk-drag-highlight"><function>gtk_drag_highlight()</function></link>.

4978

5200

</para>

4979

5201

<para>

4980

5202

5043

5265

5044

5266

</para><variablelist role="params">

5045

5267

<varlistentry><term><parameter>widget</parameter> :</term>

5046

<listitem><simpara> the object which received the signal.

5268

<listitem><simpara> the object which received the signal

5047

5269

</simpara></listitem></varlistentry>

5048

5270

<varlistentry><term><parameter>drag_context</parameter> :</term>

5049

5271

<listitem><simpara> the drag context

5062

5284

</simpara></listitem></varlistentry>

5063

5285

5064

5286

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5065

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-enter-notify-event"/>The "enter-notify-event" signal</title>

5287

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-enter-notify-event"/>The <literal>::enter-notify-event</literal> signal</title>

5066

5288

<indexterm><primary>GtkWidget::enter-notify-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5067

5289

5068

5290

5080

5302

5081

5303

5082

5304

</simpara></listitem></varlistentry>

5083

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-event"/>The "event" signal</title>

5305

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-event"/>The <literal>::event</literal> signal</title>

5084

5306

<indexterm><primary>GtkWidget::event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5085

5307

5086

5308

5098

5320

5099

5321

5100

5322

</simpara></listitem></varlistentry>

5101

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-event-after"/>The "event-after" signal</title>

5323

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-event-after"/>The <literal>::event-after</literal> signal</title>

5102

5324

<indexterm><primary>GtkWidget::event-after</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5103

5325

5104

5326

5114

5336

</simpara></listitem></varlistentry>

5115

5337

5116

5338

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5117

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-expose-event"/>The "expose-event" signal</title>

5339

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-expose-event"/>The <literal>::expose-event</literal> signal</title>

5118

5340

<indexterm><primary>GtkWidget::expose-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5119

5341

5120

5342

5132

5354

5133

5355

5134

5356

</simpara></listitem></varlistentry>

5135

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-focus"/>The "focus" signal</title>

5357

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-focus"/>The <literal>::focus</literal> signal</title>

5136

5358

<indexterm><primary>GtkWidget::focus</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5137

5359

5138

5360

5150

5372

5151

5373

5152

5374

</simpara></listitem></varlistentry>

5153

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-focus-in-event"/>The "focus-in-event" signal</title>

5375

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-focus-in-event"/>The <literal>::focus-in-event</literal> signal</title>

5154

5376

<indexterm><primary>GtkWidget::focus-in-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5155

5377

5156

5378

5168

5390

5169

5391

5170

5392

</simpara></listitem></varlistentry>

5171

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-focus-out-event"/>The "focus-out-event" signal</title>

5393

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-focus-out-event"/>The <literal>::focus-out-event</literal> signal</title>

5172

5394

<indexterm><primary>GtkWidget::focus-out-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5173

5395

5174

5396

5186

5408

5187

5409

5188

5410

</simpara></listitem></varlistentry>

5189

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-grab-broken-event"/>The "grab-broken-event" signal</title>

5411

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-grab-broken-event"/>The <literal>::grab-broken-event</literal> signal</title>

5190

5412

<indexterm role="2.8"><primary>GtkWidget::grab-broken-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5191

5413

5192

5414

5214

5436

5215

5437

</simpara></listitem></varlistentry>

5216

5438

</variablelist><para>Since 2.8

5217

</para></refsect2><refsect2><title><anchor id="GtkWidget-grab-focus"/>The "grab-focus" signal</title>

5439

</para></refsect2><refsect2><title><anchor id="GtkWidget-grab-focus"/>The <literal>::grab-focus</literal> signal</title>

5218

5440

<indexterm><primary>GtkWidget::grab-focus</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5219

5441

5220

5442

<para>

5226

5448

</simpara></listitem></varlistentry>

5227

5449

5228

5450

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5229

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-grab-notify"/>The "grab-notify" signal</title>

5451

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-grab-notify"/>The <literal>::grab-notify</literal> signal</title>

5230

5452

<indexterm><primary>GtkWidget::grab-notify</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5231

5453

5232

5454

5252

5474

</simpara></listitem></varlistentry>

5253

5475

5254

5476

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5255

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-hide"/>The "hide" signal</title>

5477

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-hide"/>The <literal>::hide</literal> signal</title>

5256

5478

<indexterm><primary>GtkWidget::hide</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5257

5479

5258

5480

<para>

5264

5486

</simpara></listitem></varlistentry>

5265

5487

5266

5488

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5267

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-hierarchy-changed"/>The "hierarchy-changed" signal</title>

5489

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-hierarchy-changed"/>The <literal>::hierarchy-changed</literal> signal</title>

5268

5490

<indexterm><primary>GtkWidget::hierarchy-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5269

5270

5271

<para>

5272

Emitted when there is a chance in the hierarchy to

5273

which a widget belong. More precisely, a widget is

5491

5492

5493

<para>

5494

The ::hierarchy-changed signal is emitted when the

5495

anchored state of a widget changes. A widget is anchored,

5496

if it has an ancestor that is a toplevel window.</para>

5497

<para>

5498

Emitted when there is a change in the hierarchy to

5499

which a widget belongs. More precisely, a widget is

5274

5500

<firstterm>anchored</firstterm> when its toplevel

5275

5501

ancestor is a <link linkend="GtkWindow"><type>GtkWindow</type></link>. This signal is emitted when

5276

5502

a widget changes from un-anchored to anchored or vice-versa.

5277

5503

</para><variablelist role="params">

5278

5504

<varlistentry><term><parameter>widget</parameter> :</term>

5279

<listitem><simpara>the object which received the signal.

5505

<listitem><simpara> the object on which the signal is emitted

5280

5506

</simpara></listitem></varlistentry>

5281

<varlistentry><term><parameter>widget2</parameter> :</term>

5282

5283

5507

<varlistentry><term><parameter>previous_toplevel</parameter> :</term>

5508

<listitem><simpara> the previous toplevel ancestor, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>

5509

if the widget was previously unanchored

5284

5510

</simpara></listitem></varlistentry>

5285

5511

5286

5512

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5287

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-key-press-event"/>The "key-press-event" signal</title>

5513

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-key-press-event"/>The <literal>::key-press-event</literal> signal</title>

5288

5514

<indexterm><primary>GtkWidget::key-press-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5289

5515

5290

5516

5302

5528

5303

5529

5304

5530

</simpara></listitem></varlistentry>

5305

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-key-release-event"/>The "key-release-event" signal</title>

5531

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-key-release-event"/>The <literal>::key-release-event</literal> signal</title>

5306

5532

<indexterm><primary>GtkWidget::key-release-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5307

5533

5308

5534

5320

5546

5321

5547

5322

5548

</simpara></listitem></varlistentry>

5323

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-leave-notify-event"/>The "leave-notify-event" signal</title>

5549

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-keynav-failed"/>The <literal>::keynav-failed</literal> signal</title>

5550

<indexterm role="2.12"><primary>GtkWidget::keynav-failed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5551

5552

5553

<para>

5554

Gets emitted if keyboard navigation fails.

5555

See <link linkend="gtk-widget-keynav-failed"><function>gtk_widget_keynav_failed()</function></link> for details.</para>

5556

<para>

5557

5558

</para><variablelist role="params">

5559

<varlistentry><term><parameter>widget</parameter> :</term>

5560

<listitem><simpara> the object which received the signal

5561

</simpara></listitem></varlistentry>

5562

<varlistentry><term><parameter>direction</parameter> :</term>

5563

<listitem><simpara> the direction of movement

5564

</simpara></listitem></varlistentry>

5565

5566

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5567

5568

if the emitting widget should try to handle the keyboard

5569

navigation attempt in its parent container(s).

5570

5571

</simpara></listitem></varlistentry>

5572

</variablelist><para>Since 2.12

5573

</para></refsect2><refsect2><title><anchor id="GtkWidget-leave-notify-event"/>The <literal>::leave-notify-event</literal> signal</title>

5324

5574

<indexterm><primary>GtkWidget::leave-notify-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5325

5575

5326

5576

5338

5588

5339

5589

5340

5590

</simpara></listitem></varlistentry>

5341

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-map"/>The "map" signal</title>

5591

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-map"/>The <literal>::map</literal> signal</title>

5342

5592

<indexterm><primary>GtkWidget::map</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5343

5593

5344

5594

<para>

5350

5600

</simpara></listitem></varlistentry>

5351

5601

5352

5602

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5353

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-map-event"/>The "map-event" signal</title>

5603

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-map-event"/>The <literal>::map-event</literal> signal</title>

5354

5604

<indexterm><primary>GtkWidget::map-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5355

5605

5356

5606

5368

5618

5369

5619

5370

5620

</simpara></listitem></varlistentry>

5371

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-mnemonic-activate"/>The "mnemonic-activate" signal</title>

5621

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-mnemonic-activate"/>The <literal>::mnemonic-activate</literal> signal</title>

5372

5622

<indexterm><primary>GtkWidget::mnemonic-activate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5373

5623

5374

5624

5386

5636

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>

5387

5637

5388

5638

</simpara></listitem></varlistentry>

5389

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-motion-notify-event"/>The "motion-notify-event" signal</title>

5639

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-motion-notify-event"/>The <literal>::motion-notify-event</literal> signal</title>

5390

5640

<indexterm><primary>GtkWidget::motion-notify-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5391

5641

5392

5642

5404

5654

5405

5655

5406

5656

</simpara></listitem></varlistentry>

5407

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-no-expose-event"/>The "no-expose-event" signal</title>

5657

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-move-focus"/>The <literal>::move-focus</literal> signal</title>

5658

<indexterm><primary>GtkWidget::move-focus</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5659

5660

5661

<para>

5662

5663

</para><variablelist role="params">

5664

<varlistentry><term><parameter>widget</parameter> :</term>

5665

<listitem><simpara>the object which received the signal.

5666

</simpara></listitem></varlistentry>

5667

5668

5669

5670

</simpara></listitem></varlistentry>

5671

5672

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5673

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-no-expose-event"/>The <literal>::no-expose-event</literal> signal</title>

5408

5674

<indexterm><primary>GtkWidget::no-expose-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5409

5675

5410

5676

5422

5688

5423

5689

5424

5690

</simpara></listitem></varlistentry>

5425

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-parent-set"/>The "parent-set" signal</title>

5691

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-parent-set"/>The <literal>::parent-set</literal> signal</title>

5426

5692

<indexterm><primary>GtkWidget::parent-set</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5427

5693

5428

5694

5429

5695

<para>

5430

The parent-set signal is emitted when a new parent has been set

5431

on a widget.</para>

5696

The ::parent-set signal is emitted when a new parent

5697

has been set on a widget.</para>

5432

5698

<para>

5433

5699

5434

5700

</para><variablelist role="params">

5441

5707

</simpara></listitem></varlistentry>

5442

5708

5443

5709

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5444

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-popup-menu"/>The "popup-menu" signal</title>

5710

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-popup-menu"/>The <literal>::popup-menu</literal> signal</title>

5445

5711

<indexterm><primary>GtkWidget::popup-menu</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5446

5712

5447

5713

<para>

5448

This signal gets emitted whenever a widget should pop up a context-sensitive

5449

menu. This usually happens through the standard key binding mechanism; by

5714

This signal gets emitted whenever a widget should pop up a context menu.

5715

This usually happens through the standard key binding mechanism; by

5450

5716

pressing a certain key while a widget is focused, the user can cause the

5451

widget to pop up a menu. For example, the <link linkend="GtkEntry"><type>GtkEntry</type></link> widget creates a menu

5452

with clipboard commands. See <xref linkend="checklist-popup-menu"/> for an

5453

example of how to use this signal.</para>

5717

widget to pop up a menu. For example, the <link linkend="GtkEntry"><type>GtkEntry</type></link> widget creates a

5718

menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>

5719

for an example of how to use this signal.</para>

5454

5720

<para>

5455

5721

5456

5722

</para><variablelist role="params">

5458

5724

<listitem><simpara> the object which received the signal

5459

5725

</simpara></listitem></varlistentry>

5460

5726

<varlistentry><term><parameter>returns</parameter> :</term>

5461

<listitem><simpara> TRUE if a menu was activated

5727

<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a menu was activated

5462

5728

</simpara></listitem></varlistentry>

5463

5729

5464

5730

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5465

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-property-notify-event"/>The "property-notify-event" signal</title>

5731

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-property-notify-event"/>The <literal>::property-notify-event</literal> signal</title>

5466

5732

<indexterm><primary>GtkWidget::property-notify-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5467

5733

5468

5734

5480

5746

5481

5747

5482

5748

</simpara></listitem></varlistentry>

5483

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-proximity-in-event"/>The "proximity-in-event" signal</title>

5749

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-proximity-in-event"/>The <literal>::proximity-in-event</literal> signal</title>

5484

5750

<indexterm><primary>GtkWidget::proximity-in-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5485

5751

5486

5752

5498

5764

5499

5765

5500

5766

</simpara></listitem></varlistentry>

5501

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-proximity-out-event"/>The "proximity-out-event" signal</title>

5767

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-proximity-out-event"/>The <literal>::proximity-out-event</literal> signal</title>

5502

5768

<indexterm><primary>GtkWidget::proximity-out-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5503

5769

5504

5770

5516

5782

5517

5783

5518

5784

</simpara></listitem></varlistentry>

5519

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-realize"/>The "realize" signal</title>

5785

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-query-tooltip"/>The <literal>::query-tooltip</literal> signal</title>

5786

<indexterm role="2.12"><primary>GtkWidget::query-tooltip</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5787

5788

5789

5790

5791

5792

<para>

5793

Emitted when the <link linkend="GtkSettings--gtk-tooltip-timeout"><type>:gtk-tooltip-timeout</type></link> has expired with

5794

the cursor hovering "above" <parameter>widget</parameter>; or emitted when <parameter>widget</parameter> got

5795

focus in keyboard mode.

5796

</para>

5797

<para>

5798

Using the given coordinates, the signal handler should determine

5799

whether a tooltip should be shown for <parameter>widget</parameter>. If this is the case

5800

5801

<parameter>keyboard_mode</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the values of <parameter>x</parameter> and <parameter>y</parameter> are undefined and

5802

should not be used.

5803

</para>

5804

<para>

5805

The signal handler is free to manipulate <parameter>tooltip</parameter> with the therefore

5806

destined function calls.</para>

5807

<para>

5808

5809

</para><variablelist role="params">

5810

<varlistentry><term><parameter>widget</parameter> :</term>

5811

<listitem><simpara> the object which received the signal

5812

</simpara></listitem></varlistentry>

5813

5814

<listitem><simpara> the x coordinate of the cursor position where the request has been

5815

emitted, relative to <parameter>widget->window</parameter>

5816

</simpara></listitem></varlistentry>

5817

5818

<listitem><simpara> the y coordinate of the cursor position where the request has been

5819

emitted, relative to <parameter>widget->window</parameter>

5820

</simpara></listitem></varlistentry>

5821

<varlistentry><term><parameter>keyboard_mode</parameter> :</term>

5822

<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the tooltip was trigged using the keyboard

5823

</simpara></listitem></varlistentry>

5824

<varlistentry><term><parameter>tooltip</parameter> :</term>

5825

<listitem><simpara> a <link linkend="GtkTooltip"><type>GtkTooltip</type></link>

5826

</simpara></listitem></varlistentry>

5827

5828

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5829

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>tooltip</parameter> should be shown right now, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.

5830

5831

</simpara></listitem></varlistentry>

5832

</variablelist><para>Since 2.12

5833

</para></refsect2><refsect2><title><anchor id="GtkWidget-realize"/>The <literal>::realize</literal> signal</title>

5520

5834

<indexterm><primary>GtkWidget::realize</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5521

5835

5522

5836

<para>

5528

5842

</simpara></listitem></varlistentry>

5529

5843

5530

5844

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5531

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-screen-changed"/>The "screen-changed" signal</title>

5845

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-screen-changed"/>The <literal>::screen-changed</literal> signal</title>

5532

5846

<indexterm><primary>GtkWidget::screen-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5533

5534

5847

5848

5849

<para>

5850

The ::screen-changed signal gets emitted when the

5851

screen of a widget has changed.</para>

5535

5852

<para>

5536

5853

5537

5854

</para><variablelist role="params">

5538

5855

<varlistentry><term><parameter>widget</parameter> :</term>

5539

<listitem><simpara>the object which received the signal.

5856

<listitem><simpara> the object on which the signal is emitted

5540

5857

</simpara></listitem></varlistentry>

5541

5542

5543

5858

<varlistentry><term><parameter>previous_screen</parameter> :</term>

5859

<listitem><simpara> the previous screen, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the

5860

widget was not associated with a screen before

5544

5861

</simpara></listitem></varlistentry>

5545

5862

5546

5863

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5547

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-scroll-event"/>The "scroll-event" signal</title>

5864

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-scroll-event"/>The <literal>::scroll-event</literal> signal</title>

5548

5865

<indexterm><primary>GtkWidget::scroll-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5549

5866

5550

5867

5562

5879

5563

5880

5564

5881

</simpara></listitem></varlistentry>

5565

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-clear-event"/>The "selection-clear-event" signal</title>

5882

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-clear-event"/>The <literal>::selection-clear-event</literal> signal</title>

5566

5883

<indexterm><primary>GtkWidget::selection-clear-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5567

5884

5568

5885

5580

5897

5581

5898

5582

5899

</simpara></listitem></varlistentry>

5583

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-get"/>The "selection-get" signal</title>

5900

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-get"/>The <literal>::selection-get</literal> signal</title>

5584

5901

<indexterm><primary>GtkWidget::selection-get</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5585

5902

5586

5903

5604

5921

</simpara></listitem></varlistentry>

5605

5922

5606

5923

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5607

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-notify-event"/>The "selection-notify-event" signal</title>

5924

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-notify-event"/>The <literal>::selection-notify-event</literal> signal</title>

5608

5925

<indexterm><primary>GtkWidget::selection-notify-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5609

5926

5610

5927

5622

5939

5623

5940

5624

5941

</simpara></listitem></varlistentry>

5625

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-received"/>The "selection-received" signal</title>

5942

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-received"/>The <literal>::selection-received</literal> signal</title>

5626

5943

<indexterm><primary>GtkWidget::selection-received</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5627

5944

5628

5945

5642

5959

</simpara></listitem></varlistentry>

5643

5960

5644

5961

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5645

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-request-event"/>The "selection-request-event" signal</title>

5962

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-selection-request-event"/>The <literal>::selection-request-event</literal> signal</title>

5646

5963

<indexterm><primary>GtkWidget::selection-request-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5647

5964

5648

5965

5660

5977

5661

5978

5662

5979

</simpara></listitem></varlistentry>

5663

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-show"/>The "show" signal</title>

5980

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-show"/>The <literal>::show</literal> signal</title>

5664

5981

<indexterm><primary>GtkWidget::show</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5665

5982

5666

5983

<para>

5672

5989

</simpara></listitem></varlistentry>

5673

5990

5674

5991

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5675

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-show-help"/>The "show-help" signal</title>

5992

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-show-help"/>The <literal>::show-help</literal> signal</title>

5676

5993

<indexterm><primary>GtkWidget::show-help</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5677

5994

5678

5995

5690

6007

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>

5691

6008

5692

6009

</simpara></listitem></varlistentry>

5693

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-size-allocate"/>The "size-allocate" signal</title>

6010

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-size-allocate"/>The <literal>::size-allocate</literal> signal</title>

5694

6011

<indexterm><primary>GtkWidget::size-allocate</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5695

6012

5696

6013

5706

6023

</simpara></listitem></varlistentry>

5707

6024

5708

6025

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5709

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-size-request"/>The "size-request" signal</title>

6026

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-size-request"/>The <literal>::size-request</literal> signal</title>

5710

6027

<indexterm><primary>GtkWidget::size-request</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5711

6028

5712

6029

5722

6039

</simpara></listitem></varlistentry>

5723

6040

5724

6041

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5725

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-state-changed"/>The "state-changed" signal</title>

6042

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-state-changed"/>The <literal>::state-changed</literal> signal</title>

5726

6043

<indexterm><primary>GtkWidget::state-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5727

6044

5728

6045

5738

6055

</simpara></listitem></varlistentry>

5739

6056

5740

6057

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5741

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-style-set"/>The "style-set" signal</title>

6058

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-style-set"/>The <literal>::style-set</literal> signal</title>

5742

6059

<indexterm><primary>GtkWidget::style-set</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5743

6060

5744

6061

5745

6062

<para>

5746

The style-set signal is emitted when a new style has been set

6063

The ::style-set signal is emitted when a new style has been set

5747

6064

on a widget. Note that style-modifying functions like

5748

6065

5749

6066

<para>

5758

6075

</simpara></listitem></varlistentry>

5759

6076

5760

6077

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5761

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-unmap"/>The "unmap" signal</title>

6078

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-unmap"/>The <literal>::unmap</literal> signal</title>

5762

6079

<indexterm><primary>GtkWidget::unmap</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5763

6080

5764

6081

<para>

5770

6087

</simpara></listitem></varlistentry>

5771

6088

5772

6089

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5773

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-unmap-event"/>The "unmap-event" signal</title>

6090

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-unmap-event"/>The <literal>::unmap-event</literal> signal</title>

5774

6091

<indexterm><primary>GtkWidget::unmap-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5775

6092

5776

6093

5788

6105

5789

6106

5790

6107

</simpara></listitem></varlistentry>

5791

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-unrealize"/>The "unrealize" signal</title>

6108

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-unrealize"/>The <literal>::unrealize</literal> signal</title>

5792

6109

<indexterm><primary>GtkWidget::unrealize</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5793

6110

5794

6111

<para>

5800

6117

</simpara></listitem></varlistentry>

5801

6118

5802

6119

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>

5803

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-visibility-notify-event"/>The "visibility-notify-event" signal</title>

6120

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-visibility-notify-event"/>The <literal>::visibility-notify-event</literal> signal</title>

5804

6121

<indexterm><primary>GtkWidget::visibility-notify-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5805

6122

5806

6123

5818

6135

5819

6136

5820

6137

</simpara></listitem></varlistentry>

5821

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-window-state-event"/>The "window-state-event" signal</title>

6138

</variablelist></refsect2><refsect2><title><anchor id="GtkWidget-window-state-event"/>The <literal>::window-state-event</literal> signal</title>

5822

6139

<indexterm><primary>GtkWidget::window-state-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GtkWidget">GtkWidget</link> *widget,

5823

6140

5824

6141

Older »