Synopsis

class gtk.gdk.PangoRenderer(pango.Renderer):
    pango.Renderer(screen=None)
    def set_drawable(drawable)
    def set_gc(gc)
    def set_stipple(part, stipple)
    def set_override_color(part, color)

Functions

    def gtk.gdk.gdk_pango_renderer_get_default(screen)

Ancestry

+-- gobject.GObject
  +-- pango.Renderer
    +-- gtkgdk.PangoRenderer

Properties

Description

Pango is the text layout system used by PyGTK (via GDK and GTK+). The functions and types in this section are used to render Pango objects to gtk.gdk.Drawable objects, and also extend the set of Pango attributes to include stippling and embossing.

Creating a pango.Layout object is the first step in rendering text, and requires getting a handle to a pango.Context. For PyGTK programs, you'll usually want to use the gtk.Widget.get_pango_context() method, or the create_pango_layout()) method, rather than using the lowlevel gtk.gdk.gdk_pango_context_get_for_screen() function. Once you have a pango.Layout, you can set the text and attributes of it with Pango methods like pango.Layout.set_text() and get its size using the get_size() method. (Note that Pango uses a fixed point system internally, so convert between Pango units and pixels using pango.SCALE or the pango.PIXELS() function.)

Rendering a Pango layout is done most simply with the draw_layout() method; you can also draw pieces of the layout with the draw_layout() method or the draw_glyphs() method.

gtk.gdk.PangoRenderer is a subclass of pango.Renderer that is used internally to implement these functions. Using it directly or subclassing it can be useful in some cases. The default renderer for a particular screen is obtained with the gtk.gdk.gdk_pango_renderer_get_default() function. Pango methods like pango.Renderer.draw_layout() and pango.Renderer.draw_layout_line() are then used to draw objects with the renderer.

In most simple cases, applications can just use the draw_layout() method, and don't need to directly use gtk.gdk.PangoRenderer at all. Using the gtk.gdk.PangoRenderer directly is most useful when working with a transformation such as a rotation, because the Pango drawing functions take user space coordinates (coordinates before the transformation) instead of device coordinates.

In certain cases it can be useful to subclass gtk.gdk.PangoRenderer. Examples of reasons to do this are to add handling of custom attributes by overriding 'prepare_run' or to do custom drawing of embedded objects by overriding 'draw_shape'.

Constructor

    gtk.gdk.PangoRenderer(screen)

Creates a new gtk.gdk.PangoRenderer object for the gtk.gdk.Screen specified by screen. Normally you can use the results of the gtk.gdk.gdk_pango_renderer_get_default() function rather than creating a new renderer.

Methods

    def set_drawable(drawable)

    def set_gc(gc)

    def set_stipple(part, stipple)

    def set_override_color(part, color)

Functions

    def gtk.gdk.gdk_pango_renderer_get_default(screen)