Trinity API Reference #include <documentmanager.h>
Inherits TQObject.
Signals | |
| void | documentChanged () |
| void | documentCreated (Kate::Document *document) |
| void | documentDeleted (uint documentNumber) |
Public Member Functions | |
| DocumentManager (void *documentManager) | |
| class Document * | document (uint n=0) |
| class Document * | activeDocument () |
| class Document * | documentWithID (uint id) |
| int | findDocument (const KURL &url) |
| bool | isOpen (const KURL &url) |
| uint | documents () |
| class Document * | openURL (const KURL &url, const TQString &encoding=TQString::null, uint *id=0) |
| bool | closeDocument (class Document *document) |
| bool | closeDocument (uint n=0) |
| bool | closeDocumentWithID (uint id) |
| bool | closeAllDocuments () |
Friends | |
| class | PrivateDocumentManager |
Detailed Description
This interface provides access to the Kate Document Manager.
Definition at line 29 of file documentmanager.h.
Constructor & Destructor Documentation
◆ DocumentManager()
| Kate::DocumentManager::DocumentManager | ( | void * | documentManager | ) |
Definition at line 48 of file documentmanager.cpp.
◆ ~DocumentManager()
|
virtual |
Definition at line 54 of file documentmanager.cpp.
Member Function Documentation
◆ activeDocument()
| 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.
◆ closeAllDocuments()
| bool Kate::DocumentManager::closeAllDocuments | ( | ) |
close all documents
Definition at line 109 of file documentmanager.cpp.
◆ closeDocument() [1/2]
| bool Kate::DocumentManager::closeDocument | ( | class Document * | document | ) |
close a document by pointer
Definition at line 94 of file documentmanager.cpp.
◆ closeDocument() [2/2]
| bool Kate::DocumentManager::closeDocument | ( | uint | n = 0 | ) |
close a document identified by the index
Definition at line 99 of file documentmanager.cpp.
◆ closeDocumentWithID()
| bool Kate::DocumentManager::closeDocumentWithID | ( | uint | id | ) |
close a document identified by the ID
Definition at line 104 of file documentmanager.cpp.
◆ document()
| 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.
◆ documentChanged
|
signal |
emitted if the current doc changes (there need not to be a active document)
◆ documentCreated
|
signal |
this document has now been created
◆ documentDeleted
|
signal |
the document with this number was deleted
◆ documents()
| uint Kate::DocumentManager::documents | ( | ) |
returns the number of documents managed by this manager.
Definition at line 84 of file documentmanager.cpp.
◆ documentWithID()
| 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.
◆ findDocument()
| 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.
◆ isOpen()
| 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.
◆ openURL()
| Document * Kate::DocumentManager::openURL | ( | const KURL & | url, |
| const TQString & | encoding = TQString::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.
Friends And Related Function Documentation
◆ PrivateDocumentManager
|
friend |
Definition at line 31 of file documentmanager.h.
The documentation for this class was generated from the following files: