Gjsify LogoGjsify Logo

Index

Functions

  • Retrieves any font rendering options previously set with [funcPangoCairo.context_set_font_options].

    This function does not report options that are derived from the target surface by [funcupdate_context].

    Parameters

    • context: Pango.Context

      a PangoContext, from a pangocairo font map

    Returns FontOptions | null

  • Gets the resolution for the context.

    See [funcPangoCairo.context_set_resolution]

    Parameters

    • context: Pango.Context

      a PangoContext, from a pangocairo font map

    Returns number

  • Sets the font options used when rendering text with this context.

    These options override any options that [funcupdate_context] derives from the target surface.

    Parameters

    • context: Pango.Context

      a PangoContext, from a pangocairo font map

    • options: FontOptions

      a cairo_font_options_t, or %NULL to unset any previously set options. A copy is made.

    Returns void

  • contextSetResolution(context: Pango.Context, dpi: number): void
  • 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: Pango.Context

      a PangoContext, from a pangocairo font map

    • dpi: number

      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.

    Returns void

  • Sets callback function for context to use for rendering attributes of type %PANGO_ATTR_SHAPE.

    See PangoCairoShapeRendererFunc for details.

    Parameters

    • context: Pango.Context

      a PangoContext, from a pangocairo font map

    • func: ShapeRendererFunc

      Callback function for rendering attributes of type %PANGO_ATTR_SHAPE, or %NULL to disable shape rendering.

    Returns void

  • 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 [ctorPango.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 [funccreate_layout] instead.

    Parameters

    Returns Pango.Context

  • 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 [methodPango.Layout.get_size] or drawing with functions like [funcshow_layout]. If you change the transformation or target surface for cr, you need to call [funcupdate_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

    Returns Pango.Layout

  • errorUnderlinePath(cr: cairo.Context, x: number, y: number, width: number, height: number): void
  • 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: cairo.Context

      a Cairo context

    • x: number

      The X coordinate of one corner of the rectangle

    • y: number

      The Y coordinate of one corner of the rectangle

    • width: number

      Non-negative width of the rectangle

    • height: number

      Non-negative height of the rectangle

    Returns void

  • 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 [methodPangoCairo.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 Pango.FontMap

  • 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 funcPangoCairo`.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 Pango.FontMap

  • 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 [funcPangoCairo.FontMap.new], or in fact in most of those cases, just use [funcPangoCairo.FontMap.get_default].

    Parameters

    Returns Pango.FontMap | null

  • 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

    Returns void

  • 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

    Returns void

  • 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

    Returns void

  • showErrorUnderline(cr: cairo.Context, x: number, y: number, width: number, height: number): void
  • 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: cairo.Context

      a Cairo context

    • x: number

      The X coordinate of one corner of the rectangle

    • y: number

      The Y coordinate of one corner of the rectangle

    • width: number

      Non-negative width of the rectangle

    • height: number

      Non-negative height of the rectangle

    Returns void

  • 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 [funcshow_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: cairo.Context

      a Cairo context

    • text: string

      the UTF-8 text that glyph_item refers to

    • glyphItem: GlyphItem

      a PangoGlyphItem

    Returns void

  • 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

    Returns void

  • 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

    Returns void

  • 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

    Returns void

  • 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 [methodPango.Layout.context_changed] on those layouts.

    Parameters

    Returns void

  • Updates the private PangoContext of a PangoLayout created with [funccreate_layout] to match the current transformation and target surface of a Cairo context.

    Parameters

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method