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
// 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;
use glib::translate::*;
use std::fmt;
use std::mem;
glib::wrapper! {
/// A GtkPrintContext encapsulates context information that is required when
/// drawing pages for printing, such as the cairo context and important
/// parameters like page size and resolution. It also lets you easily
/// create [`pango::Layout`][crate::pango::Layout] and [`pango::Context`][crate::pango::Context] objects that match the font metrics
/// of the cairo surface.
///
/// GtkPrintContext objects gets passed to the `signal::PrintOperation::begin-print`,
/// `signal::PrintOperation::end-print`, `signal::PrintOperation::request-page-setup` and
/// `signal::PrintOperation::draw-page` signals on the [`PrintOperation`][crate::PrintOperation].
///
/// ## Using GtkPrintContext in a `signal::PrintOperation::draw-page` callback
///
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// static void
/// draw_page (GtkPrintOperation *operation,
/// GtkPrintContext *context,
/// int page_nr)
/// {
/// cairo_t *cr;
/// PangoLayout *layout;
/// PangoFontDescription *desc;
///
/// cr = gtk_print_context_get_cairo_context (context);
///
/// // Draw a red rectangle, as wide as the paper (inside the margins)
/// cairo_set_source_rgb (cr, 1.0, 0, 0);
/// cairo_rectangle (cr, 0, 0, gtk_print_context_get_width (context), 50);
///
/// cairo_fill (cr);
///
/// // Draw some lines
/// cairo_move_to (cr, 20, 10);
/// cairo_line_to (cr, 40, 20);
/// cairo_arc (cr, 60, 60, 20, 0, M_PI);
/// cairo_line_to (cr, 80, 20);
///
/// cairo_set_source_rgb (cr, 0, 0, 0);
/// cairo_set_line_width (cr, 5);
/// cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
/// cairo_set_line_join (cr, CAIRO_LINE_JOIN_ROUND);
///
/// cairo_stroke (cr);
///
/// // Draw some text
/// layout = gtk_print_context_create_pango_layout (context);
/// pango_layout_set_text (layout, "Hello World! Printing is easy", -1);
/// desc = pango_font_description_from_string ("sans 28");
/// pango_layout_set_font_description (layout, desc);
/// pango_font_description_free (desc);
///
/// cairo_move_to (cr, 30, 20);
/// pango_cairo_layout_path (cr, layout);
///
/// // Font Outline
/// cairo_set_source_rgb (cr, 0.93, 1.0, 0.47);
/// cairo_set_line_width (cr, 0.5);
/// cairo_stroke_preserve (cr);
///
/// // Font Fill
/// cairo_set_source_rgb (cr, 0, 0.0, 1.0);
/// cairo_fill (cr);
///
/// g_object_unref (layout);
/// }
/// ```
///
/// Printing support was added in GTK+ 2.10.
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GtkPrintContext")]
pub struct PrintContext(Object<ffi::GtkPrintContext>);
match fn {
type_ => || ffi::gtk_print_context_get_type(),
}
}
impl PrintContext {
/// Creates a new [`pango::Context`][crate::pango::Context] that can be used with the
/// [`PrintContext`][crate::PrintContext].
///
/// # Returns
///
/// a new Pango context for `self`
#[doc(alias = "gtk_print_context_create_pango_context")]
pub fn create_pango_context(&self) -> Option<pango::Context> {
unsafe {
from_glib_full(ffi::gtk_print_context_create_pango_context(
self.to_glib_none().0,
))
}
}
/// Creates a new [`pango::Layout`][crate::pango::Layout] that is suitable for use
/// with the [`PrintContext`][crate::PrintContext].
///
/// # Returns
///
/// a new Pango layout for `self`
#[doc(alias = "gtk_print_context_create_pango_layout")]
pub fn create_pango_layout(&self) -> Option<pango::Layout> {
unsafe {
from_glib_full(ffi::gtk_print_context_create_pango_layout(
self.to_glib_none().0,
))
}
}
/// Obtains the cairo context that is associated with the
/// [`PrintContext`][crate::PrintContext].
///
/// # Returns
///
/// the cairo context of `self`
#[doc(alias = "gtk_print_context_get_cairo_context")]
#[doc(alias = "get_cairo_context")]
pub fn cairo_context(&self) -> Option<cairo::Context> {
unsafe {
from_glib_none(ffi::gtk_print_context_get_cairo_context(
self.to_glib_none().0,
))
}
}
/// Obtains the horizontal resolution of the [`PrintContext`][crate::PrintContext],
/// in dots per inch.
///
/// # Returns
///
/// the horizontal resolution of `self`
#[doc(alias = "gtk_print_context_get_dpi_x")]
#[doc(alias = "get_dpi_x")]
pub fn dpi_x(&self) -> f64 {
unsafe { ffi::gtk_print_context_get_dpi_x(self.to_glib_none().0) }
}
/// Obtains the vertical resolution of the [`PrintContext`][crate::PrintContext],
/// in dots per inch.
///
/// # Returns
///
/// the vertical resolution of `self`
#[doc(alias = "gtk_print_context_get_dpi_y")]
#[doc(alias = "get_dpi_y")]
pub fn dpi_y(&self) -> f64 {
unsafe { ffi::gtk_print_context_get_dpi_y(self.to_glib_none().0) }
}
/// Obtains the hardware printer margins of the [`PrintContext`][crate::PrintContext], in units.
///
/// # Returns
///
/// [`true`] if the hard margins were retrieved
///
/// ## `top`
/// top hardware printer margin
///
/// ## `bottom`
/// bottom hardware printer margin
///
/// ## `left`
/// left hardware printer margin
///
/// ## `right`
/// right hardware printer margin
#[doc(alias = "gtk_print_context_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_print_context_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
}
}
}
/// Obtains the height of the [`PrintContext`][crate::PrintContext], in pixels.
///
/// # Returns
///
/// the height of `self`
#[doc(alias = "gtk_print_context_get_height")]
#[doc(alias = "get_height")]
pub fn height(&self) -> f64 {
unsafe { ffi::gtk_print_context_get_height(self.to_glib_none().0) }
}
/// Obtains the [`PageSetup`][crate::PageSetup] that determines the page
/// dimensions of the [`PrintContext`][crate::PrintContext].
///
/// # Returns
///
/// the page setup of `self`
#[doc(alias = "gtk_print_context_get_page_setup")]
#[doc(alias = "get_page_setup")]
pub fn page_setup(&self) -> Option<PageSetup> {
unsafe { from_glib_none(ffi::gtk_print_context_get_page_setup(self.to_glib_none().0)) }
}
/// Returns a [`pango::FontMap`][crate::pango::FontMap] that is suitable for use
/// with the [`PrintContext`][crate::PrintContext].
///
/// # Returns
///
/// the font map of `self`
#[doc(alias = "gtk_print_context_get_pango_fontmap")]
#[doc(alias = "get_pango_fontmap")]
pub fn pango_fontmap(&self) -> Option<pango::FontMap> {
unsafe {
from_glib_none(ffi::gtk_print_context_get_pango_fontmap(
self.to_glib_none().0,
))
}
}
/// Obtains the width of the [`PrintContext`][crate::PrintContext], in pixels.
///
/// # Returns
///
/// the width of `self`
#[doc(alias = "gtk_print_context_get_width")]
#[doc(alias = "get_width")]
pub fn width(&self) -> f64 {
unsafe { ffi::gtk_print_context_get_width(self.to_glib_none().0) }
}
/// Sets a new cairo context on a print context.
///
/// This function is intended to be used when implementing
/// an internal print preview, it is not needed for printing,
/// since GTK+ itself creates a suitable cairo context in that
/// case.
/// ## `cr`
/// the cairo context
/// ## `dpi_x`
/// the horizontal resolution to use with `cr`
/// ## `dpi_y`
/// the vertical resolution to use with `cr`
#[doc(alias = "gtk_print_context_set_cairo_context")]
pub fn set_cairo_context(&self, cr: &cairo::Context, dpi_x: f64, dpi_y: f64) {
unsafe {
ffi::gtk_print_context_set_cairo_context(
self.to_glib_none().0,
mut_override(cr.to_glib_none().0),
dpi_x,
dpi_y,
);
}
}
}
impl fmt::Display for PrintContext {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("PrintContext")
}
}