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
// 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, TreePath};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// List views use widgets to display their contents.
/// You should use [`ToggleButton`][crate::ToggleButton] instead
/// Renders a toggle button in a cell
///
/// [`CellRendererToggle`][crate::CellRendererToggle] renders a toggle button in a cell. The
/// button is drawn as a radio or a checkbutton, depending on the
/// `GtkCellRendererToggle:radio` property.
/// When activated, it emits the `GtkCellRendererToggle::toggled` signal.
///
/// ## Properties
///
///
/// #### `activatable`
/// Readable | Writeable
///
///
/// #### `active`
/// Readable | Writeable
///
///
/// #### `inconsistent`
/// Readable | Writeable
///
///
/// #### `radio`
/// 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>
///
/// ## Signals
///
///
/// #### `toggled`
/// The ::toggled signal is emitted when the cell is toggled.
///
/// It is the responsibility of the application to update the model
/// with the correct value to store at @path. Often this is simply the
/// opposite of the value currently stored at @path.
///
///
/// <details><summary><h4>CellRenderer</h4></summary>
///
///
/// #### `editing-canceled`
/// This signal gets emitted when the user cancels the process of editing a
/// cell. For example, an editable cell renderer could be written to cancel
/// editing when the user presses Escape.
///
/// See also: gtk_cell_renderer_stop_editing().
///
///
///
///
/// #### `editing-started`
/// This signal gets emitted when a cell starts to be edited.
/// The intended use of this signal is to do special setup
/// on @editable, e.g. adding a [`EntryCompletion`][crate::EntryCompletion] or setting
/// up additional columns in a [`ComboBox`][crate::ComboBox].
///
/// See gtk_cell_editable_start_editing() for information on the lifecycle of
/// the @editable and a way to do setup that doesn’t depend on the @renderer.
///
/// Note that GTK doesn't guarantee that cell renderers will
/// continue to use the same kind of widget for editing in future
/// releases, therefore you should check the type of @editable
/// before doing any specific setup, as in the following example:
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// static void
/// text_editing_started (GtkCellRenderer *cell,
/// GtkCellEditable *editable,
/// const char *path,
/// gpointer data)
/// {
/// if (GTK_IS_ENTRY (editable))
/// {
/// GtkEntry *entry = GTK_ENTRY (editable);
///
/// // ... create a GtkEntryCompletion
///
/// gtk_entry_set_completion (entry, completion);
/// }
/// }
/// ```
///
///
/// </details>
///
/// # Implements
///
/// [`CellRendererExt`][trait@crate::prelude::CellRendererExt], [`trait@glib::ObjectExt`], [`CellRendererExtManual`][trait@crate::prelude::CellRendererExtManual]
#[doc(alias = "GtkCellRendererToggle")]
pub struct CellRendererToggle(Object<ffi::GtkCellRendererToggle>) @extends CellRenderer;
match fn {
type_ => || ffi::gtk_cell_renderer_toggle_get_type(),
}
}
impl CellRendererToggle {
/// Creates a new [`CellRendererToggle`][crate::CellRendererToggle]. Adjust rendering
/// parameters using object properties. Object properties can be set
/// globally (with g_object_set()). Also, with [`TreeViewColumn`][crate::TreeViewColumn], you
/// can bind a property to a value in a [`TreeModel`][crate::TreeModel]. For example, you
/// can bind the “active” property on the cell renderer to a boolean value
/// in the model, thus causing the check button to reflect the state of
/// the model.
///
/// # 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_toggle_new")]
pub fn new() -> CellRendererToggle {
assert_initialized_main_thread!();
unsafe { CellRenderer::from_glib_none(ffi::gtk_cell_renderer_toggle_new()).unsafe_cast() }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`CellRendererToggle`] objects.
///
/// This method returns an instance of [`CellRendererToggleBuilder`](crate::builders::CellRendererToggleBuilder) which can be used to create [`CellRendererToggle`] objects.
pub fn builder() -> CellRendererToggleBuilder {
CellRendererToggleBuilder::new()
}
/// Returns whether the cell renderer is activatable. See
/// gtk_cell_renderer_toggle_set_activatable().
///
/// # Deprecated since 4.10
///
///
/// # Returns
///
/// [`true`] if the cell renderer is activatable.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_cell_renderer_toggle_get_activatable")]
#[doc(alias = "get_activatable")]
pub fn is_activatable(&self) -> bool {
unsafe {
from_glib(ffi::gtk_cell_renderer_toggle_get_activatable(
self.to_glib_none().0,
))
}
}
/// Returns whether the cell renderer is active. See
/// gtk_cell_renderer_toggle_set_active().
///
/// # Deprecated since 4.10
///
///
/// # Returns
///
/// [`true`] if the cell renderer is active.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_cell_renderer_toggle_get_active")]
#[doc(alias = "get_active")]
pub fn is_active(&self) -> bool {
unsafe {
from_glib(ffi::gtk_cell_renderer_toggle_get_active(
self.to_glib_none().0,
))
}
}
/// Returns whether we’re rendering radio toggles rather than checkboxes.
///
/// # Deprecated since 4.10
///
///
/// # Returns
///
/// [`true`] if we’re rendering radio toggles rather than checkboxes
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_cell_renderer_toggle_get_radio")]
#[doc(alias = "get_radio")]
pub fn is_radio(&self) -> bool {
unsafe {
from_glib(ffi::gtk_cell_renderer_toggle_get_radio(
self.to_glib_none().0,
))
}
}
/// Makes the cell renderer activatable.
///
/// # Deprecated since 4.10
///
/// ## `setting`
/// the value to set.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_cell_renderer_toggle_set_activatable")]
pub fn set_activatable(&self, setting: bool) {
unsafe {
ffi::gtk_cell_renderer_toggle_set_activatable(
self.to_glib_none().0,
setting.into_glib(),
);
}
}
/// Activates or deactivates a cell renderer.
///
/// # Deprecated since 4.10
///
/// ## `setting`
/// the value to set.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_cell_renderer_toggle_set_active")]
pub fn set_active(&self, setting: bool) {
unsafe {
ffi::gtk_cell_renderer_toggle_set_active(self.to_glib_none().0, setting.into_glib());
}
}
/// If @radio is [`true`], the cell renderer renders a radio toggle
/// (i.e. a toggle in a group of mutually-exclusive toggles).
/// If [`false`], it renders a check toggle (a standalone boolean option).
/// This can be set globally for the cell renderer, or changed just
/// before rendering each cell in the model (for [`TreeView`][crate::TreeView], you set
/// up a per-row setting using [`TreeViewColumn`][crate::TreeViewColumn] to associate model
/// columns with cell renderer properties).
///
/// # Deprecated since 4.10
///
/// ## `radio`
/// [`true`] to make the toggle look like a radio button
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_cell_renderer_toggle_set_radio")]
pub fn set_radio(&self, radio: bool) {
unsafe {
ffi::gtk_cell_renderer_toggle_set_radio(self.to_glib_none().0, radio.into_glib());
}
}
pub fn is_inconsistent(&self) -> bool {
glib::ObjectExt::property(self, "inconsistent")
}
pub fn set_inconsistent(&self, inconsistent: bool) {
glib::ObjectExt::set_property(self, "inconsistent", inconsistent)
}
/// The ::toggled signal is emitted when the cell is toggled.
///
/// It is the responsibility of the application to update the model
/// with the correct value to store at @path. Often this is simply the
/// opposite of the value currently stored at @path.
/// ## `path`
/// string representation of [`TreePath`][crate::TreePath] describing the
/// event location
#[doc(alias = "toggled")]
pub fn connect_toggled<F: Fn(&Self, TreePath) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn toggled_trampoline<F: Fn(&CellRendererToggle, TreePath) + 'static>(
this: *mut ffi::GtkCellRendererToggle,
path: *mut libc::c_char,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
let path = from_glib_full(crate::ffi::gtk_tree_path_new_from_string(path));
f(&from_glib_borrow(this), path)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"toggled\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
toggled_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "activatable")]
pub fn connect_activatable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_activatable_trampoline<F: Fn(&CellRendererToggle) + 'static>(
this: *mut ffi::GtkCellRendererToggle,
_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::activatable\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_activatable_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "active")]
pub fn connect_active_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_active_trampoline<F: Fn(&CellRendererToggle) + 'static>(
this: *mut ffi::GtkCellRendererToggle,
_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::active\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_active_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "inconsistent")]
pub fn connect_inconsistent_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_inconsistent_trampoline<
F: Fn(&CellRendererToggle) + 'static,
>(
this: *mut ffi::GtkCellRendererToggle,
_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::inconsistent\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_inconsistent_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "radio")]
pub fn connect_radio_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_radio_trampoline<F: Fn(&CellRendererToggle) + 'static>(
this: *mut ffi::GtkCellRendererToggle,
_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::radio\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_radio_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for CellRendererToggle {
fn default() -> Self {
Self::new()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`CellRendererToggle`] 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 CellRendererToggleBuilder {
builder: glib::object::ObjectBuilder<'static, CellRendererToggle>,
}
impl CellRendererToggleBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
pub fn activatable(self, activatable: bool) -> Self {
Self {
builder: self.builder.property("activatable", activatable),
}
}
pub fn active(self, active: bool) -> Self {
Self {
builder: self.builder.property("active", active),
}
}
pub fn inconsistent(self, inconsistent: bool) -> Self {
Self {
builder: self.builder.property("inconsistent", inconsistent),
}
}
pub fn radio(self, radio: bool) -> Self {
Self {
builder: self.builder.property("radio", radio),
}
}
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),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`CellRendererToggle`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> CellRendererToggle {
self.builder.build()
}
}
impl fmt::Display for CellRendererToggle {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("CellRendererToggle")
}
}