gtk.TextView



class TextView : gtk.Container.Container, gtk.ScrollableIF.ScrollableIF;
You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together.

# CSS nodes

|[ textview.view ├── border.top ├── border.left ├── text │ ╰── [selection] ├── border.right ├── border.bottom ╰── [window.popup] ]|

GtkTextView has a main css node with name textview and style class .view, and subnodes for each of the border windows, and the main text area, with names border and text, respectively. The border nodes each get one of the style classes .left, .right, .top or .bottom.

A node representing the selection will appear below the text node.

If a context menu is opened, the window node will appear as a subnode of the main node.

protected GtkTextView* gtkTextView ;
the main Gtk struct

GtkTextView* getTextViewStruct ();
Get the main Gtk struct

protected void* getStruct ();
the main Gtk struct as a void*

this(GtkTextView* gtkTextView, bool ownedRef = false);
Sets our main struct and passes it to the parent class.

string getLineTextAt (int y);
Get the text line at the pixel y

void insertText (string text);
Simply appends some on the cursor position

Params:
string text the text to append

void appendText (string text, bool ensureVisible = true);
Simply appends some text to this view

Params:
string text the text to append

static GType getType ();


this();
Creates a new #GtkTextView. If you don’t call gtk_text_view_set_buffer() before using the text view, an empty default buffer will be created for you. Get the buffer with gtk_text_view_get_buffer(). If you want to specify your own buffer, consider gtk_text_view_new_with_buffer().

Return:
a new #GtkTextView

Throws:
ConstructionException GTK+ fails to create the object.

this(TextBuffer buffer);
Creates a new #GtkTextView widget displaying the buffer @buffer. One buffer can be shared among many widgets. @buffer may be %NULL to create a default buffer, in which case this function is equivalent to gtk_text_view_new(). The text view adds its own reference count to the buffer; it does not take over an existing reference.

Params:
TextBuffer buffer a #GtkTextBuffer

Return:
a new #GtkTextView.

Throws:
ConstructionException GTK+ fails to create the object.

void addChildAtAnchor (Widget child, TextChildAnchor anchor);
Adds a child widget in the text buffer, at the given @anchor.

Params:
Widget child a #GtkWidget
TextChildAnchor anchor a #GtkTextChildAnchor in the #GtkTextBuffer for @text_view

void addChildInWindow (Widget child, GtkTextWindowType whichWindow, int xpos, int ypos);
Adds a child at fixed coordinates in one of the text widget's windows.

The window must have nonzero size (see gtk_text_view_set_border_window_size()). Note that the child coordinates are given relative to scrolling. When placing a child in #GTK_TEXT_WINDOW_WIDGET, scrolling is irrelevant, the child floats above all scrollable areas. But when placing a child in one of the scrollable windows (border windows or text window) it will move with the scrolling as needed.

Params:
Widget child a #GtkWidget
GtkTextWindowType whichWindow which window the child should appear in
int xpos X position of child in window coordinates
int ypos Y position of child in window coordinates

bool backwardDisplayLine (TextIter iter);
Moves the given @iter backward by one display (wrapped) line. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the #GtkTextBuffer.

Params:
TextIter iter a #GtkTextIter

Return:
%TRUE if @iter was moved and is not on the end iterator

bool backwardDisplayLineStart (TextIter iter);
Moves the given @iter backward to the next display line start. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the #GtkTextBuffer.

Params:
TextIter iter a #GtkTextIter

Return:
%TRUE if @iter was moved and is not on the end iterator

void bufferToWindowCoords (GtkTextWindowType win, int bufferX, int bufferY, out int windowX, out int windowY);
Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window @win, and stores the result in (@window_x, @window_y).

Note that you can’t convert coordinates for a nonexisting window (see gtk_text_view_set_border_window_size()).

Params:
GtkTextWindowType win a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
int bufferX buffer x coordinate
int bufferY buffer y coordinate
int windowX window x coordinate return location or %NULL
int windowY window y coordinate return location or %NULL

