org.kde.koala

Class ReadWritePart

public class ReadWritePart extends 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(). See ReadWritePartSignals for signals emitted by ReadWritePart

UNKNOWN: Base class for an "editor" part.

Constructor Summary
protected	ReadWritePart(Class dummy)

Method Summary
String	className()
boolean	closeURL() 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).
boolean	closeURL(boolean promptToSave) Call this method instead of the above if you need control if the save prompt is shown.
boolean	isModified()
boolean	isReadWrite()
QMetaObject	metaObject()
boolean	queryClose() If the document has been modified, ask the user to save changes.
boolean	save() Save the file in the location from which it was opened.
boolean	saveAs(KURL url) Save the file to a new location.
void	setModified(boolean modified) Sets the modified flag of the part.
void	setModified() Call setModified() whenever the contents get modified.
void	setReadWrite(boolean readwrite) Changes the behavior of this part to readonly or readwrite.
void	setReadWrite()
boolean	waitSaveComplete() Waits for any pending upload job to finish and returns whether the last save() action was successful.

Constructor Detail

ReadWritePart

protected ReadWritePart(Class dummy)

Method Detail

className

public String className()

closeURL

public boolean closeURL()

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

UNKNOWN: Called when closing the current url (e.

closeURL

public boolean closeURL(boolean 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()

UNKNOWN: Call this method instead of the above if you need control if the save prompt is shown.

isModified

public boolean isModified()

Returns: true if the document has been modified.

UNKNOWN:

isReadWrite

public boolean isReadWrite()

Returns: true if the part is in read-write mode

UNKNOWN:

metaObject

public QMetaObject metaObject()

queryClose

public boolean 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.

UNKNOWN: If the document has been modified, ask the user to save changes.

save

public boolean save()

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.

UNKNOWN: Save the file in the location from which it was opened.