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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
use crate::Accessible;
use crate::AccessibleRole;
use crate::Align;
use crate::Buildable;
use crate::ConstraintTarget;
use crate::LayoutManager;
use crate::Overflow;
use crate::Widget;
use glib::object::Cast;
use glib::object::IsA;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;
glib::wrapper! {
/// [`HeaderBar`][crate::HeaderBar] is a widget for creating custom title bars for windows.
///
/// ![An example GtkHeaderBar](headerbar.png)
///
/// [`HeaderBar`][crate::HeaderBar] is similar to a horizontal [`CenterBox`][crate::CenterBox]. It allows
/// children to be placed at the start or the end. In addition, it allows
/// the window title to be displayed. The title will be centered with respect
/// to the width of the box, even if the children at either side take up
/// different amounts of space.
///
/// [`HeaderBar`][crate::HeaderBar] can add typical window frame controls, such as minimize,
/// maximize and close buttons, or the window icon.
///
/// For these reasons, [`HeaderBar`][crate::HeaderBar] is the natural choice for use as the
/// custom titlebar widget of a [`Window`][crate::Window] (see [`GtkWindowExt::set_titlebar()`][crate::prelude::GtkWindowExt::set_titlebar()]),
/// as it gives features typical of titlebars while allowing the addition of
/// child widgets.
///
/// ## GtkHeaderBar as GtkBuildable
///
/// The [`HeaderBar`][crate::HeaderBar] implementation of the [`Buildable`][crate::Buildable] interface supports
/// adding children at the start or end sides by specifying “start” or “end” as
/// the “type” attribute of a <child> element, or setting the title widget by
/// specifying “title” value.
///
/// By default the [`HeaderBar`][crate::HeaderBar] uses a [`Label`][crate::Label] displaying the title of the
/// window it is contained in as the title widget, equivalent to the following
/// UI definition:
///
/// ```xml
/// <object class="GtkHeaderBar">
/// <property name="title-widget">
/// <object class="GtkLabel">
/// <property name="label" translatable="yes">Label</property>
/// <property name="single-line-mode">True</property>
/// <property name="ellipsize">end</property>
/// <property name="width-chars">5</property>
/// <style>
/// <class name="title"/>
/// </style>
/// </object>
/// </property>
/// </object>
/// ```
///
/// # CSS nodes
///
/// ```text
/// headerbar
/// ╰── windowhandle
/// ╰── box
/// ├── box.start
/// │ ├── windowcontrols.start
/// │ ╰── [other children]
/// ├── [Title Widget]
/// ╰── box.end
/// ├── [other children]
/// ╰── windowcontrols.end
/// ```
///
/// A [`HeaderBar`][crate::HeaderBar]'s CSS node is called `headerbar`. It contains a `windowhandle`
/// subnode, which contains a `box` subnode, which contains two `box` subnodes at
/// the start and end of the header bar, as well as a center node that represents
/// the title.
///
/// Each of the boxes contains a `windowcontrols` subnode, see
/// [`WindowControls`][crate::WindowControls] for details, as well as other children.
///
/// # Accessibility
///
/// [`HeaderBar`][crate::HeaderBar] uses the [`AccessibleRole::Group`][crate::AccessibleRole::Group] role.
///
/// # Implements
///
/// [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`AccessibleExt`][trait@crate::prelude::AccessibleExt], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`ConstraintTargetExt`][trait@crate::prelude::ConstraintTargetExt], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`AccessibleExtManual`][trait@crate::prelude::AccessibleExtManual]
#[doc(alias = "GtkHeaderBar")]
pub struct HeaderBar(Object<ffi::GtkHeaderBar>) @extends Widget, @implements Accessible, Buildable, ConstraintTarget;
match fn {
type_ => || ffi::gtk_header_bar_get_type(),
}
}
impl HeaderBar {
/// Creates a new [`HeaderBar`][crate::HeaderBar] widget.
///
/// # Returns
///
/// a new [`HeaderBar`][crate::HeaderBar]
#[doc(alias = "gtk_header_bar_new")]
pub fn new() -> HeaderBar {
assert_initialized_main_thread!();
unsafe { Widget::from_glib_none(ffi::gtk_header_bar_new()).unsafe_cast() }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`HeaderBar`] objects.
///
/// This method returns an instance of [`HeaderBarBuilder`](crate::builders::HeaderBarBuilder) which can be used to create [`HeaderBar`] objects.
pub fn builder() -> HeaderBarBuilder {
HeaderBarBuilder::default()
}
/// Gets the decoration layout of the [`HeaderBar`][crate::HeaderBar].
///
/// # Returns
///
/// the decoration layout
#[doc(alias = "gtk_header_bar_get_decoration_layout")]
#[doc(alias = "get_decoration_layout")]
pub fn decoration_layout(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::gtk_header_bar_get_decoration_layout(
self.to_glib_none().0,
))
}
}
/// Returns whether this header bar shows the standard window
/// title buttons.
///
/// # Returns
///
/// [`true`] if title buttons are shown
#[doc(alias = "gtk_header_bar_get_show_title_buttons")]
#[doc(alias = "get_show_title_buttons")]
pub fn shows_title_buttons(&self) -> bool {
unsafe {
from_glib(ffi::gtk_header_bar_get_show_title_buttons(
self.to_glib_none().0,
))
}
}
/// Retrieves the title widget of the header.
///
/// See [`set_title_widget()`][Self::set_title_widget()].
///
/// # Returns
///
/// the title widget of the header
#[doc(alias = "gtk_header_bar_get_title_widget")]
#[doc(alias = "get_title_widget")]
pub fn title_widget(&self) -> Option<Widget> {
unsafe { from_glib_none(ffi::gtk_header_bar_get_title_widget(self.to_glib_none().0)) }
}
/// Adds @child to @self, packed with reference to the
/// end of the @self.
/// ## `child`
/// the [`Widget`][crate::Widget] to be added to @self
#[doc(alias = "gtk_header_bar_pack_end")]
pub fn pack_end(&self, child: &impl IsA<Widget>) {
unsafe {
ffi::gtk_header_bar_pack_end(self.to_glib_none().0, child.as_ref().to_glib_none().0);
}
}
/// Adds @child to @self, packed with reference to the
/// start of the @self.
/// ## `child`
/// the [`Widget`][crate::Widget] to be added to @self
#[doc(alias = "gtk_header_bar_pack_start")]
pub fn pack_start(&self, child: &impl IsA<Widget>) {
unsafe {
ffi::gtk_header_bar_pack_start(self.to_glib_none().0, child.as_ref().to_glib_none().0);
}
}
/// Removes a child from the [`HeaderBar`][crate::HeaderBar].
///
/// The child must have been added with
/// [`pack_start()`][Self::pack_start()],
/// [`pack_end()`][Self::pack_end()] or
/// [`set_title_widget()`][Self::set_title_widget()].
/// ## `child`
/// the child to remove
#[doc(alias = "gtk_header_bar_remove")]
pub fn remove(&self, child: &impl IsA<Widget>) {
unsafe {
ffi::gtk_header_bar_remove(self.to_glib_none().0, child.as_ref().to_glib_none().0);
}
}
/// Sets the decoration layout for this header bar.
///
/// This property overrides the
/// `property::Settings::gtk-decoration-layout` setting.
///
/// There can be valid reasons for overriding the setting, such
/// as a header bar design that does not allow for buttons to take
/// room on the right, or only offers room for a single close button.
/// Split header bars are another example for overriding the setting.
///
/// The format of the string is button names, separated by commas.
/// A colon separates the buttons that should appear on the left
/// from those on the right. Recognized button names are minimize,
/// maximize, close and icon (the window icon).
///
/// For example, “icon:minimize,maximize,close” specifies a icon
/// on the left, and minimize, maximize and close buttons on the right.
/// ## `layout`
/// a decoration layout, or [`None`] to unset the layout
#[doc(alias = "gtk_header_bar_set_decoration_layout")]
pub fn set_decoration_layout(&self, layout: Option<&str>) {
unsafe {
ffi::gtk_header_bar_set_decoration_layout(
self.to_glib_none().0,
layout.to_glib_none().0,
);
}
}
/// Sets whether this header bar shows the standard window
/// title buttons.
/// ## `setting`
/// [`true`] to show standard title buttons
#[doc(alias = "gtk_header_bar_set_show_title_buttons")]
pub fn set_show_title_buttons(&self, setting: bool) {
unsafe {
ffi::gtk_header_bar_set_show_title_buttons(self.to_glib_none().0, setting.into_glib());
}
}
/// Sets the title for the [`HeaderBar`][crate::HeaderBar].
///
/// When set to [`None`], the headerbar will display the title of
/// the window it is contained in.
///
/// The title should help a user identify the current view.
/// To achieve the same style as the builtin title, use the
/// “title” style class.
///
/// You should set the title widget to [`None`], for the window
/// title label to be visible again.
/// ## `title_widget`
/// a widget to use for a title
#[doc(alias = "gtk_header_bar_set_title_widget")]
pub fn set_title_widget(&self, title_widget: Option<&impl IsA<Widget>>) {
unsafe {
ffi::gtk_header_bar_set_title_widget(
self.to_glib_none().0,
title_widget.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
#[doc(alias = "decoration-layout")]
pub fn connect_decoration_layout_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_decoration_layout_trampoline<F: Fn(&HeaderBar) + 'static>(
this: *mut ffi::GtkHeaderBar,
_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::decoration-layout\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_decoration_layout_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "show-title-buttons")]
pub fn connect_show_title_buttons_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_show_title_buttons_trampoline<F: Fn(&HeaderBar) + 'static>(
this: *mut ffi::GtkHeaderBar,
_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-title-buttons\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_show_title_buttons_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "title-widget")]
pub fn connect_title_widget_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_title_widget_trampoline<F: Fn(&HeaderBar) + 'static>(
this: *mut ffi::GtkHeaderBar,
_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-widget\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_title_widget_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for HeaderBar {
fn default() -> Self {
Self::new()
}
}
#[derive(Clone, Default)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`HeaderBar`] 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 HeaderBarBuilder {
decoration_layout: Option<String>,
show_title_buttons: Option<bool>,
title_widget: Option<Widget>,
can_focus: Option<bool>,
can_target: Option<bool>,
css_classes: Option<Vec<String>>,
css_name: Option<String>,
cursor: Option<gdk::Cursor>,
focus_on_click: Option<bool>,
focusable: Option<bool>,
halign: Option<Align>,
has_tooltip: Option<bool>,
height_request: Option<i32>,
hexpand: Option<bool>,
hexpand_set: Option<bool>,
layout_manager: Option<LayoutManager>,
margin_bottom: Option<i32>,
margin_end: Option<i32>,
margin_start: Option<i32>,
margin_top: Option<i32>,
name: Option<String>,
opacity: Option<f64>,
overflow: Option<Overflow>,
receives_default: Option<bool>,
sensitive: Option<bool>,
tooltip_markup: Option<String>,
tooltip_text: Option<String>,
valign: Option<Align>,
vexpand: Option<bool>,
vexpand_set: Option<bool>,
visible: Option<bool>,
width_request: Option<i32>,
accessible_role: Option<AccessibleRole>,
}
impl HeaderBarBuilder {
// rustdoc-stripper-ignore-next
/// Create a new [`HeaderBarBuilder`].
pub fn new() -> Self {
Self::default()
}
// rustdoc-stripper-ignore-next
/// Build the [`HeaderBar`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> HeaderBar {
let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
if let Some(ref decoration_layout) = self.decoration_layout {
properties.push(("decoration-layout", decoration_layout));
}
if let Some(ref show_title_buttons) = self.show_title_buttons {
properties.push(("show-title-buttons", show_title_buttons));
}
if let Some(ref title_widget) = self.title_widget {
properties.push(("title-widget", title_widget));
}
if let Some(ref can_focus) = self.can_focus {
properties.push(("can-focus", can_focus));
}
if let Some(ref can_target) = self.can_target {
properties.push(("can-target", can_target));
}
if let Some(ref css_classes) = self.css_classes {
properties.push(("css-classes", css_classes));
}
if let Some(ref css_name) = self.css_name {
properties.push(("css-name", css_name));
}
if let Some(ref cursor) = self.cursor {
properties.push(("cursor", cursor));
}
if let Some(ref focus_on_click) = self.focus_on_click {
properties.push(("focus-on-click", focus_on_click));
}
if let Some(ref focusable) = self.focusable {
properties.push(("focusable", focusable));
}
if let Some(ref halign) = self.halign {
properties.push(("halign", halign));
}
if let Some(ref has_tooltip) = self.has_tooltip {
properties.push(("has-tooltip", has_tooltip));
}
if let Some(ref height_request) = self.height_request {
properties.push(("height-request", height_request));
}
if let Some(ref hexpand) = self.hexpand {
properties.push(("hexpand", hexpand));
}
if let Some(ref hexpand_set) = self.hexpand_set {
properties.push(("hexpand-set", hexpand_set));
}
if let Some(ref layout_manager) = self.layout_manager {
properties.push(("layout-manager", layout_manager));
}
if let Some(ref margin_bottom) = self.margin_bottom {
properties.push(("margin-bottom", margin_bottom));
}
if let Some(ref margin_end) = self.margin_end {
properties.push(("margin-end", margin_end));
}
if let Some(ref margin_start) = self.margin_start {
properties.push(("margin-start", margin_start));
}
if let Some(ref margin_top) = self.margin_top {
properties.push(("margin-top", margin_top));
}
if let Some(ref name) = self.name {
properties.push(("name", name));
}
if let Some(ref opacity) = self.opacity {
properties.push(("opacity", opacity));
}
if let Some(ref overflow) = self.overflow {
properties.push(("overflow", overflow));
}
if let Some(ref receives_default) = self.receives_default {
properties.push(("receives-default", receives_default));
}
if let Some(ref sensitive) = self.sensitive {
properties.push(("sensitive", sensitive));
}
if let Some(ref tooltip_markup) = self.tooltip_markup {
properties.push(("tooltip-markup", tooltip_markup));
}
if let Some(ref tooltip_text) = self.tooltip_text {
properties.push(("tooltip-text", tooltip_text));
}
if let Some(ref valign) = self.valign {
properties.push(("valign", valign));
}
if let Some(ref vexpand) = self.vexpand {
properties.push(("vexpand", vexpand));
}
if let Some(ref vexpand_set) = self.vexpand_set {
properties.push(("vexpand-set", vexpand_set));
}
if let Some(ref visible) = self.visible {
properties.push(("visible", visible));
}
if let Some(ref width_request) = self.width_request {
properties.push(("width-request", width_request));
}
if let Some(ref accessible_role) = self.accessible_role {
properties.push(("accessible-role", accessible_role));
}
glib::Object::new::<HeaderBar>(&properties)
.expect("Failed to create an instance of HeaderBar")
}
/// The decoration layout for buttons.
///
/// If this property is not set, the
/// `property::Settings::gtk-decoration-layout` setting is used.
pub fn decoration_layout(mut self, decoration_layout: &str) -> Self {
self.decoration_layout = Some(decoration_layout.to_string());
self
}
/// Whether to show title buttons like close, minimize, maximize.
///
/// Which buttons are actually shown and where is determined
/// by the `property::HeaderBar::decoration-layout` property,
/// and by the state of the window (e.g. a close button will not
/// be shown if the window can't be closed).
pub fn show_title_buttons(mut self, show_title_buttons: bool) -> Self {
self.show_title_buttons = Some(show_title_buttons);
self
}
pub fn title_widget(mut self, title_widget: &impl IsA<Widget>) -> Self {
self.title_widget = Some(title_widget.clone().upcast());
self
}
/// 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(mut self, can_focus: bool) -> Self {
self.can_focus = Some(can_focus);
self
}
/// Whether the widget can receive pointer events.
pub fn can_target(mut self, can_target: bool) -> Self {
self.can_target = Some(can_target);
self
}
/// A list of css classes applied to this widget.
pub fn css_classes(mut self, css_classes: Vec<String>) -> Self {
self.css_classes = Some(css_classes);
self
}
/// 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(mut self, css_name: &str) -> Self {
self.css_name = Some(css_name.to_string());
self
}
/// The cursor used by @widget.
pub fn cursor(mut self, cursor: &gdk::Cursor) -> Self {
self.cursor = Some(cursor.clone());
self
}
/// 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(mut self, focus_on_click: bool) -> Self {
self.focus_on_click = Some(focus_on_click);
self
}
/// Whether this widget itself will accept the input focus.
pub fn focusable(mut self, focusable: bool) -> Self {
self.focusable = Some(focusable);
self
}
/// How to distribute horizontal space if widget gets extra space.
pub fn halign(mut self, halign: Align) -> Self {
self.halign = Some(halign);
self
}
/// 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 `signal::Widget::query-tooltip` to
/// determine whether it will provide a tooltip or not.
pub fn has_tooltip(mut self, has_tooltip: bool) -> Self {
self.has_tooltip = Some(has_tooltip);
self
}
/// Override for height request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn height_request(mut self, height_request: i32) -> Self {
self.height_request = Some(height_request);
self
}
/// Whether to expand horizontally.
pub fn hexpand(mut self, hexpand: bool) -> Self {
self.hexpand = Some(hexpand);
self
}
/// Whether to use the `hexpand` property.
pub fn hexpand_set(mut self, hexpand_set: bool) -> Self {
self.hexpand_set = Some(hexpand_set);
self
}
/// 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(mut self, layout_manager: &impl IsA<LayoutManager>) -> Self {
self.layout_manager = Some(layout_manager.clone().upcast());
self
}
/// 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(mut self, margin_bottom: i32) -> Self {
self.margin_bottom = Some(margin_bottom);
self
}
/// 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(mut self, margin_end: i32) -> Self {
self.margin_end = Some(margin_end);
self
}
/// 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(mut self, margin_start: i32) -> Self {
self.margin_start = Some(margin_start);
self
}
/// 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(mut self, margin_top: i32) -> Self {
self.margin_top = Some(margin_top);
self
}
/// The name of the widget.
pub fn name(mut self, name: &str) -> Self {
self.name = Some(name.to_string());
self
}
/// The requested opacity of the widget.
pub fn opacity(mut self, opacity: f64) -> Self {
self.opacity = Some(opacity);
self
}
/// 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(mut self, overflow: Overflow) -> Self {
self.overflow = Some(overflow);
self
}
/// Whether the widget will receive the default action when it is focused.
pub fn receives_default(mut self, receives_default: bool) -> Self {
self.receives_default = Some(receives_default);
self
}
/// Whether the widget responds to input.
pub fn sensitive(mut self, sensitive: bool) -> Self {
self.sensitive = Some(sensitive);
self
}
/// 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`]:
/// `property::Widget::has-tooltip` will automatically be set to [`true`]
/// and there will be taken care of `signal::Widget::query-tooltip` in
/// the default signal handler.
///
/// Note that if both `property::Widget::tooltip-text` and
/// `property::Widget::tooltip-markup` are set, the last one wins.
pub fn tooltip_markup(mut self, tooltip_markup: &str) -> Self {
self.tooltip_markup = Some(tooltip_markup.to_string());
self
}
/// 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`]:
/// `property::Widget::has-tooltip` will automatically be set to [`true`]
/// and there will be taken care of `signal::Widget::query-tooltip` in
/// the default signal handler.
///
/// Note that if both `property::Widget::tooltip-text` and
/// `property::Widget::tooltip-markup` are set, the last one wins.
pub fn tooltip_text(mut self, tooltip_text: &str) -> Self {
self.tooltip_text = Some(tooltip_text.to_string());
self
}
/// How to distribute vertical space if widget gets extra space.
pub fn valign(mut self, valign: Align) -> Self {
self.valign = Some(valign);
self
}
/// Whether to expand vertically.
pub fn vexpand(mut self, vexpand: bool) -> Self {
self.vexpand = Some(vexpand);
self
}
/// Whether to use the `vexpand` property.
pub fn vexpand_set(mut self, vexpand_set: bool) -> Self {
self.vexpand_set = Some(vexpand_set);
self
}
/// Whether the widget is visible.
pub fn visible(mut self, visible: bool) -> Self {
self.visible = Some(visible);
self
}
/// Override for width request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn width_request(mut self, width_request: i32) -> Self {
self.width_request = Some(width_request);
self
}
/// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
pub fn accessible_role(mut self, accessible_role: AccessibleRole) -> Self {
self.accessible_role = Some(accessible_role);
self
}
}
impl fmt::Display for HeaderBar {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("HeaderBar")
}
}