Commit bb103bdd authored by Dominik Haumann's avatar Dominik Haumann

more API documentation

parent c4d73539
...@@ -46,6 +46,7 @@ class View; ...@@ -46,6 +46,7 @@ class View;
* - \ref doc_intro * - \ref doc_intro
* - \ref doc_manipulation * - \ref doc_manipulation
* - \ref doc_views * - \ref doc_views
* - \ref doc_readwrite
* - \ref doc_extensions * - \ref doc_extensions
* *
* \section doc_intro Introduction * \section doc_intro Introduction
...@@ -90,6 +91,14 @@ class View; ...@@ -90,6 +91,14 @@ class View;
* it by using activeView(). Create a new view with createView(). Every time * it by using activeView(). Create a new view with createView(). Every time
* a new view is created the signal viewCreated() is emitted. * a new view is created the signal viewCreated() is emitted.
* *
* \section doc_readwrite Read-Only Mode
*
* A Document may be in read-only mode, for instance due to missing file
* permissions. The read-only mode can be checked with isReadWrite(). Further,
* the signal readWriteChanged() is emitted whenever the state changes either
* to read-only mode or to read/write mode. The read-only mode can be controlled
* with setReadWrite().
*
* \section doc_extensions Document Extension Interfaces * \section doc_extensions Document Extension Interfaces
* *
* A simple document represents text and provides text manipulation methods. * A simple document represents text and provides text manipulation methods.
...@@ -223,7 +232,7 @@ class KTEXTEDITOR_EXPORT Document : public KParts::ReadWritePart ...@@ -223,7 +232,7 @@ class KTEXTEDITOR_EXPORT Document : public KParts::ReadWritePart
* This signal is emitted whenever the readWrite state of a document * This signal is emitted whenever the readWrite state of a document
* changes. * changes.
* \param document the document whose read/write property changed * \param document the document whose read/write property changed
* \see KParts::setReadWrite() * \see KParts::ReadWritePart::setReadWrite()
*/ */
void readWriteChanged ( KTextEditor::Document *document ); void readWriteChanged ( KTextEditor::Document *document );
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment