GI.Gtk.Objects.TextView

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

plain code

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.

Exported types

newtype TextView

Memory-managed wrapper type.

Constructors

TextView (ManagedPtr TextView)

Instances

Eq TextView

Defined in GI.Gtk.Objects.TextView

Methods

(==) :: TextView -> TextView -> Bool

(/=) :: TextView -> TextView -> Bool

GObject TextView

Defined in GI.Gtk.Objects.TextView

ManagedPtrNewtype TextView

Defined in GI.Gtk.Objects.TextView

Methods

toManagedPtr :: TextView -> ManagedPtr TextView

TypedObject TextView

Defined in GI.Gtk.Objects.TextView

Methods

glibType :: IO GType

HasParentTypes TextView

Defined in GI.Gtk.Objects.TextView

IsGValue (Maybe TextView)

Convert TextView to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.TextView

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe TextView -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe TextView)

type ParentTypes TextView

Defined in GI.Gtk.Objects.TextView

type ParentTypes TextView = '[Container, Widget, Object, ImplementorIface, Buildable, Scrollable]

class (GObject o, IsDescendantOf TextView o) => IsTextView o

Type class for types which can be safely cast to TextView, for instance with toTextView.

Instances

(GObject o, IsDescendantOf TextView o) => IsTextView o

Defined in GI.Gtk.Objects.TextView

toTextView :: (MonadIO m, IsTextView o) => o -> m TextView

Cast to TextView, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

activate, add, addAccelerator, addChild, addChildAtAnchor, addChildInWindow, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, backwardDisplayLine, backwardDisplayLineStart, bindProperty, bindPropertyFull, bufferToWindowCoords, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, forwardDisplayLine, forwardDisplayLineEnd, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, imContextFilterKeypress, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, moveChild, moveMarkOnscreen, moveVisually, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, placeCursorOnscreen, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetCursorBlink, resetImContext, resetRcStyles, resetStyle, resizeChildren, runDispose, scrollMarkOnscreen, scrollToIter, scrollToMark, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, startsDisplayLine, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure, windowToBufferCoords.

Getters

getAcceptsTab, getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorder, getBorderWidth, getBorderWindowSize, getBottomMargin, getBuffer, getCanDefault, getCanFocus, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getCursorLocations, getCursorVisible, getData, getDefaultAttributes, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEditable, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHadjustment, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHscrollPolicy, getIndent, getInputHints, getInputPurpose, getInternalChild, getIterAtLocation, getIterAtPosition, getIterLocation, getJustification, getLeftMargin, getLineAtY, getLineYrange, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getMonospace, getName, getNoShowAll, getOpacity, getOverwrite, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPixelsAboveLines, getPixelsBelowLines, getPixelsInsideWrap, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRightMargin, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTabs, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getTopMargin, getToplevel, getVadjustment, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisibleRect, getVisual, getVscrollPolicy, getWindow, getWindowType, getWrapMode.

Setters

setAccelPath, setAcceptsTab, setAllocation, setAppPaintable, setBorderWidth, setBorderWindowSize, setBottomMargin, setBuffer, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setCursorVisible, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEditable, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHadjustment, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHscrollPolicy, setIndent, setInputHints, setInputPurpose, setJustification, setLeftMargin, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMonospace, setName, setNoShowAll, setOpacity, setOverwrite, setParent, setParentWindow, setPixelsAboveLines, setPixelsBelowLines, setPixelsInsideWrap, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setRightMargin, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTabs, setTooltipMarkup, setTooltipText, setTooltipWindow, setTopMargin, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setVscrollPolicy, setWindow, setWrapMode.

addChildAtAnchor

textViewAddChildAtAnchor

Arguments

:: (HasCallStack, MonadIO m, IsTextView a, IsWidget b, IsTextChildAnchor c)

=> a

textView: a TextView

-> b

child: a Widget

-> c

anchor: a TextChildAnchor in the TextBuffer for textView

-> m ()

Adds a child widget in the text buffer, at the given anchor.

addChildInWindow

textViewAddChildInWindow

Arguments

:: (HasCallStack, MonadIO m, IsTextView a, IsWidget b)

=> a

textView: a TextView

-> b

child: a Widget

-> TextWindowType

whichWindow: which window the child should appear in

-> Int32

xpos: X position of child in window coordinates

-> Int32

ypos: Y position of child in window coordinates

-> m ()

Adds a child at fixed coordinates in one of the text widget's windows.

The window must have nonzero size (see textViewSetBorderWindowSize). 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.

backwardDisplayLine

textViewBackwardDisplayLine

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextIter

iter: a TextIter

-> m Bool

Returns: True if iter was moved and is not on the end iterator

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 TextBuffer.

backwardDisplayLineStart

textViewBackwardDisplayLineStart

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextIter

iter: a TextIter

-> m Bool

Returns: True if iter was moved and is not on the end iterator

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 TextBuffer.

bufferToWindowCoords

textViewBufferToWindowCoords

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextWindowType

win: a TextWindowType, except TextWindowTypePrivate

-> Int32

bufferX: buffer x coordinate

-> Int32

bufferY: buffer y coordinate

-> m (Int32, Int32)

Converts coordinate (bufferX, bufferY) to coordinates for the window win, and stores the result in (windowX, windowY).

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

forwardDisplayLine

textViewForwardDisplayLine

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextIter

iter: a TextIter

-> m Bool

