Class
GtkSourceMap
Description
class GtkSource.Map : GtkSource.View {
parent_instance: GtkSourceView
}
Widget that displays a map for a specific GtkSourceView
.
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 GtkSourceMap: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, GtkSourceMap: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
.
When FontConfig is available, GtkSourceMap
will try to use a bundled
“block” font to make the map more legible.
Constructors
gtk_source_map_new
Creates a new GtkSourceMap
.
Instance methods
gtk_source_map_get_view
Gets the GtkSourceMap:view
property, which is the view this widget is mapping.
gtk_source_map_set_view
Sets the view that map
will be doing the mapping to.
Methods inherited from GtkSourceView (40)
Methods inherited from GtkTextView (71)
Methods inherited from GtkWidget (159)
Methods inherited from GObject (43)
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role
Retrieves the GtkAccessibleRole
for the given GtkAccessible
.
gtk_accessible_reset_property
Resets the accessible property
to its default value.
gtk_accessible_reset_relation
Resets the accessible relation
to its default value.
gtk_accessible_reset_state
Resets the accessible state
to its default value.
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable
object.
Methods inherited from GtkScrollable (9)
gtk_scrollable_get_border
Returns the size of a non-scrolling border around the outside of the scrollable.
gtk_scrollable_get_hadjustment
Retrieves the GtkAdjustment
used for horizontal scrolling.
gtk_scrollable_get_hscroll_policy
Gets the horizontal GtkScrollablePolicy
.
gtk_scrollable_get_vadjustment
Retrieves the GtkAdjustment
used for vertical scrolling.
gtk_scrollable_get_vscroll_policy
Gets the vertical GtkScrollablePolicy
.
gtk_scrollable_set_hadjustment
Sets the horizontal adjustment of the GtkScrollable
.
gtk_scrollable_set_hscroll_policy
Sets the GtkScrollablePolicy
.
gtk_scrollable_set_vadjustment
Sets the vertical adjustment of the GtkScrollable
.
gtk_scrollable_set_vscroll_policy
Sets the GtkScrollablePolicy
.
Properties
GtkSource.Map:font-desc
GtkSource.Map:view
Properties inherited from GtkSourceView (17)
GtkSource.View:auto-indent
GtkSource.View:background-pattern
Draw a specific background pattern on the view.
GtkSource.View:completion
The completion object associated with the view.
GtkSource.View:enable-snippets
The property denotes if snippets should be
expanded when the user presses Tab after having typed a word
matching the snippets found in GtkSourceSnippetManager
.
GtkSource.View:highlight-current-line
GtkSource.View:indent-on-tab
GtkSource.View:indent-width
Width of an indentation step expressed in number of spaces.
GtkSource.View:indenter
The property is a GtkSourceIndenter
to use to indent
as the user types into the GtkSourceView
.
GtkSource.View:insert-spaces-instead-of-tabs
GtkSource.View:right-margin-position
Position of the right margin.
GtkSource.View:show-line-marks
Whether to display line mark pixbufs.
GtkSource.View:show-line-numbers
Whether to display line numbers.
GtkSource.View:show-right-margin
Whether to display the right margin.
GtkSource.View:smart-backspace
Whether smart Backspace should be used.
GtkSource.View:smart-home-end
Set the behavior of the HOME and END keys.
GtkSource.View:space-drawer
The GtkSourceSpaceDrawer
object associated with the view.4
GtkSource.View:tab-width
Width of a tab character expressed in number of spaces.
Properties inherited from GtkTextView (21)
Gtk.TextView:accepts-tab
Whether Tab will result in a tab character being entered.
Gtk.TextView:bottom-margin
The bottom margin for text in the text view.
Gtk.TextView:buffer
The buffer which is displayed.
Gtk.TextView:cursor-visible
If the insertion cursor is shown.
Gtk.TextView:editable
Gtk.TextView:extra-menu
A menu model whose contents will be appended to the context menu.
Gtk.TextView:im-module
Which IM (input method) module should be used for this text_view.
Gtk.TextView:indent
Amount to indent the paragraph, in pixels.
Gtk.TextView:input-hints
Additional hints (beyond GtkTextView:input-purpose
)
that allow input methods to fine-tune their behaviour.
Gtk.TextView:input-purpose
The purpose of this text field.
Gtk.TextView:justification
Gtk.TextView:left-margin
The default left margin for text in the text view.
Gtk.TextView:monospace
Whether text should be displayed in a monospace font.
Gtk.TextView:overwrite
Whether entered text overwrites existing contents.
Gtk.TextView:pixels-above-lines
Gtk.TextView:pixels-below-lines
Gtk.TextView:pixels-inside-wrap
Gtk.TextView:right-margin
The default right margin for text in the text view.
Gtk.TextView:tabs
Gtk.TextView:top-margin
The top margin for text in the text view.
Gtk.TextView:wrap-mode
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget
.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget
.
Gtk.Widget:height-request
Override for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand
property.
Gtk.Widget:layout-manager
The GtkLayoutManager
instance to use to compute the preferred size
of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot
widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand
property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Override for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible
implementation.
Properties inherited from GtkScrollable (4)
Gtk.Scrollable:hadjustment
Horizontal GtkAdjustment
of the scrollable widget.
Gtk.Scrollable:hscroll-policy
Determines when horizontal scrolling should start.
Gtk.Scrollable:vadjustment
Vertical GtkAdjustment
of the scrollable widget.
Gtk.Scrollable:vscroll-policy
Determines when vertical scrolling should start.
Signals
Signals inherited from GtkSourceView (10)
GtkSource.View::change-case
Keybinding signal to change case of the text at the current cursor position.
GtkSource.View::change-number
Keybinding signal to edit a number at the current cursor position.
GtkSource.View::join-lines
Keybinding signal to join the lines currently selected.
GtkSource.View::line-mark-activated
Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter).
GtkSource.View::move-lines
The signal is a keybinding which gets emitted when the user initiates moving a line.
GtkSource.View::move-to-matching-bracket
Keybinding signal to move the cursor to the matching bracket.
GtkSource.View::move-words
The signal is a keybinding which gets emitted when the user initiates moving a word.
GtkSource.View::push-snippet
The signal is emitted to insert a new snippet into the view.
GtkSource.View::show-completion
The signal is a key binding signal which gets
emitted when the user requests a completion, by pressing
GtkSource.View::smart-home-end
Emitted when a the cursor was moved according to the smart home end setting.
Signals inherited from GtkTextView (15)
Gtk.TextView::backspace
Gets emitted when the user asks for it.
Gtk.TextView::copy-clipboard
Gets emitted to copy the selection to the clipboard.
Gtk.TextView::cut-clipboard
Gets emitted to cut the selection to the clipboard.
Gtk.TextView::delete-from-cursor
Gets emitted when the user initiates a text deletion.
Gtk.TextView::extend-selection
Emitted when the selection needs to be extended at location
.
Gtk.TextView::insert-at-cursor
Gets emitted when the user initiates the insertion of a fixed string at the cursor.
Gtk.TextView::insert-emoji
Gets emitted to present the Emoji chooser for the text_view
.
Gtk.TextView::move-cursor
Gets emitted when the user initiates a cursor movement.
Gtk.TextView::move-viewport
Gets emitted to move the viewport.
Gtk.TextView::paste-clipboard
Gets emitted to paste the contents of the clipboard into the text view.
Gtk.TextView::preedit-changed
Emitted when preedit text of the active IM changes.
Gtk.TextView::select-all
Gets emitted to select or unselect the complete contents of the text view.
Gtk.TextView::set-anchor
Gets emitted when the user initiates settings the “anchor” mark.
Gtk.TextView::toggle-cursor-visible
Gets emitted to toggle the cursor-visible
property.
Gtk.TextView::toggle-overwrite
Gets emitted to toggle the overwrite mode of the text view.
Signals inherited from GtkWidget (13)
Gtk.Widget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
Gtk.Widget::direction-changed
Emitted when the text direction of a widget changes.
Gtk.Widget::hide
Emitted when widget
is hidden.
Gtk.Widget::keynav-failed
Emitted if keyboard navigation fails.
Gtk.Widget::map
Emitted when widget
is going to be mapped.
Gtk.Widget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
Gtk.Widget::move-focus
Emitted when the focus is moved.
Gtk.Widget::query-tooltip
Emitted when the widgets tooltip is about to be shown.
Gtk.Widget::realize
Emitted when widget
is associated with a GdkSurface
.
Gtk.Widget::show
Emitted when widget
is shown.
Gtk.Widget::state-flags-changed
Emitted when the widget state changes.
Gtk.Widget::unmap
Emitted when widget
is going to be unmapped.
Gtk.Widget::unrealize
Emitted when the GdkSurface
associated with widget
is destroyed.
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.