TextView

Description You may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together.

class TextView : Container {}

Constructors

this
this(GtkTextView* gtkTextView)

Sets our main struct and passes it to the parent class

this
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().

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

Members

Functions

addChildAtAnchor
void addChildAtAnchor(Widget child, TextChildAnchor anchor)

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

addChildInWindow
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 the GdkWindow in question, and that these coordinates have no sane relationship 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), you'll need to compute the child's correct position in buffer coordinates any time scrolling occurs or buffer changes occur, and then call gtk_text_view_move_child() to update the child's position. Unfortunately there's no good way to detect that scrolling has occurred, using the current API; a possible hack would be to update all child positions when the scroll adjustments change or the text buffer changes. See bug 64518 on bugzilla.gnome.org for status of fixing this issue.

addOnBackspace
void addOnBackspace(void delegate(TextView) dlg, ConnectFlags connectFlags)

The ::backspace signal is a keybinding signal which gets emitted when the user asks for it. The default bindings for this signal are Backspace and Shift-Backspace.

addOnCopyClipboard
void addOnCopyClipboard(void delegate(TextView) dlg, ConnectFlags connectFlags)

The ::copy-clipboard signal is a keybinding signal which gets emitted to copy the selection to the clipboard. The default bindings for this signal are Ctrl-c and Ctrl-Insert.

addOnCutClipboard
void addOnCutClipboard(void delegate(TextView) dlg, ConnectFlags connectFlags)

The ::cut-clipboard signal is a keybinding signal which gets emitted to cut the selection to the clipboard. The default bindings for this signal are Ctrl-x and Shift-Delete.

addOnDeleteFromCursor
void addOnDeleteFromCursor(void delegate(GtkDeleteType, gint, TextView) dlg, ConnectFlags connectFlags)

The ::delete-from-cursor signal is a keybinding signal 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.

addOnInsertAtCursor
void addOnInsertAtCursor(void delegate(string, TextView) dlg, ConnectFlags connectFlags)

The ::insert-at-cursor signal is a keybinding signal which gets emitted when the user initiates the insertion of a fixed string at the cursor. This signal has no default bindings.

addOnMoveCursor
void addOnMoveCursor(void delegate(GtkMovementStep, gint, gboolean, TextView) dlg, ConnectFlags connectFlags)

The ::move-cursor signal is a keybinding signal 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 TRUE if the move should extend the selection

addOnMoveViewport
void addOnMoveViewport(void delegate(GtkScrollStep, gint, TextView) dlg, ConnectFlags connectFlags)

The ::move-viewport signal is a keybinding signal 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.

addOnPageHorizontally
void addOnPageHorizontally(void delegate(gint, gboolean, TextView) dlg, ConnectFlags connectFlags)

The ::page-horizontally signal is a keybinding signal which can be bound to key combinations to allow the user to initiate horizontal cursor movement by pages. This signal should not be used anymore, instead use the "move-cursor" signal with the GTK_MOVEMENT_HORIZONTAL_PAGES granularity. TRUE if the move should extend the selection

addOnPasteClipboard
void addOnPasteClipboard(void delegate(TextView) dlg, ConnectFlags connectFlags)

The ::paste-clipboard signal is a keybinding signal 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.

addOnPopulatePopup
void addOnPopulatePopup(void delegate(GtkMenu*, TextView) dlg, ConnectFlags connectFlags)

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 menuitems to the menu.

addOnPreeditChanged
void addOnPreeditChanged(void delegate(string, TextView) dlg, ConnectFlags connectFlags)

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

addOnSelectAll
void addOnSelectAll(void delegate(gboolean, TextView) dlg, ConnectFlags connectFlags)

The ::select-all signal is a keybinding signal 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. TRUE to select, FALSE to unselect

addOnSetAnchor
void addOnSetAnchor(void delegate(TextView) dlg, ConnectFlags connectFlags)

The ::set-anchor signal is a keybinding signal 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.

addOnSetScrollAdjustments
void addOnSetScrollAdjustments(void delegate(Adjustment, Adjustment, TextView) dlg, ConnectFlags connectFlags)

Set the scroll adjustments for the text view. Usually scrolled containers like GtkScrolledWindow will emit this signal to connect two instances of GtkScrollbar to the scroll directions of the GtkTextView.

addOnToggleCursorVisible
void addOnToggleCursorVisible(void delegate(TextView) dlg, ConnectFlags connectFlags)

The ::toggle-cursor-visible signal is a keybinding signal which gets emitted to toggle the visibility of the cursor. The default binding for this signal is F7.

addOnToggleOverwrite
void addOnToggleOverwrite(void delegate(TextView) dlg, ConnectFlags connectFlags)

The ::toggle-overwrite signal is a keybinding signal which gets emitted to toggle the overwrite mode of the text view. The default bindings for this signal is Insert. See Also GtkTextBuffer, GtkTextIter

