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
// 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
use crate::{ColumnView, ListItemFactory, Sorter};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// [`ColumnViewColumn`][crate::ColumnViewColumn] represents the columns being added to [`ColumnView`][crate::ColumnView].
///
/// The main ingredient for a [`ColumnViewColumn`][crate::ColumnViewColumn] is the [`ListItemFactory`][crate::ListItemFactory]
/// that tells the columnview how to create cells for this column from items in
/// the model.
///
/// Columns have a title, and can optionally have a header menu set
/// with [`set_header_menu()`][Self::set_header_menu()].
///
/// A sorter can be associated with a column using
/// [`set_sorter()`][Self::set_sorter()], to let users influence sorting
/// by clicking on the column header.
///
/// ## Properties
///
///
/// #### `column-view`
/// The [`ColumnView`][crate::ColumnView] this column is a part of.
///
/// Readable
///
///
/// #### `expand`
/// Column gets share of extra width allocated to the view.
///
/// Readable | Writeable
///
///
/// #### `factory`
/// Factory for populating list items.
///
/// Readable | Writeable
///
///
/// #### `fixed-width`
/// If not -1, this is the width that the column is allocated,
/// regardless of the size of its content.
///
/// Readable | Writeable
///
///
/// #### `header-menu`
/// Menu model used to create the context menu for the column header.
///
/// Readable | Writeable
///
///
/// #### `id`
/// An ID for the column.
///
/// GTK is not currently using the ID for anything, but
/// it can be used by applications when saving column view
/// configurations.
///
/// It is up to applications to ensure uniqueness of IDs.
///
/// Readable | Writeable
///
///
/// #### `resizable`
/// Whether this column is resizable.
///
/// Readable | Writeable
///
///
/// #### `sorter`
/// Sorter for sorting items according to this column.
///
/// Readable | Writeable
///
///
/// #### `title`
/// Title displayed in the header.
///
/// Readable | Writeable
///
///
/// #### `visible`
/// Whether this column is visible.
///
/// Readable | Writeable
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GtkColumnViewColumn")]
pub struct ColumnViewColumn(Object<ffi::GtkColumnViewColumn, ffi::GtkColumnViewColumnClass>);
match fn {
type_ => || ffi::gtk_column_view_column_get_type(),
}
}
impl ColumnViewColumn {
/// Creates a new [`ColumnViewColumn`][crate::ColumnViewColumn] that uses the given @factory for
/// mapping items to widgets.
///
/// You most likely want to call [`ColumnView::append_column()`][crate::ColumnView::append_column()] next.
///
/// The function takes ownership of the argument, so you can write code like:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// column = gtk_column_view_column_new (_("Name"),
/// gtk_builder_list_item_factory_new_from_resource ("/name.ui"));
/// ```
/// ## `title`
/// Title to use for this column
/// ## `factory`
/// The factory to populate items with
///
/// # Returns
///
/// a new [`ColumnViewColumn`][crate::ColumnViewColumn] using the given @factory
#[doc(alias = "gtk_column_view_column_new")]
pub fn new(
title: Option<&str>,
factory: Option<impl IsA<ListItemFactory>>,
) -> ColumnViewColumn {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_column_view_column_new(
title.to_glib_none().0,
factory.map(|p| p.upcast()).into_glib_ptr(),
))
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`ColumnViewColumn`] objects.
///
/// This method returns an instance of [`ColumnViewColumnBuilder`](crate::builders::ColumnViewColumnBuilder) which can be used to create [`ColumnViewColumn`] objects.
pub fn builder() -> ColumnViewColumnBuilder {
ColumnViewColumnBuilder::new()
}
/// Gets the column view that's currently displaying this column.
///
/// If @self has not been added to a column view yet, [`None`] is returned.
///
/// # Returns
///
/// The column view displaying @self.
#[doc(alias = "gtk_column_view_column_get_column_view")]
#[doc(alias = "get_column_view")]
pub fn column_view(&self) -> Option<ColumnView> {
unsafe {
from_glib_none(ffi::gtk_column_view_column_get_column_view(
self.to_glib_none().0,
))
}
}
/// Returns whether this column should expand.
///
/// # Returns
///
/// [`true`] if this column expands
#[doc(alias = "gtk_column_view_column_get_expand")]
#[doc(alias = "get_expand")]
pub fn expands(&self) -> bool {
unsafe {
from_glib(ffi::gtk_column_view_column_get_expand(
self.to_glib_none().0,
))
}
}
/// Gets the factory that's currently used to populate list items for
/// this column.
///
/// # Returns
///
/// The factory in use
#[doc(alias = "gtk_column_view_column_get_factory")]
#[doc(alias = "get_factory")]
pub fn factory(&self) -> Option<ListItemFactory> {
unsafe {
from_glib_none(ffi::gtk_column_view_column_get_factory(
self.to_glib_none().0,
))
}
}
/// Gets the fixed width of the column.
///
/// # Returns
///
/// the fixed with of the column
#[doc(alias = "gtk_column_view_column_get_fixed_width")]
#[doc(alias = "get_fixed_width")]
pub fn fixed_width(&self) -> i32 {
unsafe { ffi::gtk_column_view_column_get_fixed_width(self.to_glib_none().0) }
}
/// Gets the menu model that is used to create the context menu
/// for the column header.
///
/// # Returns
///
/// the `GMenuModel`
#[doc(alias = "gtk_column_view_column_get_header_menu")]
#[doc(alias = "get_header_menu")]
pub fn header_menu(&self) -> Option<gio::MenuModel> {
unsafe {
from_glib_none(ffi::gtk_column_view_column_get_header_menu(
self.to_glib_none().0,
))
}
}
/// Returns the ID set with gtk_column_view_column_set_id().
///
/// # Returns
///
/// The column's ID
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
#[doc(alias = "gtk_column_view_column_get_id")]
#[doc(alias = "get_id")]
pub fn id(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::gtk_column_view_column_get_id(self.to_glib_none().0)) }
}
/// Returns whether this column is resizable.
///
/// # Returns
///
/// [`true`] if this column is resizable
#[doc(alias = "gtk_column_view_column_get_resizable")]
#[doc(alias = "get_resizable")]
pub fn is_resizable(&self) -> bool {
unsafe {
from_glib(ffi::gtk_column_view_column_get_resizable(
self.to_glib_none().0,
))
}
}
/// Returns the sorter that is associated with the column.
///
/// # Returns
///
/// the [`Sorter`][crate::Sorter] of @self
#[doc(alias = "gtk_column_view_column_get_sorter")]
#[doc(alias = "get_sorter")]
pub fn sorter(&self) -> Option<Sorter> {
unsafe {
from_glib_none(ffi::gtk_column_view_column_get_sorter(
self.to_glib_none().0,
))
}
}
/// Returns the title set with gtk_column_view_column_set_title().
///
/// # Returns
///
/// The column's title
#[doc(alias = "gtk_column_view_column_get_title")]
#[doc(alias = "get_title")]
pub fn title(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::gtk_column_view_column_get_title(self.to_glib_none().0)) }
}
/// Returns whether this column is visible.
///
/// # Returns
///
/// [`true`] if this column is visible
#[doc(alias = "gtk_column_view_column_get_visible")]
#[doc(alias = "get_visible")]
pub fn is_visible(&self) -> bool {
unsafe {
from_glib(ffi::gtk_column_view_column_get_visible(
self.to_glib_none().0,
))
}
}
/// Sets the column to take available extra space.
///
/// The extra space is shared equally amongst all columns that
/// have the expand set to [`true`].
/// ## `expand`
/// [`true`] if this column should expand to fill available sace
#[doc(alias = "gtk_column_view_column_set_expand")]
pub fn set_expand(&self, expand: bool) {
unsafe {
ffi::gtk_column_view_column_set_expand(self.to_glib_none().0, expand.into_glib());
}
}
/// Sets the [`ListItemFactory`][crate::ListItemFactory] to use for populating list items for this
/// column.
/// ## `factory`
/// the factory to use
#[doc(alias = "gtk_column_view_column_set_factory")]
pub fn set_factory(&self, factory: Option<&impl IsA<ListItemFactory>>) {
unsafe {
ffi::gtk_column_view_column_set_factory(
self.to_glib_none().0,
factory.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// If @fixed_width is not -1, sets the fixed width of @column;
/// otherwise unsets it.
///
/// Setting a fixed width overrides the automatically calculated
/// width. Interactive resizing also sets the “fixed-width” property.
/// ## `fixed_width`
/// the new fixed width, or -1
#[doc(alias = "gtk_column_view_column_set_fixed_width")]
pub fn set_fixed_width(&self, fixed_width: i32) {
unsafe {
ffi::gtk_column_view_column_set_fixed_width(self.to_glib_none().0, fixed_width);
}
}
/// Sets the menu model that is used to create the context menu
/// for the column header.
/// ## `menu`
/// a `GMenuModel`
#[doc(alias = "gtk_column_view_column_set_header_menu")]
pub fn set_header_menu(&self, menu: Option<&impl IsA<gio::MenuModel>>) {
unsafe {
ffi::gtk_column_view_column_set_header_menu(
self.to_glib_none().0,
menu.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Sets the id of this column.
///
/// GTK makes no use of this, but applications can use it when
/// storing column view configuration.
///
/// It is up to callers to ensure uniqueness of IDs.
/// ## `id`
/// ID to use for this column
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
#[doc(alias = "gtk_column_view_column_set_id")]
pub fn set_id(&self, id: Option<&str>) {
unsafe {
ffi::gtk_column_view_column_set_id(self.to_glib_none().0, id.to_glib_none().0);
}
}
/// Sets whether this column should be resizable by dragging.
/// ## `resizable`
/// whether this column should be resizable
#[doc(alias = "gtk_column_view_column_set_resizable")]
pub fn set_resizable(&self, resizable: bool) {
unsafe {
ffi::gtk_column_view_column_set_resizable(self.to_glib_none().0, resizable.into_glib());
}
}
/// Associates a sorter with the column.
///
/// If @sorter is [`None`], the column will not let users change
/// the sorting by clicking on its header.
///
/// This sorter can be made active by clicking on the column
/// header, or by calling [`ColumnView::sort_by_column()`][crate::ColumnView::sort_by_column()].
///
/// See [`ColumnView::sorter()`][crate::ColumnView::sorter()] for the necessary steps
/// for setting up customizable sorting for [`ColumnView`][crate::ColumnView].
/// ## `sorter`
/// the [`Sorter`][crate::Sorter] to associate with @column
#[doc(alias = "gtk_column_view_column_set_sorter")]
pub fn set_sorter(&self, sorter: Option<&impl IsA<Sorter>>) {
unsafe {
ffi::gtk_column_view_column_set_sorter(
self.to_glib_none().0,
sorter.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Sets the title of this column.
///
/// The title is displayed in the header of a [`ColumnView`][crate::ColumnView]
/// for this column and is therefore user-facing text that should
/// be translated.
/// ## `title`
/// Title to use for this column
#[doc(alias = "gtk_column_view_column_set_title")]
pub fn set_title(&self, title: Option<&str>) {
unsafe {
ffi::gtk_column_view_column_set_title(self.to_glib_none().0, title.to_glib_none().0);
}
}
/// Sets whether this column should be visible in views.
/// ## `visible`
/// whether this column should be visible
#[doc(alias = "gtk_column_view_column_set_visible")]
pub fn set_visible(&self, visible: bool) {
unsafe {
ffi::gtk_column_view_column_set_visible(self.to_glib_none().0, visible.into_glib());
}
}
#[doc(alias = "column-view")]
pub fn connect_column_view_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_column_view_trampoline<F: Fn(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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::column-view\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_column_view_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "expand")]
pub fn connect_expand_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_expand_trampoline<F: Fn(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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::expand\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_expand_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "factory")]
pub fn connect_factory_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_factory_trampoline<F: Fn(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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::factory\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_factory_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "fixed-width")]
pub fn connect_fixed_width_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_fixed_width_trampoline<F: Fn(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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::fixed-width\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_fixed_width_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "header-menu")]
pub fn connect_header_menu_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_header_menu_trampoline<F: Fn(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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::header-menu\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_header_menu_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
#[doc(alias = "id")]
pub fn connect_id_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_id_trampoline<F: Fn(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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::id\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_id_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "resizable")]
pub fn connect_resizable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_resizable_trampoline<F: Fn(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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::resizable\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_resizable_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "sorter")]
pub fn connect_sorter_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_sorter_trampoline<F: Fn(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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::sorter\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_sorter_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(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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(transmute::<_, unsafe extern "C" fn()>(
notify_title_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "visible")]
pub fn connect_visible_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_visible_trampoline<F: Fn(&ColumnViewColumn) + 'static>(
this: *mut ffi::GtkColumnViewColumn,
_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::visible\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_visible_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for ColumnViewColumn {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ColumnViewColumn`] 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 ColumnViewColumnBuilder {
builder: glib::object::ObjectBuilder<'static, ColumnViewColumn>,
}
impl ColumnViewColumnBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// Column gets share of extra width allocated to the view.
pub fn expand(self, expand: bool) -> Self {
Self {
builder: self.builder.property("expand", expand),
}
}
/// Factory for populating list items.
pub fn factory(self, factory: &impl IsA<ListItemFactory>) -> Self {
Self {
builder: self.builder.property("factory", factory.clone().upcast()),
}
}
/// If not -1, this is the width that the column is allocated,
/// regardless of the size of its content.
pub fn fixed_width(self, fixed_width: i32) -> Self {
Self {
builder: self.builder.property("fixed-width", fixed_width),
}
}
/// Menu model used to create the context menu for the column header.
pub fn header_menu(self, header_menu: &impl IsA<gio::MenuModel>) -> Self {
Self {
builder: self
.builder
.property("header-menu", header_menu.clone().upcast()),
}
}
/// An ID for the column.
///
/// GTK is not currently using the ID for anything, but
/// it can be used by applications when saving column view
/// configurations.
///
/// It is up to applications to ensure uniqueness of IDs.
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
pub fn id(self, id: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("id", id.into()),
}
}
/// Whether this column is resizable.
pub fn resizable(self, resizable: bool) -> Self {
Self {
builder: self.builder.property("resizable", resizable),
}
}
/// Sorter for sorting items according to this column.
pub fn sorter(self, sorter: &impl IsA<Sorter>) -> Self {
Self {
builder: self.builder.property("sorter", sorter.clone().upcast()),
}
}
/// Title displayed in the header.
pub fn title(self, title: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("title", title.into()),
}
}
/// Whether this column is visible.
pub fn visible(self, visible: bool) -> Self {
Self {
builder: self.builder.property("visible", visible),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`ColumnViewColumn`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> ColumnViewColumn {
self.builder.build()
}
}
impl fmt::Display for ColumnViewColumn {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("ColumnViewColumn")
}
}