Package ch.bailu.gtk.gtk
Class PrintContext
java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gtk.PrintContext
- All Implemented Interfaces:
PointerInterface
A `GtkPrintContext` encapsulates context information that is required when
drawing pages for printing.
This includes the cairo context and important parameters like page size
and resolution. It also lets you easily create [class@Pango.Layout] and
[class@Pango.Context] objects that match the font metrics of the cairo surface.
`GtkPrintContext` objects get passed to the
[signal@Gtk.PrintOperation::begin-print],
[signal@Gtk.PrintOperation::end-print],
[signal@Gtk.PrintOperation::request-page-setup] and
[signal@Gtk.PrintOperation::draw-page] signals on the
[class@Gtk.PrintOperation] object.
## Using GtkPrintContext in a ::draw-page callback
```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);
}
```
drawing pages for printing.
This includes the cairo context and important parameters like page size
and resolution. It also lets you easily create [class@Pango.Layout] and
[class@Pango.Context] objects that match the font metrics of the cairo surface.
`GtkPrintContext` objects get passed to the
[signal@Gtk.PrintOperation::begin-print],
[signal@Gtk.PrintOperation::end-print],
[signal@Gtk.PrintOperation::request-page-setup] and
[signal@Gtk.PrintOperation::draw-page] signals on the
[class@Gtk.PrintOperation] object.
## Using GtkPrintContext in a ::draw-page callback
```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);
}
```
-
Nested Class Summary
Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object
Object.OnBindingTransformFunc, Object.OnDestroyNotify, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify
-
Field Summary
Fields inherited from class ch.bailu.gtk.gobject.Object
SIGNAL_ON_NOTIFY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionCreates a new `PangoContext` that can be used with the
`GtkPrintContext`.Creates a new `PangoLayout` that is suitable for use
with the `GtkPrintContext`.Obtains the cairo context that is associated with the
`GtkPrintContext`.static ClassHandler
double
getDpiX()
Obtains the horizontal resolution of the `GtkPrintContext`,
in dots per inch.double
getDpiY()
Obtains the vertical resolution of the `GtkPrintContext`,
in dots per inch.double
Obtains the height of the `GtkPrintContext`, in pixels.static int
Obtains the `GtkPageSetup` that determines the page
dimensions of the `GtkPrintContext`.Returns a `PangoFontMap` that is suitable for use
with the `GtkPrintContext`.static long
static TypeSystem.TypeSize
static long
static TypeSystem.TypeSize
double
getWidth()
Obtains the width of the `GtkPrintContext`, in pixels.void
setCairoContext
(Context cr, double dpi_x, double dpi_y) Sets a new cairo context on a print context.Methods inherited from class ch.bailu.gtk.gobject.Object
addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref
Methods inherited from class ch.bailu.gtk.type.Pointer
asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks
Methods inherited from class ch.bailu.gtk.type.Type
asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ch.bailu.gtk.type.PointerInterface
asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull
-
Constructor Details
-
PrintContext
-
-
Method Details
-
getClassHandler
-
createPangoContext
Creates a new `PangoContext` that can be used with the
`GtkPrintContext`.- Returns:
- a new Pango context for @context
-
createPangoLayout
Creates a new `PangoLayout` that is suitable for use
with the `GtkPrintContext`.- Returns:
- a new Pango layout for @context
-
getCairoContext
Obtains the cairo context that is associated with the
`GtkPrintContext`.- Returns:
- the cairo context of @context
-
getDpiX
public double getDpiX()Obtains the horizontal resolution of the `GtkPrintContext`,
in dots per inch.- Returns:
- the horizontal resolution of @context
-
getDpiY
public double getDpiY()Obtains the vertical resolution of the `GtkPrintContext`,
in dots per inch.- Returns:
- the vertical resolution of @context
-
getHeight
public double getHeight()Obtains the height of the `GtkPrintContext`, in pixels.- Returns:
- the height of @context
-
getPageSetup
Obtains the `GtkPageSetup` that determines the page
dimensions of the `GtkPrintContext`.- Returns:
- the page setup of @context
-
getPangoFontmap
Returns a `PangoFontMap` that is suitable for use
with the `GtkPrintContext`.- Returns:
- the font map of @context
-
getWidth
public double getWidth()Obtains the width of the `GtkPrintContext`, in pixels.- Returns:
- the width of @context
-
setCairoContext
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.- Parameters:
cr
- the cairo contextdpi_x
- the horizontal resolution to use with @crdpi_y
- the vertical resolution to use with @cr
-
getTypeID
public static long getTypeID() -
getParentTypeID
public static long getParentTypeID() -
getTypeSize
-
getParentTypeSize
-
getInstanceSize
public static int getInstanceSize()
-