1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
use crate::{NavigationDirection, SwipeTracker};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem, mem::transmute};
glib::wrapper! {
/// An interface for swipeable widgets.
///
/// The [`Swipeable`][crate::Swipeable] interface is implemented by all swipeable widgets. They
/// can be synced using [`SwipeGroup`][crate::SwipeGroup].
///
/// See [`SwipeTracker`][crate::SwipeTracker] for details about implementing it.
///
/// ## Signals
///
///
/// #### `child-switched`
/// Emitted when the widget's visible child is changed.
///
/// @duration can be 0 if the child is switched without animation.
///
/// This is used by [`SwipeGroup`][crate::SwipeGroup], applications should not connect to it.
///
///
/// <details><summary><h4>Widget</h4></summary>
///
///
/// #### `accel-closures-changed`
///
///
///
/// #### `button-press-event`
/// The ::button-press-event signal will be emitted when a button
/// (typically from a mouse) is pressed.
///
/// To receive this signal, the #GdkWindow associated to the
/// widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `button-release-event`
/// The ::button-release-event signal will be emitted when a button
/// (typically from a mouse) is released.
///
/// To receive this signal, the #GdkWindow associated to the
/// widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `can-activate-accel`
/// Determines whether an accelerator that activates the signal
/// identified by @signal_id can currently be activated.
/// This signal is present to allow applications and derived
/// widgets to override the default #GtkWidget handling
/// for determining whether an accelerator can be activated.
///
///
///
///
/// #### `child-notify`
/// The ::child-notify signal is emitted for each
/// [child property][child-properties] that has
/// changed on an object. The signal's detail holds the property name.
///
/// Detailed
///
///
/// #### `composited-changed`
/// The ::composited-changed signal is emitted when the composited
/// status of @widgets screen changes.
/// See gdk_screen_is_composited().
///
/// Action
///
///
/// #### `configure-event`
/// The ::configure-event signal will be emitted when the size, position or
/// stacking of the @widget's window has changed.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
/// automatically for all new windows.
///
///
///
///
/// #### `damage-event`
/// Emitted when a redirected window belonging to @widget gets drawn into.
/// The region/area members of the event shows what area of the redirected
/// drawable was drawn into.
///
///
///
///
/// #### `delete-event`
/// The ::delete-event signal is emitted if a user requests that
/// a toplevel window is closed. The default handler for this signal
/// destroys the window. Connecting gtk_widget_hide_on_delete() to
/// this signal will cause the window to be hidden instead, so that
/// it can later be shown again without reconstructing it.
///
///
///
///
/// #### `destroy`
/// Signals that all holders of a reference to the widget should release
/// the reference that they hold. May result in finalization of the widget
/// if all references are released.
///
/// This signal is not suitable for saving widget state.
///
///
///
///
/// #### `destroy-event`
/// The ::destroy-event signal is emitted when a #GdkWindow is destroyed.
/// You rarely get this signal, because most widgets disconnect themselves
/// from their window before they destroy it, so no widget owns the
/// window at destroy time.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
/// automatically for all new windows.
///
///
///
///
/// #### `direction-changed`
/// The ::direction-changed signal is emitted when the text direction
/// of a widget changes.
///
///
///
///
/// #### `drag-begin`
/// The ::drag-begin signal is emitted on the drag source when a drag is
/// started. A typical reason to connect to this signal is to set up a
/// custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().
///
/// Note that some widgets set up a drag icon in the default handler of
/// this signal, so you may have to use g_signal_connect_after() to
/// override what the default handler did.
///
///
///
///
/// #### `drag-data-delete`
/// The ::drag-data-delete signal is emitted on the drag source when a drag
/// with the action `GDK_ACTION_MOVE` is successfully completed. The signal
/// handler is responsible for deleting the data that has been dropped. What
/// "delete" means depends on the context of the drag operation.
///
///
///
///
/// #### `drag-data-get`
/// The ::drag-data-get signal is emitted on the drag source when the drop
/// site requests the data which is dragged. It is the responsibility of
/// the signal handler to fill @data with the data in the format which
/// is indicated by @info. See gtk_selection_data_set() and
/// gtk_selection_data_set_text().
///
///
///
///
/// #### `drag-data-received`
/// The ::drag-data-received signal is emitted on the drop site when the
/// dragged data has been received. If the data was received in order to
/// determine whether the drop will be accepted, the handler is expected
/// to call gdk_drag_status() and not finish the drag.
/// If the data was received in response to a #GtkWidget::drag-drop signal
/// (and this is the last target to be received), the handler for this
/// signal is expected to process the received data and then call
/// gtk_drag_finish(), setting the @success parameter depending on
/// whether the data was processed successfully.
///
/// Applications must create some means to determine why the signal was emitted
/// and therefore whether to call gdk_drag_status() or gtk_drag_finish().
///
/// The handler may inspect the selected action with
/// gdk_drag_context_get_selected_action() before calling
/// gtk_drag_finish(), e.g. to implement `GDK_ACTION_ASK` as
/// shown in the following example:
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// void
/// drag_data_received (GtkWidget *widget,
/// GdkDragContext *context,
/// gint x,
/// gint y,
/// GtkSelectionData *data,
/// guint info,
/// guint time)
/// {
/// if ((data->length >= 0) && (data->format == 8))
/// {
/// GdkDragAction action;
///
/// // handle data here
///
/// action = gdk_drag_context_get_selected_action (context);
/// if (action == GDK_ACTION_ASK)
/// {
/// GtkWidget *dialog;
/// gint response;
///
/// dialog = gtk_message_dialog_new (NULL,
/// GTK_DIALOG_MODAL |
/// GTK_DIALOG_DESTROY_WITH_PARENT,
/// GTK_MESSAGE_INFO,
/// GTK_BUTTONS_YES_NO,
/// "Move the data ?\n");
/// response = gtk_dialog_run (GTK_DIALOG (dialog));
/// gtk_widget_destroy (dialog);
///
/// if (response == GTK_RESPONSE_YES)
/// action = GDK_ACTION_MOVE;
/// else
/// action = GDK_ACTION_COPY;
/// }
///
/// gtk_drag_finish (context, TRUE, action == GDK_ACTION_MOVE, time);
/// }
/// else
/// gtk_drag_finish (context, FALSE, FALSE, time);
/// }
/// ```
///
///
///
///
/// #### `drag-drop`
/// The ::drag-drop signal is emitted on the drop site when the user drops
/// the data onto the widget. The signal handler must determine whether
/// the cursor position is in a drop zone or not. If it is not in a drop
/// zone, it returns [`false`] and no further processing is necessary.
/// Otherwise, the handler returns [`true`]. In this case, the handler must
/// ensure that gtk_drag_finish() is called to let the source know that
/// the drop is done. The call to gtk_drag_finish() can be done either
/// directly or in a #GtkWidget::drag-data-received handler which gets
/// triggered by calling gtk_drag_get_data() to receive the data for one
/// or more of the supported targets.
///
///
///
///
/// #### `drag-end`
/// The ::drag-end signal is emitted on the drag source when a drag is
/// finished. A typical reason to connect to this signal is to undo
/// things done in #GtkWidget::drag-begin.
///
///
///
///
/// #### `drag-failed`
/// The ::drag-failed signal is emitted on the drag source when a drag has
/// failed. The signal handler may hook custom code to handle a failed DnD
/// operation based on the type of error, it returns [`true`] is the failure has
/// been already handled (not showing the default "drag operation failed"
/// animation), otherwise it returns [`false`].
///
///
///
///
/// #### `drag-leave`
/// The ::drag-leave signal is emitted on the drop site when the cursor
/// leaves the widget. A typical reason to connect to this signal is to
/// undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
/// with gtk_drag_unhighlight().
///
///
/// Likewise, the #GtkWidget::drag-leave signal is also emitted before the
/// ::drag-drop signal, for instance to allow cleaning up of a preview item
/// created in the #GtkWidget::drag-motion signal handler.
///
///
///
///
/// #### `drag-motion`
/// The ::drag-motion signal is emitted on the drop site when the user
/// moves the cursor over the widget during a drag. The signal handler
/// must determine whether the cursor position is in a drop zone or not.
/// If it is not in a drop zone, it returns [`false`] and no further processing
/// is necessary. Otherwise, the handler returns [`true`]. In this case, the
/// handler is responsible for providing the necessary information for
/// displaying feedback to the user, by calling gdk_drag_status().
///
/// If the decision whether the drop will be accepted or rejected can't be
/// made based solely on the cursor position and the type of the data, the
/// handler may inspect the dragged data by calling gtk_drag_get_data() and
/// defer the gdk_drag_status() call to the #GtkWidget::drag-data-received
/// handler. Note that you must pass #GTK_DEST_DEFAULT_DROP,
/// #GTK_DEST_DEFAULT_MOTION or #GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set()
/// when using the drag-motion signal that way.
///
/// Also note that there is no drag-enter signal. The drag receiver has to
/// keep track of whether he has received any drag-motion signals since the
/// last #GtkWidget::drag-leave and if not, treat the drag-motion signal as
/// an "enter" signal. Upon an "enter", the handler will typically highlight
/// the drop site with gtk_drag_highlight().
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// static void
/// drag_motion (GtkWidget *widget,
/// GdkDragContext *context,
/// gint x,
/// gint y,
/// guint time)
/// {
/// GdkAtom target;
///
/// PrivateData *private_data = GET_PRIVATE_DATA (widget);
///
/// if (!private_data->drag_highlight)
/// {
/// private_data->drag_highlight = 1;
/// gtk_drag_highlight (widget);
/// }
///
/// target = gtk_drag_dest_find_target (widget, context, NULL);
/// if (target == GDK_NONE)
/// gdk_drag_status (context, 0, time);
/// else
/// {
/// private_data->pending_status
/// = gdk_drag_context_get_suggested_action (context);
/// gtk_drag_get_data (widget, context, target, time);
/// }
///
/// return TRUE;
/// }
///
/// static void
/// drag_data_received (GtkWidget *widget,
/// GdkDragContext *context,
/// gint x,
/// gint y,
/// GtkSelectionData *selection_data,
/// guint info,
/// guint time)
/// {
/// PrivateData *private_data = GET_PRIVATE_DATA (widget);
///
/// if (private_data->suggested_action)
/// {
/// private_data->suggested_action = 0;
///
/// // We are getting this data due to a request in drag_motion,
/// // rather than due to a request in drag_drop, so we are just
/// // supposed to call gdk_drag_status(), not actually paste in
/// // the data.
///
/// str = gtk_selection_data_get_text (selection_data);
/// if (!data_is_acceptable (str))
/// gdk_drag_status (context, 0, time);
/// else
/// gdk_drag_status (context,
/// private_data->suggested_action,
/// time);
/// }
/// else
/// {
/// // accept the drop
/// }
/// }
/// ```
///
///
///
///
/// #### `draw`
/// This signal is emitted when a widget is supposed to render itself.
/// The @widget's top left corner must be painted at the origin of
/// the passed in context and be sized to the values returned by
/// gtk_widget_get_allocated_width() and
/// gtk_widget_get_allocated_height().
///
/// Signal handlers connected to this signal can modify the cairo
/// context passed as @cr in any way they like and don't need to
/// restore it. The signal emission takes care of calling cairo_save()
/// before and cairo_restore() after invoking the handler.
///
/// The signal handler will get a @cr with a clip region already set to the
/// widget's dirty region, i.e. to the area that needs repainting. Complicated
/// widgets that want to avoid redrawing themselves completely can get the full
/// extents of the clip region with gdk_cairo_get_clip_rectangle(), or they can
/// get a finer-grained representation of the dirty region with
/// cairo_copy_clip_rectangle_list().
///
///
///
///
/// #### `enter-notify-event`
/// The ::enter-notify-event will be emitted when the pointer enters
/// the @widget's window.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_ENTER_NOTIFY_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `event`
/// The GTK+ main loop will emit three signals for each GDK event delivered
/// to a widget: one generic ::event signal, another, more specific,
/// signal that matches the type of event delivered (e.g.
/// #GtkWidget::key-press-event) and finally a generic
/// #GtkWidget::event-after signal.
///
///
///
///
/// #### `event-after`
/// After the emission of the #GtkWidget::event signal and (optionally)
/// the second more specific signal, ::event-after will be emitted
/// regardless of the previous two signals handlers return values.
///
///
///
///
/// #### `focus`
///
///
///
/// #### `focus-in-event`
/// The ::focus-in-event signal will be emitted when the keyboard focus
/// enters the @widget's window.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_FOCUS_CHANGE_MASK mask.
///
///
///
///
/// #### `focus-out-event`
/// The ::focus-out-event signal will be emitted when the keyboard focus
/// leaves the @widget's window.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_FOCUS_CHANGE_MASK mask.
///
///
///
///
/// #### `grab-broken-event`
/// Emitted when a pointer or keyboard grab on a window belonging
/// to @widget gets broken.
///
/// On X11, this happens when the grab window becomes unviewable
/// (i.e. it or one of its ancestors is unmapped), or if the same
/// application grabs the pointer or keyboard again.
///
///
///
///
/// #### `grab-focus`
/// Action
///
///
/// #### `grab-notify`
/// The ::grab-notify signal is emitted when a widget becomes
/// shadowed by a GTK+ grab (not a pointer or keyboard grab) on
/// another widget, or when it becomes unshadowed due to a grab
/// being removed.
///
/// A widget is shadowed by a gtk_grab_add() when the topmost
/// grab widget in the grab stack of its window group is not
/// its ancestor.
///
///
///
///
/// #### `hide`
/// The ::hide signal is emitted when @widget is hidden, for example with
/// gtk_widget_hide().
///
///
///
///
/// #### `hierarchy-changed`
/// The ::hierarchy-changed signal is emitted when the
/// anchored state of a widget changes. A widget is
/// “anchored” when its toplevel
/// ancestor is a #GtkWindow. This signal is emitted when
/// a widget changes from un-anchored to anchored or vice-versa.
///
///
///
///
/// #### `key-press-event`
/// The ::key-press-event signal is emitted when a key is pressed. The signal
/// emission will reoccur at the key-repeat rate when the key is kept pressed.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_KEY_PRESS_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `key-release-event`
/// The ::key-release-event signal is emitted when a key is released.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_KEY_RELEASE_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `keynav-failed`
/// Gets emitted if keyboard navigation fails.
/// See gtk_widget_keynav_failed() for details.
///
///
///
///
/// #### `leave-notify-event`
/// The ::leave-notify-event will be emitted when the pointer leaves
/// the @widget's window.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_LEAVE_NOTIFY_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `map`
/// The ::map signal is emitted when @widget is going to be mapped, that is
/// when the widget is visible (which is controlled with
/// gtk_widget_set_visible()) and all its parents up to the toplevel widget
/// are also visible. Once the map has occurred, #GtkWidget::map-event will
/// be emitted.
///
/// The ::map signal can be used to determine whether a widget will be drawn,
/// for instance it can resume an animation that was stopped during the
/// emission of #GtkWidget::unmap.
///
///
///
///
/// #### `map-event`
/// The ::map-event signal will be emitted when the @widget's window is
/// mapped. A window is mapped when it becomes visible on the screen.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
/// automatically for all new windows.
///
///
///
///
/// #### `mnemonic-activate`
/// The default handler for this signal activates @widget if @group_cycling
/// is [`false`], or just makes @widget grab focus if @group_cycling is [`true`].
///
///
///
///
/// #### `motion-notify-event`
/// The ::motion-notify-event signal is emitted when the pointer moves
/// over the widget's #GdkWindow.
///
/// To receive this signal, the #GdkWindow associated to the widget
/// needs to enable the #GDK_POINTER_MOTION_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `move-focus`
/// Action
///
///
/// #### `parent-set`
/// The ::parent-set signal is emitted when a new parent
/// has been set on a widget.
///
///
///
///
/// #### `popup-menu`
/// This signal gets emitted whenever a widget should pop up a context
/// menu. This usually happens through the standard key binding mechanism;
/// by pressing a certain key while a widget is focused, the user can cause
/// the widget to pop up a menu. For example, the #GtkEntry widget creates
/// a menu with clipboard commands. See the
/// [Popup Menu Migration Checklist][checklist-popup-menu]
/// for an example of how to use this signal.
///
/// Action
///
///
/// #### `property-notify-event`
/// The ::property-notify-event signal will be emitted when a property on
/// the @widget's window has been changed or deleted.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_PROPERTY_CHANGE_MASK mask.
///
///
///
///
/// #### `proximity-in-event`
/// To receive this signal the #GdkWindow associated to the widget needs
/// to enable the #GDK_PROXIMITY_IN_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `proximity-out-event`
/// To receive this signal the #GdkWindow associated to the widget needs
/// to enable the #GDK_PROXIMITY_OUT_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `query-tooltip`
/// Emitted when #GtkWidget:has-tooltip is [`true`] and the hover timeout
/// has expired with the cursor hovering "above" @widget; or emitted when @widget got
/// focus in keyboard mode.
///
/// Using the given coordinates, the signal handler should determine
/// whether a tooltip should be shown for @widget. If this is the case
/// [`true`] should be returned, [`false`] otherwise. Note that if
/// @keyboard_mode is [`true`], the values of @x and @y are undefined and
/// should not be used.
///
/// The signal handler is free to manipulate @tooltip with the therefore
/// destined function calls.
///
///
///
///
/// #### `realize`
/// The ::realize signal is emitted when @widget is associated with a
/// #GdkWindow, which means that gtk_widget_realize() has been called or the
/// widget has been mapped (that is, it is going to be drawn).
///
///
///
///
/// #### `screen-changed`
/// The ::screen-changed signal gets emitted when the
/// screen of a widget has changed.
///
///
///
///
/// #### `scroll-event`
/// The ::scroll-event signal is emitted when a button in the 4 to 7
/// range is pressed. Wheel mice are usually configured to generate
/// button press events for buttons 4 and 5 when the wheel is turned.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_SCROLL_MASK mask.
///
/// This signal will be sent to the grab widget if there is one.
///
///
///
///
/// #### `selection-clear-event`
/// The ::selection-clear-event signal will be emitted when the
/// the @widget's window has lost ownership of a selection.
///
///
///
///
/// #### `selection-get`
///
///
///
/// #### `selection-notify-event`
///
///
///
/// #### `selection-received`
///
///
///
/// #### `selection-request-event`
/// The ::selection-request-event signal will be emitted when
/// another client requests ownership of the selection owned by
/// the @widget's window.
///
///
///
///
/// #### `show`
/// The ::show signal is emitted when @widget is shown, for example with
/// gtk_widget_show().
///
///
///
///
/// #### `show-help`
/// Action
///
///
/// #### `size-allocate`
///
///
///
/// #### `state-changed`
/// The ::state-changed signal is emitted when the widget state changes.
/// See gtk_widget_get_state().
///
///
///
///
/// #### `state-flags-changed`
/// The ::state-flags-changed signal is emitted when the widget state
/// changes, see gtk_widget_get_state_flags().
///
///
///
///
/// #### `style-set`
/// The ::style-set signal is emitted when a new style has been set
/// on a widget. Note that style-modifying functions like
/// gtk_widget_modify_base() also cause this signal to be emitted.
///
/// Note that this signal is emitted for changes to the deprecated
/// #GtkStyle. To track changes to the #GtkStyleContext associated
/// with a widget, use the #GtkWidget::style-updated signal.
///
///
///
///
/// #### `style-updated`
/// The ::style-updated signal is a convenience signal that is emitted when the
/// #GtkStyleContext::changed signal is emitted on the @widget's associated
/// #GtkStyleContext as returned by gtk_widget_get_style_context().
///
/// Note that style-modifying functions like gtk_widget_override_color() also
/// cause this signal to be emitted.
///
///
///
///
/// #### `touch-event`
///
///
///
/// #### `unmap`
/// The ::unmap signal is emitted when @widget is going to be unmapped, which
/// means that either it or any of its parents up to the toplevel widget have
/// been set as hidden.
///
/// As ::unmap indicates that a widget will not be shown any longer, it can be
/// used to, for example, stop an animation on the widget.
///
///
///
///
/// #### `unmap-event`
/// The ::unmap-event signal will be emitted when the @widget's window is
/// unmapped. A window is unmapped when it becomes invisible on the screen.
///
/// To receive this signal, the #GdkWindow associated to the widget needs
/// to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
/// automatically for all new windows.
///
///
///
///
/// #### `unrealize`
/// The ::unrealize signal is emitted when the #GdkWindow associated with
/// @widget is destroyed, which means that gtk_widget_unrealize() has been
/// called or the widget has been unmapped (that is, it is going to be
/// hidden).
///
///
///
///
/// #### `visibility-notify-event`
/// The ::visibility-notify-event will be emitted when the @widget's
/// window is obscured or unobscured.
///
/// To receive this signal the #GdkWindow associated to the widget needs
/// to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
///
///
///
///
/// #### `window-state-event`
/// The ::window-state-event will be emitted when the state of the
/// toplevel window associated to the @widget changes.
///
/// To receive this signal the #GdkWindow associated to the widget
/// needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
/// this mask automatically for all new windows.
///
///
/// </details>
///
/// # Implements
///
/// [`SwipeableExt`][trait@crate::prelude::SwipeableExt], [`trait@gtk::prelude::WidgetExt`], [`trait@glib::ObjectExt`], [`trait@gtk::prelude::BuildableExt`]
#[doc(alias = "HdySwipeable")]
pub struct Swipeable(Interface<ffi::HdySwipeable, ffi::HdySwipeableInterface>) @requires gtk::Widget, gtk::Buildable;
match fn {
type_ => || ffi::hdy_swipeable_get_type(),
}
}
impl Swipeable {
pub const NONE: Option<&'static Swipeable> = None;
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::Swipeable>> Sealed for T {}
}
/// Trait containing all [`struct@Swipeable`] methods.
///
/// # Implementors
///
/// [`Carousel`][struct@crate::Carousel], [`Deck`][struct@crate::Deck], [`Flap`][struct@crate::Flap], [`Leaflet`][struct@crate::Leaflet], [`Swipeable`][struct@crate::Swipeable]
pub trait SwipeableExt: IsA<Swipeable> + sealed::Sealed + 'static {
/// Emits [`child-switched`][struct@crate::Swipeable#child-switched] signal.
///
/// This should be called when the widget switches visible child widget.
///
/// @duration can be 0 if the child is switched without animation.
/// ## `index`
/// the index of the child to switch to
/// ## `duration`
/// animation duration, in milliseconds
#[doc(alias = "hdy_swipeable_emit_child_switched")]
fn emit_child_switched(&self, index: u32, duration: i64) {
unsafe {
ffi::hdy_swipeable_emit_child_switched(self.as_ref().to_glib_none().0, index, duration);
}
}
/// Gets the progress @self will snap back to after the gesture is canceled.
///
/// # Returns
///
/// the cancel progress, unitless
#[doc(alias = "hdy_swipeable_get_cancel_progress")]
#[doc(alias = "get_cancel_progress")]
fn cancel_progress(&self) -> f64 {
unsafe { ffi::hdy_swipeable_get_cancel_progress(self.as_ref().to_glib_none().0) }
}
/// Gets the swipe distance of @self.
///
/// This corresponds to how many pixels 1 unit represents.
///
/// # Returns
///
/// the swipe distance in pixels
#[doc(alias = "hdy_swipeable_get_distance")]
#[doc(alias = "get_distance")]
fn distance(&self) -> f64 {
unsafe { ffi::hdy_swipeable_get_distance(self.as_ref().to_glib_none().0) }
}
/// Gets the current progress of @self.
///
/// # Returns
///
/// the current progress, unitless
#[doc(alias = "hdy_swipeable_get_progress")]
#[doc(alias = "get_progress")]
fn progress(&self) -> f64 {
unsafe { ffi::hdy_swipeable_get_progress(self.as_ref().to_glib_none().0) }
}
/// Gets the snap points of @self.
///
/// Each snap point represents a progress value that is considered acceptable to
/// end the swipe on.
///
/// # Returns
///
/// the snap points
#[doc(alias = "hdy_swipeable_get_snap_points")]
#[doc(alias = "get_snap_points")]
fn snap_points(&self) -> Vec<f64> {
unsafe {
let mut n_snap_points = mem::MaybeUninit::uninit();
let ret = FromGlibContainer::from_glib_full_num(
ffi::hdy_swipeable_get_snap_points(
self.as_ref().to_glib_none().0,
n_snap_points.as_mut_ptr(),
),
n_snap_points.assume_init() as _,
);
ret
}
}
/// Gets the area @self can start a swipe from for the given direction and
/// gesture type.
///
/// This can be used to restrict swipes to only be possible from a certain area,
/// for example, to only allow edge swipes, or to have a draggable element and
/// ignore swipes elsewhere.
///
/// Swipe area is only considered for direct swipes (as in, not initiated by
/// [`SwipeGroup`][crate::SwipeGroup]).
///
/// If not implemented, the default implementation returns the allocation of
/// @self, allowing swipes from anywhere.
/// ## `navigation_direction`
/// the direction of the swipe
/// ## `is_drag`
/// whether the swipe is caused by a dragging gesture
///
/// # Returns
///
///
/// ## `rect`
/// a pointer to a rectangle to store the swipe area
#[doc(alias = "hdy_swipeable_get_swipe_area")]
#[doc(alias = "get_swipe_area")]
fn swipe_area(
&self,
navigation_direction: NavigationDirection,
is_drag: bool,
) -> gdk::Rectangle {
unsafe {
let mut rect = gdk::Rectangle::uninitialized();
ffi::hdy_swipeable_get_swipe_area(
self.as_ref().to_glib_none().0,
navigation_direction.into_glib(),
is_drag.into_glib(),
rect.to_glib_none_mut().0,
);
rect
}
}
/// Gets the [`SwipeTracker`][crate::SwipeTracker] used by this swipeable widget.
///
/// # Returns
///
/// the swipe tracker
#[doc(alias = "hdy_swipeable_get_swipe_tracker")]
#[doc(alias = "get_swipe_tracker")]
fn swipe_tracker(&self) -> Option<SwipeTracker> {
unsafe {
from_glib_none(ffi::hdy_swipeable_get_swipe_tracker(
self.as_ref().to_glib_none().0,
))
}
}
/// Switches to child with index @index.
///
/// See [`child-switched`][struct@crate::Swipeable#child-switched].
/// ## `index`
/// the index of the child to switch to
/// ## `duration`
/// animation duration, in milliseconds
#[doc(alias = "hdy_swipeable_switch_child")]
fn switch_child(&self, index: u32, duration: i64) {
unsafe {
ffi::hdy_swipeable_switch_child(self.as_ref().to_glib_none().0, index, duration);
}
}
/// Emitted when the widget's visible child is changed.
///
/// @duration can be 0 if the child is switched without animation.
///
/// This is used by [`SwipeGroup`][crate::SwipeGroup], applications should not connect to it.
/// ## `index`
/// the index of the child to switch to
/// ## `duration`
/// animation duration, in milliseconds
#[doc(alias = "child-switched")]
fn connect_child_switched<F: Fn(&Self, u32, i64) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn child_switched_trampoline<
P: IsA<Swipeable>,
F: Fn(&P, u32, i64) + 'static,
>(
this: *mut ffi::HdySwipeable,
index: libc::c_uint,
duration: i64,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(
Swipeable::from_glib_borrow(this).unsafe_cast_ref(),
index,
duration,
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"child-switched\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
child_switched_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl<O: IsA<Swipeable>> SwipeableExt for O {}
impl fmt::Display for Swipeable {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("Swipeable")
}
}