libadwaita/auto/view_stack_page.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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
use crate::ffi;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// An auxiliary class used by [`ViewStack`][crate::ViewStack].
///
/// ## Properties
///
///
/// #### `badge-number`
/// The badge number for this page.
///
/// [`ViewSwitcher`][crate::ViewSwitcher] can display it as a badge next to the page icon. It is
/// commonly used to display a number of unread items within the page.
///
/// It can be used together with [property@ViewStack{age}:needs-attention].
///
/// Readable | Writeable
///
///
/// #### `child`
/// The stack child to which the page belongs.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `icon-name`
/// The icon name of the child page.
///
/// Readable | Writeable
///
///
/// #### `name`
/// The name of the child page.
///
/// Readable | Writeable
///
///
/// #### `needs-attention`
/// Whether the page requires the user attention.
///
/// [`ViewSwitcher`][crate::ViewSwitcher] will display it as a dot next to the page icon.
///
/// Readable | Writeable
///
///
/// #### `title`
/// The title of the child page.
///
/// Readable | Writeable
///
///
/// #### `use-underline`
/// Whether an embedded underline in the title indicates a mnemonic.
///
/// Readable | Writeable
///
///
/// #### `visible`
/// Whether this page is visible.
///
/// This is independent from the [`visible`][struct@crate::gtk::Widget#visible] property of
/// [`child`][struct@crate::ViewStackPage#child].
///
/// Readable | Writeable
/// <details><summary><h4>Accessible</h4></summary>
///
///
/// #### `accessible-role`
/// The accessible role of the given [`gtk::Accessible`][crate::gtk::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
///
/// Readable | Writeable
/// </details>
///
/// # Implements
///
/// [`trait@glib::ObjectExt`], [`trait@gtk::prelude::AccessibleExt`]
#[doc(alias = "AdwViewStackPage")]
pub struct ViewStackPage(Object<ffi::AdwViewStackPage, ffi::AdwViewStackPageClass>) @implements gtk::Accessible;
match fn {
type_ => || ffi::adw_view_stack_page_get_type(),
}
}
impl ViewStackPage {
/// Gets the badge number for this page.
///
/// # Returns
///
/// the badge number for this page
#[doc(alias = "adw_view_stack_page_get_badge_number")]
#[doc(alias = "get_badge_number")]
#[doc(alias = "badge-number")]
pub fn badge_number(&self) -> u32 {
unsafe { ffi::adw_view_stack_page_get_badge_number(self.to_glib_none().0) }
}
/// Gets the stack child to which @self belongs.
///
/// # Returns
///
/// the child to which @self belongs
#[doc(alias = "adw_view_stack_page_get_child")]
#[doc(alias = "get_child")]
pub fn child(&self) -> gtk::Widget {
unsafe { from_glib_none(ffi::adw_view_stack_page_get_child(self.to_glib_none().0)) }
}
/// Gets the icon name of the page.
///
/// # Returns
///
/// the icon name of the page
#[doc(alias = "adw_view_stack_page_get_icon_name")]
#[doc(alias = "get_icon_name")]
#[doc(alias = "icon-name")]
pub fn icon_name(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::adw_view_stack_page_get_icon_name(
self.to_glib_none().0,
))
}
}
/// Gets the name of the page.
///
/// # Returns
///
/// the name of the page
#[doc(alias = "adw_view_stack_page_get_name")]
#[doc(alias = "get_name")]
pub fn name(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::adw_view_stack_page_get_name(self.to_glib_none().0)) }
}
/// Gets whether the page requires the user attention.
///
/// # Returns
///
/// whether the page needs attention
#[doc(alias = "adw_view_stack_page_get_needs_attention")]
#[doc(alias = "get_needs_attention")]
#[doc(alias = "needs-attention")]
pub fn needs_attention(&self) -> bool {
unsafe {
from_glib(ffi::adw_view_stack_page_get_needs_attention(
self.to_glib_none().0,
))
}
}
/// Gets the page title.
///
/// # Returns
///
/// the page title
#[doc(alias = "adw_view_stack_page_get_title")]
#[doc(alias = "get_title")]
pub fn title(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::adw_view_stack_page_get_title(self.to_glib_none().0)) }
}
/// Gets whether underlines in the page title indicate mnemonics.
///
/// # Returns
///
/// whether underlines in the page title indicate mnemonics
#[doc(alias = "adw_view_stack_page_get_use_underline")]
#[doc(alias = "get_use_underline")]
#[doc(alias = "use-underline")]
pub fn uses_underline(&self) -> bool {
unsafe {
from_glib(ffi::adw_view_stack_page_get_use_underline(
self.to_glib_none().0,
))
}
}
/// Gets whether @self is visible in its [`ViewStack`][crate::ViewStack].
///
/// This is independent from the [`visible`][struct@crate::gtk::Widget#visible]
/// property of its widget.
///
/// # Returns
///
/// whether @self is visible
#[doc(alias = "adw_view_stack_page_get_visible")]
#[doc(alias = "get_visible")]
#[doc(alias = "visible")]
pub fn is_visible(&self) -> bool {
unsafe { from_glib(ffi::adw_view_stack_page_get_visible(self.to_glib_none().0)) }
}
/// Sets the badge number for this page.
///
/// [`ViewSwitcher`][crate::ViewSwitcher] can display it as a badge next to the page icon. It is
/// commonly used to display a number of unread items within the page.
///
/// It can be used together with [property@ViewStack{age}:needs-attention].
/// ## `badge_number`
/// the new value to set
#[doc(alias = "adw_view_stack_page_set_badge_number")]
#[doc(alias = "badge-number")]
pub fn set_badge_number(&self, badge_number: u32) {
unsafe {
ffi::adw_view_stack_page_set_badge_number(self.to_glib_none().0, badge_number);
}
}
/// Sets the icon name of the page.
/// ## `icon_name`
/// the icon name
#[doc(alias = "adw_view_stack_page_set_icon_name")]
#[doc(alias = "icon-name")]
pub fn set_icon_name(&self, icon_name: Option<&str>) {
unsafe {
ffi::adw_view_stack_page_set_icon_name(
self.to_glib_none().0,
icon_name.to_glib_none().0,
);
}
}
/// Sets the name of the page.
/// ## `name`
/// the page name
#[doc(alias = "adw_view_stack_page_set_name")]
#[doc(alias = "name")]
pub fn set_name(&self, name: Option<&str>) {
unsafe {
ffi::adw_view_stack_page_set_name(self.to_glib_none().0, name.to_glib_none().0);
}
}
/// Sets whether the page requires the user attention.
///
/// [`ViewSwitcher`][crate::ViewSwitcher] will display it as a dot next to the page icon.
/// ## `needs_attention`
/// the new value to set
#[doc(alias = "adw_view_stack_page_set_needs_attention")]
#[doc(alias = "needs-attention")]
pub fn set_needs_attention(&self, needs_attention: bool) {
unsafe {
ffi::adw_view_stack_page_set_needs_attention(
self.to_glib_none().0,
needs_attention.into_glib(),
);
}
}
/// Sets the page title.
/// ## `title`
/// the page title
#[doc(alias = "adw_view_stack_page_set_title")]
#[doc(alias = "title")]
pub fn set_title(&self, title: Option<&str>) {
unsafe {
ffi::adw_view_stack_page_set_title(self.to_glib_none().0, title.to_glib_none().0);
}
}
/// Sets whether underlines in the page title indicate mnemonics.
/// ## `use_underline`
/// the new value to set
#[doc(alias = "adw_view_stack_page_set_use_underline")]
#[doc(alias = "use-underline")]
pub fn set_use_underline(&self, use_underline: bool) {
unsafe {
ffi::adw_view_stack_page_set_use_underline(
self.to_glib_none().0,
use_underline.into_glib(),
);
}
}
/// Sets whether @page is visible in its [`ViewStack`][crate::ViewStack].
///
/// This is independent from the [`visible`][struct@crate::gtk::Widget#visible] property of
/// [`child`][struct@crate::ViewStackPage#child].
/// ## `visible`
/// whether @self is visible
#[doc(alias = "adw_view_stack_page_set_visible")]
#[doc(alias = "visible")]
pub fn set_visible(&self, visible: bool) {
unsafe {
ffi::adw_view_stack_page_set_visible(self.to_glib_none().0, visible.into_glib());
}
}
#[doc(alias = "badge-number")]
pub fn connect_badge_number_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_badge_number_trampoline<F: Fn(&ViewStackPage) + 'static>(
this: *mut ffi::AdwViewStackPage,
_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::badge-number\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_badge_number_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "icon-name")]
pub fn connect_icon_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_icon_name_trampoline<F: Fn(&ViewStackPage) + 'static>(
this: *mut ffi::AdwViewStackPage,
_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::icon-name\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_icon_name_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "name")]
pub fn connect_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_name_trampoline<F: Fn(&ViewStackPage) + 'static>(
this: *mut ffi::AdwViewStackPage,
_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::name\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_name_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "needs-attention")]
pub fn connect_needs_attention_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_needs_attention_trampoline<F: Fn(&ViewStackPage) + 'static>(
this: *mut ffi::AdwViewStackPage,
_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::needs-attention\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_needs_attention_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(&ViewStackPage) + 'static>(
this: *mut ffi::AdwViewStackPage,
_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(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_title_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "use-underline")]
pub fn connect_use_underline_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_use_underline_trampoline<F: Fn(&ViewStackPage) + 'static>(
this: *mut ffi::AdwViewStackPage,
_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::use-underline\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_use_underline_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(&ViewStackPage) + 'static>(
this: *mut ffi::AdwViewStackPage,
_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(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_visible_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}