Kate::DocumentManager Class Reference

This interface provides access to the Kate Document Manager. More...

#include <documentmanager.h>

Inheritance diagram for Kate::DocumentManager:

[legend]

List of all members.

Signals
void	documentChanged ()
void	documentCreated (Kate::Document *document)
void	documentDeleted (uint documentNumber)
Public Member Functions
class Document *	activeDocument ()
bool	closeAllDocuments ()
bool	closeDocument (uint n=0)
bool	closeDocument (class Document *document)
bool	closeDocumentWithID (uint id)
class Document *	document (uint n=0)
	DocumentManager (void *documentManager)
uint	documents ()
class Document *	documentWithID (uint id)
int	findDocument (const KURL &url)
bool	isOpen (const KURL &url)
class Document *	openURL (const KURL &url, const QString &encoding=QString::null, uint *id=0)
virtual	~DocumentManager ()

---

Detailed Description

This interface provides access to the Kate Document Manager.

Definition at line 29 of file documentmanager.h.

---

Constructor & Destructor Documentation

Kate::DocumentManager::DocumentManager

(

void *

documentManager

)

Definition at line 48 of file documentmanager.cpp.

Kate::DocumentManager::~DocumentManager

(

)

[virtual]

Definition at line 54 of file documentmanager.cpp.

---

Member Function Documentation

Document * Kate::DocumentManager::activeDocument

(

)

Returns a pointer to the currently active document or NULL if no document is open.

Definition at line 64 of file documentmanager.cpp.

bool Kate::DocumentManager::closeAllDocuments

(

)

close all documents

Definition at line 109 of file documentmanager.cpp.

bool Kate::DocumentManager::closeDocument

(

uint

n = 0

)

close a document identified by the index

Definition at line 99 of file documentmanager.cpp.

bool Kate::DocumentManager::closeDocument

(

class Document *

document

)

close a document by pointer

Definition at line 94 of file documentmanager.cpp.

bool Kate::DocumentManager::closeDocumentWithID

(

uint

id

)

close a document identified by the ID

Definition at line 104 of file documentmanager.cpp.

Document * Kate::DocumentManager::document

(

uint

n = 0

)

Returns a pointer to the document indexed by n in the managers internal list.

Definition at line 59 of file documentmanager.cpp.

void Kate::DocumentManager::documentChanged

(

)

[signal]

emitted if the current doc changes (there need not to be a active document)

void Kate::DocumentManager::documentCreated

(

Kate::Document *

document

)

[signal]

this document has now been created

void Kate::DocumentManager::documentDeleted

(

uint

documentNumber

)

[signal]

the document with this number was deleted

uint Kate::DocumentManager::documents

(

)

returns the number of documents managed by this manager.

Definition at line 84 of file documentmanager.cpp.

Document * Kate::DocumentManager::documentWithID

(

uint

id

)

Returns a pointer to the document with the given ID or NULL if no such document exists.

Definition at line 69 of file documentmanager.cpp.

int Kate::DocumentManager::findDocument

(

const KURL &

url

)

Returns the ID of the document located at url if such a document is known by the manager.

Definition at line 74 of file documentmanager.cpp.

bool Kate::DocumentManager::isOpen

(

const KURL &

url

)

Returns true if the document located at url is open, otherwise false.

Definition at line 79 of file documentmanager.cpp.

Document * Kate::DocumentManager::openURL	(	const KURL &	url,
		const QString &	encoding = QString::null,
		uint *	id = 0
	)

open a document and return a pointer to the document, if you specify a pointer != 0 to the id parameter you will get the document id returned too

Definition at line 89 of file documentmanager.cpp.

---

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

• documentmanager.h
• documentmanager.cpp