addClipboard
public void addClipboard(Clipboard clipboard)
Adds clipboard to the list of clipboards in which the selection contents
of buffer are available. In most cases, clipboard will be the
GtkClipboard of type GDK_SELECTION_PRIMARY for a view of buffer.
addListener
public void addListener(TextBufferListener listener)
Register an object to receive text view event notification.
listener
- The object that has implemented the TextBufferListener
interface that is to receive the text view events.
applyTag
public void applyTag(String name,
TextIter start,
TextIter end)
Looks up a tag by name and then applies it.
name
- Name of a named TextTagstart
- One bound of range to be taggedend
- Other bound of range to be tagged
applyTag
public void applyTag(TextTag tag,
TextIter start,
TextIter end)
Emits the "apply_tag" signal on buffer. The default handler for the
signal applies tag to the given range. start and end do not have to be in
order.
tag
- A TextTagstart
- One bound of range to be taggedend
- Other bound of range to be tagged
backspace
public boolean backspace(TextIter iter,
boolean interactive,
boolean default_editable)
Performs the appropriate action as if the user hit the delete key with
the cursor at the position specified by iter. In the normal case a single
character will be deleted, but when combining accents are involved, more
than one character can be deleted, and when precomposed character and
accent combinations are involved, less than one character will be
deleted.
Because the buffer is modified, all outstanding iterators become invalid
after calling this function; however, the iter will be re-initialized to
point to the location where text was deleted.
iter
- A position in the buffer.interactive
- Whether the deletion is caused by user interaction.default_editable
- Whether the buffer is editable by default.
- TRUE if the buffer was modified.
beginUserAction
public void beginUserAction()
Called to indicate that the buffer operations between here and a call to
endUserAction()
are part of a single user-visible operation. The
operations between beginUserAction() and endUserAction() can then be
grouped when creating an undo stack. TextBuffer maintains a count of
calls to beginUserAction() that have not been closed with a call to
endUserAction(), and emits the "begin_user_action" and "end_user_action"
event only for the outermost pair of calls. This allows you to build user
actions from other user actions.
The "interactive" buffer mutation functions automatically call begin/end
user action around the buffer operations they perform, so there's no need
to add extra calls if you user action consists solely of a single call to
one of those functions.
copyClipboard
public void copyClipboard(Clipboard clip)
Copies the currently-selected text to a clipboard.
clip
- The clipboard to copy the text to
createChildAnchor
public TextChildAnchor createChildAnchor(TextIter iter)
This is a convenience function which simply creates a child anchor with
{link TextChildAnchor#TextChildAnchor()} and inserts it into the buffer
iter
- Location in the buffer
createMark
public TextMark createMark(String markName,
TextIter where,
boolean leftGravity)
Creates a mark at position
where
. Otherwise, the mark can
be retrieved by name using
getMark(String)
. If a mark has left
gravity, and text is inserted at the mark's current location, the mark
will be moved to the left of the newly-inserted text. If the mark has
right gravity (leftGravity = FALSE), the mark will end up on the right of
newly-inserted text. The standard left-to-right cursor is a mark with
right gravity (when you type, the cursor stays on the right side of the
text you're typing).
Emits the "mark_set" event as notification of the mark's initial
placement.
markName
- Name for markwhere
- Location to place markleftGravity
- Whether the mark has left gravity
createTag
public TextTag createTag(String name)
Creates a TextTag initialised for use in this TextBuffer. If a TextTag
already exists with this name null is returned.
cutClipboard
public void cutClipboard(Clipboard clipboard,
boolean defaultEditable)
Copies the currently-selected text to a clipboard, then deletes said text
if it's editable.
clipboard
- The Clipboard object to cut to.defaultEditable
- Default editability of the buffer
deleteMark
public void deleteMark(String name)
Deletes the mark named name
; the mark must exist.
name
- The name of the mark to delete
deleteMark
public void deleteMark(TextMark mark)
Deletes
mark
, so that it's no longer located anywhere in
the buffer. There is no way to undelete a mark.
TextMark.getDeleted()
indicates that a mark no longer belongs to
a buffer. The "mark_deleted" signal will be emitted as notification after
the mark is deleted.
mark
- A TextMark in buffer
deleteSelection
public boolean deleteSelection(boolean interactive,
boolean defaultEditable)
Deletes the range between the "insert" and "selection_bound" marks, that
is, the currently-selected text. If interactive is TRUE, the editability
of the selection will be considered (users can't delete uneditable text).
interactive
- Whether the deletion is caused by user interactiondefaultEditable
- Whether the buffer is editable by default
- Whether there was a non-empty selection to delete
deleteText
public void deleteText(TextIter start,
TextIter end)
Deletes text between start
and end
. The
order of start and end is not actually relevant. This function actually
emits the "delete_range" signal, and the default handler of that signal
deletes the text. Because the buffer is modified, all outstanding
iterators become invalid after calling this function; however, the start
and end will be re-initialized to point to the location where text was
deleted.
start
- A position in bufferend
- Another position in buffer.
deleteTextInteractive
public boolean deleteTextInteractive(TextIter start,
TextIter end,
boolean defaultEditable)
Deletes all
editable text in the given range. Calls
deleteText(TextIter,TextIter)
for each editable sub-range of
start,end.
start
and
end
are revalidated to
point to the location of the last deleted range, or left untouched if no
text was deleted.
start
- Start of range to deleteend
- End of rangedefaultEditable
- Ehether the buffer is editable by default
- Whether some text was actually deleted
endUserAction
public void endUserAction()
Should be paired with a call to
beginUserAction()
. See that
function for a full explanation.
getCharCount
public int getCharCount()
Gets the number of characters in the buffer. Note that characters and
bytes are not the same. You can't expect the contents of the buffer in
string form to be this many bytes long. The character count is cached, so
this function is very fast.
- Number of characters in the buffer.
getEndIter
public TextIter getEndIter()
Returns Iterator for the end of the text
- Iterator for the end of the text.
getEventListenerClass
public Class getEventListenerClass(String signal)
TextView event handling.
getEventType
public EventType getEventType(String signal)
getInsert
public TextMark getInsert()
Returns the mark that represents the cursor (insertion point). Equivalent
to calling gtk_text_buffer_get_mark() to get the mark named "insert", but
very slightly more efficient, and involves less typing.
getIter
public TextIter getIter(int charOffset)
Obtains an iterator pointing to charOffset within the entire string,
statring from the beginning
charOffset
- Character offset from the beginning of the text
- Iterator pointing to that point.
getIter
public TextIter getIter(int lineNumber,
int charOffset)
Obtains an iterator pointing to charOffset within the given line. The
charOffset must exist, offsets off the end of the line are not allowed.
Note characters, not bytes; UTF-8 may encode one character as multiple
bytes.
lineNumber
- Line number counting from 0charOffset
- Char offset from start of line
getIter
public TextIter getIter(TextChildAnchor anchor)
Obtains the location of anchor within buffer.
anchor
- An anchor that appears in the buffer.
getIter
public TextIter getIter(TextMark mark)
Returns an iter at the given mark
mark
- The position for the iter
getLineCount
public int getLineCount()
Obtains the number of lines in the buffer. This value is cached, so the
function is very fast.
- The number of lines in the buffer.
getLineIter
public TextIter getLineIter(int line)
Obtains an iterator pointing to the start of the given line
getMark
public TextMark getMark(String name)
Returns the mark named name
in the buffer, or
null
if no such mark exists in the buffer
getModified
public boolean getModified()
Indicates whether the buffer has been modified since the last call to
setModified(boolean)
set the modification flag to FALSE. Used
for example to enable a "save" function in a text editor.
- TRUE if the buffer has been modified
getSelected
public boolean getSelected()
Returns true if an area of the buffer is selected
- True if an area is selected
getSelectionBound
public TextMark getSelectionBound()
Returns the mark that represents the selection bound. Equivalent to
calling
getMark(String)
to get the mark named "selection_bound",
but very slightly more efficient, and involves less typing.
The currently-selected text in buffer is the region between the
"selection_bound" and "insert" marks. If "selection_bound" and "insert"
are in the same place, then there is no current selection.
getSelectionEnd
public TextIter getSelectionEnd()
Returns an iterator for the end of the selection, or null
if no text is selected.
getSelectionStart
public TextIter getSelectionStart()
Returns an iterator for the start of the selected text, or
null
if no text is selected.
getSlice
public String getSlice(TextIter start,
TextIter end,
boolean includeHiddenChars)
Returns the text in the range start,end. Excludes undisplayed text (text
marked with tags that set the invisibility attribute) if
includeHiddenChars is FALSE. The returned string includes a 0xFFFC
character whenever the buffer contains embedded images, so byte and
character indexes into the returned string do correspond to byte and
character indexes into the buffer. Contrast with
getText(TextIter,TextIter,boolean)
. Note that 0xFFFC can
occur in normal text as well, so it is not a reliable indicator that a
pixbuf or widget is in the buffer.
start
- Start of a rangeend
- End of a range.includeHiddenChars
- Whether to include invisible text
getStartIter
public TextIter getStartIter()
Returns an iterator for the start of the text
getText
public String getText(TextIter start,
TextIter end,
boolean includeHiddenChars)
Returns the text in the range start,end. Excludes undisplayed text (text
marked with tags that set the invisibility attribute) if
includeHiddenChars is FALSE. Does not include characters representing
embedded images, so byte and character indexes into the returned string
do not correspond to byte and character indexes into the buffer. Contrast
with
getSlice(TextIter,TextIter,boolean)
.
start
- Start of a rangeend
- End of a rangeincludeHiddenChars
- Whether to include invisible text
getTextTagTable
public TextTagTable getTextTagTable()
Get the GtkTextTagTable associated with this buffer.
getType
public static Type getType()
Retrieve the runtime type used by the GLib library.
inserChildAnchor
public void inserChildAnchor(TextIter iter,
TextChildAnchor anchor)
Inserts a child widget anchor into the text buffer at iter. The anchor
will be counted as one character in character counts, and when obtaining
the buffer contents as a string, will be represented by the Unicode
"object replacement character" 0xFFFC. Note that the "slice" variants for
obtaining portions of the buffer as a string include this character for
child anchors, but the "text" variants do not.
iter
- Location to insert the anchoranchor
- A TextChildAnchor
insertPixbuf
public void insertPixbuf(TextIter iter,
Pixbuf pixbuf)
Inserts an image into the text buffer at iter. The image will be counted
as one character in character counts, and when obtaining the buffer
contents as a string, will be represented by the Unicode "object
replacement character" 0xFFFC. Note that the "slice" variants for
obtaining portions of the buffer as a string include this character for
pixbufs, but the "text" variants do not.
iter
- Location to insert the pixbufpixbuf
- A Pixbuf
insertRange
public void insertRange(TextIter iter,
TextIter start,
TextIter end)
Copies text, tags, and pixbufs between start and end (the order of start
and end doesn't matter) and inserts the copy at iter. Used instead of
simply getting/inserting text because it preserves images and tags. If
start and end are in a different buffer from buffer, the two buffers must
share the same tag table.
Implemented via emissions of the insert_text and apply_tag signals, so
expect those.
iter
- A position in the bufferstart
- A position in a TextBufferend
- Another position in the same buffer as start
insertRangeInteractive
public boolean insertRangeInteractive(TextIter iter,
TextIter start,
TextIter end,
boolean defaultEditable)
iter
- A position in bufferstart
- A position in a TextBufferend
- Another position in the same buffer as startdefaultEditable
- default editability of the buffer
- Whether an insertion was possible at iter.
insertText
public void insertText(String text)
Inserts text at the current cursor position
text
- The text to insert
insertText
public void insertText(TextIter iter,
String text)
Inserts text at position iter. Emits the "insert_text" signal; insertion
actually occurs in the default handler for the signal. iter is
invalidated when insertion occurs (because the buffer contents change),
but the default signal handler revalidates it to point to the end of the
inserted text.
iter
- A position in the buffertext
- The text to insert
insertText
public void insertText(TextIter iter,
String text,
String tag)
Inserts text and applies a tag to that text.
iter
- Place to insert texttext
- Text to inserttag
- name of TextTag to apply to that text.
insertText
public void insertText(TextIter iter,
String text,
String[] tags)
Inserts text and applies tags to that text.
iter
- Place to insert texttext
- Text to inserttags
- Array of TextTag names to apply to that text.
insertTextInteractive
public boolean insertTextInteractive(String text,
boolean defaultEditable)
text
- The text to insert.defaultEditable
- Default editability of buffer
- Whether text was actually inserted.
insertTextInteractive
public boolean insertTextInteractive(TextIter iter,
String text,
boolean defaultEditable)
Like
insertText(TextIter,String)
, but the insertion will not
occur if iter is at a non-editable location in the buffer. Usually you
want to prevent insertions at ineditable locations if the insertion
results from a user action (is interactive).
defaultEditable indicates the editability of text that doesn't have a tag
affecting editability applied to it. Typically the result of
TextView.getEditable()
is appropriate here.
iter
- A position in buffertext
- The text to insertdefaultEditable
- Default editability of buffer
- Whether text was actually inserted
markExists
public boolean markExists(String name)
Returns true if a mark exists with the given name.
moveMark
public void moveMark(String name,
TextIter where)
Moves the mark named name
(which must exist) to location
where
name
- Name of a markwhere
- New location for mark
moveMark
public void moveMark(TextMark mark,
TextIter where)
Moves mark
to the new location where
.
Emits the "mark_set" event as notification of the move.
mark
- A TextMarkwhere
- New location for mark in buffer
pasteClipboard
public void pasteClipboard(Clipboard clipboard,
boolean defaultEditable)
Pastes the contents of a clipboard at the insertion point. (Note: pasting
is asynchronous, that is, we'll ask for the paste data and return, and at
some point later after the main loop runs, the paste data will be
inserted.)
clipboard
- The Clipboard to paste fromdefaultEditable
- Whether the buffer is editable by default
pasteClipboard
public void pasteClipboard(Clipboard clipboard,
TextIter location,
boolean defaultEditable)
Pastes the contents of a clipboard at location. (Note: pasting is
asynchronous, that is, we'll ask for the paste data and return, and at
some point later after the main loop runs, the paste data will be
inserted.)
clipboard
- The Clipboard to paste fromlocation
- Location to insert pasted textdefaultEditable
- Whether the buffer is editable by default
placeCursor
public void placeCursor(TextIter where)
This function moves the "insert" and "selection_bound" marks
simultaneously. If you move them to the same place in two steps with
moveMark(TextMark,TextIter)
, you will temporarily select a
region in between their old and new locations, which can be pretty
inefficient since the temporarily-selected region will force stuff to be
recalculated. This function moves them as a unit, which can be optimized.
where
- Where to put the cursor
removeAllTags
public void removeAllTags(TextIter start,
TextIter end)
Removes all tags in the range between start and end. Be careful with this
function; it could remove tags added in code unrelated to the code you're
currently writing. That is, using this function is probably a bad idea if
you have two or more unrelated code sections that add tags.
removeAllTags
public void removeAllTags(TextTag start,
TextTag end)
Removes all tags in the range between start and end. Be careful with this
function; it could remove tags added in code unrelated to the code you're
currently writing. That is, using this function is probably a bad idea if
you have two or more unrelated code sections that add tags.
THIS METHOD IS INCORRECT AND SHOULD NOT BE USED Use
removeAllTags(TextIter,TextIter)
instead
start
- One bound of range to be untaggedend
- Other bound of range to be untagged
removeClipboard
public void removeClipboard(Clipboard clipboard)
clipboard
- The clipboard to remove
removeListener
public void removeListener(TextBufferListener listener)
Unregister an object that was receiving text view event notification.
listener
- The object that is to no longer receive text view events.
removeTag
public void removeTag(String name,
TextIter start,
TextIter end)
Removes a tag based on it's name.
name
- Name of a TextTagstart
- One bound of range to be untaggedend
- Other bound of range to be untagged
removeTag
public void removeTag(TextTag tag,
TextIter start,
TextIter end)
Emits the "remove_tag" signal. The default handler for the signal removes
all occurrences of tag from the given range. start and end don't have to
be in order
tag
- A TextTagstart
- One bound of range to be untaggedend
- Other bound of range to be untagged
selectRange
public void selectRange(TextIter ins,
TextIter bound)
This function moves the "insert" and "selection_bound" marks
simultaneously. If you move them in two steps with moveMark, you will
temporarily select a region in between their old and new locations, which
can be pretty inefficient since the temporarily-selected region will
force stuff to be recalculated. This function moves them as a unit, which
can be optimized.
ins
- where to put the "insert" markbound
- where to put the "selection_bound" mark
setModified
public void setModified(boolean setting)
Used to keep track of whether the buffer has been modified since the last
time it was saved. Whenever the buffer is saved to disk, call
setModified(FALSE). When the buffer is modified, it will automatically
toggled on the modified bit again. When the modified bit flips, the
buffer emits a "modified_changed" event.
setting
- Modification flag setting
setText
public void setText(String text)
Deletes current contents of buffer, and inserts text
instead.
text
- The text to use as the content of the buffer.