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
// 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
#![allow(deprecated)]
use crate::{CellRenderer, CellRendererMode, Orientable, Orientation};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// List views use widgets to display their contents.
/// You should use [`ProgressBar`][crate::ProgressBar] instead
/// Renders numbers as progress bars
///
/// [`CellRendererProgress`][crate::CellRendererProgress] renders a numeric value as a progress par in a cell.
/// Additionally, it can display a text on top of the progress bar.
///
/// ## Properties
///
///
/// #### `inverted`
/// Readable | Writeable
///
///
/// #### `pulse`
/// Setting this to a non-negative value causes the cell renderer to
/// enter "activity mode", where a block bounces back and forth to
/// indicate that some progress is made, without specifying exactly how
/// much.
///
/// Each increment of the property causes the block to move by a little
/// bit.
///
/// To indicate that the activity has not started yet, set the property
/// to zero. To indicate completion, set the property to `G_MAXINT`.
///
/// Readable | Writeable
///
///
/// #### `text`
/// The "text" property determines the label which will be drawn
/// over the progress bar. Setting this property to [`None`] causes the default
/// label to be displayed. Setting this property to an empty string causes
/// no label to be displayed.
///
/// Readable | Writeable
///
///
/// #### `text-xalign`
/// The "text-xalign" property controls the horizontal alignment of the
/// text in the progress bar. Valid values range from 0 (left) to 1
/// (right). Reserved for RTL layouts.
///
/// Readable | Writeable
///
///
/// #### `text-yalign`
/// The "text-yalign" property controls the vertical alignment of the
/// text in the progress bar. Valid values range from 0 (top) to 1
/// (bottom).
///
/// Readable | Writeable
///
///
/// #### `value`
/// The "value" property determines the percentage to which the
/// progress bar will be "filled in".
///
/// Readable | Writeable
/// <details><summary><h4>CellRenderer</h4></summary>
///
///
/// #### `cell-background`
/// Writeable
///
///
/// #### `cell-background-rgba`
/// Cell background as a [`gdk::RGBA`][crate::gdk::RGBA]
///
/// Readable | Writeable
///
///
/// #### `cell-background-set`
/// Readable | Writeable
///
///
/// #### `editing`
/// Readable
///
///
/// #### `height`
/// Readable | Writeable
///
///
/// #### `is-expanded`
/// Readable | Writeable
///
///
/// #### `is-expander`
/// Readable | Writeable
///
///
/// #### `mode`
/// Readable | Writeable
///
///
/// #### `sensitive`
/// Readable | Writeable
///
///
/// #### `visible`
/// Readable | Writeable
///
///
/// #### `width`
/// Readable | Writeable
///
///
/// #### `xalign`
/// Readable | Writeable
///
///
/// #### `xpad`
/// Readable | Writeable
///
///
/// #### `yalign`
/// Readable | Writeable
///
///
/// #### `ypad`
/// Readable | Writeable
/// </details>
/// <details><summary><h4>Orientable</h4></summary>
///
///
/// #### `orientation`
/// The orientation of the orientable.
///
/// Readable | Writeable
/// </details>
///
/// # Implements
///
/// [`CellRendererExt`][trait@crate::prelude::CellRendererExt], [`trait@glib::ObjectExt`], [`OrientableExt`][trait@crate::prelude::OrientableExt], [`CellRendererExtManual`][trait@crate::prelude::CellRendererExtManual]
#[doc(alias = "GtkCellRendererProgress")]
pub struct CellRendererProgress(Object<ffi::GtkCellRendererProgress>) @extends CellRenderer, @implements Orientable;
match fn {
type_ => || ffi::gtk_cell_renderer_progress_get_type(),
}
}
impl CellRendererProgress {
/// Creates a new [`CellRendererProgress`][crate::CellRendererProgress].
///
/// # Deprecated since 4.10
///
///
/// # Returns
///
/// the new cell renderer
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_cell_renderer_progress_new")]
pub fn new() -> CellRendererProgress {
assert_initialized_main_thread!();
unsafe { CellRenderer::from_glib_none(ffi::gtk_cell_renderer_progress_new()).unsafe_cast() }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`CellRendererProgress`] objects.
///
/// This method returns an instance of [`CellRendererProgressBuilder`](crate::builders::CellRendererProgressBuilder) which can be used to create [`CellRendererProgress`] objects.
pub fn builder() -> CellRendererProgressBuilder {
CellRendererProgressBuilder::new()
}
pub fn is_inverted(&self) -> bool {
ObjectExt::property(self, "inverted")
}
pub fn set_inverted(&self, inverted: bool) {
ObjectExt::set_property(self, "inverted", inverted)
}
/// Setting this to a non-negative value causes the cell renderer to
/// enter "activity mode", where a block bounces back and forth to
/// indicate that some progress is made, without specifying exactly how
/// much.
///
/// Each increment of the property causes the block to move by a little
/// bit.
///
/// To indicate that the activity has not started yet, set the property
/// to zero. To indicate completion, set the property to `G_MAXINT`.
pub fn pulse(&self) -> i32 {
ObjectExt::property(self, "pulse")
}
/// Setting this to a non-negative value causes the cell renderer to
/// enter "activity mode", where a block bounces back and forth to
/// indicate that some progress is made, without specifying exactly how
/// much.
///
/// Each increment of the property causes the block to move by a little
/// bit.
///
/// To indicate that the activity has not started yet, set the property
/// to zero. To indicate completion, set the property to `G_MAXINT`.
pub fn set_pulse(&self, pulse: i32) {
ObjectExt::set_property(self, "pulse", pulse)
}
/// The "text" property determines the label which will be drawn
/// over the progress bar. Setting this property to [`None`] causes the default
/// label to be displayed. Setting this property to an empty string causes
/// no label to be displayed.
pub fn text(&self) -> Option<glib::GString> {
ObjectExt::property(self, "text")
}
/// The "text" property determines the label which will be drawn
/// over the progress bar. Setting this property to [`None`] causes the default
/// label to be displayed. Setting this property to an empty string causes
/// no label to be displayed.
pub fn set_text(&self, text: Option<&str>) {
ObjectExt::set_property(self, "text", text)
}
/// The "text-xalign" property controls the horizontal alignment of the
/// text in the progress bar. Valid values range from 0 (left) to 1
/// (right). Reserved for RTL layouts.
#[doc(alias = "text-xalign")]
pub fn text_xalign(&self) -> f32 {
ObjectExt::property(self, "text-xalign")
}
/// The "text-xalign" property controls the horizontal alignment of the
/// text in the progress bar. Valid values range from 0 (left) to 1
/// (right). Reserved for RTL layouts.
#[doc(alias = "text-xalign")]
pub fn set_text_xalign(&self, text_xalign: f32) {
ObjectExt::set_property(self, "text-xalign", text_xalign)
}
/// The "text-yalign" property controls the vertical alignment of the
/// text in the progress bar. Valid values range from 0 (top) to 1
/// (bottom).
#[doc(alias = "text-yalign")]
pub fn text_yalign(&self) -> f32 {
ObjectExt::property(self, "text-yalign")
}
/// The "text-yalign" property controls the vertical alignment of the
/// text in the progress bar. Valid values range from 0 (top) to 1
/// (bottom).
#[doc(alias = "text-yalign")]
pub fn set_text_yalign(&self, text_yalign: f32) {
ObjectExt::set_property(self, "text-yalign", text_yalign)
}
/// The "value" property determines the percentage to which the
/// progress bar will be "filled in".
pub fn value(&self) -> i32 {
ObjectExt::property(self, "value")
}
/// The "value" property determines the percentage to which the
/// progress bar will be "filled in".
pub fn set_value(&self, value: i32) {
ObjectExt::set_property(self, "value", value)
}
#[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(&CellRendererProgress) + 'static>(
this: *mut ffi::GtkCellRendererProgress,
_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::<_, unsafe extern "C" fn()>(
notify_inverted_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "pulse")]
pub fn connect_pulse_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_pulse_trampoline<F: Fn(&CellRendererProgress) + 'static>(
this: *mut ffi::GtkCellRendererProgress,
_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\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_pulse_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(&CellRendererProgress) + 'static>(
this: *mut ffi::GtkCellRendererProgress,
_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::<_, unsafe extern "C" fn()>(
notify_text_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "text-xalign")]
pub fn connect_text_xalign_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_text_xalign_trampoline<
F: Fn(&CellRendererProgress) + 'static,
>(
this: *mut ffi::GtkCellRendererProgress,
_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-xalign\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_text_xalign_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "text-yalign")]
pub fn connect_text_yalign_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_text_yalign_trampoline<
F: Fn(&CellRendererProgress) + 'static,
>(
this: *mut ffi::GtkCellRendererProgress,
_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-yalign\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_text_yalign_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "value")]
pub fn connect_value_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_value_trampoline<F: Fn(&CellRendererProgress) + 'static>(
this: *mut ffi::GtkCellRendererProgress,
_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::value\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_value_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for CellRendererProgress {
fn default() -> Self {
Self::new()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`CellRendererProgress`] 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 CellRendererProgressBuilder {
builder: glib::object::ObjectBuilder<'static, CellRendererProgress>,
}
impl CellRendererProgressBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
pub fn inverted(self, inverted: bool) -> Self {
Self {
builder: self.builder.property("inverted", inverted),
}
}
/// Setting this to a non-negative value causes the cell renderer to
/// enter "activity mode", where a block bounces back and forth to
/// indicate that some progress is made, without specifying exactly how
/// much.
///
/// Each increment of the property causes the block to move by a little
/// bit.
///
/// To indicate that the activity has not started yet, set the property
/// to zero. To indicate completion, set the property to `G_MAXINT`.
pub fn pulse(self, pulse: i32) -> Self {
Self {
builder: self.builder.property("pulse", pulse),
}
}
/// The "text" property determines the label which will be drawn
/// over the progress bar. Setting this property to [`None`] causes the default
/// label to be displayed. Setting this property to an empty string causes
/// no label to be displayed.
pub fn text(self, text: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("text", text.into()),
}
}
/// The "text-xalign" property controls the horizontal alignment of the
/// text in the progress bar. Valid values range from 0 (left) to 1
/// (right). Reserved for RTL layouts.
pub fn text_xalign(self, text_xalign: f32) -> Self {
Self {
builder: self.builder.property("text-xalign", text_xalign),
}
}
/// The "text-yalign" property controls the vertical alignment of the
/// text in the progress bar. Valid values range from 0 (top) to 1
/// (bottom).
pub fn text_yalign(self, text_yalign: f32) -> Self {
Self {
builder: self.builder.property("text-yalign", text_yalign),
}
}
/// The "value" property determines the percentage to which the
/// progress bar will be "filled in".
pub fn value(self, value: i32) -> Self {
Self {
builder: self.builder.property("value", value),
}
}
pub fn cell_background(self, cell_background: impl Into<glib::GString>) -> Self {
Self {
builder: self
.builder
.property("cell-background", cell_background.into()),
}
}
/// Cell background as a [`gdk::RGBA`][crate::gdk::RGBA]
pub fn cell_background_rgba(self, cell_background_rgba: &gdk::RGBA) -> Self {
Self {
builder: self
.builder
.property("cell-background-rgba", cell_background_rgba),
}
}
pub fn cell_background_set(self, cell_background_set: bool) -> Self {
Self {
builder: self
.builder
.property("cell-background-set", cell_background_set),
}
}
pub fn height(self, height: i32) -> Self {
Self {
builder: self.builder.property("height", height),
}
}
pub fn is_expanded(self, is_expanded: bool) -> Self {
Self {
builder: self.builder.property("is-expanded", is_expanded),
}
}
pub fn is_expander(self, is_expander: bool) -> Self {
Self {
builder: self.builder.property("is-expander", is_expander),
}
}
pub fn mode(self, mode: CellRendererMode) -> Self {
Self {
builder: self.builder.property("mode", mode),
}
}
pub fn sensitive(self, sensitive: bool) -> Self {
Self {
builder: self.builder.property("sensitive", sensitive),
}
}
pub fn visible(self, visible: bool) -> Self {
Self {
builder: self.builder.property("visible", visible),
}
}
pub fn width(self, width: i32) -> Self {
Self {
builder: self.builder.property("width", width),
}
}
pub fn xalign(self, xalign: f32) -> Self {
Self {
builder: self.builder.property("xalign", xalign),
}
}
pub fn xpad(self, xpad: u32) -> Self {
Self {
builder: self.builder.property("xpad", xpad),
}
}
pub fn yalign(self, yalign: f32) -> Self {
Self {
builder: self.builder.property("yalign", yalign),
}
}
pub fn ypad(self, ypad: u32) -> Self {
Self {
builder: self.builder.property("ypad", ypad),
}
}
/// 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 [`CellRendererProgress`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> CellRendererProgress {
self.builder.build()
}
}