AbstractExporter Class Reference

This file is part of the KDE libraries Copyright (C) 2009 Milian Wolff <mail@milianw.de> More...

#include <abstractexporter.h>

Inheritance diagram for AbstractExporter:

List of all members.

Public Member Functions
	AbstractExporter (KTextEditor::View *view, QTextStream &output, const bool encapsulate=false)
virtual	~AbstractExporter ()
virtual void	closeLine (const bool lastLine)=0
virtual void	exportText (const QString &text, const KTextEditor::Attribute::Ptr &attrib)=0
virtual void	openLine ()=0
Protected Attributes
KTextEditor::Attribute::Ptr	m_defaultAttribute
bool	m_encapsulate
QTextStream &	m_output
KTextEditor::View *	m_view

---

Detailed Description

This file is part of the KDE libraries Copyright (C) 2009 Milian Wolff <mail@milianw.de>

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License version 2 as published by the Free Software Foundation.

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 Library General Public License for more details.

You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Definition at line 32 of file abstractexporter.h.

---

Constructor & Destructor Documentation

AbstractExporter::AbstractExporter	(	KTextEditor::View *	view,
		QTextStream &	output,
		const bool	encapsulate = false
	)		[inline]

If m_encapsulate is set, you should add some kind of header in the ctor to m_output.

Definition at line 37 of file abstractexporter.h.

virtual AbstractExporter::~AbstractExporter

(

)

[inline, virtual]

Gets called after everything got exported.

Hence, if m_encapsulate is set, you should probably add some kind of footer here.

Definition at line 57 of file abstractexporter.h.

---

Member Function Documentation

virtual void AbstractExporter::closeLine

(

const bool

lastLine

)

[pure virtual]

Finish the current line.

Implemented in HTMLExporter.

virtual void AbstractExporter::exportText	(	const QString &	text,
		const KTextEditor::Attribute::Ptr &	attrib
	)		[pure virtual]

Export text with given text attribute attrib.

NOTE: Check attrib, it might be null for KTextEditors that do not implement the HighlightInterface.

Implemented in HTMLExporter.

virtual void AbstractExporter::openLine

(

)

[pure virtual]

Begin a new line.

Implemented in HTMLExporter.

---

Member Data Documentation

KTextEditor::Attribute::Ptr AbstractExporter::m_defaultAttribute [protected]

Definition at line 75 of file abstractexporter.h.

bool AbstractExporter::m_encapsulate [protected]

Definition at line 74 of file abstractexporter.h.

QTextStream& AbstractExporter::m_output [protected]

Definition at line 73 of file abstractexporter.h.

KTextEditor::View* AbstractExporter::m_view [protected]

Definition at line 72 of file abstractexporter.h.

---

The documentation for this class was generated from the following file:

• abstractexporter.h