---

KParts::ReadWritePart Class Reference

#include <part.h>

Inheritance diagram for KParts::ReadWritePart:

List of all members.

Public Slots
virtual void	setModified ()
virtual bool	save ()
Public Methods
	ReadWritePart (QObject *parent=0, const char *name=0)
virtual	~ReadWritePart ()
bool	isReadWrite () const
virtual void	setReadWrite (bool readwrite=true)
bool	isModified () const
bool	queryClose ()
virtual bool	closeURL ()
bool	closeURL (bool promptToSave)
virtual bool	saveAs (const KURL &url)
virtual void	setModified (bool modified)
Protected Methods
virtual bool	saveFile ()=0
virtual bool	saveToURL ()

---

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 498 of file part.h.

---

Constructor & Destructor Documentation

KParts::ReadWritePart::ReadWritePart (  QObject *    parent = 0, const char *    name = 0 )

Constructor See parent constructor for instructions.

virtual KParts::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 KParts::ReadWritePart::closeURL (  bool    promptToSave )

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() Since: 3.2

virtual bool KParts::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.

bool KParts::ReadWritePart::isModified (    )  const [inline]

Returns: true if the document has been modified. Definition at line 531 of file part.h.

bool KParts::ReadWritePart::isReadWrite (    )  const [inline]

Returns: true if the part is in read-write mode Definition at line 520 of file part.h.

bool KParts::ReadWritePart::queryClose (    )

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. Since: 3.2

virtual bool KParts::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.

virtual bool KParts::ReadWritePart::saveAs (  const KURL &    url )  [virtual]

Save the file to a new location. Calls save(), no need to reimplement

virtual bool KParts::ReadWritePart::saveFile (    )  [protected, pure virtual]

Save to a local file. You need to implement it, to save to m_file. The framework takes care of re-uploading afterwards.

virtual bool KParts::ReadWritePart::saveToURL (    )  [protected, virtual]

Save the file. Uploads the file, if m_url is remote. This will emit started(), and either completed() or canceled(), in case you want to provide feedback.

virtual void KParts::ReadWritePart::setModified (    )  [virtual, slot]

Call setModified() whenever the contents get modified. This is a slot for convenience, so that you can connect it to a signal, like textChanged().

virtual void KParts::ReadWritePart::setModified (  bool    modified )  [virtual]

Sets the modified flag of the part.

virtual void KParts::ReadWritePart::setReadWrite (  bool    readwrite = true )  [virtual]

Changes the behaviour of this part to readonly or readwrite. Parameters: readwrite  set to true to enable readwrite mode Referenced by KParts::GenericFactory< T >::createPartObject().

---

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

• part.h

---