--- name: "Gtk2::TextView" section: "3pm" platform: "linux" package: "libgtk2-perl-doc" version: "2:1.24992-1" release: "Debian 10 (Buster)" platforms: ["linux"] url: "https://new.carta.tech/Gtk2::TextView" --- # Gtk2::TextView(3pm) wrapper for GtkTextView ## NAME Gtk2::TextView - wrapper for GtkTextView ## HIERARCHY ``` Glib::Object +----Glib::InitiallyUnowned +----Gtk2::Object +----Gtk2::Widget +----Gtk2::Container +----Gtk2::TextView ``` ## INTERFACES ``` Glib::Object::_Unregistered::AtkImplementorIface Gtk2::Buildable ``` ## METHODS ### widget = Gtk2::TextView-\>new ### widget = Gtk2::TextView-\>new\_with\_buffer ($buffer) - • `$buffer` (Gtk2::TextBuffer) ### boolean = $text\_view-\>get\_accepts\_tab Since: gtk+ 2.4 ### $text\_view-\>set\_accepts\_tab ($accepts\_tab) - • `$accepts_tab` (boolean) Since: gtk+ 2.4 ### $text\_view-\>add\_child\_at\_anchor ($child, $anchor) - • `$child` (Gtk2::Widget) - • `$anchor` (Gtk2::TextChildAnchor) ### $text\_view-\>add\_child\_in\_window ($child, $which\_window, $xpos, $ypos) - • `$child` (Gtk2::Widget) - • `$which_window` (Gtk2::TextWindowType) - • `$xpos` (integer) - • `$ypos` (integer) ### boolean = $text\_view-\>backward\_display\_line ($iter) - • `$iter` (Gtk2::TextIter) ### boolean = $text\_view-\>backward\_display\_line\_start ($iter) - • `$iter` (Gtk2::TextIter) ### integer = $text\_view-\>get\_border\_window\_size ($type) - • `$type` (Gtk2::TextWindowType) ### $text\_view-\>set\_border\_window\_size ($type, $size) - • `$type` (Gtk2::TextWindowType) - • `$size` (integer) ### textbuffer = $text\_view-\>get\_buffer ### $text\_view-\>set\_buffer ($buffer) - • `$buffer` (Gtk2::TextBuffer) ### (window\_x, window\_y) = $text\_view-\>buffer\_to\_window\_coords ($win, $buffer\_x, $buffer\_y) - • `$win` (Gtk2::TextWindowType) - • `$buffer_x` (integer) - • `$buffer_y` (integer) ### boolean = $text\_view-\>get\_cursor\_visible ### $text\_view-\>set\_cursor\_visible ($setting) - • `$setting` (boolean) ### textattributes = $text\_view-\>get\_default\_attributes ### boolean = $text\_view-\>get\_editable ### $text\_view-\>set\_editable ($setting) - • `$setting` (boolean) ### boolean = $text\_view-\>forward\_display\_line ($iter) - • `$iter` (Gtk2::TextIter) ### boolean = $text\_view-\>forward\_display\_line\_end ($iter) - • `$iter` (Gtk2::TextIter) ### adjustment = $text\_view-\>get\_hadjustment Since: gtk+ 2.22 ### boolean = $text\_view-\>im\_context\_filter\_keypress ($event) - • `$event` (Gtk2::Gdk::Event) Since: gtk+ 2.22 ### integer = $text\_view-\>get\_indent ### $text\_view-\>set\_indent ($indent) - • `$indent` (integer) ### textiter = $text\_view-\>get\_iter\_at\_location ($x, $y) - • `$x` (integer) - • `$y` (integer) ### ($iter, $trailing) = $text\_view-\>get\_iter\_at\_position ($x, $y) ### $iter = $text\_view-\>get\_iter\_at\_position ($x, $y) - • `$x` (integer) - • `$y` (integer) 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 `"$text_view->window_to_buffer_coords()"`. Note that this is different from `"$text_view->get_iter_at_location()"`, which returns cursor locations, i.e. positions between characters. Since: gtk+ 2.6 ### rectangle = $text\_view-\>get\_iter\_location ($iter) - • `$iter` (Gtk2::TextIter) ### justification = $text\_view-\>get\_justification ### $text\_view-\>set\_justification ($justification) - • `$justification` (Gtk2::Justification) ### integer = $text\_view-\>get\_left\_margin ### $text\_view-\>set\_left\_margin ($left\_margin) - • `$left_margin` (integer) ### (target\_iter, line\_top) = $text\_view-\>get\_line\_at\_y ($y) - • `$y` (integer) ### (y, height) = $text\_view-\>get\_line\_yrange ($iter) - • `$iter` (Gtk2::TextIter) ### $text\_view-\>move\_child ($child, $xpos, $ypos) - • `$child` (Gtk2::Widget) - • `$xpos` (integer) - • `$ypos` (integer) ### boolean = $text\_view-\>move\_mark\_onscreen ($mark) - • `$mark` (Gtk2::TextMark) ### boolean = $text\_view-\>move\_visually ($iter, $count) - • `$iter` (Gtk2::TextIter) - • `$count` (integer) ### boolean = $text\_view-\>get\_overwrite Since: gtk+ 2.4 ### $text\_view-\>set\_overwrite ($overwrite) - • `$overwrite` (boolean) Since: gtk+ 2.4 ### integer = $text\_view-\>get\_pixels\_above\_lines ### $text\_view-\>set\_pixels\_above\_lines ($pixels\_above\_lines) - • `$pixels_above_lines` (integer) ### integer = $text\_view-\>get\_pixels\_below\_lines ### $text\_view-\>set\_pixels\_below\_lines ($pixels\_below\_lines) - • `$pixels_below_lines` (integer) ### integer = $text\_view-\>get\_pixels\_inside\_wrap ### $text\_view-\>set\_pixels\_inside\_wrap ($pixels\_inside\_wrap) - • `$pixels_inside_wrap` (integer) ### boolean = $text\_view-\>place\_cursor\_onscreen ### $text\_view-\>reset\_im\_context Since: gtk+ 2.22 ### integer = $text\_view-\>get\_right\_margin ### $text\_view-\>set\_right\_margin ($right\_margin) - • `$right_margin` (integer) ### $text\_view-\>scroll\_mark\_onscreen ($mark) - • `$mark` (Gtk2::TextMark) ### boolean = $text\_view-\>scroll\_to\_iter ($iter, $within\_margin, $use\_align, $xalign, $yalign) - • `$iter` (Gtk2::TextIter) - • `$within_margin` (double) - • `$use_align` (boolean) - • `$xalign` (double) - • `$yalign` (double) ### $text\_view-\>scroll\_to\_mark ($mark, $within\_margin, $use\_align, $xalign, $yalign) - • `$mark` (Gtk2::TextMark) - • `$within_margin` (double) - • `$use_align` (boolean) - • `$xalign` (double) - • `$yalign` (double) ### boolean = $text\_view-\>starts\_display\_line ($iter) - • `$iter` (Gtk2::TextIter) ### tabarray = $text\_view-\>get\_tabs ### $text\_view-\>set\_tabs ($tabs) - • `$tabs` (Pango::TabArray) ### adjustment = $text\_view-\>get\_vadjustment Since: gtk+ 2.22 ### rectangle = $text\_view-\>get\_visible\_rect ### window = $text\_view-\>get\_window ($win) - • `$win` (Gtk2::TextWindowType) ### (buffer\_x, buffer\_y) = $text\_view-\>window\_to\_buffer\_coords ($win, $window\_x, $window\_y) - • `$win` (Gtk2::TextWindowType) - • `$window_x` (integer) - • `$window_y` (integer) ### textwindowtype = $text\_view-\>get\_window\_type ($window) - • `$window` (Gtk2::Gdk::Window) ### wrapmode = $text\_view-\>get\_wrap\_mode ### $text\_view-\>set\_wrap\_mode ($wrap\_mode) - • `$wrap_mode` (Gtk2::WrapMode) ## PROPERTIES - 'accepts-tab' (boolean : default true : readable / writable / private) Whether Tab will result in a tab character being entered - 'buffer' (Gtk2::TextBuffer : default undef : readable / writable / private) The buffer which is displayed - 'cursor-visible' (boolean : default true : readable / writable / private) If the insertion cursor is shown - 'editable' (boolean : default true : readable / writable / private) Whether the text can be modified by the user - 'im-module' (string : default undef : readable / writable / private) Which IM module should be used - 'indent' (integer : default 0 : readable / writable / private) Amount to indent the paragraph, in pixels - 'justification' (Gtk2::Justification : default "left" : readable / writable / private) Left, right, or center justification - 'left-margin' (integer : default 0 : readable / writable / private) Width of the left margin in pixels - 'overwrite' (boolean : default false : readable / writable / private) Whether entered text overwrites existing contents - 'pixels-above-lines' (integer : default 0 : readable / writable / private) Pixels of blank space above paragraphs - 'pixels-below-lines' (integer : default 0 : readable / writable / private) Pixels of blank space below paragraphs - 'pixels-inside-wrap' (integer : default 0 : readable / writable / private) Pixels of blank space between wrapped lines in a paragraph - 'right-margin' (integer : default 0 : readable / writable / private) Width of the right margin in pixels - 'tabs' (Pango::TabArray : default undef : readable / writable / private) Custom tabs for this text - 'wrap-mode' (Gtk2::WrapMode : default "none" : readable / writable / private) Whether to wrap lines never, at word boundaries, or at character boundaries ## STYLE PROPERTIES - 'error-underline-color' (Gtk2::Gdk::Color : default undef : readable / private) Color with which to draw error-indication underlines ## SIGNALS - **backspace** (Gtk2::TextView) - **copy-clipboard** (Gtk2::TextView) - **cut-clipboard** (Gtk2::TextView) - **delete-from-cursor** (Gtk2::TextView, Gtk2::DeleteType, integer) - **insert-at-cursor** (Gtk2::TextView, string) - **move-cursor** (Gtk2::TextView, Gtk2::MovementStep, integer, boolean) - **move-viewport** (Gtk2::TextView, GtkScrollStep, integer) - **page-horizontally** (Gtk2::TextView, integer, boolean) - **paste-clipboard** (Gtk2::TextView) - **populate-popup** (Gtk2::TextView, Gtk2::Menu) - **preedit-changed** (Gtk2::TextView, string) - **select-all** (Gtk2::TextView, boolean) - **set-anchor** (Gtk2::TextView) - **set-scroll-adjustments** (Gtk2::TextView, Gtk2::Adjustment, Gtk2::Adjustment) - **toggle-cursor-visible** (Gtk2::TextView) - **toggle-overwrite** (Gtk2::TextView) ## ENUMS AND FLAGS ### enum Gtk2::DeleteType - • 'chars' / 'GTK\_DELETE\_CHARS' - • 'word-ends' / 'GTK\_DELETE\_WORD\_ENDS' - • 'words' / 'GTK\_DELETE\_WORDS' - • 'display-lines' / 'GTK\_DELETE\_DISPLAY\_LINES' - • 'display-line-ends' / 'GTK\_DELETE\_DISPLAY\_LINE\_ENDS' - • 'paragraph-ends' / 'GTK\_DELETE\_PARAGRAPH\_ENDS' - • 'paragraphs' / 'GTK\_DELETE\_PARAGRAPHS' - • 'whitespace' / 'GTK\_DELETE\_WHITESPACE' ### enum Gtk2::Justification - • 'left' / 'GTK\_JUSTIFY\_LEFT' - • 'right' / 'GTK\_JUSTIFY\_RIGHT' - • 'center' / 'GTK\_JUSTIFY\_CENTER' - • 'fill' / 'GTK\_JUSTIFY\_FILL' ### enum Gtk2::MovementStep - • 'logical-positions' / 'GTK\_MOVEMENT\_LOGICAL\_POSITIONS' - • 'visual-positions' / 'GTK\_MOVEMENT\_VISUAL\_POSITIONS' - • 'words' / 'GTK\_MOVEMENT\_WORDS' - • 'display-lines' / 'GTK\_MOVEMENT\_DISPLAY\_LINES' - • 'display-line-ends' / 'GTK\_MOVEMENT\_DISPLAY\_LINE\_ENDS' - • 'paragraphs' / 'GTK\_MOVEMENT\_PARAGRAPHS' - • 'paragraph-ends' / 'GTK\_MOVEMENT\_PARAGRAPH\_ENDS' - • 'pages' / 'GTK\_MOVEMENT\_PAGES' - • 'buffer-ends' / 'GTK\_MOVEMENT\_BUFFER\_ENDS' - • 'horizontal-pages' / 'GTK\_MOVEMENT\_HORIZONTAL\_PAGES' ### enum Gtk2::TextWindowType - • 'private' / 'GTK\_TEXT\_WINDOW\_PRIVATE' - • 'widget' / 'GTK\_TEXT\_WINDOW\_WIDGET' - • 'text' / 'GTK\_TEXT\_WINDOW\_TEXT' - • 'left' / 'GTK\_TEXT\_WINDOW\_LEFT' - • 'right' / 'GTK\_TEXT\_WINDOW\_RIGHT' - • 'top' / 'GTK\_TEXT\_WINDOW\_TOP' - • 'bottom' / 'GTK\_TEXT\_WINDOW\_BOTTOM' ### enum Gtk2::WrapMode - • 'none' / 'GTK\_WRAP\_NONE' - • 'char' / 'GTK\_WRAP\_CHAR' - • 'word' / 'GTK\_WRAP\_WORD' - • 'word-char' / 'GTK\_WRAP\_WORD\_CHAR' ### enum GtkScrollStep - • 'steps' / 'GTK\_SCROLL\_STEPS' - • 'pages' / 'GTK\_SCROLL\_PAGES' - • 'ends' / 'GTK\_SCROLL\_ENDS' - • 'horizontal-steps' / 'GTK\_SCROLL\_HORIZONTAL\_STEPS' - • 'horizontal-pages' / 'GTK\_SCROLL\_HORIZONTAL\_PAGES' - • 'horizontal-ends' / 'GTK\_SCROLL\_HORIZONTAL\_ENDS' ## SEE ALSO Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container ## COPYRIGHT Copyright (C) 2003-2011 by the gtk2-perl team. This software is licensed under the LGPL. See Gtk2 for a full notice.