KTextEditor::Document Class Reference

#include </home/clem/local/src/opie/noncore/apps/tinykate/libkate/ktexteditor/ktexteditor.h>

Inheritance diagram for KTextEditor::Document:

[legend]List of all members.


Public Slots
virtual void	setText (const QString &t)=0
Signals
void	textChanged ()
void	deleted (int startLine, int endLine)
void	inserted (int startLine, int endLine)
Public Member Functions
	Document (QObject parent=0, const char name=0)
virtual	~Document ()
virtual View *	createView (QWidget parent, const char name=0)=0
virtual QList< View >	views () const
virtual QString	textLine (int line) const =0
virtual void	setSelection (int row_from, int col_from, int row_to, int col_t)=0
virtual bool	hasSelection () const =0
virtual QString	selection () const =0
virtual int	numLines () const =0
virtual void	insertLine (const QString &s, int line=-1)=0
virtual void	insertAt (const QString &s, int line, int col, bool mark=FALSE)=0
virtual void	removeLine (int line)=0
virtual QString	text () const =0
virtual int	length () const =0
Protected Member Functions
virtual void	addView (View *view)
virtual void	removeView (View *view)
Protected Attributes
QList< View >	m_views
Private Slots
void	slotViewDestroyed ()
Private Attributes
DocumentPrivate *	d

Constructor & Destructor Documentation

KTextEditor::Document::Document ( QObject * parent = 0,

const char * name = 0

)

virtual KTextEditor::Document::~Document ( ) [virtual]

Reimplemented in Kate::Document.

Member Function Documentation

virtual void KTextEditor::Document::addView ( View * view ) [protected, virtual]

Call this method in your document implementation whenever you created a new view. (like in createView )
Referenced by KateDocument::addView().

virtual View* KTextEditor::Document::createView ( QWidget * parent,

const char * name = 0

) [pure virtual]

Create a view that will display the document data. You can create as many views as you like. When the user modifies data in one view then all other views will be updated as well.
Implemented in KateDocument.

void KTextEditor::Document::deleted ( int startLine,

int endLine

) [signal]

Referenced by KateDocument::clearRedo().

virtual bool KTextEditor::Document::hasSelection ( ) const [pure virtual]

Implemented in KateDocument.

virtual void KTextEditor::Document::insertAt ( const QString & s,

int line,

int col,

bool mark = FALSE

) [pure virtual]

Add the line(s) into the document at the given line and column.
Implemented in KateDocument.

void KTextEditor::Document::inserted ( int startLine,

int endLine

) [signal]

virtual void KTextEditor::Document::insertLine ( const QString & s,

int line = -1

) [pure virtual]

Insert line(s) at the given line number. If the line number is -1 (the default) then the line is added to end of the document
Implemented in KateDocument.

virtual int KTextEditor::Document::length ( ) const [pure virtual]

Returns:
the number of characters in the document

Implemented in KateDocument.

virtual int KTextEditor::Document::numLines ( ) const [pure virtual]

Returns:
The current number of lines in the document

Implemented in KateDocument.

virtual void KTextEditor::Document::removeLine ( int line ) [pure virtual]

Implemented in KateDocument.

virtual void KTextEditor::Document::removeView ( View * view ) [protected, virtual]

Call this method in your document implementation whenever you delete a view.
Referenced by KateDocument::removeView().

virtual QString KTextEditor::Document::selection ( ) const [pure virtual]

Implemented in KateDocument.

virtual void KTextEditor::Document::setSelection ( int row_from,

int col_from,

int row_to,

int col_t

) [pure virtual]

Implemented in KateDocument.

virtual void KTextEditor::Document::setText ( const QString & t ) [pure virtual, slot]

Set the given text into the view. Warning: This will overwrite any data currently held in this view.
Implemented in KateDocument.

void KTextEditor::Document::slotViewDestroyed ( ) [private, slot]

The view emits a destroyed() signal which is connected to this slot and removed from our internal list. Note: The view* is obtained from the QObject::sender() method.
Reimplemented in KateDocument.
Referenced by Document::addView(), Document::removeView(), and Document::~Document().

virtual QString KTextEditor::Document::text ( ) const [pure virtual]

Returns:
the complete document as a single QString

Implemented in KateDocument.

void KTextEditor::Document::textChanged ( ) [signal]

When the user changes the text then this signal is emitted TODO: - explain why and what type of change trigger this?
Referenced by KateDocument::recordEnd().

virtual QString KTextEditor::Document::textLine ( int line ) const [pure virtual]

Returns:
All the text from the requested line.

Implemented in KateDocument.