Returns: True if iter was moved and is not on the end iterator

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 TextBuffer.

forwardDisplayLineEnd

textViewForwardDisplayLineEnd

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextIter

iter: a TextIter

-> m Bool

Returns: True if iter was moved and is not on the end iterator

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 TextBuffer.

getAcceptsTab

textViewGetAcceptsTab

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: A TextView

-> m Bool

Returns: True if pressing the Tab key inserts a tab character, False if pressing the Tab key moves the keyboard focus.

Returns whether pressing the Tab key inserts a tab characters. textViewSetAcceptsTab.

Since: 2.4

getBorderWindowSize

textViewGetBorderWindowSize

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextWindowType

type: window to return size from

-> m Int32

Returns: width of window

Gets the width of the specified border window. See textViewSetBorderWindowSize.

getBottomMargin

textViewGetBottomMargin

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Int32

Returns: bottom margin in pixels

Gets the bottom margin for text in the textView.

Since: 3.18

getBuffer

textViewGetBuffer

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m TextBuffer

Returns: a TextBuffer

Returns the TextBuffer 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.

getCursorLocations

textViewGetCursorLocations

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Maybe TextIter

iter: a TextIter

-> m (Rectangle, Rectangle)

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 Nothing, 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 textViewBufferToWindowCoords to convert these coordinates to coordinates for one of the windows in the text view.

Since: 3.0

getCursorVisible

textViewGetCursorVisible

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Bool

Returns: whether the insertion mark is visible

Find out whether the cursor should be displayed.

getDefaultAttributes

textViewGetDefaultAttributes

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m TextAttributes

Returns: a new TextAttributes

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 textIterGetAttributes 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 textAttributesUnref.

getEditable

textViewGetEditable

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Bool

Returns: whether text is editable by default

Returns the default editability of the TextView. Tags in the buffer may override this setting for some ranges of text.

getHadjustment

textViewGetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Adjustment

Returns: pointer to the horizontal Adjustment

Deprecated: (Since version 3.0)Use scrollableGetHadjustment

Gets the horizontal-scrolling Adjustment.

Since: 2.22

getIndent

textViewGetIndent

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Int32

Returns: number of pixels of indentation

Gets the default indentation of paragraphs in textView. Tags in the view’s buffer may override the default. The indentation may be negative.

getInputHints

textViewGetInputHints

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m [InputHints]

Gets the value of the TextView:inputHints property.

Since: 3.6

getInputPurpose

textViewGetInputPurpose

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m InputPurpose

Gets the value of the TextView:inputPurpose property.

Since: 3.6

getIterAtLocation

textViewGetIterAtLocation

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

x: x position, in buffer coordinates

-> Int32

y: y position, in buffer coordinates

-> m (Bool, TextIter)

Returns: True if the position is over text

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 textViewWindowToBufferCoords.

getIterAtPosition

textViewGetIterAtPosition

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

x: x position, in buffer coordinates

-> Int32

y: y position, in buffer coordinates

-> m (Bool, TextIter, Int32)

Returns: True if the position is over text

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 textViewWindowToBufferCoords.

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

Since: 2.6

getIterLocation

textViewGetIterLocation

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextIter

iter: a TextIter

-> m Rectangle

Gets a rectangle which roughly contains the character at iter. The rectangle position is in buffer coordinates; use textViewBufferToWindowCoords to convert these coordinates to coordinates for one of the windows in the text view.

getJustification

textViewGetJustification

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Justification

Returns: default justification

Gets the default justification of paragraphs in textView. Tags in the buffer may override the default.

getLeftMargin

textViewGetLeftMargin

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Int32

Returns: left margin in pixels

Gets the default left margin size of paragraphs in the textView. Tags in the buffer may override the default.

getLineAtY

textViewGetLineAtY

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

y: a y coordinate

-> m (TextIter, Int32)

Gets the TextIter at the start of the line containing the coordinate y. y is in buffer coordinates, convert from window coordinates with textViewWindowToBufferCoords. If non-Nothing, lineTop will be filled with the coordinate of the top edge of the line.

getLineYrange

textViewGetLineYrange

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextIter

iter: a TextIter

-> m (Int32, Int32)

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 textViewBufferToWindowCoords.

getMonospace

textViewGetMonospace

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Bool

Returns: True if monospace fonts are desired

Gets the value of the TextView:monospace property.

Since: 3.16

getOverwrite

textViewGetOverwrite

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Bool

Returns: whether textView is in overwrite mode or not.

Returns whether the TextView is in overwrite mode or not.

Since: 2.4

getPixelsAboveLines

textViewGetPixelsAboveLines

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Int32

Returns: default number of pixels above paragraphs

Gets the default number of pixels to put above paragraphs. Adding this function with textViewGetPixelsBelowLines is equal to the line space between each paragraph.

getPixelsBelowLines

textViewGetPixelsBelowLines

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Int32

Returns: default number of blank pixels below paragraphs

Gets the value set by textViewSetPixelsBelowLines.

The line space is the sum of the value returned by this function and the value returned by textViewGetPixelsAboveLines.

getPixelsInsideWrap

textViewGetPixelsInsideWrap

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Int32

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

Gets the value set by textViewSetPixelsInsideWrap.

getRightMargin

textViewGetRightMargin

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Int32

Returns: right margin in pixels

Gets the default right margin for text in textView. Tags in the buffer may override the default.

getTabs

textViewGetTabs

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m (Maybe TabArray)