appendText
void appendText(string text, bool ensureVisible)

Simply appends some text to this view

backwardDisplayLine
int 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.

backwardDisplayLineStart
int 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.

bufferToWindowCoords
void bufferToWindowCoords(GtkTextWindowType win, int bufferX, int bufferY, int windowX, 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()).

forwardDisplayLine
int 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.

forwardDisplayLineEnd
int 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.

getAcceptsTab
int getAcceptsTab()

Returns whether pressing the Tab key inserts a tab characters. gtk_text_view_set_accepts_tab(). Since 2.4

getBorderWindowSize
int getBorderWindowSize(GtkTextWindowType type)

Gets the width of the specified border window. See gtk_text_view_set_border_window_size().

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

getCursorVisible
int getCursorVisible()

Find out whether the cursor is being displayed.

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

getEditable
int getEditable()

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

getHadjustment
Adjustment getHadjustment()

Gets the horizontal-scrolling GtkAdjustment. Since 2.22

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

getIterAtLocation
void getIterAtLocation(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().

getIterAtPosition
void getIterAtPosition(TextIter iter, 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. Since 2.6

getIterLocation
void getIterLocation(TextIter iter, Rectangle 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.

getJustification
GtkJustification getJustification()

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

getLeftMargin
int getLeftMargin()

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

getLineAtY
void getLineAtY(TextIter targetIter, int y, 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.

getLineTextAt
string getLineTextAt(gint y)

Get the text line at the pixel y

getLineYrange
void getLineYrange(TextIter iter, int y, 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().

getOverwrite
int getOverwrite()

Returns whether the GtkTextView is in overwrite mode or not. Since 2.4

getPixelsAboveLines
int getPixelsAboveLines()

Gets the default number of pixels to put above paragraphs.

getPixelsBelowLines
int getPixelsBelowLines()

Gets the value set by gtk_text_view_set_pixels_below_lines().

getPixelsInsideWrap
int getPixelsInsideWrap()

Gets the value set by gtk_text_view_set_pixels_inside_wrap().

getRightMargin
int getRightMargin()

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

getStruct
void* getStruct()

the main Gtk struct as a void*

getTabs
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().

getTextViewStruct
GtkTextView* getTextViewStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getVadjustment
Adjustment getVadjustment()

Gets the vertical-scrolling GtkAdjustment. Since 2.22

getVisibleRect
void getVisibleRect(Rectangle 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().

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

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

getWrapMode
GtkWrapMode getWrapMode()

Gets the line wrapping for the view.

imContextFilterKeypress
int 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. Since 2.22

insertText
void insertText(string text)

Simply appends some on the cursor position

moveChild
void moveChild(Widget child, int xpos, int ypos)

Updates the position of a child, as for gtk_text_view_add_child_in_window().

moveMarkOnscreen
int moveMarkOnscreen(TextMark mark)

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

moveVisually
int 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.

placeCursorOnscreen
int placeCursorOnscreen()

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

resetImContext
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

scrollMarkOnscreen
void scrollMarkOnscreen(TextMark mark)

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

scrollToIter
int scrollToIter(TextIter iter, double withinMargin, int 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.

scrollToMark
void scrollToMark(TextMark mark, double withinMargin, int 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.

setAcceptsTab
void setAcceptsTab(int 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. Since 2.4

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

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

setCursorVisible
void setCursorVisible(int setting)

Toggles whether the insertion point is displayed. A buffer with no editable text probably shouldn't have a visible cursor, so you may want to turn the cursor off.

setEditable
void setEditable(int 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.

setIndent
void setIndent(int indent)

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

setJustification
void setJustification(GtkJustification justification)

Sets the default justification of text in text_view. Tags in the view's buffer may override the default.

setLeftMargin
void setLeftMargin(int leftMargin)

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

setOverwrite
void setOverwrite(int overwrite)

Changes the GtkTextView overwrite mode. Since 2.4

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

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

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

setRightMargin
void setRightMargin(int rightMargin)

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

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setTabs
void setTabs(PgTabArray tabs)

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

setWrapMode
void setWrapMode(GtkWrapMode wrapMode)

Sets the line wrapping for the view.

startsDisplayLine
int 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.

windowToBufferCoords
void windowToBufferCoords(GtkTextWindowType win, int windowX, int windowY, int bufferX, 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()).

Static functions

callBackBackspace
void callBackBackspace(GtkTextView* textViewStruct, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackCopyClipboard
void callBackCopyClipboard(GtkTextView* textViewStruct, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackCutClipboard
void callBackCutClipboard(GtkTextView* textViewStruct, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackDeleteFromCursor
void callBackDeleteFromCursor(GtkTextView* textViewStruct, GtkDeleteType type, gint count, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackInsertAtCursor
void callBackInsertAtCursor(GtkTextView* textViewStruct, gchar* str, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackMoveCursor
void callBackMoveCursor(GtkTextView* textViewStruct, GtkMovementStep step, gint count, gboolean extendSelection, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackMoveViewport
void callBackMoveViewport(GtkTextView* textViewStruct, GtkScrollStep step, gint count, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackPageHorizontally
void callBackPageHorizontally(GtkTextView* textViewStruct, gint count, gboolean extendSelection, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackPasteClipboard
void callBackPasteClipboard(GtkTextView* textViewStruct, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackPopulatePopup
void callBackPopulatePopup(GtkTextView* entryStruct, GtkMenu* menu, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackPreeditChanged
void callBackPreeditChanged(GtkTextView* textViewStruct, gchar* preedit, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackSelectAll
void callBackSelectAll(GtkTextView* textViewStruct, gboolean select, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackSetAnchor
void callBackSetAnchor(GtkTextView* textViewStruct, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackSetScrollAdjustments
void callBackSetScrollAdjustments(GtkTextView* horizontalStruct, GtkAdjustment* vertical, GtkAdjustment* arg2, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackToggleCursorVisible
void callBackToggleCursorVisible(GtkTextView* textViewStruct, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackToggleOverwrite
void callBackToggleOverwrite(GtkTextView* textViewStruct, TextView _textView)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals
int[string] connectedSignals;
gtkTextView
GtkTextView* gtkTextView;

the main Gtk struct

onBackspaceListeners
void delegate(TextView)[] onBackspaceListeners;
Undocumented in source.
onCopyClipboardListeners
void delegate(TextView)[] onCopyClipboardListeners;
Undocumented in source.
onCutClipboardListeners
void delegate(TextView)[] onCutClipboardListeners;
Undocumented in source.
onDeleteFromCursorListeners
void delegate(GtkDeleteType, gint, TextView)[] onDeleteFromCursorListeners;
Undocumented in source.
onInsertAtCursorListeners
void delegate(string, TextView)[] onInsertAtCursorListeners;
Undocumented in source.
onMoveCursorListeners
void delegate(GtkMovementStep, gint, gboolean, TextView)[] onMoveCursorListeners;
Undocumented in source.
onMoveViewportListeners
void delegate(GtkScrollStep, gint, TextView)[] onMoveViewportListeners;
Undocumented in source.
onPageHorizontallyListeners
void delegate(gint, gboolean, TextView)[] onPageHorizontallyListeners;
Undocumented in source.
onPasteClipboardListeners
void delegate(TextView)[] onPasteClipboardListeners;
Undocumented in source.
onPopulatePopupListeners
void delegate(GtkMenu*, TextView)[] onPopulatePopupListeners;
Undocumented in source.
onPreeditChangedListeners
void delegate(string, TextView)[] onPreeditChangedListeners;
Undocumented in source.
onSelectAllListeners
void delegate(gboolean, TextView)[] onSelectAllListeners;
Undocumented in source.
onSetAnchorListeners
void delegate(TextView)[] onSetAnchorListeners;
Undocumented in source.
onSetScrollAdjustmentsListeners
void delegate(Adjustment, Adjustment, TextView)[] onSetScrollAdjustmentsListeners;
Undocumented in source.
onToggleCursorVisibleListeners
void delegate(TextView)[] onToggleCursorVisibleListeners;
Undocumented in source.
onToggleOverwriteListeners
void delegate(TextView)[] onToggleOverwriteListeners;
Undocumented in source.

Inherited Members

From Container

gtkContainer
GtkContainer* gtkContainer;

the main Gtk struct

getContainerStruct
GtkContainer* getContainerStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
removeAll
void removeAll()

Removes all widgets from the container

connectedSignals
int[string] connectedSignals;
onAddListeners
void delegate(Widget, Container)[] onAddListeners;
Undocumented in source.
addOnAdd
void addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackAdd
void callBackAdd(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onCheckResizeListeners
void delegate(Container)[] onCheckResizeListeners;
Undocumented in source.
addOnCheckResize
void addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
callBackCheckResize
void callBackCheckResize(GtkContainer* containerStruct, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onRemoveListeners
void delegate(Widget, Container)[] onRemoveListeners;
Undocumented in source.
addOnRemove
void addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackRemove
void callBackRemove(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onSetFocusChildListeners
void delegate(Widget, Container)[] onSetFocusChildListeners;
Undocumented in source.
addOnSetFocusChild
void addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackSetFocusChild
void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
add
void add(Widget widget)

Adds widget to container. Typically used for simple containers such as GtkWindow, GtkFrame, or GtkButton; for more complicated layout containers such as GtkBox or GtkTable, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_table_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; you can't place the same widget inside two different containers.

remove
void remove(Widget widget)

Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it while it's not inside a container, using g_object_ref(). If you don't want to use widget again it's usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

getResizeMode
GtkResizeMode getResizeMode()

Returns the resize mode for the container. See gtk_container_set_resize_mode().

setResizeMode
void setResizeMode(GtkResizeMode resizeMode)

Sets the resize mode for the container. The resize mode of a container determines whether a resize request will be passed to the container's parent, queued for later execution or executed immediately.

checkResize
void checkResize()
foreac
void foreac(GtkCallback callback, void* callbackData)

Invokes callback on each non-internal child of container. See gtk_container_forall() for details on what constitutes an "internal" child. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().

foreachFull
void foreachFull(GtkCallback callback, GtkCallbackMarshal marshal, void* callbackData, GDestroyNotify notify)

Warning gtk_container_foreach_full is deprecated and should not be used in newly-written code. Use gtk_container_foreach() instead.

getChildren
ListG getChildren()

Returns the container's non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.

setReallocateRedraws
void setReallocateRedraws(int needsRedraws)

Sets the reallocate_redraws flag of the container to the given value. Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.

getFocusChild
Widget getFocusChild()

Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk_window_get_focus(). Since 2.14

setFocusChild
void setFocusChild(Widget child)

Sets, or unsets if child is NULL, the focused child of container. This function emits the GtkContainer::set_focus_child signal of container. Implementations of GtkContainer can override the default behaviour by overriding the class closure of this signal. This is function is mostly meant to be used by widgets. Applications can use gtk_widget_grab_focus() to manualy set the focus to a specific widget.

getFocusVadjustment
Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().

setFocusVadjustment
void setFocusVadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

getFocusHadjustment
Adjustment getFocusHadjustment()

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment().

setFocusHadjustment
void setFocusHadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

resizeChildren
void resizeChildren()
childType
GType childType()

Returns the type of the children supported by the container. Note that this may return G_TYPE_NONE to indicate that no more children can be added, e.g. for a GtkPaned which already has two children.

childGetProperty
void childGetProperty(Widget child, string propertyName, Value value)

Gets the value of a child property for child and container.

childSetProperty
void childSetProperty(Widget child, string propertyName, Value value)

Sets a child property for child and container.

childGetValist
void childGetValist(Widget child, string firstPropertyName, void* varArgs)

Gets the values of one or more child properties for child and container.

childSetValist
void childSetValist(Widget child, string firstPropertyName, void* varArgs)

Sets one or more child properties for child and container.

forall
void forall(GtkCallback callback, void* callbackData)

Invokes callback on each child of container, including children that are considered "internal" (implementation details of the container). "Internal" children generally weren't added by the user of the container, but were added by the container implementation itself. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().

getBorderWidth
uint getBorderWidth()

Retrieves the border width of the container. See gtk_container_set_border_width().

setBorderWidth
void setBorderWidth(uint borderWidth)

Sets the border width of the container. The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is GtkWindow; because toplevel windows can't leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, one approach is to create a GtkAlignment widget, call gtk_widget_set_size_request() to give it a size, and place it on the side of the container as a spacer.

propagateExpose
void propagateExpose(Widget child, GdkEventExpose* event)

When a container receives an expose event, it must send synthetic expose events to all children that don't have their own GdkWindows. This function provides a convenient way of doing this. A container, when it receives an expose event, calls gtk_container_propagate_expose() once for each child, passing in the event the container received. gtk_container_propagate_expose() takes care of deciding whether an expose event needs to be sent to the child, intersecting the event's area with the child area, and sending the event. In most cases, a container can simply either simply inherit the "expose" implementation from GtkContainer, or, do some drawing and then chain to the ::expose implementation from GtkContainer. Note that the ::expose-event signal has been replaced by a ::draw signal in GTK+ 3, and consequently, gtk_container_propagate_expose() has been replaced by gtk_container_propagate_draw(). The GTK+ 3 migration guide for hints on how to port from ::expose-event to ::draw.

getFocusChain
int getFocusChain(ListG focusableWidgets)

Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores NULL in focusable_widgets and returns FALSE.

setFocusChain
void setFocusChain(ListG focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+. In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it's allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn't always packed. The necessary checks are done when the focus chain is actually traversed.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with gtk_container_set_focus_chain().

classFindChildProperty
ParamSpec classFindChildProperty(GObjectClass* cclass, string propertyName)

Finds a child property of a container class by name.

classInstallChildProperty
void classInstallChildProperty(Container cclass, uint propertyId, ParamSpec pspec)

Installs a child property on a container class.

classListChildProperties
ParamSpec[] classListChildProperties(GObjectClass* cclass)

Returns all child properties of a container class.

Meta