gtksource.map

Module for [Map] class

class Map MapGidBuilder MapGidBuilderImpl

Types 3

classMap : gtksource.view.View

Widget that displays a map for a specific gtksource.view.View.

gtksource.map.Map is a widget that maps the content of a gtksource.view.View into a smaller view so the user can have a quick overview of the whole document.

This works by connecting a gtksource.view.View to to the gtksource.map.Map using the gtksource.map.Map.view property or gtksource.map.Map.setView.

gtksource.map.Map is a gtksource.view.View object. This means that you can add a gtksource.gutter_renderer.GutterRenderer to a gutter in the same way you would for a gtksource.view.View. One example might be a gtksource.gutter_renderer.GutterRenderer that shows which lines have changed in the document.

Additionally, it is desirable to match the font of the gtksource.map.Map and the gtksource.view.View used for editing. Therefore, gtksource.map.Map.fontDesc 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.FontDescription.setSize for how to alter the size of an existing pango.font_description.FontDescription.

When FontConfig is available, gtksource.map.Map will try to use a bundled "block" font to make the map more legible.

Methods
GType _getGType() static nothrow
GType _gType() @property nothrow
Map self() nothrowReturns `this`, for use in `with` statements.
MapGidBuilder builder() static nothrowGet builder for [gtksource.map.Map] Returns: New builder object
pango.font_description.FontDescription fontDesc() @property nothrow
void fontDesc(pango.font_description.FontDescription propval) @property nothrow
gtksource.view.View view() @property nothrow
void view(gtksource.view.View propval) @property nothrow
gtksource.view.View getView() nothrowGets the [gtksource.map.Map.view] property, which is the view this widget is mapping. Returns: a #GtkSourceView or null.
void setView(gtksource.view.View view) nothrowSets the view that map will be doing the mapping to.
Constructors
this(void * ptr, Flag!"Take" take)
this()Creates a new [gtksource.map.Map]. Returns: a new #GtkSourceMap.
classMapGidBuilderImpl(T) : gtksource.view.ViewGidBuilderImpl!T

Fluent builder implementation template for gtksource.map.Map

Methods
T fontDesc(pango.font_description.FontDescription propval) nothrow
T view(gtksource.view.View propval) nothrow
classMapGidBuilder : MapGidBuilderImpl!MapGidBuilder

Fluent builder for gtksource.map.Map

Methods
Map build() nothrowCreate object from builder. Returns: New object