bool forwardDisplayLine (TextIter iter);
Moves the given @iter forward by one display (wrapped) line. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the #GtkTextBuffer.

Params:
TextIter iter a #GtkTextIter

Return:
%TRUE if @iter was moved and is not on the end iterator

bool forwardDisplayLineEnd (TextIter iter);
Moves the given @iter forward to the next display line end. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the #GtkTextBuffer.

Params:
TextIter iter a #GtkTextIter

Return:
%TRUE if @iter was moved and is not on the end iterator

bool getAcceptsTab ();
Returns whether pressing the Tab key inserts a tab characters. gtk_text_view_set_accepts_tab().

Return:
%TRUE if pressing the Tab key inserts a tab character, %FALSE if pressing the Tab key moves the keyboard focus.

Since:
2.4

int getBorderWindowSize (GtkTextWindowType type);
Gets the width of the specified border window. See gtk_text_view_set_border_window_size().

Params:
GtkTextWindowType type window to return size from

Return:
width of window

int getBottomMargin ();
Gets the bottom margin for text in the @text_view.

Return:
bottom margin in pixels

Since:
3.18

TextBuffer getBuffer ();
Returns the #GtkTextBuffer being displayed by this text view. The reference count on the buffer is not incremented; the caller of this function won’t own a new reference.

Return:
a #GtkTextBuffer

void getCursorLocations (TextIter iter, out GdkRectangle strong, out GdkRectangle weak);
Given an @iter within a text layout, determine the positions of the strong and weak cursors if the insertion point is at that iterator. The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction of the paragraph are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the paragraph are inserted.

If @iter is %NULL, the actual cursor position is used.

Note that if @iter happens to be the actual cursor position, and there is currently an IM preedit sequence being entered, the returned locations will be adjusted to account for the preedit cursor’s offset within the preedit sequence.

The rectangle position is in buffer coordinates; use gtk_text_view_buffer_to_window_coords() to convert these coordinates to coordinates for one of the windows in the text view.

Params:
TextIter iter a #GtkTextIter
GdkRectangle strong location to store the strong cursor position (may be %NULL)
GdkRectangle weak location to store the weak cursor position (may be %NULL)

Since:
3.0

bool getCursorVisible ();
Find out whether the cursor should be displayed.

Return:
whether the insertion mark is visible

TextAttributes getDefaultAttributes ();
Obtains a copy of the default text attributes. These are the attributes used for text unless a tag overrides them. You’d typically pass the default attributes in to gtk_text_iter_get_attributes() in order to get the attributes in effect at a given text position.

The return value is a copy owned by the caller of this function, and should be freed with gtk_text_attributes_unref().

Return:
a new #GtkTextAttributes

bool getEditable ();
Returns the default editability of the #GtkTextView. Tags in the buffer may override this setting for some ranges of text.

Return:
whether text is editable by default

int getIndent ();
Gets the default indentation of paragraphs in @text_view. Tags in the view’s buffer may override the default. The indentation may be negative.

Return:
number of pixels of indentation

GtkInputHints getInputHints ();
Gets the value of the #GtkTextView:input-hints property.

Since:
3.6

GtkInputPurpose getInputPurpose ();
Gets the value of the #GtkTextView:input-purpose property.

Since:
3.6

bool getIterAtLocation (out TextIter iter, int x, int y);
Retrieves the iterator at buffer coordinates @x and @y. Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with gtk_text_view_window_to_buffer_coords().

Params:
TextIter iter a #GtkTextIter
int x x position, in buffer coordinates
int y y position, in buffer coordinates

Return:
%TRUE if the position is over text

bool getIterAtPosition (out TextIter iter, out int trailing, int x, int y);
Retrieves the iterator pointing to the character at buffer coordinates @x and @y. Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with gtk_text_view_window_to_buffer_coords().

