/****************************************************************************

**

** Copyright (C) 2016 The Qt Company Ltd.

** Contact: https://www.qt.io/licensing/

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** Commercial License Usage

** Licensees holding valid commercial Qt licenses may use this file in

** accordance with the commercial license agreement provided with the

** Software or, alternatively, in accordance with the terms contained in

** a written agreement between you and The Qt Company. For licensing terms

** and conditions see https://www.qt.io/terms-conditions. For further

** information use the contact form at https://www.qt.io/contact-us.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 3 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL3 included in the

** packaging of this file. Please review the following information to

** ensure the GNU Lesser General Public License version 3 requirements

** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.

**

** GNU General Public License Usage

** Alternatively, this file may be used under the terms of the GNU

** General Public License version 2.0 or (at your option) the GNU General

** Public license version 3 or any later version approved by the KDE Free

** Qt Foundation. The licenses are as published by the Free Software

** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3

** included in the packaging of this file. Please review the following

** information to ensure the GNU General Public License requirements will

** be met: https://www.gnu.org/licenses/gpl-2.0.html and

** https://www.gnu.org/licenses/gpl-3.0.html.

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QTEXTTABLE_H

#define QTEXTTABLE_H

#include <QtGui/qtguiglobal.h>

#include <QtCore/qobject.h>

#include <QtGui/qtextobject.h>

QT_BEGIN_NAMESPACE

class QTextCursor;

class QTextTable;

class QTextTablePrivate;

class Q_GUI_EXPORT QTextTableCell

{

public:

    QTextTableCell() : table(nullptr) {}

    ~QTextTableCell() {}

    QTextTableCell(const QTextTableCell &o) : table(o.table), fragment(o.fragment) {}

    QTextTableCell &operator=(const QTextTableCell &o)

    { table = o.table; fragment = o.fragment; return *this; }

    void setFormat(const QTextCharFormat &format);

    QTextCharFormat format() const;

    int row() const;

    int column() const;

    int rowSpan() const;

    int columnSpan() const;

    inline bool isValid() const { return table != nullptr; }

    QTextCursor firstCursorPosition() const;

    QTextCursor lastCursorPosition() const;

    int firstPosition() const;

    int lastPosition() const;

    inline bool operator==(const QTextTableCell &other) const

    { return table == other.table && fragment == other.fragment; }

    inline bool operator!=(const QTextTableCell &other) const

    { return !operator==(other); }

    QTextFrame::iterator begin() const;

    QTextFrame::iterator end() const;

    int tableCellFormatIndex() const;

private:

    friend class QTextTable;

    QTextTableCell(const QTextTable *t, int f)

        : table(t), fragment(f) {}

    const QTextTable *table;

    int fragment;

};

class Q_GUI_EXPORT QTextTable : public QTextFrame

{

    Q_OBJECT

public:

    explicit QTextTable(QTextDocument *doc);

    ~QTextTable();

    void resize(int rows, int cols);

    void insertRows(int pos, int num);

    void insertColumns(int pos, int num);

    void appendRows(int count);

    void appendColumns(int count);

    void removeRows(int pos, int num);

    void removeColumns(int pos, int num);

    void mergeCells(int row, int col, int numRows, int numCols);

    void mergeCells(const QTextCursor &cursor);

    void splitCell(int row, int col, int numRows, int numCols);

    int rows() const;

    int columns() const;

    QTextTableCell cellAt(int row, int col) const;

    QTextTableCell cellAt(int position) const;

    QTextTableCell cellAt(const QTextCursor &c) const;

    QTextCursor rowStart(const QTextCursor &c) const;

    QTextCursor rowEnd(const QTextCursor &c) const;

    void setFormat(const QTextTableFormat &format);

    QTextTableFormat format() const { return QTextObject::format().toTableFormat(); }

private:

    Q_DISABLE_COPY(QTextTable)

    Q_DECLARE_PRIVATE(QTextTable)

    friend class QTextTableCell;

};

QT_END_NAMESPACE

#endif // QTEXTTABLE_H