KTextEditor::Document Class Reference

#include <document.h>

Inheritance diagram for KTextEditor::Document:

Public Member Functions
	Document (TQObject *parent=0, const char *name=0)
unsigned int	documentNumber () const
TQCString	documentDCOPSuffix () const
virtual class View *	createView (TQWidget *parent, const char *name=0)=0
virtual TQPtrList< class View >	views () const =0
long	documentListPosition () const
void	setDocumentListPosition (long pos)
Public Member Functions inherited from KTextEditor::Editor
	Editor (TQObject *parent=0, const char *name=0)
unsigned int	editorNumber () const

Friends
class	PrivateDocument

Detailed Description

The main class representing a text document.

This class provides access to the document's views.

Definition at line 31 of file document.h.

Constructor & Destructor Documentation

Document()

Document::Document	(	TQObject *	parent = 0,
		const char *	name = 0
	)

Definition at line 109 of file tdetexteditor.cpp.

~Document()

Document::~Document ( )

virtual

Definition at line 116 of file tdetexteditor.cpp.

Member Function Documentation

createView()

virtual class View * KTextEditor::Document::createView ( TQWidget *  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.

documentDCOPSuffix()

TQCString Document::documentDCOPSuffix

(

)

const

Returns this document's DCOP suffix for identifiying its DCOP interface.

Definition at line 135 of file tdetexteditor.cpp.

documentListPosition()

long Document::documentListPosition

(

)

const

Returns the list position of this document in your app, if applicable.

Definition at line 125 of file tdetexteditor.cpp.

documentNumber()

unsigned int Document::documentNumber

(

)

const

Returns the global number of this document in your app.

Definition at line 120 of file tdetexteditor.cpp.

setDocumentListPosition()

void Document::setDocumentListPosition

(

long

pos

)

Sets the list position of this document in your app, if applicable.

Definition at line 130 of file tdetexteditor.cpp.

Friends And Related Function Documentation

PrivateDocument

friend class PrivateDocument

friend

Definition at line 33 of file document.h.

---

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

• document.h
• tdetexteditor.cpp