Package ch.bailu.gtk.pangocairo

Class Pangocairo

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Package
ch.bailu.gtk.pangocairo.Pangocairo
public class Pangocairo extends Package

https://docs.gtk.org/

  • Constructor Details

    • Pangocairo

      public Pangocairo()

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • contextGetFontOptions

      public static FontOptions contextGetFontOptions(@Nonnull Context context)
      Retrieves any font rendering options previously set with
      [func@PangoCairo.context_set_font_options].

      This function does not report options that are derived from
      the target surface by [func@update_context].
      Parameters:
      context - a `PangoContext`, from a pangocairo font map
      Returns:
      the font options previously set on the context, or %NULL if no options have been set. This value is owned by the context and must not be modified or freed.

    • contextGetResolution

      public static double contextGetResolution(@Nonnull Context context)
      Gets the resolution for the context.

      See [func@PangoCairo.context_set_resolution]
      Parameters:
      context - a `PangoContext`, from a pangocairo font map
      Returns:
      the resolution in "dots per inch". A negative value will be returned if no resolution has previously been set.

    • contextSetFontOptions

      public static void contextSetFontOptions(@Nonnull Context context, @Nullable FontOptions options)
      Sets the font options used when rendering text with this context.

      These options override any options that [func@update_context]
      derives from the target surface.
      Parameters:
      context - a `PangoContext`, from a pangocairo font map
      options - a `cairo_font_options_t`, or %NULL to unset any previously set options. A copy is made.

    • contextSetResolution

      public static void contextSetResolution(@Nonnull Context context, double dpi)
      Sets the resolution for the context.

      This is a scale factor between points specified in a `PangoFontDescription`
      and Cairo units. The default value is 96, meaning that a 10 point font will
      be 13 units high. (10 * 96. / 72. = 13.3).
      Parameters:
      context - a `PangoContext`, from a pangocairo font map
      dpi - the resolution in "dots per inch". (Physical inches aren't actually involved; the terminology is conventional.) A 0 or negative value means to use the resolution from the font map.

    • contextSetShapeRenderer

      public static void contextSetShapeRenderer(@Nonnull Context context, Pangocairo.OnShapeRendererFunc func, @Nullable Pointer data, Pangocairo.OnDestroyNotify dnotify)
      Sets callback function for context to use for rendering attributes
      of type %PANGO_ATTR_SHAPE.

      See `PangoCairoShapeRendererFunc` for details.
      Parameters:
      context - a `PangoContext`, from a pangocairo font map
      func - Callback function for rendering attributes of type %PANGO_ATTR_SHAPE, or %NULL to disable shape rendering.
      data - User data that will be passed to @func.
      dnotify - Callback that will be called when the context is freed to release @data

    • createContext

      public static Context createContext(@Nonnull Context cr)
      Creates a context object set up to match the current transformation
      and target surface of the Cairo context.

      This context can then be
      used to create a layout using [ctor@Pango.Layout.new].

      This function is a convenience function that creates a context using
      the default font map, then updates it to @cr. If you just need to
      create a layout for use with @cr and do not need to access `PangoContext`
      directly, you can use [func@create_layout] instead.
      Parameters:
      cr - a Cairo context
      Returns:
      the newly created `PangoContext`

    • createLayout

      public static Layout createLayout(@Nonnull Context cr)
      Creates a layout object set up to match the current transformation
      and target surface of the Cairo context.

      This layout can then be used for text measurement with functions
      like [method@Pango.Layout.get_size] or drawing with functions like
      [func@show_layout]. If you change the transformation or target
      surface for @cr, you need to call [func@update_layout].

      This function is the most convenient way to use Cairo with Pango,
      however it is slightly inefficient since it creates a separate
      `PangoContext` object for each layout. This might matter in an
      application that was laying out large amounts of text.
      Parameters:
      cr - a Cairo context
      Returns:
      the newly created `PangoLayout`

    • errorUnderlinePath

      public static void errorUnderlinePath(@Nonnull Context cr, double x, double y, double width, double height)
      Add a squiggly line to the current path in the specified cairo context that
      approximately covers the given rectangle in the style of an underline used
      to indicate a spelling error.

      The width of the underline is rounded to an integer number of up/down
      segments and the resulting rectangle is centered in the original rectangle.
      Parameters:
      cr - a Cairo context
      x - The X coordinate of one corner of the rectangle
      y - The Y coordinate of one corner of the rectangle
      width - Non-negative width of the rectangle
      height - Non-negative height of the rectangle

    • fontMapGetDefault

      public static FontMap fontMapGetDefault()
      Gets a default `PangoCairoFontMap` to use with Cairo.

      Note that the type of the returned object will depend on the
      particular font backend Cairo was compiled to use; you generally
      should only use the `PangoFontMap` and `PangoCairoFontMap`
      interfaces on the returned object.

      The default Cairo fontmap can be changed by using
      [method@PangoCairo.FontMap.set_default]. This can be used to
      change the Cairo font backend that the default fontmap uses
      for example.

      Note that since Pango 1.32.6, the default fontmap is per-thread.
      Each thread gets its own default fontmap. In this way, PangoCairo
      can be used safely from multiple threads.
      Returns:
      the default PangoCairo fontmap for the current thread. This object is owned by Pango and must not be freed.

    • fontMapNew

      public static FontMap fontMapNew()
      Creates a new `PangoCairoFontMap` object.

      A fontmap is used to cache information about available fonts,
      and holds certain global parameters such as the resolution.
      In most cases, you can use `func@PangoCairo.font_map_get_default]
      instead.

      Note that the type of the returned object will depend
      on the particular font backend Cairo was compiled to use;
      You generally should only use the `PangoFontMap` and
      `PangoCairoFontMap` interfaces on the returned object.

      You can override the type of backend returned by using an
      environment variable %PANGOCAIRO_BACKEND. Supported types,
      based on your build, are fc (fontconfig), win32, and coretext.
      If requested type is not available, NULL is returned. Ie.
      this is only useful for testing, when at least two backends
      are compiled in.
      Returns:
      the newly allocated `PangoFontMap`, which should be freed with g_object_unref().

    • fontMapNewForFontType

      public static FontMap fontMapNewForFontType(int fonttype)
      Creates a new `PangoCairoFontMap` object of the type suitable
      to be used with cairo font backend of type @fonttype.

      In most cases one should simply use [func@PangoCairo.FontMap.new], or
      in fact in most of those cases, just use [func@PangoCairo.FontMap.get_default].
      Parameters:
      fonttype - desired #cairo_font_type_t
      Returns:
      the newly allocated `PangoFontMap` of suitable type which should be freed with g_object_unref(), or %NULL if the requested cairo font backend is not supported / compiled in.

    • glyphStringPath

      public static void glyphStringPath(@Nonnull Context cr, @Nonnull Font font, @Nonnull GlyphString glyphs)
      Adds the glyphs in @glyphs to the current path in the specified
      cairo context.

      The origin of the glyphs (the left edge of the baseline)
      will be at the current point of the cairo context.
      Parameters:
      cr - a Cairo context
      font - a `PangoFont` from a `PangoCairoFontMap`
      glyphs - a `PangoGlyphString`

    • layoutLinePath

      public static void layoutLinePath(@Nonnull Context cr, @Nonnull LayoutLine line)
      Adds the text in `PangoLayoutLine` to the current path in the
      specified cairo context.

      The origin of the glyphs (the left edge of the line) will be
      at the current point of the cairo context.
      Parameters:
      cr - a Cairo context
      line - a `PangoLayoutLine`

    • layoutPath

      public static void layoutPath(@Nonnull Context cr, @Nonnull Layout layout)
      Adds the text in a `PangoLayout` to the current path in the
      specified cairo context.

      The top-left corner of the `PangoLayout` will be at the
      current point of the cairo context.
      Parameters:
      cr - a Cairo context
      layout - a Pango layout

    • showErrorUnderline

      public static void showErrorUnderline(@Nonnull Context cr, double x, double y, double width, double height)
      Draw a squiggly line in the specified cairo context that approximately
      covers the given rectangle in the style of an underline used to indicate a
      spelling error.

      The width of the underline is rounded to an integer
      number of up/down segments and the resulting rectangle is centered in the
      original rectangle.
      Parameters:
      cr - a Cairo context
      x - The X coordinate of one corner of the rectangle
      y - The Y coordinate of one corner of the rectangle
      width - Non-negative width of the rectangle
      height - Non-negative height of the rectangle

    • showGlyphItem

      public static void showGlyphItem(@Nonnull Context cr, @Nonnull Str text, @Nonnull GlyphItem glyph_item)
      Draws the glyphs in @glyph_item in the specified cairo context,

      embedding the text associated with the glyphs in the output if the
      output format supports it (PDF for example), otherwise it acts
      similar to [func@show_glyph_string].

      The origin of the glyphs (the left edge of the baseline) will
      be drawn at the current point of the cairo context.

      Note that @text is the start of the text for layout, which is then
      indexed by `glyph_item->item->offset`.
      Parameters:
      cr - a Cairo context
      text - the UTF-8 text that @glyph_item refers to
      glyph_item - a `PangoGlyphItem`

    • showGlyphString

      public static void showGlyphString(@Nonnull Context cr, @Nonnull Font font, @Nonnull GlyphString glyphs)
      Draws the glyphs in @glyphs in the specified cairo context.

      The origin of the glyphs (the left edge of the baseline) will
      be drawn at the current point of the cairo context.
      Parameters:
      cr - a Cairo context
      font - a `PangoFont` from a `PangoCairoFontMap`
      glyphs - a `PangoGlyphString`

    • showLayout

      public static void showLayout(@Nonnull Context cr, @Nonnull Layout layout)
      Draws a `PangoLayout` in the specified cairo context.

      The top-left corner of the `PangoLayout` will be drawn
      at the current point of the cairo context.
      Parameters:
      cr - a Cairo context
      layout - a Pango layout

    • showLayoutLine

      public static void showLayoutLine(@Nonnull Context cr, @Nonnull LayoutLine line)
      Draws a `PangoLayoutLine` in the specified cairo context.

      The origin of the glyphs (the left edge of the line) will
      be drawn at the current point of the cairo context.
      Parameters:
      cr - a Cairo context
      line - a `PangoLayoutLine`

    • updateContext

      public static void updateContext(@Nonnull Context cr, @Nonnull Context context)
      Updates a `PangoContext` previously created for use with Cairo to
      match the current transformation and target surface of a Cairo
      context.

      If any layouts have been created for the context, it's necessary
      to call [method@Pango.Layout.context_changed] on those layouts.
      Parameters:
      cr - a Cairo context
      context - a `PangoContext`, from a pangocairo font map

    • updateLayout

      public static void updateLayout(@Nonnull Context cr, @Nonnull Layout layout)
      Updates the private `PangoContext` of a `PangoLayout` created with
      [func@create_layout] to match the current transformation and target
      surface of a Cairo context.
      Parameters:
      cr - a Cairo context
      layout - a `PangoLayout`, from [func@create_layout]