Returns: copy of default tab array, or Nothing if “standard" tabs are used; must be freed with tabArrayFree.

Gets the default tabs for textView. Tags in the buffer may override the defaults. The returned array will be Nothing if “standard” (8-space) tabs are used. Free the return value with tabArrayFree.

getTopMargin

textViewGetTopMargin

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Int32

Returns: top margin in pixels

Gets the top margin for text in the textView.

Since: 3.18

getVadjustment

textViewGetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Adjustment

Returns: pointer to the vertical Adjustment

Deprecated: (Since version 3.0)Use scrollableGetVadjustment

Gets the vertical-scrolling Adjustment.

Since: 2.22

getVisibleRect

textViewGetVisibleRect

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Rectangle

Fills visibleRect with the currently-visible region of the buffer, in buffer coordinates. Convert to window coordinates with textViewBufferToWindowCoords.

getWindow

textViewGetWindow

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextWindowType

win: window to get

-> m (Maybe Window)

Returns: a Window, or Nothing

Retrieves the Window 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 Nothing and nonexistent if their width or height is 0, and are nonexistent before the widget has been realized.

getWindowType

textViewGetWindowType

Arguments

:: (HasCallStack, MonadIO m, IsTextView a, IsWindow b)

=> a

textView: a TextView

-> b

window: a window type

-> m TextWindowType

Returns: the window type.

Usually used to find out which window an event corresponds to.

If you connect to an event signal on textView, this function should be called on event->window to see which window it was.

getWrapMode

textViewGetWrapMode

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m WrapMode

Returns: the line wrap setting

Gets the line wrapping for the view.

imContextFilterKeypress

textViewImContextFilterKeypress

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> EventKey

event: the key event

-> m Bool

Returns: True if the input method handled the key event.

Allow the TextView 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 iMContextFilterKeypress.

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 TextView.

C code

static gboolean
gtk_foo_bar_key_press_event (GtkWidget   *widget,
                             GdkEventKey *event)
{
  guint keyval;

  gdk_event_get_keyval ((GdkEvent*)event, &keyval);

  if (keyval == GDK_KEY_Return || keyval == GDK_KEY_KP_Enter)
    {
      if (gtk_text_view_im_context_filter_keypress (GTK_TEXT_VIEW (widget), event))
        return TRUE;
    }

  // Do some stuff

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

Since: 2.22

moveChild

textViewMoveChild

Arguments

:: (HasCallStack, MonadIO m, IsTextView a, IsWidget b)

=> a

textView: a TextView

-> b

child: child widget already added to the text view

-> Int32

xpos: new X position in window coordinates

-> Int32

ypos: new Y position in window coordinates

-> m ()

Updates the position of a child, as for textViewAddChildInWindow.

moveMarkOnscreen

textViewMoveMarkOnscreen

Arguments

:: (HasCallStack, MonadIO m, IsTextView a, IsTextMark b)

=> a

textView: a TextView

-> b

mark: a TextMark

-> m Bool

Returns: True if the mark moved (wasn’t already onscreen)

Moves a mark within the buffer so that it's located within the currently-visible text area.

moveVisually

textViewMoveVisually

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextIter

iter: a TextIter

-> Int32

count: number of characters to move (negative moves left, positive moves right)

-> m Bool

Returns: True if iter moved and is not on the end iterator

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.

new

textViewNew

Arguments

:: (HasCallStack, MonadIO m)

=> m TextView

Returns: a new TextView

Creates a new TextView. If you don’t call textViewSetBuffer before using the text view, an empty default buffer will be created for you. Get the buffer with textViewGetBuffer. If you want to specify your own buffer, consider textViewNewWithBuffer.

newWithBuffer

textViewNewWithBuffer

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> m TextView

Returns: a new TextView.

Creates a new TextView widget displaying the buffer buffer. One buffer can be shared among many widgets. buffer may be Nothing to create a default buffer, in which case this function is equivalent to textViewNew. The text view adds its own reference count to the buffer; it does not take over an existing reference.

placeCursorOnscreen

textViewPlaceCursorOnscreen

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m Bool

Returns: True if the cursor had to be moved.

Moves the cursor to the currently visible region of the buffer, it it isn’t there already.

resetCursorBlink

textViewResetCursorBlink

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m ()

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 Widget::keyPressEvent handler).

Since: 3.20

resetImContext

textViewResetImContext

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> m ()

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

scrollMarkOnscreen

textViewScrollMarkOnscreen

Arguments

:: (HasCallStack, MonadIO m, IsTextView a, IsTextMark b)

=> a

textView: a TextView

-> b

mark: a mark in the buffer for textView

-> m ()

Scrolls textView the minimum distance such that mark is contained within the visible area of the widget.

scrollToIter

textViewScrollToIter

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextIter

iter: a TextIter

-> 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

-> m Bool

Returns: True if scrolling occurred

Scrolls textView 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 useAlign 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 withinMargin.

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 textViewScrollToMark which saves a point to be scrolled to after line validation.

scrollToMark

textViewScrollToMark

Arguments

:: (HasCallStack, MonadIO m, IsTextView a, IsTextMark b)

=> a

textView: a TextView

-> b

mark: a TextMark

-> 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

-> m ()

Scrolls textView 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 useAlign 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 withinMargin.

setAcceptsTab

textViewSetAcceptsTab

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: A TextView

-> Bool

acceptsTab: True if pressing the Tab key should insert a tab character, False, if pressing the Tab key should move the keyboard focus.

