|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gnu.glib.Struct
org.gnu.glib.GObject
org.gnu.gtk.TextBuffer
public class TextBuffer
The TextBuffer is the object used to store data to be displayed in a TextView
widget. See the TextView
widget description for details.
Constructor Summary | |
---|---|
TextBuffer()
Creates a new buffer and a new default TextTagTable. |
|
TextBuffer(TextTagTable table)
Creates a new text buffer. |
Method Summary | |
---|---|
void |
addClipboard(Clipboard clipboard)
Adds clipboard to the list of clipboards in which the selection contents of buffer are available. |
void |
addListener(TextBufferListener listener)
Register an object to receive text view event notification. |
void |
applyTag(java.lang.String name,
TextIter start,
TextIter end)
Looks up a tag by name and then applies it. |
void |
applyTag(TextTag tag,
TextIter start,
TextIter end)
Emits the "apply_tag" signal on buffer. |
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. |
void |
beginUserAction()
Called to indicate that the buffer operations between here and a call to endUserAction() are part of a single user-visible operation. |
void |
copyClipboard(Clipboard clip)
Copies the currently-selected text to a clipboard. |
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 |
TextMark |
createMark(java.lang.String markName,
TextIter where,
boolean leftGravity)
Creates a mark at position where . |
TextTag |
createTag(java.lang.String name)
Creates a TextTag initialised for use in this TextBuffer. |
void |
cutClipboard(Clipboard clipboard,
boolean defaultEditable)
Copies the currently-selected text to a clipboard, then deletes said text if it's editable. |
void |
deleteMark(java.lang.String name)
Deletes the mark named name ; the mark must exist. |
void |
deleteMark(TextMark mark)
Deletes mark , so that it's no longer located anywhere in
the buffer. |
boolean |
deleteSelection(boolean interactive,
boolean defaultEditable)
Deletes the range between the "insert" and "selection_bound" marks, that is, the currently-selected text. |
void |
deleteText(TextIter start,
TextIter end)
Deletes text between start and end . |
boolean |
deleteTextInteractive(TextIter start,
TextIter end,
boolean defaultEditable)
Deletes all editable text in the given range. |
void |
endUserAction()
Should be paired with a call to beginUserAction() . |
int |
getCharCount()
Gets the number of characters in the buffer. |
TextIter |
getEndIter()
Returns Iterator for the end of the text |
java.lang.Class |
getEventListenerClass(java.lang.String signal)
TextView event handling. |
EventType |
getEventType(java.lang.String signal)
|
TextMark |
getInsert()
Returns the mark that represents the cursor (insertion point). |
TextIter |
getIter(int charOffset)
Obtains an iterator pointing to charOffset within the entire string, statring from the beginning |
TextIter |
getIter(int lineNumber,
int charOffset)
Obtains an iterator pointing to charOffset within the given line. |
TextIter |
getIter(TextChildAnchor anchor)
Obtains the location of anchor within buffer. |
TextIter |
getIter(TextMark mark)
Returns an iter at the given mark |
int |
getLineCount()
Obtains the number of lines in the buffer. |
TextIter |
getLineIter(int line)
Obtains an iterator pointing to the start of the given line |
TextMark |
getMark(java.lang.String name)
Returns the mark named name in the buffer, or
null if no such mark exists in the buffer |
boolean |
getModified()
Indicates whether the buffer has been modified since the last call to setModified(boolean) set the modification flag to FALSE. |
boolean |
getSelected()
Returns true if an area of the buffer is selected |
TextMark |
getSelectionBound()
Returns the mark that represents the selection bound. |
TextIter |
getSelectionEnd()
Returns an iterator for the end of the selection, or null
if no text is selected. |
TextIter |
getSelectionStart()
Returns an iterator for the start of the selected text, or null if no text is selected. |
java.lang.String |
getSlice(TextIter start,
TextIter end,
boolean includeHiddenChars)
Returns the text in the range start,end. |
TextIter |
getStartIter()
Returns an iterator for the start of the text |
java.lang.String |
getText(TextIter start,
TextIter end,
boolean includeHiddenChars)
Returns the text in the range start,end. |
TextTagTable |
getTextTagTable()
Get the GtkTextTagTable associated with this buffer. |
static Type |
getType()
Retrieve the runtime type used by the GLib library. |
void |
inserChildAnchor(TextIter iter,
TextChildAnchor anchor)
Inserts a child widget anchor into the text buffer at iter. |
void |
insertPixbuf(TextIter iter,
Pixbuf pixbuf)
Inserts an image into the text buffer at iter. |
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. |
boolean |
insertRangeInteractive(TextIter iter,
TextIter start,
TextIter end,
boolean defaultEditable)
Same as insertRange(TextIter, TextIter, TextIter) , but does
nothing if the insertion point isn't editable. |
void |
insertText(java.lang.String text)
Inserts text at the current cursor position |
void |
insertText(TextIter iter,
java.lang.String text)
Inserts text at position iter. |
void |
insertText(TextIter iter,
java.lang.String text,
java.lang.String tag)
Inserts text and applies a tag to that text. |
void |
insertText(TextIter iter,
java.lang.String text,
java.lang.String[] tags)
Inserts text and applies tags to that text. |
boolean |
insertTextInteractive(java.lang.String text,
boolean defaultEditable)
Calls insertTextInteractive(TextIter, String, boolean) at the
cursor position. |
boolean |
insertTextInteractive(TextIter iter,
java.lang.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. |
boolean |
markExists(java.lang.String name)
Returns true if a mark exists with the given name. |
void |
moveMark(java.lang.String name,
TextIter where)
Moves the mark named name (which must exist) to location
where |
void |
moveMark(TextMark mark,
TextIter where)
Moves mark to the new location where . |
void |
pasteClipboard(Clipboard clipboard,
boolean defaultEditable)
Pastes the contents of a clipboard at the insertion point. |
void |
pasteClipboard(Clipboard clipboard,
TextIter location,
boolean defaultEditable)
Pastes the contents of a clipboard at location. |
void |
placeCursor(TextIter where)
This function moves the "insert" and "selection_bound" marks simultaneously. |
void |
removeAllTags(TextIter start,
TextIter end)
Removes all tags in the range between start and end. |
void |
removeAllTags(TextTag start,
TextTag end)
Deprecated. |
void |
removeClipboard(Clipboard clipboard)
Removes a clipboard added with addClipboard(Clipboard) |
void |
removeListener(TextBufferListener listener)
Unregister an object that was receiving text view event notification. |
void |
removeTag(java.lang.String name,
TextIter start,
TextIter end)
Removes a tag based on it's name. |
void |
removeTag(TextTag tag,
TextIter start,
TextIter end)
Emits the "remove_tag" signal. |
void |
selectRange(TextIter ins,
TextIter bound)
This function moves the "insert" and "selection_bound" marks simultaneously. |
void |
setModified(boolean setting)
Used to keep track of whether the buffer has been modified since the last time it was saved. |
void |
setText(java.lang.String text)
Deletes current contents of buffer, and inserts text
instead. |
Methods inherited from class org.gnu.glib.Struct |
---|
equals, getHandle, getNullHandle, hashCode |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TextBuffer(TextTagTable table)
table
- A tag tablepublic TextBuffer()
Method Detail |
---|
public int getLineCount()
public int getCharCount()
public TextTagTable getTextTagTable()
public void insertText(TextIter iter, java.lang.String text)
iter
- A position in the buffertext
- The text to insert
java.lang.IllegalArgumentException
- If text
is nullpublic void insertText(java.lang.String text)
text
- The text to insert
java.lang.IllegalArgumentException
- If text
is nullpublic boolean insertTextInteractive(TextIter iter, java.lang.String text, boolean defaultEditable)
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
java.lang.IllegalArgumentException
- If text
is nullpublic boolean insertTextInteractive(java.lang.String text, boolean defaultEditable)
insertTextInteractive(TextIter, String, boolean)
at the
cursor position.
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.
text
- The text to insert.defaultEditable
- Default editability of buffer
java.lang.IllegalArgumentException
- If text
is nullpublic void insertRange(TextIter iter, TextIter start, TextIter end)
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 startpublic void insertText(TextIter iter, java.lang.String text, java.lang.String tag)
iter
- Place to insert texttext
- Text to inserttag
- name of TextTag to apply to that text.
java.lang.IllegalArgumentException
- If text
is nullpublic void insertText(TextIter iter, java.lang.String text, java.lang.String[] tags)
iter
- Place to insert texttext
- Text to inserttags
- Array of TextTag names to apply to that text.public boolean insertRangeInteractive(TextIter iter, TextIter start, TextIter end, boolean defaultEditable)
insertRange(TextIter, TextIter, TextIter)
, but does
nothing if the insertion point isn't editable. The defaultEditable
parameter indicates whether the text is editable at iter if no tags
enclosing iter affect editability. Typically the result of TextView.getEditable()
is appropriate here.
iter
- A position in bufferstart
- A position in a TextBufferend
- Another position in the same buffer as startdefaultEditable
- default editability of the buffer
public void deleteText(TextIter start, TextIter end)
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.public boolean deleteTextInteractive(TextIter start, TextIter end, boolean defaultEditable)
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
public void setText(java.lang.String text)
text
instead.
text
- The text to use as the content of the buffer.
java.lang.IllegalArgumentException
- If text
is nullpublic java.lang.String getText(TextIter start, TextIter end, boolean includeHiddenChars)
getSlice(TextIter, TextIter, boolean)
.
start
- Start of a rangeend
- End of a rangeincludeHiddenChars
- Whether to include invisible text
public java.lang.String getSlice(TextIter start, TextIter end, boolean includeHiddenChars)
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
public void insertPixbuf(TextIter iter, Pixbuf pixbuf)
iter
- Location to insert the pixbufpixbuf
- A Pixbufpublic void inserChildAnchor(TextIter iter, TextChildAnchor anchor)
iter
- Location to insert the anchoranchor
- A TextChildAnchorpublic TextChildAnchor createChildAnchor(TextIter iter)
iter
- Location in the buffer
public TextMark createMark(java.lang.String markName, TextIter where, boolean leftGravity)
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
public void moveMark(TextMark mark, TextIter where)
mark
to the new location where
.
Emits the "mark_set" event as notification of the move.
mark
- A TextMarkwhere
- New location for mark in bufferpublic void moveMark(java.lang.String name, TextIter where)
name
(which must exist) to location
where
name
- Name of a markwhere
- New location for markpublic void deleteMark(TextMark mark)
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 bufferpublic void deleteMark(java.lang.String name)
name
; the mark must exist.
name
- The name of the mark to deletedeleteMark(TextMark)
public boolean markExists(java.lang.String name)
public TextMark getMark(java.lang.String name)
name
in the buffer, or
null
if no such mark exists in the buffer
public TextMark getInsert()
public TextMark getSelectionBound()
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.
public void placeCursor(TextIter where)
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 cursorpublic void applyTag(TextTag tag, TextIter start, TextIter end)
tag
- A TextTagstart
- One bound of range to be taggedend
- Other bound of range to be taggedpublic void removeTag(TextTag tag, TextIter start, TextIter end)
tag
- A TextTagstart
- One bound of range to be untaggedend
- Other bound of range to be untaggedpublic void applyTag(java.lang.String name, TextIter start, TextIter end)
name
- Name of a named TextTagstart
- One bound of range to be taggedend
- Other bound of range to be taggedpublic void removeTag(java.lang.String name, TextIter start, TextIter end)
name
- Name of a TextTagstart
- One bound of range to be untaggedend
- Other bound of range to be untaggedpublic void removeAllTags(TextTag start, TextTag end)
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 untaggedpublic void removeAllTags(TextIter start, TextIter end)
start
- end
- public TextIter getIter(int lineNumber, int charOffset)
lineNumber
- Line number counting from 0charOffset
- Char offset from start of line
public TextIter getIter(int charOffset)
charOffset
- Character offset from the beginning of the text
public TextIter getLineIter(int line)
line
- The line
public TextIter getIter(TextMark mark)
mark
- The position for the iter
public TextIter getIter(TextChildAnchor anchor)
anchor
- An anchor that appears in the buffer.
public TextIter getStartIter()
public TextIter getEndIter()
public boolean getModified()
setModified(boolean)
set the modification flag to FALSE. Used
for example to enable a "save" function in a text editor.
public void setModified(boolean setting)
setting
- Modification flag settingpublic boolean deleteSelection(boolean interactive, boolean defaultEditable)
interactive
- Whether the deletion is caused by user interactiondefaultEditable
- Whether the buffer is editable by default
public void pasteClipboard(Clipboard clipboard, TextIter location, boolean defaultEditable)
clipboard
- The Clipboard to paste fromlocation
- Location to insert pasted textdefaultEditable
- Whether the buffer is editable by defaultpublic void pasteClipboard(Clipboard clipboard, boolean defaultEditable)
clipboard
- The Clipboard to paste fromdefaultEditable
- Whether the buffer is editable by defaultpublic void copyClipboard(Clipboard clip)
clip
- The clipboard to copy the text topublic void cutClipboard(Clipboard clipboard, boolean defaultEditable)
clipboard
- The Clipboard object to cut to.defaultEditable
- Default editability of the bufferpublic boolean getSelected()
public TextIter getSelectionStart()
null
if no text is selected.
public TextIter getSelectionEnd()
null
if no text is selected.
public void beginUserAction()
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.
public void endUserAction()
beginUserAction()
. See that
function for a full explanation.
public void addClipboard(Clipboard clipboard)
clipboard
- A ClipBoardpublic void removeClipboard(Clipboard clipboard)
addClipboard(Clipboard)
clipboard
- The clipboard to removepublic void selectRange(TextIter ins, TextIter bound)
ins
- where to put the "insert" markbound
- where to put the "selection_bound" markpublic boolean backspace(TextIter iter, boolean interactive, boolean default_editable)
iter
- A position in the buffer.interactive
- Whether the deletion is caused by user interaction.default_editable
- Whether the buffer is editable by default.
public java.lang.Class getEventListenerClass(java.lang.String signal)
getEventListenerClass
in class GObject
public EventType getEventType(java.lang.String signal)
getEventType
in class GObject
public void addListener(TextBufferListener listener)
listener
- The object that has implemented the TextBufferListener
interface that is to receive the text view events.public void removeListener(TextBufferListener listener)
listener
- The object that is to no longer receive text view events.public static Type getType()
public TextTag createTag(java.lang.String name)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |