2702
2701
<return></return>
2704
<signal name="GtkLevelBar::offset-changed">
2706
Emitted when an offset specified on the bar changes value as an
2707
effect to gtk_level_bar_add_offset_value() being called.
2709
The signal supports detailed connections; you can connect to the
2710
detailed signal "changed::x" in order to only receive callbacks when
2711
the value of offset "x" changes.
2717
<parameter name="self">
2718
<parameter_description> a #GtkLevelBar
2719
</parameter_description>
2721
<parameter name="name">
2722
<parameter_description> the name of the offset that changed value
2723
</parameter_description>
2705
2729
<signal name="GtkLinkButton::activate-link">
2707
2731
The ::activate-link signal is emitted each time the #GtkLinkButton
6298
6322
If the data was received in response to a #GtkWidget::drag-drop signal
6299
6323
(and this is the last target to be received), the handler for this
6300
6324
signal is expected to process the received data and then call
6301
gtk_drag_finish(), setting the @success parameter depending on whether
6302
the data was processed successfully.
6325
gtk_drag_finish(), setting the @success parameter depending on
6326
whether the data was processed successfully.
6304
The handler may inspect and modify @drag_context->action before calling
6305
gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the
6328
The handler may inspect the selected action with
6329
gdk_drag_context_get_selected_action() before calling
6330
gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as
6331
shown in the following example:
6309
6334
drag_data_received (GtkWidget *widget,
6310
GdkDragContext *drag_context,
6335
GdkDragContext *context,
6313
6338
GtkSelectionData *data,
6331
6361
gtk_widget_destroy (dialog);
6333
6363
if (response == GTK_RESPONSE_YES)
6334
drag_context->action = GDK_ACTION_MOVE;
6336
drag_context->action = GDK_ACTION_COPY;
6339
gtk_drag_finish (drag_context, TRUE, FALSE, time);
6343
gtk_drag_finish (drag_context, FALSE, FALSE, time);
6364
action = GDK_ACTION_MOVE;
6366
action = GDK_ACTION_COPY;
6369
gtk_drag_finish (context, TRUE, action == GDK_ACTION_MOVE, time);
6372
gtk_drag_finish (context, FALSE, FALSE, time);
8877
<function name="gtk_accel_label_set_accel">
8879
Manually sets a keyval and modifier mask as the accelerator rendered
8882
If a keyval and modifier are explicitly set then these values are
8883
used regardless of any associated accel closure or widget.
8885
Providing an @accelerator_key of 0 removes the manual setting.
8891
<parameter name="accel_label">
8892
<parameter_description> a #GtkAccelLabel
8893
</parameter_description>
8895
<parameter name="accelerator_key">
8896
<parameter_description> a keyval, or 0
8897
</parameter_description>
8899
<parameter name="accelerator_mods">
8900
<parameter_description> the modifier mask for the accel
8901
</parameter_description>
8841
8907
<function name="gtk_accel_label_set_accel_closure">
8843
8909
Sets the closure to be monitored by this accelerator label. The closure
11447
11552
Sets the minimum value of the adjustment.
11449
11554
When setting multiple adjustment properties via their individual
11450
setters, multiple "changed" signals will be emitted. However, since
11451
the emission of the "changed" signal is tied to the emission of the
11452
"GObject::notify" signals of the changed properties, it's possible
11453
to compress the "changed" signals into one by calling
11555
setters, multiple #GtkAdjustment::changed signals will be emitted. However, since
11556
the emission of the #GtkAdjustment::changed signal is tied to the emission of the
11557
#GObject::notify signals of the changed properties, it's possible
11558
to compress the #GtkAdjustment::changed signals into one by calling
11454
11559
g_object_freeze_notify() and g_object_thaw_notify() around the
11455
11560
calls to the individual setters.
11457
11562
Alternatively, using a single g_object_set() for all the properties
11458
11563
to change, or using gtk_adjustment_configure() has the same effect
11459
of compressing "changed" emissions.
11564
of compressing #GtkAdjustment::changed emissions.
12485
12590
<return></return>
12593
<function name="gtk_application_get_active_window">
12595
Gets the "active" window for the application.
12597
The active window is the one that was most recently focused (within
12598
the application). This window may not have the focus at the moment
12599
if another application has it -- this is just the most
12600
recently-focused window within this application.
12606
<parameter name="application">
12607
<parameter_description> a #GtkApplication
12608
</parameter_description>
12611
<return> the active window
12488
12616
<function name="gtk_application_get_app_menu">
12489
12617
<description>
12490
12618
Returns the menu model that has been set with
24452
24591
<function name="gtk_drag_begin">
24453
24592
<description>
24454
Initiates a drag on the source side. The function
24455
only needs to be used when the application is
24456
starting drags itself, and is not needed when
24457
gtk_drag_source_set() is used.
24459
The @event is used to retrieve the timestamp that will be used internally to
24460
grab the pointer. If @event is #NULL, then GDK_CURRENT_TIME will be used.
24461
However, you should try to pass a real event in all cases, since that can be
24462
used by GTK+ to get information about the start position of the drag, for
24463
example if the @event is a %GDK_MOTION_NOTIFY.
24465
Generally there are three cases when you want to start a drag by hand by
24466
calling this function:
24468
1. During a #GtkWidget::button-press-event handler, if you want to start a drag
24469
immediately when the user presses the mouse button. Pass the @event
24470
that you have in your #GtkWidget::button-press-event handler.
24472
2. During a #GtkWidget::motion-notify-event handler, if you want to start a drag
24473
when the mouse moves past a certain threshold distance after a button-press.
24474
Pass the @event that you have in your #GtkWidget::motion-notify-event handler.
24476
3. During a timeout handler, if you want to start a drag after the mouse
24477
button is held down for some time. Try to save the last event that you got
24478
from the mouse, using gdk_event_copy(), and pass it to this function
24479
(remember to free the event with gdk_event_free() when you are done).
24480
If you can really not pass a real event, pass #NULL instead.
24483
24594
</description>
24665
24731
</parameter_description>
24667
24733
</parameters>
24668
<return> %TRUE if the widget always emits
24669
#GtkWidget::drag-motion events
24674
24737
<function name="gtk_drag_dest_set">
24675
24738
<description>
24676
Sets a widget as a potential drop destination, and adds default behaviors.
24678
The default behaviors listed in @flags have an effect similar
24679
to installing default handlers for the widget's drag-and-drop signals
24680
(#GtkWidget::drag-motion, #GtkWidget::drag-drop, ...). They all exist
24681
for convenience. When passing #GTK_DEST_DEFAULT_ALL for instance it is
24682
sufficient to connect to the widget's #GtkWidget::drag-data-received
24683
signal to get primitive, but consistent drag-and-drop support.
24685
Things become more complicated when you try to preview the dragged data,
24686
as described in the documentation for #GtkWidget::drag-motion. The default
24687
behaviors described by @flags make some assumptions, that can conflict
24688
with your own signal handlers. For instance #GTK_DEST_DEFAULT_DROP causes
24689
invokations of gdk_drag_status() in the context of #GtkWidget::drag-motion,
24690
and invokations of gtk_drag_finish() in #GtkWidget::drag-data-received.
24691
Especially the later is dramatic, when your own #GtkWidget::drag-motion
24692
handler calls gtk_drag_get_data() to inspect the dragged data.
24694
There's no way to set a default action here, you can use the
24695
#GtkWidget::drag-motion callback for that. Here's an example which selects
24696
the action to use depending on whether the control key is pressed or not:
24699
drag_motion (GtkWidget *widget,
24700
GdkDragContext *context,
24705
GdkModifierType mask;
24707
gdk_window_get_pointer (gtk_widget_get_window (widget),
24708
NULL, NULL, &mask);
24709
if (mask & GDK_CONTROL_MASK)
24710
gdk_drag_status (context, GDK_ACTION_COPY, time);
24712
gdk_drag_status (context, GDK_ACTION_MOVE, time);
24716
24740
</description>
27859
27889
<return></return>
27892
<function name="gtk_entry_set_input_hints">
27894
Sets the #GtkEntry:input-hints property, which
27895
allows input methods to fine-tune their behaviour.
27901
<parameter name="entry">
27902
<parameter_description> a #GtkEntry
27903
</parameter_description>
27905
<parameter name="hints">
27906
<parameter_description> the hints
27907
</parameter_description>
27913
<function name="gtk_entry_set_input_purpose">
27915
Sets the #GtkEntry:input-purpose property which
27916
can be used by on-screen keyboards and other input
27917
methods to adjust their behaviour.
27923
<parameter name="entry">
27924
<parameter_description> a #GtkEntry
27925
</parameter_description>
27927
<parameter name="purpose">
27928
<parameter_description> the purpose
27929
</parameter_description>
27862
27935
<function name="gtk_entry_set_invisible_char">
27863
27936
<description>
27864
27937
Sets the character to use in place of the actual text when
28026
28099
<function name="gtk_entry_set_visibility">
28027
28100
<description>
28028
Sets whether the contents of the entry are visible or not.
28029
When visibility is set to %FALSE, characters are displayed
28030
as the invisible char, and will also appear that way when
28101
Sets whether the contents of the entry are visible or not.
28102
When visibility is set to %FALSE, characters are displayed
28103
as the invisible char, and will also appear that way when
28031
28104
the text in the entry widget is copied elsewhere.
28033
28106
By default, GTK+ picks the best invisible character available
28034
28107
in the current font, but it can be changed with
28035
28108
gtk_entry_set_invisible_char().
28110
Note that you probably want to set #GtkEntry:input-purpose
28111
to %GTK_INPUT_PURPOSE_PASSWORD or %GTK_INPUT_PURPOSE_PIN to
28112
inform input methods about the purpose of this entry,
28113
in addition to setting visibility to %FALSE.
28037
28115
</description>
28039
28117
<parameter name="entry">
39559
39638
<return></return>
39641
<function name="gtk_level_bar_add_offset_value">
39643
Adds a new offset marker on @self at the position specified by @value.
39644
When the bar value is in the interval topped by @value (or between @value
39645
and #GtkLevelBar:max-value in case the offset is the last one on the bar)
39646
a style class named <literal>level-</literal>@name will be applied
39647
when rendering the level bar fill.
39648
If another offset marker named @name exists, its value will be
39649
replaced by @value.
39655
<parameter name="self">
39656
<parameter_description> a #GtkLevelBar
39657
</parameter_description>
39659
<parameter name="name">
39660
<parameter_description> the name of the new offset
39661
</parameter_description>
39663
<parameter name="value">
39664
<parameter_description> the value for the new offset
39665
</parameter_description>
39671
<function name="gtk_level_bar_get_max_value">
39673
Returns the value of the #GtkLevelBar:max-value property.
39679
<parameter name="self">
39680
<parameter_description> a #GtkLevelBar
39681
</parameter_description>
39684
<return> a positive value
39689
<function name="gtk_level_bar_get_min_value">
39691
Returns the value of the #GtkLevelBar:min-value property.
39697
<parameter name="self">
39698
<parameter_description> a #GtkLevelBar
39699
</parameter_description>
39702
<return> a positive value
39707
<function name="gtk_level_bar_get_mode">
39709
Returns the value of the #GtkLevelBar:mode property.
39715
<parameter name="self">
39716
<parameter_description> a #GtkLevelBar
39717
</parameter_description>
39720
<return> a #GtkLevelBarMode
39725
<function name="gtk_level_bar_get_offset_value">
39727
Fetches the value specified for the offset marker @name in @self,
39728
returning %TRUE in case an offset named @name was found.
39734
<parameter name="self">
39735
<parameter_description> a #GtkLevelBar
39736
</parameter_description>
39738
<parameter name="name">
39739
<parameter_description> the name of an offset in the bar
39740
</parameter_description>
39742
<parameter name="value">
39743
<parameter_description> location where to store the value
39744
</parameter_description>
39747
<return> %TRUE if the specified offset is found
39752
<function name="gtk_level_bar_get_value">
39754
Returns the value of the #GtkLevelBar:value property.
39760
<parameter name="self">
39761
<parameter_description> a #GtkLevelBar
39762
</parameter_description>
39765
<return> a value in the interval between
39766
#GtkLevelBar:min-value and #GtkLevelBar:max-value
39771
<function name="gtk_level_bar_new">
39773
Creates a new #GtkLevelBar.
39780
<return> a #GtkLevelBar.
39785
<function name="gtk_level_bar_new_for_interval">
39787
Utility constructor that creates a new #GtkLevelBar for the specified
39794
<parameter name="min_value">
39795
<parameter_description> a positive value
39796
</parameter_description>
39798
<parameter name="max_value">
39799
<parameter_description> a positive value
39800
</parameter_description>
39803
<return> a #GtkLevelBar
39808
<function name="gtk_level_bar_remove_offset_value">
39810
Removes an offset marker previously added with
39811
gtk_level_bar_add_offset_value().
39817
<parameter name="self">
39818
<parameter_description> a #GtkLevelBar
39819
</parameter_description>
39821
<parameter name="name">
39822
<parameter_description> the name of an offset in the bar
39823
</parameter_description>
39829
<function name="gtk_level_bar_set_max_value">
39831
Sets the value of the #GtkLevelBar:max-value property.
39837
<parameter name="self">
39838
<parameter_description> a #GtkLevelBar
39839
</parameter_description>
39841
<parameter name="value">
39842
<parameter_description> a positive value
39843
</parameter_description>
39849
<function name="gtk_level_bar_set_min_value">
39851
Sets the value of the #GtkLevelBar:min-value property.
39857
<parameter name="self">
39858
<parameter_description> a #GtkLevelBar
39859
</parameter_description>
39861
<parameter name="value">
39862
<parameter_description> a positive value
39863
</parameter_description>
39869
<function name="gtk_level_bar_set_mode">
39871
Sets the value of the #GtkLevelBar:mode property.
39877
<parameter name="self">
39878
<parameter_description> a #GtkLevelBar
39879
</parameter_description>
39881
<parameter name="mode">
39882
<parameter_description> a #GtkLevelBarMode
39883
</parameter_description>
39889
<function name="gtk_level_bar_set_value">
39891
Sets the value of the #GtkLevelBar:value property.
39897
<parameter name="self">
39898
<parameter_description> a #GtkLevelBar
39899
</parameter_description>
39901
<parameter name="value">
39902
<parameter_description> a value in the interval between
39903
#GtkLevelBar:min-value and #GtkLevelBar:max-value
39904
</parameter_description>
39562
39910
<function name="gtk_link_button_get_uri">
39563
39911
<description>
39564
39912
Retrieves the URI set using gtk_link_button_set_uri().
39721
40069
<function name="gtk_list_store_insert">
39722
40070
<description>
39723
40071
Creates a new row at @position. @iter will be changed to point to this new
39724
row. If @position is larger than the number of rows on the list, then the
39725
new row will be appended to the list. The row will be empty after this
39726
function is called. To fill in values, you need to call
40072
row. If @position is -1 or is larger than the number of rows on the list,
40073
then the new row will be appended to the list. The row will be empty after
40074
this function is called. To fill in values, you need to call
39727
40075
gtk_list_store_set() or gtk_list_store_set_value().
41835
42183
<return></return>
42186
<function name="gtk_menu_shell_bind_model">
42188
Establishes a binding between a #GtkMenuShell and a #GMenuModel.
42190
The contents of @shell are removed and then refilled with menu items
42191
according to @model. When @model changes, @shell is updated.
42192
Calling this function twice on @shell with different @model will
42193
cause the first binding to be replaced with a binding to the new
42194
model. If @model is %NULL then any previous binding is undone and
42195
all children are removed.
42197
@with_separators determines if toplevel items (eg: sections) have
42198
separators inserted between them. This is typically desired for
42199
menus but doesn't make sense for menubars.
42201
If @action_namespace is non-%NULL then the effect is as if all
42202
actions mentioned in the @model have their names prefixed with the
42203
namespace, plus a dot. For example, if the action "quit" is
42204
mentioned and @action_namespace is "app" then the effective action
42205
name is "app.quit".
42207
For most cases you are probably better off using
42208
gtk_menu_new_from_model() or gtk_menu_bar_new_from_model() or just
42209
directly passing the #GMenuModel to gtk_application_set_app_menu() or
42210
gtk_application_set_menu_bar().
42216
<parameter name="menu_shell">
42217
<parameter_description> a #GtkMenuShell
42218
</parameter_description>
42220
<parameter name="model">
42221
<parameter_description> the #GMenuModel to bind to or %NULL to remove
42223
</parameter_description>
42225
<parameter name="action_namespace">
42226
<parameter_description> the namespace for actions in @model
42227
</parameter_description>
42229
<parameter name="with_separators">
42230
<parameter_description> %TRUE if toplevel items in @shell should have
42231
separators between them
42232
</parameter_description>
41838
42238
<function name="gtk_menu_shell_cancel">
41839
42239
<description>
41840
42240
Cancels the selection within the menu shell.
70067
70493
<return></return>
70496
<function name="gtk_text_view_set_input_hints">
70498
Sets the #GtkTextView:input-hints property, which
70499
allows input methods to fine-tune their behaviour.
70505
<parameter name="text_view">
70506
<parameter_description> a #GtkTextView
70507
</parameter_description>
70509
<parameter name="hints">
70510
<parameter_description> the hints
70511
</parameter_description>
70517
<function name="gtk_text_view_set_input_purpose">
70519
Sets the #GtkTextView:input-purpose property which
70520
can be used by on-screen keyboards and other input
70521
methods to adjust their behaviour.
70527
<parameter name="text_view">
70528
<parameter_description> a #GtkTextView
70529
</parameter_description>
70531
<parameter name="purpose">
70532
<parameter_description> the purpose
70533
</parameter_description>
70070
70539
<function name="gtk_text_view_set_justification">
70071
70540
<description>
70072
70541
Sets the default justification of text in @text_view.
76340
76810
<description>
76341
76811
Creates a new row at @position. If parent is non-%NULL, then the row will be
76342
76812
made a child of @parent. Otherwise, the row will be created at the toplevel.
76343
If @position is larger than the number of rows at that level, then the new
76344
row will be inserted to the end of the list. @iter will be changed to point
76345
to this new row. The row will be empty after this function is called. To
76346
fill in values, you need to call gtk_tree_store_set() or
76813
If @position is -1 or is larger than the number of rows at that level, then
76814
the new row will be inserted to the end of the list. @iter will be changed
76815
to point to this new row. The row will be empty after this function is
76816
called. To fill in values, you need to call gtk_tree_store_set() or
76347
76817
gtk_tree_store_set_value().
83850
84320
<return></return>
84323
<function name="gtk_widget_insert_action_group">
84325
Inserts @group into @widget. Children of @widget that implement
84326
#GtkActionable can then be associated with actions in @group by
84327
setting their 'action-name' to
84328
@prefix.<replaceable>action-name</replaceable>.
84334
<parameter name="widget">
84335
<parameter_description> a #GtkWidget
84336
</parameter_description>
84338
<parameter name="name">
84339
<parameter_description> the prefix for actions in @group
84340
</parameter_description>
84342
<parameter name="group">
84343
<parameter_description> a #GActionGroup
84344
</parameter_description>
83853
84350
<function name="gtk_widget_intersect">
83854
84351
<description>
83855
84352
Computes the intersection of a @widget's area and @area, storing
added
removed
gtk/src/gtk_docs.xml
