Functions

Properties

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkTextView
                    ╰── GtkSourceView
                        ╰── GtkSourceMap

Implemented Interfaces

GtkSourceMap implements AtkImplementorIface, GtkBuildable and GtkScrollable.

Includes

#include <gtksourceview/gtksource.h>

Description

GtkSourceMap is a widget that maps the content of a GtkSourceView into a smaller view so the user can have a quick overview of the whole document.

This works by connecting a GtkSourceView to to the GtkSourceMap using the “view” property or gtk_source_map_set_view().

GtkSourceMap is a GtkSourceView object. This means that you can add a GtkSourceGutterRenderer to a gutter in the same way you would for a GtkSourceView. One example might be a GtkSourceGutterRenderer that shows which lines have changed in the document.

Additionally, it is desirable to match the font of the GtkSourceMap and the GtkSourceView used for editing. Therefore, “font-desc” should be used to set the target font. You will need to adjust this to the desired font size for the map. A 1pt font generally seems to be an appropriate font size. "Monospace 1" is the default. See pango_font_description_set_size() for how to alter the size of an existing PangoFontDescription.

Functions

GtkWidget *
gtk_source_map_new (void);

void
gtk_source_map_set_view (GtkSourceMap *map,
                         GtkSourceView *view);

GtkSourceView *
gtk_source_map_get_view (GtkSourceMap *map);

Types and Values

typedef struct _GtkSourceMap GtkSourceMap;

Property Details

  “font-desc”                PangoFontDescription *

  “view”                     GtkSourceView *

See Also

GtkSourceView