Note that this is different from gtk_text_view_get_iter_at_location(), which returns cursor locations, i.e. positions between characters.

Params:
TextIter iter a #GtkTextIter
int trailing if non-%NULL, location to store an integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the trailing edge of the grapheme.
int x x position, in buffer coordinates
int y y position, in buffer coordinates

Return:
%TRUE if the position is over text

Since:
2.6

void getIterLocation (TextIter iter, out GdkRectangle location);
Gets a rectangle which roughly contains the character at @iter. The rectangle position is in buffer coordinates; use gtk_text_view_buffer_to_window_coords() to convert these coordinates to coordinates for one of the windows in the text view.

Params:
TextIter iter a #GtkTextIter
GdkRectangle location bounds of the character at @iter

GtkJustification getJustification ();
Gets the default justification of paragraphs in @text_view. Tags in the buffer may override the default.

Return:
default justification

int getLeftMargin ();
Gets the default left margin size of paragraphs in the @text_view. Tags in the buffer may override the default.

Return:
left margin in pixels

void getLineAtY (out TextIter targetIter, int y, out int lineTop);
Gets the #GtkTextIter at the start of the line containing the coordinate @y. @y is in buffer coordinates, convert from window coordinates with gtk_text_view_window_to_buffer_coords(). If non-%NULL, @line_top will be filled with the coordinate of the top edge of the line.

Params:
TextIter targetIter a #GtkTextIter
int y a y coordinate
int lineTop return location for top coordinate of the line

void getLineYrange (TextIter iter, out int y, out int height);
Gets the y coordinate of the top of the line containing @iter, and the height of the line. The coordinate is a buffer coordinate; convert to window coordinates with gtk_text_view_buffer_to_window_coords().

Params:
TextIter iter a #GtkTextIter
int y return location for a y coordinate
int height return location for a height

bool getMonospace ();
Gets the value of the #GtkTextView:monospace property.

Return:
%TRUE if monospace fonts are desired

Since:
3.16

bool getOverwrite ();
Returns whether the #GtkTextView is in overwrite mode or not.

Return:
whether @text_view is in overwrite mode or not.

Since:
2.4

int getPixelsAboveLines ();
Gets the default number of pixels to put above paragraphs. Adding this function with gtk_text_view_get_pixels_below_lines() is equal to the line space between each paragraph.

Return:
default number of pixels above paragraphs

int getPixelsBelowLines ();
Gets the value set by gtk_text_view_set_pixels_below_lines().

The line space is the sum of the value returned by this function and the value returned by gtk_text_view_get_pixels_above_lines().

Return:
default number of blank pixels below paragraphs

int getPixelsInsideWrap ();
Gets the value set by gtk_text_view_set_pixels_inside_wrap().

Return:
default number of pixels of blank space between wrapped lines

int getRightMargin ();
Gets the default right margin for text in @text_view. Tags in the buffer may override the default.

Return:
right margin in pixels

PgTabArray getTabs ();
Gets the default tabs for @text_view. Tags in the buffer may override the defaults. The returned array will be %NULL if “standard” (8-space) tabs are used. Free the return value with pango_tab_array_free().

Return:
copy of default tab array, or %NULL if “standard" tabs are used; must be freed with pango_tab_array_free().

int getTopMargin ();
Gets the top margin for text in the @text_view.

Return:
top margin in pixels

Since:
3.18

void getVisibleRect (out GdkRectangle visibleRect);
Fills @visible_rect with the currently-visible region of the buffer, in buffer coordinates. Convert to window coordinates with gtk_text_view_buffer_to_window_coords().

Params:
GdkRectangle visibleRect rectangle to fill

Window getWindow (GtkTextWindowType win);
Retrieves the #GdkWindow corresponding to an area of the text view; possible windows include the overall widget window, child windows on the left, right, top, bottom, and the window that displays the text buffer. Windows are %NULL and nonexistent if their width or height is 0, and are nonexistent before the widget has been realized.

