Loading...
Searching...
No Matches
odsdochandlerinterface.h
Go to the documentation of this file.
/**
* \file odsstream/odsdochandlerinterface.h
* \date 10/03/2015
* \author Olivier Langella
* \brief interface to implement, needed to read an ODS document
* A developper has to create a new class implementing this interface.
* The member functions are triggered by the OdsDocReader class.
* It acts as a SAX handler to read ODS files as streams.
*/
/*******************************************************************************
* Copyright (c) 2013 Olivier Langella <Olivier.Langella@u-psud.fr>.
*
* This file is part of the libodsstream library.
*
* libodsstream is a library to read and write ODS documents as streams
* Copyright (C) 2013 Olivier Langella <Olivier.Langella@u-psud.fr>
*
* This program 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 3 of the License, or (at your
*option) any later version.
*
* This program 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, see <http://www.gnu.org/licenses/>.
*
* Contributors:
* Olivier Langella <Olivier.Langella@u-psud.fr> - initial API and
*implementation
******************************************************************************/
#pragma once
#include <QString>
#include "reader/odscell.h"
class OdsDocHandlerInterface
{
public:
/**
* callback that indicates the begining of a data sheet. Override it in
* order to retrieve information about the current data sheet.
*
*/
virtual void startSheet(const QString &sheet_name) = 0;
/**
* callback that indicates the end of the current data sheet. Override it if
* needed
*/
virtual void endSheet() = 0;
/**
* callback that indicates a new line start. Override it if needed.
*/
virtual void startLine() = 0;
/**
* callback that indicates a line ending. Override it if needed.
*/
virtual void endLine() = 0;
/**
* callback that report the content of the current cell in a dedicated Cell
* object. Override it if you need to retrieve cell content.
*/
virtual void setCell(const OdsCell &) = 0;
/**
* callback that report the end of the ODS document. Override it if you need
* to know that reading is finished.
*/
virtual void endDocument() = 0;
};
OdsCell
Definition odscell.h:29
OdsDocHandlerInterface
Definition odsdochandlerinterface.h:43
OdsDocHandlerInterface::endSheet
virtual void endSheet()=0
OdsDocHandlerInterface::setCell
virtual void setCell(const OdsCell &)=0
OdsDocHandlerInterface::endDocument
virtual void endDocument()=0
OdsDocHandlerInterface::startLine
virtual void startLine()=0
OdsDocHandlerInterface::startSheet
virtual void startSheet(const QString &sheet_name)=0
OdsDocHandlerInterface::endLine
virtual void endLine()=0
odscell.h