gtk4/auto/progress_bar.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 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
#[cfg(feature = "v4_10")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_10")))]
use crate::AccessibleRange;
use crate::{
ffi, Accessible, AccessibleRole, Align, Buildable, ConstraintTarget, LayoutManager, Orientable,
Orientation, Overflow, Widget,
};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
#[cfg(feature = "v4_10")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_10")))]
glib::wrapper! {
/// [`ProgressBar`][crate::ProgressBar] is typically used to display the progress of a long
/// running operation.
///
/// It provides a visual clue that processing is underway. [`ProgressBar`][crate::ProgressBar]
/// can be used in two different modes: percentage mode and activity mode.
///
/// 
///
/// When an application can determine how much work needs to take place
/// (e.g. read a fixed number of bytes from a file) and can monitor its
/// progress, it can use the [`ProgressBar`][crate::ProgressBar] in percentage mode and the
/// user sees a growing bar indicating the percentage of the work that
/// has been completed. In this mode, the application is required to call
/// [`set_fraction()`][Self::set_fraction()] periodically to update the progress bar.
///
/// When an application has no accurate way of knowing the amount of work
/// to do, it can use the [`ProgressBar`][crate::ProgressBar] in activity mode, which shows
/// activity by a block moving back and forth within the progress area. In
/// this mode, the application is required to call [`pulse()`][Self::pulse()]
/// periodically to update the progress bar.
///
/// There is quite a bit of flexibility provided to control the appearance
/// of the [`ProgressBar`][crate::ProgressBar]. Functions are provided to control the orientation
/// of the bar, optional text can be displayed along with the bar, and the
/// step size used in activity mode can be set.
///
/// # CSS nodes
///
/// ```text
/// progressbar[.osd]
/// ├── [text]
/// ╰── trough[.empty][.full]
/// ╰── progress[.pulse]
/// ```
///
/// [`ProgressBar`][crate::ProgressBar] has a main CSS node with name progressbar and subnodes with
/// names text and trough, of which the latter has a subnode named progress. The
/// text subnode is only present if text is shown. The progress subnode has the
/// style class .pulse when in activity mode. It gets the style classes .left,
/// .right, .top or .bottom added when the progress 'touches' the corresponding
/// end of the GtkProgressBar. The .osd class on the progressbar node is for use
/// in overlays like the one Epiphany has for page loading progress.
///
/// # Accessibility
///
/// [`ProgressBar`][crate::ProgressBar] uses the [`AccessibleRole::ProgressBar`][crate::AccessibleRole::ProgressBar] role.
///
/// ## Properties
///
///
/// #### `ellipsize`
/// The preferred place to ellipsize the string.
///
/// The text will be ellipsized if the progress bar does not have enough room
/// to display the entire string, specified as a [`pango::EllipsizeMode`][crate::pango::EllipsizeMode].
///
/// Note that setting this property to a value other than
/// [`pango::EllipsizeMode::None`][crate::pango::EllipsizeMode::None] has the side-effect that the progress bar requests
/// only enough space to display the ellipsis ("..."). Another means to set a
/// progress bar's width is [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()].
///
/// Readable | Writeable
///
///
/// #### `fraction`
/// The fraction of total work that has been completed.
///
/// Readable | Writeable
///
///
/// #### `inverted`
/// Invert the direction in which the progress bar grows.
///
/// Readable | Writeable
///
///
/// #### `pulse-step`
/// The fraction of total progress to move the bounding block when pulsed.
///
/// Readable | Writeable
///
///
/// #### `show-text`
/// Sets whether the progress bar will show a text in addition
/// to the bar itself.
///
/// The shown text is either the value of the [`text`][struct@crate::ProgressBar#text]
/// property or, if that is [`None`], the [`fraction`][struct@crate::ProgressBar#fraction]
/// value, as a percentage.
///
/// To make a progress bar that is styled and sized suitably for showing text
/// (even if the actual text is blank), set [`show-text`][struct@crate::ProgressBar#show-text]
/// to [`true`] and [`text`][struct@crate::ProgressBar#text] to the empty string (not [`None`]).
///
/// Readable | Writeable
///
///
/// #### `text`
/// Text to be displayed in the progress bar.
///
/// Readable | Writeable
/// <details><summary><h4>Widget</h4></summary>
///
///
/// #### `can-focus`
/// Whether the widget or any of its descendents can accept
/// the input focus.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `can-target`
/// Whether the widget can receive pointer events.
///
/// Readable | Writeable
///
///
/// #### `css-classes`
/// A list of css classes applied to this widget.
///
/// Readable | Writeable
///
///
/// #### `css-name`
/// The name of this widget in the CSS tree.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `cursor`
/// The cursor used by @widget.
///
/// Readable | Writeable
///
///
/// #### `focus-on-click`
/// Whether the widget should grab focus when it is clicked with the mouse.
///
/// This property is only relevant for widgets that can take focus.
///
/// Readable | Writeable
///
///
/// #### `focusable`
/// Whether this widget itself will accept the input focus.
///
/// Readable | Writeable
///
///
/// #### `halign`
/// How to distribute horizontal space if widget gets extra space.
///
/// Readable | Writeable
///
///
/// #### `has-default`
/// Whether the widget is the default widget.
///
/// Readable
///
///
/// #### `has-focus`
/// Whether the widget has the input focus.
///
/// Readable
///
///
/// #### `has-tooltip`
/// Enables or disables the emission of the ::query-tooltip signal on @widget.
///
/// A value of [`true`] indicates that @widget can have a tooltip, in this case
/// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to
/// determine whether it will provide a tooltip or not.
///
/// Readable | Writeable
///
///
/// #### `height-request`
/// Override for height request of the widget.
///
/// If this is -1, the natural request will be used.
///
/// Readable | Writeable
///
///
/// #### `hexpand`
/// Whether to expand horizontally.
///
/// Readable | Writeable
///
///
/// #### `hexpand-set`
/// Whether to use the `hexpand` property.
///
/// Readable | Writeable
///
///
/// #### `layout-manager`
/// The [`LayoutManager`][crate::LayoutManager] instance to use to compute the preferred size
/// of the widget, and allocate its children.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `margin-bottom`
/// Margin on bottom side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-end`
/// Margin on end of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-start`
/// Margin on start of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-top`
/// Margin on top side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `name`
/// The name of the widget.
///
/// Readable | Writeable
///
///
/// #### `opacity`
/// The requested opacity of the widget.
///
/// Readable | Writeable
///
///
/// #### `overflow`
/// How content outside the widget's content area is treated.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `parent`
/// The parent widget of this widget.
///
/// Readable
///
///
/// #### `receives-default`
/// Whether the widget will receive the default action when it is focused.
///
/// Readable | Writeable
///
///
/// #### `root`
/// The [`Root`][crate::Root] widget of the widget tree containing this widget.
///
/// This will be [`None`] if the widget is not contained in a root widget.
///
/// Readable
///
///
/// #### `scale-factor`
/// The scale factor of the widget.
///
/// Readable
///
///
/// #### `sensitive`
/// Whether the widget responds to input.
///
/// Readable | Writeable
///
///
/// #### `tooltip-markup`
/// Sets the text of tooltip to be the given string, which is marked up
/// with Pango markup.
///
/// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
///
/// Readable | Writeable
///
///
/// #### `tooltip-text`
/// Sets the text of tooltip to be the given string.
///
/// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
///
/// Readable | Writeable
///
///
/// #### `valign`
/// How to distribute vertical space if widget gets extra space.
///
/// Readable | Writeable
///
///
/// #### `vexpand`
/// Whether to expand vertically.
///
/// Readable | Writeable
///
///
/// #### `vexpand-set`
/// Whether to use the `vexpand` property.
///
/// Readable | Writeable
///
///
/// #### `visible`
/// Whether the widget is visible.
///
/// Readable | Writeable
///
///
/// #### `width-request`
/// Override for width request of the widget.
///
/// If this is -1, the natural request will be used.
///
/// Readable | Writeable
/// </details>
/// <details><summary><h4>Accessible</h4></summary>
///
///
/// #### `accessible-role`
/// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
///
/// Readable | Writeable
/// </details>
/// <details><summary><h4>Orientable</h4></summary>
///
///
/// #### `orientation`
/// The orientation of the orientable.
///
/// Readable | Writeable
/// </details>
///
/// # Implements
///
/// [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`AccessibleExt`][trait@crate::prelude::AccessibleExt], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`ConstraintTargetExt`][trait@crate::prelude::ConstraintTargetExt], [`AccessibleRangeExt`][trait@crate::prelude::AccessibleRangeExt], [`OrientableExt`][trait@crate::prelude::OrientableExt], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`AccessibleExtManual`][trait@crate::prelude::AccessibleExtManual]
#[doc(alias = "GtkProgressBar")]
pub struct ProgressBar(Object<ffi::GtkProgressBar>) @extends Widget, @implements Accessible, Buildable, ConstraintTarget, AccessibleRange, Orientable;
match fn {
type_ => || ffi::gtk_progress_bar_get_type(),
}
}
#[cfg(not(any(feature = "v4_10")))]
glib::wrapper! {
#[doc(alias = "GtkProgressBar")]
pub struct ProgressBar(Object<ffi::GtkProgressBar>) @extends Widget, @implements Accessible, Buildable, ConstraintTarget, Orientable;
match fn {
type_ => || ffi::gtk_progress_bar_get_type(),
}
}
impl ProgressBar {
/// Creates a new [`ProgressBar`][crate::ProgressBar].
///
/// # Returns
///
/// a [`ProgressBar`][crate::ProgressBar].
#[doc(alias = "gtk_progress_bar_new")]
pub fn new() -> ProgressBar {
assert_initialized_main_thread!();
unsafe { Widget::from_glib_none(ffi::gtk_progress_bar_new()).unsafe_cast() }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`ProgressBar`] objects.
///
/// This method returns an instance of [`ProgressBarBuilder`](crate::builders::ProgressBarBuilder) which can be used to create [`ProgressBar`] objects.
pub fn builder() -> ProgressBarBuilder {
ProgressBarBuilder::new()
}
/// Returns the ellipsizing position of the progress bar.
///
/// See [`set_ellipsize()`][Self::set_ellipsize()].
///
/// # Returns
///
/// [`pango::EllipsizeMode`][crate::pango::EllipsizeMode]
#[doc(alias = "gtk_progress_bar_get_ellipsize")]
#[doc(alias = "get_ellipsize")]
pub fn ellipsize(&self) -> pango::EllipsizeMode {
unsafe { from_glib(ffi::gtk_progress_bar_get_ellipsize(self.to_glib_none().0)) }
}
/// Returns the current fraction of the task that’s been completed.
///
/// # Returns
///
/// a fraction from 0.0 to 1.0
#[doc(alias = "gtk_progress_bar_get_fraction")]
#[doc(alias = "get_fraction")]
pub fn fraction(&self) -> f64 {
unsafe { ffi::gtk_progress_bar_get_fraction(self.to_glib_none().0) }
}
/// Returns whether the progress bar is inverted.
///
/// # Returns
///
/// [`true`] if the progress bar is inverted
#[doc(alias = "gtk_progress_bar_get_inverted")]
#[doc(alias = "get_inverted")]
#[doc(alias = "inverted")]
pub fn is_inverted(&self) -> bool {
unsafe { from_glib(ffi::gtk_progress_bar_get_inverted(self.to_glib_none().0)) }
}
/// Retrieves the pulse step.
///
/// See [`set_pulse_step()`][Self::set_pulse_step()].
///
/// # Returns
///
/// a fraction from 0.0 to 1.0
#[doc(alias = "gtk_progress_bar_get_pulse_step")]
#[doc(alias = "get_pulse_step")]
#[doc(alias = "pulse-step")]
pub fn pulse_step(&self) -> f64 {
unsafe { ffi::gtk_progress_bar_get_pulse_step(self.to_glib_none().0) }
}
/// Returns whether the [`ProgressBar`][crate::ProgressBar] shows text.
///
/// See [`set_show_text()`][Self::set_show_text()].
///
/// # Returns
///
/// [`true`] if text is shown in the progress bar
#[doc(alias = "gtk_progress_bar_get_show_text")]
#[doc(alias = "get_show_text")]
#[doc(alias = "show-text")]
pub fn shows_text(&self) -> bool {
unsafe { from_glib(ffi::gtk_progress_bar_get_show_text(self.to_glib_none().0)) }
}
/// Retrieves the text that is displayed with the progress bar.
///
/// The return value is a reference to the text, not a copy of it,
/// so will become invalid if you change the text in the progress bar.
///
/// # Returns
///
/// the text
#[doc(alias = "gtk_progress_bar_get_text")]
#[doc(alias = "get_text")]
pub fn text(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::gtk_progress_bar_get_text(self.to_glib_none().0)) }
}
/// Indicates that some progress has been made, but you don’t know how much.
///
/// Causes the progress bar to enter “activity mode,” where a block
/// bounces back and forth. Each call to [`pulse()`][Self::pulse()]
/// causes the block to move by a little bit (the amount of movement
/// per pulse is determined by [`set_pulse_step()`][Self::set_pulse_step()]).
#[doc(alias = "gtk_progress_bar_pulse")]
pub fn pulse(&self) {
unsafe {
ffi::gtk_progress_bar_pulse(self.to_glib_none().0);
}
}
/// Sets the mode used to ellipsize the text.
///
/// The text is ellipsized if there is not enough space
/// to render the entire string.
/// ## `mode`
/// a [`pango::EllipsizeMode`][crate::pango::EllipsizeMode]
#[doc(alias = "gtk_progress_bar_set_ellipsize")]
#[doc(alias = "ellipsize")]
pub fn set_ellipsize(&self, mode: pango::EllipsizeMode) {
unsafe {
ffi::gtk_progress_bar_set_ellipsize(self.to_glib_none().0, mode.into_glib());
}
}
/// Causes the progress bar to “fill in” the given fraction
/// of the bar.
///
/// The fraction should be between 0.0 and 1.0, inclusive.
/// ## `fraction`
/// fraction of the task that’s been completed
#[doc(alias = "gtk_progress_bar_set_fraction")]
#[doc(alias = "fraction")]
pub fn set_fraction(&self, fraction: f64) {
unsafe {
ffi::gtk_progress_bar_set_fraction(self.to_glib_none().0, fraction);
}
}
/// Sets whether the progress bar is inverted.
///
/// Progress bars normally grow from top to bottom or left to right.
/// Inverted progress bars grow in the opposite direction.
/// ## `inverted`
/// [`true`] to invert the progress bar
#[doc(alias = "gtk_progress_bar_set_inverted")]
#[doc(alias = "inverted")]
pub fn set_inverted(&self, inverted: bool) {
unsafe {
ffi::gtk_progress_bar_set_inverted(self.to_glib_none().0, inverted.into_glib());
}
}
/// Sets the fraction of total progress bar length to move the
/// bouncing block.
///
/// The bouncing block is moved when [`pulse()`][Self::pulse()]
/// is called.
/// ## `fraction`
/// fraction between 0.0 and 1.0
#[doc(alias = "gtk_progress_bar_set_pulse_step")]
#[doc(alias = "pulse-step")]
pub fn set_pulse_step(&self, fraction: f64) {
unsafe {
ffi::gtk_progress_bar_set_pulse_step(self.to_glib_none().0, fraction);
}
}
/// Sets whether the progress bar will show text next to the bar.
///
/// The shown text is either the value of the [`text`][struct@crate::ProgressBar#text]
/// property or, if that is [`None`], the [`fraction`][struct@crate::ProgressBar#fraction] value,
/// as a percentage.
///
/// To make a progress bar that is styled and sized suitably for containing
/// text (even if the actual text is blank), set [`show-text`][struct@crate::ProgressBar#show-text]
/// to [`true`] and [`text`][struct@crate::ProgressBar#text] to the empty string (not [`None`]).
/// ## `show_text`
/// whether to show text
#[doc(alias = "gtk_progress_bar_set_show_text")]
#[doc(alias = "show-text")]
pub fn set_show_text(&self, show_text: bool) {
unsafe {
ffi::gtk_progress_bar_set_show_text(self.to_glib_none().0, show_text.into_glib());
}
}
/// Causes the given @text to appear next to the progress bar.
///
/// If @text is [`None`] and [`show-text`][struct@crate::ProgressBar#show-text] is [`true`],
/// the current value of [`fraction`][struct@crate::ProgressBar#fraction] will be displayed
/// as a percentage.
///
/// If @text is non-[`None`] and [`show-text`][struct@crate::ProgressBar#show-text] is [`true`],
/// the text will be displayed. In this case, it will not display the progress
/// percentage. If @text is the empty string, the progress bar will still
/// be styled and sized suitably for containing text, as long as
/// [`show-text`][struct@crate::ProgressBar#show-text] is [`true`].
/// ## `text`
/// a UTF-8 string
#[doc(alias = "gtk_progress_bar_set_text")]
#[doc(alias = "text")]
pub fn set_text(&self, text: Option<&str>) {
unsafe {
ffi::gtk_progress_bar_set_text(self.to_glib_none().0, text.to_glib_none().0);
}
}
#[doc(alias = "ellipsize")]
pub fn connect_ellipsize_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_ellipsize_trampoline<F: Fn(&ProgressBar) + 'static>(
this: *mut ffi::GtkProgressBar,
_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::ellipsize\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_ellipsize_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "fraction")]
pub fn connect_fraction_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_fraction_trampoline<F: Fn(&ProgressBar) + 'static>(
this: *mut ffi::GtkProgressBar,
_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::fraction\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_fraction_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "inverted")]
pub fn connect_inverted_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_inverted_trampoline<F: Fn(&ProgressBar) + 'static>(
this: *mut ffi::GtkProgressBar,
_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::inverted\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_inverted_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "pulse-step")]
pub fn connect_pulse_step_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_pulse_step_trampoline<F: Fn(&ProgressBar) + 'static>(
this: *mut ffi::GtkProgressBar,
_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::pulse-step\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_pulse_step_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "show-text")]
pub fn connect_show_text_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_show_text_trampoline<F: Fn(&ProgressBar) + 'static>(
this: *mut ffi::GtkProgressBar,
_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::show-text\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_show_text_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "text")]
pub fn connect_text_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_text_trampoline<F: Fn(&ProgressBar) + 'static>(
this: *mut ffi::GtkProgressBar,
_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::text\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_text_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for ProgressBar {
fn default() -> Self {
Self::new()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ProgressBar`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct ProgressBarBuilder {
builder: glib::object::ObjectBuilder<'static, ProgressBar>,
}
impl ProgressBarBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The preferred place to ellipsize the string.
///
/// The text will be ellipsized if the progress bar does not have enough room
/// to display the entire string, specified as a [`pango::EllipsizeMode`][crate::pango::EllipsizeMode].
///
/// Note that setting this property to a value other than
/// [`pango::EllipsizeMode::None`][crate::pango::EllipsizeMode::None] has the side-effect that the progress bar requests
/// only enough space to display the ellipsis ("..."). Another means to set a
/// progress bar's width is [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()].
pub fn ellipsize(self, ellipsize: pango::EllipsizeMode) -> Self {
Self {
builder: self.builder.property("ellipsize", ellipsize),
}
}
/// The fraction of total work that has been completed.
pub fn fraction(self, fraction: f64) -> Self {
Self {
builder: self.builder.property("fraction", fraction),
}
}
/// Invert the direction in which the progress bar grows.
pub fn inverted(self, inverted: bool) -> Self {
Self {
builder: self.builder.property("inverted", inverted),
}
}
/// The fraction of total progress to move the bounding block when pulsed.
pub fn pulse_step(self, pulse_step: f64) -> Self {
Self {
builder: self.builder.property("pulse-step", pulse_step),
}
}
/// Sets whether the progress bar will show a text in addition
/// to the bar itself.
///
/// The shown text is either the value of the [`text`][struct@crate::ProgressBar#text]
/// property or, if that is [`None`], the [`fraction`][struct@crate::ProgressBar#fraction]
/// value, as a percentage.
///
/// To make a progress bar that is styled and sized suitably for showing text
/// (even if the actual text is blank), set [`show-text`][struct@crate::ProgressBar#show-text]
/// to [`true`] and [`text`][struct@crate::ProgressBar#text] to the empty string (not [`None`]).
pub fn show_text(self, show_text: bool) -> Self {
Self {
builder: self.builder.property("show-text", show_text),
}
}
/// Text to be displayed in the progress bar.
pub fn text(self, text: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("text", text.into()),
}
}
/// Whether the widget or any of its descendents can accept
/// the input focus.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn can_focus(self, can_focus: bool) -> Self {
Self {
builder: self.builder.property("can-focus", can_focus),
}
}
/// Whether the widget can receive pointer events.
pub fn can_target(self, can_target: bool) -> Self {
Self {
builder: self.builder.property("can-target", can_target),
}
}
/// A list of css classes applied to this widget.
pub fn css_classes(self, css_classes: impl Into<glib::StrV>) -> Self {
Self {
builder: self.builder.property("css-classes", css_classes.into()),
}
}
/// The name of this widget in the CSS tree.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn css_name(self, css_name: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("css-name", css_name.into()),
}
}
/// The cursor used by @widget.
pub fn cursor(self, cursor: &gdk::Cursor) -> Self {
Self {
builder: self.builder.property("cursor", cursor.clone()),
}
}
/// Whether the widget should grab focus when it is clicked with the mouse.
///
/// This property is only relevant for widgets that can take focus.
pub fn focus_on_click(self, focus_on_click: bool) -> Self {
Self {
builder: self.builder.property("focus-on-click", focus_on_click),
}
}
/// Whether this widget itself will accept the input focus.
pub fn focusable(self, focusable: bool) -> Self {
Self {
builder: self.builder.property("focusable", focusable),
}
}
/// How to distribute horizontal space if widget gets extra space.
pub fn halign(self, halign: Align) -> Self {
Self {
builder: self.builder.property("halign", halign),
}
}
/// Enables or disables the emission of the ::query-tooltip signal on @widget.
///
/// A value of [`true`] indicates that @widget can have a tooltip, in this case
/// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to
/// determine whether it will provide a tooltip or not.
pub fn has_tooltip(self, has_tooltip: bool) -> Self {
Self {
builder: self.builder.property("has-tooltip", has_tooltip),
}
}
/// Override for height request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn height_request(self, height_request: i32) -> Self {
Self {
builder: self.builder.property("height-request", height_request),
}
}
/// Whether to expand horizontally.
pub fn hexpand(self, hexpand: bool) -> Self {
Self {
builder: self.builder.property("hexpand", hexpand),
}
}
/// Whether to use the `hexpand` property.
pub fn hexpand_set(self, hexpand_set: bool) -> Self {
Self {
builder: self.builder.property("hexpand-set", hexpand_set),
}
}
/// The [`LayoutManager`][crate::LayoutManager] instance to use to compute the preferred size
/// of the widget, and allocate its children.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self {
Self {
builder: self
.builder
.property("layout-manager", layout_manager.clone().upcast()),
}
}
/// Margin on bottom side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_bottom(self, margin_bottom: i32) -> Self {
Self {
builder: self.builder.property("margin-bottom", margin_bottom),
}
}
/// Margin on end of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_end(self, margin_end: i32) -> Self {
Self {
builder: self.builder.property("margin-end", margin_end),
}
}
/// Margin on start of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_start(self, margin_start: i32) -> Self {
Self {
builder: self.builder.property("margin-start", margin_start),
}
}
/// Margin on top side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_top(self, margin_top: i32) -> Self {
Self {
builder: self.builder.property("margin-top", margin_top),
}
}
/// The name of the widget.
pub fn name(self, name: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("name", name.into()),
}
}
/// The requested opacity of the widget.
pub fn opacity(self, opacity: f64) -> Self {
Self {
builder: self.builder.property("opacity", opacity),
}
}
/// How content outside the widget's content area is treated.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn overflow(self, overflow: Overflow) -> Self {
Self {
builder: self.builder.property("overflow", overflow),
}
}
/// Whether the widget will receive the default action when it is focused.
pub fn receives_default(self, receives_default: bool) -> Self {
Self {
builder: self.builder.property("receives-default", receives_default),
}
}
/// Whether the widget responds to input.
pub fn sensitive(self, sensitive: bool) -> Self {
Self {
builder: self.builder.property("sensitive", sensitive),
}
}
/// Sets the text of tooltip to be the given string, which is marked up
/// with Pango markup.
///
/// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
pub fn tooltip_markup(self, tooltip_markup: impl Into<glib::GString>) -> Self {
Self {
builder: self
.builder
.property("tooltip-markup", tooltip_markup.into()),
}
}
/// Sets the text of tooltip to be the given string.
///
/// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
pub fn tooltip_text(self, tooltip_text: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("tooltip-text", tooltip_text.into()),
}
}
/// How to distribute vertical space if widget gets extra space.
pub fn valign(self, valign: Align) -> Self {
Self {
builder: self.builder.property("valign", valign),
}
}
/// Whether to expand vertically.
pub fn vexpand(self, vexpand: bool) -> Self {
Self {
builder: self.builder.property("vexpand", vexpand),
}
}
/// Whether to use the `vexpand` property.
pub fn vexpand_set(self, vexpand_set: bool) -> Self {
Self {
builder: self.builder.property("vexpand-set", vexpand_set),
}
}
/// Whether the widget is visible.
pub fn visible(self, visible: bool) -> Self {
Self {
builder: self.builder.property("visible", visible),
}
}
/// Override for width request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn width_request(self, width_request: i32) -> Self {
Self {
builder: self.builder.property("width-request", width_request),
}
}
/// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self {
Self {
builder: self.builder.property("accessible-role", accessible_role),
}
}
/// The orientation of the orientable.
pub fn orientation(self, orientation: Orientation) -> Self {
Self {
builder: self.builder.property("orientation", orientation),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`ProgressBar`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> ProgressBar {
assert_initialized_main_thread!();
self.builder.build()
}
}