<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qtexttable.cpp --> <title>QTextTableCell Class | Qt GUI 5.9</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.9</td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QTextTableCell</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QTextTableCell Class</h1> <!-- $$$QTextTableCell-brief --> <p>The <a href="qtexttablecell.html">QTextTableCell</a> class represents the properties of a cell in a <a href="qtexttable.html">QTextTable</a>. <a href="#details">More...</a></p> <!-- @@@QTextTableCell --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QTextTableCell></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr></table></div><ul> <li><a href="qtexttablecell-members.html">List of all members, including inherited members</a></li> </ul> <p><b>Note:</b> All functions in this class are reentrant.</p> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#QTextTableCell">QTextTableCell</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#QTextTableCell-1">QTextTableCell</a></b>(const QTextTableCell &<i>other</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#dtor.QTextTableCell">~QTextTableCell</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QTextFrame::iterator </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#begin">begin</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#column">column</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#columnSpan">columnSpan</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QTextFrame::iterator </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#end">end</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QTextCursor </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#firstCursorPosition">firstCursorPosition</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QTextCharFormat </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#format">format</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#isValid">isValid</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QTextCursor </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#lastCursorPosition">lastCursorPosition</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#row">row</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#rowSpan">rowSpan</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#setFormat">setFormat</a></b>(const QTextCharFormat &<i>format</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#tableCellFormatIndex">tableCellFormatIndex</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#operator-not-eq">operator!=</a></b>(const QTextTableCell &<i>other</i>) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QTextTableCell &</td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#operator-eq">operator=</a></b>(const QTextTableCell &<i>other</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtexttablecell.html#operator-eq-eq">operator==</a></b>(const QTextTableCell &<i>other</i>) const</td></tr> </table></div> <a name="details"></a> <!-- $$$QTextTableCell-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qtexttablecell.html">QTextTableCell</a> class represents the properties of a cell in a <a href="qtexttable.html">QTextTable</a>.</p> <p>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.</p> <p>Cells are usually created when a table is inserted into a document with <a href="qtextcursor.html#insertTable">QTextCursor::insertTable</a>(), but they are also created and destroyed when a table is resized.</p> <p>Cells contain information about their location in a table; you can obtain the <a href="qtexttablecell.html#row">row</a>() and <a href="qtexttablecell.html#column">column</a>() numbers of a cell, and its <a href="qtexttablecell.html#rowSpan">rowSpan</a>() and <a href="qtexttablecell.html#columnSpan">columnSpan</a>().</p> <p>The <a href="qtexttablecell.html#format">format</a>() of a cell describes the default character format of its contents. The <a href="qtexttablecell.html#firstCursorPosition">firstCursorPosition</a>() and <a href="qtexttablecell.html#lastCursorPosition">lastCursorPosition</a>() functions are used to obtain the extent of the cell in the document.</p> </div> <p><b>See also </b><a href="qtexttable.html">QTextTable</a> and <a href="qtexttableformat.html">QTextTableFormat</a>.</p> <!-- @@@QTextTableCell --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QTextTableCell[overload1]$$$QTextTableCell --> <h3 class="fn" id="QTextTableCell"><a name="QTextTableCell"></a>QTextTableCell::<span class="name">QTextTableCell</span>()</h3> <p>Constructs an invalid table cell.</p> <p><b>See also </b><a href="qtexttablecell.html#isValid">isValid</a>().</p> <!-- @@@QTextTableCell --> <!-- $$$QTextTableCell$$$QTextTableCellconstQTextTableCell& --> <h3 class="fn" id="QTextTableCell-1"><a name="QTextTableCell-1"></a>QTextTableCell::<span class="name">QTextTableCell</span>(const <span class="type"><a href="qtexttablecell.html#QTextTableCell">QTextTableCell</a></span> &<i>other</i>)</h3> <p>Copy constructor. Creates a new <a href="qtexttablecell.html">QTextTableCell</a> object based on the <i>other</i> cell.</p> <!-- @@@QTextTableCell --> <!-- $$$~QTextTableCell[overload1]$$$~QTextTableCell --> <h3 class="fn" id="dtor.QTextTableCell"><a name="dtor.QTextTableCell"></a>QTextTableCell::<span class="name">~QTextTableCell</span>()</h3> <p>Destroys the table cell.</p> <!-- @@@~QTextTableCell --> <!-- $$$begin[overload1]$$$begin --> <h3 class="fn" id="begin"><a name="begin"></a><span class="type"><a href="qtextframe-iterator.html">QTextFrame::iterator</a></span> QTextTableCell::<span class="name">begin</span>() const</h3> <p>Returns a frame iterator pointing to the beginning of the table's cell.</p> <p><b>See also </b><a href="qtexttablecell.html#end">end</a>().</p> <!-- @@@begin --> <!-- $$$column[overload1]$$$column --> <h3 class="fn" id="column"><a name="column"></a><span class="type">int</span> QTextTableCell::<span class="name">column</span>() const</h3> <p>Returns the number of the column in the table that contains this cell.</p> <p><b>See also </b><a href="qtexttablecell.html#row">row</a>().</p> <!-- @@@column --> <!-- $$$columnSpan[overload1]$$$columnSpan --> <h3 class="fn" id="columnSpan"><a name="columnSpan"></a><span class="type">int</span> QTextTableCell::<span class="name">columnSpan</span>() const</h3> <p>Returns the number of columns this cell spans. The default is 1.</p> <p><b>See also </b><a href="qtexttablecell.html#rowSpan">rowSpan</a>().</p> <!-- @@@columnSpan --> <!-- $$$end[overload1]$$$end --> <h3 class="fn" id="end"><a name="end"></a><span class="type"><a href="qtextframe-iterator.html">QTextFrame::iterator</a></span> QTextTableCell::<span class="name">end</span>() const</h3> <p>Returns a frame iterator pointing to the end of the table's cell.</p> <p><b>See also </b><a href="qtexttablecell.html#begin">begin</a>().</p> <!-- @@@end --> <!-- $$$firstCursorPosition[overload1]$$$firstCursorPosition --> <h3 class="fn" id="firstCursorPosition"><a name="firstCursorPosition"></a><span class="type"><a href="qtextcursor.html">QTextCursor</a></span> QTextTableCell::<span class="name">firstCursorPosition</span>() const</h3> <p>Returns the first valid cursor position in this cell.</p> <p><b>See also </b><a href="qtexttablecell.html#lastCursorPosition">lastCursorPosition</a>().</p> <!-- @@@firstCursorPosition --> <!-- $$$format[overload1]$$$format --> <h3 class="fn" id="format"><a name="format"></a><span class="type"><a href="qtextcharformat.html">QTextCharFormat</a></span> QTextTableCell::<span class="name">format</span>() const</h3> <p>Returns the cell's character format.</p> <p><b>See also </b><a href="qtexttablecell.html#setFormat">setFormat</a>().</p> <!-- @@@format --> <!-- $$$isValid[overload1]$$$isValid --> <h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QTextTableCell::<span class="name">isValid</span>() const</h3> <p>Returns <code>true</code> if this is a valid table cell; otherwise returns false.</p> <!-- @@@isValid --> <!-- $$$lastCursorPosition[overload1]$$$lastCursorPosition --> <h3 class="fn" id="lastCursorPosition"><a name="lastCursorPosition"></a><span class="type"><a href="qtextcursor.html">QTextCursor</a></span> QTextTableCell::<span class="name">lastCursorPosition</span>() const</h3> <p>Returns the last valid cursor position in this cell.</p> <p><b>See also </b><a href="qtexttablecell.html#firstCursorPosition">firstCursorPosition</a>().</p> <!-- @@@lastCursorPosition --> <!-- $$$row[overload1]$$$row --> <h3 class="fn" id="row"><a name="row"></a><span class="type">int</span> QTextTableCell::<span class="name">row</span>() const</h3> <p>Returns the number of the row in the table that contains this cell.</p> <p><b>See also </b><a href="qtexttablecell.html#column">column</a>().</p> <!-- @@@row --> <!-- $$$rowSpan[overload1]$$$rowSpan --> <h3 class="fn" id="rowSpan"><a name="rowSpan"></a><span class="type">int</span> QTextTableCell::<span class="name">rowSpan</span>() const</h3> <p>Returns the number of rows this cell spans. The default is 1.</p> <p><b>See also </b><a href="qtexttablecell.html#columnSpan">columnSpan</a>().</p> <!-- @@@rowSpan --> <!-- $$$setFormat[overload1]$$$setFormatconstQTextCharFormat& --> <h3 class="fn" id="setFormat"><a name="setFormat"></a><span class="type">void</span> QTextTableCell::<span class="name">setFormat</span>(const <span class="type"><a href="qtextcharformat.html">QTextCharFormat</a></span> &<i>format</i>)</h3> <p>Sets the cell's character format to <i>format</i>. This can for example be used to change the background color of the entire cell:</p> <p><a href="qtexttablecell.html">QTextTableCell</a> cell = table->cellAt(2, 3); <a href="qtextcharformat.html">QTextCharFormat</a> format = cell.<a href="qtexttablecell.html#format">format</a>(); format.setBackground(<a href="../qtcore/qt.html#GlobalColor-enum">Qt::blue</a>); cell.setFormat(format);</p> <p>Note that the cell's row or column span cannot be changed through this function. You have to use <a href="qtexttable.html#mergeCells">QTextTable::mergeCells</a> and <a href="qtexttable.html#splitCell">QTextTable::splitCell</a> instead.</p> <p>This function was introduced in Qt 4.2.</p> <p><b>See also </b><a href="qtexttablecell.html#format">format</a>().</p> <!-- @@@setFormat --> <!-- $$$tableCellFormatIndex[overload1]$$$tableCellFormatIndex --> <h3 class="fn" id="tableCellFormatIndex"><a name="tableCellFormatIndex"></a><span class="type">int</span> QTextTableCell::<span class="name">tableCellFormatIndex</span>() const</h3> <p>Returns the index of the tableCell's format in the document's internal list of formats.</p> <p>This function was introduced in Qt 4.5.</p> <p><b>See also </b><a href="qtextdocument.html#allFormats">QTextDocument::allFormats</a>().</p> <!-- @@@tableCellFormatIndex --> <!-- $$$operator!=[overload1]$$$operator!=constQTextTableCell& --> <h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QTextTableCell::<span class="name">operator!=</span>(const <span class="type"><a href="qtexttablecell.html#QTextTableCell">QTextTableCell</a></span> &<i>other</i>) const</h3> <p>Returns <code>true</code> if this cell object and the <i>other</i> cell object describe different cells; otherwise returns <code>false</code>.</p> <!-- @@@operator!= --> <!-- $$$operator=[overload1]$$$operator=constQTextTableCell& --> <h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qtexttablecell.html#QTextTableCell">QTextTableCell</a></span> &QTextTableCell::<span class="name">operator=</span>(const <span class="type"><a href="qtexttablecell.html#QTextTableCell">QTextTableCell</a></span> &<i>other</i>)</h3> <p>Assigns the <i>other</i> table cell to this table cell.</p> <!-- @@@operator= --> <!-- $$$operator==[overload1]$$$operator==constQTextTableCell& --> <h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QTextTableCell::<span class="name">operator==</span>(const <span class="type"><a href="qtexttablecell.html#QTextTableCell">QTextTableCell</a></span> &<i>other</i>) const</h3> <p>Returns <code>true</code> if this cell object and the <i>other</i> cell object describe the same cell; otherwise returns <code>false</code>.</p> <!-- @@@operator== --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>