Params:
GtkTextWindowType win window to get

Return:
a #GdkWindow, or %NULL

GtkTextWindowType getWindowType (Window window);
Usually used to find out which window an event corresponds to. If you connect to an event signal on @text_view, this function should be called on
event->window
to see which window it was.

Params:
Window window a window type

Return:
the window type.

GtkWrapMode getWrapMode ();
Gets the line wrapping for the view.

Return:
the line wrap setting

bool imContextFilterKeypress (GdkEventKey* event);
Allow the #GtkTextView input method to internally handle key press and release events. If this function returns %TRUE, then no further processing should be done for this key event. See gtk_im_context_filter_keypress().

Note that you are expected to call this function from your handler when overriding key event handling. This is needed in the case when you need to insert your own key handling between the input method and the default key event handling of the #GtkTextView.

|[ static gboolean gtk_foo_bar_key_press_event (GtkWidget *widget, GdkEventKey *event) { if ((key->keyval == GDK_KEY_Return || key->keyval == GDK_KEY_KP_Enter)) { if (gtk_text_view_im_context_filter_keypress (GTK_TEXT_VIEW (view), event)) return TRUE; }

// Do some stuff

return GTK_WIDGET_CLASS (gtk_foo_bar_parent_class)->key_press_event (widget, event); } ]|

Params:
GdkEventKey* event the key event

Return:
%TRUE if the input method handled the key event.

Since:
2.22

void moveChild (Widget child, int xpos, int ypos);
Updates the position of a child, as for gtk_text_view_add_child_in_window().

Params:
Widget child child widget already added to the text view
int xpos new X position in window coordinates
int ypos new Y position in window coordinates

bool moveMarkOnscreen (TextMark mark);
Moves a mark within the buffer so that it's located within the currently-visible text area.

Params:
TextMark mark a #GtkTextMark

Return:
%TRUE if the mark moved (wasn’t already onscreen)

bool moveVisually (TextIter iter, int count);
Move the iterator a given number of characters visually, treating it as the strong cursor position. If @count is positive, then the new strong cursor position will be @count positions to the right of the old cursor position. If @count is negative then the new strong cursor position will be @count positions to the left of the old cursor position.

In the presence of bi-directional text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run.

Params:
TextIter iter a #GtkTextIter
int count number of characters to move (negative moves left, positive moves right)

Return:
%TRUE if @iter moved and is not on the end iterator

bool placeCursorOnscreen ();
Moves the cursor to the currently visible region of the buffer, it it isn’t there already.

Return:
%TRUE if the cursor had to be moved.

void resetCursorBlink ();
Ensures that the cursor is shown (i.e. not in an 'off' blink interval) and resets the time that it will stay blinking (or visible, in case blinking is disabled).

