# class ReadWritePart

### abstract

Module | kparts
Namespace | KParts
Class | ReadWritePart
Inherits | KParts::ReadOnlyPart

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.

### methods

- ReadWritePart (parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  parent | QObject | 0

  Constructor See parent constructor for instructions.

- ReadWritePart (a0)

  returns ctor
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  a0 | KParts.ReadWritePart |

- ReadWritePart (a0)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QObject | 0

- closeUrl ( )

  returns bool

  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

- closeUrl (promptToSave)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  promptToSave | bool |

  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()

- isModified ( )

  returns bool

  Returns true if the document has been modified.

- isReadWrite ( )

  returns bool

  Returns true if the part is in read-write mode

- queryClose ( )

  returns bool

  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.

- save ( )

  returns bool

  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.

- saveAs (url)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Save the file to a new location.

  Calls save(), no need to reimplement

- saveFile ( )

  returns bool
  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

- saveToUrl ( )

  returns bool

  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.

- setModified (modified)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  modified | bool |

  Sets the modified flag of the part.

- setModified ( )

  returns Nothing

  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().

- setReadWrite (readwrite)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  readwrite | bool | 1

  Changes the behavior of this part to readonly or readwrite.

  readwrite - set to true to enable readwrite mode

- sigQueryClose (handled, abortClosing)

  returns Nothing
  Not implemented SIGNAL ("sigQueryClose (bool*, bool*)")

  Argument | Type | Default
  --- | --- | ---
  handled | bool |
  abortClosing | bool |

  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

- waitSaveComplete ( )

  returns bool

  Waits for any pending upload job to finish and returns whether the last save() action was successful.