KDE 4.0 API Reference KParts
KParts::ReadWritePart Class Reference
#include <part.h>
Detailed Description
Base class for an "editor" part.This class handles network transparency for you. Anything that can open a URL, allow modifications, and save (to the same URL or a different one).
A read-write part can be set to read-only mode, using setReadWrite().
Part writers : Any part inheriting ReadWritePart should check isReadWrite before allowing any action that modifies the part. The part probably wants to reimplement setReadWrite, disable those actions. Don't forget to call the parent setReadWrite.
Definition at line 708 of file part.h.
Public Slots | |
| void | setModified () |
| virtual bool | save () |
| bool | waitSaveComplete () |
Signals | |
| void | sigQueryClose (bool *handled, bool *abortClosing) |
Public Member Functions | |
| ReadWritePart (QObject *parent=0) | |
| virtual | ~ReadWritePart () |
| bool | isReadWrite () const |
| virtual void | setReadWrite (bool readwrite=true) |
| bool | isModified () const |
| virtual bool | queryClose () |
| virtual bool | closeUrl () |
| virtual bool | closeUrl (bool promptToSave) |
| virtual bool | saveAs (const KUrl &url) |
| virtual void | setModified (bool modified) |
Protected Member Functions | |
| virtual bool | saveFile ()=0 |
| virtual bool | saveToUrl () |
Constructor & Destructor Documentation
| ReadWritePart::ReadWritePart | ( | QObject * | parent = 0 |
) | [explicit] |
| ReadWritePart::~ReadWritePart | ( | ) | [virtual] |
Destructor Applications using a ReadWritePart should make sure, before destroying it, to call closeUrl().
In KMainWindow::queryClose(), for instance, they should allow closing only if the return value of closeUrl() was true. This allows to cancel.
Member Function Documentation
| bool ReadWritePart::isReadWrite | ( | ) | const |
| void ReadWritePart::setReadWrite | ( | bool | readwrite = true |
) | [virtual] |
| bool ReadWritePart::isModified | ( | ) | const |
| bool ReadWritePart::queryClose | ( | ) | [virtual] |
If the document has been modified, ask the user to save changes.
This method is meant to be called from KMainWindow::queryClose(). It will also be called from closeUrl().
- Returns:
- true if closeUrl() can be called without the user losing important data, false if the user chooses to cancel.
| bool ReadWritePart::closeUrl | ( | ) | [virtual] |
Called when closing the current url (e.g.
document), for instance when switching to another url (note that openUrl() calls it automatically in this case).
If the current URL is not fully loaded yet, aborts loading.
If isModified(), queryClose() will be called.
- Returns:
- false on cancel
Reimplemented from KParts::ReadOnlyPart.
Call this method instead of the above if you need control if the save prompt is shown.
For example, if you call queryClose() from KMainWindow::queryClose(), you would not want to prompt again when closing the url.
Equivalent to promptToSave ? closeUrl() : ReadOnlyPart::closeUrl()
| void ReadWritePart::setModified | ( | bool | modified | ) | [virtual] |
set handled to true, if you don't want the default handling set abortClosing to true, if you handled the request, but for any reason don't want to allow closing the document
| void ReadWritePart::setModified | ( | ) | [slot] |
Call setModified() whenever the contents get modified.
This is a slot for convenience, since it simply calls setModified(true), so that you can connect it to a signal, like textChanged().
| bool ReadWritePart::save | ( | ) | [virtual, slot] |
Save the file in the location from which it was opened.
You can connect this to the "save" action. Calls saveFile() and saveToUrl(), no need to reimplement.
| bool ReadWritePart::waitSaveComplete | ( | ) | [slot] |
| virtual bool KParts::ReadWritePart::saveFile | ( | ) | [protected, pure virtual] |
Save to a local file.
You need to implement it, to save to the local file. The framework takes care of re-uploading afterwards.
- Returns:
- true on success, false on failure. On failure the function should inform the user about the problem with an appropriate message box. Standard error messages can be constructed using KIO::buildErrorString() in combination with the error codes defined in kio/global.h
| bool ReadWritePart::saveToUrl | ( | ) | [protected, virtual] |
Save the file.
Uploads the file, if url is remote. This will emit started(), and either completed() or canceled(), in case you want to provide feedback.
- Returns:
- true on success, false on failure.
The documentation for this class was generated from the following files:
