Kate::DocumentManager Class Reference
#include <documentmanager.h>
Detailed Description
This interface provides access to the Kate Document Manager.
Definition at line 29 of file documentmanager.h.
Signals | |
| void | documentChanged () |
| void | documentCreated (Kate::Document *document) |
| void | documentDeleted (uint documentNumber) |
Public Member Functions | |
| DocumentManager (void *documentManager) | |
| Document * | document (uint n=0) |
| Document * | activeDocument () |
| Document * | documentWithID (uint id) |
| int | findDocument (const KURL &url) |
| bool | isOpen (const KURL &url) |
| uint | documents () |
| Document * | openURL (const KURL &url, const QString &encoding=QString::null, uint *id=0) |
| bool | closeDocument (class Document *document) |
| bool | closeDocument (uint n=0) |
| bool | closeDocumentWithID (uint id) |
| bool | closeAllDocuments () |
Friends | |
| class | PrivateDocumentManager |
Member Function Documentation
|
|
Returns a pointer to the currently active document or NULL if no document is open.
Definition at line 64 of file documentmanager.cpp. |
|
|
close all documents
Definition at line 109 of file documentmanager.cpp. |
|
|
close a document identified by the index
Definition at line 99 of file documentmanager.cpp. |
|
|
close a document by pointer
Definition at line 94 of file documentmanager.cpp. |
|
|
close a document identified by the ID
Definition at line 104 of file documentmanager.cpp. |
|
|
Returns a pointer to the document indexed by n in the managers internal list.
Definition at line 59 of file documentmanager.cpp. |
|
|
emitted if the current doc changes (there need not to be a active document)
|
|
|
this document has now been created
|
|
|
the document with this number was deleted
|
|
|
returns the number of documents managed by this manager.
Definition at line 84 of file documentmanager.cpp. |
|
|
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. |
|
|
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. |
|
|
Returns true if the document located at url is open, otherwise false.
Definition at line 79 of file documentmanager.cpp. |
|
||||||||||||||||
|
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:
