File indexing completed on 2024-05-19 16:02:08

 /*
  *  Copyright (c) 2010 Carlos Licea <carlos@kdab.com>
  *
  *  This library is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU Lesser General Public License as published
  *  by the Free Software Foundation; either version 2.1 of the License, or
  *  (at your option) any later version.
  *
  *  This library is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU Lesser General Public License for more details.
  *
  *  You should have received a copy of the GNU Lesser General Public License
  *  along with this program; if not, write to the Free Software
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 #ifndef KOCELL_H
 #define KOCELL_H
 
 #include "KoCellStyle.h"
 class KoCellChild;
 class KoCellValue;
 class KoTable;
 
 class KoXmlWriter;
 class KoGenStyles;
 
 #include "koodf2_export.h"
 
 #include <QList>
 
 /**
  * \class KoCell
  * @brief represents a cell inside a table.
  **/
 class KOODF2_EXPORT KoCell
 {
     friend class KoTable;
 
     KoCell();
     KoCell& operator=(KoCell&);
 
 public:
     ~KoCell();
 
     /**
      * Set the this Cell style to the given style.
      */
     void setStyle(KoCellStyle::Ptr style);
 
     /**
      * Returns the style assigned to this KoCell.
      * It's null if no style has been set.
      */
     KoCellStyle::Ptr style() const;
 
     /**
      * Sets the value as defined by element office:value of ODF.
      * \see ODF1.2 office:value §19.386.
      */
     void setValue(KoCellValue* value);
     KoCellValue* value() const;
 
     /**
      * A class KoCellChild represents all the items that can be
      * contained inside a KoCell.
      * \see ODF1.2 table:table-cell §9.1.4
      *
      * \note The cell takes ownership of the given KoCellChild.
      * \note The order in which the elements are written to ODF
      * is the same in which they were inserted.
      */
     void appendChild(KoCellChild* child);
 
     /**
      *  Deletes the old list of children in favor of this one.
      */
     void setChildren(QList<KoCellChild*> children);
 
     /**
      * Returns all the children appended to the cell.
      * \note the cell is still the owner of those objects
      */
     QList<KoCellChild*> children() const;
 
     /**
      * \brief Sets the row span of the cell.
      * By default the span is 1.
      * Negative spans are not allowed, they are converted back to 1.
      *
      * \note the span is not checked to ensure not overlaping.
      * Also the covered cells can also be populated with data.
      */
     void setRowSpan(int span);
 
     /**
      * Gets the row span of the cell.
      * \see ODF1.2 table:number-rows-spanned §19.680
      */
     int rowSpan() const;
 
     /**
      * \brief Sets the column span of the cell.
      * By default the span is 1.
      * Negative spans are not allowed, they are converted back to 1.
      *
      * \note the span is not checked to ensure not overlaping.
      * Also the covered cells can also be populated with data.
      */
     void setColumnSpan(int span);
 
     /**
      * Gets the column span of the cell.
      * \see ODF1.2 table:number-columns-spanned §19.681
      */
     int columnSpan() const;
 
     /**
      * \brief Sets this cell to be <table:covered-table-cell>
      */
     void setCovered(bool covered);
 
     /**
      * Returns if the cell is covered or not.
      */
     bool isCovered() const;
 
     /**
      * Sets if the cell is protected. Protected cells cannot be edited by the user.
      */
     void setProtected(bool protect);
 
     /**
      * Returns if the cell is protected or not.
      * \see ODF1.2 table:protected §19.698.5
      */
     bool isProtected() const;
 
 private:
     void saveOdf(KoXmlWriter& writer, KoGenStyles& styles);
 
     QList<KoCellChild*> m_children;
     KoCellValue* m_value;
     KoCellStyle::Ptr m_style;
 
     int m_rowSpan;
     int m_columnSpan;
     bool m_protected;
     bool m_covered;
 };
 
 #endif