AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-12-26 13:41:07 +00:00
Code Issues Projects Releases Wiki Activity

printcontext: Convert docs

Browse Source
This commit is contained in:
Matthias Clasen 2021-02-27 10:54:10 -05:00 committed by Emmanuele Bassi
parent 60b3effce3
commit 5225a0f253
1 changed files with 52 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
gtk/gtkprintcontext.c
View File

@ -21,27 +21,29 @@
/** /**
* SECTION:gtkprintcontext * GtkPrintContext:
* @Short_description: Encapsulates context for drawing pages
* @Title: GtkPrintContext
* *
* A GtkPrintContext encapsulates context information that is required when * A `GtkPrintContext` encapsulates context information that is required when
* drawing pages for printing, such as the cairo context and important * drawing pages for printing.
* parameters like page size and resolution. It also lets you easily
* create #PangoLayout and #PangoContext objects that match the font metrics
* of the cairo surface.
* *
* GtkPrintContext objects gets passed to the #GtkPrintOperation::begin-print, * This includes the cairo context and important parameters like page size
* #GtkPrintOperation::end-print, #GtkPrintOperation::request-page-setup and * and resolution. It also lets you easily create [class@Pango.Layout] and
* #GtkPrintOperation::draw-page signals on the #GtkPrintOperation. * [class@Pango.Context] objects that match the font metrics of the cairo surface.
* *
* ## Using GtkPrintContext in a #GtkPrintOperation::draw-page callback * `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.
* *
* |[<!-- language="C" --> * ## Using GtkPrintContext in a ::draw-page callback
*
* ```c
* static void * static void
* draw_page (GtkPrintOperation *operation, * draw_page (GtkPrintOperation *operation,
* GtkPrintContext *context, * GtkPrintContext *context,
* int page_nr) * int page_nr)
* { * {
* cairo_t *cr; * cairo_t *cr;
* PangoLayout *layout; * PangoLayout *layout;
@ -89,7 +91,7 @@
* *
* g_object_unref (layout); * g_object_unref (layout);
* } * }
* ]| * ```
*/ */
@ -181,13 +183,13 @@ _gtk_print_context_get_fontmap (GtkPrintContext *context)
/** /**
* gtk_print_context_set_cairo_context: * gtk_print_context_set_cairo_context:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* @cr: the cairo context * @cr: the cairo context
* @dpi_x: the horizontal resolution to use with @cr * @dpi_x: the horizontal resolution to use with @cr
* @dpi_y: the vertical resolution to use with @cr * @dpi_y: the vertical resolution to use with @cr
* *
* Sets a new cairo context on a print context. * Sets a new cairo context on a print context.
* *
* This function is intended to be used when implementing * This function is intended to be used when implementing
* an internal print preview, it is not needed for printing, * an internal print preview, it is not needed for printing,
* since GTK itself creates a suitable cairo context in that * since GTK itself creates a suitable cairo context in that
@ -363,10 +365,10 @@ _gtk_print_context_set_page_setup (GtkPrintContext *context,
/** /**
* gtk_print_context_get_cairo_context: * gtk_print_context_get_cairo_context:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* *
* Obtains the cairo context that is associated with the * Obtains the cairo context that is associated with the
* #GtkPrintContext. * `GtkPrintContext`.
* *
* Returns: (transfer none): the cairo context of @context * Returns: (transfer none): the cairo context of @context
*/ */
@ -380,10 +382,10 @@ gtk_print_context_get_cairo_context (GtkPrintContext *context)
/** /**
* gtk_print_context_get_page_setup: * gtk_print_context_get_page_setup:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* *
* Obtains the #GtkPageSetup that determines the page * Obtains the `GtkPageSetup` that determines the page
* dimensions of the #GtkPrintContext. * dimensions of the `GtkPrintContext`.
* *
* Returns: (transfer none): the page setup of @context * Returns: (transfer none): the page setup of @context
*/ */
@ -397,9 +399,9 @@ gtk_print_context_get_page_setup (GtkPrintContext *context)
/** /**
* gtk_print_context_get_width: * gtk_print_context_get_width:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* *
* Obtains the width of the #GtkPrintContext, in pixels. * Obtains the width of the `GtkPrintContext`, in pixels.
* *
* Returns: the width of @context * Returns: the width of @context
*/ */
@ -424,9 +426,9 @@ gtk_print_context_get_width (GtkPrintContext *context)
/** /**
* gtk_print_context_get_height: * gtk_print_context_get_height:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* *
* Obtains the height of the #GtkPrintContext, in pixels. * Obtains the height of the `GtkPrintContext`, in pixels.
* *
* Returns: the height of @context * Returns: the height of @context
*/ */
@ -451,9 +453,9 @@ gtk_print_context_get_height (GtkPrintContext *context)
/** /**
* gtk_print_context_get_dpi_x: * gtk_print_context_get_dpi_x:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* *
* Obtains the horizontal resolution of the #GtkPrintContext, * Obtains the horizontal resolution of the `GtkPrintContext`,
* in dots per inch. * in dots per inch.
* *
* Returns: the horizontal resolution of @context * Returns: the horizontal resolution of @context
@ -468,9 +470,9 @@ gtk_print_context_get_dpi_x (GtkPrintContext *context)
/** /**
* gtk_print_context_get_dpi_y: * gtk_print_context_get_dpi_y:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* *
* Obtains the vertical resolution of the #GtkPrintContext, * Obtains the vertical resolution of the `GtkPrintContext`,
* in dots per inch. * in dots per inch.
* *
* Returns: the vertical resolution of @context * Returns: the vertical resolution of @context
@ -485,13 +487,14 @@ gtk_print_context_get_dpi_y (GtkPrintContext *context)
/** /**
* gtk_print_context_get_hard_margins: * gtk_print_context_get_hard_margins:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* @top: (out): top hardware printer margin * @top: (out): top hardware printer margin
* @bottom: (out): bottom hardware printer margin * @bottom: (out): bottom hardware printer margin
* @left: (out): left hardware printer margin * @left: (out): left hardware printer margin
* @right: (out): right hardware printer margin * @right: (out): right hardware printer margin
* *
* Obtains the hardware printer margins of the #GtkPrintContext, in units. * Obtains the hardware printer margins of the `GtkPrintContext`,
* in units.
* *
* Returns: %TRUE if the hard margins were retrieved * Returns: %TRUE if the hard margins were retrieved
*/ */
@ -515,13 +518,13 @@ gtk_print_context_get_hard_margins (GtkPrintContext *context,
/** /**
* gtk_print_context_set_hard_margins: * gtk_print_context_set_hard_margins:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* @top: top hardware printer margin * @top: top hardware printer margin
* @bottom: bottom hardware printer margin * @bottom: bottom hardware printer margin
* @left: left hardware printer margin * @left: left hardware printer margin
* @right: right hardware printer margin * @right: right hardware printer margin
* *
* set the hard margins in pixel coordinates * Sets the hard margins in pixels.
*/ */
void void
_gtk_print_context_set_hard_margins (GtkPrintContext *context, _gtk_print_context_set_hard_margins (GtkPrintContext *context,
@ -539,10 +542,10 @@ _gtk_print_context_set_hard_margins (GtkPrintContext *context,
/** /**
* gtk_print_context_get_pango_fontmap: * gtk_print_context_get_pango_fontmap:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* *
* Returns a #PangoFontMap that is suitable for use * Returns a `PangoFontMap` that is suitable for use
* with the #GtkPrintContext. * with the `GtkPrintContext`.
* *
* Returns: (transfer none): the font map of @context * Returns: (transfer none): the font map of @context
*/ */
@ -556,10 +559,10 @@ gtk_print_context_get_pango_fontmap (GtkPrintContext *context)
/** /**
* gtk_print_context_create_pango_context: * gtk_print_context_create_pango_context:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
* *
* Creates a new #PangoContext that can be used with the * Creates a new `PangoContext` that can be used with the
* #GtkPrintContext. * `GtkPrintContext`.
* *
* Returns: (transfer full): a new Pango context for @context * Returns: (transfer full): a new Pango context for @context
*/ */
@ -588,11 +591,11 @@ gtk_print_context_create_pango_context (GtkPrintContext *context)
/** /**
* gtk_print_context_create_pango_layout: * gtk_print_context_create_pango_layout:
* @context: a #GtkPrintContext * @context: a `GtkPrintContext`
*
* Creates a new `PangoLayout` that is suitable for use
* with the `GtkPrintContext`.
* *
* Creates a new #PangoLayout that is suitable for use
* with the #GtkPrintContext.
*
* Returns: (transfer full): a new Pango layout for @context * Returns: (transfer full): a new Pango layout for @context
*/ */
PangoLayout * PangoLayout *