-> m ()

Sets the behavior of the text widget when the Tab key is pressed. If acceptsTab is True, a tab character is inserted. If acceptsTab is False the keyboard focus is moved to the next widget in the focus chain.

Since: 2.4

setBorderWindowSize

textViewSetBorderWindowSize

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextWindowType

type: window to affect

-> Int32

size: width or height of the window

-> m ()

Sets the width of TextWindowTypeLeft or TextWindowTypeRight, or the height of TextWindowTypeTop or TextWindowTypeBottom. 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”, and it won’t work with TextWindowTypeWidget, TextWindowTypeText, or TextWindowTypePrivate.

setBottomMargin

textViewSetBottomMargin

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

bottomMargin: bottom margin in pixels

-> m ()

Sets the bottom margin for text in textView.

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

Since: 3.18

setBuffer

textViewSetBuffer

Arguments

:: (HasCallStack, MonadIO m, IsTextView a, IsTextBuffer b)

=> a

textView: a TextView

-> Maybe b

buffer: a TextBuffer

-> m ()

Sets buffer as the buffer being displayed by textView. 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; TextView will not “adopt” it.

setCursorVisible

textViewSetCursorVisible

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Bool

setting: whether to show the insertion cursor

-> m ()

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 Settings:gtk-keynave-use-caret settings.

setEditable

textViewSetEditable

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Bool

setting: whether it’s editable

-> m ()

Sets the default editability of the TextView. You can override this default setting with tags in the buffer, using the “editable” attribute of tags.

setIndent

textViewSetIndent

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

indent: indentation in pixels

-> m ()

Sets the default indentation for paragraphs in textView. Tags in the buffer may override the default.

setInputHints

textViewSetInputHints

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> [InputHints]

hints: the hints

-> m ()

Sets the TextView:inputHints property, which allows input methods to fine-tune their behaviour.

Since: 3.6

setInputPurpose

textViewSetInputPurpose

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> InputPurpose

purpose: the purpose

-> m ()

Sets the TextView:inputPurpose property which can be used by on-screen keyboards and other input methods to adjust their behaviour.

Since: 3.6

setJustification

textViewSetJustification

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Justification

justification: justification

-> m ()

Sets the default justification of text in textView. Tags in the view’s buffer may override the default.

setLeftMargin

textViewSetLeftMargin

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

leftMargin: left margin in pixels

-> m ()

Sets the default left margin for text in textView. Tags in the buffer may override the default.

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

setMonospace

textViewSetMonospace

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Bool

monospace: True to request monospace styling

-> m ()

Sets the TextView:monospace property, which indicates that the text view should use monospace fonts.

Since: 3.16

setOverwrite

textViewSetOverwrite

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Bool

overwrite: True to turn on overwrite mode, False to turn it off

-> m ()

Changes the TextView overwrite mode.

Since: 2.4

setPixelsAboveLines

textViewSetPixelsAboveLines

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

pixelsAboveLines: pixels above paragraphs

-> m ()

Sets the default number of blank pixels above paragraphs in textView. Tags in the buffer for textView may override the defaults.

setPixelsBelowLines

textViewSetPixelsBelowLines

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

pixelsBelowLines: pixels below paragraphs

-> m ()

Sets the default number of pixels of blank space to put below paragraphs in textView. May be overridden by tags applied to textView’s buffer.

setPixelsInsideWrap

textViewSetPixelsInsideWrap

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

pixelsInsideWrap: default number of pixels between wrapped lines

-> m ()

Sets the default number of pixels of blank space to leave between display/wrapped lines within a paragraph. May be overridden by tags in textView’s buffer.

setRightMargin

textViewSetRightMargin

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

rightMargin: right margin in pixels

-> m ()

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.

setTabs

textViewSetTabs

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TabArray

tabs: tabs as a TabArray

-> m ()

Sets the default tab stops for paragraphs in textView. Tags in the buffer may override the default.

setTopMargin

textViewSetTopMargin

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> Int32

topMargin: top margin in pixels

-> m ()

Sets the top margin for text in textView.

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

Since: 3.18

setWrapMode

textViewSetWrapMode

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> WrapMode

wrapMode: a WrapMode

-> m ()

Sets the line wrapping for the view.

startsDisplayLine

textViewStartsDisplayLine

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextIter

iter: a TextIter

-> m Bool

Returns: True if iter begins a wrapped line

Determines whether iter is at the start of a display line. See textViewForwardDisplayLine for an explanation of display lines vs. paragraphs.

windowToBufferCoords

textViewWindowToBufferCoords

Arguments

:: (HasCallStack, MonadIO m, IsTextView a)

=> a

textView: a TextView

-> TextWindowType

win: a TextWindowType except TextWindowTypePrivate

-> Int32

windowX: window x coordinate

-> Int32

windowY: window y coordinate

-> m (Int32, Int32)

Converts coordinates on the window identified by win to buffer coordinates, storing the result in (bufferX,bufferY).

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

Properties

acceptsTab

No description available in the introspection data.