This function should be called in response to user input (e.g. from derived classes that override the textview's #GtkWidget::key-press-event handler).

Since:
3.20

void resetImContext ();
Reset the input method context of the text view if needed.

This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.

Since:
2.22

void scrollMarkOnscreen (TextMark mark);
Scrolls @text_view the minimum distance such that @mark is contained within the visible area of the widget.

Params:
TextMark mark a mark in the buffer for @text_view

bool scrollToIter (TextIter iter, double withinMargin, bool useAlign, double xalign, double yalign);
Scrolls @text_view so that @iter is on the screen in the position indicated by @xalign and @yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or bottom, 0.5 means center. If @use_align is %FALSE, the text scrolls the minimal distance to get the mark onscreen, possibly not scrolling at all. The effective screen for purposes of this function is reduced by a margin of size @within_margin.

Note that this function uses the currently-computed height of the lines in the text buffer. Line heights are computed in an idle handler; so this function may not have the desired effect if it’s called before the height computations. To avoid oddness, consider using gtk_text_view_scroll_to_mark() which saves a point to be scrolled to after line validation.

Params:
TextIter iter a #GtkTextIter
double withinMargin margin as a [0.0,0.5) fraction of screen size
bool useAlign whether to use alignment arguments (if %FALSE, just get the mark onscreen)
double xalign horizontal alignment of mark within visible area
double yalign vertical alignment of mark within visible area

Return:
%TRUE if scrolling occurred

void scrollToMark (TextMark mark, double withinMargin, bool useAlign, double xalign, double yalign);
Scrolls @text_view so that @mark is on the screen in the position indicated by @xalign and @yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or bottom, 0.5 means center. If @use_align is %FALSE, the text scrolls the minimal distance to get the mark onscreen, possibly not scrolling at all. The effective screen for purposes of this function is reduced by a margin of size @within_margin.

Params:
TextMark mark a #GtkTextMark
double withinMargin margin as a [0.0,0.5) fraction of screen size
bool useAlign whether to use alignment arguments (if %FALSE, just get the mark onscreen)
double xalign horizontal alignment of mark within visible area
double yalign vertical alignment of mark within visible area

void setAcceptsTab (bool acceptsTab);
Sets the behavior of the text widget when the Tab key is pressed. If @accepts_tab is %TRUE, a tab character is inserted. If @accepts_tab is %FALSE the keyboard focus is moved to the next widget in the focus chain.

Params:
bool acceptsTab %TRUE if pressing the Tab key should insert a tab character, %FALSE, if pressing the Tab key should move the keyboard focus.

Since:
2.4

void setBorderWindowSize (GtkTextWindowType type, int size);
Sets the width of %GTK_TEXT_WINDOW_LEFT or %GTK_TEXT_WINDOW_RIGHT, or the height of %GTK_TEXT_WINDOW_TOP or %GTK_TEXT_WINDOW_BOTTOM. Automatically destroys the corresponding window if the size is set to 0, and creates the window if the size is set to non-zero. This function can only be used for the “border windows,” it doesn’t work with #GTK_TEXT_WINDOW_WIDGET, #GTK_TEXT_WINDOW_TEXT, or #GTK_TEXT_WINDOW_PRIVATE.

Params:
GtkTextWindowType type window to affect
int size width or height of the window

void setBottomMargin (int bottomMargin);
Sets the bottom margin for text in @text_view.

Note that this function is confusingly named. In CSS terms, the value set here is padding.

Params:
int bottomMargin bottom margin in pixels

Since:
3.18

void setBuffer (TextBuffer buffer);
Sets @buffer as the buffer being displayed by @text_view. The previous buffer displayed by the text view is unreferenced, and a reference is added to @buffer. If you owned a reference to @buffer before passing it to this function, you must remove that reference yourself; #GtkTextView will not “adopt” it.

Params:
TextBuffer buffer a #GtkTextBuffer

void setCursorVisible (bool setting);
Toggles whether the insertion point should be displayed. A buffer with no editable text probably shouldn’t have a visible cursor, so you may want to turn the cursor off.

Note that this property may be overridden by the #GtkSettings:gtk-keynave-use-caret settings.

Params:
bool setting whether to show the insertion cursor

void setEditable (bool setting);
Sets the default editability of the #GtkTextView. You can override this default setting with tags in the buffer, using the “editable” attribute of tags.

Params:
bool setting whether it’s editable

void setIndent (int indent);
Sets the default indentation for paragraphs in @text_view. Tags in the buffer may override the default.

Params:
int indent indentation in pixels

void setInputHints (GtkInputHints hints);
Sets the #GtkTextView:input-hints property, which allows input methods to fine-tune their behaviour.

Params:
GtkInputHints hints the hints

Since:
3.6

void setInputPurpose (GtkInputPurpose purpose);
Sets the #GtkTextView:input-purpose property which can be used by on-screen keyboards and other input methods to adjust their behaviour.

Params:
GtkInputPurpose purpose the purpose

Since:
3.6

void setJustification (GtkJustification justification);
Sets the default justification of text in @text_view. Tags in the view’s buffer may override the default.

Params:
GtkJustification justification justification

void setLeftMargin (int leftMargin);
Sets the default left margin for text in @text_view. Tags in the buffer may override the default.

Note that this function is confusingly named. In CSS terms, the value set here is padding.

Params:
int leftMargin left margin in pixels

void setMonospace (bool monospace);
Sets the #GtkTextView:monospace property, which indicates that the text view should use monospace fonts.

Params:
bool monospace %TRUE to request monospace styling

Since:
3.16

void setOverwrite (bool overwrite);
Changes the #GtkTextView overwrite mode.

Params:
bool overwrite %TRUE to turn on overwrite mode, %FALSE to turn it off

Since:
2.4

void setPixelsAboveLines (int pixelsAboveLines);
Sets the default number of blank pixels above paragraphs in @text_view. Tags in the buffer for @text_view may override the defaults.

Params:
int pixelsAboveLines pixels above paragraphs

void setPixelsBelowLines (int pixelsBelowLines);
Sets the default number of pixels of blank space to put below paragraphs in @text_view. May be overridden by tags applied to @text_view’s buffer.

Params:
int pixelsBelowLines pixels below paragraphs

void setPixelsInsideWrap (int pixelsInsideWrap);
Sets the default number of pixels of blank space to leave between display/wrapped lines within a paragraph. May be overridden by tags in @text_view’s buffer.

Params:
int pixelsInsideWrap default number of pixels between wrapped lines

void setRightMargin (int rightMargin);
Sets the default right margin for text in the text view. Tags in the buffer may override the default.

Note that this function is confusingly named. In CSS terms, the value set here is padding.

Params:
int rightMargin right margin in pixels

void setTabs (PgTabArray tabs);
Sets the default tab stops for paragraphs in @text_view. Tags in the buffer may override the default.

Params:
PgTabArray tabs tabs as a #PangoTabArray

void setTopMargin (int topMargin);
Sets the top margin for text in @text_view.

Note that this function is confusingly named. In CSS terms, the value set here is padding.

Params:
int topMargin top margin in pixels

Since:
3.18

void setWrapMode (GtkWrapMode wrapMode);
Sets the line wrapping for the view.

Params:
GtkWrapMode wrapMode a #GtkWrapMode

bool startsDisplayLine (TextIter iter);
Determines whether @iter is at the start of a display line. See gtk_text_view_forward_display_line() for an explanation of display lines vs. paragraphs.

Params:
TextIter iter a #GtkTextIter

Return:
%TRUE if @iter begins a wrapped line

void windowToBufferCoords (GtkTextWindowType win, int windowX, int windowY, out int bufferX, out int bufferY);
Converts coordinates on the window identified by @win to buffer coordinates, storing the result in (@buffer_x,@buffer_y).

Note that you can’t convert coordinates for a nonexisting window (see gtk_text_view_set_border_window_size()).

Params:
GtkTextWindowType win a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
int windowX window x coordinate
int windowY window y coordinate
int bufferX buffer x coordinate return location or %NULL
int bufferY buffer y coordinate return location or %NULL

gulong addOnBackspace (void delegate(TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::backspace signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

The default bindings for this signal are Backspace and Shift-Backspace.

gulong addOnCopyClipboard (void delegate(TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::copy-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to copy the selection to the clipboard.

The default bindings for this signal are Ctrl-c and Ctrl-Insert.

gulong addOnCutClipboard (void delegate(TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::cut-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to cut the selection to the clipboard.

The default bindings for this signal are Ctrl-x and Shift-Delete.

gulong addOnDeleteFromCursor (void delegate(GtkDeleteType, int, TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::delete-from-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a text deletion.

If the @type is %GTK_DELETE_CHARS, GTK+ deletes the selection if there is one, otherwise it deletes the requested number of characters.

The default bindings for this signal are Delete for deleting a character, Ctrl-Delete for deleting a word and Ctrl-Backspace for deleting a word backwords.

Params:
type the granularity of the deletion, as a #GtkDeleteType
count the number of @type units to delete

gulong addOnExtendSelection (bool delegate(GtkTextExtendSelection, TextIter, TextIter, TextIter, TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::extend-selection signal is emitted when the selection needs to be extended at @location.

Params:
granularity the granularity type
location the location where to extend the selection
start where the selection should start
end where the selection should end

Return:
%GDK_EVENT_STOP to stop other handlers from being invoked for the event. %GDK_EVENT_PROPAGATE to propagate the event further.

Since:
3.16

gulong addOnInsertAtCursor (void delegate(string, TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::insert-at-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates the insertion of a fixed string at the cursor.

This signal has no default bindings.

Params:
str the string to insert

gulong addOnMoveCursor (void delegate(GtkMovementStep, int, bool, TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement. If the cursor is not visible in @text_view, this signal causes the viewport to be moved instead.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifer does not. There are too many key combinations to list them all here. - Arrow keys move by individual characters/lines - Ctrl-arrow key combinations move by words/paragraphs - Home/End keys move to the ends of the buffer - PageUp/PageDown keys move vertically by pages - Ctrl-PageUp/PageDown keys move horizontally by pages

Params:
step the granularity of the move, as a #GtkMovementStep
count the number of @step units to move
extendSelection %TRUE if the move should extend the selection

gulong addOnMoveViewport (void delegate(GtkScrollStep, int, TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::move-viewport signal is a [keybinding signal][GtkBindingSignal] which can be bound to key combinations to allow the user to move the viewport, i.e. change what part of the text view is visible in a containing scrolled window.

There are no default bindings for this signal.

Params:
step the granularity of the movement, as a #GtkScrollStep
count the number of @step units to move

gulong addOnPasteClipboard (void delegate(TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::paste-clipboard signal is a [keybinding signal][GtkBindingSignal] which gets emitted to paste the contents of the clipboard into the text view.

The default bindings for this signal are Ctrl-v and Shift-Insert.

gulong addOnPopulatePopup (void delegate(Widget, TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::populate-popup signal gets emitted before showing the context menu of the text view.

If you need to add items to the context menu, connect to this signal and append your items to the @popup, which will be a #GtkMenu in this case.

If #GtkTextView:populate-all is %TRUE, this signal will also be emitted to populate touch popups. In this case, @popup will be a different container, e.g. a #GtkToolbar.

The signal handler should not make assumptions about the type of @widget, but check whether @popup is a #GtkMenu or #GtkToolbar or another kind of container.

Params:
popup the container that is being populated

gulong addOnPreeditChanged (void delegate(string, TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal.

This signal is only emitted if the text at the given position is actually editable.

Params:
preedit the current preedit string

Since:
2.20

gulong addOnSelectAll (void delegate(bool, TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::select-all signal is a [keybinding signal][GtkBindingSignal] which gets emitted to select or unselect the complete contents of the text view.

The default bindings for this signal are Ctrl-a and Ctrl-/ for selecting and Shift-Ctrl-a and Ctrl-\ for unselecting.

Params:
select %TRUE to select, %FALSE to unselect

gulong addOnSetAnchor (void delegate(TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::set-anchor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates setting the "anchor" mark. The "anchor" mark gets placed at the same position as the "insert" mark.

This signal has no default bindings.

gulong addOnToggleCursorVisible (void delegate(TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::toggle-cursor-visible signal is a [keybinding signal][GtkBindingSignal] which gets emitted to toggle the #GtkTextView:cursor-visible property.

The default binding for this signal is F7.

gulong addOnToggleOverwrite (void delegate(TextView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::toggle-overwrite signal is a [keybinding signal][GtkBindingSignal] which gets emitted to toggle the overwrite mode of the text view.

The default bindings for this signal is Insert.

Page was generated with on Fri Jan 6 23:09:20 2017