com.trolltech.qt.gui
Class QTextTableCell

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.gui.QTextTableCell
All Implemented Interfaces:
QtJambiInterface, java.lang.Cloneable

public class QTextTableCell
extends QtJambiObject
implements java.lang.Cloneable

The QTextTableCell class represents the properties of a cell in a QTextTable. Table cells are pieces of document structure that belong to a table. The table orders cells into particular rows and columns; cells can also span multiple columns and rows.

Cells are usually created when a table is inserted into a document with QTextCursor::insertTable(), but they are also created and destroyed when a table is resized.

Cells contain information about their location in a table; you can obtain the row() and column() numbers of a cell, and its rowSpan() and columnSpan().

The format() of a cell describes the default character format of its contents. The firstCursorPosition() and lastCursorPosition() functions are used to obtain the extent of the cell in the document.

See also:
QTextTable, and QTextTableFormat.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
QTextTableCell()
          Constructs an invalid table cell.
QTextTableCell(QTextTableCell o)
          Copy constructor.
 
Method Summary
 QTextFrame_iterator begin()
          Returns a frame iterator pointing to the beginning of the table's cell.
 QTextTableCell clone()
          This method is reimplemented for internal reasons
 int column()
          Returns the number of the column in the table that contains this cell.
 int columnSpan()
          Returns the number of columns this cell spans.
 QTextFrame_iterator end()
          Returns a frame iterator pointing to the end of the table's cell.
 QTextCursor firstCursorPosition()
          Returns the first valid cursor position in this cell.
 QTextCharFormat format()
          Returns the cell's character format.
 boolean isValid()
          Returns true if this is a valid table cell; otherwise returns false.
 QTextCursor lastCursorPosition()
          Returns the last valid cursor position in this cell.
 int row()
          Returns the number of the row in the table that contains this cell.
 int rowSpan()
          Returns the number of rows this cell spans.
 void setFormat(QTextCharFormat format)
          Sets the cell's character format to format.
 int tableCellFormatIndex()
          Returns the index of the tableCell's format in the document's internal list of formats.
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QTextTableCell

public QTextTableCell()
Constructs an invalid table cell.

See also:
isValid().


QTextTableCell

public QTextTableCell(QTextTableCell o)
Copy constructor. Creates a new QTextTableCell object based on the other cell.

Method Detail

begin

public final QTextFrame_iterator begin()
Returns a frame iterator pointing to the beginning of the table's cell.

See also:
end().


column

public final int column()
Returns the number of the column in the table that contains this cell.

See also:
row().


columnSpan

public final int columnSpan()
Returns the number of columns this cell spans. The default is 1.

See also:
rowSpan().


end

public final QTextFrame_iterator end()
Returns a frame iterator pointing to the end of the table's cell.

See also:
begin().


firstCursorPosition

public final QTextCursor firstCursorPosition()
Returns the first valid cursor position in this cell.

See also:
lastCursorPosition().


format

public final QTextCharFormat format()
Returns the cell's character format.

See also:
setFormat().


isValid

public final boolean isValid()
Returns true if this is a valid table cell; otherwise returns false.


lastCursorPosition

public final QTextCursor lastCursorPosition()
Returns the last valid cursor position in this cell.

See also:
firstCursorPosition().


row

public final int row()
Returns the number of the row in the table that contains this cell.

See also:
column().


rowSpan

public final int rowSpan()
Returns the number of rows this cell spans. The default is 1.

See also:
columnSpan().


setFormat

public final void setFormat(QTextCharFormat format)
Sets the cell's character format to format. This can for example be used to change the background color of the entire cell:

QTextTableCell cell = table->cellAt(2, 3); QTextCharFormat format = cell.format(); format.setBackground(Qt::blue ); cell.setFormat(format);

Note that the cell's row or column span cannot be changed through this function. You have to use QTextTable::mergeCells and QTextTable::splitCell instead.

See also:
format().


tableCellFormatIndex

public final int tableCellFormatIndex()
Returns the index of the tableCell's format in the document's internal list of formats.

See also:
QTextDocument::allFormats().


clone

public QTextTableCell clone()
This method is reimplemented for internal reasons

Overrides:
clone in class java.lang.Object