constructTextViewAcceptsTab :: (IsTextView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “accepts-tab” property. This is rarely needed directly, but it is used by new.

getTextViewAcceptsTab :: (MonadIO m, IsTextView o) => o -> m Bool

Get the value of the “accepts-tab” property. When overloading is enabled, this is equivalent to

get textView #acceptsTab

setTextViewAcceptsTab :: (MonadIO m, IsTextView o) => o -> Bool -> m ()

Set the value of the “accepts-tab” property. When overloading is enabled, this is equivalent to

set textView [ #acceptsTab := value ]

bottomMargin

The bottom margin for text in the text view.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don't confuse this property with Widget:marginBottom.

Since: 3.18

constructTextViewBottomMargin :: (IsTextView o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “bottom-margin” property. This is rarely needed directly, but it is used by new.

getTextViewBottomMargin :: (MonadIO m, IsTextView o) => o -> m Int32

Get the value of the “bottom-margin” property. When overloading is enabled, this is equivalent to

get textView #bottomMargin

setTextViewBottomMargin :: (MonadIO m, IsTextView o) => o -> Int32 -> m ()

Set the value of the “bottom-margin” property. When overloading is enabled, this is equivalent to

set textView [ #bottomMargin := value ]

buffer

No description available in the introspection data.

clearTextViewBuffer :: (MonadIO m, IsTextView o) => o -> m ()

Set the value of the “buffer” property to Nothing. When overloading is enabled, this is equivalent to

clear #buffer

constructTextViewBuffer :: (IsTextView o, MonadIO m, IsTextBuffer a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “buffer” property. This is rarely needed directly, but it is used by new.

getTextViewBuffer :: (MonadIO m, IsTextView o) => o -> m TextBuffer

Get the value of the “buffer” property. When overloading is enabled, this is equivalent to

get textView #buffer

setTextViewBuffer :: (MonadIO m, IsTextView o, IsTextBuffer a) => o -> a -> m ()

Set the value of the “buffer” property. When overloading is enabled, this is equivalent to

set textView [ #buffer := value ]

cursorVisible

No description available in the introspection data.

constructTextViewCursorVisible :: (IsTextView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “cursor-visible” property. This is rarely needed directly, but it is used by new.

getTextViewCursorVisible :: (MonadIO m, IsTextView o) => o -> m Bool

Get the value of the “cursor-visible” property. When overloading is enabled, this is equivalent to

get textView #cursorVisible

setTextViewCursorVisible :: (MonadIO m, IsTextView o) => o -> Bool -> m ()

Set the value of the “cursor-visible” property. When overloading is enabled, this is equivalent to

set textView [ #cursorVisible := value ]

editable

No description available in the introspection data.

constructTextViewEditable :: (IsTextView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “editable” property. This is rarely needed directly, but it is used by new.

getTextViewEditable :: (MonadIO m, IsTextView o) => o -> m Bool

Get the value of the “editable” property. When overloading is enabled, this is equivalent to

get textView #editable

setTextViewEditable :: (MonadIO m, IsTextView o) => o -> Bool -> m ()

Set the value of the “editable” property. When overloading is enabled, this is equivalent to

set textView [ #editable := value ]

imModule

Which IM (input method) module should be used for this text_view. See IMContext.

Setting this to a non-Nothing value overrides the system-wide IM module setting. See the GtkSettings Settings:gtkImModule property.

Since: 2.16

clearTextViewImModule :: (MonadIO m, IsTextView o) => o -> m ()

Set the value of the “im-module” property to Nothing. When overloading is enabled, this is equivalent to

clear #imModule

constructTextViewImModule :: (IsTextView o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “im-module” property. This is rarely needed directly, but it is used by new.

getTextViewImModule :: (MonadIO m, IsTextView o) => o -> m (Maybe Text)

Get the value of the “im-module” property. When overloading is enabled, this is equivalent to

get textView #imModule

setTextViewImModule :: (MonadIO m, IsTextView o) => o -> Text -> m ()

Set the value of the “im-module” property. When overloading is enabled, this is equivalent to

set textView [ #imModule := value ]

indent

No description available in the introspection data.

constructTextViewIndent :: (IsTextView o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “indent” property. This is rarely needed directly, but it is used by new.

getTextViewIndent :: (MonadIO m, IsTextView o) => o -> m Int32

Get the value of the “indent” property. When overloading is enabled, this is equivalent to

get textView #indent

setTextViewIndent :: (MonadIO m, IsTextView o) => o -> Int32 -> m ()

Set the value of the “indent” property. When overloading is enabled, this is equivalent to

set textView [ #indent := value ]

inputHints

Additional hints (beyond TextView:inputPurpose) that allow input methods to fine-tune their behaviour.

Since: 3.6

constructTextViewInputHints :: (IsTextView o, MonadIO m) => [InputHints] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “input-hints” property. This is rarely needed directly, but it is used by new.

getTextViewInputHints :: (MonadIO m, IsTextView o) => o -> m [InputHints]

Get the value of the “input-hints” property. When overloading is enabled, this is equivalent to

get textView #inputHints

setTextViewInputHints :: (MonadIO m, IsTextView o) => o -> [InputHints] -> m ()

Set the value of the “input-hints” property. When overloading is enabled, this is equivalent to

set textView [ #inputHints := value ]

inputPurpose

The purpose of this text field.

This property can be used by on-screen keyboards and other input methods to adjust their behaviour.

Since: 3.6

constructTextViewInputPurpose :: (IsTextView o, MonadIO m) => InputPurpose -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “input-purpose” property. This is rarely needed directly, but it is used by new.

getTextViewInputPurpose :: (MonadIO m, IsTextView o) => o -> m InputPurpose

Get the value of the “input-purpose” property. When overloading is enabled, this is equivalent to

get textView #inputPurpose

setTextViewInputPurpose :: (MonadIO m, IsTextView o) => o -> InputPurpose -> m ()

Set the value of the “input-purpose” property. When overloading is enabled, this is equivalent to

set textView [ #inputPurpose := value ]

justification

No description available in the introspection data.

constructTextViewJustification :: (IsTextView o, MonadIO m) => Justification -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “justification” property. This is rarely needed directly, but it is used by new.

getTextViewJustification :: (MonadIO m, IsTextView o) => o -> m Justification

Get the value of the “justification” property. When overloading is enabled, this is equivalent to

get textView #justification

setTextViewJustification :: (MonadIO m, IsTextView o) => o -> Justification -> m ()

Set the value of the “justification” property. When overloading is enabled, this is equivalent to

set textView [ #justification := value ]

leftMargin

The default left margin for text in the text view. Tags in the buffer may override the default.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don't confuse this property with Widget:marginLeft.

constructTextViewLeftMargin :: (IsTextView o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “left-margin” property. This is rarely needed directly, but it is used by new.

getTextViewLeftMargin :: (MonadIO m, IsTextView o) => o -> m Int32

Get the value of the “left-margin” property. When overloading is enabled, this is equivalent to

get textView #leftMargin

setTextViewLeftMargin :: (MonadIO m, IsTextView o) => o -> Int32 -> m ()

Set the value of the “left-margin” property. When overloading is enabled, this is equivalent to

set textView [ #leftMargin := value ]

monospace

No description available in the introspection data.

constructTextViewMonospace :: (IsTextView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “monospace” property. This is rarely needed directly, but it is used by new.

getTextViewMonospace :: (MonadIO m, IsTextView o) => o -> m Bool

Get the value of the “monospace” property. When overloading is enabled, this is equivalent to

get textView #monospace

setTextViewMonospace :: (MonadIO m, IsTextView o) => o -> Bool -> m ()

Set the value of the “monospace” property. When overloading is enabled, this is equivalent to

set textView [ #monospace := value ]

overwrite

No description available in the introspection data.

constructTextViewOverwrite :: (IsTextView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “overwrite” property. This is rarely needed directly, but it is used by new.

getTextViewOverwrite :: (MonadIO m, IsTextView o) => o -> m Bool

Get the value of the “overwrite” property. When overloading is enabled, this is equivalent to

get textView #overwrite

setTextViewOverwrite :: (MonadIO m, IsTextView o) => o -> Bool -> m ()

Set the value of the “overwrite” property. When overloading is enabled, this is equivalent to

set textView [ #overwrite := value ]

pixelsAboveLines

No description available in the introspection data.

constructTextViewPixelsAboveLines :: (IsTextView o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pixels-above-lines” property. This is rarely needed directly, but it is used by new.

getTextViewPixelsAboveLines :: (MonadIO m, IsTextView o) => o -> m Int32

Get the value of the “pixels-above-lines” property. When overloading is enabled, this is equivalent to

get textView #pixelsAboveLines

setTextViewPixelsAboveLines :: (MonadIO m, IsTextView o) => o -> Int32 -> m ()

Set the value of the “pixels-above-lines” property. When overloading is enabled, this is equivalent to

set textView [ #pixelsAboveLines := value ]

pixelsBelowLines

No description available in the introspection data.

constructTextViewPixelsBelowLines :: (IsTextView o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pixels-below-lines” property. This is rarely needed directly, but it is used by new.

getTextViewPixelsBelowLines :: (MonadIO m, IsTextView o) => o -> m Int32

Get the value of the “pixels-below-lines” property. When overloading is enabled, this is equivalent to

get textView #pixelsBelowLines

setTextViewPixelsBelowLines :: (MonadIO m, IsTextView o) => o -> Int32 -> m ()

Set the value of the “pixels-below-lines” property. When overloading is enabled, this is equivalent to

set textView [ #pixelsBelowLines := value ]

pixelsInsideWrap

No description available in the introspection data.

constructTextViewPixelsInsideWrap :: (IsTextView o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pixels-inside-wrap” property. This is rarely needed directly, but it is used by new.

getTextViewPixelsInsideWrap :: (MonadIO m, IsTextView o) => o -> m Int32

Get the value of the “pixels-inside-wrap” property. When overloading is enabled, this is equivalent to

get textView #pixelsInsideWrap

setTextViewPixelsInsideWrap :: (MonadIO m, IsTextView o) => o -> Int32 -> m ()

Set the value of the “pixels-inside-wrap” property. When overloading is enabled, this is equivalent to

set textView [ #pixelsInsideWrap := value ]

populateAll

If :populate-all is True, the TextView::populatePopup signal is also emitted for touch popups.

Since: 3.8

constructTextViewPopulateAll :: (IsTextView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “populate-all” property. This is rarely needed directly, but it is used by new.

getTextViewPopulateAll :: (MonadIO m, IsTextView o) => o -> m Bool

Get the value of the “populate-all” property. When overloading is enabled, this is equivalent to

get textView #populateAll

setTextViewPopulateAll :: (MonadIO m, IsTextView o) => o -> Bool -> m ()

Set the value of the “populate-all” property. When overloading is enabled, this is equivalent to

set textView [ #populateAll := value ]

rightMargin

The default right margin for text in the text view. Tags in the buffer may override the default.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don't confuse this property with Widget:marginRight.

constructTextViewRightMargin :: (IsTextView o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “right-margin” property. This is rarely needed directly, but it is used by new.

getTextViewRightMargin :: (MonadIO m, IsTextView o) => o -> m Int32

Get the value of the “right-margin” property. When overloading is enabled, this is equivalent to

get textView #rightMargin

setTextViewRightMargin :: (MonadIO m, IsTextView o) => o -> Int32 -> m ()

Set the value of the “right-margin” property. When overloading is enabled, this is equivalent to

set textView [ #rightMargin := value ]

tabs

No description available in the introspection data.

constructTextViewTabs :: (IsTextView o, MonadIO m) => TabArray -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “tabs” property. This is rarely needed directly, but it is used by new.

getTextViewTabs :: (MonadIO m, IsTextView o) => o -> m (Maybe TabArray)

Get the value of the “tabs” property. When overloading is enabled, this is equivalent to

get textView #tabs

setTextViewTabs :: (MonadIO m, IsTextView o) => o -> TabArray -> m ()

Set the value of the “tabs” property. When overloading is enabled, this is equivalent to

set textView [ #tabs := value ]

topMargin

The top margin for text in the text view.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don't confuse this property with Widget:marginTop.

Since: 3.18

constructTextViewTopMargin :: (IsTextView o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “top-margin” property. This is rarely needed directly, but it is used by new.

getTextViewTopMargin :: (MonadIO m, IsTextView o) => o -> m Int32

Get the value of the “top-margin” property. When overloading is enabled, this is equivalent to

get textView #topMargin

setTextViewTopMargin :: (MonadIO m, IsTextView o) => o -> Int32 -> m ()

Set the value of the “top-margin” property. When overloading is enabled, this is equivalent to

set textView [ #topMargin := value ]

wrapMode

No description available in the introspection data.

constructTextViewWrapMode :: (IsTextView o, MonadIO m) => WrapMode -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “wrap-mode” property. This is rarely needed directly, but it is used by new.

getTextViewWrapMode :: (MonadIO m, IsTextView o) => o -> m WrapMode

Get the value of the “wrap-mode” property. When overloading is enabled, this is equivalent to

get textView #wrapMode

setTextViewWrapMode :: (MonadIO m, IsTextView o) => o -> WrapMode -> m ()

Set the value of the “wrap-mode” property. When overloading is enabled, this is equivalent to

set textView [ #wrapMode := value ]

Signals

backspace

type TextViewBackspaceCallback = IO ()

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.

afterTextViewBackspace :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewBackspaceCallback) -> m SignalHandlerId

Connect a signal handler for the backspace signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #backspace callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewBackspace :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewBackspaceCallback) -> m SignalHandlerId

Connect a signal handler for the backspace signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #backspace callback

copyClipboard

type TextViewCopyClipboardCallback = IO ()

The copyClipboard 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.

afterTextViewCopyClipboard :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewCopyClipboardCallback) -> m SignalHandlerId

Connect a signal handler for the copyClipboard signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #copyClipboard callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewCopyClipboard :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewCopyClipboardCallback) -> m SignalHandlerId

Connect a signal handler for the copyClipboard signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #copyClipboard callback

cutClipboard

type TextViewCutClipboardCallback = IO ()

The cutClipboard 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.

afterTextViewCutClipboard :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewCutClipboardCallback) -> m SignalHandlerId

Connect a signal handler for the cutClipboard signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #cutClipboard callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewCutClipboard :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewCutClipboardCallback) -> m SignalHandlerId

Connect a signal handler for the cutClipboard signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #cutClipboard callback

deleteFromCursor

type TextViewDeleteFromCursorCallback

Arguments

 = DeleteType

type: the granularity of the deletion, as a DeleteType

-> Int32

count: the number of type units to delete

-> IO ()

The deleteFromCursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a text deletion.

If the type is DeleteTypeChars, 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.

afterTextViewDeleteFromCursor :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewDeleteFromCursorCallback) -> m SignalHandlerId

Connect a signal handler for the deleteFromCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #deleteFromCursor callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewDeleteFromCursor :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewDeleteFromCursorCallback) -> m SignalHandlerId

Connect a signal handler for the deleteFromCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #deleteFromCursor callback

extendSelection

type TextViewExtendSelectionCallback

Arguments

 = TextExtendSelection

granularity: the granularity type

-> TextIter

location: the location where to extend the selection

-> TextIter

start: where the selection should start

-> TextIter

end: where the selection should end

-> IO Bool

Returns: EVENT_STOP to stop other handlers from being invoked for the event. EVENT_PROPAGATE to propagate the event further.

The extendSelection signal is emitted when the selection needs to be extended at location.

Since: 3.16

afterTextViewExtendSelection :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewExtendSelectionCallback) -> m SignalHandlerId

Connect a signal handler for the extendSelection signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #extendSelection callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewExtendSelection :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewExtendSelectionCallback) -> m SignalHandlerId

Connect a signal handler for the extendSelection signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #extendSelection callback

insertAtCursor

type TextViewInsertAtCursorCallback

Arguments

 = Text

string: the string to insert

-> IO ()

The insertAtCursor 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.

afterTextViewInsertAtCursor :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewInsertAtCursorCallback) -> m SignalHandlerId

Connect a signal handler for the insertAtCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #insertAtCursor callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewInsertAtCursor :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewInsertAtCursorCallback) -> m SignalHandlerId

Connect a signal handler for the insertAtCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #insertAtCursor callback

insertEmoji

type TextViewInsertEmojiCallback = IO ()

The insertEmoji signal is a [keybinding signal][GtkBindingSignal] which gets emitted to present the Emoji chooser for the textView.

The default bindings for this signal are Ctrl-. and Ctrl-;

Since: 3.22.27

afterTextViewInsertEmoji :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewInsertEmojiCallback) -> m SignalHandlerId

Connect a signal handler for the insertEmoji signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #insertEmoji callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewInsertEmoji :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewInsertEmojiCallback) -> m SignalHandlerId

Connect a signal handler for the insertEmoji signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #insertEmoji callback

moveCursor

type TextViewMoveCursorCallback

Arguments

 = MovementStep

step: the granularity of the move, as a MovementStep

-> Int32

count: the number of step units to move

-> Bool

extendSelection: True if the move should extend the selection

-> IO ()

The moveCursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement. If the cursor is not visible in textView, 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

afterTextViewMoveCursor :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewMoveCursorCallback) -> m SignalHandlerId

Connect a signal handler for the moveCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #moveCursor callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewMoveCursor :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewMoveCursorCallback) -> m SignalHandlerId

Connect a signal handler for the moveCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #moveCursor callback

moveViewport

type TextViewMoveViewportCallback

Arguments

 = ScrollStep

step: the granularity of the movement, as a ScrollStep

-> Int32

count: the number of step units to move

-> IO ()

The moveViewport 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.

afterTextViewMoveViewport :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewMoveViewportCallback) -> m SignalHandlerId

Connect a signal handler for the moveViewport signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #moveViewport callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewMoveViewport :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewMoveViewportCallback) -> m SignalHandlerId

Connect a signal handler for the moveViewport signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #moveViewport callback

pasteClipboard

type TextViewPasteClipboardCallback = IO ()

The pasteClipboard 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.

afterTextViewPasteClipboard :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewPasteClipboardCallback) -> m SignalHandlerId

Connect a signal handler for the pasteClipboard signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #pasteClipboard callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewPasteClipboard :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewPasteClipboardCallback) -> m SignalHandlerId

Connect a signal handler for the pasteClipboard signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #pasteClipboard callback

populatePopup

type TextViewPopulatePopupCallback

Arguments

 = Widget

popup: the container that is being populated

-> IO ()

The populatePopup 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 Menu in this case.

If TextView:populateAll is True, this signal will also be emitted to populate touch popups. In this case, popup will be a different container, e.g. a Toolbar.

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

afterTextViewPopulatePopup :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewPopulatePopupCallback) -> m SignalHandlerId

Connect a signal handler for the populatePopup signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #populatePopup callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewPopulatePopup :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewPopulatePopupCallback) -> m SignalHandlerId

Connect a signal handler for the populatePopup signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #populatePopup callback

preeditChanged

type TextViewPreeditChangedCallback

Arguments

 = Text

preedit: the current preedit string

-> IO ()

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.

Since: 2.20

afterTextViewPreeditChanged :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewPreeditChangedCallback) -> m SignalHandlerId

Connect a signal handler for the preeditChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #preeditChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewPreeditChanged :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewPreeditChangedCallback) -> m SignalHandlerId

Connect a signal handler for the preeditChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #preeditChanged callback

selectAll

type TextViewSelectAllCallback

Arguments

 = Bool

select: True to select, False to unselect

-> IO ()

The selectAll 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.

afterTextViewSelectAll :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewSelectAllCallback) -> m SignalHandlerId

Connect a signal handler for the selectAll signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #selectAll callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewSelectAll :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewSelectAllCallback) -> m SignalHandlerId

Connect a signal handler for the selectAll signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #selectAll callback

setAnchor

type TextViewSetAnchorCallback = IO ()

The setAnchor 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.

afterTextViewSetAnchor :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewSetAnchorCallback) -> m SignalHandlerId

Connect a signal handler for the setAnchor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #setAnchor callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewSetAnchor :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewSetAnchorCallback) -> m SignalHandlerId

Connect a signal handler for the setAnchor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #setAnchor callback

toggleCursorVisible

type TextViewToggleCursorVisibleCallback = IO ()

The toggleCursorVisible signal is a [keybinding signal][GtkBindingSignal] which gets emitted to toggle the TextView:cursorVisible property.

The default binding for this signal is F7.

afterTextViewToggleCursorVisible :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewToggleCursorVisibleCallback) -> m SignalHandlerId

Connect a signal handler for the toggleCursorVisible signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #toggleCursorVisible callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewToggleCursorVisible :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewToggleCursorVisibleCallback) -> m SignalHandlerId

Connect a signal handler for the toggleCursorVisible signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #toggleCursorVisible callback

toggleOverwrite

type TextViewToggleOverwriteCallback = IO ()

The toggleOverwrite 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.

afterTextViewToggleOverwrite :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewToggleOverwriteCallback) -> m SignalHandlerId

Connect a signal handler for the toggleOverwrite signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textView #toggleOverwrite callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onTextViewToggleOverwrite :: (IsTextView a, MonadIO m) => a -> ((?self :: a) => TextViewToggleOverwriteCallback) -> m SignalHandlerId

Connect a signal handler for the toggleOverwrite signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textView #toggleOverwrite callback