libadwaita/auto/tab_page.rs
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
// 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::ffi;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// An auxiliary class used by [`TabView`][crate::TabView].
///
/// ## Properties
///
///
/// #### `child`
/// The child of the page.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `icon`
/// The icon of the page.
///
/// [`TabBar`][crate::TabBar] and [`TabOverview`][crate::TabOverview] display the icon next to the title,
/// unless [`loading`][struct@crate::TabPage#loading] is set to `TRUE`.
///
/// [`TabBar`][crate::TabBar] also won't show the icon if the page is pinned and
/// [propertyTabPage:indicator-icon] is set.
///
/// Readable | Writeable
///
///
/// #### `indicator-activatable`
/// Whether the indicator icon is activatable.
///
/// If set to `TRUE`, [`indicator-activated`][struct@crate::TabView#indicator-activated] will be emitted
/// when the indicator icon is clicked.
///
/// If [`indicator-icon`][struct@crate::TabPage#indicator-icon] is not set, does nothing.
///
/// Readable | Writeable
///
///
/// #### `indicator-icon`
/// An indicator icon for the page.
///
/// A common use case is an audio or camera indicator in a web browser.
///
/// [`TabBar`][crate::TabBar] will show it at the beginning of the tab, alongside icon
/// representing [`icon`][struct@crate::TabPage#icon] or loading spinner.
///
/// If the page is pinned, the indicator will be shown instead of icon or
/// spinner.
///
/// [`TabOverview`][crate::TabOverview] will show it at the at the top part of the thumbnail.
///
/// [`indicator-tooltip`][struct@crate::TabPage#indicator-tooltip] can be used to set the tooltip on the
/// indicator icon.
///
/// If [`indicator-activatable`][struct@crate::TabPage#indicator-activatable] is set to `TRUE`, the
/// indicator icon can act as a button.
///
/// Readable | Writeable
///
///
/// #### `indicator-tooltip`
/// The tooltip of the indicator icon.
///
/// The tooltip can be marked up with the Pango text markup language.
///
/// See [`indicator-icon`][struct@crate::TabPage#indicator-icon].
///
/// Readable | Writeable
///
///
/// #### `keyword`
/// The search keyboard of the page.
///
/// [`TabOverview`][crate::TabOverview] can search pages by their keywords in addition to their
/// titles and tooltips.
///
/// Keywords allow to include e.g. page URLs into tab search in a web browser.
///
/// Readable | Writeable
///
///
/// #### `live-thumbnail`
/// Whether to enable live thumbnail for this page.
///
/// When set to `TRUE`, the page's thumbnail in [`TabOverview`][crate::TabOverview] will update
/// immediately when the page is redrawn or resized.
///
/// If it's set to `FALSE`, the thumbnail will only be live when the page is
/// selected, and otherwise it will be static and will only update when
/// [`TabPage::invalidate_thumbnail()`][crate::TabPage::invalidate_thumbnail()] or
/// [`TabView::invalidate_thumbnails()`][crate::TabView::invalidate_thumbnails()] is called.
///
/// Readable | Writeable
///
///
/// #### `loading`
/// Whether the page is loading.
///
/// If set to `TRUE`, [`TabBar`][crate::TabBar] and [`TabOverview`][crate::TabOverview] will display a
/// spinner in place of icon.
///
/// If the page is pinned and [`indicator-icon`][struct@crate::TabPage#indicator-icon] is set,
/// loading status will not be visible with [`TabBar`][crate::TabBar].
///
/// Readable | Writeable
///
///
/// #### `needs-attention`
/// Whether the page needs attention.
///
/// [`TabBar`][crate::TabBar] will display a line under the tab representing the page if
/// set to `TRUE`. If the tab is not visible, the corresponding edge of the tab
/// bar will be highlighted.
///
/// [`TabOverview`][crate::TabOverview] will display a dot in the corner of the thumbnail if set
/// to `TRUE`.
///
/// [`TabButton`][crate::TabButton] will display a dot if any of the pages that aren't
/// selected have this property set to `TRUE`.
///
/// Readable | Writeable
///
///
/// #### `parent`
/// The parent page of the page.
///
/// See [`TabView::add_page()`][crate::TabView::add_page()] and [`TabView::close_page()`][crate::TabView::close_page()].
///
/// Readable | Writeable | Construct Only
///
///
/// #### `pinned`
/// Whether the page is pinned.
///
/// See [`TabView::set_page_pinned()`][crate::TabView::set_page_pinned()].
///
/// Readable
///
///
/// #### `selected`
/// Whether the page is selected.
///
/// Readable
///
///
/// #### `thumbnail-xalign`
/// The horizontal alignment of the page thumbnail.
///
/// If the page is so wide that [`TabOverview`][crate::TabOverview] can't display it completely
/// and has to crop it, horizontal alignment will determine which part of the
/// page will be visible.
///
/// For example, 0.5 means the center of the page will be visible, 0 means the
/// start edge will be visible and 1 means the end edge will be visible.
///
/// The default horizontal alignment is 0.
///
/// Readable | Writeable
///
///
/// #### `thumbnail-yalign`
/// The vertical alignment of the page thumbnail.
///
/// If the page is so tall that [`TabOverview`][crate::TabOverview] can't display it completely
/// and has to crop it, vertical alignment will determine which part of the
/// page will be visible.
///
/// For example, 0.5 means the center of the page will be visible, 0 means the
/// top edge will be visible and 1 means the bottom edge will be visible.
///
/// The default vertical alignment is 0.
///
/// Readable | Writeable
///
///
/// #### `title`
/// The title of the page.
///
/// [`TabBar`][crate::TabBar] will display it in the center of the tab unless it's pinned,
/// and will use it as a tooltip unless [`tooltip`][struct@crate::TabPage#tooltip] is set.
///
/// [`TabOverview`][crate::TabOverview] will display it below the thumbnail unless it's pinned,
/// or inside the card otherwise, and will use it as a tooltip unless
/// [`tooltip`][struct@crate::TabPage#tooltip] is set.
///
/// Readable | Writeable
///
///
/// #### `tooltip`
/// The tooltip of the page.
///
/// The tooltip can be marked up with the Pango text markup language.
///
/// If not set, [`TabBar`][crate::TabBar] and [`TabOverview`][crate::TabOverview] will use
/// [`title`][struct@crate::TabPage#title] as a tooltip instead.
///
/// Readable | Writeable
/// <details><summary><h4>Accessible</h4></summary>
///
///
/// #### `accessible-role`
/// The accessible role of the given [`gtk::Accessible`][crate::gtk::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
///
/// Readable | Writeable
/// </details>
///
/// # Implements
///
/// [`trait@glib::ObjectExt`], [`trait@gtk::prelude::AccessibleExt`]
#[doc(alias = "AdwTabPage")]
pub struct TabPage(Object<ffi::AdwTabPage, ffi::AdwTabPageClass>) @implements gtk::Accessible;
match fn {
type_ => || ffi::adw_tab_page_get_type(),
}
}
impl TabPage {
/// Gets the child of @self.
///
/// # Returns
///
/// the child of @self
#[doc(alias = "adw_tab_page_get_child")]
#[doc(alias = "get_child")]
pub fn child(&self) -> gtk::Widget {
unsafe { from_glib_none(ffi::adw_tab_page_get_child(self.to_glib_none().0)) }
}
/// Gets the icon of @self.
///
/// # Returns
///
/// the icon of @self
#[doc(alias = "adw_tab_page_get_icon")]
#[doc(alias = "get_icon")]
pub fn icon(&self) -> Option<gio::Icon> {
unsafe { from_glib_none(ffi::adw_tab_page_get_icon(self.to_glib_none().0)) }
}
/// Gets whether the indicator of @self is activatable.
///
/// # Returns
///
/// whether the indicator is activatable
#[doc(alias = "adw_tab_page_get_indicator_activatable")]
#[doc(alias = "get_indicator_activatable")]
#[doc(alias = "indicator-activatable")]
pub fn is_indicator_activatable(&self) -> bool {
unsafe {
from_glib(ffi::adw_tab_page_get_indicator_activatable(
self.to_glib_none().0,
))
}
}
/// Gets the indicator icon of @self.
///
/// # Returns
///
/// the indicator icon of @self
#[doc(alias = "adw_tab_page_get_indicator_icon")]
#[doc(alias = "get_indicator_icon")]
#[doc(alias = "indicator-icon")]
pub fn indicator_icon(&self) -> Option<gio::Icon> {
unsafe { from_glib_none(ffi::adw_tab_page_get_indicator_icon(self.to_glib_none().0)) }
}
/// Gets the tooltip of the indicator icon of @self.
///
/// # Returns
///
/// the indicator tooltip of @self
#[cfg(feature = "v1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
#[doc(alias = "adw_tab_page_get_indicator_tooltip")]
#[doc(alias = "get_indicator_tooltip")]
#[doc(alias = "indicator-tooltip")]
pub fn indicator_tooltip(&self) -> glib::GString {
unsafe {
from_glib_none(ffi::adw_tab_page_get_indicator_tooltip(
self.to_glib_none().0,
))
}
}
/// Gets the search keyword of @self.
///
/// # Returns
///
/// the search keyword of @self
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "adw_tab_page_get_keyword")]
#[doc(alias = "get_keyword")]
pub fn keyword(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::adw_tab_page_get_keyword(self.to_glib_none().0)) }
}
/// Gets whether to live thumbnail is enabled @self.
///
/// # Returns
///
/// whether live thumbnail is enabled
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "adw_tab_page_get_live_thumbnail")]
#[doc(alias = "get_live_thumbnail")]
#[doc(alias = "live-thumbnail")]
pub fn is_live_thumbnail(&self) -> bool {
unsafe { from_glib(ffi::adw_tab_page_get_live_thumbnail(self.to_glib_none().0)) }
}
/// Gets whether @self is loading.
///
/// # Returns
///
/// whether @self is loading
#[doc(alias = "adw_tab_page_get_loading")]
#[doc(alias = "get_loading")]
#[doc(alias = "loading")]
pub fn is_loading(&self) -> bool {
unsafe { from_glib(ffi::adw_tab_page_get_loading(self.to_glib_none().0)) }
}
/// Gets whether @self needs attention.
///
/// # Returns
///
/// whether @self needs attention
#[doc(alias = "adw_tab_page_get_needs_attention")]
#[doc(alias = "get_needs_attention")]
#[doc(alias = "needs-attention")]
pub fn needs_attention(&self) -> bool {
unsafe { from_glib(ffi::adw_tab_page_get_needs_attention(self.to_glib_none().0)) }
}
/// Gets the parent page of @self.
///
/// See [`TabView::add_page()`][crate::TabView::add_page()] and [`TabView::close_page()`][crate::TabView::close_page()].
///
/// # Returns
///
/// the parent page
#[doc(alias = "adw_tab_page_get_parent")]
#[doc(alias = "get_parent")]
#[must_use]
pub fn parent(&self) -> Option<TabPage> {
unsafe { from_glib_none(ffi::adw_tab_page_get_parent(self.to_glib_none().0)) }
}
/// Gets whether @self is pinned.
///
/// See [`TabView::set_page_pinned()`][crate::TabView::set_page_pinned()].
///
/// # Returns
///
/// whether @self is pinned
#[doc(alias = "adw_tab_page_get_pinned")]
#[doc(alias = "get_pinned")]
#[doc(alias = "pinned")]
pub fn is_pinned(&self) -> bool {
unsafe { from_glib(ffi::adw_tab_page_get_pinned(self.to_glib_none().0)) }
}
/// Gets whether @self is selected.
///
/// # Returns
///
/// whether @self is selected
#[doc(alias = "adw_tab_page_get_selected")]
#[doc(alias = "get_selected")]
#[doc(alias = "selected")]
pub fn is_selected(&self) -> bool {
unsafe { from_glib(ffi::adw_tab_page_get_selected(self.to_glib_none().0)) }
}
/// Gets the horizontal alignment of the thumbnail for @self.
///
/// # Returns
///
/// the horizontal alignment
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "adw_tab_page_get_thumbnail_xalign")]
#[doc(alias = "get_thumbnail_xalign")]
#[doc(alias = "thumbnail-xalign")]
pub fn thumbnail_xalign(&self) -> f32 {
unsafe { ffi::adw_tab_page_get_thumbnail_xalign(self.to_glib_none().0) }
}
/// Gets the vertical alignment of the thumbnail for @self.
///
/// # Returns
///
/// the vertical alignment
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "adw_tab_page_get_thumbnail_yalign")]
#[doc(alias = "get_thumbnail_yalign")]
#[doc(alias = "thumbnail-yalign")]
pub fn thumbnail_yalign(&self) -> f32 {
unsafe { ffi::adw_tab_page_get_thumbnail_yalign(self.to_glib_none().0) }
}
/// Gets the title of @self.
///
/// # Returns
///
/// the title of @self
#[doc(alias = "adw_tab_page_get_title")]
#[doc(alias = "get_title")]
pub fn title(&self) -> glib::GString {
unsafe { from_glib_none(ffi::adw_tab_page_get_title(self.to_glib_none().0)) }
}
/// Gets the tooltip of @self.
///
/// # Returns
///
/// the tooltip of @self
#[doc(alias = "adw_tab_page_get_tooltip")]
#[doc(alias = "get_tooltip")]
pub fn tooltip(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::adw_tab_page_get_tooltip(self.to_glib_none().0)) }
}
/// Invalidates thumbnail for @self.
///
/// If an [`TabOverview`][crate::TabOverview] is open, the thumbnail representing @self will be
/// immediately updated. Otherwise it will be update when opening the overview.
///
/// Does nothing if [`live-thumbnail`][struct@crate::TabPage#live-thumbnail] is set to `TRUE`.
///
/// See also [`TabView::invalidate_thumbnails()`][crate::TabView::invalidate_thumbnails()].
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "adw_tab_page_invalidate_thumbnail")]
pub fn invalidate_thumbnail(&self) {
unsafe {
ffi::adw_tab_page_invalidate_thumbnail(self.to_glib_none().0);
}
}
/// Sets the icon of @self.
///
/// [`TabBar`][crate::TabBar] and [`TabOverview`][crate::TabOverview] display the icon next to the title,
/// unless [`loading`][struct@crate::TabPage#loading] is set to `TRUE`.
///
/// [`TabBar`][crate::TabBar] also won't show the icon if the page is pinned and
/// [propertyTabPage:indicator-icon] is set.
/// ## `icon`
/// the icon of @self
#[doc(alias = "adw_tab_page_set_icon")]
#[doc(alias = "icon")]
pub fn set_icon(&self, icon: Option<&impl IsA<gio::Icon>>) {
unsafe {
ffi::adw_tab_page_set_icon(
self.to_glib_none().0,
icon.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Sets whether the indicator of @self is activatable.
///
/// If set to `TRUE`, [`indicator-activated`][struct@crate::TabView#indicator-activated] will be emitted
/// when the indicator icon is clicked.
///
/// If [`indicator-icon`][struct@crate::TabPage#indicator-icon] is not set, does nothing.
/// ## `activatable`
/// whether the indicator is activatable
#[doc(alias = "adw_tab_page_set_indicator_activatable")]
#[doc(alias = "indicator-activatable")]
pub fn set_indicator_activatable(&self, activatable: bool) {
unsafe {
ffi::adw_tab_page_set_indicator_activatable(
self.to_glib_none().0,
activatable.into_glib(),
);
}
}
/// Sets the indicator icon of @self.
///
/// A common use case is an audio or camera indicator in a web browser.
///
/// [`TabBar`][crate::TabBar] will show it at the beginning of the tab, alongside icon
/// representing [`icon`][struct@crate::TabPage#icon] or loading spinner.
///
/// If the page is pinned, the indicator will be shown instead of icon or
/// spinner.
///
/// [`TabOverview`][crate::TabOverview] will show it at the at the top part of the thumbnail.
///
/// [`indicator-tooltip`][struct@crate::TabPage#indicator-tooltip] can be used to set the tooltip on the
/// indicator icon.
///
/// If [`indicator-activatable`][struct@crate::TabPage#indicator-activatable] is set to `TRUE`, the
/// indicator icon can act as a button.
/// ## `indicator_icon`
/// the indicator icon of @self
#[doc(alias = "adw_tab_page_set_indicator_icon")]
#[doc(alias = "indicator-icon")]
pub fn set_indicator_icon(&self, indicator_icon: Option<&impl IsA<gio::Icon>>) {
unsafe {
ffi::adw_tab_page_set_indicator_icon(
self.to_glib_none().0,
indicator_icon.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Sets the tooltip of the indicator icon of @self.
///
/// The tooltip can be marked up with the Pango text markup language.
///
/// See [`indicator-icon`][struct@crate::TabPage#indicator-icon].
/// ## `tooltip`
/// the indicator tooltip of @self
#[cfg(feature = "v1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
#[doc(alias = "adw_tab_page_set_indicator_tooltip")]
#[doc(alias = "indicator-tooltip")]
pub fn set_indicator_tooltip(&self, tooltip: &str) {
unsafe {
ffi::adw_tab_page_set_indicator_tooltip(
self.to_glib_none().0,
tooltip.to_glib_none().0,
);
}
}
/// Sets the search keyword for @self.
///
/// [`TabOverview`][crate::TabOverview] can search pages by their keywords in addition to their
/// titles and tooltips.
///
/// Keywords allow to include e.g. page URLs into tab search in a web browser.
/// ## `keyword`
/// the search keyword
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "adw_tab_page_set_keyword")]
#[doc(alias = "keyword")]
pub fn set_keyword(&self, keyword: &str) {
unsafe {
ffi::adw_tab_page_set_keyword(self.to_glib_none().0, keyword.to_glib_none().0);
}
}
/// Sets whether to enable live thumbnail for @self.
///
/// When set to `TRUE`, @self's thumbnail in [`TabOverview`][crate::TabOverview] will update
/// immediately when @self is redrawn or resized.
///
/// If it's set to `FALSE`, the thumbnail will only be live when the @self is
/// selected, and otherwise it will be static and will only update when
/// [`invalidate_thumbnail()`][Self::invalidate_thumbnail()] or
/// [`TabView::invalidate_thumbnails()`][crate::TabView::invalidate_thumbnails()] is called.
/// ## `live_thumbnail`
/// whether to enable live thumbnail
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "adw_tab_page_set_live_thumbnail")]
#[doc(alias = "live-thumbnail")]
pub fn set_live_thumbnail(&self, live_thumbnail: bool) {
unsafe {
ffi::adw_tab_page_set_live_thumbnail(self.to_glib_none().0, live_thumbnail.into_glib());
}
}
/// Sets whether @self is loading.
///
/// If set to `TRUE`, [`TabBar`][crate::TabBar] and [`TabOverview`][crate::TabOverview] will display a
/// spinner in place of icon.
///
/// If the page is pinned and [`indicator-icon`][struct@crate::TabPage#indicator-icon] is set, loading
/// status will not be visible with [`TabBar`][crate::TabBar].
/// ## `loading`
/// whether @self is loading
#[doc(alias = "adw_tab_page_set_loading")]
#[doc(alias = "loading")]
pub fn set_loading(&self, loading: bool) {
unsafe {
ffi::adw_tab_page_set_loading(self.to_glib_none().0, loading.into_glib());
}
}
/// Sets whether @self needs attention.
///
/// [`TabBar`][crate::TabBar] will display a line under the tab representing the page if
/// set to `TRUE`. If the tab is not visible, the corresponding edge of the tab
/// bar will be highlighted.
///
/// [`TabOverview`][crate::TabOverview] will display a dot in the corner of the thumbnail if set
/// to `TRUE`.
///
/// [`TabButton`][crate::TabButton] will display a dot if any of the pages that aren't
/// selected have [`needs-attention`][struct@crate::TabPage#needs-attention] set to `TRUE`.
/// ## `needs_attention`
/// whether @self needs attention
#[doc(alias = "adw_tab_page_set_needs_attention")]
#[doc(alias = "needs-attention")]
pub fn set_needs_attention(&self, needs_attention: bool) {
unsafe {
ffi::adw_tab_page_set_needs_attention(
self.to_glib_none().0,
needs_attention.into_glib(),
);
}
}
/// Sets the horizontal alignment of the thumbnail for @self.
///
/// If the page is so wide that [`TabOverview`][crate::TabOverview] can't display it completely
/// and has to crop it, horizontal alignment will determine which part of the
/// page will be visible.
///
/// For example, 0.5 means the center of the page will be visible, 0 means the
/// start edge will be visible and 1 means the end edge will be visible.
///
/// The default horizontal alignment is 0.
/// ## `xalign`
/// the new value
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "adw_tab_page_set_thumbnail_xalign")]
#[doc(alias = "thumbnail-xalign")]
pub fn set_thumbnail_xalign(&self, xalign: f32) {
unsafe {
ffi::adw_tab_page_set_thumbnail_xalign(self.to_glib_none().0, xalign);
}
}
/// Sets the vertical alignment of the thumbnail for @self.
///
/// If the page is so tall that [`TabOverview`][crate::TabOverview] can't display it completely
/// and has to crop it, vertical alignment will determine which part of the page
/// will be visible.
///
/// For example, 0.5 means the center of the page will be visible, 0 means the
/// top edge will be visible and 1 means the bottom edge will be visible.
///
/// The default vertical alignment is 0.
/// ## `yalign`
/// the new value
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "adw_tab_page_set_thumbnail_yalign")]
#[doc(alias = "thumbnail-yalign")]
pub fn set_thumbnail_yalign(&self, yalign: f32) {
unsafe {
ffi::adw_tab_page_set_thumbnail_yalign(self.to_glib_none().0, yalign);
}
}
/// [`TabBar`][crate::TabBar] will display it in the center of the tab unless it's pinned,
/// and will use it as a tooltip unless [`tooltip`][struct@crate::TabPage#tooltip] is set.
///
/// [`TabOverview`][crate::TabOverview] will display it below the thumbnail unless it's pinned,
/// or inside the card otherwise, and will use it as a tooltip unless
/// [`tooltip`][struct@crate::TabPage#tooltip] is set.
///
/// Sets the title of @self.
/// ## `title`
/// the title of @self
#[doc(alias = "adw_tab_page_set_title")]
#[doc(alias = "title")]
pub fn set_title(&self, title: &str) {
unsafe {
ffi::adw_tab_page_set_title(self.to_glib_none().0, title.to_glib_none().0);
}
}
/// Sets the tooltip of @self.
///
/// The tooltip can be marked up with the Pango text markup language.
///
/// If not set, [`TabBar`][crate::TabBar] and [`TabOverview`][crate::TabOverview] will use
/// [`title`][struct@crate::TabPage#title] as a tooltip instead.
/// ## `tooltip`
/// the tooltip of @self
#[doc(alias = "adw_tab_page_set_tooltip")]
#[doc(alias = "tooltip")]
pub fn set_tooltip(&self, tooltip: &str) {
unsafe {
ffi::adw_tab_page_set_tooltip(self.to_glib_none().0, tooltip.to_glib_none().0);
}
}
#[doc(alias = "icon")]
pub fn connect_icon_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_icon_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::icon\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_icon_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "indicator-activatable")]
pub fn connect_indicator_activatable_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_indicator_activatable_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::indicator-activatable\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_indicator_activatable_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "indicator-icon")]
pub fn connect_indicator_icon_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_indicator_icon_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::indicator-icon\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_indicator_icon_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
#[doc(alias = "indicator-tooltip")]
pub fn connect_indicator_tooltip_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_indicator_tooltip_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::indicator-tooltip\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_indicator_tooltip_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "keyword")]
pub fn connect_keyword_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_keyword_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::keyword\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_keyword_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "live-thumbnail")]
pub fn connect_live_thumbnail_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_live_thumbnail_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::live-thumbnail\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_live_thumbnail_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "loading")]
pub fn connect_loading_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_loading_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::loading\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_loading_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "needs-attention")]
pub fn connect_needs_attention_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_needs_attention_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::needs-attention\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_needs_attention_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "pinned")]
pub fn connect_pinned_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_pinned_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::pinned\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_pinned_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "selected")]
pub fn connect_selected_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_selected_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::selected\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_selected_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "thumbnail-xalign")]
pub fn connect_thumbnail_xalign_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_thumbnail_xalign_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::thumbnail-xalign\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_thumbnail_xalign_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
#[doc(alias = "thumbnail-yalign")]
pub fn connect_thumbnail_yalign_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_thumbnail_yalign_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::thumbnail-yalign\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_thumbnail_yalign_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "title")]
pub fn connect_title_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_title_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::title\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_title_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "tooltip")]
pub fn connect_tooltip_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_tooltip_trampoline<F: Fn(&TabPage) + 'static>(
this: *mut ffi::AdwTabPage,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::tooltip\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_tooltip_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}