com.trolltech.qt.gui
Class QTextTableCell

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

public class QTextTableCell
extends QtJambiObject

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, QTextTableFormat

Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.Signal0, QSignalEmitter.Signal1<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I>
 
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.
 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.
 boolean equals(java.lang.Object other)
          
 QTextCursor firstCursorPosition()
          Returns the first valid cursor position in this cell.
 int firstPosition()
          This method is used internally by Qt Jambi.
 QTextCharFormat format()
          Returns the cell's character format.
static QTextTableCell fromNativePointer(QNativePointer nativePointer)
          This function returns the QTextTableCell instance pointed to by nativePointer
 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 lastPosition()
          This method is used internally by Qt Jambi.
static QNativePointer nativePointerArray(QTextTableCell[] array)
          This function returns a QNativePointer that is pointing to the specified QTextTableCell array.
 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.
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class java.lang.Object
clone, 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 o 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

firstPosition

public final int firstPosition()

This method is used internally by Qt Jambi. Do not use it in your applications.


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

lastPosition

public final int lastPosition()

This method is used internally by Qt Jambi. Do not use it in your applications.


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

fromNativePointer

public static QTextTableCell fromNativePointer(QNativePointer nativePointer)
This function returns the QTextTableCell instance pointed to by nativePointer

Parameters:
nativePointer - the QNativePointer of which object should be returned.

nativePointerArray

public static QNativePointer nativePointerArray(QTextTableCell[] array)
This function returns a QNativePointer that is pointing to the specified QTextTableCell array.

Parameters:
array - the array that the returned pointer will point to.
Returns:
a QNativePointer that is pointing to the specified array.

equals

public boolean equals(java.lang.Object other)

Overrides:
equals in class java.lang.Object