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
// 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::{PageSetup, PaperSize, PrintCapabilities};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem, mem::transmute};
glib::wrapper! {
/// A [`Printer`][crate::Printer] object represents a printer.
///
/// You only need to deal directly with printers if you use the
/// non-portable [`PrintUnixDialog`][crate::PrintUnixDialog] API.
///
/// A [`Printer`][crate::Printer] allows to get status information about the printer,
/// such as its description, its location, the number of queued jobs,
/// etc. Most importantly, a [`Printer`][crate::Printer] object can be used to create
/// a [`PrintJob`][crate::PrintJob] object, which lets you print to the printer.
///
/// ## Properties
///
///
/// #### `accepting-jobs`
/// [`true`] if the printer is accepting jobs.
///
/// Readable
///
///
/// #### `accepts-pdf`
/// [`true`] if this printer can accept PDF.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `accepts-ps`
/// [`true`] if this printer can accept PostScript.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `icon-name`
/// Icon name to use for the printer.
///
/// Readable
///
///
/// #### `is-virtual`
/// [`false`] if this represents a real hardware device.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `job-count`
/// Number of jobs queued in the printer.
///
/// Readable
///
///
/// #### `location`
/// Information about the location of the printer.
///
/// Readable
///
///
/// #### `name`
/// The name of the printer.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `paused`
/// [`true`] if this printer is paused.
///
/// A paused printer still accepts jobs, but it does
/// not print them.
///
/// Readable
///
///
/// #### `state-message`
/// String giving the current status of the printer.
///
/// Readable
///
/// ## Signals
///
///
/// #### `details-acquired`
/// Emitted in response to a request for detailed information
/// about a printer from the print backend.
///
/// The @success parameter indicates if the information was
/// actually obtained.
///
///
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GtkPrinter")]
pub struct Printer(Object<ffi::GtkPrinter>);
match fn {
type_ => || ffi::gtk_printer_get_type(),
}
}
impl Printer {
/// Returns whether the printer accepts input in
/// PDF format.
///
/// # Returns
///
/// [`true`] if @self accepts PDF
#[doc(alias = "gtk_printer_accepts_pdf")]
pub fn accepts_pdf(&self) -> bool {
unsafe { from_glib(ffi::gtk_printer_accepts_pdf(self.to_glib_none().0)) }
}
/// Returns whether the printer accepts input in
/// PostScript format.
///
/// # Returns
///
/// [`true`] if @self accepts PostScript
#[doc(alias = "gtk_printer_accepts_ps")]
pub fn accepts_ps(&self) -> bool {
unsafe { from_glib(ffi::gtk_printer_accepts_ps(self.to_glib_none().0)) }
}
#[doc(alias = "gtk_printer_compare")]
pub fn compare(&self, b: &Printer) -> i32 {
unsafe { ffi::gtk_printer_compare(self.to_glib_none().0, b.to_glib_none().0) }
}
/// Returns the printer’s capabilities.
///
/// This is useful when you’re using [`PrintUnixDialog`][crate::PrintUnixDialog]’s
/// manual-capabilities setting and need to know which settings
/// the printer can handle and which you must handle yourself.
///
/// This will return 0 unless the printer’s details are
/// available, see [`has_details()`][Self::has_details()] and
/// [`request_details()`][Self::request_details()].
///
/// # Returns
///
/// the printer’s capabilities
#[doc(alias = "gtk_printer_get_capabilities")]
#[doc(alias = "get_capabilities")]
pub fn capabilities(&self) -> PrintCapabilities {
unsafe { from_glib(ffi::gtk_printer_get_capabilities(self.to_glib_none().0)) }
}
/// Returns default page size of @self.
///
/// # Returns
///
/// a newly allocated [`PageSetup`][crate::PageSetup] with default page size
/// of the printer.
#[doc(alias = "gtk_printer_get_default_page_size")]
#[doc(alias = "get_default_page_size")]
pub fn default_page_size(&self) -> PageSetup {
unsafe {
from_glib_full(ffi::gtk_printer_get_default_page_size(
self.to_glib_none().0,
))
}
}
/// Gets the description of the printer.
///
/// # Returns
///
/// the description of @self
#[doc(alias = "gtk_printer_get_description")]
#[doc(alias = "get_description")]
pub fn description(&self) -> glib::GString {
unsafe { from_glib_none(ffi::gtk_printer_get_description(self.to_glib_none().0)) }
}
/// Retrieve the hard margins of @self.
///
/// These are the margins that define the area at the borders
/// of the paper that the printer cannot print to.
///
/// Note: This will not succeed unless the printer’s details are
/// available, see [`has_details()`][Self::has_details()] and
/// [`request_details()`][Self::request_details()].
///
/// # Returns
///
/// [`true`] iff the hard margins were retrieved
///
/// ## `top`
/// a location to store the top margin in
///
/// ## `bottom`
/// a location to store the bottom margin in
///
/// ## `left`
/// a location to store the left margin in
///
/// ## `right`
/// a location to store the right margin in
#[doc(alias = "gtk_printer_get_hard_margins")]
#[doc(alias = "get_hard_margins")]
pub fn hard_margins(&self) -> Option<(f64, f64, f64, f64)> {
unsafe {
let mut top = mem::MaybeUninit::uninit();
let mut bottom = mem::MaybeUninit::uninit();
let mut left = mem::MaybeUninit::uninit();
let mut right = mem::MaybeUninit::uninit();
let ret = from_glib(ffi::gtk_printer_get_hard_margins(
self.to_glib_none().0,
top.as_mut_ptr(),
bottom.as_mut_ptr(),
left.as_mut_ptr(),
right.as_mut_ptr(),
));
if ret {
Some((
top.assume_init(),
bottom.assume_init(),
left.assume_init(),
right.assume_init(),
))
} else {
None
}
}
}
/// Retrieve the hard margins of @self for @paper_size.
///
/// These are the margins that define the area at the borders
/// of the paper that the printer cannot print to.
///
/// Note: This will not succeed unless the printer’s details are
/// available, see [`has_details()`][Self::has_details()] and
/// [`request_details()`][Self::request_details()].
/// ## `paper_size`
/// a [`PaperSize`][crate::PaperSize]
///
/// # Returns
///
/// [`true`] iff the hard margins were retrieved
///
/// ## `top`
/// a location to store the top margin in
///
/// ## `bottom`
/// a location to store the bottom margin in
///
/// ## `left`
/// a location to store the left margin in
///
/// ## `right`
/// a location to store the right margin in
#[doc(alias = "gtk_printer_get_hard_margins_for_paper_size")]
#[doc(alias = "get_hard_margins_for_paper_size")]
pub fn hard_margins_for_paper_size(
&self,
paper_size: &mut PaperSize,
) -> Option<(f64, f64, f64, f64)> {
unsafe {
let mut top = mem::MaybeUninit::uninit();
let mut bottom = mem::MaybeUninit::uninit();
let mut left = mem::MaybeUninit::uninit();
let mut right = mem::MaybeUninit::uninit();
let ret = from_glib(ffi::gtk_printer_get_hard_margins_for_paper_size(
self.to_glib_none().0,
paper_size.to_glib_none_mut().0,
top.as_mut_ptr(),
bottom.as_mut_ptr(),
left.as_mut_ptr(),
right.as_mut_ptr(),
));
if ret {
Some((
top.assume_init(),
bottom.assume_init(),
left.assume_init(),
right.assume_init(),
))
} else {
None
}
}
}
/// Gets the name of the icon to use for the printer.
///
/// # Returns
///
/// the icon name for @self
#[doc(alias = "gtk_printer_get_icon_name")]
#[doc(alias = "get_icon_name")]
pub fn icon_name(&self) -> glib::GString {
unsafe { from_glib_none(ffi::gtk_printer_get_icon_name(self.to_glib_none().0)) }
}
/// Gets the number of jobs currently queued on the printer.
///
/// # Returns
///
/// the number of jobs on @self
#[doc(alias = "gtk_printer_get_job_count")]
#[doc(alias = "get_job_count")]
pub fn job_count(&self) -> i32 {
unsafe { ffi::gtk_printer_get_job_count(self.to_glib_none().0) }
}
/// Returns a description of the location of the printer.
///
/// # Returns
///
/// the location of @self
#[doc(alias = "gtk_printer_get_location")]
#[doc(alias = "get_location")]
pub fn location(&self) -> glib::GString {
unsafe { from_glib_none(ffi::gtk_printer_get_location(self.to_glib_none().0)) }
}
/// Returns the name of the printer.
///
/// # Returns
///
/// the name of @self
#[doc(alias = "gtk_printer_get_name")]
#[doc(alias = "get_name")]
pub fn name(&self) -> glib::GString {
unsafe { from_glib_none(ffi::gtk_printer_get_name(self.to_glib_none().0)) }
}
/// Returns the state message describing the current state
/// of the printer.
///
/// # Returns
///
/// the state message of @self
#[doc(alias = "gtk_printer_get_state_message")]
#[doc(alias = "get_state_message")]
pub fn state_message(&self) -> glib::GString {
unsafe { from_glib_none(ffi::gtk_printer_get_state_message(self.to_glib_none().0)) }
}
/// Returns whether the printer details are available.
///
/// # Returns
///
/// [`true`] if @self details are available
#[doc(alias = "gtk_printer_has_details")]
pub fn has_details(&self) -> bool {
unsafe { from_glib(ffi::gtk_printer_has_details(self.to_glib_none().0)) }
}
/// Returns whether the printer is accepting jobs
///
/// # Returns
///
/// [`true`] if @self is accepting jobs
#[doc(alias = "gtk_printer_is_accepting_jobs")]
pub fn is_accepting_jobs(&self) -> bool {
unsafe { from_glib(ffi::gtk_printer_is_accepting_jobs(self.to_glib_none().0)) }
}
/// Returns whether the printer is currently active (i.e.
/// accepts new jobs).
///
/// # Returns
///
/// [`true`] if @self is active
#[doc(alias = "gtk_printer_is_active")]
pub fn is_active(&self) -> bool {
unsafe { from_glib(ffi::gtk_printer_is_active(self.to_glib_none().0)) }
}
/// Returns whether the printer is the default printer.
///
/// # Returns
///
/// [`true`] if @self is the default
#[doc(alias = "gtk_printer_is_default")]
pub fn is_default(&self) -> bool {
unsafe { from_glib(ffi::gtk_printer_is_default(self.to_glib_none().0)) }
}
/// Returns whether the printer is currently paused.
///
/// A paused printer still accepts jobs, but it is not
/// printing them.
///
/// # Returns
///
/// [`true`] if @self is paused
#[doc(alias = "gtk_printer_is_paused")]
pub fn is_paused(&self) -> bool {
unsafe { from_glib(ffi::gtk_printer_is_paused(self.to_glib_none().0)) }
}
/// Returns whether the printer is virtual (i.e. does not
/// represent actual printer hardware, but something like
/// a CUPS class).
///
/// # Returns
///
/// [`true`] if @self is virtual
#[doc(alias = "gtk_printer_is_virtual")]
pub fn is_virtual(&self) -> bool {
unsafe { from_glib(ffi::gtk_printer_is_virtual(self.to_glib_none().0)) }
}
/// Lists all the paper sizes @self supports.
///
/// This will return and empty list unless the printer’s details
/// are available, see [`has_details()`][Self::has_details()] and
/// [`request_details()`][Self::request_details()].
///
/// # Returns
///
/// a newly
/// allocated list of newly allocated [`PageSetup`][crate::PageSetup]s.
#[doc(alias = "gtk_printer_list_papers")]
pub fn list_papers(&self) -> Vec<PageSetup> {
unsafe {
FromGlibPtrContainer::from_glib_full(ffi::gtk_printer_list_papers(
self.to_glib_none().0,
))
}
}
/// Requests the printer details.
///
/// When the details are available, the
/// [`details-acquired`][struct@crate::Printer#details-acquired] signal
/// will be emitted on @self.
#[doc(alias = "gtk_printer_request_details")]
pub fn request_details(&self) {
unsafe {
ffi::gtk_printer_request_details(self.to_glib_none().0);
}
}
/// Emitted in response to a request for detailed information
/// about a printer from the print backend.
///
/// The @success parameter indicates if the information was
/// actually obtained.
/// ## `success`
/// [`true`] if the details were successfully acquired
#[doc(alias = "details-acquired")]
pub fn connect_details_acquired<F: Fn(&Self, bool) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn details_acquired_trampoline<F: Fn(&Printer, bool) + 'static>(
this: *mut ffi::GtkPrinter,
success: glib::ffi::gboolean,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this), from_glib(success))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"details-acquired\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
details_acquired_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "accepting-jobs")]
pub fn connect_accepting_jobs_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_accepting_jobs_trampoline<F: Fn(&Printer) + 'static>(
this: *mut ffi::GtkPrinter,
_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::accepting-jobs\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_accepting_jobs_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(&Printer) + 'static>(
this: *mut ffi::GtkPrinter,
_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(transmute::<_, unsafe extern "C" fn()>(
notify_icon_name_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "job-count")]
pub fn connect_job_count_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_job_count_trampoline<F: Fn(&Printer) + 'static>(
this: *mut ffi::GtkPrinter,
_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::job-count\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_job_count_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "location")]
pub fn connect_location_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_location_trampoline<F: Fn(&Printer) + 'static>(
this: *mut ffi::GtkPrinter,
_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::location\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_location_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "paused")]
pub fn connect_paused_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_paused_trampoline<F: Fn(&Printer) + 'static>(
this: *mut ffi::GtkPrinter,
_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::paused\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_paused_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "state-message")]
pub fn connect_state_message_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_state_message_trampoline<F: Fn(&Printer) + 'static>(
this: *mut ffi::GtkPrinter,
_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::state-message\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_state_message_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for Printer {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str(&self.name())
}
}